MeshVertex - Zero dimensional entity. More...

#include <MeshVertex.hpp>

Inheritance diagram for MeshVertex:

Collaboration diagram for MeshVertex:

Private Attributes
Vector3D	M_coordinates

Public Types
typedef GeoPoint	geoShape_Type

Constructor & Destructor
	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...

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

Real &	x ()
	Returns the reference to the x-coordinate. More...

Real &	y ()
	Returns the reference to the y-coordinate. More...

Real &	z ()
	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...

Real &	coordinate (ID const coordinate)
	Returns the reference to the coordinate specified in the argument. More...

Get Methods
Vector3D const &	coordinates () const
	Returns the coordinates vector. More...

Additional Inherited Members
Public Types inherited from MeshEntity
enum	SwitchId { LOCALID = 0, GLOBALID = 1 }
	Indicator for local or global id. 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 ID &	id () const
	Method to get the global identifier. More...

const ID &	localId () 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_Type &	flag () const
	returns the entity flag More...

Detailed Description

MeshVertex - Zero dimensional entity.

Author: Intermediate class used to build the actual Geometry classes; it stores boundary information.

Warning: MeshVertex is a template class; in fact, information might not be known a priori. All vector dimensions are determined at compile time to enhance memory access time. A coherent GeoShape has to be provided by the user.

Definition at line 59 of file MeshVertex.hpp.

Member Typedef Documentation

◆ geoShape_Type

typedef GeoPoint geoShape_Type

Definition at line 66 of file MeshVertex.hpp.

Constructor & Destructor Documentation

◆ MeshVertex() [1/3]

MeshVertex ( )

Empty Constructor.

Definition at line 49 of file MeshVertex.cpp.

◆ MeshVertex() [2/3]

MeshVertex	(	ID	identity,
		bool	boundary = `false`
	)

explicit

Declares item identity and states if it is on boundary.

Local and global id are set equal. To change global id use setId() method (inherited from MeshEntity)

Parameters

identity	Element identity (local and global)
boundary	True if the element is on boundary

Definition at line 53 of file MeshVertex.cpp.

◆ MeshVertex() [3/3]

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

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

Parameters

identity	Element identity
x	Element x coordinate
y	Element y coordinate
z	Element z coordinate
boundary	True if the element is on boundary

Definition at line 58 of file MeshVertex.cpp.

◆ ~MeshVertex()

virtual ~MeshVertex ( )

inlinevirtual

Destructor.

Definition at line 96 of file MeshVertex.hpp.

Member Function Documentation

◆ showMe()

std::ostream & showMe	(	bool	Verbose = `false`,
		std::ostream &	coordinateVector = `std::cout`
	)		const

Display general information about the content of the class.

List of things displayed in the class

Parameters

output specify the output format (std::cout by default)

Definition at line 72 of file MeshVertex.cpp.

◆ coordinatesArray()

Real const* coordinatesArray ( ) const

inline

Returns the pointer to the coordinates vector.

Returns: Pointer to coordinate vector

Definition at line 121 of file MeshVertex.hpp.

Here is the caller graph for this function:

◆ x() [1/2]

Real& x ( )

inline

Returns the reference to the x-coordinate.

Used to provide coordinates to object created using a constructor with no coordinates given, or to modify existing coordinates

Returns: Reference to element x-coordinate

Definition at line 131 of file MeshVertex.hpp.

Here is the caller graph for this function:

◆ y() [1/2]

Real& y ( )

inline

Returns the reference to the y-coordinate.

Used to provide coordinates to object created using a constructor with no coordinates given, or to modify existing coordinates

Returns: Reference to element y-coordinate

Definition at line 140 of file MeshVertex.hpp.

Here is the caller graph for this function:

◆ z() [1/2]

Real& z ( )

inline

Returns the reference to the z-coordinate and checks if working in two dimensions.

Used to provide coordinates to object created using a constructor with no coordinates given, or to modify existing coordinates

Returns: Reference to element z-coordinate

Definition at line 149 of file MeshVertex.hpp.

Here is the caller graph for this function:

◆ x() [2/2]

Real x ( ) const

inline

Returns the x-coordinate.

Returns: Element x-coordinate

Definition at line 157 of file MeshVertex.hpp.

◆ y() [2/2]

Real y ( ) const

inline

Returns the y-coordinate.

Returns: Element y-coordinate

Definition at line 165 of file MeshVertex.hpp.

◆ z() [2/2]

Real z ( ) const

inline

Returns the z-coordinate and checks if working in two dimensions.

Returns: Element z-coordinate

Definition at line 173 of file MeshVertex.hpp.

◆ coordinate() [1/2]

Real coordinate ( ID const coordinate ) const

inline

Returns the coordinate specified in the argument.

The method allows to access the coordinate specified in the argument

Parameters

coordinate x, y, or z coordinate to be returned

Returns: Coordinate specified in the argument

Definition at line 184 of file MeshVertex.hpp.

◆ coordinate() [2/2]

Real& coordinate ( ID const coordinate )

inline

Returns the reference to the coordinate specified in the argument.

The method allows to modify the coordinate specified in the argument

Parameters

coordinate x, y, or z coordinate to be returned

Returns: Reference to the coordinate specified in the argument

Definition at line 195 of file MeshVertex.hpp.

◆ coordinates()

Vector3D const& coordinates ( ) const

inline

Returns the coordinates vector.

The method allows to access coordinates and modify them

Returns: Coordinates array

Definition at line 211 of file MeshVertex.hpp.

Field Documentation

◆ M_coordinates

Vector3D M_coordinates

private

Definition at line 219 of file MeshVertex.hpp.

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

Private Attributes

Public Types

Constructor & Destructor

Methods

Get Methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ geoShape_Type

Constructor & Destructor Documentation

◆ MeshVertex() [1/3]

◆ MeshVertex() [2/3]

◆ MeshVertex() [3/3]

◆ ~MeshVertex()

Member Function Documentation

◆ showMe()

◆ coordinatesArray()

◆ x() [1/2]

◆ y() [1/2]

◆ z() [1/2]

◆ x() [2/2]

◆ y() [2/2]

◆ z() [2/2]

◆ coordinate() [1/2]

◆ coordinate() [2/2]

◆ coordinates()

Field Documentation

◆ M_coordinates