pointTopoDistanceData< Type > Class Template Reference

For use with PointEdgeWave. Determines topological distance to starting points. Templated on passive transported data. More...

Public Types

typedef Type dataType
 

Public Member Functions

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

Friends

Ostreamoperator (Ostream &, const pointTopoDistanceData< Type > &)
 
Istreamoperator>> (Istream &, pointTopoDistanceData< Type > &)
 

Detailed Description

template<class Type>
class Foam::pointTopoDistanceData< Type >

For use with PointEdgeWave. Determines topological distance to starting points. Templated on passive transported data.

Source files

Definition at line 64 of file pointTopoDistanceData.H.

Member Typedef Documentation

◆ dataType

typedef Type dataType

Definition at line 78 of file pointTopoDistanceData.H.

Constructor & Destructor Documentation

◆ pointTopoDistanceData() [1/2]

Construct null with invalid (-1) for distance, null constructor.

for data

Definition at line 34 of file pointTopoDistanceDataI.H.

◆ pointTopoDistanceData() [2/2]

pointTopoDistanceData ( const label  distance,
const Type &  data 
)
inline

Construct from components.

Definition at line 42 of file pointTopoDistanceDataI.H.

Member Function Documentation

◆ distance()

label distance ( ) const
inline

Definition at line 99 of file pointTopoDistanceData.H.

◆ data()

const Type & data ( ) const
inline

Definition at line 104 of file pointTopoDistanceData.H.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Changed or contains original (invalid) value.

Definition at line 57 of file pointTopoDistanceDataI.H.

◆ sameGeometry()

bool sameGeometry ( const pointTopoDistanceData< Type > &  ,
const scalar  tol,
TrackingData &  td 
) const
inline

Check for identical geometrical data (eg, cyclics checking)

Definition at line 66 of file pointTopoDistanceDataI.H.

◆ 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 80 of file pointTopoDistanceDataI.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 104 of file pointTopoDistanceDataI.H.

◆ transform()

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

Apply rotation matrix to origin.

Definition at line 93 of file pointTopoDistanceDataI.H.

◆ updatePoint() [1/3]

bool updatePoint ( const polyMesh mesh,
const label  pointi,
const label  edgeI,
const pointTopoDistanceData< Type > &  edgeInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of edge on point.

Definition at line 117 of file pointTopoDistanceDataI.H.

◆ updatePoint() [2/3]

bool updatePoint ( const polyMesh mesh,
const label  pointi,
const pointTopoDistanceData< Type > &  newPointInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same point.

Merge new and old info.

Definition at line 141 of file pointTopoDistanceDataI.H.

◆ updatePoint() [3/3]

bool updatePoint ( const pointTopoDistanceData< Type > &  newPointInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of different value on same point.

No information about current position whatsoever.

Definition at line 164 of file pointTopoDistanceDataI.H.

◆ updateEdge()

bool updateEdge ( const polyMesh mesh,
const label  edgeI,
const label  pointi,
const pointTopoDistanceData< Type > &  pointInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of point on edge.

Definition at line 185 of file pointTopoDistanceDataI.H.

◆ equal()

bool equal ( const pointTopoDistanceData< Type > &  rhs,
TrackingData &  td 
) const
inline

Test for equality, with TrackingData.

Definition at line 208 of file pointTopoDistanceDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const pointTopoDistanceData< Type > &  rhs) const
inline

Definition at line 221 of file pointTopoDistanceDataI.H.

References Foam::distance().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const pointTopoDistanceData< Type > &  rhs) const
inline

Definition at line 231 of file pointTopoDistanceDataI.H.

Friends And Related Function Documentation

◆ operator

Ostream & operator ( Ostream ,
const pointTopoDistanceData< Type > &   
)
friend

◆ operator>>

Istream & operator>> ( Istream ,
pointTopoDistanceData< Type > &   
)
friend

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