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 polyMesh &, const sweepData &, const scalar, TrackingData &td) const
 Check for identical geometrical data. 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. 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 sweepData &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 sweepData &svf, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, 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 47 of file sweepData.H.

Constructor & Destructor Documentation

◆ sweepData() [1/2]

sweepData ( )
inline

Construct null.

Definition at line 74 of file sweepDataI.H.

◆ sweepData() [2/2]

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

Construct from component.

Definition at line 81 of file sweepDataI.H.

Member Function Documentation

◆ value()

scalar value ( ) const
inline

Return value.

Definition at line 82 of file sweepData.H.

Referenced by sweepData::operator=().

Here is the caller graph for this function:

◆ origin()

const point& origin ( ) const
inline

Return origin.

Definition at line 88 of file sweepData.H.

References sweepData::enterDomain(), sweepData::equal(), sweepData::leaveDomain(), sweepData::operator!=(), sweepData::operator=(), sweepData::operator==(), sweepData::sameGeometry(), sweepData::transform(), sweepData::updateCell(), sweepData::updateFace(), and sweepData::valid().

Referenced by sweepData::operator==().

Here is the call graph for this function:
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 91 of file sweepDataI.H.

References sweepData::sameGeometry().

Referenced by sweepData::origin().

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

◆ sameGeometry()

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

Check for identical geometrical data.

Used for cyclics checking

Definition at line 99 of file sweepDataI.H.

References sweepData::leaveDomain().

Referenced by sweepData::origin(), and sweepData::valid().

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

◆ 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 112 of file sweepDataI.H.

References sweepData::transform().

Referenced by sweepData::origin(), and sweepData::sameGeometry().

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

◆ enterDomain()

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

Reverse of leaveDomain.

Definition at line 138 of file sweepDataI.H.

References sweepData::updateCell().

Referenced by sweepData::origin(), and sweepData::transform().

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

◆ transform()

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

Apply rotation matrix to any coordinates.

Definition at line 126 of file sweepDataI.H.

References sweepData::enterDomain(), and Foam::transform().

Referenced by sweepData::leaveDomain(), and sweepData::origin().

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

◆ updateCell()

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

Influence of neighbouring face.

Definition at line 153 of file sweepDataI.H.

References primitiveMesh::cellCentres(), and sweepData::updateFace().

Referenced by sweepData::enterDomain(), and sweepData::origin().

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

◆ updateFace() [1/2]

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

Influence of neighbouring cell.

Definition at line 168 of file sweepDataI.H.

References primitiveMesh::faceCentres().

Referenced by sweepData::origin(), and sweepData::updateCell().

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

◆ updateFace() [2/2]

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

Influence of different value on same face.

Definition at line 184 of file sweepDataI.H.

References sweepData::equal(), and primitiveMesh::faceCentres().

Here is the call graph for this function:

◆ equal()

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

Same (like operator==)

Definition at line 198 of file sweepDataI.H.

References sweepData::operator==().

Referenced by sweepData::origin(), and sweepData::updateFace().

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

◆ operator=()

void operator= ( const scalar  value)
inline

Definition at line 210 of file sweepDataI.H.

References sweepData::value().

Referenced by sweepData::origin().

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

◆ operator==()

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

Definition at line 219 of file sweepDataI.H.

References sweepData::origin().

Referenced by sweepData::equal(), and sweepData::origin().

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

◆ operator!=()

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

Definition at line 228 of file sweepDataI.H.

Referenced by sweepData::origin().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 197 of file sweepData.H.

◆ operator>>

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

Definition at line 205 of file sweepData.H.

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