Loading...
Searching...
No Matches
cellInfo Class Reference

Holds information regarding type of cell. Used in inside/outside determination in cellClassification. More...

#include <cellInfo.H>

Public Member Functions

 cellInfo ()
 Default construct - as cellClassification::NOTSET.
 cellInfo (const label ctype)
 Construct from cellClassification type.
label type () const
label & type ()
template<class TrackingData>
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value.
template<class TrackingData>
bool sameGeometry (const polyMesh &, const cellInfo &, const scalar, TrackingData &td) const
 Check for identical geometrical data (eg, cyclics checking).
template<class TrackingData>
void leaveDomain (const polyMesh &, const polyPatch &patch, const label patchFacei, const point &faceCentre, TrackingData &td)
 Convert any absolute coordinates into relative to (patch)face.
template<class TrackingData>
void enterDomain (const polyMesh &, const polyPatch &patch, const label patchFacei, const point &faceCentre, TrackingData &td)
 Reverse of leaveDomain.
template<class TrackingData>
void transform (const polyMesh &, const tensor &rotTensor, TrackingData &td)
 Apply rotation matrix to any coordinates.
template<class TrackingData>
bool updateCell (const polyMesh &, const label thisCelli, const label neighbourFacei, const cellInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring face.
template<class TrackingData>
bool updateFace (const polyMesh &, const label thisFacei, const label neighbourCelli, const cellInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell.
template<class TrackingData>
bool updateFace (const polyMesh &, const label thisFacei, const cellInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face.
template<class TrackingData>
bool equal (const cellInfo &, TrackingData &td) const
 Test for equality, with TrackingData.
template<class TrackingData>
bool interpolate (const polyMesh &, const point &pt, const label i0, const cellInfo &f0, const label i1, const cellInfo &f1, const scalar weight, const scalar tol, TrackingData &td)
 Interpolate between two values (lerp). Returns true if causes changes. Not sure if needs to be specialised between face and cell and what index is needed...
bool operator== (const cellInfo &) const
 Test for equality.
bool operator!= (const cellInfo &) const
 Test for inequality.

Friends

Ostream & operator<< (Ostream &, const cellInfo &)
Istream & operator>> (Istream &, cellInfo &)

Detailed Description

Holds information regarding type of cell. Used in inside/outside determination in cellClassification.

Source files

Definition at line 60 of file cellInfo.H.

Constructor & Destructor Documentation

◆ cellInfo() [1/2]

cellInfo ( )
inline

Default construct - as cellClassification::NOTSET.

Definition at line 91 of file cellInfoI.H.

Referenced by equal(), interpolate(), operator!=(), operator<<, operator==(), operator>>, sameGeometry(), updateCell(), updateFace(), and updateFace().

Here is the caller graph for this function:

◆ cellInfo() [2/2]

cellInfo ( const label ctype)
inlineexplicit

Construct from cellClassification type.

Definition at line 97 of file cellInfoI.H.

Member Function Documentation

◆ type() [1/2]

label type ( ) const
inline

Definition at line 105 of file cellInfo.H.

◆ type() [2/2]

label & type ( )
inline

Definition at line 109 of file cellInfo.H.

◆ valid()

template<class TrackingData>
bool valid ( TrackingData & td) const
inline

Changed or contains original (invalid) value.

Definition at line 106 of file cellInfoI.H.

References cellClassification::NOTSET, and td().

Referenced by interpolate(), and FaceCellWave< Type, TrackingData >::updateCell().

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

◆ sameGeometry()

template<class TrackingData>
bool sameGeometry ( const polyMesh & ,
const cellInfo & w2,
const scalar tol,
TrackingData & td ) const
inline

Check for identical geometrical data (eg, cyclics checking).

Definition at line 114 of file cellInfoI.H.

References cellInfo(), td(), and w2.

Here is the call graph for this function:

◆ leaveDomain()

template<class TrackingData>
void leaveDomain ( const polyMesh & ,
const polyPatch & patch,
const label patchFacei,
const point & faceCentre,
TrackingData & td )
inline

Convert any absolute coordinates into relative to (patch)face.

centre

Definition at line 128 of file cellInfoI.H.

References td().

Here is the call graph for this function:

◆ enterDomain()

template<class TrackingData>
void enterDomain ( const polyMesh & ,
const polyPatch & patch,
const label patchFacei,
const point & faceCentre,
TrackingData & td )
inline

Reverse of leaveDomain.

Definition at line 152 of file cellInfoI.H.

References td().

Here is the call graph for this function:

◆ transform()

template<class TrackingData>
void transform ( const polyMesh & ,
const tensor & rotTensor,
TrackingData & td )
inline

Apply rotation matrix to any coordinates.

Definition at line 141 of file cellInfoI.H.

References td().

Here is the call graph for this function:

◆ updateCell()

template<class TrackingData>
bool updateCell ( const polyMesh & ,
const label thisCelli,
const label neighbourFacei,
const cellInfo & neighbourInfo,
const scalar tol,
TrackingData & td )
inline

Influence of neighbouring face.

Definition at line 165 of file cellInfoI.H.

References cellInfo(), td(), and update().

Referenced by FaceCellWave< Type, TrackingData >::updateCell().

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

◆ updateFace() [1/2]

template<class TrackingData>
bool updateFace ( const polyMesh & ,
const label thisFacei,
const label neighbourCelli,
const cellInfo & neighbourInfo,
const scalar tol,
TrackingData & td )
inline

Influence of neighbouring cell.

Definition at line 189 of file cellInfoI.H.

References cellInfo(), td(), and update().

Here is the call graph for this function:

◆ updateFace() [2/2]

template<class TrackingData>
bool updateFace ( const polyMesh & ,
const label thisFacei,
const cellInfo & neighbourInfo,
const scalar tol,
TrackingData & td )
inline

Influence of different value on same face.

Definition at line 213 of file cellInfoI.H.

References cellInfo(), td(), and update().

Here is the call graph for this function:

◆ equal()

template<class TrackingData>
bool equal ( const cellInfo & rhs,
TrackingData & td ) const
inline

Test for equality, with TrackingData.

Definition at line 235 of file cellInfoI.H.

References cellInfo(), Foam::operator==(), Foam::rhs(), and td().

Here is the call graph for this function:

◆ interpolate()

template<class TrackingData>
bool interpolate ( const polyMesh & ,
const point & pt,
const label i0,
const cellInfo & f0,
const label i1,
const cellInfo & f1,
const scalar weight,
const scalar tol,
TrackingData & td )
inline

Interpolate between two values (lerp). Returns true if causes changes. Not sure if needs to be specialised between face and cell and what index is needed...

Definition at line 246 of file cellInfoI.H.

References cellInfo(), td(), update(), and valid().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const cellInfo & rhs) const
inline

Test for equality.

Definition at line 272 of file cellInfoI.H.

References cellInfo(), and Foam::rhs().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const cellInfo & rhs) const
inline

Test for inequality.

Definition at line 281 of file cellInfoI.H.

References cellInfo(), and Foam::rhs().

Here is the call graph for this function:

◆ operator<<

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

References cellInfo().

◆ operator>>

Istream & operator>> ( Istream & ,
cellInfo &  )
friend

References cellInfo().

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