Public Member Functions | Friends | List of all members
meshPhiPreCorrectInfo Class Reference

Public Member Functions

 meshPhiPreCorrectInfo ()
 Construct null. More...
 
 meshPhiPreCorrectInfo (const label layer, const scalar weight)
 Construct given the layer index and weight. More...
 
label layer () const
 Return the layer index. More...
 
scalar weight () const
 Return the weight. More...
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Check whether the meshPhiPreCorrectInfo has been changed at all. More...
 
template<class TrackingData >
bool sameGeometry (const fvMesh &mesh, const meshPhiPreCorrectInfo &, 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 meshPhiPreCorrectInfo &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 meshPhiPreCorrectInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const fvMesh &mesh, const labelPair &thisPatchAndFacei, const meshPhiPreCorrectInfo &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const meshPhiPreCorrectInfo &, TrackingData &td) const
 Test equality. More...
 
bool operator== (const meshPhiPreCorrectInfo &) const
 
bool operator!= (const meshPhiPreCorrectInfo &) const
 

Friends

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

Detailed Description

Source files

Definition at line 57 of file meshPhiPreCorrectInfo.H.

Constructor & Destructor Documentation

◆ meshPhiPreCorrectInfo() [1/2]

meshPhiPreCorrectInfo ( )
inline

Construct null.

Definition at line 31 of file meshPhiPreCorrectInfoI.H.

◆ meshPhiPreCorrectInfo() [2/2]

meshPhiPreCorrectInfo ( const label  layer,
const scalar  weight 
)
inline

Construct given the layer index and weight.

Definition at line 39 of file meshPhiPreCorrectInfoI.H.

Member Function Documentation

◆ layer()

Foam::label layer ( ) const
inline

Return the layer index.

Definition at line 51 of file meshPhiPreCorrectInfoI.H.

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

Here is the caller graph for this function:

◆ weight()

Foam::scalar weight ( ) const
inline

Return the weight.

Definition at line 57 of file meshPhiPreCorrectInfoI.H.

Referenced by meshPhiCorrectInfo::updateFace().

Here is the caller graph for this function:

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether the meshPhiPreCorrectInfo has been changed at all.

or still contains original (invalid) value.

Definition at line 64 of file meshPhiPreCorrectInfoI.H.

References Foam::labelMax, and meshPhiPreCorrectInfo::sameGeometry().

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

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

◆ sameGeometry()

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

Check for identical geometrical data. Used for checking.

consistency across cyclics.

Definition at line 72 of file meshPhiPreCorrectInfoI.H.

References meshPhiPreCorrectInfo::transform().

Referenced by meshPhiPreCorrectInfo::valid().

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

◆ transform()

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

Transform across an interface.

Definition at line 85 of file meshPhiPreCorrectInfoI.H.

References meshPhiPreCorrectInfo::updateCell().

Referenced by meshPhiPreCorrectInfo::sameGeometry().

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

◆ updateCell()

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

Influence of neighbouring face.

Definition at line 96 of file meshPhiPreCorrectInfoI.H.

References meshPhiPreCorrectInfo::updateFace(), and meshPhiPreCorrectInfo::valid().

Referenced by meshPhiPreCorrectInfo::transform().

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

◆ updateFace() [1/2]

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

Influence of neighbouring cell.

Definition at line 126 of file meshPhiPreCorrectInfoI.H.

References meshPhiPreCorrectInfo::valid().

Referenced by meshPhiPreCorrectInfo::updateCell().

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

◆ updateFace() [2/2]

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

Influence of different value on same face.

Definition at line 155 of file meshPhiPreCorrectInfoI.H.

References meshPhiPreCorrectInfo::equal().

Here is the call graph for this function:

◆ equal()

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

Test equality.

Definition at line 175 of file meshPhiPreCorrectInfoI.H.

References meshPhiPreCorrectInfo::operator==().

Referenced by meshPhiPreCorrectInfo::updateFace().

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

◆ operator==()

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

Definition at line 187 of file meshPhiPreCorrectInfoI.H.

Referenced by meshPhiPreCorrectInfo::equal().

Here is the caller graph for this function:

◆ operator!=()

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

Definition at line 196 of file meshPhiPreCorrectInfoI.H.

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

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