Function object to generate images during run-time. More...

Inheritance diagram for runTimePostProcessing:

Collaboration diagram for runTimePostProcessing:

[legend]

Data Structures
struct	outputType

Public Member Functions
	TypeName ("runTimePostProcessing")
	Runtime type information. More...

	runTimePostProcessing (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct from dictionary. More...

virtual	~runTimePostProcessing ()
	Desructor. More...

virtual const objectRegistry &	obr () const

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

Public Member Functions inherited from functionObjectState
	functionObjectState (const objectRegistry &obr, const word &name)
	Construct from components. More...

virtual	~functionObjectState ()
	Destructor. More...

const word &	name () const
	Return the name. More...

bool	active () const
	Return the active flag. More...

const IOdictionary &	stateDict () const
	Return access to the state dictionary. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

template<class Type >
bool	setActive ()
	Set the active status by querying objectRegistry type. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property. More...

template<class Type >
void	getProperty (const word &entryName, Type &value) const
	Retrieve generic property. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from named object. More...

template<class Type >
void	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Retrieve generic property from named object. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve result from named object. More...

template<class Type >
void	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Retrieve result from named object. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

List< word >	objectResultEntries () const
	Retrieve the result entries. More...

List< word >	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

Protected Attributes
const objectRegistry &	obr_
	Reference to the database. More...

bool	active_
	on/off switch More...

Protected Attributes inherited from functionObjectState
const word	name_
	Name of model. More...

bool	active_
	Flag to indicate whether the object is active. More...

IOdictionary &	stateDict_
	Reference to the state dictionary. More...

Private Member Functions
template<class Type >
void	readObjects (const dictionary &dict, PtrList< Type > &objects) const
	Helper function to read scene objects. More...

Private Attributes
outputType	output_
	Output instance. More...

scene	scene_
	Scene manager. More...

PtrList< pointData >	points_
	List of points. More...

PtrList< pathline >	lines_
	List of lines. More...

PtrList< surface >	surfaces_
	List of surfaces. More...

PtrList< text >	text_
	List of text. More...

Additional Inherited Members
Protected Member Functions inherited from functionObjectState
	functionObjectState (const functionObjectState &)
	Disallow default bitwise copy construct. More...

void	operator= (const functionObjectState &)
	Disallow default bitwise assignment. More...

Detailed Description

Function object to generate images during run-time.

The functionality makes use of the VTK libraries (see http://www.vtk.org) which provide a broad set of functionality for scene composition and manipulation.

Images are generated using a combination of function object output, and additional data e.gg triangulated surfaces and text. Current capabilities include support for:

Camera
Objects
Points
Lines
Surfaces
Scalar bars
Annotations
Selection of colour maps Scene configuration is performed using standard OpenFOAM dictionaries, using the main headings of: output=, camera, colours, points, lines, surfaces and text.

Source files

Definition at line 83 of file runTimePostProcessing.H.

Constructor & Destructor Documentation

◆ runTimePostProcessing()

runTimePostProcessing	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = `false`
	)

Construct from dictionary.

Definition at line 55 of file runTimePostProcessing.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~runTimePostProcessing()

~runTimePostProcessing ( )

virtual

Desructor.

Definition at line 77 of file runTimePostProcessing.C.

Member Function Documentation

◆ readObjects()

void readObjects	(	const dictionary &	dict,
		PtrList< Type > &	objects
	)		const

private

Helper function to read scene objects.

Definition at line 30 of file runTimePostProcessingTemplates.C.

References PtrList::append(), PtrList::clear(), dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter(), dictionary::lookup(), and Foam::compressible::New().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "runTimePostProcessing" )

Runtime type information.

◆ obr()

virtual const objectRegistry& obr ( ) const

inlinevirtual

Definition at line 163 of file runTimePostProcessing.H.

References runTimePostProcessing::obr_.

Referenced by functionObjectCloud::addGeometryToScene().

Here is the caller graph for this function:

◆ read()

void read ( const dictionary & dict )

virtual

Read the field min/max data.

Definition at line 83 of file runTimePostProcessing.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter(), Foam::Info, dictionary::lookup(), ITstream::name_, dictionary::subDict(), dictionary::subOrEmptyDict(), and Foam::type().

Here is the call graph for this function:

◆ execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 115 of file runTimePostProcessing.C.

◆ end()

void end ( )

virtual

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

Definition at line 121 of file runTimePostProcessing.C.

◆ timeSet()

void timeSet ( )

virtual

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

Definition at line 127 of file runTimePostProcessing.C.

◆ write()

void write ( )

virtual

Write.

Definition at line 133 of file runTimePostProcessing.C.

References Foam::endl(), forAll, Foam::Info, UPstream::master(), Foam::compressible::New(), Foam::nl, sigFpe::set(), Foam::type(), and sigFpe::unset().

Here is the call graph for this function:

◆ updateMesh()

virtual void updateMesh ( const mapPolyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 184 of file runTimePostProcessing.H.

◆ movePoints()

virtual void movePoints ( const polyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 188 of file runTimePostProcessing.H.

Field Documentation

◆ output_

outputType output_

private

Output instance.

Definition at line 100 of file runTimePostProcessing.H.

◆ scene_

scene scene_

private

Scene manager.

Definition at line 103 of file runTimePostProcessing.H.

◆ points_

PtrList<pointData> points_

private

List of points.

Definition at line 106 of file runTimePostProcessing.H.

◆ lines_

PtrList<pathline> lines_

private

List of lines.

Definition at line 109 of file runTimePostProcessing.H.

◆ surfaces_

PtrList<surface> surfaces_

private

List of surfaces.

Definition at line 112 of file runTimePostProcessing.H.

◆ text_

PtrList<text> text_

private

List of text.

Definition at line 115 of file runTimePostProcessing.H.

◆ obr_

const objectRegistry& obr_

protected

Reference to the database.

Definition at line 134 of file runTimePostProcessing.H.

Referenced by runTimePostProcessing::obr().

◆ active_

bool active_

protected

on/off switch

Definition at line 137 of file runTimePostProcessing.H.

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

src/postProcessing/functionObjects/graphics/runTimePostProcessing/runTimePostProcessing.H
src/postProcessing/functionObjects/graphics/runTimePostProcessing/runTimePostProcessing.C
src/postProcessing/functionObjects/graphics/runTimePostProcessing/runTimePostProcessingTemplates.C

Data Structures

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ runTimePostProcessing()

◆ ~runTimePostProcessing()

Member Function Documentation

◆ readObjects()

◆ TypeName()

◆ obr()

◆ read()

◆ execute()

◆ end()

◆ timeSet()

◆ write()

◆ updateMesh()

◆ movePoints()

Field Documentation

◆ output_

◆ scene_

◆ points_

◆ lines_

◆ surfaces_

◆ text_

◆ obr_

◆ active_