minData Class Reference

For use with FaceCellWave. Transports minimum passive data. More...

Public Member Functions

 minData ()
 Construct null. More...
 
 minData (const label data)
 Construct from count. More...
 
label data () 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 minData &, const scalar, TrackingData &td) const
 Check for identical geometrical data. Used for cyclics 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 minData &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 minData &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, const minData &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const minData &, TrackingData &td) const
 Same (like operator==) More...
 
bool operator== (const minData &) const
 
bool operator!= (const minData &) const
 

Friends

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

Detailed Description

For use with FaceCellWave. Transports minimum passive data.

Source files

Definition at line 63 of file minData.H.

Constructor & Destructor Documentation

◆ minData() [1/2]

minData ( )
inline

Construct null.

Definition at line 30 of file minDataI.H.

◆ minData() [2/2]

minData ( const label  data)
inline

Construct from count.

Definition at line 36 of file minDataI.H.

Member Function Documentation

◆ data()

label data ( ) const
inline

Definition at line 86 of file minData.H.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether origin has been changed at all or.

still contains original (invalid) value.

Definition at line 45 of file minDataI.H.

References Foam::labelMax.

◆ sameGeometry()

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

Check for identical geometrical data. Used for cyclics checking.

Definition at line 52 of file minDataI.H.

◆ transform()

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

Transform across an interface.

Definition at line 65 of file minDataI.H.

◆ updateCell()

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

Influence of neighbouring face.

Definition at line 76 of file minDataI.H.

◆ updateFace() [1/2]

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

Influence of neighbouring cell.

Definition at line 99 of file minDataI.H.

◆ updateFace() [2/2]

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

Influence of different value on same face.

Definition at line 124 of file minDataI.H.

◆ equal()

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

Same (like operator==)

Definition at line 147 of file minDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const minData rhs) const
inline

Definition at line 159 of file minDataI.H.

◆ operator!=()

bool operator!= ( const minData rhs) const
inline

Definition at line 168 of file minDataI.H.

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

Istream& operator>> ( Istream ,
minData  
)
friend

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