All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
wallPoint Class Reference

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

Inheritance diagram for wallPoint:

Public Member Functions

 wallPoint ()
 Construct null. More...
 
 wallPoint (const point &origin, const scalar distSqr)
 Construct from origin, distance. More...
 
const pointorigin () const
 
pointorigin ()
 
scalar distSqr () const
 
scalar & distSqr ()
 
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 wallPoint &, const scalar, TrackingData &td) const
 Check for identical geometrical data. Used for cyclics checking. 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 (patch)face. 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 wallPoint &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring face. More...
 
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. More...
 
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. More...
 
template<class TrackingData >
bool equal (const wallPoint &, TrackingData &td) const
 Same (like operator==) More...
 
bool operator== (const wallPoint &) const
 
bool operator!= (const wallPoint &) const
 

Friends

Ostreamoperator<< (Ostream &, const wallPoint &)
 
Istreamoperator>> (Istream &, wallPoint &)
 

Detailed Description

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

Source files

Definition at line 63 of file wallPoint.H.

Constructor & Destructor Documentation

◆ wallPoint() [1/2]

wallPoint ( )
inline

Construct null.

Definition at line 85 of file wallPointI.H.

◆ wallPoint() [2/2]

wallPoint ( const point origin,
const scalar  distSqr 
)
inline

Construct from origin, distance.

Definition at line 92 of file wallPointI.H.

Member Function Documentation

◆ origin() [1/2]

const Foam::point & origin ( ) const
inline

Definition at line 101 of file wallPointI.H.

Referenced by Foam::operator<<(), wallPoint::operator==(), and Foam::operator>>().

Here is the caller graph for this function:

◆ origin() [2/2]

Foam::point & origin ( )
inline

Definition at line 107 of file wallPointI.H.

◆ distSqr() [1/2]

Foam::scalar distSqr ( ) const
inline

Definition at line 113 of file wallPointI.H.

Referenced by Foam::operator<<(), Foam::operator>>(), and wallPoint::sameGeometry().

Here is the caller graph for this function:

◆ distSqr() [2/2]

Foam::scalar & distSqr ( )
inline

Definition at line 119 of file wallPointI.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 126 of file wallPointI.H.

References wallPoint::sameGeometry().

Here is the call graph for this function:

◆ sameGeometry()

bool sameGeometry ( const polyMesh ,
const wallPoint w2,
const scalar  tol,
TrackingData &  td 
) const
inline

Check for identical geometrical data. Used for cyclics checking.

Definition at line 135 of file wallPointI.H.

References wallPoint::distSqr(), wallPoint::leaveDomain(), and Foam::mag().

Referenced by wallPoint::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 164 of file wallPointI.H.

References wallPoint::transform().

Referenced by wallPoint::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 192 of file wallPointI.H.

References wallPoint::updateCell().

Referenced by wallPoint::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 178 of file wallPointI.H.

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

Referenced by wallPoint::leaveDomain().

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

Influence of neighbouring face.

Definition at line 208 of file wallPointI.H.

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

Referenced by wallPoint::enterDomain().

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

Influence of neighbouring cell.

Definition at line 231 of file wallPointI.H.

References primitiveMesh::faceCentres().

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

Influence of different value on same face.

Definition at line 253 of file wallPointI.H.

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

Here is the call graph for this function:

◆ equal()

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

Same (like operator==)

Definition at line 274 of file wallPointI.H.

References wallPoint::operator==().

Referenced by wallPoint::updateFace().

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

◆ operator==()

bool operator== ( const wallPoint rhs) const
inline

Definition at line 285 of file wallPointI.H.

References wallPoint::origin().

Referenced by wallPoint::equal().

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

◆ operator!=()

bool operator!= ( const wallPoint rhs) const
inline

Definition at line 291 of file wallPointI.H.

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

Istream& operator>> ( Istream ,
wallPoint  
)
friend

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