Allows specification of different writing frequency of objects registered to the database. More...

Inheritance diagram for writeObjects:

Collaboration diagram for writeObjects:

Public Types
enum	writeOption { AUTO_WRITE, NO_WRITE, ANY_WRITE }

Public Member Functions
	TypeName ("writeObjects")

	writeObjects (const word &name, const Time &runTime, const dictionary &dict)

virtual	~writeObjects ()=default

virtual bool	read (const dictionary &)

virtual bool	execute ()

virtual bool	write ()

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)

autoPtr< functionObject >	clone () const

virtual	~functionObject ()=default

virtual const word &	type () const =0

const word &	name () const noexcept

bool	useNamePrefix () const noexcept

bool	useNamePrefix (bool on) noexcept

virtual bool	execute (const label subIndex)

virtual bool	end ()

virtual bool	adjustTimeStep ()

virtual bool	filesModified () const

virtual void	updateMesh (const mapPolyMesh &mpm)

virtual void	movePoints (const polyMesh &mesh)

Static Public Attributes
static const Enum< writeOption >	writeOptionNames_

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess

static bool	defaultUseNamePrefix

static word	outputPrefix

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)

Public Attributes inherited from functionObject
bool	log

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Detailed Description

Allows specification of different writing frequency of objects registered to the database.

It has similar functionality as the main time database through the writeControl setting:

timeStep
writeTime
adjustableRunTime
runTime
clockTime
cpuTime

It also has the ability to write the selected objects that were defined with the respective write mode for the requested writeOption, namely:

	=	objects set to write at output time
	=	objects set to not write by default
	=	any option of the previous two

Usage

Example of function object specification:

writeObjects1
{
    type        writeObjects;
    libs        (utilityFunctionObjects);
    ...
    objects     (obj1 obj2);
    writeOption anyWrite;
}

Where the entries comprise: