LifeV
MeshElementMarked< 0, geoDim, GeoShape, MC > Class Template Reference

specialization for 0D entities (points). More...

#include <MeshElementMarked.hpp>

+ Inheritance diagram for MeshElementMarked< 0, geoDim, GeoShape, MC >:
+ Collaboration diagram for MeshElementMarked< 0, geoDim, GeoShape, MC >:

Public Member Functions

void setPoint (ID const identity, MeshElementMarked< 0, geoDim, GeoShape, MC > const *point)
 
void setPoint (ID const, MeshElementMarked< 0, geoDim, GeoShape, MC > const &point)
 
MeshElementMarked< 0, geoDim, GeoShape, MC > const & point (ID const identity) const
 
- Public Member Functions inherited from MeshVertex
 MeshVertex ()
 Empty Constructor. More...
 
 MeshVertex (ID identity, bool boundary=false)
 Declares item identity and states if it is on boundary. More...
 
 MeshVertex (ID identity, Real x, Real y, Real z, bool boundary=false)
 Declares item identity, provides coordinate and states if it is on boundary. More...
 
virtual ~MeshVertex ()
 Destructor. More...
 
std::ostream & showMe (bool Verbose=false, std::ostream &coordinateVector=std::cout) const
 Display general information about the content of the class. More...
 
Real const * coordinatesArray () const
 Returns the pointer to the coordinates vector. More...
 
Realx ()
 Returns the reference to the x-coordinate. More...
 
Realy ()
 Returns the reference to the y-coordinate. More...
 
Realz ()
 Returns the reference to the z-coordinate and checks if working in two dimensions. More...
 
Real x () const
 Returns the x-coordinate. More...
 
Real y () const
 Returns the y-coordinate. More...
 
Real z () const
 Returns the z-coordinate and checks if working in two dimensions. More...
 
Real coordinate (ID const coordinate) const
 Returns the coordinate specified in the argument. More...
 
Realcoordinate (ID const coordinate)
 Returns the reference to the coordinate specified in the argument. More...
 
Vector3D const & coordinates () const
 Returns the coordinates vector. More...
 
- Public Member Functions inherited from MeshEntity
 MeshEntity ()
 Empty Constructor. More...
 
 MeshEntity (const ID &id, const flag_Type &flag=EntityFlags::DEFAULT)
 Constructor with a single value for both identifiers. More...
 
 MeshEntity (const ID &id, const ID &lid, const flag_Type &flag=EntityFlags::DEFAULT)
 Full constructor, where both identifiers are specified. More...
 
 MeshEntity (const ID &id, const bool &boundary)
 backward-compatible constructor More...
 
virtual ~MeshEntity ()
 Destructor. More...
 
void showMe (std::ostream &output=std::cout) const
 Displays the informations stored by this class. More...
 
void setId (const ID &id)
 Method to set the global identifier. More...
 
void setLocalId (const ID &id)
 Method to set the local identifier. More...
 
void setBoundary (const bool &boundary)
 Set method for the boundary indicator. More...
 
void replaceFlag (const flag_Type &flag)
 Replace method for the entity flag. More...
 
void setFlag (const flag_Type &flag)
 Sets a flag. More...
 
void unSetFlag (const flag_Type &flag)
 Remove a flag. More...
 
const IDid () const
 Method to get the global identifier. More...
 
const IDlocalId () const
 Method to get the local identifier. More...
 
bool boundary () const
 Tells if it is on the boundary. More...
 
bool isOwned () const
 Tells if the entity is owned by current process. More...
 
const flag_Typeflag () const
 returns the entity flag More...
 

Public Types

typedef MC::pointMarker_Type marker_Type
 

Constructor & Destructor

 MeshElementMarked ()
 Empty Constructor. More...
 
 MeshElementMarked (ID identity, bool boundary=false)
 Declares item identity and states if it is on boundary. More...
 
 MeshElementMarked (ID identity, Real x, Real y, Real z, bool boundary=false)
 Declares item identity, provides coordinate and states if it is on boundary. More...
 
 MeshElementMarked (MeshElementMarked< 0, geoDim, GeoShape, MC > const &Element)
 Copy constructor. More...
 
 MeshElementMarked (MeshVertex const &Element, MC const &Marker)
 Copy constructor. More...
 
virtual ~MeshElementMarked ()
 Destructor. More...
 

Operators

MeshElementMarkedoperator= (const MeshElementMarked< 0, geoDim, GeoShape, MC > &Element)
 The equivalence operator. More...
 

Additional Inherited Members

- Public Types inherited from MeshVertex
typedef GeoPoint geoShape_Type
 
- Public Types inherited from MeshEntity
enum  SwitchId { LOCALID = 0, GLOBALID = 1 }
 Indicator for local or global id. More...
 

Detailed Description

template<int geoDim, typename GeoShape, typename MC>
class LifeV::MeshElementMarked< 0, geoDim, GeoShape, MC >

specialization for 0D entities (points).

Definition at line 71 of file MeshElementMarked.hpp.

Member Typedef Documentation

◆ marker_Type

typedef MC::pointMarker_Type marker_Type

Definition at line 77 of file MeshElementMarked.hpp.

Constructor & Destructor Documentation

◆ MeshElementMarked() [1/5]

Empty Constructor.

Definition at line 786 of file MeshElementMarked.hpp.

+ Here is the caller graph for this function:

◆ MeshElementMarked() [2/5]

MeshElementMarked ( ID  identity,
bool  boundary = false 
)
explicit

Declares item identity and states if it is on boundary.

Parameters
identityElement identity
boundaryTrue if the element is on boundary

Definition at line 791 of file MeshElementMarked.hpp.

+ Here is the caller graph for this function:

◆ MeshElementMarked() [3/5]

MeshElementMarked ( ID  identity,
Real  x,
Real  y,
Real  z,
bool  boundary = false 
)

Declares item identity, provides coordinate and states if it is on boundary.

Parameters
identityElement identity
xElement x coordinate
yElement y coordinate
zElement z coordinate
boundaryTrue if the element is on boundary

Definition at line 796 of file MeshElementMarked.hpp.

+ Here is the caller graph for this function:

◆ MeshElementMarked() [4/5]

MeshElementMarked ( MeshElementMarked< 0, geoDim, GeoShape, MC > const &  Element)

Copy constructor.

Parameters
ElementMeshElementMarked0D to be copied

Definition at line 801 of file MeshElementMarked.hpp.

+ Here is the caller graph for this function:

◆ MeshElementMarked() [5/5]

MeshElementMarked ( MeshVertex const &  Element,
MC const &  Marker 
)

Copy constructor.

Parameters
ElementMeshElementMarked0D to be copied
MarkerMarkercommon

◆ ~MeshElementMarked()

virtual ~MeshElementMarked ( )
inlinevirtual

Destructor.

Definition at line 118 of file MeshElementMarked.hpp.

Member Function Documentation

◆ operator=()

MeshElementMarked< 0, geoDim, GeoShape, MC > & operator= ( const MeshElementMarked< 0, geoDim, GeoShape, MC > &  Element)

The equivalence operator.

It calls operator= of base classes, just to be sure to do the right thing.

Parameters
ElementEquivalent MeshElementMarked
Returns
Reference to a new MeshElementMarked with the same content of MeshElementMarked Element

Definition at line 812 of file MeshElementMarked.hpp.

◆ setPoint() [1/2]

void setPoint ( ID const  identity,
MeshElementMarked< 0, geoDim, GeoShape, MC > const *  point 
)

Definition at line 835 of file MeshElementMarked.hpp.

◆ setPoint() [2/2]

void setPoint ( ID const  ,
MeshElementMarked< 0, geoDim, GeoShape, MC > const &  point 
)

Definition at line 845 of file MeshElementMarked.hpp.

◆ point()

MeshElementMarked< 0, geoDim, GeoShape, MC > const & point ( ID const  identity) const

Definition at line 828 of file MeshElementMarked.hpp.


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