Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
patchDistMethod Class Referenceabstract

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

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

Public Member Functions

 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...
 
 patchDistMethod (const patchDistMethod &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~patchDistMethod ()
 Destructor. More...
 
const labelHashSet & patchIDs () const
 Return the patchIDs. More...
 
virtual bool movePoints ()
 Update cached geometry when the mesh moves. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update cached topology and geometry when the mesh changes. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
virtual bool correct (volScalarField &y)=0
 Correct the given distance-to-patch field. More...
 
virtual bool correct (volScalarField &y, volVectorField &n)=0
 Correct the given distance-to-patch and normal-to-patch fields. More...
 
void operator= (const patchDistMethod &)=delete
 Disallow default bitwise assignment. More...
 
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)
 
template<class Type >
static wordList patchTypes (const fvMesh &mesh, const labelHashSet &patchIDs)
 Return the patch types for y and n. More...
 

Protected Attributes

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

Detailed Description

Specialisation of patchDist for wall distance calculation.

Source files

Definition at line 56 of file patchDistMethod.H.

Constructor & Destructor Documentation

◆ patchDistMethod() [1/2]

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

Construct from mesh and patch ID set.

Definition at line 39 of file patchDistMethod.C.

◆ patchDistMethod() [2/2]

patchDistMethod ( const patchDistMethod &  )
delete

Disallow default bitwise copy construction.

◆ ~patchDistMethod()

~patchDistMethod ( )
virtual

Destructor.

Definition at line 82 of file patchDistMethod.C.

Member Function Documentation

◆ TypeName()

TypeName ( "patchDistMethod"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

Definition at line 52 of file patchDistMethod.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and dictionary::lookup().

Here is the call graph for this function:

◆ patchTypes() [1/2]

static 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

◆ patchIDs()

const labelHashSet& patchIDs ( ) const
inline

Return the patchIDs.

Definition at line 134 of file patchDistMethod.H.

References patchDistMethod::patchIDs_.

Referenced by patchDistMethod::patchTypes().

Here is the caller graph for this function:

◆ movePoints()

virtual bool movePoints ( )
inlinevirtual

Update cached geometry when the mesh moves.

Definition at line 140 of file patchDistMethod.H.

◆ topoChange()

virtual void topoChange ( const polyTopoChangeMap &  )
inlinevirtual

Update cached topology and geometry when the mesh changes.

Definition at line 146 of file patchDistMethod.H.

◆ mapMesh()

virtual void mapMesh ( const polyMeshMap &  )
inlinevirtual

Update from another mesh using the given map.

Definition at line 150 of file patchDistMethod.H.

◆ distribute()

virtual void distribute ( const polyDistributionMap &  )
inlinevirtual

Redistribute or update using the given distribution map.

Definition at line 154 of file patchDistMethod.H.

◆ correct() [1/2]

virtual bool correct ( volScalarField &  y)
pure virtual

Correct the given distance-to-patch field.

Implemented in Poisson, meshWave, and advectionDiffusion.

◆ 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 Poisson, meshWave, and advectionDiffusion.

◆ operator=()

void operator= ( const patchDistMethod &  )
delete

Disallow default bitwise assignment.

◆ patchTypes() [2/2]

Foam::wordList patchTypes ( const fvMesh &  mesh,
const labelHashSet &  patchIDs 
)

Definition at line 31 of file patchDistMethodTemplates.C.

References fvMesh::boundary(), forAllConstIter, patchDistMethod::patchIDs(), and UPtrList< T >::size().

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.

◆ patchIDs_

const labelHashSet patchIDs_
protected

Set of patch IDs.

Definition at line 67 of file patchDistMethod.H.

Referenced by patchDistMethod::patchIDs().

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