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

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

Public Member Functions

 wallFace ()
 Construct null. More...
 
 wallFace (const face &f, const pointField &points, const scalar distSqr)
 Construct from face, distance. More...
 
 wallFace (const face &f, const pointField &points, const point &centre, const scalar distSqr)
 Construct from face, distance. More...
 
const pointField & points () const
 
pointField & points ()
 
scalar distSqr () const
 
scalar & distSqr ()
 
template<class TrackingData >
scalar dist (TrackingData &td) const
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Check whether the wallFace has been changed at all or still. More...
 
template<class TrackingData >
bool sameGeometry (const wallFace &, const scalar, TrackingData &td) const
 Check for identical geometrical data. Used for checking. More...
 
template<class TrackingData >
void transform (const transformer &transform, TrackingData &td)
 Transform across an interface. More...
 
template<class TrackingData >
bool equal (const wallFace &, TrackingData &td) const
 Test equality. More...
 
bool operator== (const wallFace &) const
 
bool operator!= (const wallFace &) const
 
template<class TrackingData >
Foam::scalar dist (TrackingData &td) const
 

Protected Member Functions

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

Friends

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

Detailed Description

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

Source files

Definition at line 58 of file wallFace.H.

Constructor & Destructor Documentation

◆ wallFace() [1/3]

wallFace ( )
inline

Construct null.

Definition at line 76 of file wallFaceI.H.

◆ wallFace() [2/3]

wallFace ( const face &  f,
const pointField &  points,
const scalar  distSqr 
)
inline

Construct from face, distance.

Definition at line 83 of file wallFaceI.H.

◆ wallFace() [3/3]

wallFace ( const face &  f,
const pointField &  points,
const point &  centre,
const scalar  distSqr 
)
inline

Construct from face, distance.

Definition at line 95 of file wallFaceI.H.

Member Function Documentation

◆ update()

bool update ( const point &  pt,
const wallFace &  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 wallFaceI.H.

References Foam::diff(), PointHit< Point >::distance(), wallFace::distSqr(), Foam::identityMap(), face::nearestPoint(), wallFace::points(), Foam::sqr(), wallFace::valid(), and w2.

Here is the call graph for this function:

◆ points() [1/2]

const Foam::pointField & points ( ) const
inline

Definition at line 110 of file wallFaceI.H.

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

Here is the caller graph for this function:

◆ points() [2/2]

Foam::pointField & points ( )
inline

Definition at line 116 of file wallFaceI.H.

◆ distSqr() [1/2]

Foam::scalar distSqr ( ) const
inline

Definition at line 122 of file wallFaceI.H.

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

Here is the caller graph for this function:

◆ distSqr() [2/2]

Foam::scalar & distSqr ( )
inline

Definition at line 128 of file wallFaceI.H.

◆ dist() [1/2]

scalar dist ( TrackingData &  td) const
inline

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether the wallFace has been changed at all or still.

contains original (invalid) value.

Definition at line 142 of file wallFaceI.H.

Referenced by wallFace::update().

Here is the caller graph for this function:

◆ sameGeometry()

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

Check for identical geometrical data. Used for checking.

consistency across cyclics.

Definition at line 149 of file wallFaceI.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 165 of file wallFaceI.H.

References Foam::transform().

Here is the call graph for this function:

◆ equal()

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

Test equality.

Definition at line 177 of file wallFaceI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

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

Definition at line 189 of file wallFaceI.H.

References points.

◆ operator!=()

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

Definition at line 198 of file wallFaceI.H.

◆ dist() [2/2]

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

Definition at line 135 of file wallFaceI.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 wallFace &   
)
friend

◆ operator>>

Istream& operator>> ( Istream &  ,
wallFace &   
)
friend
The documentation for this class was generated from the following files: