Fast topological mesh-wave method for calculating the distance to nearest patch for all cells and boundary. More...

Inheritance diagram for meshWave:

Collaboration diagram for meshWave:

Public Member Functions
	TypeName ("meshWave")
	Runtime type information. More...

	meshWave (const dictionary &dict, const fvMesh &mesh, const labelHashSet &patchIDs)
	Construct from coefficients dictionary, mesh. More...

	meshWave (const fvMesh &mesh, const labelHashSet &patchIDs, const bool correctWalls=true)
	Construct from mesh, fixed-value patch set and flag specifying. 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 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...

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

Protected Attributes
const bool	correctWalls_
	Do accurate distance calculation for near-wall cells. More...

label	nUnset_
	Number of unset cells and faces. More...

Protected Attributes inherited from patchDistMethod
const fvMesh &	mesh_
	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< 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. More...

Protected Member Functions inherited from patchDistMethod
	patchDistMethod (const patchDistMethod &)=delete
	No copy construct. More...

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

Detailed Description

Fast topological mesh-wave method for calculating the distance to nearest patch for all cells and boundary.

For regular/un-distorted meshes this method is accurate but for skewed, non-orthogonal meshes it is approximate with the error increasing with the degree of mesh distortion. The distance from the near-wall cells to the boundary may optionally be corrected for mesh distortion by setting correctWalls = true.

Example of the wallDist specification in fvSchemes:

    wallDist
    {
        method meshWave;

        // Optional entry enabling the calculation
        // of the normal-to-wall field
        nRequired false;
    }

See also: Foam::patchDistMethod::Poisson Foam::wallDist

Source files

Definition at line 72 of file meshWavePatchDistMethod.H.

Constructor & Destructor Documentation

◆ meshWave() [1/2]

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

Construct from coefficients dictionary, mesh.

and fixed-value patch set

Definition at line 45 of file meshWavePatchDistMethod.C.

◆ meshWave() [2/2]

meshWave	(	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 58 of file meshWavePatchDistMethod.C.

Member Function Documentation

◆ TypeName()

TypeName ( "meshWave" )

Runtime type information.

◆ correct() [1/2]

bool correct ( volScalarField & y )

virtual

Correct the given distance-to-patch field.

Implements patchDistMethod.

Reimplemented in directionalMeshWave.

Definition at line 72 of file meshWavePatchDistMethod.C.

References meshWave::correctWalls_, Foam::dimLength, patchWave::distance(), forAll, patchDistMethod::mesh_, patchWave::nUnset(), meshWave::nUnset_, patchWave::patchDistance(), patchDistMethod::patchIDs_, PtrList< T >::transfer(), 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.

Reimplemented in directionalMeshWave.

Definition at line 106 of file meshWavePatchDistMethod.C.

References patchDataWave< TransferType, TrackingData >::cellData(), Foam::dimLength, patchDataWave< TransferType, TrackingData >::distance(), forAll, n, patchDataWave< TransferType, TrackingData >::nUnset(), patchDataWave< TransferType, TrackingData >::patchData(), patchDataWave< TransferType, TrackingData >::patchDistance(), PtrList< T >::transfer(), UPtrList< T >::transfer(), 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 83 of file meshWavePatchDistMethod.H.

Referenced by meshWave::correct().

◆ nUnset_

label nUnset_

mutableprotected

Number of unset cells and faces.

Definition at line 88 of file meshWavePatchDistMethod.H.