FreeFOAM The Cross-Platform CFD Toolkit
patchWave Class Reference

Takes a set of patches to start MeshWave from. After construction holds distance at cells and distance at patches. Is e.g. used by wallDist to construct volScalarField with correct distance to wall. More...

#include <meshTools/patchWave.H>


Detailed Description

Takes a set of patches to start MeshWave from. After construction holds distance at cells and distance at patches. Is e.g. used by wallDist to construct volScalarField with correct distance to wall.

Source files

Definition at line 58 of file patchWave.H.

+ Inheritance diagram for patchWave:
+ Collaboration diagram for patchWave:

List of all members.

Public Member Functions

 patchWave (const polyMesh &mesh, const labelHashSet &patchIDs, bool correctWalls=true)
 Construct from mesh and patches to initialize to 0 and flag.
virtual ~patchWave ()
virtual void correct ()
 Correct for mesh geom/topo changes.
label nUnset () const
const scalarFielddistance () const
scalarFielddistance ()
 Non const access so we can 'transfer' contents for efficiency.
const FieldField< Field, scalar > & patchDistance () const
FieldField< Field, scalar > & patchDistance ()
- Public Member Functions inherited from cellDistFuncs
 ClassName ("cellDistFuncs")
 cellDistFuncs (const polyMesh &mesh)
 Construct from mesh.
const polyMeshmesh () const
 Access mesh.
labelHashSet getPatchIDs (const wordList &) const
 Get patchIDs of named patches.
template<class Type >
labelHashSet getPatchIDs () const
 Get patchIDs of/derived off certain type (e.g. 'processorPolyPatch')
scalar smallestDist (const point &p, const polyPatch &patch, const label nWallFaces, const labelList &wallFaces, label &meshFaceI) const
 Calculate smallest true distance (and face index)
label getPointNeighbours (const primitivePatch &, const label patchFaceI, labelList &) const
 Get faces sharing point with face on patch.
label maxPatchSize (const labelHashSet &patchIDs) const
 Size of largest patch (out of supplied subset of patches)
label sumPatchSize (const labelHashSet &patchIDs) const
 Sum of patch sizes (out of supplied subset of patches).
void correctBoundaryFaceCells (const labelHashSet &patchIDs, scalarField &wallDistCorrected, Map< label > &nearestFace) const
 Correct all cells connected to boundary (via face). Sets values in.
void correctBoundaryPointCells (const labelHashSet &patchIDs, scalarField &wallDistCorrected, Map< label > &nearestFace) const
 Correct all cells connected to wall (via point). Sets values in.

Constructor & Destructor Documentation

patchWave ( const polyMesh mesh,
const labelHashSet patchIDs,
bool  correctWalls = true 
)

Construct from mesh and patches to initialize to 0 and flag.

whether or not to correct wall. Calculate for all cells. correctWalls : correct wall (face&point) cells for correct distance, searching neighbours.

Definition at line 137 of file patchWave.C.

References patchWave::correct().

~patchWave ( )
virtual

Definition at line 156 of file patchWave.C.


Member Function Documentation

void correct ( )
virtual

Correct for mesh geom/topo changes.

Definition at line 164 of file patchWave.C.

References mesh.

Referenced by patchWave::patchWave().

label nUnset ( ) const
inline

Definition at line 123 of file patchWave.H.

Referenced by wallDist::correct().

const scalarField& distance ( ) const
inline

Definition at line 128 of file patchWave.H.

Referenced by wallDist::correct().

scalarField& distance ( )
inline

Non const access so we can 'transfer' contents for efficiency.

Definition at line 134 of file patchWave.H.

const FieldField<Field, scalar>& patchDistance ( ) const
inline

Definition at line 139 of file patchWave.H.

Referenced by wallDist::correct().

FieldField<Field, scalar>& patchDistance ( )
inline

Definition at line 144 of file patchWave.H.


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