processorField Class Reference

This function object writes a scalar field whose value is the local processor ID. The output field name is 'processorID'. More...

Collaboration diagram for processorField:

Public Member Functions
	TypeName ("processorField")
	Runtime type information. More...
	processorField (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary. More...
virtual	~processorField ()
	Destructor. More...
virtual const word &	name () const
	Return name of the processorField object. More...
virtual void	read (const dictionary &)
	Read the input 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
	processorField (const processorField &)
	Disallow default bitwise copy construct. More...
void	operator= (const processorField &)
	Disallow default bitwise assignment. More...

Protected Attributes
word	name_
	Name of this set of nearWallFields object. More...
const objectRegistry &	obr_
	Reference to the database. More...
bool	active_
	on/off switch More...
word	resultName_
	Result name. More...
Switch	log_
	Switch to send output to Info as well as to file. More...

Detailed Description

This function object writes a scalar field whose value is the local processor ID. The output field name is 'processorID'.

Example of function object specification:

processorField1
{
    type        processorField;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
}

Function object usage

Property	Description	Required	Default value
type	type name: processorField	yes
log	Log to standard output	no	yes

See also

Foam::functionObject Foam::OutputFilterFunctionObject

Source files

• processorField.H
• processorField.C
• IOprocessorField.H

Definition at line 98 of file processorField.H.

Constructor & Destructor Documentation

processorField() [1/2]

processorField ( const processorField &  )

protected

Disallow default bitwise copy construct.

processorField() [2/2]

processorField	(	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 41 of file processorField.C.

References dict, Foam::dimless, Foam::endl(), mesh, Foam::read(), and WarningInFunction.

Here is the call graph for this function:

~processorField()

~processorField ( )

virtual

Destructor.

Definition at line 92 of file processorField.C.

Member Function Documentation

operator=()

void operator= ( const processorField &  )

protected

Disallow default bitwise assignment.

TypeName()

TypeName

(

"processorField"

)

Runtime type information.

name()

virtual const word& name ( ) const

inlinevirtual

Return name of the processorField object.

Definition at line 155 of file processorField.H.

References processorField::name_.

read()

void read ( const dictionary &  dict )

virtual

Read the input data.

Definition at line 98 of file processorField.C.

References dict.

execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 107 of file processorField.C.

References Foam::dimless, and UPstream::myProcNo().

Here is the call graph for this function:

end()

void end ( )

virtual

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

Definition at line 120 of file processorField.C.

timeSet()

void timeSet ( )

virtual

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

Definition at line 126 of file processorField.C.

write()

void write ( )

virtual

Write.

Definition at line 132 of file processorField.C.

References Foam::endl(), Foam::Info, Foam::nl, and Foam::type().

Here is the call graph for this function:

updateMesh()

virtual void updateMesh ( const mapPolyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 176 of file processorField.H.

movePoints()

virtual void movePoints ( const polyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 180 of file processorField.H.

Field Documentation

name_

word name_

protected

Name of this set of nearWallFields object.

Definition at line 105 of file processorField.H.

Referenced by processorField::name().

obr_

const objectRegistry& obr_

protected

Reference to the database.

Definition at line 108 of file processorField.H.

active_

bool active_

protected

on/off switch

Definition at line 111 of file processorField.H.

resultName_

word resultName_

protected

Result name.

Definition at line 114 of file processorField.H.

log_

Switch log_

protected

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

Definition at line 117 of file processorField.H.

---

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

• src/postProcessing/functionObjects/field/processorField/processorField.H
• src/postProcessing/functionObjects/field/processorField/processorField.C