Historique de valeurs du type T. Plus de détails...

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

Graphe d'héritage de Arcane::TimeHistoryValueT< DataType >:

Graphe de collaboration de Arcane::TimeHistoryValueT< DataType >:

Types publics
typedef VariableRefArrayT< DataType >	ValueList

typedef VariableRefArrayT< Int32 >	IterationList

Fonctions membres publiques
	TimeHistoryValueT (IVariableMng *vm, const TimeHistoryAddValueArgInternal &thpi, Integer index, Integer nb_element, bool shrink)
	Constructeur permettant de construire un historique de valeur non lié à un maillage.

	TimeHistoryValueT (const TimeHistoryAddValueArgInternal &thpi, Integer index, Integer nb_element, bool shrink)
	Constructeur permettant de construire un historique de valeur lié à un maillage.

void	fromOldToNewVariables (IVariableMng vm, IMesh default_mesh) override
	Méthode permettant de convertir les variables d'anciennes sauvegardes vers le nouveau format.

Integer	size () const override
	Méthode permettant de récupérer le nombre de valeurs enregistrées.

void	addValue (ConstArrayView< DataType > values, Integer iteration)
	Méthode permettant d'ajouter des valeurs à une itération.

void	removeAfterIteration (Integer last_iteration) override
	Méthode permettant de retirer toutes les valeurs après une certaine itération.

void	dumpValues (ITraceMng msg, ITimeHistoryCurveWriter2 writer, const TimeHistoryCurveWriterInfo &infos) const override
	Imprime les valeurs de l'historique avec l'écrivain writer.

void	applyTransformation (ITraceMng msg, ITimeHistoryTransformer v) override
	Méthode permettant d'appliquer une transformation sur les valeurs de l'historique de valeur.

void	arrayToWrite (UniqueArray< Int32 > &iterations, UniqueArray< Real > &values, const TimeHistoryCurveWriterInfo &infos) const override
	Méthode permettant de récupérer les itérations et les valeurs d'un historique de valeur.

const ValueList &	values () const

const IterationList &	iterations () const

Fonctions membres publiques hérités de Arcane::TimeHistoryValue
	TimeHistoryValue (const TimeHistoryAddValueArgInternal &thpi, eDataType dt, Integer index, Integer sub_size)

virtual	~TimeHistoryValue ()=default
	Libére les ressources.

const String &	name () const
	Nom de l'historique.

eDataType	dataType () const
	Type de données de l'historique.

Integer	index () const
	Index de l'historique dans la liste.

Integer	subSize () const

const MeshHandle &	meshHandle () const
	Méthode permettant de récupérer le MeshHandle enregistré.

bool	isLocal () const
	Méthode permettant de savoir si c'est un historique global ou local à un sous-domaine.

Integer	localProcId () const
	Méthode permettant de récupérer l'id du sous-domaine à qui appartient cet historique.

Attributs publics
const int	VAR_BUILD_FLAGS = IVariable::PNoRestore \| IVariable::PExecutionDepend \| IVariable::PNoReplicaSync

Attributs publics statiques
static const Integer	COMPRESSED_TAG = -15

Attributs privés
ValueList	m_values

IterationList	m_iterations

bool	m_use_compression

bool	m_shrink_history

Description détaillée

template<typename DataType>
class Arcane::TimeHistoryValueT< DataType >

Historique de valeurs du type T.

Actuellement, on ne support que trois types de valeurs: Real, Int32 et Int64.

Un historique est composé d'un tableau de couples (x,y) avec x le numéro de l'itération et y la valeur de l'historique.

Les historiques doivent être rangées par ordre croissant d'itération.

Définition à la ligne 179 du fichier TimeHistoryMngInternal.h.

Documentation des définitions de type membres

◆ IterationList

template<typename DataType >

typedef VariableRefArrayT<Int32> Arcane::TimeHistoryValueT< DataType >::IterationList

Définition à la ligne 195 du fichier TimeHistoryMngInternal.h.

◆ ValueList

template<typename DataType >

typedef VariableRefArrayT<DataType> Arcane::TimeHistoryValueT< DataType >::ValueList

Définition à la ligne 194 du fichier TimeHistoryMngInternal.h.

Documentation des constructeurs et destructeur

◆ TimeHistoryValueT() [1/2]

template<typename DataType >

Arcane::TimeHistoryValueT< DataType >::TimeHistoryValueT	(	IVariableMng *	vm,
		const TimeHistoryAddValueArgInternal &	thpi,
		Integer	index,
		Integer	nb_element,
		bool	shrink
	)

inline

Constructeur permettant de construire un historique de valeur non lié à un maillage.

Paramètres

vm	Le variableMng pour créer les variables.
thpi	Les arguments pour créer l'historique.
index	L'index des variables globales.
nb_element	Le nombre de valeurs par itération.
shrink	S'il y a compression.

Définition à la ligne 213 du fichier TimeHistoryMngInternal.h.

◆ TimeHistoryValueT() [2/2]

template<typename DataType >

Arcane::TimeHistoryValueT< DataType >::TimeHistoryValueT	(	const TimeHistoryAddValueArgInternal &	thpi,
		Integer	index,
		Integer	nb_element,
		bool	shrink
	)

inline

Constructeur permettant de construire un historique de valeur lié à un maillage.

Paramètres

thpi	Les arguments pour créer l'historique.
index	L'index des variables globales.
nb_element	Le nombre de valeurs par itération.
shrink	S'il y a compression.

Définition à la ligne 230 du fichier TimeHistoryMngInternal.h.

Documentation des fonctions membres

◆ addValue()

template<typename DataType >

void Arcane::TimeHistoryValueT< DataType >::addValue	(	ConstArrayView< DataType >	values,
		Integer	iteration
	)

inline

Méthode permettant d'ajouter des valeurs à une itération.

Paramètres

values	Les valeurs à ajouter.
iteration	L'itération liée aux valeurs.

Définition à la ligne 272 du fichier TimeHistoryMngInternal.h.

Références Arcane::math::max(), Arcane::VariableRefArrayT< T >::resizeWithReserve(), et Arccore::ArrayView< T >::size().

◆ applyTransformation()

template<typename DataType >

void Arcane::TimeHistoryValueT< DataType >::applyTransformation	(	ITraceMng *	msg,
		ITimeHistoryTransformer *	v
	)

inlineoverridevirtual

Méthode permettant d'appliquer une transformation sur les valeurs de l'historique de valeur.

Paramètres

msg	Le traceMng où écrire les messages.
v	Le transformer.

Implémente Arcane::TimeHistoryValue.

Définition à la ligne 335 du fichier TimeHistoryMngInternal.h.

Références Arcane::TimeHistoryValue::name(), Arcane::VariableRefArrayT< T >::resize(), Arcane::ITimeHistoryTransformer::transform(), et Arccore::TraceAccessor::warning().

◆ arrayToWrite()

template<typename DataType >

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

inlineoverridevirtual

Méthode permettant de récupérer les itérations et les valeurs d'un historique de valeur.

Paramètres

iterations	[OUT] Les itérations où ont été récupérer chaque valeur.
values	[OUT] Les valeurs récupérées.
infos	Les informations nécessaire à la récupération de l'historique.

Implémente Arcane::TimeHistoryValue.

Définition à la ligne 364 du fichier TimeHistoryMngInternal.h.

Références Arccore::ArrayView< T >::size(), Arccore::ConstArrayView< T >::size(), Arcane::TimeHistoryCurveWriterInfo::times(), et Arcane::Convert::toReal().

Référencé par Arcane::TimeHistoryValueT< DataType >::dumpValues().

◆ dumpValues()

template<typename DataType >

void Arcane::TimeHistoryValueT< DataType >::dumpValues	(	ITraceMng *	msg,
		ITimeHistoryCurveWriter2 *	writer,
		const TimeHistoryCurveWriterInfo &	infos
	)		const

inlineoverridevirtual

Imprime les valeurs de l'historique avec l'écrivain writer.

Implémente Arcane::TimeHistoryValue.

Définition à la ligne 309 du fichier TimeHistoryMngInternal.h.

Références Arcane::TimeHistoryValueT< DataType >::arrayToWrite(), Arcane::TimeHistoryValue::localProcId(), Arcane::TimeHistoryValue::meshHandle(), et Arcane::TimeHistoryValue::name().

◆ fromOldToNewVariables()

template<typename DataType >

void Arcane::TimeHistoryValueT< DataType >::fromOldToNewVariables	(	IVariableMng *	vm,
		IMesh *	default_mesh
	)

inlineoverridevirtual

Méthode permettant de convertir les variables d'anciennes sauvegardes vers le nouveau format.

Paramètres

vm	Le VariableMng.
default_mesh	Le maillage par défaut.

Implémente Arcane::TimeHistoryValue.

Définition à la ligne 241 du fichier TimeHistoryMngInternal.h.

Références ARCANE_FATAL, Arccore::ArrayView< T >::copy(), Arcane::TimeHistoryValue::index(), et Arcane::VariableRefArrayT< T >::resize().

◆ iterations()

template<typename DataType >

const IterationList & Arcane::TimeHistoryValueT< DataType >::iterations ( ) const

inline

Définition à la ligne 387 du fichier TimeHistoryMngInternal.h.

◆ removeAfterIteration()

template<typename DataType >

void Arcane::TimeHistoryValueT< DataType >::removeAfterIteration ( Integer last_iteration )

inlineoverridevirtual

Méthode permettant de retirer toutes les valeurs après une certaine itération.

Paramètres

last_iteration La dernière itération voulu.

Implémente Arcane::TimeHistoryValue.

Définition à la ligne 293 du fichier TimeHistoryMngInternal.h.

Références Arcane::VariableRefArrayT< T >::resize(), Arccore::ArrayView< T >::size(), et Arcane::TimeHistoryValueT< DataType >::size().

◆ size()

template<typename DataType >

Integer Arcane::TimeHistoryValueT< DataType >::size ( ) const

inlineoverridevirtual

Méthode permettant de récupérer le nombre de valeurs enregistrées.

Renvoie: Le nombre de valeurs enregistrées.

Implémente Arcane::TimeHistoryValue.

Définition à la ligne 261 du fichier TimeHistoryMngInternal.h.

Références Arccore::ArrayView< T >::size().

Référencé par Arcane::TimeHistoryValueT< DataType >::removeAfterIteration().

◆ values()

template<typename DataType >

const ValueList & Arcane::TimeHistoryValueT< DataType >::values ( ) const

inline

Définition à la ligne 386 du fichier TimeHistoryMngInternal.h.

Documentation des données membres

◆ COMPRESSED_TAG

template<typename DataType >

const Integer Arcane::TimeHistoryValueT< DataType >::COMPRESSED_TAG = -15

static

Définition à la ligne 196 du fichier TimeHistoryMngInternal.h.

◆ m_iterations

template<typename DataType >

IterationList Arcane::TimeHistoryValueT< DataType >::m_iterations

private

Définition à la ligne 392 du fichier TimeHistoryMngInternal.h.

◆ m_shrink_history

template<typename DataType >

bool Arcane::TimeHistoryValueT< DataType >::m_shrink_history

private

Définition à la ligne 394 du fichier TimeHistoryMngInternal.h.

◆ m_use_compression

template<typename DataType >

bool Arcane::TimeHistoryValueT< DataType >::m_use_compression

private

Définition à la ligne 393 du fichier TimeHistoryMngInternal.h.

◆ m_values

template<typename DataType >

ValueList Arcane::TimeHistoryValueT< DataType >::m_values

private

Définition à la ligne 391 du fichier TimeHistoryMngInternal.h.

◆ VAR_BUILD_FLAGS

template<typename DataType >

const int Arcane::TimeHistoryValueT< DataType >::VAR_BUILD_FLAGS = IVariable::PNoRestore | IVariable::PExecutionDepend | IVariable::PNoReplicaSync

Définition à la ligne 200 du fichier TimeHistoryMngInternal.h.

La documentation de cette classe a été générée à partir du fichier suivant :

TimeHistoryMngInternal.h

Types publics

Fonctions membres publiques

Attributs publics

Attributs publics statiques

Attributs privés

Description détaillée

Documentation des définitions de type membres

◆ IterationList

◆ ValueList

Documentation des constructeurs et destructeur

◆ TimeHistoryValueT() [1/2]

◆ TimeHistoryValueT() [2/2]

Documentation des fonctions membres

◆ addValue()

◆ applyTransformation()

◆ arrayToWrite()

◆ dumpValues()

◆ fromOldToNewVariables()

◆ iterations()

◆ removeAfterIteration()

◆ size()

◆ values()

Documentation des données membres

◆ COMPRESSED_TAG

◆ m_iterations

◆ m_shrink_history

◆ m_use_compression

◆ m_values

◆ VAR_BUILD_FLAGS