Writes the time step. More...

Inheritance diagram for timeStep:

Collaboration diagram for timeStep:

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

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

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

virtual	~timeStep ()
	Destructor. More...

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

virtual bool	execute ()
	Execute, currently does nothing. More...

virtual bool	write ()
	Write the time step value. More...

void	operator= (const timeStep &)=delete
	Disallow default bitwise assignment. 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, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. 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 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)
	Construct from components. 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	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

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

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

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

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

Public Member Functions inherited from logFiles
	logFiles (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

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

virtual	~logFiles ()
	Destructor. More...

const wordList &	names () const
	Return const access to the names. More...

PtrList< OFstream > &	files ()
	Return access to the files. More...

OFstream &	file ()
	Return access to the file (if only 1) More...

OFstream &	file (const label i)
	Return file 'i'. More...

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

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

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

	~writeFile ()
	Destructor. More...

void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

void	writeTime (Ostream &os) const
	Write the current time to stream. More...

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair. More...

label	charWidth () const
	Return width of character stream output. More...

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

Protected Member Functions
virtual void	writeFileHeader (const label i)
	Output file header information. More...

Protected Member Functions inherited from regionFunctionObject
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...

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 >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	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 Member Functions inherited from logFiles
virtual void	createFiles ()
	Create the output file. More...

virtual void	resetNames (const wordList &names)
	Reset the list of names from a wordList. More...

virtual void	resetName (const word &name)
	Reset the list of names to a single name entry. 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 write log to Info. More...

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

Static Public Attributes inherited from writeFile
static const word	outputPrefix
	Directory prefix. More...

static label	addChars = 8
	Additional characters for writing. More...

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from logFiles
wordList	names_
	File names. More...

PtrList< OFstream >	filePtrs_
	File pointer. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const word	prefix_
	Prefix. More...

Detailed Description

Writes the time step.

Example of function object specification:

timeStep
{
    type           timeStep;
    writeControl   timeStep;
    writeInterval  1;
}

Output data is written to the dir postProcessing/timeStep/<timeDir>/

See also: Foam::functionObject Foam::functionObjects::regionFunctionObject Foam::functionObjects::logFiles

Source files

Definition at line 68 of file timeStepFunctionObject.H.

Constructor & Destructor Documentation

◆ timeStep() [1/2]

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

Construct from Time and dictionary.

Definition at line 51 of file timeStepFunctionObject.C.

References Foam::read().

Here is the call graph for this function:

◆ timeStep() [2/2]

timeStep ( const timeStep & )

delete

Disallow default bitwise copy construction.

◆ ~timeStep()

~timeStep ( )

virtual

Destructor.

Definition at line 66 of file timeStepFunctionObject.C.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( const label i )

protectedvirtual

Output file header information.

Implements logFiles.

Definition at line 82 of file timeStepFunctionObject.C.

References Foam::endl(), Foam::file, UPstream::master(), Foam::tab, and Foam::vtkWriteOps::writeHeader().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "timeStep" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the controls.

Reimplemented from regionFunctionObject.

Definition at line 72 of file timeStepFunctionObject.C.

References functionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 96 of file timeStepFunctionObject.C.

◆ write()

bool write ( )

virtual

Write the time step value.

Reimplemented from logFiles.

Definition at line 102 of file timeStepFunctionObject.C.

References Foam::endl(), Foam::file, UPstream::master(), Foam::tab, and logFiles::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const timeStep & )

delete

Disallow default bitwise assignment.

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

src/functionObjects/utilities/timeStep/timeStepFunctionObject.H
src/functionObjects/utilities/timeStep/timeStepFunctionObject.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ timeStep() [1/2]

◆ timeStep() [2/2]

◆ ~timeStep()

Member Function Documentation

◆ writeFileHeader()

◆ TypeName()

◆ read()

◆ execute()

◆ write()

◆ operator=()