Public Member Functions | Friends | List of all members
pointEdgePoint Class Reference

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

Public Member Functions

 pointEdgePoint ()
 Default construct. More...
 
 pointEdgePoint (const point &origin, const scalar distSqr)
 Construct from origin, distance. More...
 
const point & origin () const
 
point & origin ()
 
scalar distSqr () const
 
scalar & distSqr ()
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value. More...
 
template<class TrackingData >
bool sameGeometry (const pointEdgePoint &, const scalar tol, TrackingData &td) const
 Check for identical geometrical data (eg, 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
 Test for equality, with TrackingData. More...
 
bool operator== (const pointEdgePoint &) const
 Test for equality. More...
 
bool operator!= (const pointEdgePoint &) const
 Test for inequality. More...
 

Friends

Ostream & operator<< (Ostream &, const pointEdgePoint &)
 
Istream & operator>> (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 66 of file pointEdgePoint.H.

Constructor & Destructor Documentation

◆ pointEdgePoint() [1/2]

pointEdgePoint ( )
inline

Default construct.

Definition at line 123 of file pointEdgePointI.H.

◆ pointEdgePoint() [2/2]

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

Construct from origin, distance.

Definition at line 131 of file pointEdgePointI.H.

Member Function Documentation

◆ origin() [1/2]

const point& origin ( ) const
inline

Definition at line 117 of file pointEdgePoint.H.

◆ origin() [2/2]

point& origin ( )
inline

Definition at line 121 of file pointEdgePoint.H.

◆ distSqr() [1/2]

scalar distSqr ( ) const
inline

Definition at line 126 of file pointEdgePoint.H.

◆ distSqr() [2/2]

scalar& distSqr ( )
inline

Definition at line 130 of file pointEdgePoint.H.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Changed or contains original (invalid) value.

Definition at line 144 of file pointEdgePointI.H.

References VectorSpace< Vector< Cmpt >, Cmpt, 3 >::max.

◆ sameGeometry()

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

Check for identical geometrical data (eg, cyclics checking)

Definition at line 153 of file pointEdgePointI.H.

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

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

◆ transform()

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

Apply rotation matrix to origin.

Definition at line 194 of file pointEdgePointI.H.

References Foam::transform().

Referenced by PointData< DataType >::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 222 of file pointEdgePointI.H.

References mesh, polyMesh::points(), and update().

Referenced by PointData< DataType >::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 238 of file pointEdgePointI.H.

References mesh, polyMesh::points(), and update().

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

References update().

Here is the call graph for this function:

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

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

Referenced by PointData< DataType >::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

Test for equality, with TrackingData.

Definition at line 282 of file pointEdgePointI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

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

Test for equality.

Definition at line 294 of file pointEdgePointI.H.

Referenced by PointData< DataType >::operator==().

Here is the caller graph for this function:

◆ operator!=()

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

Test for inequality.

Definition at line 303 of file pointEdgePointI.H.

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

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