Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::CheckpointService Class Reference

Public Member Functions

 CheckpointService (const ServiceBuildInfo &sbi)
void build () override
 Build-level construction of the service.
void setFileName (const String &file_name) override
 Sets the name of the checkpoint file.
String fileName () const override
 Name of the checkpoint file.
void setCheckpointTimes (RealConstArrayView times) override
 Sets the checkpoint times.
void setCurrentTimeAndIndex (Real current_time, Integer current_index) override
 Sets the time and index of the protection to read.
RealConstArrayView checkpointTimes () const override
 Checkpoint times.
String readerMetaData () const override
 Metadata for the reader associated with this writer.
void setReaderMetaData (const String &s) override
 Metadata associated with this reader.
void setBaseDirectoryName (const String &dirname) override
 Sets the name of the checkpoint base directory.
String baseDirectoryName () const override
 Name of the checkpoint base directory.
Integer currentIndex () const
Real currentTime () const
Public Member Functions inherited from Arcane::BasicService
 ~BasicService () override
 Releases resources.
virtual ISubDomainsubDomain ()
Public Member Functions inherited from Arcane::AbstractService
 ~AbstractService () override
 Destructor.
IServiceInfoserviceInfo () const override
 Access to service information. See IServiceInfo for details.
IBaseserviceParent () const override
 Access to the base interface of main Arcane objects.
IServiceserviceInterface () override
 Returns the low-level IService interface of the service.
Public Member Functions inherited from Arcane::TraceAccessor
 TraceAccessor (ITraceMng *m)
 Constructs an accessor via the trace manager m.
 TraceAccessor (const TraceAccessor &rhs)
 Copy constructor.
TraceAccessoroperator= (const TraceAccessor &rhs)
 Copy assignment operator.
virtual ~TraceAccessor ()
 Frees resources.
ITraceMngtraceMng () 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::IService
virtual ~IService ()
 Releases resources.
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.
VariableNodeReal3nodesCoordinates () 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.
IMeshmesh () const
const MeshHandlemeshHandle () 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).
Public Member Functions inherited from Arcane::ICheckpointWriter
virtual ~ICheckpointWriter ()=default
 Releases resources.
virtual IDataWriterdataWriter ()=0
 Returns the associated writer.
virtual void notifyBeginWrite ()=0
 Notifies that a checkpoint is going to be written with the current parameters.
virtual void notifyEndWrite ()=0
 Notifies that a checkpoint has just been written.
virtual void close ()=0
 Closes the checkpoints.
virtual String readerServiceName () const =0
 Name of the reader service associated with this writer.
Public Member Functions inherited from Arcane::ICheckpointReader
virtual ~ICheckpointReader ()=default
 Frees resources.
virtual IDataReaderdataReader ()=0
 Returns the associated reader.
virtual void notifyBeginRead ()=0
 Notifies that a protection will be read with current parameters.
virtual void notifyEndRead ()=0
 Notifies that a protection has just been read.

Additional Inherited Members

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::BasicService
 BasicService (const ServiceBuildInfo &)
Protected Member Functions inherited from Arcane::AbstractService
 AbstractService (const ServiceBuildInfo &)
 Constructor from a ServiceBuildInfo.
Protected Member Functions inherited from Arcane::TraceAccessor
void _setLocalVerboseLevel (Int32 v)
Int32 _localVerboseLevel () const
Protected Member Functions inherited from Arcane::IService
 IService ()
 Constructor.

Detailed Description

Definition at line 44 of file CheckpointService.h.

Constructor & Destructor Documentation

◆ CheckpointService()

Arcane::CheckpointService::CheckpointService ( const ServiceBuildInfo & sbi)
explicit

Definition at line 27 of file CheckpointService.cc.

Member Function Documentation

◆ baseDirectoryName()

String Arcane::CheckpointService::baseDirectoryName ( ) const
inlineoverridevirtual

Name of the checkpoint base directory.

Implements Arcane::ICheckpointWriter.

Definition at line 73 of file CheckpointService.h.

◆ build()

void Arcane::CheckpointService::build ( )
inlineoverridevirtual

Build-level construction of the service.

This method is called right after the constructor.

Reimplemented from Arcane::AbstractService.

Definition at line 59 of file CheckpointService.h.

◆ checkpointTimes()

RealConstArrayView Arcane::CheckpointService::checkpointTimes ( ) const
inlineoverridevirtual

Checkpoint times.

Implements Arcane::ICheckpointWriter.

Definition at line 68 of file CheckpointService.h.

◆ currentIndex()

Integer Arcane::CheckpointService::currentIndex ( ) const
inline

Definition at line 75 of file CheckpointService.h.

◆ currentTime()

Real Arcane::CheckpointService::currentTime ( ) const
inline

Definition at line 76 of file CheckpointService.h.

◆ fileName()

String Arcane::CheckpointService::fileName ( ) const
inlineoverridevirtual

Name of the checkpoint file.

Implements Arcane::ICheckpointWriter.

Definition at line 64 of file CheckpointService.h.

◆ readerMetaData()

String Arcane::CheckpointService::readerMetaData ( ) const
inlineoverridevirtual

Metadata for the reader associated with this writer.

Implements Arcane::ICheckpointWriter.

Definition at line 70 of file CheckpointService.h.

◆ setBaseDirectoryName()

void Arcane::CheckpointService::setBaseDirectoryName ( const String & dirname)
inlineoverridevirtual

Sets the name of the checkpoint base directory.

Implements Arcane::ICheckpointWriter.

Definition at line 72 of file CheckpointService.h.

◆ setCheckpointTimes()

void Arcane::CheckpointService::setCheckpointTimes ( RealConstArrayView times)
overridevirtual

Sets the checkpoint times.

The time of the current checkpoint is the last element of the array

Implements Arcane::ICheckpointWriter.

Definition at line 36 of file CheckpointService.cc.

◆ setCurrentTimeAndIndex()

void Arcane::CheckpointService::setCurrentTimeAndIndex ( Real current_time,
Integer current_index )
overridevirtual

Sets the time and index of the protection to read.

Implements Arcane::ICheckpointReader.

Definition at line 45 of file CheckpointService.cc.

◆ setFileName()

void Arcane::CheckpointService::setFileName ( const String & file_name)
inlineoverridevirtual

Sets the name of the checkpoint file.

Implements Arcane::ICheckpointWriter.

Definition at line 63 of file CheckpointService.h.

◆ setReaderMetaData()

void Arcane::CheckpointService::setReaderMetaData ( const String & )
inlineoverridevirtual

Metadata associated with this reader.

Implements Arcane::ICheckpointReader.

Definition at line 71 of file CheckpointService.h.


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