LifeV
GetCoordComponent Class Reference

This functor is used to do some geometry checks. More...

#include <MeshUtility.hpp>

+ Collaboration diagram for GetCoordComponent:

Private Attributes

Int componentIndex
 

Constructor & Destructor

 GetCoordComponent ()
 Empty Constructor. More...
 
 GetCoordComponent (Int i)
 Constructor taking the component. More...
 
 GetCoordComponent (const GetCoordComponent &getCoordComponent)
 Copy constructor. More...
 
virtual ~GetCoordComponent ()
 Virtual Destructor. More...
 

Operators

void operator() (Real const &x, Real const &y, Real const &z, Real ret[3]) const
 The function call operator. More...
 

Detailed Description

This functor is used to do some geometry checks.

It is instantiated with the index of the component to be extracted from a vector of geometric coordinates.

Definition at line 320 of file MeshUtility.hpp.

Constructor & Destructor Documentation

◆ GetCoordComponent() [1/3]

Empty Constructor.

Definition at line 46 of file MeshUtility.cpp.

◆ GetCoordComponent() [2/3]

GetCoordComponent ( Int  i)
explicit

Constructor taking the component.

Parameters
ithe index of the component to be extracted from a vector of geometric coordinates

Definition at line 49 of file MeshUtility.cpp.

+ Here is the caller graph for this function:

◆ GetCoordComponent() [3/3]

GetCoordComponent ( const GetCoordComponent getCoordComponent)
inline

Copy constructor.

Definition at line 337 of file MeshUtility.hpp.

◆ ~GetCoordComponent()

virtual ~GetCoordComponent ( )
inlinevirtual

Virtual Destructor.

Definition at line 342 of file MeshUtility.hpp.

Member Function Documentation

◆ operator()()

void operator() ( Real const &  x,
Real const &  y,
Real const &  z,
Real  ret[3] 
) const

The function call operator.

If componentIndex is valid (0 <= 2), the function call operator will operate on a vector by returning a new vector of geometric coordinates, with the single non null component corresponding to the componentIndex.

Otherwise, the vector given as an argument will be returned unchanged.

Parameters
[in]xfirst component of the input vector
[in]ysecond component of the input vector
[in]zthird component of the input vector
[out]retoutput vector

Definition at line 55 of file MeshUtility.cpp.

Field Documentation

◆ componentIndex

Int componentIndex
private

Definition at line 368 of file MeshUtility.hpp.


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