FreeFOAM The Cross-Platform CFD Toolkit
readFields Class Reference

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

#include <fieldFunctionObjects/readFields.H>


Detailed Description

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

Source files

Definition at line 59 of file readFields.H.

+ Collaboration diagram for readFields:

List of all members.

Public Member Functions

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

Protected Member Functions

 readFields (const readFields &)
 Disallow default bitwise copy construct.
void operator= (const readFields &)
 Disallow default bitwise assignment.
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.
const objectRegistryobr_
bool active_
 on/off switch
wordList fieldSet_
 Fields to load.
PtrList< volScalarFieldvsf_
 Loaded fields.
PtrList< volVectorFieldvvf_
PtrList< volSphericalTensorFieldvSpheretf_
PtrList< volSymmTensorFieldvSymmtf_
PtrList< volTensorFieldvtf_
PtrList< surfaceScalarFieldssf_
PtrList< surfaceVectorFieldsvf_
PtrList
< surfaceSphericalTensorField
sSpheretf_
PtrList< surfaceSymmTensorFieldsSymmtf_
PtrList< surfaceTensorFieldstf_

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(), and WarningIn.

~readFields ( )
virtual

Destructor.

Definition at line 75 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().

TypeName ( "readFields"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the readFields object.

Definition at line 133 of file readFields.H.

References readFields::name_.

void read ( const dictionary dict)
virtual

Read the field min/max data.

Definition at line 81 of file readFields.C.

References dictionary::lookup().

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 90 of file readFields.C.

References forAll.

void end ( )
virtual

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

Definition at line 119 of file readFields.C.

void write ( )
virtual

Write.

Definition at line 125 of file readFields.C.

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 151 of file readFields.H.

virtual void movePoints ( const pointField )
inlinevirtual

Update for changes of mesh.

Definition at line 155 of file readFields.H.


Member Data Documentation

word name_
protected

Name of this set of readFields object.

Definition at line 66 of file readFields.H.

Referenced by readFields::name().

const objectRegistry& obr_
protected

Definition at line 68 of file readFields.H.

bool active_
protected

on/off switch

Definition at line 71 of file readFields.H.

wordList fieldSet_
protected

Fields to load.

Definition at line 74 of file readFields.H.

PtrList<volScalarField> vsf_
protected

Loaded fields.

Definition at line 77 of file readFields.H.

PtrList<volVectorField> vvf_
protected

Definition at line 78 of file readFields.H.

PtrList<volSphericalTensorField> vSpheretf_
protected

Definition at line 79 of file readFields.H.

PtrList<volSymmTensorField> vSymmtf_
protected

Definition at line 80 of file readFields.H.

PtrList<volTensorField> vtf_
protected

Definition at line 81 of file readFields.H.

PtrList<surfaceScalarField> ssf_
protected

Definition at line 83 of file readFields.H.

PtrList<surfaceVectorField> svf_
protected

Definition at line 84 of file readFields.H.

PtrList<surfaceSphericalTensorField> sSpheretf_
protected

Definition at line 85 of file readFields.H.

PtrList<surfaceSymmTensorField> sSymmtf_
protected

Definition at line 86 of file readFields.H.

PtrList<surfaceTensorField> stf_
protected

Definition at line 87 of file readFields.H.


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