Classes | Public Member Functions | Friends | List of all members
smoothData Class Reference

Helper class used by the fvc::smooth and fvc::spread functions. More...

Classes

class  trackData
 Class used to pass additional data in. More...
 

Public Member Functions

 smoothData ()
 Construct null. More...
 
 smoothData (const scalar value)
 Construct from inverse field value. More...
 
scalar value () const
 Return value. More...
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Check whether origin has been changed at all or. More...
 
template<class TrackingData >
bool sameGeometry (const fvMesh &, const smoothData &, const scalar, TrackingData &td) const
 Check for identical geometrical data. More...
 
template<class TrackingData >
void transform (const fvPatch &patch, const label patchFacei, const transformer &transform, TrackingData &td)
 Transform across an interface. More...
 
template<class TrackingData >
bool updateCell (const fvMesh &, const label thisCelli, const labelPair &neighbourPatchAndFacei, const smoothData &svf, const scalar tol, TrackingData &td)
 Influence of neighbouring face. More...
 
template<class TrackingData >
bool updateFace (const fvMesh &, const labelPair &thisPatchAndFacei, const label neighbourCelli, const smoothData &svf, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const fvMesh &, const labelPair &thisPatchAndFacei, const smoothData &svf, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const smoothData &, TrackingData &td) const
 Same (like operator==) More...
 
void operator= (const scalar value)
 
bool operator== (const smoothData &) const
 
bool operator!= (const smoothData &) const
 

Friends

Ostream & operator<< (Ostream &os, const smoothData &svf)
 
Istream & operator>> (Istream &is, smoothData &svf)
 

Detailed Description

Helper class used by the fvc::smooth and fvc::spread functions.

Source files

Definition at line 55 of file smoothData.H.

Constructor & Destructor Documentation

◆ smoothData() [1/2]

smoothData ( )
inline

Construct null.

Definition at line 68 of file smoothDataI.H.

◆ smoothData() [2/2]

smoothData ( const scalar  value)
inline

Construct from inverse field value.

Definition at line 74 of file smoothDataI.H.

Member Function Documentation

◆ value()

scalar value ( ) const
inline

Return value.

Definition at line 105 of file smoothData.H.

Referenced by smoothData::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 83 of file smoothDataI.H.

◆ sameGeometry()

bool sameGeometry ( const fvMesh &  ,
const smoothData &  ,
const  scalar,
TrackingData &  td 
) const
inline

Check for identical geometrical data.

Used for cyclics checking

Definition at line 90 of file smoothDataI.H.

◆ transform()

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

Transform across an interface.

Definition at line 103 of file smoothDataI.H.

◆ updateCell()

bool updateCell ( const fvMesh &  ,
const label  thisCelli,
const labelPair &  neighbourPatchAndFacei,
const smoothData &  svf,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring face.

Definition at line 114 of file smoothDataI.H.

◆ updateFace() [1/2]

bool updateFace ( const fvMesh &  ,
const labelPair &  thisPatchAndFacei,
const label  neighbourCelli,
const smoothData &  svf,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring cell.

Definition at line 130 of file smoothDataI.H.

◆ updateFace() [2/2]

bool updateFace ( const fvMesh &  ,
const labelPair &  thisPatchAndFacei,
const smoothData &  svf,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same face.

Definition at line 147 of file smoothDataI.H.

◆ equal()

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

Same (like operator==)

Definition at line 162 of file smoothDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator=()

void operator= ( const scalar  value)
inline

Definition at line 174 of file smoothDataI.H.

◆ operator==()

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

Definition at line 180 of file smoothDataI.H.

References smoothData::value().

Here is the call graph for this function:

◆ operator!=()

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

Definition at line 186 of file smoothDataI.H.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const smoothData &  svf 
)
friend

Definition at line 190 of file smoothData.H.

◆ operator>>

Istream& operator>> ( Istream &  is,
smoothData &  svf 
)
friend

Definition at line 195 of file smoothData.H.

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