Loading...
Searching...
No Matches
sweepData Class Reference

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

#include <sweepData.H>

Public Member Functions

 sweepData (const sweepData &)=default
 Copy construct.
sweepData & operator= (const sweepData &)=default
 Copy assignment.
 sweepData ()
 Default construct.
 sweepData (const scalar value, const point &origin)
 Construct from components.
scalar value () const
 Return value.
scalar & value ()
 The value.
const point & origin () const
 Return origin.
template<class TrackingData>
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value.
template<class TrackingData>
bool sameGeometry (const polyMesh &, const sweepData &, const scalar, TrackingData &td) const
 Check for identical geometrical data (eg, cyclics checking).
template<class TrackingData>
void leaveDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
 Convert any absolute coordinates into relative to.
template<class TrackingData>
void enterDomain (const polyMesh &, const polyPatch &, const label patchFacei, const point &faceCentre, TrackingData &td)
 Reverse of leaveDomain.
template<class TrackingData>
void transform (const polyMesh &, const tensor &, TrackingData &td)
 Apply rotation matrix to any coordinates.
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.
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.
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.
template<class TrackingData>
bool equal (const sweepData &, TrackingData &td) const
 Test for equality, with TrackingData.
template<class TrackingData>
bool interpolate (const polyMesh &, const point &pt, const label i0, const sweepData &f0, const label i1, const sweepData &f1, const scalar weight, const scalar tol, TrackingData &td)
 Interpolate between two values (lerp). Returns true if causes changes. Not sure if needs to be specialised between face and cell and what index is needed...
void operator= (const scalar value)
 Assign new value.
bool operator== (const sweepData &) const
 Test for equality.
bool operator!= (const sweepData &) const
 Test for inequality.

Friends

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

Detailed Description

Helper class used by fvc::sweep function.

Source files

Definition at line 52 of file sweepData.H.

Constructor & Destructor Documentation

◆ sweepData() [1/3]

sweepData ( const sweepData & )
default

Copy construct.

References sweepData().

Referenced by equal(), interpolate(), operator!=(), operator<<, operator=(), operator==(), operator>>, sameGeometry(), sweepData(), updateCell(), updateFace(), and updateFace().

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

◆ sweepData() [2/3]

sweepData ( )
inline

Default construct.

Definition at line 69 of file sweepDataI.H.

References Foam::max().

Here is the call graph for this function:

◆ sweepData() [3/3]

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

Construct from components.

Definition at line 76 of file sweepDataI.H.

References origin(), and value().

Here is the call graph for this function:

Member Function Documentation

◆ operator=() [1/2]

sweepData & operator= ( const sweepData & )
default

Copy assignment.

References origin(), sweepData(), and value().

Referenced by interpolate().

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

◆ value() [1/2]

scalar value ( ) const
inline

Return value.

Definition at line 112 of file sweepData.H.

Referenced by operator=(), operator=(), and sweepData().

Here is the caller graph for this function:

◆ value() [2/2]

scalar & value ( )
inline

The value.

Definition at line 120 of file sweepData.H.

◆ origin()

const point & origin ( ) const
inline

Return origin.

Definition at line 128 of file sweepData.H.

Referenced by operator=(), and sweepData().

Here is the caller graph for this function:

◆ valid()

template<class TrackingData>
bool valid ( TrackingData & td) const
inline

Changed or contains original (invalid) value.

Definition at line 90 of file sweepDataI.H.

References td().

Referenced by interpolate().

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

◆ sameGeometry()

template<class TrackingData>
bool sameGeometry ( const polyMesh & ,
const sweepData & ,
const scalar ,
TrackingData & td ) const
inline

Check for identical geometrical data (eg, cyclics checking).

Definition at line 97 of file sweepDataI.H.

References sweepData(), and td().

Here is the call graph for this function:

◆ leaveDomain()

template<class TrackingData>
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 110 of file sweepDataI.H.

References td().

Here is the call graph for this function:

◆ enterDomain()

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

Reverse of leaveDomain.

Definition at line 136 of file sweepDataI.H.

References td().

Here is the call graph for this function:

◆ transform()

template<class TrackingData>
void transform ( const polyMesh & ,
const tensor & rotTensor,
TrackingData & td )
inline

Apply rotation matrix to any coordinates.

Definition at line 124 of file sweepDataI.H.

References td(), and Foam::transform().

Here is the call graph for this function:

◆ updateCell()

template<class TrackingData>
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 151 of file sweepDataI.H.

References mesh, sweepData(), td(), and update().

Here is the call graph for this function:

◆ updateFace() [1/2]

template<class TrackingData>
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 166 of file sweepDataI.H.

References mesh, sweepData(), td(), and update().

Here is the call graph for this function:

◆ updateFace() [2/2]

template<class TrackingData>
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 182 of file sweepDataI.H.

References mesh, sweepData(), td(), and update().

Here is the call graph for this function:

◆ equal()

template<class TrackingData>
bool equal ( const sweepData & rhs,
TrackingData & td ) const
inline

Test for equality, with TrackingData.

Definition at line 196 of file sweepDataI.H.

References Foam::operator==(), Foam::rhs(), sweepData(), and td().

Here is the call graph for this function:

◆ interpolate()

template<class TrackingData>
bool interpolate ( const polyMesh & ,
const point & pt,
const label i0,
const sweepData & f0,
const label i1,
const sweepData & f1,
const scalar weight,
const scalar tol,
TrackingData & td )
inline

Interpolate between two values (lerp). Returns true if causes changes. Not sure if needs to be specialised between face and cell and what index is needed...

Definition at line 207 of file sweepDataI.H.

References operator=(), sweepData(), td(), and valid().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const scalar value)
inline

Assign new value.

Definition at line 265 of file sweepData.H.

References value().

Here is the call graph for this function:

◆ operator==()

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

Test for equality.

Definition at line 247 of file sweepDataI.H.

References Foam::rhs(), and sweepData().

Here is the call graph for this function:

◆ operator!=()

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

Test for inequality.

Definition at line 256 of file sweepDataI.H.

References Foam::rhs(), and sweepData().

Here is the call graph for this function:

◆ operator<<

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

Definition at line 283 of file sweepData.H.

References os(), Foam::rhs(), and sweepData().

◆ operator>>

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

Definition at line 288 of file sweepData.H.

References Foam::rhs(), and sweepData().

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