Manager of a history of values. More...

Inheritance diagram for Arcane::TimeHistoryMng2:

Collaboration diagram for Arcane::TimeHistoryMng2:

Public Member Functions
	TimeHistoryMng2 (const ModuleBuildInfo &cb, bool add_entry_points=true)
VersionInfo	versionInfo () const override
	Module version.
void	addValue (const String &name, Real value, bool end_time, bool is_local) override
	Adds the value value to the history name.
void	addValue (const String &name, Int64 value, bool end_time, bool is_local) override
void	addValue (const String &name, Int32 value, bool end_time, bool is_local) override
	Adds the value value to the history name.
void	addValue (const String &name, RealConstArrayView values, bool end_time, bool is_local) override
	Adds the value value to the history name.
void	addValue (const String &name, Int32ConstArrayView values, bool end_time, bool is_local) override
	Adds the value value to the history name.
void	addValue (const String &name, Int64ConstArrayView values, bool end_time, bool is_local) override
void	timeHistoryBegin () override
void	timeHistoryEnd () override
void	timeHistoryInit () override
void	timeHistoryStartInit () override
void	timeHistoryContinueInit () override
void	timeHistoryRestore () override
void	timeHistoryStartInitEnd ()
void	addCurveWriter (ITimeHistoryCurveWriter2 *writer) override
	Adds a writer.
void	removeCurveWriter (ITimeHistoryCurveWriter2 *writer) override
	Removes a writer.
void	removeCurveWriter (const String &name) override
	Removes the writer with name name.
void	dumpHistory (bool is_verbose) override
	Saves the history.
void	dumpCurves (ITimeHistoryCurveWriter2 *writer) override
	Uses the writer writer to output all curves.
bool	active () const override
	Indicates the activation status.
void	setActive (bool is_active) override
	Sets the activation status.
bool	isDumpActive () const override
	Indicates the output activation status.
void	setDumpActive (bool is_active) override
	Sets the output activation status.
bool	isShrinkActive () const override
	Returns a boolean indicating if the history is compressed.
void	setShrinkActive (bool is_active) override
	Sets the boolean indicating if the history is compressed.
void	applyTransformation (ITimeHistoryTransformer *v) override
	Applies the transformation v to all curves.
ITimeHistoryMngInternal *	_internalApi () override
	Internal Arcane API.
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::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::ITimeHistoryMng
virtual	~ITimeHistoryMng ()=default
	Frees resources.
virtual ARCANE_DEPRECATED void	addCurveWriter (ITimeHistoryCurveWriter *writer)
	Adds a writer.
virtual ARCANE_DEPRECATED void	removeCurveWriter (ITimeHistoryCurveWriter *writer)
	Removes a writer.

Private Attributes
Ref< ITimeHistoryMngInternal >	m_internal

Additional Inherited Members
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::AbstractModule
void	_setVersionInfo (const VersionInfo &vi)
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const

Detailed Description

Manager of a history of values.

IMPORTANT: this module provides an interface to other modules via ITimeHistoryMng. Therefore, you must ensure that you do not modify the variables of this module during a call to any of the ITimeHistoryMng methods.

Definition at line 148 of file TimeHistoryMng2.cc.

Constructor & Destructor Documentation

◆ TimeHistoryMng2()

Arcane::TimeHistoryMng2::TimeHistoryMng2	(	const ModuleBuildInfo &	cb,
		bool	add_entry_points = true )

Definition at line 237 of file TimeHistoryMng2.cc.

Member Function Documentation

◆ _internalApi()

ITimeHistoryMngInternal * Arcane::TimeHistoryMng2::_internalApi ( )

inlineoverridevirtual

Internal Arcane API.

Reimplemented from Arcane::ITimeHistoryMng.

Definition at line 226 of file TimeHistoryMng2.cc.

◆ active()

bool Arcane::TimeHistoryMng2::active ( ) const

inlineoverridevirtual

Indicates the activation status.

The addValue() functions are only considered if the instance is active. Otherwise, calls to addValue() are ignored.

Implements Arcane::ITimeHistoryMng.

Definition at line 215 of file TimeHistoryMng2.cc.

◆ addCurveWriter()

void Arcane::TimeHistoryMng2::addCurveWriter ( ITimeHistoryCurveWriter2 * writer )

overridevirtual

Adds a writer.

Implements Arcane::ITimeHistoryMng.

Definition at line 355 of file TimeHistoryMng2.cc.

References Arcane::makeRef().

Here is the call graph for this function:

◆ addValue() [1/6]

void Arcane::TimeHistoryMng2::addValue	(	const String &	name,
		Int32	value,
		bool	end_time,
		bool	is_local )

inlineoverridevirtual

Adds the value value to the history name.

Deprecated: This method is deprecated and is replaced by using the GlobalTimeHistoryAdder object.

The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.

Implements Arcane::ITimeHistoryMng.

Definition at line 173 of file TimeHistoryMng2.cc.

References Arcane::AbstractModule::name(), and Arcane::AbstractModule::parallelMng().

Here is the call graph for this function:

◆ addValue() [2/6]

void Arcane::TimeHistoryMng2::addValue	(	const String &	name,
		Int32ConstArrayView	value,
		bool	end_time,
		bool	is_local )

inlineoverridevirtual

Adds the value value to the history name.

Deprecated: This method is deprecated and is replaced by using the GlobalTimeHistoryAdder object.

The number of elements of value must be constant over time. The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.

Implements Arcane::ITimeHistoryMng.

Definition at line 181 of file TimeHistoryMng2.cc.

References Arcane::AbstractModule::name(), and Arcane::AbstractModule::parallelMng().

Here is the call graph for this function:

◆ addValue() [3/6]

void Arcane::TimeHistoryMng2::addValue	(	const String &	name,
		Int64	value,
		bool	end_time,
		bool	is_local )

inlineoverridevirtual

Adds the value value to the history name.

Deprecated: This method is deprecated and is replaced by using the GlobalTimeHistoryAdder object.

The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.

Implements Arcane::ITimeHistoryMng.

Definition at line 169 of file TimeHistoryMng2.cc.

References Arcane::AbstractModule::name(), and Arcane::AbstractModule::parallelMng().

Here is the call graph for this function:

◆ addValue() [4/6]

void Arcane::TimeHistoryMng2::addValue	(	const String &	name,
		Int64ConstArrayView	value,
		bool	end_time,
		bool	is_local )

inlineoverridevirtual

Adds the value value to the history name.

Deprecated: This method is deprecated and is replaced by using the GlobalTimeHistoryAdder object.

The number of elements of value must be constant over time. The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.

Implements Arcane::ITimeHistoryMng.

Definition at line 185 of file TimeHistoryMng2.cc.

References Arcane::AbstractModule::name(), and Arcane::AbstractModule::parallelMng().

Here is the call graph for this function:

◆ addValue() [5/6]

void Arcane::TimeHistoryMng2::addValue	(	const String &	name,
		Real	value,
		bool	end_time,
		bool	is_local )

inlineoverridevirtual

Adds the value value to the history name.

Deprecated: This method is deprecated and is replaced by using the GlobalTimeHistoryAdder object.

The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.

Implements Arcane::ITimeHistoryMng.

Definition at line 165 of file TimeHistoryMng2.cc.

References Arcane::AbstractModule::name(), and Arcane::AbstractModule::parallelMng().

Here is the call graph for this function:

◆ addValue() [6/6]

void Arcane::TimeHistoryMng2::addValue	(	const String &	name,
		RealConstArrayView	value,
		bool	end_time,
		bool	is_local )

inlineoverridevirtual

Adds the value value to the history name.

Deprecated: This method is deprecated and is replaced by using the GlobalTimeHistoryAdder object.

The number of elements of value must be constant over time. The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.

Implements Arcane::ITimeHistoryMng.

Definition at line 177 of file TimeHistoryMng2.cc.

References Arcane::AbstractModule::name(), and Arcane::AbstractModule::parallelMng().

Here is the call graph for this function:

◆ applyTransformation()

void Arcane::TimeHistoryMng2::applyTransformation ( ITimeHistoryTransformer * v )

overridevirtual

Applies the transformation v to all curves.

Implements Arcane::ITimeHistoryMng.

Definition at line 402 of file TimeHistoryMng2.cc.

◆ dumpCurves()

void Arcane::TimeHistoryMng2::dumpCurves ( ITimeHistoryCurveWriter2 * writer )

overridevirtual

Uses the writer writer to output all curves.

The output path is the current directory.

Implements Arcane::ITimeHistoryMng.

Definition at line 393 of file TimeHistoryMng2.cc.

◆ dumpHistory()

void Arcane::TimeHistoryMng2::dumpHistory ( bool is_verbose )

overridevirtual

Saves the history.

This consists of calling dumpCurves() for each registered writer.

Implements Arcane::ITimeHistoryMng.

Definition at line 383 of file TimeHistoryMng2.cc.

◆ isDumpActive()

bool Arcane::TimeHistoryMng2::isDumpActive ( ) const

inlineoverridevirtual

Indicates the output activation status.

The dumpHistory() function is inactive if isDumpActive() is false.

Implements Arcane::ITimeHistoryMng.

Definition at line 218 of file TimeHistoryMng2.cc.

◆ isShrinkActive()

bool Arcane::TimeHistoryMng2::isShrinkActive ( ) const

inlineoverridevirtual

Returns a boolean indicating if the history is compressed.

Implements Arcane::ITimeHistoryMng.

Definition at line 221 of file TimeHistoryMng2.cc.

◆ removeCurveWriter() [1/2]

void Arcane::TimeHistoryMng2::removeCurveWriter ( const String & name )

overridevirtual

Removes the writer with name name.

Implements Arcane::ITimeHistoryMng.

Definition at line 411 of file TimeHistoryMng2.cc.

References Arcane::AbstractModule::name().

Here is the call graph for this function:

◆ removeCurveWriter() [2/2]

void Arcane::TimeHistoryMng2::removeCurveWriter ( ITimeHistoryCurveWriter2 * writer )

inlineoverridevirtual

Removes a writer.

Implements Arcane::ITimeHistoryMng.

Definition at line 203 of file TimeHistoryMng2.cc.

References ARCANE_CHECK_POINTER, Arcane::ITimeHistoryCurveWriter2::name(), and removeCurveWriter().

Referenced by removeCurveWriter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActive()

void Arcane::TimeHistoryMng2::setActive ( bool is_active )

inlineoverridevirtual

Sets the activation status.

See also: active().

Implements Arcane::ITimeHistoryMng.

Definition at line 216 of file TimeHistoryMng2.cc.

◆ setDumpActive()

void Arcane::TimeHistoryMng2::setDumpActive ( bool is_active )

inlineoverridevirtual

Sets the output activation status.

Implements Arcane::ITimeHistoryMng.

Definition at line 219 of file TimeHistoryMng2.cc.

◆ setShrinkActive()

void Arcane::TimeHistoryMng2::setShrinkActive ( bool is_active )

inlineoverridevirtual

Sets the boolean indicating if the history is compressed.

Implements Arcane::ITimeHistoryMng.

Definition at line 222 of file TimeHistoryMng2.cc.

◆ timeHistoryBegin()

void Arcane::TimeHistoryMng2::timeHistoryBegin ( )

overridevirtual

Implements Arcane::ITimeHistoryMng.

Definition at line 283 of file TimeHistoryMng2.cc.

◆ timeHistoryContinueInit()

void Arcane::TimeHistoryMng2::timeHistoryContinueInit ( )

overridevirtual

Implements Arcane::ITimeHistoryMng.

Definition at line 364 of file TimeHistoryMng2.cc.

◆ timeHistoryEnd()

void Arcane::TimeHistoryMng2::timeHistoryEnd ( )

overridevirtual

Implements Arcane::ITimeHistoryMng.

Definition at line 315 of file TimeHistoryMng2.cc.

◆ timeHistoryInit()

void Arcane::TimeHistoryMng2::timeHistoryInit ( )

overridevirtual

Implements Arcane::ITimeHistoryMng.

Definition at line 324 of file TimeHistoryMng2.cc.

◆ timeHistoryRestore()

void Arcane::TimeHistoryMng2::timeHistoryRestore ( )

overridevirtual

Implements Arcane::ITimeHistoryMng.

Definition at line 374 of file TimeHistoryMng2.cc.

◆ timeHistoryStartInit()

void Arcane::TimeHistoryMng2::timeHistoryStartInit ( )

overridevirtual

Implements Arcane::ITimeHistoryMng.

Definition at line 266 of file TimeHistoryMng2.cc.

◆ timeHistoryStartInitEnd()

void Arcane::TimeHistoryMng2::timeHistoryStartInitEnd ( )

Definition at line 274 of file TimeHistoryMng2.cc.

◆ versionInfo()

VersionInfo Arcane::TimeHistoryMng2::versionInfo ( ) const

inlineoverridevirtual

Module version.

Reimplemented from Arcane::AbstractModule.

Definition at line 161 of file TimeHistoryMng2.cc.

Member Data Documentation

◆ m_internal

Ref<ITimeHistoryMngInternal> Arcane::TimeHistoryMng2::m_internal

private

Definition at line 230 of file TimeHistoryMng2.cc.

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

TimeHistoryMng2.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimeHistoryMng2()

Member Function Documentation

◆ _internalApi()

◆ active()

◆ addCurveWriter()

◆ addValue() [1/6]

◆ addValue() [2/6]

◆ addValue() [3/6]

◆ addValue() [4/6]

◆ addValue() [5/6]

◆ addValue() [6/6]

◆ applyTransformation()

◆ dumpCurves()

◆ dumpHistory()

◆ isDumpActive()

◆ isShrinkActive()

◆ removeCurveWriter() [1/2]

◆ removeCurveWriter() [2/2]

◆ setActive()

◆ setDumpActive()

◆ setShrinkActive()

◆ timeHistoryBegin()

◆ timeHistoryContinueInit()

◆ timeHistoryEnd()

◆ timeHistoryInit()

◆ timeHistoryRestore()

◆ timeHistoryStartInit()

◆ timeHistoryStartInitEnd()

◆ versionInfo()

Member Data Documentation

◆ m_internal