Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence du modèle de la classe Arcane::MeshVariableScalarRefT< ItemTypeT, 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::MeshVariableScalarRefT< ItemTypeT, DataTypeT >:
+ Graphe de collaboration de Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >:

Types publics

typedef DataTypeT DataType
 
typedef ItemTypeT ItemType
 
typedef UniqueArray< DataTypeT > ValueType
 
typedef const DataTypeT & ConstReturnReferenceType
 
typedef DataTypeT & ReturnReferenceType
 
- Types publics hérités de Arcane::ItemVariableScalarRefT< DataTypeT >
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

 MeshVariableScalarRefT (const VariableBuildInfo &vb)
 Construit une référence à la variable spécifiée dans vb.
 
 MeshVariableScalarRefT (IVariable *var)
 Construit une référence à partir de var.
 
 MeshVariableScalarRefT (const MeshVariableScalarRefT< ItemType, DataTypeT > &rhs)
 Construit une référence à partir de rhs.
 
void refersTo (const MeshVariableScalarRefT< ItemType, DataTypeT > &rhs)
 Positionne la référence de l'instance à la variable rhs.
 
ThatClassoperator= (const ThatClass &rhs)=delete
 
void fill (const DataTypeT &value)
 
void fill (const DataTypeT &value, RunQueue *queue)
 
void fill (const DataTypeT &value, const GroupType &group)
 
void swapValues (MeshVariableScalarRefT< ItemType, DataType > &rhs)
 Échange les valeurs de la variable rhs avec celles de l'instance.
 
GroupType itemGroup () const
 Groupe associé à la grandeur.
 
void setIsSynchronized ()
 
void setIsSynchronized (const GroupType &group)
 
const DataTypeT & operator[] (ItemLocalIdType i) const
 Valeur non modifiable de l'entité item.
 
DataTypeReturnReference operator[] (ItemLocalIdType i)
 Valeur modifiable de l'entité item.
 
const DataTypeT & operator() (ItemLocalIdType i) const
 Valeur non modifiable de l'entité item.
 
DataTypeReturnReference operator() (ItemLocalIdType i)
 Valeur modifiable de l'entité item.
 
DataTypeT & getReference (ItemLocalIdType item)
 Valeur modifiable de l'entité item.
 
const DataTypeT & item (ItemLocalIdType i) const
 
void setItem (ItemLocalIdType i, const DataTypeT &v)
 
- Fonctions membres publiques hérités de Arcane::ItemVariableScalarRefT< DataTypeT >
 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 VariableTypeInfo _internalVariableTypeInfo ()
 
static VariableInfo _internalVariableInfo (const VariableBuildInfo &vbi)
 
- Fonctions membres publiques statiques hérités de Arcane::ItemVariableScalarRefT< DataTypeT >
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 ()
 

Types protégés

typedef ItemType::Index ItemIndexType
 
typedef ItemType::LocalIdType ItemLocalIdType
 
typedef ItemVariableScalarRefT< DataTypeT > BaseClass
 
typedef ItemTraitsT< ItemType >::ItemGroupType GroupType
 
typedef MeshVariableScalarRefT< ItemType, DataTypeT > ThatClass
 
typedef BaseClass::DataTypeReturnReference DataTypeReturnReference
 
- Types protégés hérités de Arcane::PrivateVariableScalarT< DataTypeT >
typedef DataTypeT & DataTypeReturnReference
 
typedef VariableArrayT< DataTypeT > PrivatePartType
 

Fonctions membres protégées

 MeshVariableScalarRefT ()
 Constructeur vide.
 
ThatClass_Internal ()
 
- Fonctions membres protégées hérités de Arcane::ItemVariableScalarRefT< DataTypeT >
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

- 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 ItemTypeT, typename DataTypeT>
class Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >

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

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

Documentation des définitions de type membres

◆ BaseClass

template<typename ItemTypeT , typename DataTypeT >
typedef ItemVariableScalarRefT<DataTypeT> Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::BaseClass
protected

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

◆ ConstReturnReferenceType

template<typename ItemTypeT , typename DataTypeT >
typedef const DataTypeT& Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::ConstReturnReferenceType

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

◆ DataType

template<typename ItemTypeT , typename DataTypeT >
typedef DataTypeT Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::DataType

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

◆ DataTypeReturnReference

template<typename ItemTypeT , typename DataTypeT >
typedef BaseClass::DataTypeReturnReference Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::DataTypeReturnReference
protected

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

◆ GroupType

template<typename ItemTypeT , typename DataTypeT >
typedef ItemTraitsT<ItemType>::ItemGroupType Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::GroupType
protected

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

◆ ItemIndexType

template<typename ItemTypeT , typename DataTypeT >
typedef ItemType::Index Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::ItemIndexType
protected

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

◆ ItemLocalIdType

template<typename ItemTypeT , typename DataTypeT >
typedef ItemType::LocalIdType Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::ItemLocalIdType
protected

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

◆ ItemType

template<typename ItemTypeT , typename DataTypeT >
typedef ItemTypeT Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::ItemType

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

◆ ReturnReferenceType

template<typename ItemTypeT , typename DataTypeT >
typedef DataTypeT& Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::ReturnReferenceType

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

◆ ThatClass

template<typename ItemTypeT , typename DataTypeT >
typedef MeshVariableScalarRefT<ItemType,DataTypeT> Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::ThatClass
protected

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

◆ ValueType

template<typename ItemTypeT , typename DataTypeT >
typedef UniqueArray<DataTypeT> Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::ValueType

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

Documentation des constructeurs et destructeur

◆ MeshVariableScalarRefT() [1/4]

template<class ItemType , class DataTypeT >
Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::MeshVariableScalarRefT ( const VariableBuildInfo vb)

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

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

◆ MeshVariableScalarRefT() [2/4]

template<class ItemType , class DataTypeT >
Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::MeshVariableScalarRefT ( IVariable var)
explicit

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

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

◆ MeshVariableScalarRefT() [3/4]

template<class ItemType , class DataTypeT >
Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::MeshVariableScalarRefT ( const MeshVariableScalarRefT< ItemType, DataTypeT > &  rhs)

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

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

◆ MeshVariableScalarRefT() [4/4]

template<typename ItemTypeT , typename DataTypeT >
Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::MeshVariableScalarRefT ( )
inlineprotected

Constructeur vide.

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

Documentation des fonctions membres

◆ _Internal()

template<typename ItemTypeT , typename DataTypeT >
ThatClass & Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::_Internal ( )
inlineprotected

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

◆ _internalVariableInfo()

template<typename ItemType , typename DataType >
VariableInfo Arcane::MeshVariableScalarRefT< ItemType, DataType >::_internalVariableInfo ( const VariableBuildInfo vbi)
static

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

◆ _internalVariableTypeInfo()

template<typename ItemType , typename DataType >
VariableTypeInfo Arcane::MeshVariableScalarRefT< ItemType, DataType >::_internalVariableTypeInfo ( )
static

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

◆ fill() [1/3]

template<typename ItemTypeT , typename DataTypeT >
void Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::fill ( const DataTypeT &  value)
inline

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

◆ fill() [2/3]

template<typename ItemTypeT , typename DataTypeT >
void Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::fill ( const DataTypeT &  value,
const GroupType &  group 
)
inline

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

◆ fill() [3/3]

template<typename ItemTypeT , typename DataTypeT >
void Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::fill ( const DataTypeT &  value,
RunQueue queue 
)
inline

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

◆ getReference()

template<typename ItemTypeT , typename DataTypeT >
DataTypeT & Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::getReference ( ItemLocalIdType  item)
inline

Valeur modifiable de l'entité item.

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

◆ item()

template<typename ItemTypeT , typename DataTypeT >
const DataTypeT & Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::item ( ItemLocalIdType  i) const
inline

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

◆ itemGroup()

template<class ItemType , class DataTypeT >
Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::GroupType Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::itemGroup ( ) const

Groupe associé à la grandeur.

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

◆ operator()() [1/2]

template<typename ItemTypeT , typename DataTypeT >
DataTypeReturnReference Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::operator() ( ItemLocalIdType  i)
inline

Valeur modifiable de l'entité item.

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

◆ operator()() [2/2]

template<typename ItemTypeT , typename DataTypeT >
const DataTypeT & Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::operator() ( ItemLocalIdType  i) const
inline

Valeur non modifiable de l'entité item.

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

◆ operator[]() [1/2]

template<typename ItemTypeT , typename DataTypeT >
DataTypeReturnReference Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::operator[] ( ItemLocalIdType  i)
inline

Valeur modifiable de l'entité item.

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

◆ operator[]() [2/2]

template<typename ItemTypeT , typename DataTypeT >
const DataTypeT & Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::operator[] ( ItemLocalIdType  i) const
inline

Valeur non modifiable de l'entité item.

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

◆ refersTo()

template<class ItemType , class DataTypeT >
void Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::refersTo ( const MeshVariableScalarRefT< ItemType, DataTypeT > &  rhs)

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

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

◆ setIsSynchronized() [1/2]

template<class ItemType , class DataTypeT >
void Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::setIsSynchronized ( )

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

◆ setIsSynchronized() [2/2]

template<class ItemType , class DataTypeT >
void Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::setIsSynchronized ( const GroupType &  group)

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

◆ setItem()

template<typename ItemTypeT , typename DataTypeT >
void Arcane::MeshVariableScalarRefT< ItemTypeT, DataTypeT >::setItem ( ItemLocalIdType  i,
const DataTypeT &  v 
)
inline

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

◆ swapValues()

template<class ItemType , class DataTypeT >
void Arcane::MeshVariableScalarRefT< ItemType, DataTypeT >::swapValues ( MeshVariableScalarRefT< ItemType, DataType > &  rhs)

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

Cette méthode est optimisée pour éviter les recopie et donc l'échange se fait en temps constant. Les variables échangées doivent avoir le même maillage, la même famille et le même groupe. Elles doivent aussi être allouées (IVariable::setUsed()==true)

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


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