Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::MeshMDVariableRefT< ItemType, DataType, Extents > Class Template Reference

Class managing a multi-dimensional variable on a mesh entity. More...

#include <arcane/core/MeshMDVariableRef.h>

Inheritance diagram for Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >:
Collaboration diagram for Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >:

Public Types

using BaseClass = MeshMDVariableRefBaseT<ItemType, DataType, AddedFirstExtentsType>
using ItemLocalIdType = typename ItemType::LocalIdType
Public Types inherited from Arcane::MeshMDVariableRefBaseT< ItemType, DataType, Extents::template AddedFirstExtentsType< DynExtent > >
using UnderlyingVariableType
using MDSpanType
using ItemLocalIdType
using FullExtentsType

Public Member Functions

 MeshMDVariableRefT (const VariableBuildInfo &b)
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 0, void>>
DataType & operator() (ItemLocalIdType id)
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 0, void>>
const DataType & operator() (ItemLocalIdType id) const
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 1, void>>
DataType & operator() (ItemLocalIdType id, Int32 i1)
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 1, void>>
const DataType & operator() (ItemLocalIdType id, Int32 i1) const
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 2, void>>
DataType & operator() (ItemLocalIdType id, Int32 i1, Int32 i2)
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 2, void>>
const DataType & operator() (ItemLocalIdType id, Int32 i1, Int32 i2) const
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 3, void>>
DataType & operator() (ItemLocalIdType id, Int32 i, Int32 j, Int32 k)
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 3, void>>
const DataType & operator() (ItemLocalIdType id, Int32 i, Int32 j, Int32 k) const
void reshape (std::array< Int32, Extents::nb_dynamic > dims)
 Changes the data shape.
Public Member Functions inherited from Arcane::MeshMDVariableRefBaseT< ItemType, DataType, Extents::template AddedFirstExtentsType< DynExtent > >
 MeshMDVariableRefBaseT (const VariableBuildInfo &b)
UnderlyingVariableType & underlyingVariable ()
 Associated underlying variable.
ArrayShape fullShape () const
 Full shape (static + dynamic) of the variable.
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.
ISubDomainsubDomain () const
 Sub-domain associated with the variable (TODO deprecate end of 2023).
IVariableMngvariableMng () 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 IModulemodule () 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).
IVariablevariable () 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.
virtual Integer arraySize () const
 If the variable is an array, returns its dimension, otherwise returns 0.
void setUsed (bool v)
bool isUsed () const
virtual void internalSetUsed (bool)
const StringassignmentStackTrace () 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.
VariableRefpreviousReference ()
 Previous reference (or null) to variable().
VariableRefnextReference ()
 Next reference (or null) to variable().
void setPreviousReference (VariableRef *v)
 Sets the previous reference.
void setNextReference (VariableRef *v)
 Sets the next reference.

Static Public Attributes

static constexpr int nb_dynamic = Extents::nb_dynamic

Private Types

using AddedFirstExtentsType = typename Extents::template AddedFirstExtentsType<DynExtent>
using BasicType = typename DataTypeTraitsT<DataType>::BasicType

Additional Inherited Members

static void setTraceCreation (bool v)
static bool hasTraceCreation ()
Protected Member Functions inherited from Arcane::MeshMDVariableRefBaseT< ItemType, DataType, Extents::template AddedFirstExtentsType< DynExtent > >
void updateFromInternal () override
 Updates from the internal part.
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.
VariableRefoperator= (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::MeshMDVariableRefBaseT< ItemType, DataType, Extents::template AddedFirstExtentsType< DynExtent > >
impl::MeshMDVariableRefWrapperT< ItemType, DataType > m_underlying_var
MDSpanType m_mdspan
bool m_has_trace = false

Detailed Description

template<typename ItemType, typename DataType, typename Extents>
class Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >

Class managing a multi-dimensional variable on a mesh entity.

Warning
API is under definition. Do not use outside of Arcane.

Definition at line 149 of file MeshMDVariableRef.h.

Member Typedef Documentation

◆ AddedFirstExtentsType

template<typename ItemType, typename DataType, typename Extents>
using Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::AddedFirstExtentsType = typename Extents::template AddedFirstExtentsType<DynExtent>
private

Definition at line 152 of file MeshMDVariableRef.h.

◆ BaseClass

template<typename ItemType, typename DataType, typename Extents>
using Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::BaseClass = MeshMDVariableRefBaseT<ItemType, DataType, AddedFirstExtentsType>

Definition at line 159 of file MeshMDVariableRef.h.

◆ BasicType

template<typename ItemType, typename DataType, typename Extents>
using Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::BasicType = typename DataTypeTraitsT<DataType>::BasicType
private

Definition at line 153 of file MeshMDVariableRef.h.

◆ ItemLocalIdType

template<typename ItemType, typename DataType, typename Extents>
using Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::ItemLocalIdType = typename ItemType::LocalIdType

Definition at line 160 of file MeshMDVariableRef.h.

Constructor & Destructor Documentation

◆ MeshMDVariableRefT()

template<typename ItemType, typename DataType, typename Extents>
Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::MeshMDVariableRefT ( const VariableBuildInfo & b)
inlineexplicit

Definition at line 165 of file MeshMDVariableRef.h.

Member Function Documentation

◆ operator()() [1/8]

template<typename ItemType, typename DataType, typename Extents>
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 0, void>>
DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType id)
inline

Definition at line 172 of file MeshMDVariableRef.h.

◆ operator()() [2/8]

template<typename ItemType, typename DataType, typename Extents>
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 0, void>>
const DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType id) const
inline

Definition at line 178 of file MeshMDVariableRef.h.

◆ operator()() [3/8]

template<typename ItemType, typename DataType, typename Extents>
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 3, void>>
DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType id,
Int32 i,
Int32 j,
Int32 k )
inline

Definition at line 208 of file MeshMDVariableRef.h.

◆ operator()() [4/8]

template<typename ItemType, typename DataType, typename Extents>
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 3, void>>
const DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType id,
Int32 i,
Int32 j,
Int32 k ) const
inline

Definition at line 214 of file MeshMDVariableRef.h.

◆ operator()() [5/8]

template<typename ItemType, typename DataType, typename Extents>
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 1, void>>
DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType id,
Int32 i1 )
inline

Definition at line 184 of file MeshMDVariableRef.h.

◆ operator()() [6/8]

template<typename ItemType, typename DataType, typename Extents>
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 1, void>>
const DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType id,
Int32 i1 ) const
inline

Definition at line 190 of file MeshMDVariableRef.h.

◆ operator()() [7/8]

template<typename ItemType, typename DataType, typename Extents>
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 2, void>>
DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType id,
Int32 i1,
Int32 i2 )
inline

Definition at line 196 of file MeshMDVariableRef.h.

◆ operator()() [8/8]

template<typename ItemType, typename DataType, typename Extents>
template<typename X = Extents, typename = std::enable_if_t<X::rank() == 2, void>>
const DataType & Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::operator() ( ItemLocalIdType id,
Int32 i1,
Int32 i2 ) const
inline

Definition at line 202 of file MeshMDVariableRef.h.

◆ reshape()

template<typename ItemType, typename DataType, typename Extents>
void Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::reshape ( std::array< Int32, Extents::nb_dynamic > dims)
inline

Changes the data shape.

The number of elements in dims must correspond to the number of dynamic values in Extents.

Definition at line 225 of file MeshMDVariableRef.h.

Member Data Documentation

◆ nb_dynamic

template<typename ItemType, typename DataType, typename Extents>
int Arcane::MeshMDVariableRefT< ItemType, DataType, Extents >::nb_dynamic = Extents::nb_dynamic
staticconstexpr

Definition at line 161 of file MeshMDVariableRef.h.


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