Public Member Functions | Private Attributes | Friends
topoDistanceData Class Reference

For use with FaceCellWave. Determines topological distance to starting faces. More...

Public Member Functions

 topoDistanceData ()
 Construct null. More...
 
 topoDistanceData (const label data, const label distance)
 Construct from count. More...
 
label data () const
 
label distance () const
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Check whether origin has been changed at all or. More...
 
template<class TrackingData >
bool sameGeometry (const polyMesh &, const topoDistanceData &, const scalar, TrackingData &td) const
 Check for identical geometrical data. Used for 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 &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 &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFaceI, const topoDistanceData &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const topoDistanceData &, TrackingData &td) const
 Same (like operator==) More...
 
bool operator== (const topoDistanceData &) const
 
bool operator!= (const topoDistanceData &) const
 

Private Attributes

label data_
 Starting data. More...
 
label distance_
 Distance. More...
 

Friends

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

Detailed Description

For use with FaceCellWave. Determines topological distance to starting faces.

Source files

Definition at line 53 of file topoDistanceData.H.

Constructor & Destructor Documentation

◆ topoDistanceData() [1/2]

topoDistanceData ( )
inline

Construct null.

Definition at line 34 of file topoDistanceDataI.H.

◆ topoDistanceData() [2/2]

topoDistanceData ( const label  data,
const label  distance 
)
inline

Construct from count.

Definition at line 43 of file topoDistanceDataI.H.

Member Function Documentation

◆ data()

label data ( ) const
inline

Definition at line 84 of file topoDistanceData.H.

References topoDistanceData::data_.

Referenced by topoDistanceData::operator==().

Here is the caller graph for this function:

◆ distance()

label distance ( ) const
inline

Definition at line 88 of file topoDistanceData.H.

References topoDistanceData::distance_.

Referenced by topoDistanceData::operator==().

Here is the caller graph for this function:

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether origin has been changed at all or.

still contains original (invalid) value.

Definition at line 56 of file topoDistanceDataI.H.

◆ sameGeometry()

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

Check for identical geometrical data. Used for cyclics checking.

Definition at line 65 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 79 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 103 of file topoDistanceDataI.H.

◆ transform()

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

Apply rotation matrix to any coordinates.

Definition at line 92 of file topoDistanceDataI.H.

◆ updateCell()

bool updateCell ( const polyMesh ,
const label  thisCellI,
const label  neighbourFaceI,
const topoDistanceData neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring face.

Definition at line 116 of file topoDistanceDataI.H.

◆ updateFace() [1/2]

bool updateFace ( const polyMesh mesh,
const label  thisFaceI,
const label  neighbourCellI,
const topoDistanceData neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring cell.

Definition at line 140 of file topoDistanceDataI.H.

References topoDistanceData::data_, and topoDistanceData::distance_.

◆ updateFace() [2/2]

bool updateFace ( const polyMesh ,
const label  thisFaceI,
const topoDistanceData neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same face.

Definition at line 167 of file topoDistanceDataI.H.

◆ equal()

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

Same (like operator==)

Definition at line 190 of file topoDistanceDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const topoDistanceData rhs) const
inline

Definition at line 202 of file topoDistanceDataI.H.

References topoDistanceData::data(), Foam::distance(), and topoDistanceData::distance().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const topoDistanceData rhs) const
inline

Definition at line 211 of file topoDistanceDataI.H.

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

Istream& operator>> ( Istream ,
topoDistanceData  
)
friend

Field Documentation

◆ data_

label data_
private

Starting data.

Definition at line 58 of file topoDistanceData.H.

Referenced by topoDistanceData::data(), and topoDistanceData::updateFace().

◆ distance_

label distance_
private

Distance.

Definition at line 61 of file topoDistanceData.H.

Referenced by topoDistanceData::distance(), and topoDistanceData::updateFace().


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