Writes changing mesh data (e.g., points, faces, zones) at times other than the write times defined in the controlDict. More...

Inheritance diagram for writeMesh:

[legend]

Collaboration diagram for writeMesh:

[legend]

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

virtual	~writeMesh ()
	Destructor. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	execute ()
	Do nothing. More...

virtual bool	write ()
	Write the registered objects. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Inherit constructors. More...

	regionFunctionObject (const word &name, const objectRegistry &obr)
	Inherit constructors. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Inherit constructors. More...

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr)
	Construct from the region objectRegistry. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

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

Public Member Functions inherited from objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

	objectRegistryFunctionObject (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read optional controls. More...

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

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from objectRegistryFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

Writes changing mesh data (e.g., points, faces, zones) at times other than the write times defined in the controlDict.

Example of function object specification:

writeMesh1
{
    type            writeMesh;
    libs            ("libutilityFunctionObjects.so");
    writeControl    adjustableRunTime;
    writeInterval   0.002;
}

Usage

Property	Description	Required	Default value
`type`	type name: writeMesh	yes
`region`	the name of the region	no	default region

See also: Foam::functionObject Foam::functionObjects::timeControl

Source files

Definition at line 88 of file writeMesh.H.

Constructor & Destructor Documentation

◆ ~writeMesh()

~writeMesh ( )

virtual

Destructor.

Definition at line 44 of file writeMesh.C.

Member Function Documentation

◆ TypeName()

TypeName ( "writeMesh" )

Runtime type information.

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 111 of file writeMesh.H.

References List< word >::null().

Here is the call graph for this function:

◆ executeAtStart()

bool executeAtStart ( ) const

virtual

Return true if the functionObject should be executed at the start.

Reimplemented from functionObject.

Definition at line 50 of file writeMesh.C.

◆ execute()

bool execute ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 56 of file writeMesh.C.

◆ write()

bool write ( )

virtual

Write the registered objects.

Implements functionObject.

Definition at line 62 of file writeMesh.C.

◆ regionFunctionObject() [1/3]

regionFunctionObject

Inherit constructors.

Definition at line 69 of file regionFunctionObject.C.

◆ regionFunctionObject() [2/3]

regionFunctionObject

Inherit constructors.

Definition at line 77 of file regionFunctionObject.C.

◆ regionFunctionObject() [3/3]

regionFunctionObject

delete

Inherit constructors.

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

src/functionObjects/utilities/writeMesh/writeMesh.H
src/functionObjects/utilities/writeMesh/writeMesh.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~writeMesh()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ executeAtStart()

◆ execute()

◆ write()

◆ regionFunctionObject() [1/3]

◆ regionFunctionObject() [2/3]

◆ regionFunctionObject() [3/3]