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

Helper class used by fvc::sweep function. More...

Public Member Functions

 sweepData ()
 Construct null. More...
 
 sweepData (const scalar value, const point &origin)
 Construct from component. More...
 
scalar value () const
 Return value. More...
 
const point & origin () const
 Return origin. 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 sweepData &, 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 sweepData &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 sweepData &svf, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const fvMesh &, const labelPair &thisPatchAndFacei, const sweepData &svf, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const sweepData &, TrackingData &td) const
 Same (like operator==) More...
 
void operator= (const scalar value)
 
bool operator== (const sweepData &) const
 
bool operator!= (const sweepData &) const
 

Friends

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

Detailed Description

Helper class used by fvc::sweep function.

Source files

Definition at line 56 of file sweepData.H.

Constructor & Destructor Documentation

◆ sweepData() [1/2]

sweepData ( )
inline

Construct null.

Definition at line 77 of file sweepDataI.H.

◆ sweepData() [2/2]

sweepData ( const scalar  value,
const point &  origin 
)
inline

Construct from component.

Definition at line 84 of file sweepDataI.H.

Member Function Documentation

◆ value()

scalar value ( ) const
inline

Return value.

Definition at line 97 of file sweepData.H.

◆ origin()

const point& origin ( ) const
inline

Return origin.

Definition at line 103 of file sweepData.H.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether origin has been changed at all or.

still contains original (invalid) value

Definition at line 94 of file sweepDataI.H.

◆ sameGeometry()

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

Check for identical geometrical data.

Used for cyclics checking

Definition at line 101 of file sweepDataI.H.

◆ transform()

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

Transform across an interface.

Definition at line 114 of file sweepDataI.H.

References Foam::transform().

Here is the call graph for this function:

◆ updateCell()

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

Influence of neighbouring face.

Definition at line 127 of file sweepDataI.H.

References fvMesh::C().

Here is the call graph for this function:

◆ updateFace() [1/2]

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

Influence of neighbouring cell.

Definition at line 142 of file sweepDataI.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvMesh::Cf(), Pair< Type >::first(), and Pair< Type >::second().

Here is the call graph for this function:

◆ updateFace() [2/2]

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

Influence of different value on same face.

Definition at line 170 of file sweepDataI.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvMesh::Cf(), Pair< Type >::first(), and Pair< Type >::second().

Here is the call graph for this function:

◆ equal()

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

Same (like operator==)

Definition at line 196 of file sweepDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator=()

void operator= ( const scalar  value)
inline

Definition at line 208 of file sweepDataI.H.

◆ operator==()

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

Definition at line 217 of file sweepDataI.H.

◆ operator!=()

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

Definition at line 226 of file sweepDataI.H.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 188 of file sweepData.H.

◆ operator>>

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

Definition at line 193 of file sweepData.H.

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