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

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

Collaboration diagram for readFields:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("readFields")
 Runtime type information. More...
 
 readFields (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~readFields ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the readFields object. More...
 
virtual void read (const dictionary &)
 Read the field min/max data. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 

Protected Member Functions

 readFields (const readFields &)
 Disallow default bitwise copy construct. More...
 
void operator= (const readFields &)
 Disallow default bitwise assignment. More...
 
template<class Type >
void loadField (const word &, PtrList< GeometricField< Type, fvPatchField, volMesh > > &, PtrList< GeometricField< Type, fvsPatchField, surfaceMesh > > &) const
 

Protected Attributes

word name_
 Name of this set of readFields object. More...
 
const objectRegistryobr_
 
bool active_
 on/off switch More...
 
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_
 

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;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
    fields
    (
        U
        p
    );
}


Function object usage

Property Description Required Default value
type type name: readFields yes
fields list of fields to read no
See also
Foam::functionObject Foam::OutputFilterFunctionObject
Source files

Definition at line 102 of file readFields.H.

Constructor & Destructor Documentation

readFields ( const readFields )
protected

Disallow default bitwise copy construct.

readFields ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 40 of file readFields.C.

References Foam::endl(), Foam::read(), and WarningIn.

Here is the call graph for this function:

~readFields ( )
virtual

Destructor.

Definition at line 77 of file readFields.C.

Member Function Documentation

void operator= ( const readFields )
protected

Disallow default bitwise assignment.

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 Foam::endl(), Foam::Info, mesh, fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

TypeName ( "readFields"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the readFields object.

Definition at line 176 of file readFields.H.

References readFields::end(), readFields::execute(), readFields::name_, readFields::read(), readFields::timeSet(), and readFields::write().

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the field min/max data.

Definition at line 83 of file readFields.C.

References dictionary::lookup().

Referenced by readFields::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 92 of file readFields.C.

References forAll.

Referenced by readFields::name().

Here is the caller graph for this function:

void end ( )
virtual

Execute at the final time-loop, currently does nothing.

Definition at line 124 of file readFields.C.

Referenced by readFields::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 133 of file readFields.C.

Referenced by readFields::name().

Here is the caller graph for this function:

void write ( )
virtual

Write.

Definition at line 139 of file readFields.C.

Referenced by readFields::name().

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 197 of file readFields.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 201 of file readFields.H.

Member Data Documentation

word name_
protected

Name of this set of readFields object.

Definition at line 109 of file readFields.H.

Referenced by readFields::name().

const objectRegistry& obr_
protected

Definition at line 111 of file readFields.H.

bool active_
protected

on/off switch

Definition at line 114 of file readFields.H.

wordList fieldSet_
protected

Fields to load.

Definition at line 117 of file readFields.H.

PtrList<volScalarField> vsf_
protected

Loaded fields.

Definition at line 120 of file readFields.H.

PtrList<volVectorField> vvf_
protected

Definition at line 121 of file readFields.H.

PtrList<volSphericalTensorField> vSpheretf_
protected

Definition at line 122 of file readFields.H.

PtrList<volSymmTensorField> vSymmtf_
protected

Definition at line 123 of file readFields.H.

PtrList<volTensorField> vtf_
protected

Definition at line 124 of file readFields.H.

PtrList<surfaceScalarField> ssf_
protected

Definition at line 126 of file readFields.H.

PtrList<surfaceVectorField> svf_
protected

Definition at line 127 of file readFields.H.

PtrList<surfaceSphericalTensorField> sSpheretf_
protected

Definition at line 128 of file readFields.H.

PtrList<surfaceSymmTensorField> sSymmtf_
protected

Definition at line 129 of file readFields.H.

PtrList<surfaceTensorField> stf_
protected

Definition at line 130 of file readFields.H.


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