Public Member Functions | Friends | List of all members
topoDistanceData< Type > Class Template Reference

For use with FaceCellWave. Determines topological distance to starting faces. Templated on passive transported data. More...

Public Member Functions

 topoDistanceData ()
 Construct null with invalid (-1) for distance, null constructor. More...
 
 topoDistanceData (const label distance, const Type &data)
 Construct from components. More...
 
label distance () const
 
const Type & data () const
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value. More...
 
template<class TrackingData >
bool sameGeometry (const polyMesh &, const topoDistanceData< Type > &, const scalar, TrackingData &td) const
 Check for identical geometrical data (eg, cyclics checking) More...
 
template<class TrackingData >
void leaveDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
 Convert any absolute coordinates into relative to (patch)face. More...
 
template<class TrackingData >
void enterDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
 Reverse of leaveDomain. More...
 
template<class TrackingData >
void transform (const polyMesh &, const tensor &, TrackingData &td)
 Apply rotation matrix to any coordinates. More...
 
template<class TrackingData >
bool updateCell (const polyMesh &, const label thisCelli, const label neighbourFacei, const topoDistanceData< Type > &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 topoDistanceData< Type > &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, const topoDistanceData< Type > &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const topoDistanceData< Type > &, TrackingData &td) const
 Test for equality, with TrackingData. More...
 
bool operator== (const topoDistanceData< Type > &) const
 
bool operator!= (const topoDistanceData< Type > &) const
 

Friends

Ostream & operator (Ostream &, const topoDistanceData< Type > &)
 
Istream & operator>> (Istream &, topoDistanceData< Type > &)
 

Detailed Description

template<class Type>
class Foam::topoDistanceData< Type >

For use with FaceCellWave. Determines topological distance to starting faces. Templated on passive transported data.

Source files

Definition at line 53 of file topoDistanceData.H.

Constructor & Destructor Documentation

◆ topoDistanceData() [1/2]

topoDistanceData ( )
inline

Construct null with invalid (-1) for distance, null constructor.

for data

Definition at line 34 of file topoDistanceDataI.H.

◆ topoDistanceData() [2/2]

topoDistanceData ( const label  distance,
const Type &  data 
)
inline

Construct from components.

Definition at line 43 of file topoDistanceDataI.H.

Member Function Documentation

◆ distance()

label distance ( ) const
inline

Definition at line 96 of file topoDistanceData.H.

Referenced by structuredRenumber::layerLess::operator()(), and topoDistanceData< Type >::operator==().

Here is the caller graph for this function:

◆ data()

const Type& data ( ) const
inline

Definition at line 101 of file topoDistanceData.H.

Referenced by structuredRenumber::layerLess::operator()(), and topoDistanceData< Type >::operator==().

Here is the caller graph for this function:

◆ valid()

bool valid ( TrackingData &  td) const
inline

Changed or contains original (invalid) value.

Definition at line 57 of file topoDistanceDataI.H.

Referenced by structuredRenumber::layerLess::operator()().

Here is the caller graph for this function:

◆ sameGeometry()

bool sameGeometry ( const polyMesh &  ,
const topoDistanceData< Type > &  ,
const  scalar,
TrackingData &  td 
) const
inline

Check for identical geometrical data (eg, cyclics checking)

Definition at line 67 of file topoDistanceDataI.H.

◆ leaveDomain()

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 82 of file topoDistanceDataI.H.

◆ enterDomain()

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

Reverse of leaveDomain.

Definition at line 108 of file topoDistanceDataI.H.

◆ transform()

void transform ( const polyMesh &  ,
const tensor &  rotTensor,
TrackingData &  td 
)
inline

Apply rotation matrix to any coordinates.

Definition at line 96 of file topoDistanceDataI.H.

◆ updateCell()

bool updateCell ( const polyMesh &  ,
const label  thisCelli,
const label  neighbourFacei,
const topoDistanceData< Type > &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring face.

Definition at line 122 of file topoDistanceDataI.H.

◆ updateFace() [1/2]

bool updateFace ( const polyMesh &  mesh,
const label  thisFacei,
const label  neighbourCelli,
const topoDistanceData< Type > &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring cell.

Definition at line 145 of file topoDistanceDataI.H.

◆ updateFace() [2/2]

bool updateFace ( const polyMesh &  ,
const label  thisFacei,
const topoDistanceData< Type > &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same face.

Definition at line 171 of file topoDistanceDataI.H.

◆ equal()

bool equal ( const topoDistanceData< Type > &  rhs,
TrackingData &  td 
) const
inline

Test for equality, with TrackingData.

Definition at line 193 of file topoDistanceDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const topoDistanceData< Type > &  rhs) const
inline

Definition at line 206 of file topoDistanceDataI.H.

References topoDistanceData< Type >::data(), Foam::distance(), and topoDistanceData< Type >::distance().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const topoDistanceData< Type > &  rhs) const
inline

Definition at line 216 of file topoDistanceDataI.H.

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream &  ,
const topoDistanceData< Type > &   
)
friend

◆ operator>>

Istream& operator>> ( Istream &  ,
topoDistanceData< Type > &   
)
friend
The documentation for this class was generated from the following files: