LifeV
Private Attributes
BCIdentifierEssential Class Reference

BCIdentifierEssential - BCIdentifier for implementing Essential Boundary Conditions. More...

#include <BCIdentifier.hpp>

+ Inheritance diagram for BCIdentifierEssential:
+ Collaboration diagram for BCIdentifierEssential:

Private Attributes

Real M_x
 
Real M_y
 
Real M_z
 
 BCIdentifierEssential ()
 Constructor & Destructor. More...
 
 BCIdentifierEssential (const ID &id, const Real &x, const Real &y, const Real &z)
 Constructor given the ID and the coordinates. More...
 
 BCIdentifierEssential (BCIdentifierEssential const &id)
 Copy Constructor. More...
 

Methods

virtual void showMe (std::ostream &output=std::cout) const
 Display method. More...
 

Get Methods

const Real & x () const
 Recovering the node's x-coordinate. More...
 
const Real & y () const
 Recovering the node's y-coordinate. More...
 
const Real & z () const
 Recovering the node's z-coordinate. More...
 

Additional Inherited Members

- Public Member Functions inherited from BCIdentifierBase
 BCIdentifierBase ()
 Empty Constructor. More...
 
 BCIdentifierBase (ID const &i)
 Constructor given the ID. More...
 
 BCIdentifierBase (BCIdentifierBase const &id)
 Copy constructor. More...
 
virtual ~BCIdentifierBase ()
 Destructor. More...
 
 operator unsigned int ()
 Conversion operator to unsigned int. More...
 
 operator int ()
 Conversion operator to int. More...
 
const ID & id () const
 Returns the ID of the BCIdentifier. More...
 
- Protected Attributes inherited from BCIdentifierBase
ID M_id
 

Detailed Description

BCIdentifierEssential - BCIdentifier for implementing Essential Boundary Conditions.

This class holds the DOF identifier and its coordinates for implementing Essential Boundary Conditions

Definition at line 178 of file BCIdentifier.hpp.

Constructor & Destructor Documentation

◆ BCIdentifierEssential() [1/3]

BCIdentifierEssential ( )
inline

Constructor & Destructor.

Empty Constructor

Definition at line 186 of file BCIdentifier.hpp.

◆ BCIdentifierEssential() [2/3]

BCIdentifierEssential ( const ID &  id,
const Real &  x,
const Real &  y,
const Real &  z 
)
inline

Constructor given the ID and the coordinates.

Creates an BCIdentifier with a given ID and given coordinates x x-coordinate of the node where this BC applies y y-coordinate of the node where this BC applies z z-coordinate of the node where this BC applies

Definition at line 198 of file BCIdentifier.hpp.

◆ BCIdentifierEssential() [3/3]

BCIdentifierEssential ( BCIdentifierEssential const &  id)

Copy Constructor.

Definition at line 71 of file BCIdentifier.cpp.

Member Function Documentation

◆ showMe()

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

Display method.

Reimplemented from BCIdentifierBase.

Definition at line 83 of file BCIdentifier.cpp.

◆ x()

const Real& x ( ) const
inline

Recovering the node's x-coordinate.

Returns
The x-coordinate of the node

Definition at line 227 of file BCIdentifier.hpp.

+ Here is the caller graph for this function:

◆ y()

const Real& y ( ) const
inline

Recovering the node's y-coordinate.

Returns
The y-coordinate of the node

Definition at line 236 of file BCIdentifier.hpp.

+ Here is the caller graph for this function:

◆ z()

const Real& z ( ) const
inline

Recovering the node's z-coordinate.

Returns
The z-coordinate of the node

Definition at line 245 of file BCIdentifier.hpp.

+ Here is the caller graph for this function:

Field Documentation

◆ M_x

Real M_x
private

Definition at line 254 of file BCIdentifier.hpp.

◆ M_y

Real M_y
private

Definition at line 254 of file BCIdentifier.hpp.

◆ M_z

Real M_z
private

Definition at line 254 of file BCIdentifier.hpp.

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