Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::Materials::IMeshMaterialVariableabstract

Interface d'une variable matériau d'un maillage. Plus de détails...

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

+ Graphe d'héritage de Arcane::Materials::IMeshMaterialVariable:
+ Graphe de collaboration de Arcane::Materials::IMeshMaterialVariable:

Fonctions membres publiques

virtual String name () const =0
 Nom de la variable.
 
virtual IVariableglobalVariable () const =0
 Variable globale sur le maillage associée.
 
virtual void buildFromManager (bool is_continue)=0
 
virtual void syncReferences ()=0
 Synchronise les références.
 
virtual void addVariableRef (MeshMaterialVariableRef *var_ref)=0
 Ajoute une référence à cette variable.
 
virtual void removeVariableRef (MeshMaterialVariableRef *var_ref)=0
 Supprime une référence à cette variable.
 
virtual MeshMaterialVariableReffirstReference () const =0
 
virtual IVariablematerialVariable (IMeshMaterial *mat)=0
 
virtual void setKeepOnChange (bool v)=0
 Indique si on souhaite conserver la valeur de la variable apres un changement de la liste des matériaux.
 
virtual bool keepOnChange () const =0
 Indique si on souhaite conserver la valeur de la variable apres un changement de la liste des matériaux.
 
virtual void synchronize ()=0
 Synchronise la variable.
 
virtual void synchronize (MeshMaterialVariableSynchronizerList &sync_list)=0
 
virtual void dumpValues (std::ostream &ostr)=0
 Affiche les valeurs de la variable sur le flot ostr.
 
virtual void dumpValues (std::ostream &ostr, AllEnvCellVectorView view)=0
 Affiche les valeurs de la variable pour la vue view sur le flot ostr.
 
virtual void fillPartialValuesWithGlobalValues ()=0
 Remplit les valeurs partielles avec la valeur de la maille globale associée.
 
virtual void fillPartialValuesWithSuperValues (Int32 level)=0
 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().
 
virtual void serialize (ISerializer *sbuffer, Int32ConstArrayView ids)=0
 Sérialise la variable pour les entités de numéro local ids.
 
virtual MatVarSpace space () const =0
 Espace de définition de la variable (matériau+milieu ou milieu uniquement)
 
Gestion des dépendances
virtual void update (IMeshMaterial *mat)=0
 Recalcule la variable pour le matériau mat si nécessaire.
 
virtual void setUpToDate (IMeshMaterial *mat)=0
 Indique que la variable vient d'être mise à jour.
 
virtual Int64 modifiedTime (IMeshMaterial *mat)=0
 Temps auquel la variable a été mise à jour.
 
virtual void addDepend (IMeshMaterialVariable *var)=0
 Ajoute var à la liste des dépendances.
 
virtual void addDepend (IMeshMaterialVariable *var, const TraceInfo &tinfo)=0
 Ajoute var à la liste des dépendances avec les infos de trace tinfo.
 
virtual void addDepend (IVariable *var)=0
 Ajoute var à la liste des dépendances.
 
virtual void addDepend (IVariable *var, const TraceInfo &tinfo)=0
 Ajoute var à la liste des dépendances avec les infos de trace tinfo.
 
virtual void removeDepend (IMeshMaterialVariable *var)=0
 Supprime var de la liste des dépendances.
 
virtual void removeDepend (IVariable *var)=0
 Supprime var de la liste des dépendances.
 
virtual void setComputeFunction (IMeshMaterialVariableComputeFunction *v)=0
 Positionne la fonction de recalcule de la variable.
 
virtual IMeshMaterialVariableComputeFunctioncomputeFunction ()=0
 Fonction utilisée pour mettre à jour la variable.
 
virtual void dependInfos (Array< VariableDependInfo > &infos, Array< MeshMaterialVariableDependInfo > &mat_infos)=0
 Infos de dépendances.
 
virtual IMeshMaterialVariableInternal * _internalApi ()=0
 

Description détaillée

Interface d'une variable matériau d'un maillage.

Définition à la ligne 46 du fichier core/materials/IMeshMaterialVariable.h.

Documentation des fonctions membres

◆ addDepend() [1/4]

virtual void Arcane::Materials::IMeshMaterialVariable::addDepend ( IMeshMaterialVariable var)
pure virtual

Ajoute var à la liste des dépendances.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ addDepend() [2/4]

virtual void Arcane::Materials::IMeshMaterialVariable::addDepend ( IMeshMaterialVariable var,
const TraceInfo tinfo 
)
pure virtual

Ajoute var à la liste des dépendances avec les infos de trace tinfo.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ addDepend() [3/4]

virtual void Arcane::Materials::IMeshMaterialVariable::addDepend ( IVariable var)
pure virtual

Ajoute var à la liste des dépendances.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ addDepend() [4/4]

virtual void Arcane::Materials::IMeshMaterialVariable::addDepend ( IVariable var,
const TraceInfo tinfo 
)
pure virtual

Ajoute var à la liste des dépendances avec les infos de trace tinfo.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ addVariableRef()

virtual void Arcane::Materials::IMeshMaterialVariable::addVariableRef ( MeshMaterialVariableRef var_ref)
pure virtual

Ajoute une référence à cette variable.

Précondition
var_ref ne doit pas déjà référencer une variable.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ computeFunction()

virtual IMeshMaterialVariableComputeFunction * Arcane::Materials::IMeshMaterialVariable::computeFunction ( )
pure virtual

Fonction utilisée pour mettre à jour la variable.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ dependInfos()

virtual void Arcane::Materials::IMeshMaterialVariable::dependInfos ( Array< VariableDependInfo > &  infos,
Array< MeshMaterialVariableDependInfo > &  mat_infos 
)
pure virtual

Infos de dépendances.

Remplit le tableau infos avec les infos de dépendance sur les variables globales et le tableau mat_infos avec celles sur les variables matériaux.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ dumpValues() [1/2]

virtual void Arcane::Materials::IMeshMaterialVariable::dumpValues ( std::ostream &  ostr)
pure virtual

Affiche les valeurs de la variable sur le flot ostr.

Implémenté dans Arcane::Materials::ItemMaterialVariableScalar< DataType >, et Arcane::Materials::ItemMaterialVariableArray< DataType >.

◆ dumpValues() [2/2]

virtual void Arcane::Materials::IMeshMaterialVariable::dumpValues ( std::ostream &  ostr,
AllEnvCellVectorView  view 
)
pure virtual

Affiche les valeurs de la variable pour la vue view sur le flot ostr.

Implémenté dans Arcane::Materials::ItemMaterialVariableScalar< DataType >, et Arcane::Materials::ItemMaterialVariableArray< DataType >.

◆ fillPartialValuesWithGlobalValues()

virtual void Arcane::Materials::IMeshMaterialVariable::fillPartialValuesWithGlobalValues ( )
pure virtual

◆ fillPartialValuesWithSuperValues()

virtual void Arcane::Materials::IMeshMaterialVariable::fillPartialValuesWithSuperValues ( Int32  level)
pure virtual

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

Implémenté dans Arcane::Materials::ItemMaterialVariableBase< Traits >, Arcane::Materials::ItemMaterialVariableBase< MaterialVariableArrayTraits< DataType > >, et Arcane::Materials::ItemMaterialVariableBase< MaterialVariableScalarTraits< DataType > >.

◆ globalVariable()

◆ keepOnChange()

virtual bool Arcane::Materials::IMeshMaterialVariable::keepOnChange ( ) const
pure virtual

Indique si on souhaite conserver la valeur de la variable apres un changement de la liste des matériaux.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ modifiedTime()

virtual Int64 Arcane::Materials::IMeshMaterialVariable::modifiedTime ( IMeshMaterial mat)
pure virtual

Temps auquel la variable a été mise à jour.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ name()

virtual String Arcane::Materials::IMeshMaterialVariable::name ( ) const
pure virtual

Nom de la variable.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ removeDepend() [1/2]

virtual void Arcane::Materials::IMeshMaterialVariable::removeDepend ( IMeshMaterialVariable var)
pure virtual

Supprime var de la liste des dépendances.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ removeDepend() [2/2]

virtual void Arcane::Materials::IMeshMaterialVariable::removeDepend ( IVariable var)
pure virtual

Supprime var de la liste des dépendances.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ removeVariableRef()

virtual void Arcane::Materials::IMeshMaterialVariable::removeVariableRef ( MeshMaterialVariableRef var_ref)
pure virtual

Supprime une référence à cette variable.

Précondition
var_ref doit référencer cette variable (un appel à addVariableRef() doit avoir été effectué sur cette variable).

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ serialize()

virtual void Arcane::Materials::IMeshMaterialVariable::serialize ( ISerializer sbuffer,
Int32ConstArrayView  ids 
)
pure virtual

Sérialise la variable pour les entités de numéro local ids.

Implémenté dans Arcane::Materials::ItemMaterialVariableScalar< DataType >, et Arcane::Materials::ItemMaterialVariableArray< DataType >.

◆ setComputeFunction()

virtual void Arcane::Materials::IMeshMaterialVariable::setComputeFunction ( IMeshMaterialVariableComputeFunction v)
pure virtual

Positionne la fonction de recalcule de la variable.

Si une fonction de recalcule existait déjà, elle est détruite et remplacée par celle-ci.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ setKeepOnChange()

virtual void Arcane::Materials::IMeshMaterialVariable::setKeepOnChange ( bool  v)
pure virtual

Indique si on souhaite conserver la valeur de la variable apres un changement de la liste des matériaux.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ setUpToDate()

virtual void Arcane::Materials::IMeshMaterialVariable::setUpToDate ( IMeshMaterial mat)
pure virtual

Indique que la variable vient d'être mise à jour.

Pour une gestion correcte des dépendances, il faut que cette propriété soit appelée toutes les fois où la mise à jour d'une variable a été effectuée.

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ space()

virtual MatVarSpace Arcane::Materials::IMeshMaterialVariable::space ( ) const
pure virtual

Espace de définition de la variable (matériau+milieu ou milieu uniquement)

Implémenté dans Arcane::Materials::MeshMaterialVariable.

◆ synchronize()

virtual void Arcane::Materials::IMeshMaterialVariable::synchronize ( )
pure virtual

Synchronise la variable.

La synchronisation se fait sur tous les matériaux de la maille. Il est indispensable que toutes mailles fantômes aient déjà le bon nombre de matériaux.

Implémenté dans Arcane::Materials::ItemMaterialVariableScalar< DataType >, et Arcane::Materials::ItemMaterialVariableArray< DataType >.

◆ syncReferences()

virtual void Arcane::Materials::IMeshMaterialVariable::syncReferences ( )
pure virtual

Synchronise les références.

Synchronise les valeurs des références (VariableRef) à cette variable avec la valeur actuelle de la variable. Cette méthode est appelé automatiquement lorsque le nombre d'éléments d'une variable tableau change.

Implémenté dans Arcane::Materials::ItemMaterialVariableBase< Traits >, Arcane::Materials::ItemMaterialVariableBase< MaterialVariableArrayTraits< DataType > >, et Arcane::Materials::ItemMaterialVariableBase< MaterialVariableScalarTraits< DataType > >.

◆ update()

virtual void Arcane::Materials::IMeshMaterialVariable::update ( IMeshMaterial mat)
pure virtual

Recalcule la variable pour le matériau mat si nécessaire.

Par le mécanisme de dépendances, cette opération est appelée récursivement sur toutes les variables dont dépend l'instance. La fonction de recalcul computeFunction() est ensuite appelée s'il s'avère qu'une des variables dont elle dépend a été modifiée plus récemment.

Précondition
computeFunction() != 0

Implémenté dans Arcane::Materials::MeshMaterialVariable.


La documentation de cette classe a été générée à partir du fichier suivant :