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:

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 word &	name () 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 &) const

Protected Attributes
word	name_
	Name of this set of readFields object. More...
const objectRegistry &	obr_
bool	active_
	on/off switch More...
wordList	fieldSet_
	Fields to load. More...
Switch	log_
	Switch to send output to Info as well as to file. 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;
    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
log	Log to standard output	no	yes

See also

Foam::functionObject Foam::OutputFilterFunctionObject

Source files

• readFields.H
• readFields.C
• IOreadFields.H

Definition at line 104 of file readFields.H.

Constructor & Destructor Documentation

readFields() [1/2]

readFields ( const readFields &  )

protected

Disallow default bitwise copy construct.

readFields() [2/2]

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 dict, Foam::endl(), Foam::read(), and WarningInFunction.

Here is the call graph for this function:

~readFields()

~readFields ( )

virtual

Destructor.

Definition at line 70 of file readFields.C.

Member Function Documentation

operator=()

void operator= ( const readFields &  )

protected

Disallow default bitwise assignment.

loadField()

void loadField ( const word &  fieldName ) const

protected

Definition at line 34 of file readFieldsTemplates.C.

References Foam::endl(), objectRegistry::foundObject(), IOobject::headerClassName(), IOobject::headerOk(), Foam::Info, readFields::log_, mesh, IOobject::MUST_READ, IOobject::NO_WRITE, and readFields::obr_.

Here is the call graph for this function:

TypeName()

TypeName

(

"readFields"

)

Runtime type information.

name()

virtual const word& name ( ) const

inlinevirtual

Return name of the readFields object.

Definition at line 163 of file readFields.H.

References readFields::name_.

read()

void read ( const dictionary &  dict )

virtual

Read the field min/max data.

Definition at line 76 of file readFields.C.

References dict, and dictionary::lookup().

Here is the call graph for this function:

execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 86 of file readFields.C.

References forAll.

end()

void end ( )

virtual

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

Definition at line 105 of file readFields.C.

timeSet()

void timeSet ( )

virtual

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

Definition at line 111 of file readFields.C.

write()

void write ( )

virtual

Write.

Definition at line 117 of file readFields.C.

updateMesh()

virtual void updateMesh ( const mapPolyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 184 of file readFields.H.

movePoints()

virtual void movePoints ( const polyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 188 of file readFields.H.

Field Documentation

name_

word name_

protected

Name of this set of readFields object.

Definition at line 111 of file readFields.H.

Referenced by readFields::name().

obr_

const objectRegistry& obr_

protected

Definition at line 113 of file readFields.H.

Referenced by readFields::loadField().

active_

bool active_

protected

on/off switch

Definition at line 116 of file readFields.H.

fieldSet_

wordList fieldSet_

protected

Fields to load.

Definition at line 119 of file readFields.H.

log_

Switch log_

protected

Switch to send output to Info as well as to file.

Definition at line 122 of file readFields.H.

Referenced by readFields::loadField().

---

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

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