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

Classes

class  trackData
 Tracking data. Mostly just a collection of references to the. More...
 

Public Types

enum class  shape { invalid , face , cell }
 Enumeration to define the mesh shape the info applies to. More...
 

Public Member Functions

 meshPhiCorrectInfo ()
 Construct null. More...
 
 meshPhiCorrectInfo (const shape &s)
 Construct for given shape. More...
 
scalar deltaPhi () const
 Return the flux correction. More...
 
scalar & deltaPhi ()
 Access the flux correction. More...
 
scalar deltaDVdtError () const
 Return the volume change rate error correction. More...
 
scalar & deltaDVdtError ()
 Access the volume change rate error correction. More...
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Check whether the meshPhiCorrectInfo has been changed at all. More...
 
template<class TrackingData >
bool sameGeometry (const fvMesh &mesh, const meshPhiCorrectInfo &, const scalar, TrackingData &td) const
 Check for identical geometrical data. Used for checking. 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 &mesh, const label thisCelli, const labelPair &neighbourPatchAndFacei, const meshPhiCorrectInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring face. More...
 
template<class TrackingData >
bool updateFace (const fvMesh &mesh, const labelPair &thisPatchAndFacei, const label neighbourCelli, const meshPhiCorrectInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const fvMesh &mesh, const labelPair &thisPatchAndFacei, const meshPhiCorrectInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const meshPhiCorrectInfo &, TrackingData &td) const
 Test equality. More...
 
bool operator== (const meshPhiCorrectInfo &) const
 
bool operator!= (const meshPhiCorrectInfo &) const
 

Friends

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

Detailed Description

Source files

Definition at line 55 of file meshPhiCorrectInfo.H.

Member Enumeration Documentation

◆ shape

enum shape
strong

Enumeration to define the mesh shape the info applies to.

Enumerator
invalid 
face 
cell 

Definition at line 62 of file meshPhiCorrectInfo.H.

Constructor & Destructor Documentation

◆ meshPhiCorrectInfo() [1/2]

meshPhiCorrectInfo ( )
inline

Construct null.

Definition at line 55 of file meshPhiCorrectInfoI.H.

◆ meshPhiCorrectInfo() [2/2]

meshPhiCorrectInfo ( const shape &  s)
inline

Construct for given shape.

Definition at line 62 of file meshPhiCorrectInfoI.H.

Member Function Documentation

◆ deltaPhi() [1/2]

Foam::scalar deltaPhi ( ) const
inline

Return the flux correction.

Definition at line 71 of file meshPhiCorrectInfoI.H.

Referenced by meshPhiCorrectInfo::updateCell(), and meshPhiCorrectInfo::updateFace().

Here is the caller graph for this function:

◆ deltaPhi() [2/2]

Foam::scalar & deltaPhi ( )
inline

Access the flux correction.

Definition at line 78 of file meshPhiCorrectInfoI.H.

◆ deltaDVdtError() [1/2]

Foam::scalar deltaDVdtError ( ) const
inline

Return the volume change rate error correction.

Definition at line 85 of file meshPhiCorrectInfoI.H.

Referenced by meshPhiCorrectInfo::updateFace().

Here is the caller graph for this function:

◆ deltaDVdtError() [2/2]

Foam::scalar & deltaDVdtError ( )
inline

Access the volume change rate error correction.

Definition at line 92 of file meshPhiCorrectInfoI.H.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether the meshPhiCorrectInfo has been changed at all.

or still contains original (invalid) value.

Definition at line 100 of file meshPhiCorrectInfoI.H.

◆ sameGeometry()

bool sameGeometry ( const fvMesh &  mesh,
const meshPhiCorrectInfo &  l,
const scalar  tol,
TrackingData &  td 
) const
inline

Check for identical geometrical data. Used for checking.

consistency across cyclics.

Definition at line 107 of file meshPhiCorrectInfoI.H.

◆ transform()

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

Transform across an interface.

Definition at line 120 of file meshPhiCorrectInfoI.H.

◆ updateCell()

bool updateCell ( const fvMesh &  mesh,
const label  thisCelli,
const labelPair &  neighbourPatchAndFacei,
const meshPhiCorrectInfo &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring face.

Definition at line 131 of file meshPhiCorrectInfoI.H.

References meshPhiCorrectInfo::deltaPhi(), Pair< Type >::first(), meshPhiPreCorrectInfo::layer(), fvMesh::owner(), s(), Pair< Type >::second(), and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ updateFace() [1/2]

bool updateFace ( const fvMesh &  mesh,
const labelPair &  thisPatchAndFacei,
const label  neighbourCelli,
const meshPhiCorrectInfo &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring cell.

Definition at line 176 of file meshPhiCorrectInfoI.H.

References meshPhiCorrectInfo::deltaDVdtError(), Pair< Type >::first(), meshPhiPreCorrectInfo::layer(), fvMesh::owner(), s(), Pair< Type >::second(), Foam::blendedInterfacialModel::valid(), and meshPhiPreCorrectInfo::weight().

Here is the call graph for this function:

◆ updateFace() [2/2]

bool updateFace ( const fvMesh &  mesh,
const labelPair &  thisPatchAndFacei,
const meshPhiCorrectInfo &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same face.

Definition at line 223 of file meshPhiCorrectInfoI.H.

References meshPhiCorrectInfo::deltaPhi(), and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ equal()

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

Test equality.

Definition at line 245 of file meshPhiCorrectInfoI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

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

Definition at line 257 of file meshPhiCorrectInfoI.H.

◆ operator!=()

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

Definition at line 266 of file meshPhiCorrectInfoI.H.

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

Istream& operator>> ( Istream &  ,
meshPhiCorrectInfo &   
)
friend
The documentation for this class was generated from the following files: