Loading...
Searching...
No Matches
wallPoint Class Reference

Holds information regarding nearest wall point. Used in wall distance calculation. More...

#include <wallPoint.H>

Inheritance diagram for wallPoint:
Inheritance graph
[legend]

Public Member Functions

 wallPoint ()
 Default construct.
 wallPoint (const point &origin, const scalar distSqr)
 Construct from origin, distance-squared.
const point & origin () const
point & origin ()
scalar distSqr () const
scalar & distSqr ()
template<class TrackingData>
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value.
template<class TrackingData>
bool sameGeometry (const polyMesh &, const wallPoint &, 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 (patch)face centre.
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 wallPoint &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring face.
template<class TrackingData>
bool updateFace (const polyMesh &, const label thisFacei, const label neighbourCelli, const wallPoint &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell.
template<class TrackingData>
bool updateFace (const polyMesh &, const label thisFacei, const wallPoint &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face.
template<class TrackingData>
 wallPoint (const polyMesh &, const scalar weight, const label face0, const wallPoint &info0, const label face1, const wallPoint &info1, const scalar tol, TrackingData &td)
 Interpolate different values.
template<class TrackingData>
bool equal (const wallPoint &, TrackingData &td) const
 Test for equality, with TrackingData.
template<class TrackingData>
bool interpolate (const polyMesh &, const point &pt, const label i0, const wallPoint &f0, const label i1, const wallPoint &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...
bool operator== (const wallPoint &) const
 Test for equality.
bool operator!= (const wallPoint &) const
 Test for inequality.

Friends

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

Detailed Description

Holds information regarding nearest wall point. Used in wall distance calculation.

Source files

Definition at line 61 of file wallPoint.H.

Constructor & Destructor Documentation

◆ wallPoint() [1/3]

wallPoint ( )
inline

Default construct.

Definition at line 92 of file wallPointI.H.

References Foam::max().

Referenced by equal(), interpolate(), operator!=(), operator<<, operator==(), operator>>, sameGeometry(), updateCell(), updateFace(), updateFace(), wallPoint(), wallPointAddressing::wallPointAddressing(), wallPointAddressing::wallPointAddressing(), wallPointData< Type >::wallPointData(), and wallPointData< Type >::wallPointData().

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

◆ wallPoint() [2/3]

wallPoint ( const point & origin,
const scalar distSqr )
inline

Construct from origin, distance-squared.

Definition at line 99 of file wallPointI.H.

References distSqr(), and origin().

Here is the call graph for this function:

◆ wallPoint() [3/3]

template<class TrackingData>
wallPoint ( const polyMesh & ,
const scalar weight,
const label face0,
const wallPoint & info0,
const label face1,
const wallPoint & info1,
const scalar tol,
TrackingData & td )

Interpolate different values.

References td(), and wallPoint().

Here is the call graph for this function:

Member Function Documentation

◆ origin() [1/2]

const point & origin ( ) const
inline

Definition at line 123 of file wallPoint.H.

Referenced by directionalWallPointData< Type >::directionalWallPointData(), transportData::transportData(), wallPoint(), wallPointAddressing::wallPointAddressing(), and wallPointData< Type >::wallPointData().

Here is the caller graph for this function:

◆ origin() [2/2]

point & origin ( )
inline

Definition at line 127 of file wallPoint.H.

◆ distSqr() [1/2]

scalar distSqr ( ) const
inline

Definition at line 132 of file wallPoint.H.

Referenced by directionalWallPointData< Type >::directionalWallPointData(), interpolate(), sameGeometry(), transportData::transportData(), wallPoint(), wallPointAddressing::wallPointAddressing(), and wallPointData< Type >::wallPointData().

Here is the caller graph for this function:

◆ distSqr() [2/2]

scalar & distSqr ( )
inline

Definition at line 136 of file wallPoint.H.

◆ valid()

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

Changed or contains original (invalid) value.

Definition at line 109 of file wallPointI.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 wallPoint & w2,
const scalar tol,
TrackingData & td ) const
inline

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

Definition at line 117 of file wallPointI.H.

References Foam::diff(), distSqr(), Foam::mag(), td(), w2, and wallPoint().

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 146 of file wallPointI.H.

References td().

Referenced by wallPointAddressing::leaveDomain().

Here is the call graph for this function:
Here is the caller 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 174 of file wallPointI.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 160 of file wallPointI.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 wallPoint & neighbourInfo,
const scalar tol,
TrackingData & td )
inline

Influence of neighbouring face.

Definition at line 190 of file wallPointI.H.

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

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 wallPoint & neighbourInfo,
const scalar tol,
TrackingData & td )
inline

Influence of neighbouring cell.

Definition at line 213 of file wallPointI.H.

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

Here is the call graph for this function:

◆ updateFace() [2/2]

template<class TrackingData>
bool updateFace ( const polyMesh & mesh,
const label thisFacei,
const wallPoint & neighbourInfo,
const scalar tol,
TrackingData & td )
inline

Influence of different value on same face.

Definition at line 236 of file wallPointI.H.

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

Here is the call graph for this function:

◆ equal()

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

Test for equality, with TrackingData.

Definition at line 257 of file wallPointI.H.

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

Here is the call graph for this function:

◆ interpolate()

template<class TrackingData>
bool interpolate ( const polyMesh & ,
const point & pt,
const label i0,
const wallPoint & f0,
const label i1,
const wallPoint & 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 268 of file wallPointI.H.

References distSqr(), Foam::lerp(), Foam::sqr(), Foam::sqrt(), td(), update(), valid(), and wallPoint().

Here is the call graph for this function:

◆ operator==()

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

Test for equality.

Definition at line 321 of file wallPointI.H.

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

Here is the call graph for this function:

◆ operator!=()

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

Test for inequality.

Definition at line 330 of file wallPointI.H.

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

Here is the call graph for this function:

◆ operator<<

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

References wallPoint().

◆ operator>>

Istream & operator>> ( Istream & ,
wallPoint &  )
friend

References wallPoint().

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