Loading...
Searching...
No Matches
patchDistMethod Class Referenceabstract

Specialisation of patchDist for wall distance calculation. More...

#include <patchDistMethod.H>

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

Public Member Functions

 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.
virtual bool correct (volScalarField &y)=0
 Correct the given distance-to-patch field.
virtual bool correct (volScalarField &y, volVectorField &n)=0
 Correct the given distance-to-patch and normal-to-patch fields.
template<class Type>
Foam::wordList patchTypes (const fvMesh &mesh, const labelHashSet &patchIDs)

Static Public Member Functions

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

 patchDistMethod (const patchDistMethod &)=delete
 No copy construct.
void operator= (const patchDistMethod &)=delete
 No copy assignment.

Protected Attributes

const fvMesh & mesh_
 Reference to the mesh.
const labelHashSet patchIDs_
 Set of patch IDs.

Detailed Description

Specialisation of patchDist for wall distance calculation.

Source files

Definition at line 55 of file patchDistMethod.H.

Constructor & Destructor Documentation

◆ patchDistMethod() [1/2]

patchDistMethod ( const patchDistMethod & )
protecteddelete

No copy construct.

References patchDistMethod().

Referenced by advectionDiffusion::advectionDiffusion(), declareRunTimeSelectionTable(), exact::exact(), exact::exact(), meshWave::meshWave(), meshWave::meshWave(), meshWaveAddressing::meshWaveAddressing(), meshWaveAddressing::meshWaveAddressing(), operator=(), patchDistMethod(), Poisson::Poisson(), and Poisson::Poisson().

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

◆ patchDistMethod() [2/2]

patchDistMethod ( const fvMesh & mesh,
const labelHashSet & patchIDs )

Construct from mesh and patch ID set.

Definition at line 35 of file patchDistMethod.C.

References mesh, mesh_, patchIDs(), and patchIDs_.

Here is the call graph for this function:

◆ ~patchDistMethod()

~patchDistMethod ( )
virtual

Destructor.

Definition at line 91 of file patchDistMethod.C.

Member Function Documentation

◆ operator=()

void operator= ( const patchDistMethod & )
protecteddelete

No copy assignment.

References patchDistMethod().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "patchDistMethod" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
patchDistMethod ,
dictionary ,
(const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs) ,
(dict, mesh, patchIDs)  )

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

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::patchDistMethod > New ( const dictionary & dict,
const fvMesh & mesh,
const labelHashSet & patchIDs,
const word & defaultPatchDistMethod = word::null )
static

Definition at line 49 of file patchDistMethod.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, keyType::LITERAL, mesh, IOobjectOption::MUST_READ, patchIDs(), and IOobjectOption::READ_IF_PRESENT.

Referenced by advectionDiffusion::advectionDiffusion(), and levelSetDesignVariables::readField().

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

◆ patchTypes() [1/2]

template<class Type>
wordList patchTypes ( const fvMesh & mesh,
const labelHashSet & patchIDs )
static

Return the patch types for y and n.

These are fixedValue for the set provided otherwise zero-gradient

References mesh, and patchIDs().

Referenced by adjointEikonalSolver::computeYPhi(), advectionDiffusion::correct(), directionalMeshWave::correct(), wallDistAddressing::correct(), adjointEikonalSolver::getFISensitivityTerm(), and levelSetDesignVariables::readField().

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

◆ patchIDs()

const labelHashSet & patchIDs ( ) const
inline

Return the patchIDs.

Definition at line 158 of file patchDistMethod.H.

References patchIDs_.

Referenced by advectionDiffusion::advectionDiffusion(), declareRunTimeSelectionTable(), directionalMeshWave::directionalMeshWave(), exact::exact(), exact::exact(), meshWave::meshWave(), meshWave::meshWave(), meshWaveAddressing::meshWaveAddressing(), meshWaveAddressing::meshWaveAddressing(), New(), patchDistMethod(), patchTypes(), Poisson::Poisson(), Poisson::Poisson(), advectionDiffusion::TypeName(), directionalMeshWave::TypeName(), exact::TypeName(), meshWave::TypeName(), meshWaveAddressing::TypeName(), and Poisson::TypeName().

Here is the caller graph for this function:

◆ movePoints()

virtual bool movePoints ( )
inlinevirtual

Update cached geometry when the mesh moves.

Reimplemented in exact.

Definition at line 166 of file patchDistMethod.H.

◆ updateMesh()

virtual void updateMesh ( const mapPolyMesh & )
inlinevirtual

Update cached topology and geometry when the mesh changes.

Reimplemented in exact.

Definition at line 174 of file patchDistMethod.H.

◆ correct() [1/2]

virtual bool correct ( volScalarField & y)
pure virtual

Correct the given distance-to-patch field.

Implemented in advectionDiffusion, directionalMeshWave, exact, meshWave, meshWaveAddressing, and Poisson.

References y.

◆ correct() [2/2]

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

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

Implemented in advectionDiffusion, directionalMeshWave, exact, meshWave, meshWaveAddressing, and Poisson.

References n, and y.

◆ patchTypes() [2/2]

template<class Type>
Foam::wordList patchTypes ( const fvMesh & mesh,
const labelHashSet & patchIDs )

Definition at line 27 of file patchDistMethodTemplates.C.

References mesh, patchIDs(), FieldBase::typeName, and fvPatchFieldBase::zeroGradientType().

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh.

Definition at line 64 of file patchDistMethod.H.

Referenced by advectionDiffusion::correct(), directionalMeshWave::correct(), directionalMeshWave::correct(), exact::correct(), meshWave::correct(), meshWave::correct(), meshWaveAddressing::correct(), Poisson::correct(), and patchDistMethod().

◆ patchIDs_

const labelHashSet patchIDs_
protected

Set of patch IDs.

Definition at line 69 of file patchDistMethod.H.

Referenced by advectionDiffusion::correct(), directionalMeshWave::correct(), directionalMeshWave::correct(), meshWave::correct(), meshWave::correct(), meshWaveAddressing::correct(), patchDistMethod(), and patchIDs().

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