Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence du modèle de la classe Arcane::ItemVariableScalarRefT< DataTypeT >

Variable scalaire sur un type d'entité du maillage. Plus de détails...

#include <arcane/core/MeshVariableScalarRef.h>

+ Graphe d'héritage de Arcane::ItemVariableScalarRefT< DataTypeT >:
+ Graphe de collaboration de Arcane::ItemVariableScalarRefT< DataTypeT >:

Types publics

typedef DataTypeT DataType
 
typedef UniqueArray< DataTypeT > ValueType
 
typedef const DataTypeT & ConstReturnReferenceType
 
typedef DataTypeT & ReturnReferenceType
 
typedef ArrayView< DataTypeT > ArrayBase
 
typedef PrivateVariableScalarT< DataTypeT > BaseClass
 
typedef BaseClass::PrivatePartType PrivatePartType
 
typedef BaseClass::DataTypeReturnReference DataTypeReturnReference
 

Fonctions membres publiques

 ItemVariableScalarRefT (const VariableBuildInfo &b, eItemKind ik)
 Construit une référence à la variable spécifiée dans vb.
 
 ItemVariableScalarRefT (IVariable *var)
 Construit une référence à partir de var.
 
 ItemVariableScalarRefT (const ItemVariableScalarRefT< DataTypeT > &rhs)
 Construit une référence à partir de rhs.
 
void add (const ItemVariableScalarRefT< DataTypeT > &v)
 
void sub (const ItemVariableScalarRefT< DataTypeT > &v)
 
void mult (const ItemVariableScalarRefT< DataTypeT > &v)
 
void mult (const DataTypeT &v)
 
void copy (const ItemVariableScalarRefT< DataTypeT > &v)
 
void power (const DataTypeT &v)
 
void add (const ItemVariableScalarRefT< DataTypeT > &v, const ItemGroup &group)
 
void sub (const ItemVariableScalarRefT< DataTypeT > &v, const ItemGroup &group)
 
void mult (const ItemVariableScalarRefT< DataTypeT > &v, const ItemGroup &group)
 
void mult (const DataTypeT &v, const ItemGroup &group)
 
void power (const DataTypeT &v, const ItemGroup &group)
 
void copy (const ItemVariableScalarRefT< DataTypeT > &v, const ItemGroup &group)
 Copie pour les entités de group, les valeurs de v dans cette variable.
 
void fill (const DataTypeT &value)
 
void fill (const DataTypeT &value, const ItemGroup &group)
 
void copy (const ItemVariableScalarRefT< DataTypeT > &v, RunQueue *queue)
 Copie les valeurs de v dans cette variable via la file queue.
 
void fill (const DataTypeT &value, RunQueue *queue)
 Remplit les valeurs de l'instance par value via la file queue.
 
const DataType & operator[] (ItemLocalId item) const
 Valeur non modifiable de l'entité item.
 
DataTypeReturnReference operator[] (ItemLocalId item)
 Valeur modifiable de l'entité item.
 
const DataType & operator() (ItemLocalId item) const
 Valeur non modifiable de l'entité item.
 
DataTypeReturnReference operator() (ItemLocalId item)
 Valeur modifiable de l'entité item.
 
- Fonctions membres publiques hérités de Arcane::PrivateVariableScalarT< DataTypeT >
ArrayView< DataTypeT > asArray ()
 
ConstArrayView< DataTypeT > asArray () const
 
Integer arraySize () const
 Si la variable est un tableau, retourne sa dimension, sinon retourne 0.
 
void updateFromInternal ()
 Mise à jour à partir de la partie interne.
 
ItemGroup itemGroup () const
 
SmallSpan< DataTypeT > _internalSpan ()
 
SmallSpan< const DataTypeT > _internalSpan () const
 
SmallSpan< const DataTypeT > _internalConstSpan () const
 
- Fonctions membres publiques hérités de Arcane::MeshVariableRef
 MeshVariableRef (const VariableBuildInfo &vb)
 Construit une référence liée au module module.
 
void synchronize ()
 
void synchronize (Int32ConstArrayView local_ids)
 
- Fonctions membres publiques hérités de Arcane::VariableRef
virtual ~VariableRef ()
 Libère les ressources.
 
ISubDomainsubDomain () const
 Sous-domaine associé à la variable (TODO rendre obsolète fin 2023)
 
IVariableMngvariableMng () 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 IModulemodule () 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)
 
IVariablevariable () 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 StringassignmentStackTrace () 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.
 
VariableRefpreviousReference ()
 Référence précédente (ou null) sur variable()
 
VariableRefnextReference ()
 Référence suivante (ou null) sur variable()
 
void setPreviousReference (VariableRef *v)
 
void setNextReference (VariableRef *v)
 

Fonctions membres publiques statiques

static VariableInfo _internalVariableInfo (const VariableBuildInfo &vbi, eItemKind ik)
 
static VariableTypeInfo _internalVariableTypeInfo (eItemKind ik)
 
- Fonctions membres publiques statiques hérités de Arcane::VariableRef
static void setTraceCreation (bool v)
 
static bool hasTraceCreation ()
 

Fonctions membres protégées

void operator= (const ItemVariableScalarRefT< DataTypeT > &rhs)
 Positionne la référence de l'instance à la variable rhs.
 
 ItemVariableScalarRefT ()
 Constructeur vide.
 
- Fonctions membres protégées hérités de Arcane::PrivateVariableScalarT< DataTypeT >
 PrivateVariableScalarT (const VariableBuildInfo &vb, const VariableInfo &vi)
 Construit une référence liée au module module.
 
 PrivateVariableScalarT (const PrivateVariableScalarT &rhs)
 
 PrivateVariableScalarT (IVariable *var)
 
void operator= (const PrivateVariableScalarT &rhs)
 
void _internalInit ()
 
const DataTypeT & _value (Integer local_id) const
 
DataTypeReturnReference _value (Integer local_id)
 
const DataTypeT & _putValue (Integer index, const DataTypeT &v)
 
- Fonctions membres protégées hérités de Arcane::MeshVariableRef
 MeshVariableRef (const MeshVariableRef &rhs)
 
 MeshVariableRef (IVariable *var)
 
void operator= (const MeshVariableRef &rhs)
 
void _internalInit (IVariable *)
 
- 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.
 
VariableRefoperator= (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

- Types protégés hérités de Arcane::PrivateVariableScalarT< DataTypeT >
typedef DataTypeT & DataTypeReturnReference
 
typedef VariableArrayT< DataTypeT > PrivatePartType
 
- Attributs protégés hérités de Arcane::PrivateVariableScalarT< DataTypeT >
PrivatePartType * m_private_part
 
ArrayView< DataTypeT > m_view
 
IMemoryAccessTracem_memory_trace
 
- Attributs protégés hérités de Arcane::VariableRef
bool m_has_trace = false
 

Description détaillée

template<typename DataTypeT>
class Arcane::ItemVariableScalarRefT< DataTypeT >

Variable scalaire sur un type d'entité du maillage.

Définition à la ligne 72 du fichier MeshVariableScalarRef.h.

Documentation des définitions de type membres

◆ ArrayBase

template<typename DataTypeT >
typedef ArrayView<DataTypeT> Arcane::ItemVariableScalarRefT< DataTypeT >::ArrayBase

Définition à la ligne 82 du fichier MeshVariableScalarRef.h.

◆ BaseClass

template<typename DataTypeT >
typedef PrivateVariableScalarT<DataTypeT> Arcane::ItemVariableScalarRefT< DataTypeT >::BaseClass

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

◆ ConstReturnReferenceType

template<typename DataTypeT >
typedef const DataTypeT& Arcane::ItemVariableScalarRefT< DataTypeT >::ConstReturnReferenceType

Définition à la ligne 79 du fichier MeshVariableScalarRef.h.

◆ DataType

template<typename DataTypeT >
typedef DataTypeT Arcane::ItemVariableScalarRefT< DataTypeT >::DataType

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

◆ DataTypeReturnReference

template<typename DataTypeT >
typedef BaseClass::DataTypeReturnReference Arcane::ItemVariableScalarRefT< DataTypeT >::DataTypeReturnReference

Définition à la ligne 85 du fichier MeshVariableScalarRef.h.

◆ PrivatePartType

template<typename DataTypeT >
typedef BaseClass::PrivatePartType Arcane::ItemVariableScalarRefT< DataTypeT >::PrivatePartType

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

◆ ReturnReferenceType

template<typename DataTypeT >
typedef DataTypeT& Arcane::ItemVariableScalarRefT< DataTypeT >::ReturnReferenceType

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

◆ ValueType

template<typename DataTypeT >
typedef UniqueArray<DataTypeT> Arcane::ItemVariableScalarRefT< DataTypeT >::ValueType

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

Documentation des constructeurs et destructeur

◆ ItemVariableScalarRefT() [1/4]

template<class DataTypeT >
Arcane::ItemVariableScalarRefT< DataTypeT >::ItemVariableScalarRefT ( const VariableBuildInfo b,
eItemKind  ik 
)

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

Définition à la ligne 101 du fichier MeshVariableScalarRefT.H.

Références ARCANE_FATAL.

◆ ItemVariableScalarRefT() [2/4]

template<class DataTypeT >
Arcane::ItemVariableScalarRefT< DataTypeT >::ItemVariableScalarRefT ( IVariable var)
explicit

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

Définition à la ligne 116 du fichier MeshVariableScalarRefT.H.

Références ARCANE_FATAL.

◆ ItemVariableScalarRefT() [3/4]

template<class DataTypeT >
Arcane::ItemVariableScalarRefT< DataTypeT >::ItemVariableScalarRefT ( const ItemVariableScalarRefT< DataTypeT > &  rhs)

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

Définition à la ligne 129 du fichier MeshVariableScalarRefT.H.

◆ ItemVariableScalarRefT() [4/4]

template<typename DataTypeT >
Arcane::ItemVariableScalarRefT< DataTypeT >::ItemVariableScalarRefT ( )
inlineprotected

Constructeur vide.

Définition à la ligne 110 du fichier MeshVariableScalarRef.h.

Documentation des fonctions membres

◆ _internalVariableInfo()

template<typename DataType >
VariableInfo Arcane::ItemVariableScalarRefT< DataType >::_internalVariableInfo ( const VariableBuildInfo vbi,
eItemKind  ik 
)
static

Définition à la ligne 89 du fichier MeshVariableScalarRefT.H.

◆ _internalVariableTypeInfo()

template<typename DataType >
VariableTypeInfo Arcane::ItemVariableScalarRefT< DataType >::_internalVariableTypeInfo ( eItemKind  ik)
static

Définition à la ligne 78 du fichier MeshVariableScalarRefT.H.

◆ add() [1/2]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::add ( const ItemVariableScalarRefT< DataTypeT > &  v)
inline

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

◆ add() [2/2]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::add ( const ItemVariableScalarRefT< DataTypeT > &  v,
const ItemGroup group 
)
inline

Définition à la ligne 139 du fichier MeshVariableScalarRef.h.

◆ copy() [1/3]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::copy ( const ItemVariableScalarRefT< DataTypeT > &  v)
inline

Définition à la ligne 130 du fichier MeshVariableScalarRef.h.

◆ copy() [2/3]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::copy ( const ItemVariableScalarRefT< DataTypeT > &  v,
const ItemGroup group 
)

Copie pour les entités de group, les valeurs de v dans cette variable.

Définition à la ligne 161 du fichier MeshVariableScalarRefT.H.

Références ENUMERATE_ITEM.

◆ copy() [3/3]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::copy ( const ItemVariableScalarRefT< DataTypeT > &  v,
RunQueue queue 
)

Copie les valeurs de v dans cette variable via la file queue.

queue peut être nul.

Définition à la ligne 173 du fichier MeshVariableScalarRefT.H.

◆ fill() [1/3]

template<class DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::fill ( const DataTypeT &  value)

Définition à la ligne 139 du fichier MeshVariableScalarRefT.H.

◆ fill() [2/3]

template<class DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::fill ( const DataTypeT &  value,
const ItemGroup group 
)

Définition à la ligne 149 du fichier MeshVariableScalarRefT.H.

◆ fill() [3/3]

template<class DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::fill ( const DataTypeT &  value,
RunQueue queue 
)

Remplit les valeurs de l'instance par value via la file queue.

queue peut être nul.

Définition à la ligne 187 du fichier MeshVariableScalarRefT.H.

◆ mult() [1/4]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::mult ( const DataTypeT &  v)
inline

Définition à la ligne 126 du fichier MeshVariableScalarRef.h.

◆ mult() [2/4]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::mult ( const DataTypeT &  v,
const ItemGroup group 
)
inline

Définition à la ligne 151 du fichier MeshVariableScalarRef.h.

◆ mult() [3/4]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::mult ( const ItemVariableScalarRefT< DataTypeT > &  v)
inline

Définition à la ligne 122 du fichier MeshVariableScalarRef.h.

◆ mult() [4/4]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::mult ( const ItemVariableScalarRefT< DataTypeT > &  v,
const ItemGroup group 
)
inline

Définition à la ligne 147 du fichier MeshVariableScalarRef.h.

◆ operator()() [1/2]

template<typename DataTypeT >
DataTypeReturnReference Arcane::ItemVariableScalarRefT< DataTypeT >::operator() ( ItemLocalId  item)
inline

Valeur modifiable de l'entité item.

Définition à la ligne 190 du fichier MeshVariableScalarRef.h.

◆ operator()() [2/2]

template<typename DataTypeT >
const DataType & Arcane::ItemVariableScalarRefT< DataTypeT >::operator() ( ItemLocalId  item) const
inline

Valeur non modifiable de l'entité item.

Définition à la ligne 187 du fichier MeshVariableScalarRef.h.

◆ operator=()

template<class DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::operator= ( const ItemVariableScalarRefT< DataTypeT > &  rhs)
protected

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

Définition à la ligne 201 du fichier MeshVariableScalarRefT.H.

◆ operator[]() [1/2]

template<typename DataTypeT >
DataTypeReturnReference Arcane::ItemVariableScalarRefT< DataTypeT >::operator[] ( ItemLocalId  item)
inline

Valeur modifiable de l'entité item.

Définition à la ligne 184 du fichier MeshVariableScalarRef.h.

◆ operator[]() [2/2]

template<typename DataTypeT >
const DataType & Arcane::ItemVariableScalarRefT< DataTypeT >::operator[] ( ItemLocalId  item) const
inline

Valeur non modifiable de l'entité item.

Définition à la ligne 181 du fichier MeshVariableScalarRef.h.

◆ power() [1/2]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::power ( const DataTypeT &  v)
inline

Définition à la ligne 134 du fichier MeshVariableScalarRef.h.

◆ power() [2/2]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::power ( const DataTypeT &  v,
const ItemGroup group 
)
inline

Définition à la ligne 155 du fichier MeshVariableScalarRef.h.

◆ sub() [1/2]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::sub ( const ItemVariableScalarRefT< DataTypeT > &  v)
inline

Définition à la ligne 118 du fichier MeshVariableScalarRef.h.

◆ sub() [2/2]

template<typename DataTypeT >
void Arcane::ItemVariableScalarRefT< DataTypeT >::sub ( const ItemVariableScalarRefT< DataTypeT > &  v,
const ItemGroup group 
)
inline

Définition à la ligne 143 du fichier MeshVariableScalarRef.h.


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