Classes | Public Member Functions | Friends | List of all members
externalPointEdgePoint Class Reference

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

Classes

class  trackingData
 Class used to pass data into container. More...
 

Public Member Functions

 externalPointEdgePoint ()
 Default construct. More...
 
 externalPointEdgePoint (const point &, const scalar)
 Construct from origin, distance. More...
 
const point & origin () const
 
scalar distSqr () const
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value. More...
 
template<class TrackingData >
bool sameGeometry (const externalPointEdgePoint &, 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)
 
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 externalPointEdgePoint &edgeInfo, const scalar tol, TrackingData &td)
 Influence of edge on point. More...
 
template<class TrackingData >
bool updatePoint (const polyMesh &mesh, const label pointi, const externalPointEdgePoint &newPointInfo, const scalar tol, TrackingData &td)
 Influence of different value on same point. More...
 
template<class TrackingData >
bool updatePoint (const externalPointEdgePoint &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 externalPointEdgePoint &pointInfo, const scalar tol, TrackingData &td)
 Influence of point on edge. More...
 
template<class TrackingData >
bool equal (const externalPointEdgePoint &, TrackingData &td) const
 Test for equality, with TrackingData. More...
 
bool operator== (const externalPointEdgePoint &) const
 Test for equality. More...
 
bool operator!= (const externalPointEdgePoint &) const
 Test for inequality. More...
 

Friends

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

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 62 of file externalPointEdgePoint.H.

Constructor & Destructor Documentation

◆ externalPointEdgePoint() [1/2]

externalPointEdgePoint ( )
inline

Default construct.

Definition at line 121 of file externalPointEdgePointI.H.

◆ externalPointEdgePoint() [2/2]

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

Construct from origin, distance.

Definition at line 129 of file externalPointEdgePointI.H.

Member Function Documentation

◆ origin()

const point& origin ( ) const
inline

Definition at line 127 of file externalPointEdgePoint.H.

◆ distSqr()

scalar distSqr ( ) const
inline

Definition at line 132 of file externalPointEdgePoint.H.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Changed or contains original (invalid) value.

Definition at line 142 of file externalPointEdgePointI.H.

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

◆ sameGeometry()

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

Check for identical geometrical data (eg, cyclics checking)

Definition at line 151 of file externalPointEdgePointI.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 179 of file externalPointEdgePointI.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 203 of file externalPointEdgePointI.H.

◆ transform()

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

Apply rotation matrix to origin.

Definition at line 192 of file externalPointEdgePointI.H.

References Foam::transform().

Here is the call graph for this function:

◆ updatePoint() [1/3]

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

Influence of edge on point.

Definition at line 217 of file externalPointEdgePointI.H.

References update().

Here is the call graph for this function:

◆ updatePoint() [2/3]

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

Influence of different value on same point.

Merge new and old info.

Definition at line 232 of file externalPointEdgePointI.H.

References update().

Here is the call graph for this function:

◆ updatePoint() [3/3]

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

Influence of different value on same point.

No information about current position whatsoever.

Definition at line 246 of file externalPointEdgePointI.H.

References update().

Here is the call graph for this function:

◆ updateEdge()

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

Influence of point on edge.

Definition at line 258 of file externalPointEdgePointI.H.

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

Here is the call graph for this function:

◆ equal()

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

Test for equality, with TrackingData.

Definition at line 274 of file externalPointEdgePointI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

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

Test for equality.

Definition at line 286 of file externalPointEdgePointI.H.

◆ operator!=()

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

Test for inequality.

Definition at line 295 of file externalPointEdgePointI.H.

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

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