Reads fields from the time directories and adds them to the mesh database for further post-processing. More...

Inheritance diagram for readFields:

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...

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

virtual	~readFields ()
	Destructor. More...

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

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

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

virtual bool	write ()
	Do nothing. More...

void	operator= (const readFields &)=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
template<class Type >
void	loadField (const word &, PtrList< VolField< Type >> &, PtrList< SurfaceField< 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
wordList	fields_
	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 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

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 93 of file readFields.H.

Constructor & Destructor Documentation

◆ readFields() [1/2]

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

References dict, and readFields::read().

Here is the call graph for this function:

◆ readFields() [2/2]

readFields ( const readFields & )

delete

Disallow default bitwise copy construction.

◆ ~readFields()

~readFields ( )

virtual

Destructor.

Definition at line 61 of file readFields.C.

Member Function Documentation

◆ loadField()

void loadField	(	const word &	fieldName,
		PtrList< VolField< Type >> &	vflds,
		PtrList< SurfaceField< Type >> &	sflds
	)		const

protected

Definition at line 34 of file readFieldsTemplates.C.

References DebugInfo, Foam::endl(), objectRegistry::foundObject(), IOobject::headerClassName(), IOobject::headerOk(), Log, fvMeshFunctionObject::mesh_, IOobject::MUST_READ, dimensioned< Type >::name(), IOobject::NO_WRITE, objectRegistryFunctionObject::obr_, and functionObject::time_.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "readFields" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the set of fields from dictionary.

Reimplemented from objectRegistryFunctionObject.

Definition at line 67 of file readFields.C.

References dict, and objectRegistryFunctionObject::read().

Referenced by readFields::readFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 77 of file readFields.C.

◆ execute()

bool execute ( )

virtual

Read the fields.

Implements functionObject.

Definition at line 83 of file readFields.C.

References forAll.

◆ write()

bool write ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 114 of file readFields.C.

◆ operator=()

void operator= ( const readFields & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ fields_

wordList fields_

protected

Fields to load.

Definition at line 102 of file readFields.H.

◆ vsf_

PtrList<volScalarField> vsf_

protected

Loaded fields.

Definition at line 105 of file readFields.H.

◆ vvf_

PtrList<volVectorField> vvf_

protected

Definition at line 106 of file readFields.H.

◆ vSpheretf_

PtrList<volSphericalTensorField> vSpheretf_

protected

Definition at line 107 of file readFields.H.

◆ vSymmtf_

PtrList<volSymmTensorField> vSymmtf_

protected

Definition at line 108 of file readFields.H.

◆ vtf_

PtrList<volTensorField> vtf_

protected

Definition at line 109 of file readFields.H.

◆ ssf_

PtrList<surfaceScalarField> ssf_

protected

Definition at line 111 of file readFields.H.

◆ svf_

PtrList<surfaceVectorField> svf_

protected

Definition at line 112 of file readFields.H.

◆ sSpheretf_

PtrList<surfaceSphericalTensorField> sSpheretf_

protected

Definition at line 113 of file readFields.H.

◆ sSymmtf_

PtrList<surfaceSymmTensorField> sSymmtf_

protected

Definition at line 114 of file readFields.H.

◆ stf_

PtrList<surfaceTensorField> stf_

protected

Definition at line 115 of file readFields.H.

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

src/functionObjects/field/readFields/readFields.H
src/functionObjects/field/readFields/readFields.C
src/functionObjects/field/readFields/readFieldsTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ readFields() [1/2]

◆ readFields() [2/2]

◆ ~readFields()

Member Function Documentation

◆ loadField()

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()

Member Data Documentation

◆ fields_

◆ vsf_

◆ vvf_

◆ vSpheretf_

◆ vSymmtf_

◆ vtf_

◆ ssf_

◆ svf_

◆ sSpheretf_

◆ sSymmtf_

◆ stf_