Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
edgeTopoDistanceData< Type, PrimitivePatchType > Class Template Reference

For use with PatchEdgeFaceWave. Determines topological distance to starting edges. Templated on passive transported data. More...

Public Types

typedef Type dataType
 

Public Member Functions

 edgeTopoDistanceData ()
 Construct null with invalid (-1) for distance, null constructor. More...
 
 edgeTopoDistanceData (const label distance, const Type &data)
 Construct from distance, data. More...
 
label distance () const
 
const Type & data () const
 
template<class TrackingData >
bool valid (TrackingData &td) const
 Check whether origin has been changed at all or. More...
 
template<class TrackingData >
void transform (const polyMesh &mesh, const PrimitivePatchType &patch, const tensor &rotTensor, const scalar tol, TrackingData &td)
 Apply rotation matrix. More...
 
template<class TrackingData >
bool updateEdge (const polyMesh &mesh, const PrimitivePatchType &patch, const label edgeI, const label facei, const edgeTopoDistanceData< Type, PrimitivePatchType > &faceInfo, const scalar tol, TrackingData &td)
 Influence of face on edge. More...
 
template<class TrackingData >
bool updateEdge (const polyMesh &mesh, const PrimitivePatchType &patch, const edgeTopoDistanceData< Type, PrimitivePatchType > &edgeInfo, const bool sameOrientation, const scalar tol, TrackingData &td)
 New information for edge (from e.g. coupled edge) More...
 
template<class TrackingData >
bool updateFace (const polyMesh &mesh, const PrimitivePatchType &patch, const label facei, const label edgeI, const edgeTopoDistanceData< Type, PrimitivePatchType > &edgeInfo, const scalar tol, TrackingData &td)
 Influence of edge on face. More...
 
template<class TrackingData >
bool equal (const edgeTopoDistanceData< Type, PrimitivePatchType > &, TrackingData &) const
 Same (like operator==) More...
 
bool operator== (const edgeTopoDistanceData< Type, PrimitivePatchType > &) const
 
bool operator!= (const edgeTopoDistanceData< Type, PrimitivePatchType > &) const
 

Protected Attributes

label distance_
 Distance. More...
 
Type data_
 Starting data. More...
 

Friends

Ostream & operator (Ostream &, const edgeTopoDistanceData< Type, PrimitivePatchType > &)
 
Istream & operator>> (Istream &, edgeTopoDistanceData< Type, PrimitivePatchType > &)
 

Detailed Description

template<class Type, class PrimitivePatchType = indirectPrimitivePatch>
class Foam::edgeTopoDistanceData< Type, PrimitivePatchType >

For use with PatchEdgeFaceWave. Determines topological distance to starting edges. Templated on passive transported data.

Source files

Definition at line 76 of file edgeTopoDistanceData.H.

Member Typedef Documentation

◆ dataType

typedef Type dataType

Definition at line 91 of file edgeTopoDistanceData.H.

Constructor & Destructor Documentation

◆ edgeTopoDistanceData() [1/2]

edgeTopoDistanceData
inline

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

for data

Definition at line 36 of file edgeTopoDistanceDataI.H.

◆ edgeTopoDistanceData() [2/2]

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

Construct from distance, data.

Definition at line 45 of file edgeTopoDistanceDataI.H.

Member Function Documentation

◆ distance()

label distance ( ) const
inline

Definition at line 111 of file edgeTopoDistanceData.H.

References edgeTopoDistanceData< Type, PrimitivePatchType >::distance_.

◆ data()

const Type & data ( ) const
inline

Definition at line 116 of file edgeTopoDistanceData.H.

References edgeTopoDistanceData< Type, PrimitivePatchType >::data_.

◆ valid()

bool valid ( TrackingData &  td) const
inline

Check whether origin has been changed at all or.

still contains original (invalid) value.

Definition at line 60 of file edgeTopoDistanceDataI.H.

◆ transform()

void transform ( const polyMesh &  mesh,
const PrimitivePatchType &  patch,
const tensor &  rotTensor,
const scalar  tol,
TrackingData &  td 
)
inline

Apply rotation matrix.

Definition at line 71 of file edgeTopoDistanceDataI.H.

◆ updateEdge() [1/2]

bool updateEdge ( const polyMesh &  mesh,
const PrimitivePatchType &  patch,
const label  edgeI,
const label  facei,
const edgeTopoDistanceData< Type, PrimitivePatchType > &  faceInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of face on edge.

Definition at line 84 of file edgeTopoDistanceDataI.H.

References edgeTopoDistanceData< Type, PrimitivePatchType >::data_, and edgeTopoDistanceData< Type, PrimitivePatchType >::distance_.

◆ updateEdge() [2/2]

bool updateEdge ( const polyMesh &  mesh,
const PrimitivePatchType &  patch,
const edgeTopoDistanceData< Type, PrimitivePatchType > &  edgeInfo,
const bool  sameOrientation,
const scalar  tol,
TrackingData &  td 
)
inline

New information for edge (from e.g. coupled edge)

Definition at line 109 of file edgeTopoDistanceDataI.H.

◆ updateFace()

bool updateFace ( const polyMesh &  mesh,
const PrimitivePatchType &  patch,
const label  facei,
const label  edgeI,
const edgeTopoDistanceData< Type, PrimitivePatchType > &  edgeInfo,
const scalar  tol,
TrackingData &  td 
)
inline

Influence of edge on face.

Definition at line 132 of file edgeTopoDistanceDataI.H.

◆ equal()

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

Same (like operator==)

Definition at line 156 of file edgeTopoDistanceDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const edgeTopoDistanceData< Type, PrimitivePatchType > &  rhs) const
inline

Definition at line 169 of file edgeTopoDistanceDataI.H.

References Foam::distance().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const edgeTopoDistanceData< Type, PrimitivePatchType > &  rhs) const
inline

Definition at line 179 of file edgeTopoDistanceDataI.H.

Friends And Related Function Documentation

◆ operator

Ostream & operator ( Ostream &  ,
const edgeTopoDistanceData< Type, PrimitivePatchType > &   
)
friend

◆ operator>>

Istream & operator>> ( Istream &  ,
edgeTopoDistanceData< Type, PrimitivePatchType > &   
)
friend

Member Data Documentation

◆ distance_

label distance_
protected

Distance.

Definition at line 83 of file edgeTopoDistanceData.H.

Referenced by edgeTopoDistanceData< Type, PrimitivePatchType >::distance(), and edgeTopoDistanceData< Type, PrimitivePatchType >::updateEdge().

◆ data_

Type data_
protected

Starting data.

Definition at line 86 of file edgeTopoDistanceData.H.

Referenced by edgeTopoDistanceData< Type, PrimitivePatchType >::data(), and edgeTopoDistanceData< Type, PrimitivePatchType >::updateEdge().

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