Public Member Functions | Static Public Member Functions | List of all members
PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData > Class Template Reference

Wave propagation of information along patch. Every iteration information goes through one layer of faces. Templated on information that is transferred. More...

Inheritance diagram for PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >:
Inheritance graph
[legend]
Collaboration diagram for PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >:
Collaboration graph
[legend]

Public Member Functions

 PatchEdgeFaceWave (const polyMesh &mesh, const PrimitivePatchType &patch, const labelList &initialEdges, const List< Type > &initialEdgesInfo, UList< Type > &allEdgeInfo, UList< Type > &allFaceInfo, const label maxIter, TrackingData &td=dummyTrackData_)
 Construct from patch, list of changed edges with the Type. More...
 
 PatchEdgeFaceWave (const polyMesh &mesh, const PrimitivePatchType &patch, UList< Type > &allEdgeInfo, UList< Type > &allFaceInfo, TrackingData &td=dummyTrackData_)
 Construct from patch. Use setEdgeInfo and iterate() to do. More...
 
UList< Type > & allEdgeInfo () const
 Access allEdgeInfo. More...
 
UList< Type > & allFaceInfo () const
 Access allFaceInfo. More...
 
const TrackingData & data () const
 Additional data to be passed into container. More...
 
label getUnsetFaces () const
 Get number of unvisited faces, i.e. faces that were not (yet) More...
 
label getUnsetEdges () const
 
void setEdgeInfo (const labelList &changedEdges, const List< Type > &changedEdgesInfo)
 Copy initial data into allEdgeInfo_. More...
 
label edgeToFace ()
 Propagate from edge to face. Returns total number of faces. More...
 
label faceToEdge ()
 Propagate from face to edge. Returns total number of edges. More...
 
label iterate (const label maxIter)
 Iterate until no changes or maxIter reached. Returns actual. More...
 

Static Public Member Functions

static scalar propagationTol ()
 Access to tolerance. More...
 
static void setPropagationTol (const scalar tol)
 Change tolerance. More...
 

Detailed Description

template<class PrimitivePatchType, class Type, class TrackingData = label>
class Foam::PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >

Wave propagation of information along patch. Every iteration information goes through one layer of faces. Templated on information that is transferred.

Source files

Definition at line 69 of file PatchEdgeFaceWave.H.

Constructor & Destructor Documentation

PatchEdgeFaceWave ( const polyMesh mesh,
const PrimitivePatchType &  patch,
const labelList initialEdges,
const List< Type > &  initialEdgesInfo,
UList< Type > &  allEdgeInfo,
UList< Type > &  allFaceInfo,
const label  maxIter,
TrackingData &  td = dummyTrackData_ 
)

Construct from patch, list of changed edges with the Type.

for these edges. Gets work arrays to operate on, one of size number of patch edges, the other number of patch faces. Iterates until nothing changes or maxIter reached. (maxIter can be 0)

Definition at line 290 of file PatchEdgeFaceWave.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and Foam::Pout.

Here is the call graph for this function:

PatchEdgeFaceWave ( const polyMesh mesh,
const PrimitivePatchType &  patch,
UList< Type > &  allEdgeInfo,
UList< Type > &  allFaceInfo,
TrackingData &  td = dummyTrackData_ 
)

Construct from patch. Use setEdgeInfo and iterate() to do.

actual calculation

Definition at line 392 of file PatchEdgeFaceWave.C.

References PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::getUnsetEdges().

Here is the call graph for this function:

Member Function Documentation

static scalar propagationTol ( )
inlinestatic

Access to tolerance.

Definition at line 165 of file PatchEdgeFaceWave.H.

static void setPropagationTol ( const scalar  tol)
inlinestatic
UList<Type>& allEdgeInfo ( ) const
inline

Access allEdgeInfo.

Definition at line 211 of file PatchEdgeFaceWave.H.

Referenced by PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::setPropagationTol().

Here is the caller graph for this function:

UList<Type>& allFaceInfo ( ) const
inline

Access allFaceInfo.

Definition at line 217 of file PatchEdgeFaceWave.H.

Referenced by PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::setPropagationTol().

Here is the caller graph for this function:

const TrackingData& data ( ) const
inline
Foam::label getUnsetFaces ( ) const

Get number of unvisited faces, i.e. faces that were not (yet)

reached from walking across patch. This can happen from

  • not enough iterations done
  • a disconnected patch
  • a patch without walls in it

Definition at line 449 of file PatchEdgeFaceWave.C.

References PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::setEdgeInfo().

Referenced by PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::data(), and PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::getUnsetEdges().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label getUnsetEdges ( ) const
void setEdgeInfo ( const labelList changedEdges,
const List< Type > &  changedEdgesInfo 
)

Copy initial data into allEdgeInfo_.

Definition at line 464 of file PatchEdgeFaceWave.C.

References List< T >::append(), PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::faceToEdge(), and forAll.

Referenced by PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::data(), and PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::getUnsetFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label edgeToFace ( )

Propagate from edge to face. Returns total number of faces.

(over all processors) changed.

Definition at line 566 of file PatchEdgeFaceWave.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::iterate(), Foam::nl, Foam::Pout, and Foam::returnReduce().

Referenced by PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::data(), and PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::faceToEdge().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label faceToEdge ( )

Propagate from face to edge. Returns total number of edges.

(over all processors) changed.

Definition at line 503 of file PatchEdgeFaceWave.C.

References Foam::abort(), PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::edgeToFace(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, Foam::nl, Foam::Pout, and Foam::returnReduce().

Referenced by PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::data(), and PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::setEdgeInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label iterate ( const label  maxIter)

Iterate until no changes or maxIter reached. Returns actual.

number of iterations.

Definition at line 628 of file PatchEdgeFaceWave.C.

References Foam::endl(), Foam::nl, and Foam::Pout.

Referenced by PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::data(), and PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::edgeToFace().

Here is the call graph for this function:

Here is the caller graph for this function:


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