Interface for the internal part of a value history manager. More...

#include <arcane/core/internal/ITimeHistoryMngInternal.h>

Inheritance diagram for Arcane::ITimeHistoryMngInternal:

Collaboration diagram for Arcane::ITimeHistoryMngInternal:

Public Member Functions
virtual	~ITimeHistoryMngInternal ()=default
	Releases resources.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Real value)=0
	Method allowing a value to be added to a history.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int32 value)=0
	Method allowing a value to be added to a history.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int64 value)=0
	Method allowing a value to be added to a history.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, RealConstArrayView values)=0
	Method allowing values to be added to a history.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int32ConstArrayView values)=0
	Method allowing values to be added to a history.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int64ConstArrayView values)=0
	Method allowing values to be added to a history.
virtual void	addNowInGlobalTime ()=0
	Method allowing the current GlobalTime to be added to the GlobalTimes array.
virtual void	updateGlobalTimeCurve ()=0
	Method allowing the GlobalTime array to be copied into the global GlobalTime variable.
virtual void	resizeArrayAfterRestore ()=0
	Method allowing the value arrays to be resized after a restart.
virtual void	dumpCurves (ITimeHistoryCurveWriter2 *writer)=0
	Method allowing curves to be written using the provided writer.
virtual void	dumpHistory ()=0
	Method allowing all curves to be written using all registered writers.
virtual void	updateMetaData ()=0
	Method allowing the curve metadata to be updated.
virtual void	readVariables (IMeshMng mesh_mng, IMesh default_mesh)=0
	Method allowing previously written curves to be retrieved during a restart.
virtual void	addCurveWriter (Ref< ITimeHistoryCurveWriter2 > writer)=0
	Method allowing a writer to be added for curve output.
virtual void	removeCurveWriter (const String &name)=0
	Method allowing a writer to be removed.
virtual void	applyTransformation (ITimeHistoryTransformer *v)=0
	Applies the transformation v to all curves.
virtual bool	isShrinkActive () const =0
	Returns a boolean indicating if the history is compressed.
virtual void	setShrinkActive (bool is_active)=0
	Sets the boolean indicating if the history is compressed.
virtual bool	active () const =0
	Indicates the activation status.
virtual void	setActive (bool is_active)=0
	Sets the activation status.
virtual bool	isDumpActive () const =0
	Indicates the output activation status.
virtual void	setDumpActive (bool is_active)=0
	Sets the output activation status.
virtual bool	isMasterIO ()=0
	Method allowing to know if our process is the writer.
virtual bool	isMasterIOOfSubDomain ()=0
	Method allowing to know if our process is the writer for our subdomain. In the case where replication is enabled, only one process among the replicas can write (and only if isNonIOMasterCurvesEnabled() == true).
virtual bool	isNonIOMasterCurvesEnabled ()=0
	Method allowing to know if all processes can have a value history.
virtual bool	isIOMasterWriteOnly ()=0
	Method allowing to know if only the master process calls the writers.
virtual void	setIOMasterWriteOnly (bool is_active)=0
	Method allowing to define if only the master process calls the writers.
virtual void	addObservers (IPropertyMng *prop_mng)=0
	Method allowing observers saving the history before a checkpoint to be added.
virtual void	editOutputPath (const Directory &directory)=0
	Method allowing the curve output directory to be changed.
virtual void	iterationsAndValues (const TimeHistoryAddValueArgInternal &thpi, UniqueArray< Int32 > &iterations, UniqueArray< Real > &values)=0
	Method allowing the iterations and values of a history to be outputted.

Detailed Description

Interface for the internal part of a value history manager.

Definition at line 78 of file ITimeHistoryMngInternal.h.

Member Function Documentation

◆ active()

virtual bool Arcane::ITimeHistoryMngInternal::active ( ) const

pure virtual

Indicates the activation status.

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

Implemented in Arcane::TimeHistoryMngInternal.

◆ addCurveWriter()

virtual void Arcane::ITimeHistoryMngInternal::addCurveWriter ( Ref< ITimeHistoryCurveWriter2 > writer )

pure virtual

Method allowing a writer to be added for curve output.

Parameters

writer A reference to the writer.

Implemented in Arcane::TimeHistoryMngInternal.

◆ addNowInGlobalTime()

virtual void Arcane::ITimeHistoryMngInternal::addNowInGlobalTime ( )

pure virtual

Method allowing the current GlobalTime to be added to the GlobalTimes array.

Implemented in Arcane::TimeHistoryMngInternal.

◆ addObservers()

virtual void Arcane::ITimeHistoryMngInternal::addObservers ( IPropertyMng * prop_mng )

pure virtual

Method allowing observers saving the history before a checkpoint to be added.

Parameters

prop_mng A pointer to an IPropertyMng.

Implemented in Arcane::TimeHistoryMngInternal.

◆ addValue() [1/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue	(	const TimeHistoryAddValueArgInternal &	thpi,
		Int32	value )

pure virtual

Method allowing a value to be added to a history.

Parameters

thpi	History parameters.
value	The value to add.

Implemented in Arcane::TimeHistoryMngInternal.

◆ addValue() [2/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue	(	const TimeHistoryAddValueArgInternal &	thpi,
		Int32ConstArrayView	values )

pure virtual

Method allowing values to be added to a history.

Parameters

thpi	History parameters.
value	The values to add.

Implemented in Arcane::TimeHistoryMngInternal.

◆ addValue() [3/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue	(	const TimeHistoryAddValueArgInternal &	thpi,
		Int64	value )

pure virtual

Method allowing a value to be added to a history.

Parameters

thpi	History parameters.
value	The value to add.

Implemented in Arcane::TimeHistoryMngInternal.

◆ addValue() [4/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue	(	const TimeHistoryAddValueArgInternal &	thpi,
		Int64ConstArrayView	values )

pure virtual

Method allowing values to be added to a history.

Parameters

thpi	History parameters.
value	The values to add.

Implemented in Arcane::TimeHistoryMngInternal.

◆ addValue() [5/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue	(	const TimeHistoryAddValueArgInternal &	thpi,
		Real	value )

pure virtual

Method allowing a value to be added to a history.

Parameters

thpi	History parameters.
value	The value to add.

Implemented in Arcane::TimeHistoryMngInternal.

◆ addValue() [6/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue	(	const TimeHistoryAddValueArgInternal &	thpi,
		RealConstArrayView	values )

pure virtual

Method allowing values to be added to a history.

Parameters

thpi	History parameters.
value	The values to add.

Implemented in Arcane::TimeHistoryMngInternal.

◆ applyTransformation()

virtual void Arcane::ITimeHistoryMngInternal::applyTransformation ( ITimeHistoryTransformer * v )

pure virtual

Applies the transformation v to all curves.

Parameters

v	The transformation to apply.

Implemented in Arcane::TimeHistoryMngInternal.

◆ dumpCurves()

virtual void Arcane::ITimeHistoryMngInternal::dumpCurves ( ITimeHistoryCurveWriter2 * writer )

pure virtual

Method allowing curves to be written using the provided writer.

Parameters

writer	The writer with which the curves must be written.
master_only	If all histories must be transferred to the masterIO before copying.

Implemented in Arcane::TimeHistoryMngInternal.

◆ dumpHistory()

virtual void Arcane::ITimeHistoryMngInternal::dumpHistory ( )

pure virtual

Method allowing all curves to be written using all registered writers.

Implemented in Arcane::TimeHistoryMngInternal.

◆ editOutputPath()

virtual void Arcane::ITimeHistoryMngInternal::editOutputPath ( const Directory & directory )

pure virtual

Method allowing the curve output directory to be changed.

Note that the directory will be created if it does not exist.

Parameters

directory The new output directory.

Implemented in Arcane::TimeHistoryMngInternal.

◆ isDumpActive()

virtual bool Arcane::ITimeHistoryMngInternal::isDumpActive ( ) const

pure virtual

Indicates the output activation status.

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

Implemented in Arcane::TimeHistoryMngInternal.

◆ isIOMasterWriteOnly()

virtual bool Arcane::ITimeHistoryMngInternal::isIOMasterWriteOnly ( )

pure virtual

Method allowing to know if only the master process calls the writers.

Returns: true if yes

Implemented in Arcane::TimeHistoryMngInternal.

◆ isMasterIO()

virtual bool Arcane::ITimeHistoryMngInternal::isMasterIO ( )

pure virtual

Method allowing to know if our process is the writer.

Returns: True if we are the writer.

Implemented in Arcane::TimeHistoryMngInternal.

◆ isMasterIOOfSubDomain()

virtual bool Arcane::ITimeHistoryMngInternal::isMasterIOOfSubDomain ( )

pure virtual

Method allowing to know if our process is the writer for our subdomain. In the case where replication is enabled, only one process among the replicas can write (and only if isNonIOMasterCurvesEnabled() == true).

The environment variable ARCANE_ENABLE_ALL_REPLICATS_WRITE_CURVES allows bypassing this protection and allows all processes to write.

Returns: True if we are the writer for our subdomain.

Implemented in Arcane::TimeHistoryMngInternal.

◆ isNonIOMasterCurvesEnabled()

virtual bool Arcane::ITimeHistoryMngInternal::isNonIOMasterCurvesEnabled ( )

pure virtual

Method allowing to know if all processes can have a value history.

Implemented in Arcane::TimeHistoryMngInternal.

◆ isShrinkActive()

virtual bool Arcane::ITimeHistoryMngInternal::isShrinkActive ( ) const

pure virtual

Returns a boolean indicating if the history is compressed.

Implemented in Arcane::TimeHistoryMngInternal.

◆ iterationsAndValues()

virtual void Arcane::ITimeHistoryMngInternal::iterationsAndValues	(	const TimeHistoryAddValueArgInternal &	thpi,
		UniqueArray< Int32 > &	iterations,
		UniqueArray< Real > &	values )

pure virtual

Method allowing the iterations and values of a history to be outputted.

Useful method for debug/test. Caution in domain replication mode: only the masterRank of the subdomains possess the values.

Parameters

thpi	Information necessary for retrieving the history.
iterations	[OUT] The iterations where each value was retrieved.
values	[OUT] The retrieved values.

Implemented in Arcane::TimeHistoryMngInternal.

◆ readVariables()

virtual void Arcane::ITimeHistoryMngInternal::readVariables	(	IMeshMng *	mesh_mng,
		IMesh *	default_mesh )

pure virtual

Method allowing previously written curves to be retrieved during a restart.

Parameters

mesh_mng	A pointer to a meshMng.
default_mesh	A pointer to the default mesh (only necessary for retrieving old checkpoints).

Implemented in Arcane::TimeHistoryMngInternal.

◆ removeCurveWriter()

virtual void Arcane::ITimeHistoryMngInternal::removeCurveWriter ( const String & name )

pure virtual

Method allowing a writer to be removed.

Parameters

writer The name of the writer.

Implemented in Arcane::TimeHistoryMngInternal.

◆ resizeArrayAfterRestore()

virtual void Arcane::ITimeHistoryMngInternal::resizeArrayAfterRestore ( )

pure virtual

Method allowing the value arrays to be resized after a restart.

Implemented in Arcane::TimeHistoryMngInternal.

◆ setActive()

virtual void Arcane::ITimeHistoryMngInternal::setActive ( bool is_active )

pure virtual

Sets the activation status.

See also: active().

Implemented in Arcane::TimeHistoryMngInternal.

◆ setDumpActive()

virtual void Arcane::ITimeHistoryMngInternal::setDumpActive ( bool is_active )

pure virtual

Sets the output activation status.

Implemented in Arcane::TimeHistoryMngInternal.

◆ setIOMasterWriteOnly()

virtual void Arcane::ITimeHistoryMngInternal::setIOMasterWriteOnly ( bool is_active )

pure virtual

Method allowing to define if only the master process calls the writers.

Parameters

is_active True if yes.

Implemented in Arcane::TimeHistoryMngInternal.

◆ setShrinkActive()

virtual void Arcane::ITimeHistoryMngInternal::setShrinkActive ( bool is_active )

pure virtual

Sets the boolean indicating if the history is compressed.

Implemented in Arcane::TimeHistoryMngInternal.

◆ updateGlobalTimeCurve()

virtual void Arcane::ITimeHistoryMngInternal::updateGlobalTimeCurve ( )

pure virtual

Method allowing the GlobalTime array to be copied into the global GlobalTime variable.

Implemented in Arcane::TimeHistoryMngInternal.

◆ updateMetaData()

virtual void Arcane::ITimeHistoryMngInternal::updateMetaData ( )

pure virtual

Method allowing the curve metadata to be updated.

Implemented in Arcane::TimeHistoryMngInternal.

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

ITimeHistoryMngInternal.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ active()

◆ addCurveWriter()

◆ addNowInGlobalTime()

◆ addObservers()

◆ addValue() [1/6]

◆ addValue() [2/6]

◆ addValue() [3/6]

◆ addValue() [4/6]

◆ addValue() [5/6]

◆ addValue() [6/6]

◆ applyTransformation()

◆ dumpCurves()

◆ dumpHistory()

◆ editOutputPath()

◆ isDumpActive()

◆ isIOMasterWriteOnly()

◆ isMasterIO()

◆ isMasterIOOfSubDomain()

◆ isNonIOMasterCurvesEnabled()

◆ isShrinkActive()

◆ iterationsAndValues()

◆ readVariables()

◆ removeCurveWriter()

◆ resizeArrayAfterRestore()

◆ setActive()

◆ setDumpActive()

◆ setIOMasterWriteOnly()

◆ setShrinkActive()

◆ updateGlobalTimeCurve()

◆ updateMetaData()