Public Member Functions | Protected Member Functions | Friends | List of all members
wallPoint Class Reference

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

Public Member Functions

 wallPoint ()
 Construct null. More...
 
 wallPoint (const point &origin, const scalar distSqr)
 Construct from origin, distance. More...
 
 wallPoint (const face &f, const pointField &ps, const point &centre, const scalar distSqr)
 Construct from face, distance. More...
 
const point & origin () const
 
point & origin ()
 
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 wallPoint &, const scalar, TrackingData &td) const
 Check for identical geometrical data. Used for cyclics checking. More...
 
template<class TrackingData >
void transform (const transformer &transform, TrackingData &td)
 Transform across an interface. 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
 
template<class TrackingData >
Foam::scalar dist (TrackingData &td) const
 

Protected Member Functions

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

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 58 of file wallPoint.H.

Constructor & Destructor Documentation

◆ wallPoint() [1/3]

wallPoint ( )
inline

Construct null.

Definition at line 70 of file wallPointI.H.

◆ wallPoint() [2/3]

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

Construct from origin, distance.

Definition at line 77 of file wallPointI.H.

◆ wallPoint() [3/3]

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

Construct from face, distance.

Definition at line 88 of file wallPointI.H.

Member Function Documentation

◆ update()

bool update ( const point &  pt,
const wallPoint &  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 33 of file wallPointI.H.

References Foam::diff(), wallPoint::distSqr(), Foam::magSqr(), wallPoint::origin(), wallPoint::valid(), and w2.

Here is the call graph for this function:

◆ origin() [1/2]

const Foam::point & origin ( ) const
inline

Definition at line 103 of file wallPointI.H.

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

Here is the caller graph for this function:

◆ origin() [2/2]

Foam::point & origin ( )
inline

Definition at line 109 of file wallPointI.H.

◆ distSqr() [1/2]

Foam::scalar distSqr ( ) const
inline

Definition at line 115 of file wallPointI.H.

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

Here is the caller graph for this function:

◆ distSqr() [2/2]

Foam::scalar & distSqr ( )
inline

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

Referenced by wallPoint::update().

Here is the caller graph for this function:

◆ sameGeometry()

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

Check for identical geometrical data. Used for cyclics checking.

Definition at line 142 of file wallPointI.H.

References Foam::diff(), Foam::mag(), and w2.

Here is the call graph for this function:

◆ transform()

void transform ( const transformer &  transform,
TrackingData &  td 
)
inline

Transform across an interface.

Definition at line 158 of file wallPointI.H.

References Foam::transform().

Here is the call graph for this function:

◆ equal()

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

Same (like operator==)

Definition at line 170 of file wallPointI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

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

Definition at line 182 of file wallPointI.H.

◆ operator!=()

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

Definition at line 191 of file wallPointI.H.

◆ dist() [2/2]

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

Definition at line 128 of file wallPointI.H.

References Foam::sqrt(), and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

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: