Marker - Base marker class. More...

#include <Marker.hpp>

Collaboration diagram for Marker< MarkerIDPolicy >:

Protected Attributes
markerID_Type	M_markerID

Public Types
typedef MarkerIDPolicy	MarkerIDPolicy_Type
	The policy used by this marker. More...

Constructor & Destructor
	Marker ()
	Empty Constructor. More...

	Marker (markerID_Type &p)
	Constructor given the marker ID. More...

	Marker (Marker< MarkerIDPolicy > const &markerBase)
	Copy Constructor. More...

virtual	~Marker ()
	Destructor. More...

Methods
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...

Setters
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	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	setStrongerMarkerID (markerID_Type const &markerID)
	Sets to the strongest marker ID. More...

markerID_Type	setWeakerMarkerID (markerID_Type const &markerID)
	Sets to the weaker marker ID. More...

void	unsetMarkerID ()
	Put marker to NULLFLAG. More...

Get Methods
markerID_Type	markerID () const
	Extracts the entityFlag associated to the marked entity. More...

static markerID_Type const &	nullMarkerID ()
	Returns the null marker ID. More...

Detailed Description

template<typename MarkerIDPolicy = MarkerIDStandardPolicy>
class LifeV::Marker< MarkerIDPolicy >

Marker - Base marker class.

It stores an object of markerID_Type which may be used for marking a geometric entity. The typical use is to specify boundary conditions or material properties associated with the entity. The actual boundary conditions will be handled in the DOF class. During the creation of a field, the markers are processed to furnish the correct boundary conditions. The template argument MarkerIDPolicy defaults to MarkerIDStandardPolicy and it defines the way ambiguities in the Marker ID definition are treated. The template argument FlagPolicy defaults to EntityFlagStandardPolicy and it defines the way ambiguities in the flag definition are treated.

Marker is a concrete base class which also implements basic tool to operate on the markerID. All geometric entities stored in a mesh derives from it, thus it may be used to extend the capabilities of a geometric entity, for any purpose.

The default markers used by RegionMesh are contained in MarkerDefinitions.hpp

Definition at line 148 of file Marker.hpp.

Member Typedef Documentation

◆ MarkerIDPolicy_Type

typedef MarkerIDPolicy MarkerIDPolicy_Type

The policy used by this marker.

Definition at line 155 of file Marker.hpp.

Constructor & Destructor Documentation

◆ Marker() [1/3]

Marker ( )

Empty Constructor.

Definition at line 261 of file Marker.hpp.

◆ Marker() [2/3]

Marker ( markerID_Type & p )

explicit

Constructor given the marker ID.

Definition at line 267 of file Marker.hpp.

◆ Marker() [3/3]

Marker ( Marker< MarkerIDPolicy > const & markerBase )

Copy Constructor.

Definition at line 273 of file Marker.hpp.

◆ ~Marker()

virtual ~Marker ( )

inlinevirtual

Destructor.

Definition at line 171 of file Marker.hpp.

Member Function Documentation

◆ isMarkerSet()

bool isMarkerSet ( ) const

inline

It enquires if marker ID is different than the null marker ID.

Definition at line 340 of file Marker.hpp.

◆ isMarkerUnset()

bool isMarkerUnset ( ) const

inline

It enquires if marker ID is different than the null marker ID.

Definition at line 346 of file Marker.hpp.

Here is the caller graph for this function:

◆ hasEqualMarkerID()

bool hasEqualMarkerID ( markerID_Type const & markerID ) const

inline

Compares marker IDs.

It returns true if the marker ID is equal to the argument

Definition at line 358 of file Marker.hpp.

◆ showMe()

void showMe ( std::ostream & output = std::cout ) const

virtual

Display information about the marker object.

Definition at line 364 of file Marker.hpp.

◆ setMarkerID()

markerID_Type setMarkerID ( markerID_Type const & markerID )

inline

Set marker to the given value.

Definition at line 291 of file Marker.hpp.

Here is the caller graph for this function:

◆ updateMarkerID()

markerID_Type updateMarkerID ( markerID_Type const & markerID )

Set marker to the given value only if unset.

Definition at line 297 of file Marker.hpp.

◆ setStrongerMarkerID() [1/2]

markerID_Type setStrongerMarkerID	(	markerID_Type const &	markerID1,
		markerID_Type const &	markerID2
	)

Sets the marker ID to the stronger marker ID of two given markers.

Definition at line 306 of file Marker.hpp.

◆ setWeakerMarkerID() [1/2]

markerID_Type setWeakerMarkerID	(	markerID_Type const &	markerID1,
		markerID_Type const &	markerID2
	)

Sets the marker ID to the weaker marker ID of two given markers.

Definition at line 313 of file Marker.hpp.

◆ setStrongerMarkerID() [2/2]

markerID_Type setStrongerMarkerID ( markerID_Type const & markerID )

Sets to the strongest marker ID.

If marker ID is not set, is sets it to that of the argument, otherwise it sets it to the stronger ID between the stored one and the one provided by the argument.

Definition at line 320 of file Marker.hpp.

◆ setWeakerMarkerID() [2/2]

markerID_Type setWeakerMarkerID ( markerID_Type const & markerID )

Sets to the weaker marker ID.

If marker ID is not set, is sets it to that of the argument, otherwise it sets it to the weaker ID between the stored one and the one provided by the argument.

Definition at line 330 of file Marker.hpp.

◆ unsetMarkerID()

void unsetMarkerID ( )

inline

Put marker to NULLFLAG.

Definition at line 352 of file Marker.hpp.

◆ markerID()

markerID_Type markerID ( ) const

inline

Extracts the entityFlag associated to the marked entity.

For historical reason this method is called marker, while it should be called markerID() instead. Refactoring however would involve changing too many files and it has been postponed. Just remember that markerID() does not return a Marker!

Definition at line 279 of file Marker.hpp.

◆ nullMarkerID()

markerID_Type const & nullMarkerID ( )

static

Returns the null marker ID.

Definition at line 285 of file Marker.hpp.

Here is the caller graph for this function:

Field Documentation

◆ M_markerID

markerID_Type M_markerID

protected

Definition at line 251 of file Marker.hpp.

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

Marker.hpp

Protected Attributes

Public Types

Constructor & Destructor

Methods

Setters

Get Methods

Detailed Description

template<typename MarkerIDPolicy = MarkerIDStandardPolicy> class LifeV::Marker< MarkerIDPolicy >

Member Typedef Documentation

◆ MarkerIDPolicy_Type

Constructor & Destructor Documentation

◆ Marker() [1/3]

◆ Marker() [2/3]

◆ Marker() [3/3]

◆ ~Marker()

Member Function Documentation

◆ isMarkerSet()

◆ isMarkerUnset()

◆ hasEqualMarkerID()

◆ showMe()

◆ setMarkerID()

◆ updateMarkerID()

◆ setStrongerMarkerID() [1/2]

◆ setWeakerMarkerID() [1/2]

◆ setStrongerMarkerID() [2/2]

◆ setWeakerMarkerID() [2/2]

◆ unsetMarkerID()

◆ markerID()

◆ nullMarkerID()

Field Documentation

◆ M_markerID

template<typename MarkerIDPolicy = MarkerIDStandardPolicy>
class LifeV::Marker< MarkerIDPolicy >