LifeV
NeighborMarker< FlagPolicy > Class Template Reference

#include <NeighborMarker.hpp>

+ Inheritance diagram for NeighborMarker< FlagPolicy >:
+ Collaboration diagram for NeighborMarker< FlagPolicy >:

Public Types

typedef neighbors_Type::iterator neighborIterator_Type
 
typedef neighbors_Type::const_iterator neighborConstIterator_Type
 
- Public Types inherited from Marker< FlagPolicy >
typedef FlagPolicy MarkerIDPolicy_Type
 The policy used by this marker. More...
 

Public Member Functions

 NeighborMarker ()
 
 NeighborMarker (markerID_Type &p)
 
NeighborMarker< FlagPolicy > & operator= (NeighborMarker< FlagPolicy > const &marker)
 
neighbors_TypepointNeighbors ()
 
neighbors_Type const & pointNeighbors () const
 
void setPointNeighbors (neighbors_Type const &pointNeighbors)
 
- Public Member Functions inherited from Marker< FlagPolicy >
 Marker ()
 Empty Constructor. More...
 
 Marker (markerID_Type &p)
 Constructor given the marker ID. More...
 
 Marker (Marker< FlagPolicy > const &markerBase)
 Copy Constructor. More...
 
virtual ~Marker ()
 Destructor. More...
 
bool isMarkerSet () const
 It enquires if marker ID is different than the null marker ID. More...
 
bool isMarkerUnset () const
 It enquires if marker ID is different than the null marker ID. More...
 
bool hasEqualMarkerID (markerID_Type const &markerID) const
 Compares marker IDs. More...
 
virtual void showMe (std::ostream &output=std::cout) const
 Display information about the marker object. More...
 
markerID_Type setMarkerID (markerID_Type const &markerID)
 Set marker to the given value. More...
 
markerID_Type updateMarkerID (markerID_Type const &markerID)
 Set marker to the given value only if unset. More...
 
markerID_Type setStrongerMarkerID (markerID_Type const &markerID1, markerID_Type const &markerID2)
 Sets the marker ID to the stronger marker ID of two given markers. More...
 
markerID_Type setStrongerMarkerID (markerID_Type const &markerID)
 Sets to the strongest marker ID. More...
 
markerID_Type setWeakerMarkerID (markerID_Type const &markerID1, markerID_Type const &markerID2)
 Sets the marker ID to the weaker marker ID of two given markers. More...
 
markerID_Type setWeakerMarkerID (markerID_Type const &markerID)
 Sets to the weaker marker ID. More...
 
void unsetMarkerID ()
 Put marker to NULLFLAG. More...
 
markerID_Type markerID () const
 Extracts the entityFlag associated to the marked entity. More...
 

Protected Attributes

neighbors_Type M_pointNeighbors
 
- Protected Attributes inherited from Marker< FlagPolicy >
markerID_Type M_markerID
 

Additional Inherited Members

- Static Public Member Functions inherited from Marker< FlagPolicy >
static markerID_Type const & nullMarkerID ()
 Returns the null marker ID. More...
 

Detailed Description

template<typename FlagPolicy = MarkerIDStandardPolicy>
class LifeV::NeighborMarker< FlagPolicy >

This class extends the default marker adding containers to store all adjacency informations.

Definition at line 60 of file NeighborMarker.hpp.

Member Typedef Documentation

◆ neighborIterator_Type

typedef neighbors_Type::iterator neighborIterator_Type

Definition at line 64 of file NeighborMarker.hpp.

◆ neighborConstIterator_Type

typedef neighbors_Type::const_iterator neighborConstIterator_Type

Definition at line 65 of file NeighborMarker.hpp.

Constructor & Destructor Documentation

◆ NeighborMarker() [1/2]

NeighborMarker ( )
inline

Definition at line 67 of file NeighborMarker.hpp.

◆ NeighborMarker() [2/2]

NeighborMarker ( markerID_Type p)
inlineexplicit

Definition at line 69 of file NeighborMarker.hpp.

Member Function Documentation

◆ operator=()

NeighborMarker<FlagPolicy>& operator= ( NeighborMarker< FlagPolicy > const &  marker)
inline

Definition at line 71 of file NeighborMarker.hpp.

◆ pointNeighbors() [1/2]

neighbors_Type& pointNeighbors ( )
inline

Definition at line 78 of file NeighborMarker.hpp.

◆ pointNeighbors() [2/2]

neighbors_Type const& pointNeighbors ( ) const
inline

Definition at line 83 of file NeighborMarker.hpp.

◆ setPointNeighbors()

void setPointNeighbors ( neighbors_Type const &  pointNeighbors)
inline

Definition at line 91 of file NeighborMarker.hpp.

+ Here is the caller graph for this function:

Field Documentation

◆ M_pointNeighbors

neighbors_Type M_pointNeighbors
protected

Definition at line 100 of file NeighborMarker.hpp.


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