WallPointBase< Derived > Class Template Reference
Inheritance diagram for WallPointBase< Derived >:

Public Member Functions

 WallPointBase ()
 Construct null. More...
 
 WallPointBase (const point &origin, const scalar distSqr)
 Construct from origin, distance. More...
 
 WallPointBase (const face &f, const pointField &ps, const point &centre, const scalar distSqr)
 Construct from face, distance. More...
 
const pointorigin () const
 
pointorigin ()
 
scalar distSqr () const
 
scalar & distSqr ()
 
template<class TrackingData >
scalar dist (TrackingData &td) const
 
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 WallPointBase< Derived > &, const scalar, TrackingData &td) const
 Check for identical geometrical data. Used for cyclics checking. More...
 
template<class TrackingData >
void transform (const polyPatch &patch, const label patchFacei, const transformer &transform, TrackingData &td)
 Transform across an interface. More...
 
template<class TrackingData >
bool updateCell (const polyMesh &, const label thisCelli, const label neighbourFacei, const WallPointBase< Derived > &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 WallPointBase< Derived > &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of neighbouring cell. More...
 
template<class TrackingData >
bool updateFace (const polyMesh &, const label thisFacei, const WallPointBase< Derived > &neighbourInfo, const scalar tol, TrackingData &td)
 Influence of different value on same face. More...
 
template<class TrackingData >
bool equal (const WallPointBase< Derived > &, TrackingData &td) const
 Same (like operator==) More...
 
bool operator== (const WallPointBase< Derived > &) const
 
bool operator!= (const WallPointBase< Derived > &) const
 
template<class TrackingData >
Foam::scalar dist (TrackingData &td) const
 

Protected Member Functions

template<class TrackingData >
bool update (const point &, const WallPointBase< Derived > &w2, const scalar tol, TrackingData &td)
 Evaluate distance to point. Update distSqr, origin from whomever. More...
 

Friends

Ostreamoperator (Ostream &, const WallPointBase< Derived > &)
 
Istreamoperator>> (Istream &, WallPointBase< Derived > &)
 

Detailed Description

template<class Derived>
class Foam::WallPointBase< Derived >

Definition at line 53 of file wallPoint.H.

Constructor & Destructor Documentation

◆ WallPointBase() [1/3]

WallPointBase ( )
inline

Construct null.

Definition at line 73 of file wallPointI.H.

Referenced by WallPointBase< wallPoint >::WallPointBase().

Here is the caller graph for this function:

◆ WallPointBase() [2/3]

WallPointBase ( const point origin,
const scalar  distSqr 
)
inline

Construct from origin, distance.

Definition at line 82 of file wallPointI.H.

◆ WallPointBase() [3/3]

WallPointBase ( const face f,
const pointField ps,
const point centre,
const scalar  distSqr 
)
inline

Construct from face, distance.

Definition at line 94 of file wallPointI.H.

Member Function Documentation

◆ update()

bool update ( const point pt,
const WallPointBase< Derived > &  w2,
const scalar  tol,
TrackingData &  td 
)
inlineprotected

Evaluate distance to point. Update distSqr, origin from whomever.

is nearer pt. Return true if w2 is closer to point, false otherwise.

Definition at line 36 of file wallPointI.H.

◆ origin() [1/2]

const Foam::point & origin ( ) const
inline

Definition at line 109 of file wallPointI.H.

Referenced by WallPointBase< wallPoint >::operator!=(), WallPointBase< wallPoint >::operator==(), and WallPointBase< wallPoint >::update().

Here is the caller graph for this function:

◆ origin() [2/2]

Foam::point & origin ( )
inline

Definition at line 116 of file wallPointI.H.

◆ distSqr() [1/2]

Foam::scalar distSqr ( ) const
inline

Definition at line 123 of file wallPointI.H.

Referenced by WallPointBase< wallPoint >::operator!=(), and WallPointBase< wallPoint >::sameGeometry().

Here is the caller graph for this function:

◆ distSqr() [2/2]

Foam::scalar & distSqr ( )
inline

Definition at line 130 of file wallPointI.H.

◆ dist() [1/2]

scalar dist ( TrackingData &  td) const
inline

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether origin has been changed at all or.

still contains original (invalid) value.

Definition at line 146 of file wallPointI.H.

◆ sameGeometry()

bool sameGeometry ( const polyMesh ,
const WallPointBase< Derived > &  w2,
const scalar  tol,
TrackingData &  td 
) const
inline

Check for identical geometrical data. Used for cyclics checking.

Definition at line 155 of file wallPointI.H.

Referenced by WallPointBase< wallPoint >::valid().

Here is the caller graph for this function:

◆ transform()

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

Transform across an interface.

Definition at line 185 of file wallPointI.H.

Referenced by WallPointBase< wallPoint >::sameGeometry().

Here is the caller graph for this function:

◆ updateCell()

bool updateCell ( const polyMesh mesh,
const label  thisCelli,
const label  neighbourFacei,
const WallPointBase< Derived > &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring face.

Definition at line 200 of file wallPointI.H.

Referenced by WallPointBase< wallPoint >::transform().

Here is the caller graph for this function:

◆ updateFace() [1/2]

bool updateFace ( const polyMesh mesh,
const label  thisFacei,
const label  neighbourCelli,
const WallPointBase< Derived > &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of neighbouring cell.

Definition at line 223 of file wallPointI.H.

Referenced by WallPointBase< wallPoint >::updateCell(), and WallPointBase< wallPoint >::updateFace().

Here is the caller graph for this function:

◆ updateFace() [2/2]

bool updateFace ( const polyMesh mesh,
const label  thisFacei,
const WallPointBase< Derived > &  neighbourInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same face.

Definition at line 246 of file wallPointI.H.

◆ equal()

bool equal ( const WallPointBase< Derived > &  rhs,
TrackingData &  td 
) const
inline

Same (like operator==)

Definition at line 268 of file wallPointI.H.

Referenced by WallPointBase< wallPoint >::updateFace().

Here is the caller graph for this function:

◆ operator==()

bool operator== ( const WallPointBase< Derived > &  rhs) const
inline

Definition at line 281 of file wallPointI.H.

◆ operator!=()

bool operator!= ( const WallPointBase< Derived > &  rhs) const
inline

Definition at line 291 of file wallPointI.H.

◆ dist() [2/2]

Foam::scalar dist ( TrackingData &  td) const
inline

Definition at line 138 of file wallPointI.H.

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream ,
const WallPointBase< Derived > &   
)
friend

◆ operator>>

Istream& operator>> ( Istream ,
WallPointBase< Derived > &   
)
friend

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