Base class for a value history. More...

#include <arcane/impl/internal/TimeHistoryMngInternal.h>

Inheritance diagram for Arcane::TimeHistoryValue:

Collaboration diagram for Arcane::TimeHistoryValue:

Public Member Functions
	TimeHistoryValue (const TimeHistoryAddValueArgInternal &thpi, eDataType dt, Integer index, Integer sub_size)
virtual	~TimeHistoryValue ()=default
	Frees resources.
virtual void	fromOldToNewVariables (IVariableMng vm, IMesh default_mesh)=0
	Method allowing the conversion of variables from old saves to the new format.
virtual void	dumpValues (ITraceMng msg, ITimeHistoryCurveWriter2 writer, const TimeHistoryCurveWriterInfo &infos) const =0
	Prints the history values using the writer writer.
virtual void	arrayToWrite (UniqueArray< Int32 > &iterations, UniqueArray< Real > &values, const TimeHistoryCurveWriterInfo &infos) const =0
	Method allowing the retrieval of iterations and values from a value history.
virtual void	applyTransformation (ITraceMng msg, ITimeHistoryTransformer v)=0
	Method allowing the application of a transformation on the values of the value history.
virtual Integer	size () const =0
	Method allowing the retrieval of the number of recorded values.
virtual void	removeAfterIteration (Integer last_iteration)=0
	Method allowing the removal of all values after a certain iteration.
const String &	name () const
	History name.
eDataType	dataType () const
	History data type.
Integer	index () const
	History index in the list.
Integer	subSize () const
const MeshHandle &	meshHandle () const
	Method allowing the retrieval of the registered MeshHandle.
bool	isLocal () const
	Method allowing determination if it is a global history or local to a subdomain.
Integer	localSubDomainId () const
	Method allowing the retrieval of the subdomain ID to which this history belongs.

Private Attributes
eDataType	m_data_type
	Data type.
Integer	m_index
	History index in the list.
Integer	m_sub_size
TimeHistoryAddValueArgInternal	m_thpi

Detailed Description

Base class for a value history.

A history contains a set of values for certain iterations. It is characterized by a name.

Definition at line 58 of file TimeHistoryMngInternal.h.

Constructor & Destructor Documentation

◆ TimeHistoryValue()

Arcane::TimeHistoryValue::TimeHistoryValue	(	const TimeHistoryAddValueArgInternal &	thpi,
		eDataType	dt,
		Integer	index,
		Integer	sub_size )

inline

Definition at line 62 of file TimeHistoryMngInternal.h.

Member Function Documentation

◆ applyTransformation()

virtual void Arcane::TimeHistoryValue::applyTransformation	(	ITraceMng *	msg,
		ITimeHistoryTransformer *	v )

pure virtual

Method allowing the application of a transformation on the values of the value history.

Parameters

msg	The traceMng where messages should be written.
v	The transformer.

Implemented in Arcane::TimeHistoryValueT< DataType >.

Referenced by Arcane::TimeHistoryMngInternal::applyTransformation().

Here is the caller graph for this function:

◆ arrayToWrite()

virtual void Arcane::TimeHistoryValue::arrayToWrite	(	UniqueArray< Int32 > &	iterations,
		UniqueArray< Real > &	values,
		const TimeHistoryCurveWriterInfo &	infos ) const

pure virtual

Method allowing the retrieval of iterations and values from a value history.

Parameters

iterations	[OUT] The iterations where each value was retrieved.
values	[OUT] The retrieved values.
infos	The information necessary to retrieve the history.

Implemented in Arcane::TimeHistoryValueT< DataType >.

Referenced by Arcane::TimeHistoryMngInternal::dumpCurves().

Here is the caller graph for this function:

◆ dataType()

eDataType Arcane::TimeHistoryValue::dataType ( ) const

inline

History data type.

Definition at line 126 of file TimeHistoryMngInternal.h.

References m_data_type.

Referenced by Arcane::TimeHistoryMngInternal::updateMetaData().

Here is the caller graph for this function:

◆ dumpValues()

virtual void Arcane::TimeHistoryValue::dumpValues	(	ITraceMng *	msg,
		ITimeHistoryCurveWriter2 *	writer,
		const TimeHistoryCurveWriterInfo &	infos ) const

pure virtual

Prints the history values using the writer writer.

Implemented in Arcane::TimeHistoryValueT< DataType >.

Referenced by Arcane::TimeHistoryMngInternal::dumpCurves().

Here is the caller graph for this function:

◆ fromOldToNewVariables()

virtual void Arcane::TimeHistoryValue::fromOldToNewVariables	(	IVariableMng *	vm,
		IMesh *	default_mesh )

pure virtual

Method allowing the conversion of variables from old saves to the new format.

Parameters

vm	The VariableMng.
default_mesh	The default mesh.

Implemented in Arcane::TimeHistoryValueT< DataType >.

Referenced by Arcane::TimeHistoryMngInternal::readVariables().

Here is the caller graph for this function:

◆ index()

Integer Arcane::TimeHistoryValue::index ( ) const

inline

History index in the list.

Definition at line 129 of file TimeHistoryMngInternal.h.

References m_index.

Referenced by Arcane::TimeHistoryValueT< DataType >::fromOldToNewVariables(), Arcane::TimeHistoryValueT< DataType >::TimeHistoryValueT(), Arcane::TimeHistoryValueT< DataType >::TimeHistoryValueT(), and Arcane::TimeHistoryMngInternal::updateMetaData().

Here is the caller graph for this function:

◆ isLocal()

bool Arcane::TimeHistoryValue::isLocal ( ) const

inline

Method allowing determination if it is a global history or local to a subdomain.

See also: localProcId()

Returns: true if it is a local history.

Definition at line 148 of file TimeHistoryMngInternal.h.

Referenced by Arcane::TimeHistoryMngInternal::_dumpSummaryOfCurves(), Arcane::TimeHistoryMngInternal::_dumpSummaryOfCurvesLegacy(), and Arcane::TimeHistoryMngInternal::updateMetaData().

Here is the caller graph for this function:

◆ localSubDomainId()

Integer Arcane::TimeHistoryValue::localSubDomainId ( ) const

inline

Method allowing the retrieval of the subdomain ID to which this history belongs.

Returns: The subdomain ID.

Definition at line 155 of file TimeHistoryMngInternal.h.

Referenced by Arcane::TimeHistoryValueT< DataType >::dumpValues(), and Arcane::TimeHistoryMngInternal::updateMetaData().

Here is the caller graph for this function:

◆ meshHandle()

const MeshHandle & Arcane::TimeHistoryValue::meshHandle ( ) const

inline

Method allowing the retrieval of the registered MeshHandle.

Note: For global histories, this MeshHandle is null!

Returns: The MeshHandle.

Definition at line 140 of file TimeHistoryMngInternal.h.

Referenced by Arcane::TimeHistoryMngInternal::_dumpSummaryOfCurves(), Arcane::TimeHistoryMngInternal::_dumpSummaryOfCurvesLegacy(), Arcane::TimeHistoryMngInternal::dumpCurves(), Arcane::TimeHistoryValueT< DataType >::dumpValues(), Arcane::TimeHistoryValueT< DataType >::TimeHistoryValueT(), and Arcane::TimeHistoryMngInternal::updateMetaData().

Here is the caller graph for this function:

◆ name()

const String & Arcane::TimeHistoryValue::name ( ) const

inline

History name.

Definition at line 123 of file TimeHistoryMngInternal.h.

Referenced by Arcane::TimeHistoryMngInternal::_dumpSummaryOfCurves(), Arcane::TimeHistoryMngInternal::_dumpSummaryOfCurvesLegacy(), Arcane::TimeHistoryValueT< DataType >::applyTransformation(), Arcane::TimeHistoryMngInternal::dumpCurves(), Arcane::TimeHistoryValueT< DataType >::dumpValues(), and Arcane::TimeHistoryMngInternal::updateMetaData().

Here is the caller graph for this function:

◆ removeAfterIteration()

virtual void Arcane::TimeHistoryValue::removeAfterIteration ( Integer last_iteration )

pure virtual

Method allowing the removal of all values after a certain iteration.

Parameters

last_iteration The desired last iteration.

Implemented in Arcane::TimeHistoryValueT< DataType >.

◆ size()

virtual Integer Arcane::TimeHistoryValue::size ( ) const

pure virtual

Method allowing the retrieval of the number of recorded values.

Returns: The number of recorded values.

Implemented in Arcane::TimeHistoryValueT< DataType >.

◆ subSize()

Integer Arcane::TimeHistoryValue::subSize ( ) const

inline

Definition at line 131 of file TimeHistoryMngInternal.h.

Member Data Documentation

◆ m_data_type

eDataType Arcane::TimeHistoryValue::m_data_type

private

Data type.

Definition at line 159 of file TimeHistoryMngInternal.h.

Referenced by dataType().

◆ m_index

Integer Arcane::TimeHistoryValue::m_index

private

History index in the list.

Definition at line 160 of file TimeHistoryMngInternal.h.

Referenced by index().

◆ m_sub_size

Integer Arcane::TimeHistoryValue::m_sub_size

private

Definition at line 161 of file TimeHistoryMngInternal.h.

◆ m_thpi

TimeHistoryAddValueArgInternal Arcane::TimeHistoryValue::m_thpi

private

Definition at line 162 of file TimeHistoryMngInternal.h.

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

TimeHistoryMngInternal.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimeHistoryValue()

Member Function Documentation

◆ applyTransformation()

◆ arrayToWrite()

◆ dataType()

◆ dumpValues()

◆ fromOldToNewVariables()

◆ index()

◆ isLocal()

◆ localSubDomainId()

◆ meshHandle()

◆ name()

◆ removeAfterIteration()

◆ size()

◆ subSize()

Member Data Documentation

◆ m_data_type

◆ m_index

◆ m_sub_size

◆ m_thpi