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

Determines length of string of edges walked to point. More...

Public Member Functions

 pointEdgeStructuredWalk ()
 Default construct. More...
 
 pointEdgeStructuredWalk (const point &point0, const point &previousPoint, const scalar dist, const vector &data, const label index=-1)
 Construct from components. More...
 
scalar dist () const
 The distance information. More...
 
const vector & data () const
 Tracking data. More...
 
label index () const
 Index (if any) associated with data. More...
 
bool inZone () const
 True if starting point is valid (ie, not point::max) More...
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Changed or contains original (invalid) value. More...
 
template<class TrackingData >
bool sameGeometry (const pointEdgeStructuredWalk &, 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 pointEdgeStructuredWalk &edgeInfo, const scalar tol, TrackingData &td)
 Influence of edge on point. More...
 
template<class TrackingData >
bool updatePoint (const polyMesh &mesh, const label pointi, const pointEdgeStructuredWalk &newPointInfo, const scalar tol, TrackingData &td)
 Influence of different value on same point. More...
 
template<class TrackingData >
bool updatePoint (const pointEdgeStructuredWalk &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 pointEdgeStructuredWalk &pointInfo, const scalar tol, TrackingData &td)
 Influence of point on edge. More...
 
template<class TrackingData >
bool equal (const pointEdgeStructuredWalk &, TrackingData &) const
 Test for equality, with TrackingData. More...
 
bool operator== (const pointEdgeStructuredWalk &) const
 Test for equality. More...
 
bool operator!= (const pointEdgeStructuredWalk &) const
 Test for inequality. More...
 

Friends

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

Detailed Description

Determines length of string of edges walked to point.

Source files

Definition at line 57 of file pointEdgeStructuredWalk.H.

Constructor & Destructor Documentation

◆ pointEdgeStructuredWalk() [1/2]

pointEdgeStructuredWalk ( )
inline

Default construct.

Definition at line 52 of file pointEdgeStructuredWalkI.H.

◆ pointEdgeStructuredWalk() [2/2]

pointEdgeStructuredWalk ( const point &  point0,
const point &  previousPoint,
const scalar  dist,
const vector &  data,
const label  index = -1 
)
inline

Construct from components.

Definition at line 63 of file pointEdgeStructuredWalkI.H.

Member Function Documentation

◆ dist()

scalar dist ( ) const
inline

The distance information.

Definition at line 129 of file pointEdgeStructuredWalk.H.

◆ data()

const vector& data ( ) const
inline

Tracking data.

Definition at line 137 of file pointEdgeStructuredWalk.H.

◆ index()

label index ( ) const
inline

Index (if any) associated with data.

Definition at line 145 of file pointEdgeStructuredWalk.H.

◆ inZone()

bool inZone ( ) const
inline

True if starting point is valid (ie, not point::max)

Definition at line 81 of file pointEdgeStructuredWalkI.H.

References Foam::max().

Here is the call graph for this function:

◆ valid()

bool valid ( TrackingData &  td) const
inline

Changed or contains original (invalid) value.

Definition at line 88 of file pointEdgeStructuredWalkI.H.

References Foam::max().

Here is the call graph for this function:

◆ sameGeometry()

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

Check for identical geometrical data (eg, cyclics checking)

Definition at line 97 of file pointEdgeStructuredWalkI.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 125 of file pointEdgeStructuredWalkI.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 151 of file pointEdgeStructuredWalkI.H.

◆ transform()

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

Apply rotation matrix to origin.

Definition at line 138 of file pointEdgeStructuredWalkI.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 pointEdgeStructuredWalk &  edgeInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of edge on point.

Definition at line 166 of file pointEdgeStructuredWalkI.H.

References td(), and update().

Here is the call graph for this function:

◆ updatePoint() [2/3]

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

Influence of different value on same point.

Merge new and old info.

Definition at line 187 of file pointEdgeStructuredWalkI.H.

References td(), and update().

Here is the call graph for this function:

◆ updatePoint() [3/3]

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

Influence of different value on same point.

No information about current position whatsoever.

Definition at line 207 of file pointEdgeStructuredWalkI.H.

References td(), and update().

Here is the call graph for this function:

◆ updateEdge()

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

Influence of point on edge.

Definition at line 220 of file pointEdgeStructuredWalkI.H.

References td(), and update().

Here is the call graph for this function:

◆ equal()

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

Test for equality, with TrackingData.

Definition at line 240 of file pointEdgeStructuredWalkI.H.

References Foam::operator==(), and Foam::rhs().

Here is the call graph for this function:

◆ operator==()

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

Test for equality.

Definition at line 252 of file pointEdgeStructuredWalkI.H.

References Foam::rhs().

Here is the call graph for this function:

◆ operator!=()

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

Test for inequality.

Definition at line 261 of file pointEdgeStructuredWalkI.H.

References Foam::rhs().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

◆ operator>>

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