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 (const smoothData &)=default
 Copy construct. More...
 
smoothData & operator= (const smoothData &)=default
 Copy assignment. More...
 
 smoothData ()
 Default construct. More...
 
 smoothData (const scalar value)
 Construct from inverse field value. More...
 
scalar value () const
 Return value. More...
 
scalar & value ()
 The value. More...
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value. More...
 
template<class TrackingData >
bool sameGeometry (const polyMesh &, const smoothData &, 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 centre. 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 smoothData &svf, const scalar tol, TrackingData &td)
 Influence of neighbouring face. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, const label neighbourCelli, const smoothData &svf, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, 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
 Test for equality, with TrackingData. More...
 
void operator= (const scalar value)
 Assign new value. More...
 
bool operator== (const smoothData &) const
 Test for equality. More...
 
bool operator!= (const smoothData &) const
 Test for inequality. More...
 

Friends

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

Detailed Description

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

Source files

Definition at line 52 of file smoothData.H.

Constructor & Destructor Documentation

◆ smoothData() [1/3]

smoothData ( const smoothData &  )
default

Copy construct.

◆ smoothData() [2/3]

smoothData ( )
inline

Default construct.

Definition at line 60 of file smoothDataI.H.

◆ smoothData() [3/3]

smoothData ( const scalar  value)
inline

Construct from inverse field value.

Definition at line 66 of file smoothDataI.H.

Member Function Documentation

◆ operator=() [1/2]

smoothData& operator= ( const smoothData &  )
default

Copy assignment.

◆ value() [1/2]

scalar value ( ) const
inline

Return value.

Definition at line 124 of file smoothData.H.

Referenced by smoothData::operator=().

Here is the caller graph for this function:

◆ value() [2/2]

scalar& value ( )
inline

The value.

Definition at line 132 of file smoothData.H.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Changed or contains original (invalid) value.

Definition at line 75 of file smoothDataI.H.

◆ sameGeometry()

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

Check for identical geometrical data (eg, cyclics checking)

Definition at line 83 of file smoothDataI.H.

◆ leaveDomain()

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

Convert any absolute coordinates into relative to (patch)face centre.

Definition at line 96 of file smoothDataI.H.

◆ enterDomain()

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

Reverse of leaveDomain.

Definition at line 118 of file smoothDataI.H.

◆ transform()

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

Apply rotation matrix to any coordinates.

Definition at line 108 of file smoothDataI.H.

◆ updateCell()

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

Influence of neighbouring face.

Definition at line 130 of file smoothDataI.H.

References update().

Here is the call graph for this function:

◆ updateFace() [1/2]

bool updateFace ( const polyMesh &  ,
const label  thisFacei,
const label  neighbourCelli,
const smoothData &  svf,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring cell.

Definition at line 146 of file smoothDataI.H.

References update().

Here is the call graph for this function:

◆ updateFace() [2/2]

bool updateFace ( const polyMesh &  ,
const label  thisFacei,
const smoothData &  svf,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same face.

Definition at line 163 of file smoothDataI.H.

References update().

Here is the call graph for this function:

◆ equal()

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

Test for equality, with TrackingData.

Definition at line 178 of file smoothDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const scalar  value)
inline

Assign new value.

Definition at line 249 of file smoothData.H.

References smoothData::value().

Here is the call graph for this function:

◆ operator==()

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

Test for equality.

Definition at line 190 of file smoothDataI.H.

◆ operator!=()

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

Test for inequality.

Definition at line 199 of file smoothDataI.H.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 267 of file smoothData.H.

◆ operator>>

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

Definition at line 272 of file smoothData.H.

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