Public Member Functions | Private Member Functions | Private Attributes | Friends
pointEdgePoint Class Reference

Holds information regarding nearest wall point. Used in PointEdgeWave. (so not standard FaceCellWave) To be used in wall distance calculation. More...

Inheritance diagram for pointEdgePoint:
Inheritance graph
[legend]
Collaboration diagram for pointEdgePoint:
Collaboration graph
[legend]

Public Member Functions

 pointEdgePoint ()
 Construct null. More...
 
 pointEdgePoint (const point &, const scalar)
 Construct from origin, distance. More...
 
 pointEdgePoint (const pointEdgePoint &)
 Construct as copy. More...
 
const pointorigin () const
 
scalar distSqr () 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 pointEdgePoint &, const scalar tol, TrackingData &td) const
 Check for identical geometrical data. Used for cyclics checking. More...
 
template<class TrackingData >
void leaveDomain (const polyPatch &patch, const label patchPointI, const point &pos, TrackingData &td)
 Convert origin to relative vector to leaving point. More...
 
template<class TrackingData >
void enterDomain (const polyPatch &patch, const label patchPointI, const point &pos, TrackingData &td)
 Convert relative origin to absolute by adding entering point. More...
 
template<class TrackingData >
void transform (const tensor &rotTensor, TrackingData &td)
 Apply rotation matrix to origin. More...
 
template<class TrackingData >
bool updatePoint (const polyMesh &mesh, const label pointI, const label edgeI, const pointEdgePoint &edgeInfo, const scalar tol, TrackingData &td)
 Influence of edge on point. More...
 
template<class TrackingData >
bool updatePoint (const polyMesh &mesh, const label pointI, const pointEdgePoint &newPointInfo, const scalar tol, TrackingData &td)
 Influence of different value on same point. More...
 
template<class TrackingData >
bool updatePoint (const pointEdgePoint &newPointInfo, const scalar tol, TrackingData &td)
 Influence of different value on same point. More...
 
template<class TrackingData >
bool updateEdge (const polyMesh &mesh, const label edgeI, const label pointI, const pointEdgePoint &pointInfo, const scalar tol, TrackingData &td)
 Influence of point on edge. More...
 
template<class TrackingData >
bool equal (const pointEdgePoint &, TrackingData &td) const
 Same (like operator==) More...
 
bool operator== (const pointEdgePoint &) const
 
bool operator!= (const pointEdgePoint &) const
 

Private Member Functions

template<class TrackingData >
bool update (const point &, const pointEdgePoint &w2, const scalar tol, TrackingData &td)
 Evaluate distance to point. Update distSqr, origin from whomever. More...
 
template<class TrackingData >
bool update (const pointEdgePoint &w2, const scalar tol, TrackingData &td)
 Combine current with w2. Update distSqr, origin if w2 has smaller. More...
 

Private Attributes

point origin_
 Position of nearest wall center. More...
 
scalar distSqr_
 Normal distance (squared) from point to origin. More...
 

Friends

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

Detailed Description

Holds information regarding nearest wall point. Used in PointEdgeWave. (so not standard FaceCellWave) To be used in wall distance calculation.

Source files

Definition at line 59 of file pointEdgePoint.H.

Constructor & Destructor Documentation

◆ pointEdgePoint() [1/3]

pointEdgePoint ( )
inline

Construct null.

Definition at line 121 of file pointEdgePointI.H.

◆ pointEdgePoint() [2/3]

pointEdgePoint ( const point origin,
const scalar  distSqr 
)
inline

Construct from origin, distance.

Definition at line 130 of file pointEdgePointI.H.

◆ pointEdgePoint() [3/3]

pointEdgePoint ( const pointEdgePoint wpt)
inline

Construct as copy.

Definition at line 141 of file pointEdgePointI.H.

Member Function Documentation

◆ update() [1/2]

bool update ( const point pt,
const pointEdgePoint w2,
const scalar  tol,
TrackingData &  td 
)
inlineprivate

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 34 of file pointEdgePointI.H.

References Foam::diff(), Foam::magSqr(), and pointEdgePoint::origin().

Here is the call graph for this function:

◆ update() [2/2]

bool update ( const pointEdgePoint w2,
const scalar  tol,
TrackingData &  td 
)
inlineprivate

Combine current with w2. Update distSqr, origin if w2 has smaller.

quantities and returns true.

Definition at line 79 of file pointEdgePointI.H.

References Foam::diff(), pointEdgePoint::distSqr(), and pointEdgePoint::origin().

Here is the call graph for this function:

◆ origin()

const Foam::point & origin ( ) const
inline

Definition at line 150 of file pointEdgePointI.H.

Referenced by pointEdgePoint::operator==(), and pointEdgePoint::update().

Here is the caller graph for this function:

◆ distSqr()

Foam::scalar distSqr ( ) const
inline

Definition at line 156 of file pointEdgePointI.H.

Referenced by pointEdgePoint::operator==(), pointEdgePoint::sameGeometry(), and pointEdgePoint::update().

Here is the caller graph for this function:

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether origin has been changed at all or.

still contains original (invalid) value.

Definition at line 163 of file pointEdgePointI.H.

References Vector< scalar >::max.

◆ sameGeometry()

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

Check for identical geometrical data. Used for cyclics checking.

Definition at line 172 of file pointEdgePointI.H.

References Foam::diff(), pointEdgePoint::distSqr(), and Foam::mag().

Here is the call graph for this function:

◆ leaveDomain()

void leaveDomain ( const polyPatch patch,
const label  patchPointI,
const point pos,
TrackingData &  td 
)
inline

Convert origin to relative vector to leaving point.

(= point coordinate)

Definition at line 200 of file pointEdgePointI.H.

◆ enterDomain()

void enterDomain ( const polyPatch patch,
const label  patchPointI,
const point pos,
TrackingData &  td 
)
inline

Convert relative origin to absolute by adding entering point.

Definition at line 226 of file pointEdgePointI.H.

◆ transform()

void transform ( const tensor rotTensor,
TrackingData &  td 
)
inline

Apply rotation matrix to origin.

Definition at line 213 of file pointEdgePointI.H.

References Foam::transform().

Referenced by pointData::transform(), and PointData::transform().

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

◆ updatePoint() [1/3]

bool updatePoint ( const polyMesh mesh,
const label  pointI,
const label  edgeI,
const pointEdgePoint edgeInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of edge on point.

Definition at line 241 of file pointEdgePointI.H.

References mesh, and polyMesh::points().

Referenced by pointData::updatePoint(), and PointData::updatePoint().

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

◆ updatePoint() [2/3]

bool updatePoint ( const polyMesh mesh,
const label  pointI,
const pointEdgePoint newPointInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same point.

Merge new and old info.

Definition at line 257 of file pointEdgePointI.H.

References mesh, and polyMesh::points().

Here is the call graph for this function:

◆ updatePoint() [3/3]

bool updatePoint ( const pointEdgePoint newPointInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same point.

No information about current position whatsoever.

Definition at line 272 of file pointEdgePointI.H.

◆ updateEdge()

bool updateEdge ( const polyMesh mesh,
const label  edgeI,
const label  pointI,
const pointEdgePoint pointInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of point on edge.

Definition at line 285 of file pointEdgePointI.H.

References Foam::e, primitiveMesh::edges(), mesh, and polyMesh::points().

Referenced by pointData::updateEdge(), and PointData::updateEdge().

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

◆ equal()

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

Same (like operator==)

Definition at line 301 of file pointEdgePointI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const pointEdgePoint rhs) const
inline

Definition at line 312 of file pointEdgePointI.H.

References pointEdgePoint::distSqr(), and pointEdgePoint::origin().

Referenced by pointData::operator==(), and PointData::operator==().

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

◆ operator!=()

bool operator!= ( const pointEdgePoint rhs) const
inline

Definition at line 319 of file pointEdgePointI.H.

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

Istream& operator>> ( Istream ,
pointEdgePoint  
)
friend

Field Documentation

◆ origin_

point origin_
private

Position of nearest wall center.

Definition at line 64 of file pointEdgePoint.H.

◆ distSqr_

scalar distSqr_
private

Normal distance (squared) from point to origin.

Definition at line 67 of file pointEdgePoint.H.


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