Types publics
typedef T	ValueType

typedef IScalarDataT< T >	ValueDataType

typedef VariableScalarT< T >	ThatClass

typedef Variable	BaseClass

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
void	synchronize () override
	Synchronise la variable.

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

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

Integer	nbElement () const override
	Nombre d'éléments de la variable.

ValueType &	value ()

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

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

IData *	data () override
	Données associées à la variable.

const IData *	data () const override
	Données associées à la variable.

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

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

void	compact (Int32ConstArrayView new_to_old_ids) override
	Compacte les valeurs de la variable.

void	setIsSynchronized () override
	Indique que la variable est synchronisée.

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

void	swapValues (ThatClass &rhs)

Fonctions membres publiques hérités de Arcane::Variable
	~Variable () override
	Libère les ressources.

	Variable (const Variable &from)=delete
	Constructeur de recopie (ne pas utiliser)

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

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

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

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

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

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 Arcane::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.

Fonctions membres publiques statiques
static ThatClass *	getReference (const VariableBuildInfo &v, const VariableInfo &vi)

static ThatClass *	getReference (IVariable *var)

static Int64	incrementModifiedTime ()
	Incrémente le compteur de modification et retourne sa valeur avant modification.

Fonctions membres protégées
	VariableScalarT (const VariableBuildInfo &v, const VariableInfo &vi)
	Construit une variable basée sur la référence v.

void	_internalResize (const VariableResizeArgs &resize_args) override

VariableComparerResults	_compareVariable (const VariableComparerArgs &compare_args) final
	Comparaison de valeurs entre variables.

Fonctions membres protégées hérités de Arcane::Variable
	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.

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	_resize (const VariableResizeArgs &resize_args)

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

Int32	_localVerboseLevel () const

Membres hérités additionnels
Attributs publics statiques hérités de Arcane::IVariable
static const char *	TAG_POST_PROCESSING = "PostProcessing"
	Tag utilisé pour indiquer si une variable sera post-traitée.

static const char *	TAG_POST_PROCESSING_AT_THIS_ITERATION = "PostProcessingAtThisIteration"
	Tag utilisé pour indiquer si une variable sera post-traitée à cette itération.

Description détaillée

template<class T>
class Arcane::VariableScalarT< T >

Définition à la ligne 32 du fichier VariableScalar.h.

Documentation des définitions de type membres

◆ BaseClass

template<class T>

typedef Variable Arcane::VariableScalarT< T >::BaseClass

Définition à la ligne 40 du fichier VariableScalar.h.

◆ ThatClass

template<class T>

typedef VariableScalarT<T> Arcane::VariableScalarT< T >::ThatClass

Définition à la ligne 39 du fichier VariableScalar.h.

◆ ValueDataType

template<class T>

typedef IScalarDataT<T> Arcane::VariableScalarT< T >::ValueDataType

Définition à la ligne 38 du fichier VariableScalar.h.

◆ ValueType

template<class T>

typedef T Arcane::VariableScalarT< T >::ValueType

Définition à la ligne 37 du fichier VariableScalar.h.

Documentation des constructeurs et destructeur

◆ VariableScalarT()

template<typename T>

Arcane::VariableScalarT< T >::VariableScalarT	(	const VariableBuildInfo &	v,
		const VariableInfo &	vi )

protected

Construit une variable basée sur la référence v.

Définition à la ligne 168 du fichier VariableScalar.cc.

Références Arcane::Variable::_setData(), data(), Arcane::TraceAccessor::info(), Arcane::makeRef(), et Arcane::Variable::Variable().

Documentation des fonctions membres

◆ _compareVariable()

template<typename T>

VariableComparerResults Arcane::VariableScalarT< T >::_compareVariable ( const VariableComparerArgs & compare_args )

finalprotectedvirtual

Comparaison de valeurs entre variables.

Implémente Arcane::Variable.

Définition à la ligne 243 du fichier VariableScalar.cc.

Références ARCANE_CHECK_POINTER, ARCANE_FATAL, Arcane::Ref< InstanceType, ImplTagId >::get(), Arcane::IK_Particle, Arcane::Variable::itemKind(), Arcane::IDataReader::read(), Arcane::Same, Arcane::SameOnAllReplica, et Arcane::Sync.

◆ _internalResize()

template<class T>

void Arcane::VariableScalarT< T >::_internalResize ( const VariableResizeArgs & resize_args )

inlineoverrideprotectedvirtual

Implémente Arcane::Variable.

Définition à la ligne 80 du fichier VariableScalar.h.

◆ allocatedMemory()

template<typename T>

Real Arcane::VariableScalarT< T >::allocatedMemory ( ) const

overridevirtual

Taille mémoire (en Koctet) utilisée par la variable.

Implémente Arcane::IVariable.

Définition à la ligne 305 du fichier VariableScalar.cc.

◆ compact()

template<typename T>

void Arcane::VariableScalarT< T >::compact ( Int32ConstArrayView new_to_old_ids )

overridevirtual

Compacte les valeurs de la variable.

Cette opération est interne à Arcane et doit se faire en conjonction avec la famille d'entité correspondant à cette variable.

Implémente Arcane::IVariable.

Définition à la ligne 337 du fichier VariableScalar.cc.

◆ copyItemsMeanValues()

template<typename T>

void Arcane::VariableScalarT< T >::copyItemsMeanValues	(	Int32ConstArrayView	first_source,
		Int32ConstArrayView	second_source,
		Int32ConstArrayView	destination )

overridevirtual

Copie les moyennes des valeurs des entités numéros first_source et second_source dans les entités numéros destination.

Paramètres

first_source	liste des localId de la 1ère source
second_source	liste des localId de la 2ème source
destination	liste des localId destination

Implémente Arcane::IVariable.

Définition à la ligne 324 du fichier VariableScalar.cc.

◆ copyItemsValues()

template<typename T>

void Arcane::VariableScalarT< T >::copyItemsValues	(	Int32ConstArrayView	source,
		Int32ConstArrayView	destination )

overridevirtual

Copie les valeurs des entités numéros source dans les entités numéro destination.

Note: Cette opération est interne à Arcane et doit se faire en conjonction avec la famille d'entité correspondant à cette variable.

Paramètres

source	liste des localId source
destination	liste des localId destination

Implémente Arcane::IVariable.

Définition à la ligne 314 du fichier VariableScalar.cc.

◆ data() [1/2]

template<class T>

const IData * Arcane::VariableScalarT< T >::data ( ) const

inlineoverridevirtual

Données associées à la variable.

Implémente Arcane::IVariable.

Définition à la ligne 62 du fichier VariableScalar.h.

◆ data() [2/2]

template<class T>

IData * Arcane::VariableScalarT< T >::data ( )

inlineoverridevirtual

Données associées à la variable.

Implémente Arcane::IVariable.

Définition à la ligne 61 du fichier VariableScalar.h.

Référencé par VariableScalarT().

◆ getReference() [1/2]

template<typename T>

auto Arcane::VariableScalarT< T >::getReference	(	const VariableBuildInfo &	v,
		const VariableInfo &	vi )

static

Définition à la ligne 184 du fichier VariableScalar.cc.

◆ getReference() [2/2]

template<typename T>

VariableScalarT< T > * Arcane::VariableScalarT< T >::getReference ( IVariable * var )

static

Définition à la ligne 203 du fichier VariableScalar.cc.

◆ nbElement()

template<class T>

Integer Arcane::VariableScalarT< T >::nbElement ( ) const

inlineoverridevirtual

Nombre d'éléments de la variable.

Les valeurs retournées dépendent de la dimension de la variable:

pour une dimension 0, retourne 1,
pour une dimension 1, retourne le nombre d'éléments du tableau
pour une dimension 2, retourne le nombre total d'éléments en sommant le nombre d'éléments par dimension.

Implémente Arcane::IVariable.

Définition à la ligne 57 du fichier VariableScalar.h.

◆ print()

template<typename T>

void Arcane::VariableScalarT< T >::print ( std::ostream & o ) const

overridevirtual

Imprime les valeurs de la variable sur le flot o.

Implémente Arcane::IVariable.

Définition à la ligne 277 du fichier VariableScalar.cc.

◆ setIsSynchronized() [1/2]

template<typename T>

void Arcane::VariableScalarT< T >::setIsSynchronized ( )

overridevirtual

Indique que la variable est synchronisée.

Cette opération est collective.

Implémente Arcane::IVariable.

Définition à la ligne 346 du fichier VariableScalar.cc.

◆ setIsSynchronized() [2/2]

template<typename T>

void Arcane::VariableScalarT< T >::setIsSynchronized ( const ItemGroup & item_group )

overridevirtual

Indique que la variable est synchronisée sur le group item_group.

Cette opération est collective.

Implémente Arcane::IVariable.

Définition à la ligne 354 du fichier VariableScalar.cc.

◆ shrinkMemory()

template<class T>

void Arcane::VariableScalarT< T >::shrinkMemory ( )

inlineoverridevirtual

Libère l'éventuelle mémoire supplémentaire allouée pour les données.

Cette méthode n'est utilie que pour les variables non scalaires

Implémente Arcane::IVariable.

Définition à la ligne 59 du fichier VariableScalar.h.

◆ swapValues()

template<typename DataType>

void Arcane::VariableScalarT< DataType >::swapValues ( ThatClass & rhs )

Définition à la ligne 364 du fichier VariableScalar.cc.

◆ synchronize() [1/2]

template<typename T>

void Arcane::VariableScalarT< T >::synchronize ( )

overridevirtual

Synchronise la variable.

La synchronisation ne peut se faire que sur les variables du maillage.

Implémente Arcane::IVariable.

Définition à la ligne 286 du fichier VariableScalar.cc.

◆ synchronize() [2/2]

template<typename T>

void Arcane::VariableScalarT< T >::synchronize ( Int32ConstArrayView local_ids )

overridevirtual

Synchronise la variable sur une liste d'entités.

La synchronisation ne peut se faire que sur les variables du maillage. Seules les entités listées dans local_ids seront synchronisées. Attention : une entité présente dans cette liste sur un sous-domaine doit être présente dans cette liste pour tout autre sous-domaine qui possède cette entité.

Réimplémentée à partir de Arcane::IVariable.

Définition à la ligne 295 du fichier VariableScalar.cc.

◆ value()

template<class T>

ValueType & Arcane::VariableScalarT< T >::value ( )

inline

Définition à la ligne 58 du fichier VariableScalar.h.

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

Types publics

Fonctions membres publiques

Fonctions membres publiques statiques

Fonctions membres protégées

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ BaseClass

◆ ThatClass

◆ ValueDataType

◆ ValueType

Documentation des constructeurs et destructeur

◆ VariableScalarT()

Documentation des fonctions membres

◆ _compareVariable()

◆ _internalResize()

◆ allocatedMemory()

◆ compact()

◆ copyItemsMeanValues()

◆ copyItemsValues()

◆ data() [1/2]

◆ data() [2/2]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ nbElement()

◆ print()

◆ setIsSynchronized() [1/2]

◆ setIsSynchronized() [2/2]

◆ shrinkMemory()

◆ swapValues()

◆ synchronize() [1/2]

◆ synchronize() [2/2]

◆ value()