Abstract functionObject to report when a real version is unavailable. More...

#include <functionObject.H>

Inheritance diagram for functionObject::unavailableFunctionObject:

Collaboration diagram for functionObject::unavailableFunctionObject:

Public Member Functions
virtual bool	execute ()
	No nothing.
virtual bool	write ()
	No nothing.
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 (const label subIndex)
	Execute using the specified subIndex.
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
	unavailableFunctionObject (const word &name)
	Construct with name.
void	carp (std::string message="") const
	Report it is unavailable, emitting a FatalError for try/catch in the caller.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.

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

Abstract functionObject to report when a real version is unavailable.

Definition at line 573 of file functionObject.H.

Constructor & Destructor Documentation

◆ unavailableFunctionObject()

unavailableFunctionObject ( const word & name )

explicitprotected

Construct with name.

Definition at line 213 of file functionObject.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ carp()

void carp ( std::string message = "" ) const

protected

Report it is unavailable, emitting a FatalError for try/catch in the caller.

Definition at line 222 of file functionObject.C.

References Foam::exit(), Foam::FatalError, Foam::nl, and functionObject::type().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

No nothing.

Implements functionObject.

Definition at line 243 of file functionObject.C.

◆ write()

bool write ( )

virtual

No nothing.

Implements functionObject.

Definition at line 249 of file functionObject.C.

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

src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
src/OpenFOAM/db/functionObjects/functionObject/functionObject.C

Public Member Functions

Protected Member Functions