Instance d'une variable. Plus de détails...

#include <arcane/core/Variable.h>

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

Graphe de collaboration de Arcane::Variable:

Fonctions membres publiques
	~Variable () override
	Libère les ressources.

ISubDomain *	subDomain () override
	Sous-domaine associé à la variable (TODO rendre obsolète fin 2023)

IVariableMng *	variableMng () const override
	Gestionnaire de variable associé à la variable.

String	fullName () const final
	Nom complet de la variable (avec le préfixe de la famille)

String	name () const final
	Nom de la variable.

String	itemFamilyName () const final
	Nom de la famille associée (nul si aucune).

String	meshName () const final
	Nom du maillage associé (nul si aucun).

String	itemGroupName () const final
	Nom du groupe d'entité associée.

int	property () const override

void	notifyReferencePropertyChanged () override
	Indique que les propriétés d'une des références à cette variable ont changé (interne)

void	setUsed (bool v) override
	Positionne l'état d'utilisation de la variable.

bool	isUsed () const override
	Etat d'utilisation de la variable.

bool	isPartial () const override
	Indique si la variable est partielle.

void	setTraceInfo (Integer, eTraceType) override

void	read (IDataReader *d) override

void	write (IDataWriter *d) override
	Sauve la variable.

void	notifyEndRead () override
	Notifie de la modification externe de data().

void	notifyBeginWrite () override
	Notifie du début d'écriture de data().

void	addVariableRef (VariableRef *ref) override
	Ajoute une référence à cette variable.

void	removeVariableRef (VariableRef *ref) override
	Supprime une référence à cette variable.

VariableRef *	firstReference () const override
	Première réference (ou null) sur cette variable.

Integer	nbReference () const override
	Nombre de références sur cette variable.

VariableMetaData *	createMetaData () const override
	Créé une instance contenant les meta-données de la variable.

Ref< VariableMetaData >	createMetaDataRef () const override
	Créé une instance contenant les meta-données de la variable.

void	syncReferences () override
	Synchronise les références.

IMesh *	mesh () const final
	Maillage auquel est associé la variable.

MeshHandle	meshHandle () const final
	Maillage auquel est associé la variable.

ItemGroup	itemGroup () const final
	Groupe du maillage associé.

IItemFamily *	itemFamily () const final
	Famille d'entité associée.

eItemKind	itemKind () const override
	Type des entités du maillage sur lequel repose la variable.

Integer	dimension () const override
	Dimension de la variable.

Integer	multiTag () const override
	Indique si la variable est un tableau à taille multiple.

Integer	checkIfSync (Integer max_print) override
	Vérifie si la variable est bien synchronisée.

Integer	checkIfSameOnAllReplica (Integer max_print) override
	Vérifie si la variable a les mêmes valeurs sur tous les réplicas.

eDataType	dataType () const override
	Type de la donnée gérée par la variable (Real, Integer, ...)

bool	initialize (const ItemGroup &, const String &) override
	Initialise la variable sur un groupe.

IDataFactoryMng *	dataFactoryMng () const final
	Fabrique de données associées à la variable.

void	serialize (ISerializer sbuffer, IDataOperation operation) override

void	serialize (ISerializer sbuffer, Int32ConstArrayView ids, IDataOperation operation) override
	Sérialize la variable pour les identifiants ids.

void	resize (Integer n) override
	Positionne le nombre d'éléments pour une variable tableau.

void	resizeFromGroup () override
	Positionne le nombre d'éléments pour une variable du maillage.

void	setAllocationInfo (const DataAllocationInfo &v) override
	Positionne les informations sur l'allocation.

DataAllocationInfo	allocationInfo () const override
	Informations sur l'allocation.

IObservable *	writeObservable () override
	Observable en écriture.

IObservable *	readObservable () override
	Observable en lecture.

IObservable *	onSizeChangedObservable () override
	Observable en redimensionnement.

void	addTag (const String &tagname, const String &tagvalue) override
	Ajoute le tag tagname avev la valeur tagvalue.

void	removeTag (const String &tagname) override
	Supprime le tag tagname.

bool	hasTag (const String &tagname) override
	true si la variable possède le tag tagname

String	tagValue (const String &tagname) override
	Valeur du tag tagname. La chaîne est nulle si le tag n'existe pas.

void	update () override
	Recalcule la variable si nécessaire.

void	setUpToDate () override
	Indique que la variable vient d'être mise à jour.

Int64	modifiedTime () override
	Temps auquel la variable a été mise à jour.

void	addDepend (IVariable *var, eDependType dt) override
	Ajoute var à la liste des dépendances.

void	addDepend (IVariable *var, eDependType dt, const TraceInfo &tinfo) override
	Ajoute var à la liste des dépendances avec les infos de trace tinfo.

void	removeDepend (IVariable *var) override
	Supprime var de la liste des dépendances.

void	setComputeFunction (IVariableComputeFunction *v) override
	Positionne la fonction de recalcul de la variable.

IVariableComputeFunction *	computeFunction () override
	Fonction utilisée pour mettre à jour la variable.

void	dependInfos (Array< VariableDependInfo > &infos) override
	Infos de dépendances.

void	update (Real wanted_time) override

void	changeGroupIds (Int32ConstArrayView old_to_new_ids) override
	pH : EXPERIMENTAL

IVariableInternal *	_internalApi () override
	API interne à Arcane.

IMemoryAccessTrace *	memoryAccessTrace () const override

Fonctions membres publiques hérités de Arccore::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Construit un accesseur via le gestionnaire de trace m.

	TraceAccessor (const TraceAccessor &rhs)
	Constructeur par recopie.

TraceAccessor &	operator= (const TraceAccessor &rhs)
	Opérateur de recopie.

virtual	~TraceAccessor ()
	Libère les ressources.

ITraceMng *	traceMng () const
	Gestionnaire de trace.

TraceMessage	info () const
	Flot pour un message d'information.

TraceMessage	pinfo () const
	Flot pour un message d'information en parallèle.

TraceMessage	info (char category) const
	Flot pour un message d'information d'une catégorie donnée.

TraceMessage	pinfo (char category) const
	Flot pour un message d'information parallèle d'une catégorie donnée.

TraceMessage	info (bool v) const
	Flot pour un message d'information.

TraceMessage	warning () const
	Flot pour un message d'avertissement.

TraceMessage	pwarning () const

TraceMessage	error () const
	Flot pour un message d'erreur.

TraceMessage	perror () const

TraceMessage	log () const
	Flot pour un message de log.

TraceMessage	plog () const
	Flot pour un message de log.

TraceMessage	logdate () const
	Flot pour un message de log précédé de la date.

TraceMessage	fatal () const
	Flot pour un message d'erreur fatale.

TraceMessage	pfatal () const
	Flot pour un message d'erreur fatale en parallèle.

TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flot pour un message de debug.

Trace::eDebugLevel	configDbgLevel () const
	Niveau debug du fichier de configuration.

TraceMessage	info (Int32 verbose_level) const
	Flot pour un message d'information d'un niveau donné

TraceMessage	linfo () const
	Flot pour un message d'information avec le niveau d'information local à cette instance.

TraceMessage	linfo (Int32 relative_level) const
	Flot pour un message d'information avec le niveau d'information local à cette instance.

void	fatalMessage (const StandaloneTraceMessage &o) const

Fonctions membres publiques hérités de Arcane::IVariable
virtual	~IVariable ()=default
	Libère les ressources.

virtual Real	allocatedMemory () const =0
	Taille mémoire (en Koctet) utilisée par la variable.

virtual Integer	nbElement () const =0
	Nombre d'éléments de la variable.

virtual void	shrinkMemory ()=0
	Libère l'éventuelle mémoire supplémentaire allouée pour les données.

virtual Integer	checkIfSame (IDataReader *reader, Integer max_print, bool compare_ghost)=0
	Vérifie que la variable est identique à une valeur de référence.

virtual void	synchronize ()=0
	Synchronise la variable.

virtual void	synchronize (Int32ConstArrayView local_ids)
	Synchronise la variable sur une liste d'entités.

virtual void	copyItemsValues (Int32ConstArrayView source, Int32ConstArrayView destination)=0
	Copie les valeurs des entités numéros source dans les entités numéro destination.

virtual void	copyItemsMeanValues (Int32ConstArrayView first_source, Int32ConstArrayView second_source, Int32ConstArrayView destination)=0
	Copie les moyennes des valeurs des entités numéros first_source et second_source dans les entités numéros destination.

virtual void	compact (Int32ConstArrayView new_to_old_ids)=0
	Compacte les valeurs de la variable.

virtual IData *	data ()=0
	Données associées à la variable.

virtual const IData *	data () const =0
	Données associées à la variable.

virtual void	print (std::ostream &o) const =0
	Imprime les valeurs de la variable sur le flot o.

virtual void	setIsSynchronized ()=0
	Indique que la variable est synchronisée.

virtual void	setIsSynchronized (const ItemGroup &item_group)=0
	Indique que la variable est synchronisée sur le group item_group.

Fonctions membres protégées
	Variable (const VariableBuildInfo &v, const VariableInfo &vi)
	Créé une variable lié à la référence v.

void	_setProperty (int property)

void	_setData (const Ref< IData > &data)
	Positionne la donnée.

void	_setValidData (bool valid_data)
	Indique si les données de la variable sont valides.

bool	_hasValidData () const
	Indique si les données de la variable sont valides.

virtual void	_internalResize (Integer new_size, Integer nb_additional_element)=0

virtual Integer	_checkIfSameOnAllReplica (IParallelMng *replica_pm, int max_print)=0

void	_checkSwapIsValid (Variable *rhs)
	Vérifie qu'il est possible d'échanger les valeurs de l'instance avec celle de rhs.

bool	_wantShrink () const

void	_resizeWithReserve (Int32 new_size, Int32 additional_capacity)

Fonctions membres protégées hérités de Arccore::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)

Int32	_localVerboseLevel () const

Fonctions membres privées
	Variable (const Variable &from)=delete
	Constructeur de recopie (ne pas utiliser)

Variable &	operator= (const Variable &from)=delete
	Opérateur de recopie (ne pas utiliser)

void	_checkSetItemFamily ()

void	_checkSetItemGroup ()

void	_checkSetProperty (VariableRef *)

bool	_hasReference () const

void	_removeMeshReference ()

String	_computeComparisonHashCollective (IData *sorted_data)

VariableMetaData *	_createMetaData () const

Attributs privés
VariablePrivate *	m_p
	Implémentation.

Amis
class	VariablePrivate

Membres hérités additionnels
Types publics hérités de Arcane::IVariable
enum	eDependType { DPT_PreviousTime , DPT_CurrentTime }
	Type des dépendances. Plus de détails...

enum	{ PNoDump = (1 << 0) , PNoNeedSync = (1 << 1) , PHasTrace = (1 << 2) , PSubDomainDepend = (1 << 3) , PSubDomainPrivate = (1 << 4) , PExecutionDepend = (1 << 5) , PPrivate = (1 << 6) , PTemporary = (1 << 7) , PNoRestore = (1 << 8) , PNoExchange = (1 << 9) , PPersistant = (1 << 10) , PNoReplicaSync = (1 << 11) }
	Propriétés d'une variable. Plus de détails...

Fonctions membres publiques statiques hérités de Arcane::IVariable
static Int64	incrementModifiedTime ()
	Incrémente le compteur de modification et retourne sa valeur avant modification.

Description détaillée

Instance d'une variable.

Cette classe gère les données d'une variable. Cette instance ne doit en principe pas être utilisée par les développeurs de code.

A faire:: expliquer mieux

Une variable est caractérisée par:

son nom,
son type: réel, entier, tenseur, ...,
son genre: scalaire, tableau, grandeur au noeud, grandeur au centre des mailles ...

Une variable qui repose sur un type d'entité du maillage est appelée une variable du maillage.

La variable est généralement utilisée par un module (IModule) via une référence (VariableRef).

Les variables sont persistantes et leur lecture/écriture se fait par les méthodes read() et write().

Avertissement: Cette classe est gérée entièrement par Arcane et les modules qui l'utilisent ne doivent en principe ne l'utiliser que pour récupérer des informations. Les opérations qui modifient cette instance (comme setItemGroup()) ne doivent être utilisé que si le développeur possède une bonne connaissance de leur fonctionnement.

Cette classe ne doit pas être copiée.

Définition à la ligne 76 du fichier Variable.h.

Documentation des constructeurs et destructeur

◆ Variable()

Arcane::Variable::Variable	(	const VariableBuildInfo &	v,
		const VariableInfo &	vi
	)

protected

Créé une variable lié à la référence v.

Définition à la ligne 331 du fichier Variable.cc.

◆ ~Variable()

Arcane::Variable::~Variable ( )

override

Libère les ressources.

Définition à la ligne 341 du fichier Variable.cc.

Références m_p.

Documentation des fonctions membres

◆ _checkSetItemFamily()

void Arcane::Variable::_checkSetItemFamily ( )

private

Définition à la ligne 995 du fichier Variable.cc.

◆ _checkSetItemGroup()

void Arcane::Variable::_checkSetItemGroup ( )

private

Définition à la ligne 1045 du fichier Variable.cc.

◆ _checkSetProperty()

void Arcane::Variable::_checkSetProperty ( VariableRef * ref )

private

Définition à la ligne 428 du fichier Variable.cc.

◆ _checkSwapIsValid()

void Arcane::Variable::_checkSwapIsValid ( Variable * rhs )

protected

Vérifie qu'il est possible d'échanger les valeurs de l'instance avec celle de rhs.

Cette méthode étant appelée par une classe dérivée, on est sur que rhs est du même type C++ que l'instance et donc il n'y a pas besoin de vérifier par exemple que les dimensions ou le type des données sont les mêmes. Pour que l'échange soit valide, il faut que le maillage, la famille et le groupe soit les mêmes. Pour cela, il suffit de vérifier que le groupe est le même.

Définition à la ligne 1339 du fichier Variable.cc.

Références ARCANE_FATAL, isPartial(), itemGroup(), Arcane::VariablePrivate::m_is_used, et m_p.

◆ _createMetaData()

VariableMetaData * Arcane::Variable::_createMetaData ( ) const

private

Définition à la ligne 714 du fichier Variable.cc.

◆ _hasReference()

bool Arcane::Variable::_hasReference ( ) const

private

Définition à la ligne 352 du fichier Variable.cc.

◆ _hasValidData()

bool Arcane::Variable::_hasValidData ( ) const

protected

Indique si les données de la variable sont valides.

Les données sont valides à la fin d'un appel à setUsed().

Définition à la ligne 886 du fichier Variable.cc.

Références Arcane::VariablePrivate::m_has_valid_data, et m_p.

◆ _internalApi()

IVariableInternal * Arcane::Variable::_internalApi ( )

overridevirtual

API interne à Arcane.

group_name	groupe. Il doit correspondre à un groupe existant du type de la variable (par exemple CellGroup pour une variable au maille).
value	valeur d'initialisation. La chaîne doit pouvoir être convertie en le type de la variable.

true	en cas d'erreur ou si la variable n'est pas une variable du maillage.
false	si l'initialisation est un succès.

Fonctions membres publiques

Fonctions membres protégées

Fonctions membres privées

Attributs privés

Amis

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ Variable()

◆ ~Variable()

Documentation des fonctions membres

◆ _checkSetItemFamily()

◆ _checkSetItemGroup()

◆ _checkSetProperty()

◆ _checkSwapIsValid()

◆ _createMetaData()

◆ _hasReference()

◆ _hasValidData()

◆ _internalApi()

◆ _removeMeshReference()

◆ _resizeWithReserve()

◆ _setData()

◆ _setProperty()

◆ _setValidData()

◆ _wantShrink()

◆ addDepend() [1/2]

◆ addDepend() [2/2]

◆ addTag()

◆ addVariableRef()

◆ allocationInfo()

◆ changeGroupIds()

◆ checkIfSameOnAllReplica()

◆ checkIfSync()

◆ computeFunction()

◆ createMetaData()

◆ createMetaDataRef()

◆ dataFactoryMng()

◆ dataType()

◆ dependInfos()

◆ dimension()

◆ firstReference()

◆ fullName()

◆ hasTag()

◆ initialize()

◆ isPartial()

◆ isUsed()

◆ itemFamily()

◆ itemFamilyName()

◆ itemGroup()

◆ itemGroupName()

◆ itemKind()

◆ memoryAccessTrace()

◆ mesh()

◆ meshHandle()

◆ meshName()

◆ modifiedTime()

◆ multiTag()

◆ name()

◆ nbReference()

◆ notifyBeginWrite()

◆ notifyEndRead()

◆ notifyReferencePropertyChanged()

◆ onSizeChangedObservable()

◆ property()

◆ read()

◆ readObservable()

◆ removeDepend()

◆ removeTag()

◆ removeVariableRef()

◆ resize()

◆ resizeFromGroup()

◆ serialize() [1/2]

◆ serialize() [2/2]

◆ setAllocationInfo()

◆ setComputeFunction()

◆ setTraceInfo()

◆ setUpToDate()

◆ setUsed()

◆ subDomain()

◆ syncReferences()