Inheritance diagram for groundDist:

Collaboration diagram for groundDist:

Public Member Functions
	groundDist (const fvMesh &mesh, labelHashSet patchIDs, bool correctWalls=true)
	Construct from mesh and flag whether or not to correct wall. More...

virtual	~groundDist ()

const volScalarField &	y () const

label	nUnset () const

virtual void	correct (labelHashSet patchIDs)
	Correct for mesh geom/topo changes. More...

	groundDist (const fvMesh &mesh, labelHashSet patchIDs, bool correctWalls=true)
	Construct from mesh and flag whether or not to correct wall. More...

virtual	~groundDist ()

const volScalarField &	y () const

label	nUnset () const

virtual void	correct (labelHashSet patchIDs)
	Correct for mesh geom/topo changes. More...

Public Member Functions inherited from GeometricField
	TypeName ("GeometricField")
	Runtime type information. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensions and patch type. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Constructor given IOobject, mesh, dimensions and patch types. More...

	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensioned<Type> and patch type. More...

	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Constructor given IOobject, mesh, dimensioned<Type> and patch types. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type > > &)
	Constructor from components. More...

	GeometricField (const IOobject &, const Mesh &, const bool readOldTime=true)
	Construct and read given IOobject. More...

	GeometricField (const IOobject &, const Mesh &, const dictionary &)
	Construct from dictionary. More...

	GeometricField (const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy. More...

	GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy of tmp<GeometricField> deleting argument. More...

	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy resetting IO parameters. More...

	GeometricField (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy of tmp<GeometricField> resetting IO parameters. More...

	GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy resetting name. More...

	GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy resetting name. More...

	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch type. More...

	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

virtual	~GeometricField ()
	Destructor. More...

DimensionedInternalField &	dimensionedInternalField ()
	Return dimensioned internal field. More...

const DimensionedInternalField &	dimensionedInternalField () const
	Return dimensioned internal field. More...

InternalField &	internalField ()
	Return internal field. More...

const InternalField &	internalField () const
	Return internal field. More...

GeometricBoundaryField &	boundaryField ()
	Return reference to GeometricBoundaryField. More...

const GeometricBoundaryField &	boundaryField () const
	Return reference to GeometricBoundaryField for const field. More...

label	timeIndex () const
	Return the time index of the field. More...

label &	timeIndex ()
	Return the time index of the field. More...

void	storeOldTimes () const
	Store the old-time fields. More...

void	storeOldTime () const
	Store the old-time field. More...

label	nOldTimes () const
	Return the number of old time fields stored. More...

const GeometricField< Type, PatchField, GeoMesh > &	oldTime () const
	Return old time field. More...

GeometricField< Type, PatchField, GeoMesh > &	oldTime ()
	Return non-const old time field. More...

void	storePrevIter () const
	Store the field as the previous iteration value. More...

const GeometricField< Type, PatchField, GeoMesh > &	prevIter () const
	Return previous iteration field. More...

void	correctBoundaryConditions ()
	Correct boundary field. More...

bool	needReference () const
	Does the field need a reference level for solution. More...

tmp< GeometricField< cmptType, PatchField, GeoMesh > >	component (const direction) const
	Return a component of the field. More...

bool	writeData (Ostream &) const
	WriteData member function required by regIOobject. More...

tmp< GeometricField< Type, PatchField, GeoMesh > >	T () const
	Return transpose (only if it is a tensor field) More...

void	relax (const scalar alpha)
	Relax field (for steady-state solution). More...

void	relax ()
	Relax field (for steady-state solution). More...

word	select (bool final) const
	Select the final iteration parameters if `final' is true. More...

void	writeMinMax (Ostream &os) const
	Helper function to write the min and max to an Ostream. More...

void	negate ()

void	replace (const direction, const GeometricField< cmptType, PatchField, GeoMesh > &)

void	replace (const direction, const dimensioned< cmptType > &)

void	max (const dimensioned< Type > &)

void	min (const dimensioned< Type > &)

void	max (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

void	min (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

void	scale (const GeometricField< Type, PatchField, GeoMesh > &, const GeometricField< Type, PatchField, GeoMesh > &)

void	scale (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

void	operator= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

void	operator= (const dimensioned< Type > &)

void	operator== (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

void	operator== (const dimensioned< Type > &)

void	operator+= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

void	operator-= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

void	operator*= (const GeometricField< scalar, PatchField, GeoMesh > &)

void	operator*= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)

void	operator/= (const GeometricField< scalar, PatchField, GeoMesh > &)

void	operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)

void	operator+= (const dimensioned< Type > &)

void	operator-= (const dimensioned< Type > &)

void	operator*= (const dimensioned< scalar > &)

void	operator/= (const dimensioned< scalar > &)

tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const

void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)

tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const

void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)

Public Member Functions inherited from cellDistFuncs
	ClassName ("cellDistFuncs")

	cellDistFuncs (const polyMesh &mesh)
	Construct from mesh. More...

const polyMesh &	mesh () const
	Access mesh. More...

labelHashSet	getPatchIDs (const wordReList &patchNames) const
	Return the set of patch IDs corresponding to the given names. More...

template<class Type >
labelHashSet	getPatchIDs () const
	Get patchIDs of/derived off certain type (e.g. 'processorPolyPatch') More...

scalar	smallestDist (const point &p, const polyPatch &patch, const label nWallFaces, const labelList &wallFaces, label &meshFaceI) const
	Calculate smallest true distance (and face index) More...

label	getPointNeighbours (const primitivePatch &, const label patchFaceI, labelList &) const
	Get faces sharing point with face on patch. More...

label	maxPatchSize (const labelHashSet &patchIDs) const
	Size of largest patch (out of supplied subset of patches) More...

label	sumPatchSize (const labelHashSet &patchIDs) const
	Sum of patch sizes (out of supplied subset of patches). More...

void	correctBoundaryFaceCells (const labelHashSet &patchIDs, scalarField &wallDistCorrected, Map< label > &nearestFace) const
	Correct all cells connected to boundary (via face). Sets values in. More...

void	correctBoundaryPointCells (const labelHashSet &patchIDs, scalarField &wallDistCorrected, Map< label > &nearestFace) const
	Correct all cells connected to wall (via point). Sets values in. More...

template<class Type >
Foam::labelHashSet	getPatchIDs () const

Private Member Functions
	groundDist (const groundDist &)
	Disallow default bitwise copy construct. More...

void	operator= (const groundDist &)
	Disallow default bitwise assignment. More...

	groundDist (const groundDist &)
	Disallow default bitwise copy construct. More...

void	operator= (const groundDist &)
	Disallow default bitwise assignment. More...

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

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

Additional Inherited Members
Public Types inherited from GeometricField
typedef GeoMesh::Mesh	Mesh

typedef GeoMesh::BoundaryMesh	BoundaryMesh

typedef DimensionedField< Type, GeoMesh >	DimensionedInternalField

typedef Field< Type >	InternalField

typedef PatchField< Type >	PatchFieldType

typedef Field< Type >::cmptType	cmptType

Static Public Member Functions inherited from GeometricField
static const GeometricField< Type, PatchField, GeoMesh > &	null ()
	Return a null geometric field. More...

Detailed Description

Definition at line 58 of file groundDist.H.

Constructor & Destructor Documentation

◆ groundDist() [1/4]

groundDist ( const groundDist & )

private

Disallow default bitwise copy construct.

◆ groundDist() [2/4]

groundDist	(	const fvMesh &	mesh,
		labelHashSet	patchIDs,
		bool	correctWalls = `true`
	)

Construct from mesh and flag whether or not to correct wall.

Calculate for all cells. correctWalls : correct wall (face&point) cells for correct distance, searching neighbours.

Definition at line 37 of file groundDist.C.

References groundDist::correct(), Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ ~groundDist() [1/2]

~groundDist ( )

virtual

Definition at line 61 of file groundDist.C.

◆ groundDist() [3/4]

groundDist ( const groundDist & )

private

Disallow default bitwise copy construct.

◆ groundDist() [4/4]

groundDist	(	const fvMesh &	mesh,
		labelHashSet	patchIDs,
		bool	correctWalls = `true`
	)

Construct from mesh and flag whether or not to correct wall.

Calculate for all cells. correctWalls : correct wall (face&point) cells for correct distance, searching neighbours.

◆ ~groundDist() [2/2]

virtual ~groundDist ( )

virtual

Member Function Documentation

◆ operator=() [1/2]

void operator= ( const groundDist & )

private

Disallow default bitwise assignment.

◆ y() [1/2]

const volScalarField& y ( ) const

inline

Definition at line 101 of file groundDist.H.

Referenced by canopySource::calculatePatchDistance().

Here is the caller graph for this function:

◆ nUnset() [1/2]

label nUnset ( ) const

inline

Definition at line 106 of file groundDist.H.

References groundDist::nUnset_.

◆ correct() [1/2]

void correct ( labelHashSet patchIDs )

virtual

Correct for mesh geom/topo changes.

Definition at line 69 of file groundDist.C.

References boundaryField(), patchWave::distance(), Foam::endl(), forAll, Foam::Info, cellDistFuncs::mesh(), patchWave::nUnset(), patchWave::patchDistance(), and Foam::type().

Referenced by groundDist::groundDist().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/2]

void operator= ( const groundDist & )

private

Disallow default bitwise assignment.

◆ y() [2/2]

const volScalarField& y ( ) const

inline

Definition at line 101 of file groundDist.H.

◆ nUnset() [2/2]

label nUnset ( ) const

inline

Definition at line 106 of file groundDist.H.

References groundDist::nUnset_.

◆ correct() [2/2]

virtual void correct ( labelHashSet patchIDs )

virtual

Correct for mesh geom/topo changes.

Field Documentation

◆ correctWalls_

bool correctWalls_

private

Do accurate distance calculation for near-wall cells.

Definition at line 70 of file groundDist.H.

◆ nUnset_

label nUnset_

private

Number of unset cells and faces.

Definition at line 73 of file groundDist.H.

Referenced by groundDist::nUnset().

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

src/fvOptions/sources/derived/LAD_source/sources/canopySource/groundDist.H
src/fvOptions/sources/derived/LAD_source/sources/canopySource/groundDist.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ groundDist() [1/4]

◆ groundDist() [2/4]

◆ ~groundDist() [1/2]

◆ groundDist() [3/4]

◆ groundDist() [4/4]

◆ ~groundDist() [2/2]

Member Function Documentation

◆ operator=() [1/2]

◆ y() [1/2]

◆ nUnset() [1/2]

◆ correct() [1/2]

◆ operator=() [2/2]

◆ y() [2/2]

◆ nUnset() [2/2]

◆ correct() [2/2]

Field Documentation

◆ correctWalls_

◆ nUnset_