Public Member Functions | List of all members
wallDist Class Reference

Interface to run-time selectable methods to calculate the distance-to-wall and normal-to-wall fields. More...

Inheritance diagram for wallDist:
[legend]
Collaboration diagram for wallDist:
[legend]

Public Member Functions

 ClassName ("wallDist")
 
 wallDist (const fvMesh &mesh, const labelHashSet &patchIDs, const word &patchTypeName="patch")
 Construct from mesh, patch IDs and optional patch type name. More...
 
 wallDist (const fvMesh &mesh, const word &defaultPatchDistMethod, const labelHashSet &patchIDs, const word &patchTypeName="patch")
 Construct from mesh, patch IDs, default patch distance method. More...
 
 wallDist (const fvMesh &mesh, const word &patchTypeName="wall")
 Construct from mesh and optional patch type name. More...
 
virtual ~wallDist ()
 Destructor. More...
 
const labelHashSet & patchIDs () const
 Return the patchIDs. More...
 
const volScalarField & y () const
 Return reference to cached distance-to-wall field. More...
 
const volVectorField & n () const
 Return reference to cached normal-to-wall field. More...
 
virtual bool movePoints ()
 Update the y-field when the mesh moves. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update the y-field when the mesh changes. More...
 
- Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDist >
 MeshObject (const fvMesh &mesh)
 Construct on Mesh type. More...
 
virtual ~MeshObject ()=default
 Destructor. More...
 
const fvMesh & mesh () const
 
virtual bool writeData (Ostream &os) const
 

Additional Inherited Members

- Static Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDist >
static const wallDist & New (const fvMesh &mesh, Args &&... args)
 Get existing or create a new MeshObject. More...
 
static bool Delete (const fvMesh &mesh)
 Static destructor. More...
 
- Protected Attributes inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDist >
const fvMesh & mesh_
 

Detailed Description

Interface to run-time selectable methods to calculate the distance-to-wall and normal-to-wall fields.

Example of the wallDist specification in fvSchemes: 

    wallDist
    {
        method meshWave;

        // Optional entry enabling the calculation
        // of the normal-to-wall field
        nRequired false;

        // Optional entry delaying wall distance update to every n steps
        // Default is 1 (update every step)
        updateInterval 5;
    }
See also
Foam::patchDistMethod::meshWave Foam::patchDistMethod::Poisson Foam::patchDistMethod::advectionDiffusion
Source files

Definition at line 75 of file wallDist.H.

Constructor & Destructor Documentation

◆ wallDist() [1/3]

wallDist ( const fvMesh &  mesh,
const labelHashSet &  patchIDs,
const word &  patchTypeName = "patch" 
)

Construct from mesh, patch IDs and optional patch type name.

Definition at line 73 of file wallDist.C.

◆ wallDist() [2/3]

wallDist ( const fvMesh &  mesh,
const word &  defaultPatchDistMethod,
const labelHashSet &  patchIDs,
const word &  patchTypeName = "patch" 
)

Construct from mesh, patch IDs, default patch distance method.

and optional patch type name

Definition at line 84 of file wallDist.C.

References wallDist::movePoints().

Here is the call graph for this function:

◆ wallDist() [3/3]

wallDist ( const fvMesh &  mesh,
const word &  patchTypeName = "wall" 
)

Construct from mesh and optional patch type name.

Definition at line 138 of file wallDist.C.

◆ ~wallDist()

~wallDist ( )
virtual

Destructor.

Definition at line 151 of file wallDist.C.

Member Function Documentation

◆ ClassName()

ClassName ( "wallDist"  )

◆ patchIDs()

const labelHashSet & patchIDs ( ) const
inline

Return the patchIDs.

Definition at line 162 of file wallDist.H.

◆ y()

const volScalarField & y ( ) const
inline

Return reference to cached distance-to-wall field.

Definition at line 168 of file wallDist.H.

◆ n()

const Foam::volVectorField & n ( ) const

Return reference to cached normal-to-wall field.

Definition at line 157 of file wallDist.C.

References Foam::endl(), Foam::isNull(), Foam::nl, and WarningInFunction.

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )
virtual

Update the y-field when the mesh moves.

Definition at line 175 of file wallDist.C.

References DebugInfo, and Foam::endl().

Referenced by wallDist::wallDist().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh &  mpm)
virtual

Update the y-field when the mesh changes.

Definition at line 206 of file wallDist.C.

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