patchDistMethod Class Reference

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

Inheritance diagram for patchDistMethod:

Collaboration diagram for patchDistMethod:

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...
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	updateMesh (const mapPolyMesh &)
	Update cached topology and geometry when the mesh changes. 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...
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)
static autoPtr< patchDistMethod >	New (const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs, const word &defaultPatchDistMethod)
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

• patchDistMethod.H
• patchDistMethod.C

Definition at line 59 of file patchDistMethod.H.

Constructor & Destructor Documentation

patchDistMethod()

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

Construct from mesh and patch ID set.

Definition at line 43 of file patchDistMethod.C.

~patchDistMethod()

~patchDistMethod ( )

virtual

Destructor.

Definition at line 114 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() [1/2]

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

static

Definition at line 56 of file patchDistMethod.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh.

Here is the call graph for this function:

New() [2/2]

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

static

Definition at line 85 of file patchDistMethod.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh.

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 151 of file patchDistMethod.H.

References patchDistMethod::patchIDs_.

movePoints()

virtual bool movePoints ( )

inlinevirtual

Update cached geometry when the mesh moves.

Reimplemented in exact.

Definition at line 157 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 163 of file patchDistMethod.H.

correct() [1/2]

virtual bool correct ( volScalarField &  y )

pure virtual

Correct the given distance-to-patch field.

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

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, Poisson, directionalMeshWave, meshWave, and exact.

patchTypes() [2/2]

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

Definition at line 35 of file patchDistMethodTemplates.C.

References mesh.

Member Data Documentation

mesh_

const fvMesh& mesh_

protected

Reference to the mesh.

Definition at line 67 of file patchDistMethod.H.

Referenced by meshWave::correct(), and directionalMeshWave::correct().

patchIDs_

const labelHashSet patchIDs_

protected

Set of patch IDs.

Definition at line 70 of file patchDistMethod.H.

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

---

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

• src/finiteVolume/fvMesh/wallDist/patchDistMethods/patchDistMethod/patchDistMethod.H
• src/finiteVolume/fvMesh/wallDist/patchDistMethods/patchDistMethod/patchDistMethod.C
• src/finiteVolume/fvMesh/wallDist/patchDistMethods/patchDistMethod/patchDistMethodTemplates.C