FEAT 3
Finite Element Analysis Toolbox
Loading...
Searching...
No Matches
FEAT::Adjacency::Adjactor Class Reference

Adjactor interface. More...

#include <adjactor.hpp>

Classes

class  ImageIterator
 Adjactor image node iterator class. More...
 
class  IndexImageIterator
 Index-Image-Iterator class. More...
 
class  NullImageIterator
 Null-Image-Iterator class. More...
 

Public Member Functions

Index get_num_nodes_domain () const
 Returns the number of domain nodes. More...
 
Index get_num_nodes_image () const
 Returns the number of image nodes. More...
 
ImageIterator image_begin (Index domain_node) const
 Returns an iterator for the first adjacent image node. More...
 
ImageIterator image_end (Index domain_node) const
 Returns an iterator for the first position past the last adjacent image node. More...
 

Detailed Description

Adjactor interface.

Todo:
details and terminology
Author
Peter Zajac

Definition at line 22 of file adjactor.hpp.

Member Function Documentation

◆ get_num_nodes_domain()

Index FEAT::Adjacency::Adjactor::get_num_nodes_domain ( ) const

Returns the number of domain nodes.

Returns
The total number of domain nodes in the adjactor.

◆ get_num_nodes_image()

Index FEAT::Adjacency::Adjactor::get_num_nodes_image ( ) const

Returns the number of image nodes.

Returns
The total number of image nodes in the adjactor.

◆ image_begin()

ImageIterator FEAT::Adjacency::Adjactor::image_begin ( Index  domain_node) const

Returns an iterator for the first adjacent image node.

Parameters
[in]domain_nodeThe index of the domain node whose image node iterator is to be returned.
Returns
An iterator representing the first image node adjacent to domain_node, or image_end(domain_node) if no adjacent image nodes exist.

◆ image_end()

ImageIterator FEAT::Adjacency::Adjactor::image_end ( Index  domain_node) const

Returns an iterator for the first position past the last adjacent image node.

Parameters
[in]domain_nodeThe index of the domain node whose image node iterator is to be returned.
Returns
An iterator representing the first position past the last image node adjacent to domain_node.

The documentation for this class was generated from the following file: