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

#include <nearWallFields.H>

Inheritance diagram for nearWallFields:

Collaboration diagram for nearWallFields:

[legend]

Public Member Functions
	TypeName ("nearWallFields")
	Runtime type information.
	nearWallFields (const word &name, const Time &runTime, const dictionary &dict)
	Construct for given objectRegistry and dictionary.
	nearWallFields (const nearWallFields &)=delete
	No copy construct.
void	operator= (const nearWallFields &)=delete
	No copy assignment.
virtual	~nearWallFields ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual bool	execute ()
	Execute the function-object operations.
virtual bool	write ()
	Write the function-object results.
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information.
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~fvMeshFunctionObject ()=default
	Destructor.
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information.
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~regionFunctionObject ()=default
	Destructor.
template<class ObjectType>
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10).
template<class ObjectType>
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components.
virtual	~stateFunctionObject ()=default
	Destructor.
dictionary &	propertyDict ()
	Return access to the property dictionary.
bool	foundProperty (const word &entryName) const
	Return true if the property exists.
void	clearTrigger ()
	Remove the trigger index from the properties.
label	getTrigger () const
	Get the current trigger index.
bool	setTrigger (const label triggeri)
	Set new trigger index.
bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set.
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set.
template<class Type>
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property.
template<class Type>
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set.
template<class Type>
void	setProperty (const word &entryName, const Type &value)
	Add generic property.
template<class Type>
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object.
template<class Type>
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set.
template<class Type>
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object.
bool	getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void	setResult (const word &entryName, const Type &value)
	Add result.
template<class Type>
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object.
template<class Type>
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result.
template<class Type>
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object.
template<class Type>
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set.
word	resultType (const word &entryName) const
	Retrieve the result type.
word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result.
wordList	objectResultEntries () const
	Retrieve the result entries.
wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object.
void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream.
void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
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.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.

Protected Member Functions
void	calcAddressing ()
	Calculate addressing from cells back to patch faces.
template<class Type>
void	createFields (PtrList< GeometricField< Type, fvPatchField, volMesh > > &) const
	Create the local fields.
template<class Type>
void	sampleBoundaryField (const interpolationCellPoint< Type > &interpolator, GeometricField< Type, fvPatchField, volMesh > &fld) const
	Override boundary fields with sampled values.
template<class Type>
void	sampleFields (PtrList< GeometricField< Type, fvPatchField, volMesh > > &) const
	Sample the fields.
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct.
void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used.
template<class ObjectType>
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry.
template<class ObjectType>
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class ObjectType>
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
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.
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.
bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry.
bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present.
void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present.
	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct.
void	operator= (const regionFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary.
functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary.
	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct.
void	operator= (const stateFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.

Protected Attributes
List< Tuple2< word, word > >	fieldSet_
	Fields to process (input-name output-name).
labelList	patchIDs_
	Patches to sample.
scalar	distance_
	Distance away from wall.
HashTable< word >	fieldMap_
	From original field to sampled result.
HashTable< word >	reverseFieldMap_
	From resulting back to original field.
labelListList	cellToWalls_
	From cell to seed patch faces.
List< List< point > >	cellToSamples_
	From cell to tracked end point.
autoPtr< mapDistribute >	getPatchDataMapPtr_
	Map from cell based data back to patch based data.
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.
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry.
const objectRegistry &	obr_
	Reference to the region objectRegistry.
const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database.

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.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.

Detailed Description

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

Operands:

Operand	Type	Location
`input`	vol<Type>Field	<time>/inputFields
`output` file	-	-
`output` field	vol<Type>Field	<time>/outputField

where Type can be one of: Scalar, Vector, SphericalTensor, SymmTensor, or Tensor.

Usage

Minimal example by using system/controlDict.functions:

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

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`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

Source files

Definition at line 153 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 233 of file nearWallFields.C.

References dict, fieldSet_, fvMeshFunctionObject::fvMeshFunctionObject(), Foam::name(), read(), and runTime.

Referenced by nearWallFields(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nearWallFields() [2/2]

nearWallFields ( const nearWallFields & )

delete

No copy construct.

References nearWallFields().

Here is the call graph for this function:

◆ ~nearWallFields()

virtual ~nearWallFields ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

◆ calcAddressing()

void calcAddressing ( )

protected

Calculate addressing from cells back to patch faces.

Definition at line 43 of file nearWallFields.C.

References cellToSamples_, cellToWalls_, tetrahedron< Point, PointRef >::centre(), DebugInFunction, cloud::defaultName, distance_, e, functionObject::end(), Foam::endl(), f(), polyMesh::FACE_DIAG_TRIS, mappedPatchBase::facePoint(), forAll, getPatchDataMapPtr_, PointIndexHit< PointType >::hit(), PointIndexHit< PointType >::index(), InfoInFunction, fvMeshFunctionObject::mesh_, OFstream::name(), patchIDs_, PointIndexHit< PointType >::point(), List< T >::setSize(), td(), tetIndices::tet(), globalIndex::toGlobal(), globalIndex::totalSize(), and OBJstream::writeLine().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFields()

template<class Type>

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

protected

Create the local fields.

Definition at line 27 of file nearWallFieldsTemplates.C.

References fvPatchFieldBase::calculatedType(), Foam::endl(), fieldMap_, fld(), io, Log, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, regionFunctionObject::obr_, patchIDs_, and WarningInFunction.

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sampleBoundaryField()

template<class Type>

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

protected

Override boundary fields with sampled values.

Definition at line 81 of file nearWallFieldsTemplates.C.

References cellToSamples_, cellToWalls_, fld(), forAll, getPatchDataMapPtr_, interpolationCellPoint< Type >::interpolate(), patchIDs_, and UList< T >::size().

Referenced by sampleFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sampleFields()

template<class Type>

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

protected

Sample the fields.

Definition at line 129 of file nearWallFieldsTemplates.C.

References fld(), forAll, regionFunctionObject::obr_, reverseFieldMap_, and sampleBoundaryField().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "nearWallFields" )

Runtime type information.

References dict, Foam::name(), and runTime.

Here is the call graph for this function:

◆ operator=()

void operator= ( const nearWallFields & )

delete

No copy assignment.

References nearWallFields().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from regionFunctionObject.

Definition at line 249 of file nearWallFields.C.

References calcAddressing(), dict, distance_, Foam::endl(), fieldMap_, fieldSet_, forAll, Foam::Info, fvMeshFunctionObject::mesh_, name, patchIDs_, pbm, functionObject::read(), reverseFieldMap_, Foam::type(), vsf_, vSpheretf_, vSymmtf_, vtf_, and vvf_.

Referenced by nearWallFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Execute the function-object operations.

Implements functionObject.

Definition at line 296 of file nearWallFields.C.

References createFields(), DebugInFunction, Foam::endl(), fieldMap_, Log, name, Foam::nl, sampleFields(), timeFunctionObject::time_, Foam::type(), vsf_, vSpheretf_, vSymmtf_, vtf_, and vvf_.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the function-object results.

Implements functionObject.

Definition at line 337 of file nearWallFields.C.

References DebugInFunction, Foam::endl(), forAll, Log, timeFunctionObject::time_, vsf_, vSpheretf_, vSymmtf_, vtf_, and vvf_.

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 166 of file nearWallFields.H.

Referenced by nearWallFields(), and read().

◆ patchIDs_

labelList patchIDs_

protected

Patches to sample.

Definition at line 171 of file nearWallFields.H.

Referenced by calcAddressing(), createFields(), read(), and sampleBoundaryField().

◆ distance_

scalar distance_

protected

Distance away from wall.

Definition at line 176 of file nearWallFields.H.

Referenced by calcAddressing(), and read().

◆ fieldMap_

HashTable<word> fieldMap_

protected

From original field to sampled result.

Definition at line 181 of file nearWallFields.H.

Referenced by createFields(), execute(), and read().

◆ reverseFieldMap_

HashTable<word> reverseFieldMap_

protected

From resulting back to original field.

Definition at line 186 of file nearWallFields.H.

Referenced by read(), and sampleFields().

◆ cellToWalls_

labelListList cellToWalls_

protected

From cell to seed patch faces.

Definition at line 194 of file nearWallFields.H.

Referenced by calcAddressing(), and sampleBoundaryField().

◆ cellToSamples_

List<List<point> > cellToSamples_

protected

From cell to tracked end point.

Definition at line 199 of file nearWallFields.H.

Referenced by calcAddressing(), and sampleBoundaryField().

◆ getPatchDataMapPtr_

autoPtr<mapDistribute> getPatchDataMapPtr_

protected

Map from cell based data back to patch based data.

Definition at line 204 of file nearWallFields.H.

Referenced by calcAddressing(), and sampleBoundaryField().

◆ vsf_

PtrList<volScalarField> vsf_

protected

Definition at line 209 of file nearWallFields.H.

Referenced by execute(), read(), and write().

◆ vvf_

PtrList<volVectorField> vvf_

protected

Definition at line 210 of file nearWallFields.H.

Referenced by execute(), read(), and write().

◆ vSpheretf_

PtrList<volSphericalTensorField> vSpheretf_

protected

Definition at line 211 of file nearWallFields.H.

Referenced by execute(), read(), and write().

◆ vSymmtf_

PtrList<volSymmTensorField> vSymmtf_

protected

Definition at line 212 of file nearWallFields.H.

Referenced by execute(), read(), and write().

◆ vtf_

PtrList<volTensorField> vtf_

protected

Definition at line 213 of file nearWallFields.H.

Referenced by execute(), read(), and write().

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_

◆ patchIDs_

◆ distance_

◆ fieldMap_

◆ reverseFieldMap_

◆ cellToWalls_

◆ cellToSamples_

◆ getPatchDataMapPtr_

◆ vsf_

◆ vvf_

◆ vSpheretf_

◆ vSymmtf_

◆ vtf_