Arcane::ArcaneCheckpointModule Class Reference

Module managing protections (checkpoint/restart mechanism). More...

Inheritance diagram for Arcane::ArcaneCheckpointModule:

Collaboration diagram for Arcane::ArcaneCheckpointModule:

Public Member Functions
	ArcaneCheckpointModule (const ModuleBuilder &cb)
virtual VersionInfo	versionInfo () const
	Module version.
virtual void	checkpointCheckAndWriteData ()
	Checks if a checkpoint should be performed at this moment and performs it if necessary.
virtual void	checkpointStartInit ()
virtual void	checkpointInit ()
virtual void	checkpointExit ()
	End-of-calculation operations.
Public Member Functions inherited from ArcaneArcaneCheckpointObject
	ArcaneArcaneCheckpointObject (const Arcane::ModuleBuildInfo &mb)
CaseOptionsArcaneCheckpoint *	options () const
	Options du jeu de données du module.
Public Member Functions inherited from Arcane::BasicModule
	~BasicModule () override
	Destructor.
Public Member Functions inherited from Arcane::AbstractModule
	AbstractModule (const ModuleBuildInfo &)
	Constructor from a ModuleBuildInfo.
virtual	~AbstractModule ()
	Destructor.
String	name () const override
	Module name.
ISession *	session () const override
	Session associated with the module.
ISubDomain *	subDomain () const override
	Sub-domain associated with the module.
IMesh *	defaultMesh () const override
	Default mesh for this module.
MeshHandle	defaultMeshHandle () const override
	Default mesh for this module.
IParallelMng *	parallelMng () const override
	Message passing parallelism manager.
IAcceleratorMng *	acceleratorMng () const override
	Accelerator manager.
ITraceMng *	traceMng () const override
	Trace manager.
void	setUsed (bool v) override
	Sets the module usage flag.
bool	used () const override
	Returns the module usage status.
void	setDisabled (bool v) override
	Sets the module activation flag.
bool	disabled () const override
	Returns the module activation status.
bool	isGarbageCollected () const override
	Indicates if the module uses a Garbage collection system.
Public Member Functions inherited from Arcane::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Constructs an accessor via the trace manager m.
	TraceAccessor (const TraceAccessor &rhs)
	Copy constructor.
TraceAccessor &	operator= (const TraceAccessor &rhs)
	Copy assignment operator.
virtual	~TraceAccessor ()
	Frees resources.
ITraceMng *	traceMng () const
	Trace manager.
TraceMessage	info () const
	Flow for an information message.
TraceMessage	pinfo () const
	Flow for a parallel information message.
TraceMessage	info (char category) const
	Flow for an information message of a given category.
TraceMessage	pinfo (char category) const
	Flow for a parallel information message of a given category.
TraceMessage	info (bool v) const
	Flow for an information message.
TraceMessage	warning () const
	Flow for a warning message.
TraceMessage	pwarning () const
TraceMessage	error () const
	Flow for an error message.
TraceMessage	perror () const
TraceMessage	log () const
	Flow for a log message.
TraceMessage	plog () const
	Flow for a log message.
TraceMessage	logdate () const
	Flow for a log message preceded by the date.
TraceMessage	fatal () const
	Flow for a fatal error message.
TraceMessage	pfatal () const
	Flow for a parallel fatal error message.
TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flow for a debug message.
Trace::eDebugLevel	configDbgLevel () const
	Debug level of the configuration file.
TraceMessage	info (Int32 verbose_level) const
	Flow for an information message of a given level.
TraceMessage	linfo () const
	Flow for an information message with the local information level of this instance.
TraceMessage	linfo (Int32 relative_level) const
	Flow for an information message with the local information level of this instance.
void	fatalMessage (const StandaloneTraceMessage &o) const
Public Member Functions inherited from Arcane::IModule
virtual	~IModule ()
	Destructor.
Public Member Functions inherited from Arcane::MeshAccessor
	MeshAccessor (ISubDomain *sd)
	MeshAccessor (IMesh *mesh)
	MeshAccessor (const MeshHandle &mesh_handle)
Integer	nbCell () const
	Returns the number of cells in the mesh.
Integer	nbFace () const
	Returns the number of faces in the mesh.
Integer	nbEdge () const
	Returns the number of edges in the mesh.
Integer	nbNode () const
	Returns the number of nodes in the mesh.
VariableNodeReal3 &	nodesCoordinates () const
	Returns the coordinates of the mesh nodes.
NodeGroup	allNodes () const
	Returns the group containing all nodes.
EdgeGroup	allEdges () const
	Returns the group containing all edges.
FaceGroup	allFaces () const
	Returns the group containing all faces.
CellGroup	allCells () const
	Returns the group containing all cells.
FaceGroup	outerFaces () const
	Returns the group containing all boundary faces.
NodeGroup	ownNodes () const
	Returns the group containing all nodes specific to this domain.
CellGroup	ownCells () const
	Returns the group containing all cells specific to this domain.
FaceGroup	ownFaces () const
	Group containing all faces specific to this domain.
EdgeGroup	ownEdges () const
	Group containing all edges specific to this domain.
IMesh *	mesh () const
const MeshHandle &	meshHandle () const
Public Member Functions inherited from Arcane::CommonVariables
	CommonVariables (IModule *c)
	Constructs the references of the common variables for the module c.
	CommonVariables (IVariableMng *variable_mng)
	Constructs the references of the common variables for the manager variable_mng.
	CommonVariables (ISubDomain *sd)
	Constructs the references of the common variables for the subdomain sd.
virtual	~CommonVariables ()
	Releases resources.
Int32	globalIteration () const
	Current iteration number.
Real	globalTime () const
	Current time.
Real	globalOldTime () const
	Previous current time.
Real	globalFinalTime () const
	Final time of the simulation.
Real	globalDeltaT () const
	Current Delta T.
Real	globalCPUTime () const
	CPU time used (in seconds).
Real	globalOldCPUTime () const
	Previous CPU time used (in seconds).
Real	globalElapsedTime () const
	Clock time (elapsed) used (in seconds).
Real	globalOldElapsedTime () const
	Previous clock time (elapsed) used (in seconds).

Private Member Functions
void	_doCheckpoint (bool save_history)
	Performs a checkpoint.
void	_dumpStats ()
void	_getCheckpointService ()
void	_setDirectoryName ()
bool	_checkHasOutput ()

Private Attributes
OutputChecker	m_output_checker
Timer *	m_checkpoint_timer
ICheckpointWriter *	m_checkpoint_writer
String	m_checkpoint_dirname

Additional Inherited Members
Static Public Member Functions inherited from ArcaneArcaneCheckpointObject
static void	fillServiceInfo (Arcane::ServiceInfo *si)
Static Public Member Functions inherited from Arcane::AbstractModule
static void	staticInitialize (ISubDomain *sd)
	Initialization of the module for the sub-domain sd.
Public Attributes inherited from Arcane::CommonVariables
VariableScalarInt32	m_global_iteration
	Current iteration.
VariableScalarReal	m_global_time
	Current time.
VariableScalarReal	m_global_deltat
	Global Delta T.
VariableScalarReal	m_global_old_time
	Time previous to the current time.
VariableScalarReal	m_global_old_deltat
	Delta T at the time previous to the global time.
VariableScalarReal	m_global_final_time
	Final time of the case.
VariableScalarReal	m_global_old_cpu_time
	Previous CPU time used (in seconds).
VariableScalarReal	m_global_cpu_time
	CPU time used (in seconds).
VariableScalarReal	m_global_old_elapsed_time
	Previous clock time used (in seconds).
VariableScalarReal	m_global_elapsed_time
	Clock time used (in seconds).
Protected Member Functions inherited from Arcane::BasicModule
	BasicModule (const ModuleBuildInfo &)
	Constructor from a ModuleBuildInfo.
Protected Member Functions inherited from Arcane::AbstractModule
void	_setVersionInfo (const VersionInfo &vi)
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const
Protected Attributes inherited from ArcaneArcaneCheckpointObject
Arcane::VariableScalarInteger	m_next_iteration
	Variables du module.
Arcane::VariableScalarReal	m_next_global_time
Arcane::VariableScalarInteger	m_next_cpu_time
Arcane::VariableArrayReal	m_checkpoints_time

Detailed Description

Module managing protections (checkpoint/restart mechanism).

Definition at line 45 of file ArcaneCheckpointModule.cc.

Constructor & Destructor Documentation

ArcaneCheckpointModule()

Arcane::ArcaneCheckpointModule::ArcaneCheckpointModule

(

const ModuleBuilder &

cb

)

Definition at line 88 of file ArcaneCheckpointModule.cc.

~ArcaneCheckpointModule()

Arcane::ArcaneCheckpointModule::~ArcaneCheckpointModule

(

)

Definition at line 105 of file ArcaneCheckpointModule.cc.

Member Function Documentation

_checkHasOutput()

bool Arcane::ArcaneCheckpointModule::_checkHasOutput ( )

private

Definition at line 140 of file ArcaneCheckpointModule.cc.

_doCheckpoint()

void Arcane::ArcaneCheckpointModule::_doCheckpoint ( bool save_history )

private

Performs a checkpoint.

Displays the time spent during checkpoint writing.

Definition at line 230 of file ArcaneCheckpointModule.cc.

References Arcane::ISubDomain::checkpointMng(), Arcane::ITimeHistoryMng::dumpHistory(), Arcane::TraceAccessor::info(), Arcane::CommonVariables::m_global_time, Arcane::AbstractModule::subDomain(), Arcane::ISubDomain::timeHistoryMng(), and Arcane::ICheckpointMng::writeDefaultCheckpoint().

Referenced by checkpointCheckAndWriteData(), and checkpointExit().

Here is the call graph for this function:

Here is the caller graph for this function:

_dumpStats()

void Arcane::ArcaneCheckpointModule::_dumpStats ( )

private

Definition at line 191 of file ArcaneCheckpointModule.cc.

_getCheckpointService()

void Arcane::ArcaneCheckpointModule::_getCheckpointService ( )

private

Definition at line 262 of file ArcaneCheckpointModule.cc.

_setDirectoryName()

void Arcane::ArcaneCheckpointModule::_setDirectoryName ( )

private

Definition at line 206 of file ArcaneCheckpointModule.cc.

checkpointCheckAndWriteData()

void Arcane::ArcaneCheckpointModule::checkpointCheckAndWriteData ( )

virtual

Checks if a checkpoint should be performed at this moment and performs it if necessary.

Implements ArcaneArcaneCheckpointObject.

Definition at line 284 of file ArcaneCheckpointModule.cc.

References _doCheckpoint(), and Arcane::TraceAccessor::info().

Here is the call graph for this function:

checkpointExit()

void Arcane::ArcaneCheckpointModule::checkpointExit ( )

virtual

End-of-calculation operations.

• Performs an end-of-calculation checkpoint (if requested)

Implements ArcaneArcaneCheckpointObject.

Definition at line 174 of file ArcaneCheckpointModule.cc.

References _doCheckpoint(), and ArcaneArcaneCheckpointObject::options().

Here is the call graph for this function:

checkpointInit()

void Arcane::ArcaneCheckpointModule::checkpointInit ( )

virtual

Implements ArcaneArcaneCheckpointObject.

Definition at line 114 of file ArcaneCheckpointModule.cc.

checkpointStartInit()

void Arcane::ArcaneCheckpointModule::checkpointStartInit ( )

virtual

Implements ArcaneArcaneCheckpointObject.

Definition at line 155 of file ArcaneCheckpointModule.cc.

versionInfo()

virtual VersionInfo Arcane::ArcaneCheckpointModule::versionInfo ( ) const

inlinevirtual

Module version.

Reimplemented from Arcane::AbstractModule.

Definition at line 55 of file ArcaneCheckpointModule.cc.

Member Data Documentation

m_checkpoint_dirname

String Arcane::ArcaneCheckpointModule::m_checkpoint_dirname

private

Definition at line 69 of file ArcaneCheckpointModule.cc.

m_checkpoint_timer

Timer* Arcane::ArcaneCheckpointModule::m_checkpoint_timer

private

Definition at line 67 of file ArcaneCheckpointModule.cc.

m_checkpoint_writer

ICheckpointWriter* Arcane::ArcaneCheckpointModule::m_checkpoint_writer

private

Definition at line 68 of file ArcaneCheckpointModule.cc.

m_output_checker

OutputChecker Arcane::ArcaneCheckpointModule::m_output_checker

private

Definition at line 66 of file ArcaneCheckpointModule.cc.

---

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

• ArcaneCheckpointModule.cc