Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::impl::MeshMDVariableRefWrapperT< ItemType, DataType > Class Template Reference

Public Types

using BaseClass = MeshVariableArrayRefT<ItemType, DataType>
using VariableType = typename BaseClass::PrivatePartType
using ValueDataType = typename VariableType::ValueDataType
Public Types inherited from Arcane::MeshVariableArrayRefT< ItemType, DataType >
typedef DataType DataType
typedef ItemType ItemType
typedef UniqueArray2< DataType > ValueType
typedef ConstArrayView< DataType > ConstReturnReferenceType
typedef ArrayView< DataType > ReturnReferenceType
Public Types inherited from Arcane::ItemVariableArrayRefT< DataTypeT >
typedef DataTypeT DataType
typedef UniqueArray2< DataType > ValueType
typedef ConstArrayView< DataType > ConstReturnReferenceType
typedef ArrayView< DataType > ReturnReferenceType

Friends

template<typename _ItemType, typename _DataType, typename _Extents>
class Arcane::MeshMDVariableRefBaseT

Additional Inherited Members

Public Member Functions inherited from Arcane::MeshVariableArrayRefT< ItemType, DataType >
 MeshVariableArrayRefT (const VariableBuildInfo &b)
 Constructs a reference to the variable specified in vb.
 MeshVariableArrayRefT (IVariable *var)
 Constructs a reference from var.
 MeshVariableArrayRefT (const MeshVariableArrayRefT< ItemType, DataType > &rhs)
 Constructs a reference from rhs.
void refersTo (const MeshVariableArrayRefT< ItemType, DataType > &rhs)
 Positions the instance reference to the variable rhs.
ThatClass & operator= (const ThatClass &rhs)=delete
ConstArrayType operator[] (ItemLocalIdType item) const
 Read-only value of entity item.
ArrayType operator[] (ItemLocalIdType item)
 Modifiable value of entity item.
const DataType operator() (ItemLocalIdType item, Int32 i) const
 Read-only value of the i-th value of entity item.
DataType & operator() (ItemLocalIdType item, Int32 i)
 Modifiable value of the i-th value of entity item.
GroupType itemGroup () const
 Group associated with the quantity.
void swapValues (MeshVariableArrayRefT< ItemType, DataType > &rhs)
 Swaps the values of the variable rhs with those of the instance.
Public Member Functions inherited from Arcane::ItemVariableArrayRefT< DataTypeT >
 ItemVariableArrayRefT (const VariableBuildInfo &b, eItemKind ik)
 Constructs a reference to the variable specified in vb.
 ItemVariableArrayRefT (IVariable *var)
 Constructs a reference from var.
 ItemVariableArrayRefT (const ItemVariableArrayRefT< DataType > &rhs)
 Constructs a reference from rhs.
ConstArrayType operator[] (ItemLocalId item) const
 Read-only value of entity item.
ArrayType operator[] (ItemLocalId item)
 Modifiable value of entity item.
const DataType operator() (ItemLocalId item, Int32 i) const
 Read-only value of the i-th value of entity item.
DataType & operator() (ItemLocalId item, Int32 i)
 Modifiable value of the i-th value of entity item.
void copy (const ItemVariableArrayRefT< DataType > &v)
 Copies the values of v into this variable.
void copy (const ItemVariableArrayRefT< DataType > &v, const ItemGroup &group)
 Copies the values of v for the group group into this variable.
void copy (const ItemVariableArrayRefT< DataType > &v, RunQueue *queue)
 Copies the values of v into this variable via the queue queue.
void fill (const DataType &value)
 Fills the variable with the value value.
void fill (const DataType &value, const ItemGroup &group)
 Fills the variable with the value value for the entities in group group.
void fill (const DataType &value, RunQueue *queue)
 Fills the variable with the value value via the queue queue.
Public Member Functions inherited from Arcane::PrivateVariableArrayT< DataTypeT >
Array2View< DataTypeT > asArray ()
Integer totalNbElement () const
Integer arraySize () const
 If the variable is an array, returns its dimension, otherwise returns 0.
bool isArrayVariable () const
void updateFromInternal ()
 Updates from the internal part.
ItemGroup itemGroup () const
void resize (Int32 dim2_size)
void resizeAndReshape (const ArrayShape &shape)
SmallSpan2< DataTypeT > _internalSpan ()
SmallSpan2< const DataTypeT > _internalConstSpan () const
Public Member Functions inherited from Arcane::MeshVariableRef
 MeshVariableRef (const VariableBuildInfo &vb)
 Constructs a reference linked to the module.
void synchronize ()
void synchronize (Int32ConstArrayView local_ids)
Public Member Functions inherited from Arcane::VariableRef
virtual ~VariableRef ()
 Releases resources.
ISubDomain * subDomain () const
 Sub-domain associated with the variable (TODO deprecate end of 2023).
IVariableMng * variableMng () const
 Variable manager associated with the variable.
String name () const
 Variable name.
virtual eDataType dataType () const
 Variable type (Real, Integer, ...).
virtual void print (std::ostream &o) const
 Prints the variable value.
virtual IModule * module () const
 Module associated with the variable (or nullptr, if none).
virtual int property () const
 Variable properties.
virtual int referenceProperty () const
 Reference properties (internal).
virtual void setProperty (int property)
 Sets the property property.
virtual void unsetProperty (int property)
 Unsets the property property.
virtual void registerVariable ()
 Registers the variable (internal).
virtual void unregisterVariable ()
 Unregisters the variable (internal).
IVariable * variable () const
 Associated variable.
virtual Integer checkIfSync (int max_print=0)
 Checks if the variable is synchronized.
virtual Integer checkIfSameOnAllReplica (int max_print=0)
 Checks if the variable has the same values on all replicas.
void setUsed (bool v)
bool isUsed () const
virtual void internalSetUsed (bool)
const String & assignmentStackTrace () const
 Call stack at the time of assigning this instance.
void addTag (const String &tagname, const String &tagvalue)
 Adds the tag tagname with the value tagvalue.
void removeTag (const String &tagname)
 Removes the tag tagname.
bool hasTag (const String &tagname) const
 true if the variable has the tag tagname
String tagValue (const String &tagname) const
 Value of the tag tagname. The string is null if the tag does not exist.
void update ()
 Recalculates the variable if necessary.
void setUpToDate ()
 Indicates that the variable has just been updated.
Int64 modifiedTime ()
 Time when the variable was updated.
void addDependCurrentTime (const VariableRef &var)
 Adds var to the dependency list at the current time.
void addDependCurrentTime (const VariableRef &var, const TraceInfo &tinfo)
 Adds var to the dependency list at the current time with trace info tinfo.
void addDependPreviousTime (const VariableRef &var)
 Adds var to the dependency list at the previous time.
void addDependPreviousTime (const VariableRef &var, const TraceInfo &tinfo)
 Adds var to the dependency list at the previous time with trace info tinfo.
void removeDepend (const VariableRef &var)
 Removes var from the dependency list.
template<typename ClassType>
void setComputeFunction (ClassType *instance, void(ClassType::*func)())
 Sets the variable's recalculation function.
template<typename ClassType>
void setComputeFunction (ClassType *instance, void(ClassType::*func)(), const TraceInfo &tinfo)
 Sets the variable's recalculation function.
VariableRef * previousReference ()
 Previous reference (or null) to variable().
VariableRef * nextReference ()
 Next reference (or null) to variable().
void setPreviousReference (VariableRef *v)
void setNextReference (VariableRef *v)
Static Public Member Functions inherited from Arcane::MeshVariableArrayRefT< ItemType, DataType >
static VariableTypeInfo _internalVariableTypeInfo ()
static VariableInfo _internalVariableInfo (const VariableBuildInfo &vbi)
Static Public Member Functions inherited from Arcane::ItemVariableArrayRefT< DataTypeT >
static VariableInfo _internalVariableInfo (const VariableBuildInfo &vbi, eItemKind ik)
static VariableTypeInfo _internalVariableTypeInfo (eItemKind ik)
static void setTraceCreation (bool v)
static bool hasTraceCreation ()
Protected Types inherited from Arcane::MeshVariableArrayRefT< ItemType, DataType >
typedef MeshVariableRef BaseClass
typedef Array2View< DataType > ArrayBase
typedef ArrayView< DataType > ArrayType
typedef ConstArrayView< DataType > ConstArrayType
typedef Array2VariableT< DataType > PrivatePartType
typedef ItemTraitsT< ItemType >::ItemGroupType GroupType
typedef ItemType::LocalIdType ItemLocalIdType
typedef MeshVariableArrayRefT< ItemType, DataType > ThatClass
Protected Types inherited from Arcane::ItemVariableArrayRefT< DataTypeT >
typedef PrivateVariableArrayT< DataType > BaseClass
typedef BaseClass::PrivatePartType PrivatePartType
typedef ArrayView< DataType > ArrayType
typedef ConstArrayView< DataType > ConstArrayType
Protected Types inherited from Arcane::PrivateVariableArrayT< DataTypeT >
typedef DataTypeT & DataTypeReturnReference
typedef Array2VariableT< DataTypeT > PrivatePartType
Protected Member Functions inherited from Arcane::ItemVariableArrayRefT< DataTypeT >
ItemVariableArrayRefT< DataType > & operator= (const ItemVariableArrayRefT< DataType > &rhs)
 Positions the instance reference to the variable rhs.
Protected Member Functions inherited from Arcane::PrivateVariableArrayT< DataTypeT >
 PrivateVariableArrayT (const VariableBuildInfo &vb, const VariableInfo &vi)
void operator= (const PrivateVariableArrayT &rhs)
void _internalInit ()
Protected Member Functions inherited from Arcane::MeshVariableRef
 MeshVariableRef (const MeshVariableRef &rhs)
 MeshVariableRef (IVariable *var)
void operator= (const MeshVariableRef &rhs)
void _internalInit (IVariable *)
Protected Member Functions inherited from Arcane::VariableRef
 VariableRef (const VariableBuildInfo &vbi)
 Constructs a reference to a variable with the infos vbi.
 VariableRef (const VariableRef &from)
 Copy constructor.
 VariableRef (IVariable *var)
 Constructs a reference to a variable var.
VariableRef & operator= (const VariableRef &from)
 Copy assignment operator.
 VariableRef ()
 Default constructor.
void _setComputeFunction (IVariableComputeFunction *v)
void _internalInit (IVariable *)
 Internal initialization of the variable.
IVariable * _variable () const
 Referenced variable.
void _executeUpdateFunctors ()
void _internalAssignVariable (const VariableRef &var)
Protected Attributes inherited from Arcane::PrivateVariableArrayT< DataTypeT >
PrivatePartType * m_private_part
Array2View< DataTypeT > m_view
bool m_has_trace = false

Detailed Description

template<typename ItemType, typename DataType>
class Arcane::impl::MeshMDVariableRefWrapperT< ItemType, DataType >

Definition at line 46 of file MeshMDVariableRef.h.

Member Typedef Documentation

◆ BaseClass

template<typename ItemType, typename DataType>
using Arcane::impl::MeshMDVariableRefWrapperT< ItemType, DataType >::BaseClass = MeshVariableArrayRefT<ItemType, DataType>

Definition at line 54 of file MeshMDVariableRef.h.

◆ ValueDataType

template<typename ItemType, typename DataType>
using Arcane::impl::MeshMDVariableRefWrapperT< ItemType, DataType >::ValueDataType = typename VariableType::ValueDataType

Definition at line 56 of file MeshMDVariableRef.h.

◆ VariableType

template<typename ItemType, typename DataType>
using Arcane::impl::MeshMDVariableRefWrapperT< ItemType, DataType >::VariableType = typename BaseClass::PrivatePartType

Definition at line 55 of file MeshMDVariableRef.h.

◆ Arcane::MeshMDVariableRefBaseT

template<typename ItemType, typename DataType>
template<typename _ItemType, typename _DataType, typename _Extents>
friend class Arcane::MeshMDVariableRefBaseT
friend

Definition at line 50 of file MeshMDVariableRef.h.

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