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

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

Types publics
using	DataType = DataType_
using	PrivatePartType = IScalarMeshMaterialVariable<Cell, DataType>
using	ThatClass = CellEnvironmentVariableScalarRef<DataType>
using	ItemType = Cell
using	GlobalVariableRefType = MeshVariableScalarRefT<ItemType, DataType>

Fonctions membres publiques
	CellEnvironmentVariableScalarRef (const VariableBuildInfo &vb)
	CellEnvironmentVariableScalarRef (const MaterialVariableBuildInfo &vb)
	Construit une référence à la variable spécifiée dans vb.
	CellEnvironmentVariableScalarRef (const ThatClass &rhs)
ThatClass &	operator= (const ThatClass &rhs)=delete
	Opérateur de recopie (interdit).
	CellEnvironmentVariableScalarRef ()=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[] (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	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	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).
IMeshMaterialVariable *	materialVariable () 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::CellEnvironmentVariableScalarRef< DataType_ >

Variable scalaire sur les mailles d'un milieu du maillage.

Ce type de variable est identique à ceci près qu'elle n'a de valeurs que sur les milieux et les mailles globales mais pas sur les matériaux.

Définition à la ligne 42 du fichier core/materials/MeshEnvironmentVariableRef.h.

Documentation des définitions de type membres

◆ DataType

template<typename DataType_>

using Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::DataType = DataType_

Définition à la ligne 47 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ GlobalVariableRefType

template<typename DataType_>

using Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::GlobalVariableRefType = MeshVariableScalarRefT<ItemType, DataType>

Définition à la ligne 51 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ ItemType

template<typename DataType_>

using Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::ItemType = Cell

Définition à la ligne 50 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ PrivatePartType

template<typename DataType_>

using Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::PrivatePartType = IScalarMeshMaterialVariable<Cell, DataType>

Définition à la ligne 48 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ ThatClass

template<typename DataType_>

using Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::ThatClass = CellEnvironmentVariableScalarRef<DataType>

Définition à la ligne 49 du fichier core/materials/MeshEnvironmentVariableRef.h.

Documentation des constructeurs et destructeur

◆ CellEnvironmentVariableScalarRef() [1/2]

template<typename DataType>

Arcane::Materials::CellEnvironmentVariableScalarRef< DataType >::CellEnvironmentVariableScalarRef ( const VariableBuildInfo & vb )

explicit

Définition à la ligne 39 du fichier MeshEnvironmentVariableRef.cc.

◆ CellEnvironmentVariableScalarRef() [2/2]

template<typename DataType>

Arcane::Materials::CellEnvironmentVariableScalarRef< DataType >::CellEnvironmentVariableScalarRef ( const MaterialVariableBuildInfo & vb )

explicit

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

Définition à la ligne 48 du fichier MeshEnvironmentVariableRef.cc.

Références Arcane::Materials::Environment.

Documentation des fonctions membres

◆ _internalValue()

template<typename DataType_>

ArrayView< DataType > * Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::_internalValue ( ) const

inline

Définition à la ligne 141 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ envValue()

template<typename DataType>

DataType Arcane::Materials::CellEnvironmentVariableScalarRef< 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 125 du fichier MeshEnvironmentVariableRef.cc.

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

◆ fill()

template<typename DataType>

void Arcane::Materials::CellEnvironmentVariableScalarRef< DataType >::fill ( const DataType & value )

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

Définition à la ligne 143 du fichier MeshEnvironmentVariableRef.cc.

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

◆ fillPartialValues()

template<typename DataType>

void Arcane::Materials::CellEnvironmentVariableScalarRef< DataType >::fillPartialValues ( const DataType & value )

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

Définition à la ligne 156 du fichier MeshEnvironmentVariableRef.cc.

Référencé par fill().

◆ globalVariable() [1/2]

template<typename DataType>

MeshVariableScalarRefT< Cell, DataType > & Arcane::Materials::CellEnvironmentVariableScalarRef< DataType >::globalVariable ( )

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

Définition à la ligne 169 du fichier MeshEnvironmentVariableRef.cc.

Références ARCANE_FATAL.

Référencé par fill().

◆ globalVariable() [2/2]

template<typename DataType>

const MeshVariableScalarRefT< Cell, DataType > & Arcane::Materials::CellEnvironmentVariableScalarRef< DataType >::globalVariable ( ) const

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

Définition à la ligne 182 du fichier MeshEnvironmentVariableRef.cc.

Références ARCANE_FATAL.

◆ operator[]() [1/6]

template<typename DataType_>

DataType & Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::operator[] ( CellLocalId c )

inline

Valeur globale de la variable pour la maille c.

Définition à la ligne 109 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [2/6]

template<typename DataType_>

DataType Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::operator[] ( CellLocalId c ) const

inline

Valeur globale de la variable pour la maille c.

Définition à la ligne 103 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [3/6]

template<typename DataType_>

DataType & Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::operator[] ( ComponentItemLocalId mc )

inline

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

Définition à la ligne 97 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [4/6]

template<typename DataType_>

DataType Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::operator[] ( ComponentItemLocalId mc ) const

inline

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

Définition à la ligne 91 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [5/6]

template<typename DataType_>

DataType & Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::operator[] ( MatVarIndex mvi )

inlineprotected

Définition à la ligne 83 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [6/6]

template<typename DataType_>

DataType Arcane::Materials::CellEnvironmentVariableScalarRef< DataType_ >::operator[] ( MatVarIndex mvi ) const

inlineprotected

Définition à la ligne 79 du fichier core/materials/MeshEnvironmentVariableRef.h.

◆ refersTo()

template<typename DataType_>

void Arcane::Materials::CellEnvironmentVariableScalarRef< DataType >::refersTo ( const ThatClass & rhs )

virtual

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

Définition à la ligne 92 du fichier MeshEnvironmentVariableRef.cc.

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

◆ updateFromInternal()

template<typename DataType>

void Arcane::Materials::CellEnvironmentVariableScalarRef< DataType >::updateFromInternal ( )

overridevirtual

Implémente Arcane::Materials::MeshMaterialVariableRef.

Définition à la ligne 115 du fichier MeshEnvironmentVariableRef.cc.

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

Description détaillée

Documentation des définitions de type membres

◆ DataType

◆ GlobalVariableRefType

◆ ItemType

◆ PrivatePartType

◆ ThatClass

Documentation des constructeurs et destructeur

◆ CellEnvironmentVariableScalarRef() [1/2]

◆ CellEnvironmentVariableScalarRef() [2/2]

Documentation des fonctions membres

◆ _internalValue()

◆ envValue()

◆ fill()

◆ fillPartialValues()

◆ globalVariable() [1/2]

◆ globalVariable() [2/2]

◆ operator[]() [1/6]

◆ operator[]() [2/6]

◆ operator[]() [3/6]

◆ operator[]() [4/6]

◆ operator[]() [5/6]

◆ operator[]() [6/6]

◆ refersTo()

◆ updateFromInternal()