Loading...
Searching...
No Matches
meshWaveAddressing Class Reference

Variant of patchDistMethods::meshWave that stores nearest-wall addressing instead of directly transporting wall information. More...

#include <meshWaveAddressingPatchDistMethod.H>

Inheritance diagram for meshWaveAddressing:
Inheritance graph
[legend]
Collaboration diagram for meshWaveAddressing:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("meshWaveAddressing")
 Runtime type information.
 meshWaveAddressing (const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs)
 Construct from coefficients dictionary, mesh and fixed-value patch set.
 meshWaveAddressing (const fvMesh &mesh, const labelHashSet &patchIDs, const bool correctWalls=true)
 Construct from mesh, fixed-value patch set and flag specifying whether or not to correct wall.
virtual bool correct (volScalarField &y)
 Correct the given distance-to-patch field.
virtual bool correct (volScalarField &y, volVectorField &n)
 Correct the given distance-to-patch and normal-to-patch fields.
Public Member Functions inherited from patchDistMethod
 TypeName ("patchDistMethod")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, patchDistMethod, dictionary,(const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs),(dict, mesh, patchIDs))
 patchDistMethod (const fvMesh &mesh, const labelHashSet &patchIDs)
 Construct from mesh and patch ID set.
virtual ~patchDistMethod ()
 Destructor.
const labelHashSet & patchIDs () const
 Return the patchIDs.
virtual bool movePoints ()
 Update cached geometry when the mesh moves.
virtual void updateMesh (const mapPolyMesh &)
 Update cached topology and geometry when the mesh changes.
template<class Type>
Foam::wordList patchTypes (const fvMesh &mesh, const labelHashSet &patchIDs)

Protected Member Functions

 meshWaveAddressing (const meshWaveAddressing &)=delete
 No copy construct.
void operator= (const meshWaveAddressing &)=delete
 No copy assignment.
Protected Member Functions inherited from patchDistMethod
 patchDistMethod (const patchDistMethod &)=delete
 No copy construct.
void operator= (const patchDistMethod &)=delete
 No copy assignment.

Protected Attributes

const bool correctWalls_
 Do accurate distance calculation for near-wall cells.
Protected Attributes inherited from patchDistMethod
const fvMesh & mesh_
 Reference to the mesh.
const labelHashSet patchIDs_
 Set of patch IDs.

Additional Inherited Members

Static Public Member Functions inherited from patchDistMethod
static autoPtr< patchDistMethod > New (const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs, const word &defaultPatchDistMethod=word::null)
template<class Type>
static wordList patchTypes (const fvMesh &mesh, const labelHashSet &patchIDs)
 Return the patch types for y and n.

Detailed Description

Variant of patchDistMethods::meshWave that stores nearest-wall addressing instead of directly transporting wall information.

Example of the wallDist specification in fvSchemes: 

    wallDist
    {
        method meshWaveAddressing;

        // Optional entry enabling the calculation
        // of the normal-to-wall field
        nRequired true;
    }
See also
Foam::patchDistMethod::meshWave Foam::wallDist
Source files

Definition at line 65 of file meshWaveAddressingPatchDistMethod.H.

Constructor & Destructor Documentation

◆ meshWaveAddressing() [1/3]

meshWaveAddressing ( const meshWaveAddressing & )
protecteddelete

No copy construct.

References meshWaveAddressing().

Referenced by meshWaveAddressing(), and operator=().

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

◆ meshWaveAddressing() [2/3]

meshWaveAddressing ( const dictionary & dict,
const fvMesh & mesh,
const labelHashSet & patchIDs )

Construct from coefficients dictionary, mesh and fixed-value patch set.

Definition at line 41 of file meshWaveAddressingPatchDistMethod.C.

References correctWalls_, dict, mesh, patchDistMethod::patchDistMethod(), and patchDistMethod::patchIDs().

Here is the call graph for this function:

◆ meshWaveAddressing() [3/3]

meshWaveAddressing ( const fvMesh & mesh,
const labelHashSet & patchIDs,
const bool correctWalls = true )

Construct from mesh, fixed-value patch set and flag specifying whether or not to correct wall.

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

Definition at line 53 of file meshWaveAddressingPatchDistMethod.C.

References correctWalls_, mesh, patchDistMethod::patchDistMethod(), and patchDistMethod::patchIDs().

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

void operator= ( const meshWaveAddressing & )
protecteddelete

No copy assignment.

References meshWaveAddressing().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "meshWaveAddressing" )

Runtime type information.

References dict, mesh, n, patchDistMethod::patchIDs(), and y.

Here is the call graph for this function:

◆ correct() [1/2]

bool correct ( volScalarField & y)
virtual

Correct the given distance-to-patch field.

Implements patchDistMethod.

Definition at line 67 of file meshWaveAddressingPatchDistMethod.C.

References correct(), GeometricField< vector, fvPatchField, volMesh >::null(), and y.

Here is the call graph for this function:

◆ correct() [2/2]

bool correct ( volScalarField & y,
volVectorField & n )
virtual

Correct the given distance-to-patch and normal-to-patch fields.

Implements patchDistMethod.

Definition at line 73 of file meshWaveAddressingPatchDistMethod.C.

References correctWalls_, patchDistMethod::mesh_, n, MeshObject< fvMesh, UpdateableMeshObject, wallDistAddressing >::New(), Foam::notNull(), patchIds, patchDistMethod::patchIDs_, and y.

Here is the call graph for this function:

Member Data Documentation

◆ correctWalls_

const bool correctWalls_
protected

Do accurate distance calculation for near-wall cells.

Definition at line 76 of file meshWaveAddressingPatchDistMethod.H.

Referenced by correct(), meshWaveAddressing(), and meshWaveAddressing().

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