layerInfo Class Reference

Class to be used with FaceCellWave which enumerates layers of cells. More...

Public Member Functions

 layerInfo ()
 Construct null. More...
 
 layerInfo (const label faceLayer, const label direction)
 Construct given the face layer index and direction. More...
 
label faceLayer () const
 Return the face layer index. More...
 
label cellLayer () const
 Return the face layer index. More...
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Check whether the layerInfo has been changed at all or still. More...
 
template<class TrackingData >
bool sameGeometry (const polyMesh &, const layerInfo &, const scalar, TrackingData &td) const
 Check for identical geometrical data. Used for checking. More...
 
template<class TrackingData >
void transform (const polyPatch &patch, const label patchFacei, const transformer &transform, TrackingData &td)
 Transform across an interface. More...
 
template<class TrackingData >
bool updateCell (const polyMesh &, const label thisCelli, const label neighbourFacei, const layerInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring face. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, const label neighbourCelli, const layerInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, const layerInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const layerInfo &, TrackingData &td) const
 Test equality. More...
 
bool operator== (const layerInfo &) const
 
bool operator!= (const layerInfo &) const
 

Friends

Ostreamoperator<< (Ostream &, const layerInfo &)
 
Istreamoperator>> (Istream &, layerInfo &)
 

Detailed Description

Class to be used with FaceCellWave which enumerates layers of cells.

Source files

Definition at line 59 of file layerInfo.H.

Constructor & Destructor Documentation

◆ layerInfo() [1/2]

layerInfo ( )
inline

Construct null.

Definition at line 43 of file layerInfoI.H.

◆ layerInfo() [2/2]

layerInfo ( const label  faceLayer,
const label  direction 
)
inline

Construct given the face layer index and direction.

Definition at line 51 of file layerInfoI.H.

Member Function Documentation

◆ faceLayer()

Foam::label faceLayer ( ) const
inline

Return the face layer index.

Definition at line 61 of file layerInfoI.H.

References Foam::exit(), and Foam::FatalError.

Here is the call graph for this function:

◆ cellLayer()

Foam::label cellLayer ( ) const
inline

Return the face layer index.

Definition at line 74 of file layerInfoI.H.

References Foam::exit(), and Foam::FatalError.

Here is the call graph for this function:

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether the layerInfo has been changed at all or still.

contains original (invalid) value.

Definition at line 88 of file layerInfoI.H.

References Foam::labelMax, and layerInfo::sameGeometry().

Referenced by layerInfo::updateCell(), and layerInfo::updateFace().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ sameGeometry()

bool sameGeometry ( const polyMesh ,
const layerInfo l,
const scalar  tol,
TrackingData &  td 
) const
inline

Check for identical geometrical data. Used for checking.

consistency across cyclics.

Definition at line 96 of file layerInfoI.H.

References layerInfo::transform().

Referenced by layerInfo::valid().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ transform()

void transform ( const polyPatch patch,
const label  patchFacei,
const transformer transform,
TrackingData &  td 
)
inline

Transform across an interface.

Definition at line 109 of file layerInfoI.H.

References layerInfo::updateCell().

Referenced by layerInfo::sameGeometry().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateCell()

bool updateCell ( const polyMesh mesh,
const label  thisCelli,
const label  neighbourFacei,
const layerInfo neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring face.

Definition at line 120 of file layerInfoI.H.

References polyMesh::faceOwner(), Foam::labelMax, layerInfo::updateFace(), and layerInfo::valid().

Referenced by layerInfo::transform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateFace() [1/2]

bool updateFace ( const polyMesh mesh,
const label  thisFacei,
const label  neighbourCelli,
const layerInfo neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring cell.

Definition at line 150 of file layerInfoI.H.

References Foam::constant::universal::c, primitiveMesh::cells(), polyMesh::faceOwner(), polyMesh::faces(), Foam::labelMax, cell::opposingFaceLabel(), and layerInfo::valid().

Referenced by layerInfo::updateCell().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateFace() [2/2]

bool updateFace ( const polyMesh mesh,
const label  thisFacei,
const layerInfo neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same face.

Definition at line 185 of file layerInfoI.H.

References layerInfo::equal(), Foam::labelMax, and layerInfo::valid().

Here is the call graph for this function:

◆ equal()

bool equal ( const layerInfo rhs,
TrackingData &  td 
) const
inline

Test equality.

Definition at line 207 of file layerInfoI.H.

References layerInfo::operator==().

Referenced by layerInfo::updateFace().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator==()

bool operator== ( const layerInfo rhs) const
inline

Definition at line 218 of file layerInfoI.H.

Referenced by layerInfo::equal().

Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const layerInfo rhs) const
inline

Definition at line 224 of file layerInfoI.H.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream ,
const layerInfo  
)
friend

◆ operator>>

Istream& operator>> ( Istream ,
layerInfo  
)
friend

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