Samples near-patch volume fields. More...

Inheritance diagram for nearWallFields:

Collaboration diagram for nearWallFields:

[legend]

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
	Disallow default bitwise copy construction. More...

virtual	~nearWallFields ()
	Destructor. More...

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

virtual wordList	fields () const
	Return the list of fields required. More...

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

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

void	operator= (const nearWallFields &)=delete
	Disallow default bitwise assignment. 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)
	Construct from the region objectRegistry. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. 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)
	Construct from the region objectRegistry. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

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

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

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

	objectRegistryFunctionObject (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

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

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

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

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

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

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

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

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

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

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

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

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

template<class Type >
void	createFields (PtrList< VolField< Type >> &) const

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

template<class Type >
void	sampleFields (PtrList< VolField< Type >> &) const

Protected Member Functions inherited from objectRegistryFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

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

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

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

Protected Attributes
List< Tuple2< word, word > >	fieldSet_
	Fields to process. 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< distributionMap >	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 objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

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

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Detailed Description

Samples near-patch volume fields.

Fields are stored

every time step the field is updated with new values
at output it writes the fields

This functionObject can either be used

to calculate a new field as a post-processing step or
since the fields are registered, used in another functionObject

Example of function object specification:

nearWallFields1
{
    type        nearWallFields;
    libs        ("libfieldFunctionObjects.so");

    writeControl writeTime;

    fields
    (
        (p pNear)
        (U UNear)
    );

    patch       movingWall;

    distance    0.13;
}

Usage

Property	Description	Required
`type`	type name: nearWallFields	yes
`fields`	list of fields with corresponding output field names	yes
`patch`	patch to sample	no
`patches`	list of patches to sample	no
`distance`	distance from patch to sample	yes