meshWaveAddressing Class Reference

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

Inheritance diagram for meshWaveAddressing:
Collaboration diagram for meshWaveAddressing:

Public Member Functions

 TypeName ("meshWaveAddressing")
 Runtime type information. More...
 
 meshWaveAddressing (const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs)
 Construct from coefficients dictionary, mesh and fixed-value patch set. More...
 
 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. More...
 
virtual bool correct (volScalarField &y)
 Correct the given distance-to-patch field. More...
 
virtual bool correct (volScalarField &y, volVectorField &n)
 Correct the given distance-to-patch and normal-to-patch fields. More...
 
- Public Member Functions inherited from patchDistMethod
 TypeName ("patchDistMethod")
 Runtime type information. More...
 
 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. More...
 
virtual ~patchDistMethod ()
 Destructor. More...
 
const labelHashSetpatchIDs () const
 Return the patchIDs. More...
 
virtual bool movePoints ()
 Update cached geometry when the mesh moves. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update cached topology and geometry when the mesh changes. More...
 
template<class Type >
Foam::wordList patchTypes (const fvMesh &mesh, const labelHashSet &patchIDs)
 

Protected Member Functions

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

Protected Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from patchDistMethod
static autoPtr< patchDistMethodNew (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. More...
 

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.

◆ 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 42 of file meshWaveAddressingPatchDistMethod.C.

◆ 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 54 of file meshWaveAddressingPatchDistMethod.C.

Member Function Documentation

◆ operator=()

void operator= ( const meshWaveAddressing )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "meshWaveAddressing"  )

Runtime type information.

◆ 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 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 74 of file meshWaveAddressingPatchDistMethod.C.

References n, MeshObject< fvMesh, UpdateableMeshObject, wallDistAddressing >::New(), UPstream::nonBlocking, Foam::notNull(), UPstream::nRequests(), UPstream::waitRequests(), 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.


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