minData Class Reference

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

Public Member Functions

 minData ()
 Default construct. More...
 
 minData (const label data)
 Construct from min value. More...
 
label 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 minData &, 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 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
 Test for equality, with TrackingData. More...
 
bool operator== (const minData &) const
 Test for equality. More...
 
bool operator!= (const minData &) const
 Test for inequality. More...
 

Friends

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

Detailed Description

For use with FaceCellWave. Transports minimum passive data.

Source files

Definition at line 60 of file minData.H.

Constructor & Destructor Documentation

◆ minData() [1/2]

minData ( )
inline

Default construct.

Definition at line 33 of file minDataI.H.

References Foam::labelMax.

◆ minData() [2/2]

minData ( const label  data)
inline

Construct from min value.

Definition at line 39 of file minDataI.H.

Member Function Documentation

◆ data()

label data ( ) const
inline

Definition at line 83 of file minData.H.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Changed or contains original (invalid) value.

Definition at line 48 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 (eg, cyclics checking)

Definition at line 55 of file minDataI.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 68 of file minDataI.H.

◆ enterDomain()

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

Reverse of leaveDomain.

Definition at line 90 of file minDataI.H.

◆ transform()

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

Apply rotation matrix to any coordinates.

Definition at line 80 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 102 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 123 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 145 of file minDataI.H.

◆ equal()

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

Test for equality, with TrackingData.

Definition at line 166 of file minDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const minData rhs) const
inline

Test for equality.

Definition at line 178 of file minDataI.H.

◆ operator!=()

bool operator!= ( const minData rhs) const
inline

Test for inequality.

Definition at line 187 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: