Array variable on the cells of a mesh material. For now, this class is only instantiated for cells. More...

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

Public Types
using	DataType = DataType_
using	PrivatePartType = IArrayMeshMaterialVariable<Cell, DataType>
using	ItemType = Cell
using	GlobalVariableRefType = MeshVariableArrayRefT<ItemType, DataType>
using	ThatClass = CellEnvironmentVariableArrayRef<DataType>

Public Member Functions
	CellEnvironmentVariableArrayRef (const VariableBuildInfo &vb)
	CellEnvironmentVariableArrayRef (const MaterialVariableBuildInfo &vb)
	Constructs a reference to the variable specified in vb.
	CellEnvironmentVariableArrayRef (const ThatClass &rhs)
ThatClass &	operator= (const ThatClass &rhs)=delete
	Copy assignment operator (deleted).
	CellEnvironmentVariableArrayRef ()=delete
	Default constructor (deleted).
virtual void	refersTo (const ThatClass &rhs)
	Positions the instance reference to the variable rhs.
void	updateFromInternal () override
GlobalVariableRefType &	globalVariable ()
	Global variable associated with this material variable.
const GlobalVariableRefType &	globalVariable () const
	Global variable associated with this material variable.
void	resize (Integer dim2_size)
	Resizes the number of elements in the array.
ConstArrayView< DataType >	operator[] (ComponentItemLocalId mc) const
	Partial value of the variable for material cell mc.
ArrayView< DataType >	operator[] (ComponentItemLocalId mc)
	Partial value of the variable for material cell mc.
ConstArrayView< DataType >	operator[] (CellLocalId c) const
	Global value of the variable for cell c.
ArrayView< DataType >	operator[] (CellLocalId c)
	Global value of the variable for cell c.
Public Member Functions inherited from Arcane::Materials::MeshMaterialVariableRef
MeshMaterialVariableRef *	previousReference ()
	Previous reference (or null) on variable().
MeshMaterialVariableRef *	nextReference ()
	Next reference (or null) on variable().
void	setPreviousReference (MeshMaterialVariableRef *v)
void	setNextReference (MeshMaterialVariableRef *v)
void	registerVariable ()
	Registers the variable (internal).
void	unregisterVariable ()
	Unregisters the variable (internal).
IMeshMaterialVariable *	materialVariable () const
	Associated material variable.
void	synchronize ()
	Synchronizes values between sub-domains.
void	synchronize (MeshMaterialVariableSynchronizerList &sync_list)
	Adds this variable to the synchronization list sync_list.
MatVarSpace	space () const
	Definition space of the variable (material+environment or environment only).
void	fillPartialValuesWithSuperValues (Int32 level)
	Fills partial values with the super cell value. If level is LEVEL_MATERIAL, copies material values with those of the environment. If level is LEVEL_ENVIRONMENT, copies environment values with those of the global cell. If level is LEVEL_ALLENVIRONMENT, fills all partial values with those of the global cell (this makes this method equivalent to 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 *)
	Functions to manage dependencies on the material part of the 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 *))

Protected Member Functions
ConstArrayView< DataType >	operator[] (MatVarIndex mvi) const
ArrayView< DataType >	operator[] (MatVarIndex mvi)
Protected Member Functions inherited from Arcane::Materials::MeshMaterialVariableRef
void	_internalInit (IMeshMaterialVariable *mat_variable)
bool	_isRegistered () const

Detailed Description

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

Array variable on the cells of a mesh material. For now, this class is only instantiated for cells.

Definition at line 159 of file core/materials/MeshEnvironmentVariableRef.h.

Member Typedef Documentation

◆ DataType

template<typename DataType_>

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

Definition at line 164 of file core/materials/MeshEnvironmentVariableRef.h.

◆ GlobalVariableRefType

template<typename DataType_>

using Arcane::Materials::CellEnvironmentVariableArrayRef< DataType_ >::GlobalVariableRefType = MeshVariableArrayRefT<ItemType, DataType>

Definition at line 167 of file core/materials/MeshEnvironmentVariableRef.h.

◆ ItemType

template<typename DataType_>

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

Definition at line 166 of file core/materials/MeshEnvironmentVariableRef.h.

◆ PrivatePartType

template<typename DataType_>

using Arcane::Materials::CellEnvironmentVariableArrayRef< DataType_ >::PrivatePartType = IArrayMeshMaterialVariable<Cell, DataType>

Definition at line 165 of file core/materials/MeshEnvironmentVariableRef.h.

◆ ThatClass

template<typename DataType_>

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

Definition at line 168 of file core/materials/MeshEnvironmentVariableRef.h.

Constructor & Destructor Documentation

◆ CellEnvironmentVariableArrayRef() [1/2]

template<typename DataType>

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

explicit

Definition at line 214 of file MeshEnvironmentVariableRef.cc.

◆ CellEnvironmentVariableArrayRef() [2/2]

template<typename DataType>

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

explicit

Constructs a reference to the variable specified in vb.

Definition at line 224 of file MeshEnvironmentVariableRef.cc.

Member Function Documentation

◆ globalVariable() [1/2]

template<typename DataType>

MeshVariableArrayRefT< Cell, DataType > & Arcane::Materials::CellEnvironmentVariableArrayRef< DataType >::globalVariable ( )

Global variable associated with this material variable.

Definition at line 302 of file MeshEnvironmentVariableRef.cc.

References ARCANE_FATAL.

◆ globalVariable() [2/2]

template<typename DataType>

const MeshVariableArrayRefT< Cell, DataType > & Arcane::Materials::CellEnvironmentVariableArrayRef< DataType >::globalVariable ( ) const

Global variable associated with this material variable.

Definition at line 315 of file MeshEnvironmentVariableRef.cc.

References ARCANE_FATAL.

◆ operator[]() [1/6]

template<typename DataType_>

ArrayView< DataType > Arcane::Materials::CellEnvironmentVariableArrayRef< DataType_ >::operator[] ( CellLocalId c )

inline

Global value of the variable for cell c.

Definition at line 243 of file core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [2/6]

template<typename DataType_>

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

inline

Global value of the variable for cell c.

Definition at line 237 of file core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [3/6]

template<typename DataType_>

ArrayView< DataType > Arcane::Materials::CellEnvironmentVariableArrayRef< DataType_ >::operator[] ( ComponentItemLocalId mc )

inline

Partial value of the variable for material cell mc.

Definition at line 231 of file core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [4/6]

template<typename DataType_>

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

inline

Partial value of the variable for material cell mc.

Definition at line 225 of file core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [5/6]

template<typename DataType_>

ArrayView< DataType > Arcane::Materials::CellEnvironmentVariableArrayRef< DataType_ >::operator[] ( MatVarIndex mvi )

inlineprotected

Definition at line 217 of file core/materials/MeshEnvironmentVariableRef.h.

◆ operator[]() [6/6]

template<typename DataType_>

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

inlineprotected

Definition at line 213 of file core/materials/MeshEnvironmentVariableRef.h.

◆ refersTo()

template<typename DataType_>

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

virtual

Positions the instance reference to the variable rhs.

Definition at line 268 of file MeshEnvironmentVariableRef.cc.

References Arcane::Materials::MeshMaterialVariableRef::unregisterVariable().

◆ resize()

template<typename DataType>

void Arcane::Materials::CellEnvironmentVariableArrayRef< DataType >::resize ( Integer dim2_size )

Resizes the number of elements in the array.

The first dimension always remains equal to the number of mesh elements. Only the second component is resized.

Definition at line 328 of file MeshEnvironmentVariableRef.cc.

◆ updateFromInternal()

template<typename DataType>

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

overridevirtual

Implements Arcane::Materials::MeshMaterialVariableRef.

Definition at line 292 of file MeshEnvironmentVariableRef.cc.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ DataType

◆ GlobalVariableRefType

◆ ItemType

◆ PrivatePartType

◆ ThatClass

Constructor & Destructor Documentation

◆ CellEnvironmentVariableArrayRef() [1/2]

◆ CellEnvironmentVariableArrayRef() [2/2]

Member Function Documentation

◆ 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()

◆ resize()

◆ updateFromInternal()