Interface of a time loop. More...

#include <arcane/core/ITimeLoop.h>

Inheritance diagram for Arcane::ITimeLoop:

Collaboration diagram for Arcane::ITimeLoop:

Call point
Where the entry point is used.
static const char *	WComputeLoop = "compute-loop"
	called during the calculation loop
static const char *	WBuild = "build"
	called when reading the dataset
static const char *	WInit = "init"
	called during initialization, initialization of a restart, or a new case
static const char *	WRestore = "restore"
	called to restore variables during a rollback
static const char *	WOnMeshChanged = "on-mesh-changed"
	called after a mesh change
static const char *	WOnMeshRefinement = "on-mesh-refinement"
	called after mesh refinement
static const char *	WExit = "exit"
	called upon termination of the code.
virtual	~ITimeLoop ()=default
	Frees resources.
virtual void	build ()=0
	Constructs the time loop.
virtual IApplication *	application () const =0
	Application.
virtual String	name () const =0
	Name of the time loop.
virtual String	title () const =0
	Title of the time loop.
virtual void	setTitle (const String &)=0
	Sets the title of the time loop.
virtual String	description () const =0
	Description of the time loop.
virtual void	setDescription (const String &)=0
	Sets the description of the time loop.
virtual StringCollection	requiredModulesName () const =0
	List of names of required modules.
virtual void	setRequiredModulesName (const StringCollection &)=0
	Sets the list of required modules.
virtual StringCollection	optionalModulesName () const =0
	List of names of optional modules.
virtual void	setOptionalModulesName (const StringCollection &)=0
	Sets the list of optional modules.
virtual TimeLoopEntryPointInfoCollection	entryPoints (const String &where) const =0
	List of names of entry points for the call point where.
virtual void	setEntryPoints (const String &where, const TimeLoopEntryPointInfoCollection &)=0
	Sets the list of names of entry points for the call point where.
virtual StringCollection	userClasses () const =0
	List of user classes associated with the time loop.
virtual void	setUserClasses (const StringCollection &)=0
	Returns the list of classes associated with the time loop.
virtual TimeLoopSingletonServiceInfoCollection	singletonServices () const =0
	List of singleton services.
virtual void	setSingletonServices (const TimeLoopSingletonServiceInfoCollection &c)=0
	Sets the list of singleton services.
virtual IConfiguration *	configuration ()=0
	Configuration options.

Detailed Description

Interface of a time loop.

Definition at line 32 of file ITimeLoop.h.

Member Function Documentation

◆ application()

virtual IApplication * Arcane::ITimeLoop::application ( ) const

pure virtual

Application.

Implemented in Arcane::TimeLoop.

◆ build()

virtual void Arcane::ITimeLoop::build ( )

pure virtual

Constructs the time loop.

Implemented in Arcane::TimeLoop.

◆ configuration()

virtual IConfiguration * Arcane::ITimeLoop::configuration ( )

pure virtual

Configuration options.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

◆ description()

virtual String Arcane::ITimeLoop::description ( ) const

pure virtual

Description of the time loop.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::SubDomain::dumpInternalInfos().

Here is the caller graph for this function:

◆ entryPoints()

virtual TimeLoopEntryPointInfoCollection Arcane::ITimeLoop::entryPoints ( const String & where ) const

pure virtual

List of names of entry points for the call point where.

Implemented in Arcane::TimeLoop.

◆ name()

virtual String Arcane::ITimeLoop::name ( ) const

pure virtual

Name of the time loop.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::InternalInfosDumper::dumpArcaneDatabase(), Arcane::InternalInfosDumper::dumpInternalAllInfos(), and Arcane::TimeLoopMng::registerTimeLoop().

Here is the caller graph for this function:

◆ optionalModulesName()

virtual StringCollection Arcane::ITimeLoop::optionalModulesName ( ) const

pure virtual

List of names of optional modules.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopMng::_fillModuleStateMap().

Here is the caller graph for this function:

◆ requiredModulesName()

virtual StringCollection Arcane::ITimeLoop::requiredModulesName ( ) const

pure virtual

List of names of required modules.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopMng::_fillModuleStateMap().

Here is the caller graph for this function:

◆ setDescription()

virtual void Arcane::ITimeLoop::setDescription ( const String & )

pure virtual

Sets the description of the time loop.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

◆ setEntryPoints()

virtual void Arcane::ITimeLoop::setEntryPoints	(	const String &	where,
		const TimeLoopEntryPointInfoCollection &	)

pure virtual

Sets the list of names of entry points for the call point where.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

◆ setOptionalModulesName()

virtual void Arcane::ITimeLoop::setOptionalModulesName ( const StringCollection & )

pure virtual

Sets the list of optional modules.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

◆ setRequiredModulesName()

virtual void Arcane::ITimeLoop::setRequiredModulesName ( const StringCollection & )

pure virtual

Sets the list of required modules.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

◆ setSingletonServices()

virtual void Arcane::ITimeLoop::setSingletonServices ( const TimeLoopSingletonServiceInfoCollection & c )

pure virtual

Sets the list of singleton services.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

◆ setTitle()

virtual void Arcane::ITimeLoop::setTitle ( const String & )

pure virtual

Sets the title of the time loop.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

◆ setUserClasses()

virtual void Arcane::ITimeLoop::setUserClasses ( const StringCollection & )

pure virtual

Returns the list of classes associated with the time loop.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

◆ singletonServices()

virtual TimeLoopSingletonServiceInfoCollection Arcane::ITimeLoop::singletonServices ( ) const

pure virtual

List of singleton services.

Implemented in Arcane::TimeLoop.

◆ title()

virtual String Arcane::ITimeLoop::title ( ) const

pure virtual

Title of the time loop.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::SubDomain::dumpInternalInfos().

Here is the caller graph for this function:

◆ userClasses()

virtual StringCollection Arcane::ITimeLoop::userClasses ( ) const

pure virtual

List of user classes associated with the time loop.

Implemented in Arcane::TimeLoop.

Referenced by Arcane::SubDomain::dumpInternalInfos().

Here is the caller graph for this function:

Member Data Documentation

◆ WBuild

const char * Arcane::ITimeLoop::WBuild = "build"

static

called when reading the dataset

Definition at line 43 of file ITimeLoop.h.

Referenced by Arcane::TimeLoopReader::readTimeLoops(), and Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WComputeLoop

const char * Arcane::ITimeLoop::WComputeLoop = "compute-loop"

static

called during the calculation loop

Definition at line 41 of file ITimeLoop.h.

Referenced by Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopReader::readTimeLoops(), and Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WExit

const char * Arcane::ITimeLoop::WExit = "exit"

static

called upon termination of the code.

Definition at line 53 of file ITimeLoop.h.

Referenced by Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopReader::readTimeLoops(), and Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WInit

const char * Arcane::ITimeLoop::WInit = "init"

static

called during initialization, initialization of a restart, or a new case

Definition at line 45 of file ITimeLoop.h.

Referenced by Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopReader::readTimeLoops(), and Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WOnMeshChanged

const char * Arcane::ITimeLoop::WOnMeshChanged = "on-mesh-changed"

static

called after a mesh change

Definition at line 49 of file ITimeLoop.h.

Referenced by Arcane::TimeLoopReader::readTimeLoops(), and Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WOnMeshRefinement

const char * Arcane::ITimeLoop::WOnMeshRefinement = "on-mesh-refinement"

static

called after mesh refinement

Definition at line 51 of file ITimeLoop.h.

Referenced by Arcane::TimeLoopReader::readTimeLoops(), and Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WRestore

const char * Arcane::ITimeLoop::WRestore = "restore"

static

called to restore variables during a rollback

Definition at line 47 of file ITimeLoop.h.

Referenced by Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopReader::readTimeLoops(), and Arcane::TimeLoopMng::setUsedTimeLoop().

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

Call point

Detailed Description

Member Function Documentation

◆ application()

◆ build()

◆ configuration()

◆ description()

◆ entryPoints()

◆ name()

◆ optionalModulesName()

◆ requiredModulesName()

◆ setDescription()

◆ setEntryPoints()

◆ setOptionalModulesName()

◆ setRequiredModulesName()

◆ setSingletonServices()

◆ setTitle()

◆ setUserClasses()

◆ singletonServices()

◆ title()

◆ userClasses()

Member Data Documentation

◆ WBuild

◆ WComputeLoop

◆ WExit

◆ WInit

◆ WOnMeshChanged

◆ WOnMeshRefinement

◆ WRestore