FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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 scalarField &  distance () const
scalarField &  distance ()
 Non const access so we can 'transfer' contents for efficiency.
const FieldField< Field, scalar > &  patchDistance () const
FieldField< Field, scalar > &  patchDistance ()

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: