Référence à une variable scalaire. Plus de détails...

#include <arcane/core/VariableRefScalar.h>

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

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

Types publics
typedef DataType	ElementType
	Type des éléments de la variable.

typedef VariableRef	BaseClass
	Type de la classe de base.

typedef VariableScalarT< DataType >	PrivatePartType

typedef VariableRefScalarT< DataType >	ThatClass

Fonctions membres publiques
	VariableRefScalarT (const VariableBuildInfo &b)
	Construit une référence à une variable scalaire spécifiée dans vb.

	VariableRefScalarT (const VariableRefScalarT< DataType > &rhs)
	Construit une référence à partir de rhs.

	VariableRefScalarT (IVariable *var)
	Construit une référence à partir de var.

void	refersTo (const VariableRefScalarT< DataType > &rhs)
	Positionne la référence de l'instance à la variable rhs.

virtual bool	isArrayVariable () const

virtual Integer	arraySize () const
	Si la variable est un tableau, retourne sa dimension, sinon retourne 0.

virtual void	updateFromInternal ()
	Mise à jour à partir de la partie interne.

ArrayView< DataType >	asArray ()

ConstArrayView< DataType >	asArray () const

void	operator= (const DataType &v)

VariableRefScalarT< DataType > &	operator= (const VariableRefScalarT< DataType > &v)

void	reset ()
	Réinitialise la variable avec sa valeur par défaut.

const DataType &	operator() () const
	Valeur du scalaire.

const DataType &	value () const
	Valeur du scalaire.

bool	isEqual (const DataType &v) const
	Compare la variable avec la valeur v.

bool	isZero () const
	Compare la variable avec la valeur 0.

bool	isNearlyEqual (const DataType &v) const
	Compare la variable avec la valeur v.

bool	isNearlyZero () const
	Compare la variable avec la valeur 0.

void	assign (const DataType &v)
	Affecte à la variable la valeur v.

void	reduce (Parallel::eReduceType type)
	Effectue une réduction de type type sur la variable.

void	swapValues (VariableRefScalarT< DataType > &rhs)
	Échange les valeurs de la variable rhs avec celles de l'instance.

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

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

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

String	name () const
	Nom de la variable.

virtual eDataType	dataType () const
	Type de la variable (Real, Integer, ...)

virtual void	print (std::ostream &o) const
	Affiche la valeur de la variable.

virtual IModule *	module () const
	Module associé à la variable (ou nullptr, s'il n'y en a pas)

virtual int	property () const
	Propriétés de la variable.

virtual int	referenceProperty () const
	Propriétés de la référence (interne)

virtual void	setProperty (int property)
	Positionne la propriété property.

virtual void	unsetProperty (int property)
	Supprime la propriété property.

virtual void	registerVariable ()
	Enregistre la variable (interne)

virtual void	unregisterVariable ()
	Supprime l'enregistrement de la variable (interne)

IVariable *	variable () const
	Variable associée.

virtual Integer	checkIfSync (int max_print=0)
	Vérifie si la variable est bien synchronisée.

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

void	setUsed (bool v)

bool	isUsed () const

virtual void	internalSetUsed (bool)

const String &	assignmentStackTrace () const
	Pile d'appel au moment de l'assignation de cette instance.

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

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

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

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

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

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

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

void	addDependCurrentTime (const VariableRef &var)
	Ajoute var à la liste des dépendances au temps courant.

void	addDependCurrentTime (const VariableRef &var, const TraceInfo &tinfo)
	Ajoute var à la liste des dépendances au temps courant avec les infos de trace tinfo.

void	addDependPreviousTime (const VariableRef &var)
	Ajoute var à la liste des dépendances au temps précédent.

void	addDependPreviousTime (const VariableRef &var, const TraceInfo &tinfo)
	Ajoute var à la liste des dépendances au temps précédent avec les infos de trace tinfo.

void	removeDepend (const VariableRef &var)
	Supprime var de la liste des dépendances.

template<typename ClassType >
void	setComputeFunction (ClassType instance, void(ClassType::func)())
	Positionne la fonction de recalcule de la variable.

template<typename ClassType >
void	setComputeFunction (ClassType instance, void(ClassType::func)(), const TraceInfo &tinfo)
	Positionne la fonction de recalcule de la variable.

VariableRef *	previousReference ()
	Référence précédente (ou null) sur variable()

VariableRef *	nextReference ()
	Référence suivante (ou null) sur variable()

void	setPreviousReference (VariableRef *v)

void	setNextReference (VariableRef *v)

Fonctions membres protégées
	VariableRefScalarT ()
	Constructeur vide.

Fonctions membres protégées hérités de Arcane::VariableRef
	VariableRef (const VariableBuildInfo &vbi)
	Construit une référence sur une variable avec les infos vbi.

	VariableRef (const VariableRef &from)
	Constructeur de copie.

	VariableRef (IVariable *var)
	Construit une référence sur une variable var.

VariableRef &	operator= (const VariableRef &from)
	Opérateur de recopie.

	VariableRef ()
	Constructeur vide.

void	_setComputeFunction (IVariableComputeFunction *v)

void	_internalInit (IVariable *)
	Initialisation interne de la variable.

IVariable *	_variable () const
	Variable référencée.

void	_executeUpdateFunctors ()

void	_internalAssignVariable (const VariableRef &var)

Membres hérités additionnels
Fonctions membres publiques statiques hérités de Arcane::VariableRef
static void	setTraceCreation (bool v)

static bool	hasTraceCreation ()

Attributs protégés hérités de Arcane::VariableRef
bool	m_has_trace = false

Description détaillée

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

Référence à une variable scalaire.

L'opérateur operator()() permet d'accéder à la valeur de la variable en lecture seulement. Pour modifier la valeur de la variable, il faut utiliser la méthode assign() ou l'opérateur operator=(). A noter que l'affectation provoque une mise à jour des références et peut s'avérer coûteuse.

Définition à la ligne 41 du fichier VariableRefScalar.h.

Documentation des définitions de type membres

◆ BaseClass

template<typename DataType >

typedef VariableRef Arcane::VariableRefScalarT< DataType >::BaseClass

Type de la classe de base.

Définition à la ligne 49 du fichier VariableRefScalar.h.

◆ ElementType

template<typename DataType >

typedef DataType Arcane::VariableRefScalarT< DataType >::ElementType

Type des éléments de la variable.

Définition à la ligne 47 du fichier VariableRefScalar.h.

◆ PrivatePartType

template<typename DataType >

typedef VariableScalarT<DataType> Arcane::VariableRefScalarT< DataType >::PrivatePartType

Définition à la ligne 51 du fichier VariableRefScalar.h.

◆ ThatClass

template<typename DataType >

typedef VariableRefScalarT<DataType> Arcane::VariableRefScalarT< DataType >::ThatClass

Définition à la ligne 53 du fichier VariableRefScalar.h.

Documentation des constructeurs et destructeur

◆ VariableRefScalarT() [1/4]

template<typename DataType >

Arcane::VariableRefScalarT< DataType >::VariableRefScalarT ( const VariableBuildInfo & b )

explicit

Construit une référence à une variable scalaire spécifiée dans vb.

Définition à la ligne 72 du fichier VariableRefScalar.cc.

Références Arcane::VariableRef::_internalInit().

◆ VariableRefScalarT() [2/4]

template<class DataType >

Arcane::VariableRefScalarT< DataType >::VariableRefScalarT ( const VariableRefScalarT< DataType > & rhs )

Construit une référence à partir de rhs.

Définition à la ligne 96 du fichier VariableRefScalar.cc.

Références Arcane::VariableRefScalarT< DataType >::updateFromInternal().

◆ VariableRefScalarT() [3/4]

template<typename DataType >

Arcane::VariableRefScalarT< DataType >::VariableRefScalarT ( IVariable * var )

explicit

Construit une référence à partir de var.

Définition à la ligne 84 du fichier VariableRefScalar.cc.

Références Arcane::VariableRef::_internalInit().

◆ VariableRefScalarT() [4/4]

template<typename DataType >

Arcane::VariableRefScalarT< DataType >::VariableRefScalarT ( )

inlineprotected

Constructeur vide.

Définition à la ligne 73 du fichier VariableRefScalar.h.

Documentation des fonctions membres

◆ arraySize()

template<typename DataType >

virtual Integer Arcane::VariableRefScalarT< DataType >::arraySize ( ) const

inlinevirtual

Si la variable est un tableau, retourne sa dimension, sinon retourne 0.

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

Définition à la ligne 78 du fichier VariableRefScalar.h.

◆ asArray() [1/2]

template<typename DataType >

ArrayView< DataType > Arcane::VariableRefScalarT< DataType >::asArray ( )

inline

Définition à la ligne 83 du fichier VariableRefScalar.h.

◆ asArray() [2/2]

template<typename DataType >

ConstArrayView< DataType > Arcane::VariableRefScalarT< DataType >::asArray ( ) const

inline

Définition à la ligne 84 du fichier VariableRefScalar.h.

◆ assign()

template<typename DataType >

void Arcane::VariableRefScalarT< DataType >::assign ( const DataType & v )

Affecte à la variable la valeur v.

Définition à la ligne 120 du fichier VariableRefScalar.cc.

Référencé par Arcane::VariableRefScalarT< DataType >::reset().

◆ isArrayVariable()

template<typename DataType >

virtual bool Arcane::VariableRefScalarT< DataType >::isArrayVariable ( ) const

inlinevirtual

Définition à la ligne 77 du fichier VariableRefScalar.h.

◆ isEqual()

template<typename DataType >

bool Arcane::VariableRefScalarT< DataType >::isEqual ( const DataType & v ) const

inline

Compare la variable avec la valeur v.

Définition à la ligne 107 du fichier VariableRefScalar.h.

Références Arcane::math::isEqual().

◆ isNearlyEqual()

template<typename DataType >

bool Arcane::VariableRefScalarT< DataType >::isNearlyEqual ( const DataType & v ) const

inline

Compare la variable avec la valeur v.

Pour un type flottant, la comparaison se fait à un epsilon près, défini dans float_info<T>::nearlyEpsilon().

Définition à la ligne 123 du fichier VariableRefScalar.h.

Références Arcane::math::isNearlyEqual().

◆ isNearlyZero()

template<typename DataType >

bool Arcane::VariableRefScalarT< DataType >::isNearlyZero ( ) const

inline

Compare la variable avec la valeur 0.

Voir également: isEqual().

Définition à la ligne 129 du fichier VariableRefScalar.h.

◆ isZero()

template<typename DataType >

bool Arcane::VariableRefScalarT< DataType >::isZero ( ) const

inline

Compare la variable avec la valeur 0.

Voir également: isEqual().

Définition à la ligne 114 du fichier VariableRefScalar.h.

◆ operator()()

template<typename DataType >

const DataType & Arcane::VariableRefScalarT< DataType >::operator() ( ) const

inline

Valeur du scalaire.

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

◆ operator=() [1/2]

template<typename DataType >

void Arcane::VariableRefScalarT< DataType >::operator= ( const DataType & v )

inline

Définition à la ligne 88 du fichier VariableRefScalar.h.

◆ operator=() [2/2]

template<typename DataType >

VariableRefScalarT< DataType > & Arcane::VariableRefScalarT< DataType >::operator= ( const VariableRefScalarT< DataType > & v )

inline

Définition à la ligne 89 du fichier VariableRefScalar.h.

◆ reduce()

template<typename DataType >

void Arcane::VariableRefScalarT< DataType >::reduce ( Parallel::eReduceType type )

Effectue une réduction de type type sur la variable.

Définition à la ligne 150 du fichier VariableRefScalar.cc.

◆ refersTo()

template<class DataType >

void Arcane::VariableRefScalarT< DataType >::refersTo ( const VariableRefScalarT< DataType > & rhs )

Positionne la référence de l'instance à la variable rhs.

Définition à la ligne 108 du fichier VariableRefScalar.cc.

Références Arcane::VariableRef::operator=().

◆ reset()

template<typename DataType >

void Arcane::VariableRefScalarT< DataType >::reset ( )

inline

Réinitialise la variable avec sa valeur par défaut.

Définition à la ligne 96 du fichier VariableRefScalar.h.

Références Arcane::VariableRefScalarT< DataType >::assign().

◆ swapValues()

template<typename DataType >

void Arcane::VariableRefScalarT< DataType >::swapValues ( VariableRefScalarT< DataType > & rhs )

Échange les valeurs de la variable rhs avec celles de l'instance.

Définition à la ligne 175 du fichier VariableRefScalar.cc.

◆ updateFromInternal()

template<typename T >

void Arcane::VariableRefScalarT< T >::updateFromInternal ( )

virtual

Mise à jour à partir de la partie interne.

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

Définition à la ligne 163 du fichier VariableRefScalar.cc.

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

◆ value()

template<typename DataType >

const DataType & Arcane::VariableRefScalarT< DataType >::value ( ) const

inline

Valeur du scalaire.

Définition à la ligne 102 du fichier VariableRefScalar.h.

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

Types publics

Fonctions membres publiques

Fonctions membres protégées

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ BaseClass

◆ ElementType

◆ PrivatePartType

◆ ThatClass

Documentation des constructeurs et destructeur

◆ VariableRefScalarT() [1/4]

◆ VariableRefScalarT() [2/4]

◆ VariableRefScalarT() [3/4]

◆ VariableRefScalarT() [4/4]

Documentation des fonctions membres

◆ arraySize()

◆ asArray() [1/2]

◆ asArray() [2/2]

◆ assign()

◆ isArrayVariable()

◆ isEqual()

◆ isNearlyEqual()

◆ isNearlyZero()

◆ isZero()

◆ operator()()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reduce()

◆ refersTo()

◆ reset()

◆ swapValues()

◆ updateFromInternal()

◆ value()