Public Member Functions
	TimeLoop (IApplication *app, const String &name)
virtual void	build () override
	Constructs the time loop.
IApplication *	application () const override
	Application.
String	name () const override
	Name of the time loop.
String	title () const override
	Title of the time loop.
void	setTitle (const String &title) override
	Sets the title of the time loop.
String	description () const override
	Description of the time loop.
void	setDescription (const String &description) override
	Sets the description of the time loop.
StringCollection	requiredModulesName () const override
	List of names of required modules.
void	setRequiredModulesName (const StringCollection &names) override
	Sets the list of required modules.
StringCollection	optionalModulesName () const override
	List of names of optional modules.
void	setOptionalModulesName (const StringCollection &names) override
	Sets the list of optional modules.
TimeLoopEntryPointInfoCollection	entryPoints (const String &where) const override
	List of names of entry points for the call point where.
void	setEntryPoints (const String &where, const TimeLoopEntryPointInfoCollection &calls) override
	Sets the list of names of entry points for the call point where.
StringCollection	userClasses () const override
	List of user classes associated with the time loop.
void	setUserClasses (const StringCollection &user_classes) override
	Returns the list of classes associated with the time loop.
TimeLoopSingletonServiceInfoCollection	singletonServices () const override
	List of singleton services.
void	setSingletonServices (const TimeLoopSingletonServiceInfoCollection &c) override
	Sets the list of singleton services.
IConfiguration *	configuration () override
	Configuration options.
virtual bool	isOldFormat () const
virtual void	setOldFormat (bool is_old)
virtual	~ITimeLoop ()=default
	Frees resources.

Additional Inherited Members
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.

Detailed Description

Definition at line 33 of file TimeLoop.h.

Constructor & Destructor Documentation

◆ TimeLoop()

Arcane::TimeLoop::TimeLoop	(	IApplication *	app,
		const String &	name )

Definition at line 108 of file TimeLoop.cc.

◆ ~TimeLoop()

Arcane::TimeLoop::~TimeLoop ( )

override

Definition at line 117 of file TimeLoop.cc.

Member Function Documentation

◆ application()

IApplication * Arcane::TimeLoop::application ( ) const

overridevirtual

Application.

Implements Arcane::ITimeLoop.

Definition at line 187 of file TimeLoop.cc.

◆ build()

void Arcane::TimeLoop::build ( )

overridevirtual

Constructs the time loop.

Implements Arcane::ITimeLoop.

Definition at line 126 of file TimeLoop.cc.

◆ configuration()

IConfiguration * Arcane::TimeLoop::configuration ( )

overridevirtual

Configuration options.

Implements Arcane::ITimeLoop.

Definition at line 274 of file TimeLoop.cc.

◆ description()

String Arcane::TimeLoop::description ( ) const

overridevirtual

Description of the time loop.

Implements Arcane::ITimeLoop.

Definition at line 223 of file TimeLoop.cc.

Referenced by setDescription().

◆ entryPoints()

TimeLoopEntryPointInfoCollection Arcane::TimeLoop::entryPoints ( const String & where ) const

overridevirtual

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

Implements Arcane::ITimeLoop.

Definition at line 153 of file TimeLoop.cc.

◆ isOldFormat()

bool Arcane::TimeLoop::isOldFormat ( ) const

virtual

Definition at line 211 of file TimeLoop.cc.

◆ name()

String Arcane::TimeLoop::name ( ) const

overridevirtual

Name of the time loop.

Implements Arcane::ITimeLoop.

Definition at line 193 of file TimeLoop.cc.

◆ optionalModulesName()

StringCollection Arcane::TimeLoop::optionalModulesName ( ) const

overridevirtual

List of names of optional modules.

Implements Arcane::ITimeLoop.

Definition at line 241 of file TimeLoop.cc.

◆ requiredModulesName()

StringCollection Arcane::TimeLoop::requiredModulesName ( ) const

overridevirtual

List of names of required modules.

Implements Arcane::ITimeLoop.

Definition at line 235 of file TimeLoop.cc.

◆ setDescription()

void Arcane::TimeLoop::setDescription ( const String & )

overridevirtual

Sets the description of the time loop.

Implements Arcane::ITimeLoop.

Definition at line 229 of file TimeLoop.cc.

References description().

◆ setEntryPoints()

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

overridevirtual

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

Implements Arcane::ITimeLoop.

Definition at line 166 of file TimeLoop.cc.

References Arcane::List< T >::clone().

◆ setOldFormat()

void Arcane::TimeLoop::setOldFormat ( bool is_old )

virtual

Definition at line 217 of file TimeLoop.cc.

◆ setOptionalModulesName()

void Arcane::TimeLoop::setOptionalModulesName ( const StringCollection & )

overridevirtual

Sets the list of optional modules.

Implements Arcane::ITimeLoop.

Definition at line 144 of file TimeLoop.cc.

◆ setRequiredModulesName()

void Arcane::TimeLoop::setRequiredModulesName ( const StringCollection & )

overridevirtual

Sets the list of required modules.

Implements Arcane::ITimeLoop.

Definition at line 135 of file TimeLoop.cc.

◆ setSingletonServices()

void Arcane::TimeLoop::setSingletonServices ( const TimeLoopSingletonServiceInfoCollection & c )

overridevirtual

Sets the list of singleton services.

Implements Arcane::ITimeLoop.

Definition at line 265 of file TimeLoop.cc.

◆ setTitle()

void Arcane::TimeLoop::setTitle ( const String & )

overridevirtual

Sets the title of the time loop.

Implements Arcane::ITimeLoop.

Definition at line 205 of file TimeLoop.cc.

References title().

◆ setUserClasses()

void Arcane::TimeLoop::setUserClasses ( const StringCollection & )

overridevirtual

Returns the list of classes associated with the time loop.

Implements Arcane::ITimeLoop.

Definition at line 178 of file TimeLoop.cc.

◆ singletonServices()

TimeLoopSingletonServiceInfoCollection Arcane::TimeLoop::singletonServices ( ) const

overridevirtual

List of singleton services.

Implements Arcane::ITimeLoop.

Definition at line 256 of file TimeLoop.cc.

◆ title()

String Arcane::TimeLoop::title ( ) const

overridevirtual

Title of the time loop.

Implements Arcane::ITimeLoop.

Definition at line 199 of file TimeLoop.cc.

Referenced by setTitle().

◆ userClasses()

StringCollection Arcane::TimeLoop::userClasses ( ) const

overridevirtual

List of user classes associated with the time loop.

Implements Arcane::ITimeLoop.

Definition at line 247 of file TimeLoop.cc.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimeLoop()

◆ ~TimeLoop()

Member Function Documentation

◆ application()

◆ build()

◆ configuration()

◆ description()

◆ entryPoints()

◆ isOldFormat()

◆ name()

◆ optionalModulesName()

◆ requiredModulesName()

◆ setDescription()

◆ setEntryPoints()

◆ setOldFormat()

◆ setOptionalModulesName()

◆ setRequiredModulesName()

◆ setSingletonServices()

◆ setTitle()

◆ setUserClasses()

◆ singletonServices()

◆ title()

◆ userClasses()