Référence de la classe Arcane::MeshTimeHistoryAdder

Classe permettant d'ajouter une ou plusieurs valeurs à un historique de valeurs. Plus de détails...

#include <arcane/core/MeshTimeHistoryAdder.h>

Graphe d'héritage de Arcane::MeshTimeHistoryAdder:

Graphe de collaboration de Arcane::MeshTimeHistoryAdder:

Fonctions membres publiques
	MeshTimeHistoryAdder (ITimeHistoryMng *time_history_mng, const MeshHandle &mesh_handle)
	Constructeur.
void	addValue (const TimeHistoryAddValueArg &thp, Real value) override
	Méthode permettant d'ajouter une valeur à un historique.
void	addValue (const TimeHistoryAddValueArg &thp, Int32 value) override
	Méthode permettant d'ajouter une valeur à un historique.
void	addValue (const TimeHistoryAddValueArg &thp, Int64 value) override
	Méthode permettant d'ajouter une valeur à un historique.
void	addValue (const TimeHistoryAddValueArg &thp, RealConstArrayView values) override
	Méthode permettant d'ajouter des valeurs à un historique.
void	addValue (const TimeHistoryAddValueArg &thp, Int32ConstArrayView values) override
	Méthode permettant d'ajouter des valeurs à un historique.
void	addValue (const TimeHistoryAddValueArg &thp, Int64ConstArrayView values) override
	Méthode permettant d'ajouter des valeurs à un historique.
Fonctions membres publiques hérités de Arcane::ITimeHistoryAdder
virtual	~ITimeHistoryAdder ()=default
	Libère les ressources.

Attributs privés
ITimeHistoryMng *	m_thm
MeshHandle	m_mesh_handle

Description détaillée

Classe permettant d'ajouter une ou plusieurs valeurs à un historique de valeurs.

Cette classe enregistrera les courbes avec comme support un maillage. C'est-à-dire que les courbes seront liées à un maillage, en plus d'être liées au domaine complet ou au sous-domaine demandé. Si le lien au maillage n'est pas désiré, la classe GlobalTimeHistoryAdder peut être plus intéressante.

Pour un nom d'historique donné, il peut y avoir qu'une courbe de une ou plusieurs valeurs par maillage et par sous-domaine (et une globale à tous les sous-domaines).

Exemple : plusieurs courbes de moyennes des pressions (appelons-les "avg_pressure"), deux sous-domaines (0 et 1) et deux maillages (mesh0 et mesh1). Une valeur par itération.

• Une courbe "avg_pressure" liée au sous-domaine 0 et au maillage 0. Chaque valeur est la moyenne des pressions de chaque maille du maillage 0 et du sous-domaine 0.
• Une courbe "avg_pressure" liée au sous-domaine 0 et au maillage 1. Chaque valeur est la moyenne des pressions de chaque maille du maillage 1 et du sous-domaine 0.
• Une courbe "avg_pressure" liée au sous-domaine 1 et au maillage 0. Chaque valeur est la moyenne des pressions de chaque maille du maillage 0 et du sous-domaine 1.
• Une courbe "avg_pressure" liée au sous-domaine 1 et au maillage 1. Chaque valeur est la moyenne des pressions de chaque maille du maillage 1 et du sous-domaine 1.
• Une courbe "avg_pressure" liée au domaine complet et au maillage 0. Chaque valeur est la moyenne des pressions du maillage 0 de chaque sous-domaine.
• Une courbe "avg_pressure" liée au domaine complet et au maillage 1. Chaque valeur est la moyenne des pressions du maillage 1 de chaque sous-domaine.

On peut remarquer qu'il est possible d'avoir plusieurs courbes indépendantes avec le même nom mais liée à des maillages différents et à des sous-domaines différents (+1 courbe globale). Et il est important de souligner que ce même nom peut être aussi utilisé avec les courbes de GlobalTimeHistoryAdder indépendement, donc l'exemple ci-dessus peut être complémentaire avec celui donné dans la description de GlobalTimeHistoryAdder ! (donc possiblement 9 courbes indépendantes mais de même nom !)

Définition à la ligne 74 du fichier MeshTimeHistoryAdder.h.

Documentation des constructeurs et destructeur

MeshTimeHistoryAdder()

Arcane::MeshTimeHistoryAdder::MeshTimeHistoryAdder	(	ITimeHistoryMng *	time_history_mng,
		const MeshHandle &	mesh_handle
	)

Constructeur.

Paramètres

time_history_mng	Un pointeur vers une instance de ITimeHistoryMng.
mesh_handle	Le maillage à lier aux courbes.

Définition à la ligne 26 du fichier MeshTimeHistoryAdder.cc.

Références Arcane::ITimeHistoryMng::_internalApi().

Documentation des fonctions membres

addValue() [1/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg &  thp, Int32  value  )

overridevirtual

Méthode permettant d'ajouter une valeur à un historique.

Paramètres

thpi	Les paramètres de la valeur.
value	La valeur à ajouter.

Implémente Arcane::ITimeHistoryAdder.

Définition à la ligne 46 du fichier MeshTimeHistoryAdder.cc.

Références Arcane::ITimeHistoryMng::_internalApi().

addValue() [2/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg &  thp, Int32ConstArrayView  values  )

overridevirtual

Méthode permettant d'ajouter des valeurs à un historique.

Paramètres

thpi	Les paramètres des valeurs.
value	Les valeurs à ajouter.

Implémente Arcane::ITimeHistoryAdder.

Définition à la ligne 58 du fichier MeshTimeHistoryAdder.cc.

Références Arcane::ITimeHistoryMng::_internalApi().

addValue() [3/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg &  thp, Int64  value  )

overridevirtual

Méthode permettant d'ajouter une valeur à un historique.

Paramètres

thpi	Les paramètres de la valeur.
value	La valeur à ajouter.

Implémente Arcane::ITimeHistoryAdder.

Définition à la ligne 40 du fichier MeshTimeHistoryAdder.cc.

Références Arcane::ITimeHistoryMng::_internalApi().

addValue() [4/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg &  thp, Int64ConstArrayView  values  )

overridevirtual

Méthode permettant d'ajouter des valeurs à un historique.

Paramètres

thpi	Les paramètres des valeurs.
value	Les valeurs à ajouter.

Implémente Arcane::ITimeHistoryAdder.

Définition à la ligne 64 du fichier MeshTimeHistoryAdder.cc.

Références Arcane::ITimeHistoryMng::_internalApi().

addValue() [5/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg &  thp, Real  value  )

overridevirtual

Méthode permettant d'ajouter une valeur à un historique.

Paramètres

thpi	Les paramètres de la valeur.
value	La valeur à ajouter.

Implémente Arcane::ITimeHistoryAdder.

Définition à la ligne 34 du fichier MeshTimeHistoryAdder.cc.

Références Arcane::ITimeHistoryMng::_internalApi().

addValue() [6/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg &  thp, RealConstArrayView  values  )

overridevirtual

Méthode permettant d'ajouter des valeurs à un historique.

Paramètres

thpi	Les paramètres des valeurs.
value	Les valeurs à ajouter.

Implémente Arcane::ITimeHistoryAdder.

Définition à la ligne 52 du fichier MeshTimeHistoryAdder.cc.

Références Arcane::ITimeHistoryMng::_internalApi().

Documentation des données membres

m_mesh_handle

MeshHandle Arcane::MeshTimeHistoryAdder::m_mesh_handle

private

Définition à la ligne 100 du fichier MeshTimeHistoryAdder.h.

m_thm

ITimeHistoryMng* Arcane::MeshTimeHistoryAdder::m_thm

private

Définition à la ligne 99 du fichier MeshTimeHistoryAdder.h.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• MeshTimeHistoryAdder.h
• MeshTimeHistoryAdder.cc