Référence du modèle de la classe 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. Plus de détails...

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

Graphe d'héritage de Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >:

Graphe de collaboration de Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >:

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)
	CellMaterialVariableScalarRef (const MaterialVariableBuildInfo &vb)
	Construit une référence à la variable spécifiée dans vb.
	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 null) sur variable()
MeshMaterialVariableRef *	nextReference ()
	Référence suivante (ou null) sur variable()
void	setPreviousReference (MeshMaterialVariableRef *v)
	Positionne la référence précédente.
void	setNextReference (MeshMaterialVariableRef *v)
	Positionne la référence suivante.
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 les sous-domaines.
void	synchronize (MeshMaterialVariableSynchronizerList &sync_list)
	Ajoute cette variable à la liste des synchronisations sync_list.
MatVarSpace	space () const
	Espace de définition de la variable (matériau+milieu ou milieu uniquement)
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

Fonctions membres privées
void	_init ()
void	_setContainerView ()

Attributs privés
PrivatePartType *	m_private_part = nullptr
ArrayView< DataType > *	m_value = nullptr
ArrayView< ArrayView< DataType > >	m_container_value

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 210 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 215 du fichier core/materials/MeshMaterialVariableRef.h.

GlobalVariableRefType

template<typename DataType_ >

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

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

ItemType

template<typename DataType_ >

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

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

PrivatePartType

template<typename DataType_ >

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

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

ThatClass

template<typename DataType_ >

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

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

Documentation des constructeurs et destructeur

CellMaterialVariableScalarRef() [1/2]

template<typename DataType >

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

explicit

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

CellMaterialVariableScalarRef() [2/2]

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 265 du fichier MeshMaterialVariableRef.cc.

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

Documentation des fonctions membres

_init()

template<typename DataType >

void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::_init ( )

private

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

_internalValue()

template<typename DataType_ >

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

inline

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

_setContainerView()

template<typename DataType >

void Arcane::Materials::CellMaterialVariableScalarRef< DataType >::_setContainerView ( )

private

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

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 359 du fichier MeshMaterialVariableRef.cc.

Références ENUMERATE_CELL_ENVCELL.

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 491 du fichier MeshMaterialVariableRef.cc.

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;
}

Définition à la ligne 386 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 407 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 504 du fichier MeshMaterialVariableRef.cc.

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 463 du fichier MeshMaterialVariableRef.cc.

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 478 du fichier MeshMaterialVariableRef.cc.

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 428 du fichier MeshMaterialVariableRef.cc.

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 449 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 517 du fichier MeshMaterialVariableRef.cc.

Références ARCANE_FATAL.

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 530 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 341 du fichier MeshMaterialVariableRef.cc.

Références ENUMERATE_CELL_ENVCELL, et ENUMERATE_CELL_MATCELL.

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 277 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 271 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 289 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 283 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 265 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 259 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 251 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 247 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 301 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 295 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 309 du fichier MeshMaterialVariableRef.cc.

updateFromInternal()

template<typename DataType >

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

overridevirtual

Implémente Arcane::Materials::MeshMaterialVariableRef.

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

Documentation des données membres

m_container_value

template<typename DataType_ >

ArrayView<ArrayView<DataType> > Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::m_container_value

private

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

m_private_part

template<typename DataType_ >

PrivatePartType* Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::m_private_part = nullptr

private

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

m_value

template<typename DataType_ >

ArrayView<DataType>* Arcane::Materials::CellMaterialVariableScalarRef< DataType_ >::m_value = nullptr

private

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

---

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

• MaterialsCoreGlobal.h
• core/materials/MeshMaterialVariableRef.h
• MeshMaterialVariableRef.cc