Inheritance diagram for Arcane::TimeHistoryMngInternal:

Collaboration diagram for Arcane::TimeHistoryMngInternal:

Public Types
typedef std::map< String, TimeHistoryValue * >	HistoryList
typedef std::set< Ref< ITimeHistoryCurveWriter2 > >	CurveWriter2List
typedef HistoryList::value_type	HistoryValueType

Public Member Functions
	TimeHistoryMngInternal (IVariableMng *vm, const Ref< Properties > &properties)
void	addValue (const TimeHistoryAddValueArgInternal &thpi, Real value) override
	Method allowing a value to be added to a history.
void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int64 value) override
	Method allowing a value to be added to a history.
void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int32 value) override
	Method allowing a value to be added to a history.
void	addValue (const TimeHistoryAddValueArgInternal &thpi, RealConstArrayView values) override
	Method allowing values to be added to a history.
void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int32ConstArrayView values) override
	Method allowing values to be added to a history.
void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int64ConstArrayView values) override
	Method allowing values to be added to a history.
void	addNowInGlobalTime () override
	Method allowing the current GlobalTime to be added to the GlobalTimes array.
void	updateGlobalTimeCurve () override
	Method allowing the GlobalTime array to be copied into the global GlobalTime variable.
void	resizeArrayAfterRestore () override
	Method allowing the value arrays to be resized after a restart.
void	dumpCurves (ITimeHistoryCurveWriter2 *writer) override
	Method allowing curves to be written using the provided writer.
void	dumpHistory () override
	Method allowing all curves to be written using all registered writers.
void	updateMetaData () override
	Method allowing the curve metadata to be updated.
void	readVariables (IMeshMng mesh_mng, IMesh default_mesh) override
	Method allowing previously written curves to be retrieved during a restart.
void	addCurveWriter (Ref< ITimeHistoryCurveWriter2 > writer) override
	Method allowing a writer to be added for curve output.
void	removeCurveWriter (const String &name) override
	Method allowing a writer to be removed.
void	applyTransformation (ITimeHistoryTransformer *v) override
	Applies the transformation v to all curves.
void	addObservers (IPropertyMng *prop_mng) override
	Method allowing observers saving the history before a checkpoint to be added.
void	editOutputPath (const Directory &directory) override
	Method allowing the curve output directory to be changed.
void	iterationsAndValues (const TimeHistoryAddValueArgInternal &thpi, UniqueArray< Int32 > &iterations, UniqueArray< Real > &values) override
	Method allowing the iterations and values of a history to be outputted.
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.
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	isMasterIO () override
	Method allowing to know if our process is the writer.
bool	isMasterIOOfSubDomain () override
	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).
bool	isNonIOMasterCurvesEnabled () override
	Method allowing to know if all processes can have a value history.
bool	isIOMasterWriteOnly () override
	Method allowing to know if only the master process calls the writers.
void	setIOMasterWriteOnly (bool is_active) override
	Method allowing to define if only the master process calls the writers.
Public Member Functions inherited from Arcane::ITimeHistoryMngInternal
virtual	~ITimeHistoryMngInternal ()=default
	Releases resources.

Private Member Functions
template<class DataType>
void	_addHistoryValue (const TimeHistoryAddValueArgInternal &thpi, ConstArrayView< DataType > values)
	Method allowing values to be added to a value history.
void	_destroyAll ()
	Destructor.
void	_dumpCurvesAllWriters ()
	Method allowing all curves to be dumped with all writers.
void	_dumpSummaryOfCurvesLegacy ()
	Method allowing an XML file to be dumped with the name of each curve output in GNUPLOT format.
void	_dumpSummaryOfCurves ()
	Method allowing a JSON file to be dumped with the name of each curve output in GNUPLOT format as well as several other information.
void	_fromLegacyFormat (IMesh *default_mesh)
	Method allowing conversion from the old format to the new.
void	_saveProperties ()
	Method allowing saving the properties of the metadata.
void	_removeCurveWriter (const Ref< ITimeHistoryCurveWriter2 > &writer)
	Method allowing removal of a writer.

Private Attributes
IVariableMng *	m_variable_mng
ITraceMng *	m_trace_mng
IParallelMng *	m_parallel_mng
CommonVariables	m_common_variables
Directory	m_directory
bool	m_is_master_io
	True if I am the IO manager.
bool	m_is_master_io_of_sd
	True if I am the IO manager for my subdomain.
bool	m_enable_non_io_master_curves
	Indicates if curve writing by non-io_master procs is possible.
bool	m_is_active
	Indicates if the service is active.
bool	m_is_shrink_active
	Indicates if history compression is active.
bool	m_is_dump_active
	Indicates if dumps are active.
bool	m_io_master_write_only
	Indicates if writers must be called by all processes.
bool	m_need_comm
	Indicates if at least one curve is non-local (thus requiring communications).
String	m_output_path
ObserverPool	m_observer_pool
HistoryList	m_history_list
	List of histories.
VariableScalarString	m_th_meta_data
	History info.
VariableArrayReal	m_th_global_time
	Array of time instants.
RealUniqueArray	m_global_times
	List of global times.
CurveWriter2List	m_curve_writers2
Ref< Properties >	m_properties
Integer	m_version

Detailed Description

Definition at line 401 of file TimeHistoryMngInternal.h.

Member Typedef Documentation

◆ CurveWriter2List

typedef std::set<Ref<ITimeHistoryCurveWriter2> > Arcane::TimeHistoryMngInternal::CurveWriter2List

Definition at line 448 of file TimeHistoryMngInternal.h.

◆ HistoryList

typedef std::map<String, TimeHistoryValue*> Arcane::TimeHistoryMngInternal::HistoryList

Definition at line 447 of file TimeHistoryMngInternal.h.

◆ HistoryValueType

typedef HistoryList::value_type Arcane::TimeHistoryMngInternal::HistoryValueType

Definition at line 449 of file TimeHistoryMngInternal.h.

Constructor & Destructor Documentation

◆ TimeHistoryMngInternal()

Arcane::TimeHistoryMngInternal::TimeHistoryMngInternal	(	IVariableMng *	vm,
		const Ref< Properties > &	properties )

inlineexplicit

Definition at line 406 of file TimeHistoryMngInternal.h.

◆ ~TimeHistoryMngInternal()

Arcane::TimeHistoryMngInternal::~TimeHistoryMngInternal ( )

inlineoverride

Definition at line 439 of file TimeHistoryMngInternal.h.

Member Function Documentation

◆ _addHistoryValue()

template<class DataType>

template void Arcane::TimeHistoryMngInternal::_addHistoryValue< Int64 >	(	const TimeHistoryAddValueArgInternal &	thpi,
		ConstArrayView< DataType >	values )

private

Method allowing values to be added to a value history.

Template Parameters

DataType The values to be added.

Parameters

thpi	The parameters for adding values.
values	The values to be added.

Definition at line 708 of file TimeHistoryMngInternal.cc.

References Arcane::TimeHistoryValueT< DataType >::addValue(), ARCANE_FATAL, Arcane::String::clone(), Arcane::MeshHandle::isNull(), isShrinkActive(), m_enable_non_io_master_curves, m_history_list, m_is_active, m_is_master_io, m_is_master_io_of_sd, m_need_comm, and Arcane::ConstArrayView< T >::size().

Referenced by addValue(), addValue(), addValue(), addValue(), addValue(), and addValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _destroyAll()

void Arcane::TimeHistoryMngInternal::_destroyAll ( )

private

Destructor.

Definition at line 768 of file TimeHistoryMngInternal.cc.

References m_history_list.

◆ _dumpCurvesAllWriters()

void Arcane::TimeHistoryMngInternal::_dumpCurvesAllWriters ( )

private

Method allowing all curves to be dumped with all writers.

Definition at line 491 of file TimeHistoryMngInternal.cc.

References dumpCurves(), Arcane::platform::getCurrentDateTime(), m_enable_non_io_master_curves, m_is_master_io, m_is_master_io_of_sd, and Arcane::ITimeHistoryCurveWriter2::name().

Referenced by dumpHistory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _dumpSummaryOfCurves()

void Arcane::TimeHistoryMngInternal::_dumpSummaryOfCurves ( )

private

Method allowing a JSON file to be dumped with the name of each curve output in GNUPLOT format as well as several other information.

Definition at line 592 of file TimeHistoryMngInternal.cc.

References Arcane::arcaneCheckArraySize(), Arcane::Directory::file(), Arcane::TimeHistoryValue::isLocal(), Arcane::MeshHandle::isNull(), Arcane::String::length(), Arcane::String::localstr(), m_enable_non_io_master_curves, m_history_list, m_io_master_write_only, m_is_master_io, m_is_master_io_of_sd, m_need_comm, Arcane::TimeHistoryValue::meshHandle(), Arcane::TimeHistoryValue::name(), and Arcane::Array< T >::unguardedBasePointer().

Referenced by dumpHistory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _dumpSummaryOfCurvesLegacy()

void Arcane::TimeHistoryMngInternal::_dumpSummaryOfCurvesLegacy ( )

private

Method allowing an XML file to be dumped with the name of each curve output in GNUPLOT format.

Definition at line 512 of file TimeHistoryMngInternal.cc.

References Arcane::arcaneCheckArraySize(), Arcane::TimeHistoryValue::isLocal(), Arcane::MeshHandle::isNull(), Arcane::String::length(), Arcane::String::localstr(), m_enable_non_io_master_curves, m_history_list, m_io_master_write_only, m_is_master_io, m_is_master_io_of_sd, m_need_comm, Arcane::TimeHistoryValue::meshHandle(), Arcane::TimeHistoryValue::name(), and Arcane::Array< T >::unguardedBasePointer().

Referenced by dumpHistory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _fromLegacyFormat()

void Arcane::TimeHistoryMngInternal::_fromLegacyFormat ( IMesh * default_mesh )

private

Method allowing conversion from the old format to the new.

Parameters

default_mesh The default mesh on which the old values are linked.

Definition at line 780 of file TimeHistoryMngInternal.cc.

References ARCANE_FATAL, m_th_global_time, m_th_meta_data, Arcane::VariableRefScalarT< DataType >::reset(), Arcane::VariableRefArrayT< T >::resize(), and Arcane::ArrayView< T >::size().

Referenced by readVariables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _removeCurveWriter()

void Arcane::TimeHistoryMngInternal::_removeCurveWriter ( const Ref< ITimeHistoryCurveWriter2 > & writer )

private

Method allowing removal of a writer.

Parameters

writer The reference of the writer.

Definition at line 802 of file TimeHistoryMngInternal.cc.

Referenced by removeCurveWriter().

Here is the caller graph for this function:

◆ _saveProperties()

void Arcane::TimeHistoryMngInternal::_saveProperties ( )

private

Method allowing saving the properties of the metadata.

Definition at line 107 of file TimeHistoryMngInternal.cc.

Referenced by addObservers().

Here is the caller graph for this function:

◆ active()

bool Arcane::TimeHistoryMngInternal::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::ITimeHistoryMngInternal.

Definition at line 503 of file TimeHistoryMngInternal.h.

References m_is_active.

◆ addCurveWriter()

void Arcane::TimeHistoryMngInternal::addCurveWriter ( Ref< ITimeHistoryCurveWriter2 > writer )

overridevirtual

Method allowing a writer to be added for curve output.

Parameters

writer A reference to the writer.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 30 of file TimeHistoryMngInternal.cc.

References m_enable_non_io_master_curves, m_is_master_io, and m_is_master_io_of_sd.

◆ addNowInGlobalTime()

void Arcane::TimeHistoryMngInternal::addNowInGlobalTime ( )

overridevirtual

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

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 117 of file TimeHistoryMngInternal.cc.

References addValue(), and m_global_times.

Here is the call graph for this function:

◆ addObservers()

void Arcane::TimeHistoryMngInternal::addObservers ( IPropertyMng * prop_mng )

overridevirtual

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

Parameters

prop_mng A pointer to an IPropertyMng.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 92 of file TimeHistoryMngInternal.cc.

References _saveProperties(), updateMetaData(), and Arcane::IPropertyMng::writeObservable().

Here is the call graph for this function:

◆ addValue() [1/6]

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

inlineoverridevirtual

Method allowing a value to be added to a history.

Parameters

thpi	History parameters.
value	The value to add.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 463 of file TimeHistoryMngInternal.h.

References _addHistoryValue().

Here is the call graph for this function:

◆ addValue() [2/6]

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

inlineoverridevirtual

Method allowing values to be added to a history.

Parameters

thpi	History parameters.
value	The values to add.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 472 of file TimeHistoryMngInternal.h.

References _addHistoryValue().

Here is the call graph for this function:

◆ addValue() [3/6]

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

inlineoverridevirtual

Method allowing a value to be added to a history.

Parameters

thpi	History parameters.
value	The value to add.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 458 of file TimeHistoryMngInternal.h.

References _addHistoryValue().

Here is the call graph for this function:

◆ addValue() [4/6]

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

inlineoverridevirtual

Method allowing values to be added to a history.

Parameters

thpi	History parameters.
value	The values to add.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 476 of file TimeHistoryMngInternal.h.

References _addHistoryValue().

Here is the call graph for this function:

◆ addValue() [5/6]

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

inlineoverridevirtual

Method allowing a value to be added to a history.

Parameters

thpi	History parameters.
value	The value to add.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 453 of file TimeHistoryMngInternal.h.

References _addHistoryValue().

Referenced by addNowInGlobalTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addValue() [6/6]

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

inlineoverridevirtual

Method allowing values to be added to a history.

Parameters

thpi	History parameters.
value	The values to add.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 468 of file TimeHistoryMngInternal.h.

References _addHistoryValue().

Here is the call graph for this function:

◆ applyTransformation()

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

overridevirtual

Applies the transformation v to all curves.

Parameters

v	The transformation to apply.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 272 of file TimeHistoryMngInternal.cc.

References Arcane::TimeHistoryValue::applyTransformation(), m_enable_non_io_master_curves, m_history_list, m_is_master_io, and m_is_master_io_of_sd.

Here is the call graph for this function:

◆ dumpCurves()

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

overridevirtual

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.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 138 of file TimeHistoryMngInternal.cc.

References ARCANE_FATAL, Arcane::arcaneCheckArraySize(), Arcane::TimeHistoryValue::arrayToWrite(), Arcane::ITimeHistoryCurveWriter2::beginWrite(), Arcane::TimeHistoryValue::dumpValues(), Arcane::ITimeHistoryCurveWriter2::endWrite(), Arcane::MeshHandle::isNull(), Arcane::String::length(), Arcane::String::localstr(), m_enable_non_io_master_curves, m_global_times, m_history_list, m_io_master_write_only, m_is_master_io, m_is_master_io_of_sd, m_need_comm, Arcane::TimeHistoryValue::meshHandle(), Arcane::TimeHistoryValue::name(), Arcane::MessagePassing::ReduceMin, Arcane::AbstractArray< T >::size(), Arcane::Array< T >::unguardedBasePointer(), and Arcane::ITimeHistoryCurveWriter2::writeCurve().

Referenced by _dumpCurvesAllWriters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dumpHistory()

void Arcane::TimeHistoryMngInternal::dumpHistory ( )

overridevirtual

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

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 254 of file TimeHistoryMngInternal.cc.

References _dumpCurvesAllWriters(), _dumpSummaryOfCurves(), _dumpSummaryOfCurvesLegacy(), Arcane::platform::getCurrentDateTime(), m_enable_non_io_master_curves, m_is_dump_active, m_is_master_io, and m_is_master_io_of_sd.

Here is the call graph for this function:

◆ editOutputPath()

void Arcane::TimeHistoryMngInternal::editOutputPath ( const Directory & directory )

overridevirtual

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.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 436 of file TimeHistoryMngInternal.cc.

◆ isDumpActive()

bool Arcane::TimeHistoryMngInternal::isDumpActive ( ) const

inlineoverridevirtual

Indicates the output activation status.

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

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 505 of file TimeHistoryMngInternal.h.

References m_is_dump_active.

◆ isIOMasterWriteOnly()

bool Arcane::TimeHistoryMngInternal::isIOMasterWriteOnly ( )

inlineoverridevirtual

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

Returns: true if yes

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 510 of file TimeHistoryMngInternal.h.

References m_io_master_write_only.

◆ isMasterIO()

bool Arcane::TimeHistoryMngInternal::isMasterIO ( )

inlineoverridevirtual

Method allowing to know if our process is the writer.

Returns: True if we are the writer.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 507 of file TimeHistoryMngInternal.h.

References m_is_master_io.

◆ isMasterIOOfSubDomain()

bool Arcane::TimeHistoryMngInternal::isMasterIOOfSubDomain ( )

inlineoverridevirtual

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.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 508 of file TimeHistoryMngInternal.h.

References m_is_master_io_of_sd.

◆ isNonIOMasterCurvesEnabled()

bool Arcane::TimeHistoryMngInternal::isNonIOMasterCurvesEnabled ( )

inlineoverridevirtual

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

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 509 of file TimeHistoryMngInternal.h.

References m_enable_non_io_master_curves.

◆ isShrinkActive()

bool Arcane::TimeHistoryMngInternal::isShrinkActive ( ) const

inlineoverridevirtual

Returns a boolean indicating if the history is compressed.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 501 of file TimeHistoryMngInternal.h.

References m_is_shrink_active.

Referenced by _addHistoryValue(), and readVariables().

Here is the caller graph for this function:

◆ iterationsAndValues()

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

overridevirtual

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.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 451 of file TimeHistoryMngInternal.cc.

References Arcane::Array< T >::clear(), Arcane::String::clone(), Arcane::MeshHandle::isNull(), m_enable_non_io_master_curves, m_global_times, m_history_list, m_is_active, m_is_master_io, and m_is_master_io_of_sd.

Here is the call graph for this function:

◆ readVariables()

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

overridevirtual

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).

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 286 of file TimeHistoryMngInternal.cc.

References _fromLegacyFormat(), ARCANE_FATAL, Arcane::XmlNode::attr(), Arcane::XmlNode::child(), Arcane::XmlNode::children(), Arcane::dataTypeFromName(), Arcane::DT_Int32, Arcane::DT_Int64, Arcane::DT_Real, Arcane::IMeshMng::findMeshHandle(), Arcane::TimeHistoryValue::fromOldToNewVariables(), Arcane::PtrT< T >::get(), isShrinkActive(), Arcane::String::localstr(), m_global_times, m_history_list, m_need_comm, m_th_global_time, m_th_meta_data, Arcane::String::null(), Arcane::XmlNode::null(), Arcane::IIOMng::parseXmlString(), and Arcane::XmlNode::valueAsInteger().

Here is the call graph for this function:

◆ removeCurveWriter()

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

overridevirtual

Method allowing a writer to be removed.

Parameters

writer The name of the writer.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 41 of file TimeHistoryMngInternal.cc.

References _removeCurveWriter().

Here is the call graph for this function:

◆ resizeArrayAfterRestore()

void Arcane::TimeHistoryMngInternal::resizeArrayAfterRestore ( )

overridevirtual

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

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 408 of file TimeHistoryMngInternal.cc.

References m_global_times, m_history_list, and m_th_global_time.

◆ setActive()

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

inlineoverridevirtual

Sets the activation status.

See also: active().

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 504 of file TimeHistoryMngInternal.h.

References m_is_active.

◆ setDumpActive()

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

inlineoverridevirtual

Sets the output activation status.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 506 of file TimeHistoryMngInternal.h.

References m_is_dump_active.

◆ setIOMasterWriteOnly()

void Arcane::TimeHistoryMngInternal::setIOMasterWriteOnly ( bool is_active )

inlineoverridevirtual

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

Parameters

is_active True if yes.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 511 of file TimeHistoryMngInternal.h.

References m_io_master_write_only.

◆ setShrinkActive()

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

inlineoverridevirtual

Sets the boolean indicating if the history is compressed.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 502 of file TimeHistoryMngInternal.h.

References m_is_shrink_active.

◆ updateGlobalTimeCurve()

void Arcane::TimeHistoryMngInternal::updateGlobalTimeCurve ( )

overridevirtual

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

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 128 of file TimeHistoryMngInternal.cc.

References m_global_times, and m_th_global_time.

Referenced by updateMetaData().

Here is the caller graph for this function:

◆ updateMetaData()

void Arcane::TimeHistoryMngInternal::updateMetaData ( )

overridevirtual

Method allowing the curve metadata to be updated.

Implements Arcane::ITimeHistoryMngInternal.

Definition at line 54 of file TimeHistoryMngInternal.cc.

References Arcane::TimeHistoryValue::dataType(), Arcane::dataTypeName(), Arcane::TimeHistoryValue::index(), Arcane::TimeHistoryValue::isLocal(), Arcane::MeshHandle::isNull(), Arcane::TimeHistoryValue::localSubDomainId(), m_history_list, m_th_meta_data, Arcane::TimeHistoryValue::meshHandle(), Arcane::TimeHistoryValue::name(), and updateGlobalTimeCurve().

Referenced by addObservers().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_common_variables

CommonVariables Arcane::TimeHistoryMngInternal::m_common_variables

private

Definition at line 571 of file TimeHistoryMngInternal.h.

◆ m_curve_writers2

CurveWriter2List Arcane::TimeHistoryMngInternal::m_curve_writers2

private

Definition at line 589 of file TimeHistoryMngInternal.h.

◆ m_directory

Directory Arcane::TimeHistoryMngInternal::m_directory

private

Definition at line 572 of file TimeHistoryMngInternal.h.

◆ m_enable_non_io_master_curves

bool Arcane::TimeHistoryMngInternal::m_enable_non_io_master_curves

private

Indicates if curve writing by non-io_master procs is possible.

Definition at line 576 of file TimeHistoryMngInternal.h.

Referenced by _addHistoryValue(), _dumpCurvesAllWriters(), _dumpSummaryOfCurves(), _dumpSummaryOfCurvesLegacy(), addCurveWriter(), applyTransformation(), dumpCurves(), dumpHistory(), isNonIOMasterCurvesEnabled(), and iterationsAndValues().

◆ m_global_times

RealUniqueArray Arcane::TimeHistoryMngInternal::m_global_times

private

List of global times.

Definition at line 588 of file TimeHistoryMngInternal.h.

Referenced by addNowInGlobalTime(), dumpCurves(), iterationsAndValues(), readVariables(), resizeArrayAfterRestore(), and updateGlobalTimeCurve().

◆ m_history_list

HistoryList Arcane::TimeHistoryMngInternal::m_history_list

private

List of histories.

Definition at line 585 of file TimeHistoryMngInternal.h.

Referenced by _addHistoryValue(), _destroyAll(), _dumpSummaryOfCurves(), _dumpSummaryOfCurvesLegacy(), applyTransformation(), dumpCurves(), iterationsAndValues(), readVariables(), resizeArrayAfterRestore(), and updateMetaData().

◆ m_io_master_write_only

bool Arcane::TimeHistoryMngInternal::m_io_master_write_only

private

Indicates if writers must be called by all processes.

Definition at line 580 of file TimeHistoryMngInternal.h.

Referenced by _dumpSummaryOfCurves(), _dumpSummaryOfCurvesLegacy(), dumpCurves(), isIOMasterWriteOnly(), and setIOMasterWriteOnly().

◆ m_is_active

bool Arcane::TimeHistoryMngInternal::m_is_active

private

Indicates if the service is active.

Definition at line 577 of file TimeHistoryMngInternal.h.

Referenced by _addHistoryValue(), active(), iterationsAndValues(), and setActive().

◆ m_is_dump_active

bool Arcane::TimeHistoryMngInternal::m_is_dump_active

private

Indicates if dumps are active.

Definition at line 579 of file TimeHistoryMngInternal.h.

Referenced by dumpHistory(), isDumpActive(), and setDumpActive().

◆ m_is_master_io

bool Arcane::TimeHistoryMngInternal::m_is_master_io

private

True if I am the IO manager.

Definition at line 574 of file TimeHistoryMngInternal.h.

Referenced by _addHistoryValue(), _dumpCurvesAllWriters(), _dumpSummaryOfCurves(), _dumpSummaryOfCurvesLegacy(), addCurveWriter(), applyTransformation(), dumpCurves(), dumpHistory(), isMasterIO(), and iterationsAndValues().

◆ m_is_master_io_of_sd

bool Arcane::TimeHistoryMngInternal::m_is_master_io_of_sd

private

True if I am the IO manager for my subdomain.

Definition at line 575 of file TimeHistoryMngInternal.h.

Referenced by _addHistoryValue(), _dumpCurvesAllWriters(), _dumpSummaryOfCurves(), _dumpSummaryOfCurvesLegacy(), addCurveWriter(), applyTransformation(), dumpCurves(), dumpHistory(), isMasterIOOfSubDomain(), and iterationsAndValues().

◆ m_is_shrink_active

bool Arcane::TimeHistoryMngInternal::m_is_shrink_active

private

Indicates if history compression is active.

Definition at line 578 of file TimeHistoryMngInternal.h.

Referenced by isShrinkActive(), and setShrinkActive().

◆ m_need_comm

bool Arcane::TimeHistoryMngInternal::m_need_comm

private

Indicates if at least one curve is non-local (thus requiring communications).

Definition at line 581 of file TimeHistoryMngInternal.h.

Referenced by _addHistoryValue(), _dumpSummaryOfCurves(), _dumpSummaryOfCurvesLegacy(), dumpCurves(), and readVariables().

◆ m_observer_pool

ObserverPool Arcane::TimeHistoryMngInternal::m_observer_pool

private

Definition at line 584 of file TimeHistoryMngInternal.h.

◆ m_output_path

String Arcane::TimeHistoryMngInternal::m_output_path

private

Definition at line 583 of file TimeHistoryMngInternal.h.

◆ m_parallel_mng

IParallelMng* Arcane::TimeHistoryMngInternal::m_parallel_mng

private

Definition at line 570 of file TimeHistoryMngInternal.h.

◆ m_properties

Ref<Properties> Arcane::TimeHistoryMngInternal::m_properties

private

Definition at line 590 of file TimeHistoryMngInternal.h.

◆ m_th_global_time

VariableArrayReal Arcane::TimeHistoryMngInternal::m_th_global_time

private

Array of time instants.

Definition at line 587 of file TimeHistoryMngInternal.h.

Referenced by _fromLegacyFormat(), readVariables(), resizeArrayAfterRestore(), and updateGlobalTimeCurve().

◆ m_th_meta_data

VariableScalarString Arcane::TimeHistoryMngInternal::m_th_meta_data

private

History info.

Definition at line 586 of file TimeHistoryMngInternal.h.

Referenced by _fromLegacyFormat(), readVariables(), and updateMetaData().

◆ m_trace_mng

ITraceMng* Arcane::TimeHistoryMngInternal::m_trace_mng

private

Definition at line 569 of file TimeHistoryMngInternal.h.

◆ m_variable_mng

IVariableMng* Arcane::TimeHistoryMngInternal::m_variable_mng

private

Definition at line 568 of file TimeHistoryMngInternal.h.

◆ m_version

Integer Arcane::TimeHistoryMngInternal::m_version

private

Definition at line 591 of file TimeHistoryMngInternal.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CurveWriter2List

◆ HistoryList

◆ HistoryValueType

Constructor & Destructor Documentation

◆ TimeHistoryMngInternal()

◆ ~TimeHistoryMngInternal()

Member Function Documentation

◆ _addHistoryValue()

◆ _destroyAll()

◆ _dumpCurvesAllWriters()

◆ _dumpSummaryOfCurves()

◆ _dumpSummaryOfCurvesLegacy()

◆ _fromLegacyFormat()

◆ _removeCurveWriter()

◆ _saveProperties()

◆ 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()

Member Data Documentation

◆ m_common_variables

◆ m_curve_writers2

◆ m_directory

◆ m_enable_non_io_master_curves

◆ m_global_times

◆ m_history_list

◆ m_io_master_write_only

◆ m_is_active

◆ m_is_dump_active

◆ m_is_master_io

◆ m_is_master_io_of_sd

◆ m_is_shrink_active

◆ m_need_comm

◆ m_observer_pool

◆ m_output_path

◆ m_parallel_mng

◆ m_properties

◆ m_th_global_time

◆ m_th_meta_data

◆ m_trace_mng

◆ m_variable_mng

◆ m_version