Arcane  4.1.13.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence du modèle de la classe Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >

Variable scalaire sur les mailles d'un matériau du maillage. Plus de détails...

#include <arcane/core/materials/MeshMaterialVariableRef.h>

Types publics

using DataType = DataType_
using PrivatePartType = IScalarMeshMaterialVariable<Cell, DataType>
using ItemType = Cell
using GlobalVariableRefType = MeshVariableScalarRefT<ItemType, DataType>
using ThatClass = CellMaterialVariableScalarRef<DataType>

Fonctions membres publiques

 CellMaterialVariableScalarRef (const VariableBuildInfo &vb)
 Construit une référence à la variable spécifiée dans vb.
 CellMaterialVariableScalarRef (const MaterialVariableBuildInfo &vb)
 Construit une référence à la variable spécifiée dans vb.
 CellMaterialVariableScalarRef (IMeshMaterialVariable *var)
 Construit une référence à la variable var.
 CellMaterialVariableScalarRef (const ThatClass &rhs)
ThatClass & operator= (const ThatClass &rhs)=delete
 Opérateur de recopie (interdit).
 CellMaterialVariableScalarRef ()=delete
 Constructeur vide (interdit).
virtual void refersTo (const ThatClass &rhs)
 Positionne la référence de l'instance à la variable rhs.
void updateFromInternal () override
DataType operator[] (ComponentItemLocalId mc) const
 Valeur partielle de la variable pour la maille matériau mc.
DataType & operator[] (ComponentItemLocalId mc)
 Valeur partielle de la variable pour la maille matériau mc.
DataType operator[] (CellComponentCellEnumerator mc) const
 Valeur partielle de la variable pour l'itérateur mc.
DataType & operator[] (CellComponentCellEnumerator mc)
 Valeur partielle de la variable pour l'itérateur mc.
DataType operator[] (CellLocalId c) const
 Valeur globale de la variable pour la maille c.
DataType & operator[] (CellLocalId c)
 Valeur globale de la variable pour la maille c.
DataType operator[] (PureMatVarIndex mvi) const
 Valeur de la variable pour la maille matériau mvi.
DataType & operator[] (PureMatVarIndex mvi)
 Valeur de la variable pour la maille matériau mvi.
DataType matValue (AllEnvCell c, Int32 mat_id) const
 Valeur de la variable pour le matériau d'index mat_id de la maille ou 0 si absent de la maille.
DataType envValue (AllEnvCell c, Int32 env_id) const
 Valeur de la variable pour le milieu d'index env_id de la maille ou 0 si absent de la maille.
void fillFromArray (IMeshMaterial *mat, ConstArrayView< DataType > values)
 Remplit les valeurs de la variable pour un matériau.
void fillFromArray (IMeshMaterial *mat, ConstArrayView< DataType > values, Int32ConstArrayView indexes)
 Remplit les valeurs de la variable pour un matériau.
void fillToArray (IMeshMaterial *mat, ArrayView< DataType > values)
 Remplit un tableau à partir des valeurs de la variable pour un matériau.
void fillToArray (IMeshMaterial *mat, ArrayView< DataType > values, Int32ConstArrayView indexes)
 Remplit un tableau à partir des valeurs de la variable pour un matériau.
void fillToArray (IMeshMaterial *mat, Array< DataType > &values)
 Remplit un tableau à partir des valeurs de la variable pour un matériau.
void fillToArray (IMeshMaterial *mat, Array< DataType > &values, Int32ConstArrayView indexes)
 Remplit un tableau à partir des valeurs de la variable pour un matériau.
void fill (const DataType &value)
 Remplit les valeurs partielles et globales de la variable avec la valeur value.
void fillPartialValues (const DataType &value)
 Remplit les valeurs partielles de la variable avec la valeur value.
GlobalVariableRefType & globalVariable ()
 Variable globale associée à cette variable matériau.
const GlobalVariableRefType & globalVariable () const
 Variable globale associée à cette variable matériau.
ArrayView< DataType > * _internalValue () const
Fonctions membres publiques hérités de Arcane::Materials::MeshMaterialVariableRef
MeshMaterialVariableRef * previousReference ()
 Référence précédente (ou nulle) sur variable().
MeshMaterialVariableRef * nextReference ()
 Référence suivante (ou nulle) sur variable().
void setPreviousReference (MeshMaterialVariableRef *v)
void setNextReference (MeshMaterialVariableRef *v)
void registerVariable ()
 Enregistre la variable (interne).
void unregisterVariable ()
 Supprime l'enregistrement de la variable (interne).
IMeshMaterialVariablematerialVariable () const
 Variable matériau associée.
void synchronize ()
 Synchronise les valeurs entre sous-domaines.
void synchronize (MeshMaterialVariableSynchronizerList &sync_list)
 Ajoute cette variable à la liste de synchronisation sync_list.
MatVarSpace space () const
 Espace de définition de la variable (matériau+milieu ou uniquement milieu).
void fillPartialValuesWithSuperValues (Int32 level)
 Remplit les valeurs partielles avec la valeur de la maille du dessus. Si level vaut LEVEL_MATERIAL, copie les valeurs matériaux avec celle du milieu. Si level vaut LEVEL_ENVIRONNEMENT, copie les valeurs des milieux avec celui de la maille globale. Si level vaut LEVEL_ALLENVIRONMENT, remplit toutes les valeurs partielles avec celle de la maille globale (cela rend cette méthode équivalente à fillGlobalValuesWithGlobalValues().
String name () const
void setUpToDate ()
bool isUsed () const
void update ()
void addDependCurrentTime (const VariableRef &var)
void addDependCurrentTime (const VariableRef &var, const TraceInfo &tinfo)
void addDependCurrentTime (const MeshMaterialVariableRef &var)
void addDependPreviousTime (const MeshMaterialVariableRef &var)
void removeDepend (const MeshMaterialVariableRef &var)
template<typename ClassType>
void setComputeFunction (ClassType *instance, void(ClassType::*func)())
void setUpToDate (IMeshMaterial *)
 Fonctions pour gérer les dépendances sur la partie matériau de la variable.
void update (IMeshMaterial *)
void addMaterialDepend (const VariableRef &var)
void addMaterialDepend (const VariableRef &var, const TraceInfo &tinfo)
void addMaterialDepend (const MeshMaterialVariableRef &var)
void addMaterialDepend (const MeshMaterialVariableRef &var, const TraceInfo &tinfo)
template<typename ClassType>
void setMaterialComputeFunction (ClassType *instance, void(ClassType::*func)(IMeshMaterial *))

Fonctions membres protégées

DataType operator[] (MatVarIndex mvi) const
DataType & operator[] (MatVarIndex mvi)
Fonctions membres protégées hérités de Arcane::Materials::MeshMaterialVariableRef
void _internalInit (IMeshMaterialVariable *mat_variable)
bool _isRegistered () const

Description détaillée

template<typename DataType_>
class Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >

Variable scalaire sur les mailles d'un matériau du maillage.

Pour l'instant, cette classe n'est instanciée que pour les mailles

Définition à la ligne 272 du fichier core/materials/MeshMaterialVariableRef.h.

Documentation des définitions de type membres

◆ DataType

template<typename DataType_>
using Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::DataType = DataType_

Définition à la ligne 277 du fichier core/materials/MeshMaterialVariableRef.h.

◆ GlobalVariableRefType

template<typename DataType_>
using Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::GlobalVariableRefType = MeshVariableScalarRefT<ItemType, DataType>

Définition à la ligne 280 du fichier core/materials/MeshMaterialVariableRef.h.

◆ ItemType

template<typename DataType_>
using Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::ItemType = Cell

Définition à la ligne 279 du fichier core/materials/MeshMaterialVariableRef.h.

◆ PrivatePartType

template<typename DataType_>
using Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::PrivatePartType = IScalarMeshMaterialVariable<Cell, DataType>

Définition à la ligne 278 du fichier core/materials/MeshMaterialVariableRef.h.

◆ ThatClass

template<typename DataType_>
using Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::ThatClass = CellMaterialVariableScalarRef<DataType>

Définition à la ligne 281 du fichier core/materials/MeshMaterialVariableRef.h.

Documentation des constructeurs et destructeur

◆ CellMaterialVariableScalarRef() [1/3]

template<typename DataType>
Arcane::Materials::CellMaterialVariableScalarRef< DataType >::CellMaterialVariableScalarRef ( const VariableBuildInfo & vb)
explicit

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

Définition à la ligne 248 du fichier MeshMaterialVariableRef.cc.

Références CellMaterialVariableScalarRef().

Référencé par CellMaterialVariableScalarRef(), et refersTo().

◆ CellMaterialVariableScalarRef() [2/3]

template<typename DataType>
Arcane::Materials::CellMaterialVariableScalarRef< DataType >::CellMaterialVariableScalarRef ( const MaterialVariableBuildInfo & vb)
explicit

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

Définition à la ligne 257 du fichier MeshMaterialVariableRef.cc.

◆ CellMaterialVariableScalarRef() [3/3]

template<typename DataType>
Arcane::Materials::CellMaterialVariableScalarRef< DataType >::CellMaterialVariableScalarRef ( IMeshMaterialVariable * var)
explicit

Construit une référence à la variable var.

var doit avoir comme type de donnée DataType et doit être une variable scalaire sinon une exception est levée.

Définition à la ligne 282 du fichier MeshMaterialVariableRef.cc.

Documentation des fonctions membres

◆ _internalValue()

template<typename DataType_>
ArrayView< DataType > * Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::_internalValue ( ) const
inline

Définition à la ligne 420 du fichier core/materials/MeshMaterialVariableRef.h.

◆ envValue()

template<typename DataType>
DataType Arcane::Materials::CellMaterialVariableScalarRef< DataType >::envValue ( AllEnvCell c,
Int32 env_id ) const

Valeur de la variable pour le milieu d'index env_id de la maille ou 0 si absent de la maille.

Définition à la ligne 363 du fichier MeshMaterialVariableRef.cc.

Références ENUMERATE_CELL_ENVCELL, et Arcane::Materials::EnvCell::environmentId().

◆ fill()

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::fill ( const DataType & value)

Remplit les valeurs partielles et globales de la variable avec la valeur value.

Définition à la ligne 495 du fichier MeshMaterialVariableRef.cc.

Références fillPartialValues(), et globalVariable().

◆ fillFromArray() [1/2]

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::fillFromArray ( IMeshMaterial * mat,
ConstArrayView< DataType > values )

Remplit les valeurs de la variable pour un matériau.

Cette méthode effectue l'opération suivante:

Integer index=0;
ENUMERATE_MATCELL(imatcell,mat){
matvar[imatcell] = values[index];
++index;
}
#define ENUMERATE_MATCELL(iname, mat)
Macro pour itérer sur toutes les mailles d'un matériau.
Int32 Integer
Type représentant un entier.

Définition à la ligne 390 du fichier MeshMaterialVariableRef.cc.

◆ fillFromArray() [2/2]

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::fillFromArray ( IMeshMaterial * mat,
ConstArrayView< DataType > values,
Int32ConstArrayView indexes )

Remplit les valeurs de la variable pour un matériau.

Cette méthode effectue l'opération suivante:

Integer index=0;
ENUMERATE_MATCELL(imatcell,mat){
matvar[imatcell] = values[index];
++index;
}

Définition à la ligne 411 du fichier MeshMaterialVariableRef.cc.

◆ fillPartialValues()

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::fillPartialValues ( const DataType & value)

Remplit les valeurs partielles de la variable avec la valeur value.

Définition à la ligne 508 du fichier MeshMaterialVariableRef.cc.

Référencé par fill().

◆ fillToArray() [1/4]

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::fillToArray ( IMeshMaterial * mat,
Array< DataType > & values )

Remplit un tableau à partir des valeurs de la variable pour un matériau.

Le tableau values est redimensionné si besoin.

Définition à la ligne 467 du fichier MeshMaterialVariableRef.cc.

Références Arcane::Materials::IMeshComponent::cells(), fillToArray(), Arcane::Array< T >::resize(), Arcane::ItemGroup::size(), et Arcane::Array< T >::view().

◆ fillToArray() [2/4]

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::fillToArray ( IMeshMaterial * mat,
Array< DataType > & values,
Int32ConstArrayView indexes )

Remplit un tableau à partir des valeurs de la variable pour un matériau.

Le tableau values est redimensionné si besoin.

Définition à la ligne 482 du fichier MeshMaterialVariableRef.cc.

Références Arcane::Materials::IMeshComponent::cells(), fillToArray(), Arcane::Array< T >::resize(), Arcane::ItemGroup::size(), et Arcane::Array< T >::view().

◆ fillToArray() [3/4]

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::fillToArray ( IMeshMaterial * mat,
ArrayView< DataType > values )

Remplit un tableau à partir des valeurs de la variable pour un matériau.

Cette méthode effectue l'opération suivante:

Integer index=0;
ENUMERATE_MATCELL(imatcell,mat){
values[index] = matvar[imatcell];
++index;
}

Définition à la ligne 432 du fichier MeshMaterialVariableRef.cc.

Référencé par fillToArray(), et fillToArray().

◆ fillToArray() [4/4]

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::fillToArray ( IMeshMaterial * mat,
ArrayView< DataType > values,
Int32ConstArrayView indexes )

Remplit un tableau à partir des valeurs de la variable pour un matériau.

Cette méthode effectue l'opération suivante:

Integer index=0;
ENUMERATE_MATCELL(imatcell,mat){
values[index] = matvar[imatcell];
++index;
}

Définition à la ligne 453 du fichier MeshMaterialVariableRef.cc.

◆ globalVariable() [1/2]

template<typename DataType>
MeshVariableScalarRefT< Cell, DataType > & Arcane::Materials::CellMaterialVariableScalarRef< DataType >::globalVariable ( )

Variable globale associée à cette variable matériau.

Définition à la ligne 521 du fichier MeshMaterialVariableRef.cc.

Références ARCANE_FATAL.

Référencé par fill().

◆ globalVariable() [2/2]

template<typename DataType>
const MeshVariableScalarRefT< Cell, DataType > & Arcane::Materials::CellMaterialVariableScalarRef< DataType >::globalVariable ( ) const

Variable globale associée à cette variable matériau.

Définition à la ligne 534 du fichier MeshMaterialVariableRef.cc.

Références ARCANE_FATAL.

◆ matValue()

template<typename DataType>
DataType Arcane::Materials::CellMaterialVariableScalarRef< DataType >::matValue ( AllEnvCell c,
Int32 mat_id ) const

Valeur de la variable pour le matériau d'index mat_id de la maille ou 0 si absent de la maille.

Définition à la ligne 345 du fichier MeshMaterialVariableRef.cc.

Références ENUMERATE_CELL_ENVCELL, ENUMERATE_CELL_MATCELL, et Arcane::Materials::MatCell::materialId().

◆ operator[]() [1/10]

template<typename DataType_>
DataType & Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( CellComponentCellEnumerator mc)
inline

Valeur partielle de la variable pour l'itérateur mc.

Définition à la ligne 347 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [2/10]

template<typename DataType_>
DataType Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( CellComponentCellEnumerator mc) const
inline

Valeur partielle de la variable pour l'itérateur mc.

Définition à la ligne 341 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [3/10]

template<typename DataType_>
DataType & Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( CellLocalId c)
inline

Valeur globale de la variable pour la maille c.

Définition à la ligne 359 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [4/10]

template<typename DataType_>
DataType Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( CellLocalId c) const
inline

Valeur globale de la variable pour la maille c.

Définition à la ligne 353 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [5/10]

template<typename DataType_>
DataType & Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( ComponentItemLocalId mc)
inline

Valeur partielle de la variable pour la maille matériau mc.

Définition à la ligne 335 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [6/10]

template<typename DataType_>
DataType Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( ComponentItemLocalId mc) const
inline

Valeur partielle de la variable pour la maille matériau mc.

Définition à la ligne 329 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [7/10]

template<typename DataType_>
DataType & Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( MatVarIndex mvi)
inlineprotected

Définition à la ligne 321 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [8/10]

template<typename DataType_>
DataType Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( MatVarIndex mvi) const
inlineprotected

Définition à la ligne 317 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [9/10]

template<typename DataType_>
DataType & Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( PureMatVarIndex mvi)
inline

Valeur de la variable pour la maille matériau mvi.

Définition à la ligne 371 du fichier core/materials/MeshMaterialVariableRef.h.

◆ operator[]() [10/10]

template<typename DataType_>
DataType Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::operator[] ( PureMatVarIndex mvi) const
inline

Valeur de la variable pour la maille matériau mvi.

Définition à la ligne 365 du fichier core/materials/MeshMaterialVariableRef.h.

◆ refersTo()

template<typename DataType_>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::refersTo ( const ThatClass & rhs)
virtual

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

Définition à la ligne 313 du fichier MeshMaterialVariableRef.cc.

Références CellMaterialVariableScalarRef(), et Arcane::Materials::MeshMaterialVariableRef::unregisterVariable().

◆ updateFromInternal()

template<typename DataType>
void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::updateFromInternal ( )
overridevirtual

Implémente Arcane::Materials::MeshMaterialVariableRef.

Définition à la ligne 335 du fichier MeshMaterialVariableRef.cc.


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