Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::Materials::MeshMaterialVariableRef Class Referenceabstract

Base class for material variable references. More...

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

Classes

class  Enumerator

Public Member Functions

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).
virtual void updateFromInternal ()=0
IMeshMaterialVariablematerialVariable () 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

void _internalInit (IMeshMaterialVariable *mat_variable)
bool _isRegistered () const

Detailed Description

Base class for material variable references.

Definition at line 49 of file core/materials/MeshMaterialVariableRef.h.

Constructor & Destructor Documentation

◆ MeshMaterialVariableRef()

Arcane::Materials::MeshMaterialVariableRef::MeshMaterialVariableRef ( )

Definition at line 36 of file MeshMaterialVariableRef.cc.

◆ ~MeshMaterialVariableRef()

Arcane::Materials::MeshMaterialVariableRef::~MeshMaterialVariableRef ( )
virtual

Definition at line 44 of file MeshMaterialVariableRef.cc.

Member Function Documentation

◆ _internalInit()

void Arcane::Materials::MeshMaterialVariableRef::_internalInit ( IMeshMaterialVariable * mat_variable)
protected

Definition at line 76 of file MeshMaterialVariableRef.cc.

◆ _isRegistered()

bool Arcane::Materials::MeshMaterialVariableRef::_isRegistered ( ) const
inlineprotected

Definition at line 181 of file core/materials/MeshMaterialVariableRef.h.

◆ addDependCurrentTime() [1/3]

void Arcane::Materials::MeshMaterialVariableRef::addDependCurrentTime ( const MeshMaterialVariableRef & var)

Definition at line 185 of file MeshMaterialVariableRef.cc.

◆ addDependCurrentTime() [2/3]

void Arcane::Materials::MeshMaterialVariableRef::addDependCurrentTime ( const VariableRef & var)

Definition at line 174 of file MeshMaterialVariableRef.cc.

◆ addDependCurrentTime() [3/3]

void Arcane::Materials::MeshMaterialVariableRef::addDependCurrentTime ( const VariableRef & var,
const TraceInfo & tinfo )

Definition at line 179 of file MeshMaterialVariableRef.cc.

◆ addDependPreviousTime()

void Arcane::Materials::MeshMaterialVariableRef::addDependPreviousTime ( const MeshMaterialVariableRef & var)

Definition at line 191 of file MeshMaterialVariableRef.cc.

◆ addMaterialDepend() [1/4]

void Arcane::Materials::MeshMaterialVariableRef::addMaterialDepend ( const MeshMaterialVariableRef & var)

Definition at line 230 of file MeshMaterialVariableRef.cc.

◆ addMaterialDepend() [2/4]

void Arcane::Materials::MeshMaterialVariableRef::addMaterialDepend ( const MeshMaterialVariableRef & var,
const TraceInfo & tinfo )

Definition at line 236 of file MeshMaterialVariableRef.cc.

◆ addMaterialDepend() [3/4]

void Arcane::Materials::MeshMaterialVariableRef::addMaterialDepend ( const VariableRef & var)

Definition at line 218 of file MeshMaterialVariableRef.cc.

◆ addMaterialDepend() [4/4]

void Arcane::Materials::MeshMaterialVariableRef::addMaterialDepend ( const VariableRef & var,
const TraceInfo & tinfo )

Definition at line 224 of file MeshMaterialVariableRef.cc.

◆ fillPartialValuesWithSuperValues()

void Arcane::Materials::MeshMaterialVariableRef::fillPartialValuesWithSuperValues ( Int32 level)
inline

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

Definition at line 137 of file core/materials/MeshMaterialVariableRef.h.

◆ isUsed()

bool Arcane::Materials::MeshMaterialVariableRef::isUsed ( ) const

Definition at line 163 of file MeshMaterialVariableRef.cc.

◆ materialVariable()

◆ name()

String Arcane::Materials::MeshMaterialVariableRef::name ( ) const

Definition at line 153 of file MeshMaterialVariableRef.cc.

◆ nextReference()

MeshMaterialVariableRef * Arcane::Materials::MeshMaterialVariableRef::nextReference ( )

Next reference (or null) on variable().

Definition at line 97 of file MeshMaterialVariableRef.cc.

Referenced by Arcane::Materials::MeshMaterialVariable::removeVariableRef().

◆ previousReference()

MeshMaterialVariableRef * Arcane::Materials::MeshMaterialVariableRef::previousReference ( )

Previous reference (or null) on variable().

Definition at line 88 of file MeshMaterialVariableRef.cc.

Referenced by Arcane::Materials::MeshMaterialVariable::addVariableRef(), and Arcane::Materials::MeshMaterialVariable::removeVariableRef().

◆ registerVariable()

void Arcane::Materials::MeshMaterialVariableRef::registerVariable ( )

Registers the variable (internal).

Definition at line 65 of file MeshMaterialVariableRef.cc.

◆ removeDepend()

void Arcane::Materials::MeshMaterialVariableRef::removeDepend ( const MeshMaterialVariableRef & var)

Definition at line 197 of file MeshMaterialVariableRef.cc.

◆ setComputeFunction()

template<typename ClassType>
void Arcane::Materials::MeshMaterialVariableRef::setComputeFunction ( ClassType * instance,
void(ClassType::* func )() )
inline

Definition at line 157 of file core/materials/MeshMaterialVariableRef.h.

◆ setMaterialComputeFunction()

template<typename ClassType>
void Arcane::Materials::MeshMaterialVariableRef::setMaterialComputeFunction ( ClassType * instance,
void(ClassType::* func )(IMeshMaterial *) )
inline

Definition at line 172 of file core/materials/MeshMaterialVariableRef.h.

◆ setNextReference()

void Arcane::Materials::MeshMaterialVariableRef::setNextReference ( MeshMaterialVariableRef * v)

Definition at line 115 of file MeshMaterialVariableRef.cc.

◆ setPreviousReference()

void Arcane::Materials::MeshMaterialVariableRef::setPreviousReference ( MeshMaterialVariableRef * v)

Definition at line 106 of file MeshMaterialVariableRef.cc.

◆ setUpToDate() [1/2]

void Arcane::Materials::MeshMaterialVariableRef::setUpToDate ( )

Definition at line 158 of file MeshMaterialVariableRef.cc.

◆ setUpToDate() [2/2]

void Arcane::Materials::MeshMaterialVariableRef::setUpToDate ( IMeshMaterial * mat)

Functions to manage dependencies on the material part of the variable.

Definition at line 206 of file MeshMaterialVariableRef.cc.

◆ space()

MatVarSpace Arcane::Materials::MeshMaterialVariableRef::space ( ) const
inline

Definition space of the variable (material+environment or environment only).

Definition at line 126 of file core/materials/MeshMaterialVariableRef.h.

◆ synchronize() [1/2]

void Arcane::Materials::MeshMaterialVariableRef::synchronize ( )

Synchronizes values between sub-domains.

Definition at line 133 of file MeshMaterialVariableRef.cc.

◆ synchronize() [2/2]

void Arcane::Materials::MeshMaterialVariableRef::synchronize ( MeshMaterialVariableSynchronizerList & sync_list)

Adds this variable to the synchronization list sync_list.

Definition at line 143 of file MeshMaterialVariableRef.cc.

◆ unregisterVariable()

◆ update() [1/2]

void Arcane::Materials::MeshMaterialVariableRef::update ( )

Definition at line 168 of file MeshMaterialVariableRef.cc.

◆ update() [2/2]

void Arcane::Materials::MeshMaterialVariableRef::update ( IMeshMaterial * mat)

Definition at line 212 of file MeshMaterialVariableRef.cc.


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