Loading...
Searching...
No Matches
directionalMeshWave Class Reference

Variant of meshWave distance-to-patch method. More...

#include <directionalMeshWavePatchDistMethod.H>

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

Public Member Functions

 TypeName ("directionalMeshWave")
 Runtime type information.
 directionalMeshWave (const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs)
 Construct from coefficients dictionary, mesh and fixed-value patch set.
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 meshWave
 TypeName ("meshWave")
 Runtime type information.
 meshWave (const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs)
 Construct from coefficients dictionary, mesh.
 meshWave (const fvMesh &mesh, const labelHashSet &patchIDs, const bool correctWalls=true)
 Construct from mesh, fixed-value patch set and flag specifying.
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)

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.
Protected Member Functions inherited from patchDistMethod
 patchDistMethod (const patchDistMethod &)=delete
 No copy construct.
void operator= (const patchDistMethod &)=delete
 No copy assignment.
Protected Attributes inherited from meshWave
const bool correctWalls_
 Do accurate distance calculation for near-wall cells.
label nUnset_
 Number of unset cells and faces.
Protected Attributes inherited from patchDistMethod
const fvMesh & mesh_
 Reference to the mesh.
const labelHashSet patchIDs_
 Set of patch IDs.

Detailed Description

Variant of meshWave distance-to-patch method.

Ignores the component in the specified direction. Can be used e.g. to calculate the distance in the z-direction only.

Usage
Example of specification in fvSchemes.wallDist: 
    wallDist
    {
        // Mandatory entries (unmodifiable)
        method      directionalMeshWave;
        n           (0 0 1);

        // Optional (inherited) entries (unmodifiable)
        ...
    }

where the entries mean:

Property Description Type Req'd Dflt
method Method name: directionalMeshWave word yes -
n The direction component to ignore vector yes -

The inherited entries are elaborated in:

See also
Foam::wallDist Foam::patchDistMethod::meshWave Foam::patchDistMethod::Poisson Foam::directionalWallPoint
Source files

Definition at line 99 of file directionalMeshWavePatchDistMethod.H.

Constructor & Destructor Documentation

◆ directionalMeshWave()

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

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

Definition at line 47 of file directionalMeshWavePatchDistMethod.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "directionalMeshWave" )

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.

Reimplemented from meshWave.

Definition at line 61 of file directionalMeshWavePatchDistMethod.C.

References correct(), Foam::dimLength, Foam::dimless, patchDistMethod::mesh_, n, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, patches, patchDistMethod::patchIDs_, patchDistMethod::patchTypes(), y, and Foam::Zero.

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.

Reimplemented from meshWave.

Definition at line 94 of file directionalMeshWavePatchDistMethod.C.

References patchDataWave< TransferType, TrackingData >::cellData(), meshWave::correctWalls_, Foam::dimLength, patchDataWave< TransferType, TrackingData >::distance(), forAll, Foam::isA(), patchDistMethod::mesh_, n, patchDataWave< TransferType, TrackingData >::nUnset(), meshWave::nUnset_, patchDataWave< TransferType, TrackingData >::patchData(), patchDataWave< TransferType, TrackingData >::patchDistance(), patchDistMethod::patchIDs_, UPtrList< T >::set(), PtrList< T >::transfer(), and y.

Here is the call graph for this function:
The documentation for this class was generated from the following files: