Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence du modèle de la classe Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >

Classe gérant une variable multi-dimension sur une entité du maillage. Plus de détails...

+ Graphe d'héritage de Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >:
+ Graphe de collaboration de Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >:

Types publics

using BaseClass = MeshMDVariableRefBaseT< ItemType, DataType, AddedFirstExtentsType >
 
using ItemLocalIdType = typename ItemType::LocalIdType
 
- Types publics hérités de Arcane::MeshMDVariableRefBaseT< ItemType, DataType, Extents::template AddedFirstExtentsType< DynExtent > >
using UnderlyingVariableType = MeshVariableArrayRefT< ItemType, DataType >
 
using MDSpanType = MDSpan< DataType, Extents, RightLayout >
 
using ItemLocalIdType = typename ItemType::LocalIdType
 
using FullExtentsType = Extents
 

Fonctions membres publiques

 MeshMDVariableRefT (const VariableBuildInfo &b)
 
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 0, void>>
DataType & operator() (ItemLocalIdType id)
 
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 0, void>>
const DataType & operator() (ItemLocalIdType id) const
 
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 1, void>>
DataType & operator() (ItemLocalIdType id, Int32 i1)
 
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 1, void>>
const DataType & operator() (ItemLocalIdType id, Int32 i1) const
 
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 2, void>>
DataType & operator() (ItemLocalIdType id, Int32 i1, Int32 i2)
 
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 2, void>>
const DataType & operator() (ItemLocalIdType id, Int32 i1, Int32 i2) const
 
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 3, void>>
DataType & operator() (ItemLocalIdType id, Int32 i, Int32 j, Int32 k)
 
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 3, void>>
const DataType & operator() (ItemLocalIdType id, Int32 i, Int32 j, Int32 k) const
 
void reshape (std::array< Int32, Extents::nb_dynamic > dims)
 Change la forme de la donnée.
 
- Fonctions membres publiques hérités de Arcane::MeshMDVariableRefBaseT< ItemType, DataType, Extents::template AddedFirstExtentsType< DynExtent > >
 MeshMDVariableRefBaseT (const VariableBuildInfo &b)
 
UnderlyingVariableTypeunderlyingVariable ()
 Variable sous-jacente associée.
 
ArrayShape fullShape () const
 Forme complète (statique + dynamique) de la variable.
 
- 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.
 
virtual Integer arraySize () const
 Si la variable est un tableau, retourne sa dimension, sinon retourne 0.
 
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)
 

Attributs publics statiques

static constexpr int nb_dynamic = Extents::nb_dynamic
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de Arcane::VariableRef
static void setTraceCreation (bool v)
 
static bool hasTraceCreation ()
 
- Fonctions membres protégées hérités de Arcane::MeshMDVariableRefBaseT< ItemType, DataType, Extents::template AddedFirstExtentsType< DynExtent > >
void updateFromInternal () override
 Mise à jour à partir de la partie interne.
 
- 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)
 
- Attributs protégés hérités de Arcane::MeshMDVariableRefBaseT< ItemType, DataType, Extents::template AddedFirstExtentsType< DynExtent > >
impl::MeshMDVariableRefWrapperT< ItemType, DataType > m_underlying_var
 
MDSpanType m_mdspan
 
- Attributs protégés hérités de Arcane::VariableRef
bool m_has_trace = false
 

Description détaillée

template<typename ItemType, typename DataType, typename Extents>
class Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >

Classe gérant une variable multi-dimension sur une entité du maillage.

Avertissement
API en cours de définition. Ne pas utiliser en dehors de Arcane.

Définition à la ligne 146 du fichier MeshMDVariableRef.h.

Documentation des définitions de type membres

◆ BaseClass

template<typename ItemType , typename DataType , typename Extents >
using Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::BaseClass = MeshMDVariableRefBaseT<ItemType, DataType, AddedFirstExtentsType>

Définition à la ligne 156 du fichier MeshMDVariableRef.h.

◆ ItemLocalIdType

template<typename ItemType , typename DataType , typename Extents >
using Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::ItemLocalIdType = typename ItemType::LocalIdType

Définition à la ligne 157 du fichier MeshMDVariableRef.h.

Documentation des constructeurs et destructeur

◆ MeshMDVariableRefT()

template<typename ItemType , typename DataType , typename Extents >
Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::MeshMDVariableRefT ( const VariableBuildInfo b)
inlineexplicit

Définition à la ligne 162 du fichier MeshMDVariableRef.h.

Documentation des fonctions membres

◆ operator()() [1/8]

template<typename ItemType , typename DataType , typename Extents >
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 0, void>>
DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType  id)
inline

Définition à la ligne 169 du fichier MeshMDVariableRef.h.

◆ operator()() [2/8]

template<typename ItemType , typename DataType , typename Extents >
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 0, void>>
const DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType  id) const
inline

Définition à la ligne 175 du fichier MeshMDVariableRef.h.

◆ operator()() [3/8]

template<typename ItemType , typename DataType , typename Extents >
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 3, void>>
DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType  id,
Int32  i,
Int32  j,
Int32  k 
)
inline

Définition à la ligne 206 du fichier MeshMDVariableRef.h.

◆ operator()() [4/8]

template<typename ItemType , typename DataType , typename Extents >
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 3, void>>
const DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType  id,
Int32  i,
Int32  j,
Int32  k 
) const
inline

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

◆ operator()() [5/8]

template<typename ItemType , typename DataType , typename Extents >
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 1, void>>
DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType  id,
Int32  i1 
)
inline

Définition à la ligne 182 du fichier MeshMDVariableRef.h.

◆ operator()() [6/8]

template<typename ItemType , typename DataType , typename Extents >
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 1, void>>
const DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType  id,
Int32  i1 
) const
inline

Définition à la ligne 188 du fichier MeshMDVariableRef.h.

◆ operator()() [7/8]

template<typename ItemType , typename DataType , typename Extents >
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 2, void>>
DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType  id,
Int32  i1,
Int32  i2 
)
inline

Définition à la ligne 194 du fichier MeshMDVariableRef.h.

◆ operator()() [8/8]

template<typename ItemType , typename DataType , typename Extents >
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 2, void>>
const DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType  id,
Int32  i1,
Int32  i2 
) const
inline

Définition à la ligne 200 du fichier MeshMDVariableRef.h.

◆ reshape()

template<typename ItemType , typename DataType , typename Extents >
void Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::reshape ( std::array< Int32, Extents::nb_dynamic >  dims)
inline

Change la forme de la donnée.

Le nombre d'éléments de dims doit correspondre aux nombre de valeurs dynamiques de Extents.

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

Documentation des données membres

◆ nb_dynamic

template<typename ItemType , typename DataType , typename Extents >
constexpr int Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::nb_dynamic = Extents::nb_dynamic
staticconstexpr

Définition à la ligne 158 du fichier MeshMDVariableRef.h.


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