Loading...
Searching...
No Matches
minData Class Reference

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

#include <minData.H>

Public Member Functions

 minData ()
 Default construct.
 minData (const label data)
 Construct from min value.
label data () const
template<class TrackingData>
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value.
template<class TrackingData>
bool sameGeometry (const polyMesh &, const minData &, const scalar, TrackingData &td) const
 Check for identical geometrical data (eg, cyclics checking).
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.
template<class TrackingData>
void enterDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
 Reverse of leaveDomain.
template<class TrackingData>
void transform (const polyMesh &, const tensor &, TrackingData &td)
 Apply rotation matrix to any coordinates.
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.
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.
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.
template<class TrackingData>
bool equal (const minData &, TrackingData &td) const
 Test for equality, with TrackingData.
template<class TrackingData>
bool interpolate (const polyMesh &, const point &pt, const label i0, const minData &f0, const label i1, const minData &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 minData &) const
 Test for equality.
bool operator!= (const minData &) const
 Test for inequality.

Friends

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

Detailed Description

For use with FaceCellWave. Transports minimum passive data.

Source files

Definition at line 56 of file minData.H.

Constructor & Destructor Documentation

◆ minData() [1/2]

minData ( )
inline

Default construct.

Definition at line 26 of file minDataI.H.

References Foam::labelMax.

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

Here is the caller graph for this function:

◆ minData() [2/2]

minData ( const label data)
inline

Construct from min value.

Definition at line 32 of file minDataI.H.

References data().

Here is the call graph for this function:

Member Function Documentation

◆ data()

label data ( ) const
inline

Definition at line 85 of file minData.H.

Referenced by minData().

Here is the caller graph for this function:

◆ valid()

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

Changed or contains original (invalid) value.

Definition at line 41 of file minDataI.H.

References Foam::labelMax, and td().

Referenced by interpolate().

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 minData & ,
const scalar ,
TrackingData & td ) const
inline

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

Definition at line 48 of file minDataI.H.

References minData().

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 61 of file minDataI.H.

◆ 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 83 of file minDataI.H.

◆ transform()

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

Apply rotation matrix to any coordinates.

Definition at line 73 of file minDataI.H.

◆ updateCell()

template<class TrackingData>
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 95 of file minDataI.H.

References minData().

Here is the call graph for this function:

◆ updateFace() [1/2]

template<class TrackingData>
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 116 of file minDataI.H.

References mesh, and minData().

Referenced by interpolate().

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

◆ updateFace() [2/2]

template<class TrackingData>
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 138 of file minDataI.H.

References minData().

Here is the call graph for this function:

◆ equal()

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

Test for equality, with TrackingData.

Definition at line 159 of file minDataI.H.

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

Here is the call graph for this function:

◆ interpolate()

template<class TrackingData>
bool interpolate ( const polyMesh & mesh,
const point & pt,
const label i0,
const minData & f0,
const label i1,
const minData & 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 170 of file minDataI.H.

References mesh, minData(), td(), updateFace(), and valid().

Here is the call graph for this function:

◆ operator==()

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

Test for equality.

Definition at line 200 of file minDataI.H.

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

Here is the call graph for this function:

◆ operator!=()

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

Test for inequality.

Definition at line 209 of file minDataI.H.

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

Here is the call graph for this function:

◆ operator<<

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

References minData().

◆ operator>>

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

References minData().

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