Samples near-patch volume fields within an input distance range. More...

Inheritance diagram for nearWallFields:

Collaboration diagram for nearWallFields:

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

	nearWallFields (const word &name, const Time &runTime, const dictionary &dict)
	Construct for given objectRegistry and dictionary. More...

	nearWallFields (const nearWallFields &)=delete
	No copy construct. More...

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

virtual	~nearWallFields ()=default
	Destructor. More...

virtual bool	read (const dictionary &dict)
	Read the controls. More...

virtual bool	execute ()
	Calculate the near-wall fields. More...

virtual bool	write ()
	Write the near-wall fields. More...

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

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

virtual	~fvMeshFunctionObject ()=default
	Destructor. More...

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

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

virtual	~regionFunctionObject ()=default
	Destructor. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri, bool increaseOnly=true)
	Set the trigger index. Normally only if greater than current. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()=default
	Destructor. More...

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Protected Member Functions
void	calcAddressing ()
	Calculate addressing from cells back to patch faces. More...

template<class Type >
void	createFields (PtrList< GeometricField< Type, fvPatchField, volMesh >> &) const

template<class Type >
void	sampleBoundaryField (const interpolationCellPoint< Type > &interpolator, GeometricField< Type, fvPatchField, volMesh > &fld) const
	Override boundary fields with sampled values. More...

template<class Type >
void	sampleFields (PtrList< GeometricField< Type, fvPatchField, volMesh >> &) const

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

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

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name. More...

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

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

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

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

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

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

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Attributes
List< Tuple2< word, word > >	fieldSet_
	Fields to process (input-name output-name) More...

labelHashSet	patchSet_
	Patches to sample. More...

scalar	distance_
	Distance away from wall. More...

HashTable< word >	fieldMap_
	From original field to sampled result. More...

HashTable< word >	reverseFieldMap_
	From resulting back to original field. More...

labelListList	cellToWalls_
	From cell to seed patch faces. More...

List< List< point > >	cellToSamples_
	From cell to tracked end point. More...

autoPtr< mapDistribute >	getPatchDataMapPtr_
	Map from cell based data back to patch based data. More...

PtrList< volScalarField >	vsf_

PtrList< volVectorField >	vvf_

PtrList< volSphericalTensorField >	vSpheretf_

PtrList< volSymmTensorField >	vSymmtf_

PtrList< volTensorField >	vtf_

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Detailed Description

Samples near-patch volume fields within an input distance range.

Operands:

Operand	Type	Location
`input`	vol<Type>Field	$FOAM_CASE/<time>/<inpField>
`output` file	-	-
`output` field	vol<Type>Field	$FOAM_CASE/<time>/<outField>

where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.

Usage

Minimal example by using system/controlDict.functions:

nearWallFields1
{
    // Mandatory entries (unmodifiable)
    type            nearWallFields;
    libs            (fieldFunctionObjects);
    fields
    (
        (<field1> <outField1>)
        (<field2> <outField2>)
    );
    patches         (<patch1> <patch2> ... <patchN>);
    distance        0.01;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: nearWallFields	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`fields`	Names of input-output fields	wordHashTable	yes	-
`patches`	Names of patches to sample	wordList	yes	-
`distance`	Wall-normal distance from patch to sample	scalar	yes	-

The inherited entries are elaborated in:

functionObject.H

Usage by the postProcess utility is not available.

See also

Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
ExtendedCodeGuide::functionObjects::field::nearWallFields

Source files

Definition at line 163 of file nearWallFields.H.

Constructor & Destructor Documentation

◆ nearWallFields() [1/2]

nearWallFields	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 246 of file nearWallFields.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ nearWallFields() [2/2]

nearWallFields ( const nearWallFields & )

delete

No copy construct.

◆ ~nearWallFields()

virtual ~nearWallFields ( )

virtualdefault

Destructor.

Member Function Documentation

◆ calcAddressing()

void calcAddressing ( )

protected

Calculate addressing from cells back to patch faces.

Definition at line 50 of file nearWallFields.C.

References fvMesh::boundary(), polyMesh::bounds(), nearWallFields::cellToSamples_, nearWallFields::cellToWalls_, tetrahedron< Point, PointRef >::centre(), functionObject::debug, DebugInFunction, cloud::defaultName, nearWallFields::distance_, Foam::constant::electromagnetic::e, functionObject::end(), Foam::endl(), f(), polyMesh::FACE_DIAG_TRIS, mappedPatchBase::facePoint(), polyMesh::faces(), polyMesh::findTetFacePt(), forAll, nearWallFields::getPatchDataMapPtr_, PointIndexHit< PointType >::hit(), PointIndexHit< PointType >::hitPoint(), PointIndexHit< PointType >::index(), InfoInFunction, boundBox::mag(), fvMeshFunctionObject::mesh_, primitiveMesh::nCells(), Foam::foamVersion::patch, nearWallFields::patchSet_, Time::path(), List< T >::setSize(), globalIndex::size(), tetIndices::tet(), fvMesh::time(), Time::timeName(), globalIndex::toGlobal(), and Ostream::write().

Here is the call graph for this function:

◆ createFields()

void createFields ( PtrList< GeometricField< Type, fvPatchField, volMesh >> & sflds ) const

protected

Definition at line 35 of file nearWallFieldsTemplates.C.

References Foam::endl(), fld, forAllConstIters(), Log, IOobject::readOpt(), IOobject::rename(), WarningInFunction, and IOobject::writeOpt().

Here is the call graph for this function:

◆ sampleBoundaryField()

void sampleBoundaryField	(	const interpolationCellPoint< Type > &	interpolator,
		GeometricField< Type, fvPatchField, volMesh > &	fld
	)		const

protected

Override boundary fields with sampled values.

Definition at line 92 of file nearWallFieldsTemplates.C.

References fld, forAll, and interpolationCellPoint< Type >::interpolate().

Here is the call graph for this function:

◆ sampleFields()

void sampleFields ( PtrList< GeometricField< Type, fvPatchField, volMesh >> & sflds ) const

protected

Definition at line 140 of file nearWallFieldsTemplates.C.

References fld, and forAll.

◆ TypeName()

TypeName ( "nearWallFields" )

Runtime type information.

◆ operator=()

void operator= ( const nearWallFields & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the controls.

Reimplemented from regionFunctionObject.

Definition at line 261 of file nearWallFields.C.

References dict, Foam::endl(), forAll, Foam::Info, Foam::name(), regionFunctionObject::read(), and Foam::type().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the near-wall fields.

Implements functionObject.

Definition at line 309 of file nearWallFields.C.

References DebugInFunction, Foam::endl(), Log, Foam::name(), Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the near-wall fields.

Implements functionObject.

Definition at line 350 of file nearWallFields.C.

References DebugInFunction, Foam::endl(), forAll, and Log.

Here is the call graph for this function:

Member Data Documentation

◆ fieldSet_

List<Tuple2<word, word> > fieldSet_

protected

Fields to process (input-name output-name)

Definition at line 174 of file nearWallFields.H.

◆ patchSet_

labelHashSet patchSet_

protected

Patches to sample.

Definition at line 177 of file nearWallFields.H.

Referenced by nearWallFields::calcAddressing().

◆ distance_

scalar distance_

protected

Distance away from wall.

Definition at line 180 of file nearWallFields.H.

Referenced by nearWallFields::calcAddressing().

◆ fieldMap_

HashTable<word> fieldMap_

protected

From original field to sampled result.

Definition at line 183 of file nearWallFields.H.

◆ reverseFieldMap_

HashTable<word> reverseFieldMap_

protected

From resulting back to original field.

Definition at line 186 of file nearWallFields.H.

◆ cellToWalls_

labelListList cellToWalls_

protected

From cell to seed patch faces.

Definition at line 192 of file nearWallFields.H.

Referenced by nearWallFields::calcAddressing().

◆ cellToSamples_

List<List<point> > cellToSamples_

protected

From cell to tracked end point.

Definition at line 195 of file nearWallFields.H.

Referenced by nearWallFields::calcAddressing().

◆ getPatchDataMapPtr_

autoPtr<mapDistribute> getPatchDataMapPtr_

protected

Map from cell based data back to patch based data.

Definition at line 198 of file nearWallFields.H.

Referenced by nearWallFields::calcAddressing().

◆ vsf_

PtrList<volScalarField> vsf_

protected

Definition at line 203 of file nearWallFields.H.

◆ vvf_

PtrList<volVectorField> vvf_

protected

Definition at line 204 of file nearWallFields.H.

◆ vSpheretf_

PtrList<volSphericalTensorField> vSpheretf_

protected

Definition at line 205 of file nearWallFields.H.

◆ vSymmtf_

PtrList<volSymmTensorField> vSymmtf_

protected

Definition at line 206 of file nearWallFields.H.

◆ vtf_

PtrList<volTensorField> vtf_

protected

Definition at line 207 of file nearWallFields.H.

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

src/functionObjects/field/nearWallFields/nearWallFields.H
src/functionObjects/field/nearWallFields/nearWallFields.C
src/functionObjects/field/nearWallFields/nearWallFieldsTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nearWallFields() [1/2]

◆ nearWallFields() [2/2]

◆ ~nearWallFields()

Member Function Documentation

◆ calcAddressing()

◆ createFields()

◆ sampleBoundaryField()

◆ sampleFields()

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ fieldSet_

◆ patchSet_

◆ distance_

◆ fieldMap_

◆ reverseFieldMap_

◆ cellToWalls_

◆ cellToSamples_

◆ getPatchDataMapPtr_

◆ vsf_

◆ vvf_

◆ vSpheretf_

◆ vSymmtf_

◆ vtf_