Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
readFields Class Reference

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

Inheritance diagram for readFields:
Inheritance graph
[legend]
Collaboration diagram for readFields:
Collaboration graph
[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...
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry 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 wordtype () 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< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () 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 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 >
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< volScalarFieldvsf_
 Loaded fields. More...
 
PtrList< volVectorFieldvvf_
 
PtrList< volSphericalTensorFieldvSpheretf_
 
PtrList< volSymmTensorFieldvSymmtf_
 
PtrList< volTensorFieldvtf_
 
PtrList< surfaceScalarFieldssf_
 
PtrList< surfaceVectorFieldsvf_
 
PtrList< surfaceSphericalTensorFieldsSpheretf_
 
PtrList< surfaceSymmTensorFieldsSymmtf_
 
PtrList< surfaceTensorFieldstf_
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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

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()

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()

~readFields ( )
virtual

Destructor.

Definition at line 61 of file readFields.C.

Member Function Documentation

◆ loadField()

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

Definition at line 35 of file readFieldsTemplates.C.

References DebugInfo, Foam::endl(), and Log.

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

Definition at line 67 of file readFields.C.

References dictionary::lookup(), and regionFunctionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Read the fields.

Implements functionObject.

Definition at line 77 of file readFields.C.

References forAll.

◆ write()

bool write ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 108 of file readFields.C.

Member Data Documentation

◆ fieldSet_

wordList fieldSet_
protected

Fields to load.

Definition at line 105 of file readFields.H.

◆ vsf_

PtrList<volScalarField> vsf_
protected

Loaded fields.

Definition at line 108 of file readFields.H.

◆ vvf_

PtrList<volVectorField> vvf_
protected

Definition at line 109 of file readFields.H.

◆ vSpheretf_

PtrList<volSphericalTensorField> vSpheretf_
protected

Definition at line 110 of file readFields.H.

◆ vSymmtf_

PtrList<volSymmTensorField> vSymmtf_
protected

Definition at line 111 of file readFields.H.

◆ vtf_

PtrList<volTensorField> vtf_
protected

Definition at line 112 of file readFields.H.

◆ ssf_

PtrList<surfaceScalarField> ssf_
protected

Definition at line 114 of file readFields.H.

◆ svf_

PtrList<surfaceVectorField> svf_
protected

Definition at line 115 of file readFields.H.

◆ sSpheretf_

PtrList<surfaceSphericalTensorField> sSpheretf_
protected

Definition at line 116 of file readFields.H.

◆ sSymmtf_

PtrList<surfaceSymmTensorField> sSymmtf_
protected

Definition at line 117 of file readFields.H.

◆ stf_

PtrList<surfaceTensorField> stf_
protected

Definition at line 118 of file readFields.H.


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