timeFunctionObject Class Reference

Virtual base class for function objects with a reference to Time. More...

#include <timeFunctionObject.H>

Inheritance diagram for timeFunctionObject:

Collaboration diagram for timeFunctionObject:

Public Member Functions
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
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)
	Construct from components.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	read (const dictionary &dict)
	Read and set the function object if its data have changed.
virtual bool	execute ()=0
	Called at each ++ or += of the time-loop.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	write ()=0
	Called at each ++ or += of the time-loop.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.

Protected Member Functions
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.

Protected Attributes
const Time &	time_
	Reference to the time database.

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.

Detailed Description

Virtual base class for function objects with a reference to Time.

See also

Foam::functionObject

Source files

• timeFunctionObject.H
• timeFunctionObject.C

Definition at line 52 of file timeFunctionObject.H.

Constructor & Destructor Documentation

timeFunctionObject() [1/2]

timeFunctionObject ( const timeFunctionObject & )

protecteddelete

No copy construct.

References timeFunctionObject().

Referenced by abort::abort(), codedFunctionObject::codedFunctionObject(), externalCoupled::externalCoupled(), multiRegion::multiRegion(), operator=(), setTimeStepFaRegionsFunctionObject::setTimeStepFaRegionsFunctionObject(), setTimeStepFunctionObject::setTimeStepFunctionObject(), stateFunctionObject::stateFunctionObject(), timeActivatedFileUpdate::timeActivatedFileUpdate(), timeControl::timeControl(), timeFunctionObject(), and timeInfo::timeInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

timeFunctionObject() [2/2]

timeFunctionObject	(	const word &	name,
		const Time &	runTime )

Construct from Time.

Definition at line 26 of file timeFunctionObject.C.

References functionObject::functionObject(), functionObject::name(), runTime, and time_.

Here is the call graph for this function:

~timeFunctionObject()

virtual ~timeFunctionObject ( )

virtualdefault

Destructor.

Member Function Documentation

clearOutputObjects()

void clearOutputObjects ( const wordList & objNames )

protected

Remove specified items from "functionObjectObjects".

Definition at line 39 of file timeFunctionObject.C.

References objectRegistry::checkOut(), and storedObjects().

Here is the call graph for this function:

operator=()

void operator= ( const timeFunctionObject & )

protecteddelete

No copy assignment.

References functionObject::name(), runTime, and timeFunctionObject().

Here is the call graph for this function:

time()

const Time & time ( ) const

inline

Return time database.

Definition at line 106 of file timeFunctionObject.H.

References time_.

Referenced by fieldAverage::addMeanFieldType(), fieldAverage::addPrime2MeanFieldType(), extractEulerianParticles::calculateAddressing(), extractEulerianParticles::collectParticle(), energyTransport::energyTransport(), age::execute(), runTimeControl::execute(), propellerInfo::propellerInfo(), multiFieldValue::read(), foamReport::read(), regionFunctionObject::regionFunctionObject(), fieldAverage::restoreWindowFieldsType(), foamReport::setDynamicBuiltins(), foamReport::setStaticBuiltins(), fieldAverage::storeWindowFieldType(), foamReport::write(), and graphFunctionObject::write().

Here is the caller graph for this function:

storedObjects() [1/2]

Foam::objectRegistry & storedObjects

(

)

Write access to the output objects ("functionObjectObjects") registered on Time.

Definition at line 56 of file timeFunctionObject.C.

References time_.

Referenced by clearOutputObjects(), fluxSummary::initialiseSurface(), fluxSummary::initialiseSurfaceAndDirection(), regionFunctionObject::obr(), fluxSummary::surfaceModeWrite(), and fluxSummary::totalArea().

Here is the caller graph for this function:

storedObjects() [2/2]

const Foam::objectRegistry & storedObjects

(

)

const

Const access to the output objects ("functionObjectObjects") registered on Time.

Definition at line 63 of file timeFunctionObject.C.

References time_.

Member Data Documentation

time_

const Time& time_

protected

Reference to the time database.

Definition at line 63 of file timeFunctionObject.H.

Referenced by setTimeStepFaRegionsFunctionObject::adjustTimeStep(), setTimeStepFunctionObject::adjustTimeStep(), timeControl::adjustTimeStep(), blendingFactor::blendingFactor(), energySpectrum::calcAndWriteSpectrum(), DESModelRegions::DESModelRegions(), abort::execute(), Curle::execute(), DESModelRegions::execute(), externalCoupled::execute(), filmFlux::execute(), graphFunctionObject::execute(), nearWallFields::execute(), runTimeControl::execute(), timeControl::execute(), writeFreeSurface::execute(), forces::force(), forceCoeffs::forceCoeff(), particleDistribution::generateDistribution(), icoUncoupledKinematicCloud::icoUncoupledKinematicCloud(), codedFunctionObject::libs(), forces::moment(), forceCoeffs::momentCoeff(), momentumError::momentumError(), momentum::newField(), abort::read(), dataCloud::read(), externalCoupled::read(), multiRegion::read(), setTimeStepFaRegionsFunctionObject::read(), setTimeStepFunctionObject::read(), timeActivatedFileUpdate::read(), externalCoupled::readDataMaster(), codedFunctionObject::redirectFunctionObject(), sampledSets::sampledSets(), sampledSets::sampledSets(), sampledSurfaces::sampledSurfaces(), sampledSurfaces::sampledSurfaces(), foamReport::setStaticBuiltins(), stateFunctionObject::stateDict(), stateFunctionObject::stateDict(), storedObjects(), storedObjects(), fluxSummary::surfaceModeWrite(), time(), timeFunctionObject(), timeInfo::timeInfo(), caseInfo::write(), dataCloud::write(), fluxSummary::write(), nearWallFields::write(), propellerInfo::write(), timeControl::write(), timeInfo::write(), writeCellCentres::write(), writeCellVolumes::write(), XiReactionRate::write(), propellerInfo::writeAxialWake(), externalCoupled::writeDataMaster(), caseInfo::writeFileDicts(), caseInfo::writeMeta(), propellerInfo::writePropellerPerformance(), propellerInfo::writeSampleDiskSurface(), streamLineBase::writeToFile(), and propellerInfo::writeWake().

---

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

• src/OpenFOAM/db/functionObjects/timeFunctionObject/timeFunctionObject.H
• src/OpenFOAM/db/functionObjects/timeFunctionObject/timeFunctionObject.C