This function object reads fields from the time directories and adds them to the mesh database for further post-processing. More...

Inheritance diagram for readFields:

[legend]

Collaboration diagram for readFields:

[legend]

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

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

virtual	~readFields ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the set of fields from dictionary. More...

virtual bool	execute ()
	Read the fields. More...

virtual bool	write ()
	Do nothing. 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...

virtual	~fvMeshFunctionObject ()
	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 ()
	Destructor. More...

Public Member Functions inherited from 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)
	Construct from components. More...

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

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. 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 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
template<class Type >
void	loadField (const word &, PtrList< GeometricField< Type, fvPatchField, volMesh >> &, PtrList< GeometricField< Type, fvsPatchField, surfaceMesh >> &) const

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

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

template<class ObjectType >
bool	store (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
wordList	fieldSet_
	Fields to load. More...

PtrList< volScalarField >	vsf_
	Loaded fields. More...

PtrList< volVectorField >	vvf_

PtrList< volSphericalTensorField >	vSpheretf_

PtrList< volSymmTensorField >	vSymmtf_

PtrList< volTensorField >	vtf_

PtrList< surfaceScalarField >	ssf_

PtrList< surfaceVectorField >	svf_

PtrList< surfaceSphericalTensorField >	sSpheretf_

PtrList< surfaceSymmTensorField >	sSymmtf_

PtrList< surfaceTensorField >	stf_

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

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. 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...

Static Public Attributes inherited from functionObject
static int	debug

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

Detailed Description

This function object reads fields from the time directories and adds them to the mesh database for further post-processing.

Example of function object specification:

readFields1
{
    type        readFields;
    libs ("libfieldFunctionObjects.so");
    ...
    fields
    (
        U
        p
    );
}

Usage

Property	Description	Required	Default value
`type`	type name: readFields	yes
`fields`	list of fields to read	no

See also: Foam::functionObjects::fvMeshFunctionObject

Source files

Definition at line 96 of file readFields.H.

Constructor & Destructor Documentation

readFields	(	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 46 of file readFields.C.

References Foam::read().

Here is the call graph for this function:

~readFields ( )

virtual

Destructor.

Definition at line 61 of file readFields.C.

Member Function Documentation

void loadField	(	const word &	fieldName,
		PtrList< GeometricField< Type, fvPatchField, volMesh >> &	vflds,
		PtrList< GeometricField< Type, fvsPatchField, surfaceMesh >> &	sflds
	)		const