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

Représente un index sur les variables matériaux et milieux. Plus de détails...

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

+ Graphe de collaboration de Arcane::Materials::MatVarIndex:

Fonctions membres publiques

constexpr __host__ __device__ MatVarIndex (Int32 array_index, Int32 value_index)
 
constexpr __host__ __device__ Int32 arrayIndex () const
 Retourne l'indice du tableau de valeur dans la liste des variables.
 
constexpr __host__ __device__ Int32 valueIndex () const
 Retourne l'indice dans le tableau de valeur.
 
constexpr __host__ __device__ void setIndex (Int32 array_index, Int32 value_index)
 Positionne l'index.
 
constexpr __host__ __device__ void reset ()
 Positionne l'entité à l'instance nulle.
 
constexpr __host__ __device__ bool null () const
 Indique si l'instance représente l'entité nulle.
 
constexpr __host__ __device__ bool isNull () const
 Indique si l'instance représente l'entité nulle.
 

Amis

constexpr __host__ __device__ friend bool operator== (MatVarIndex mv1, MatVarIndex mv2)
 Opérateur de comparaison.
 
constexpr __host__ __device__ friend bool operator!= (MatVarIndex mv1, MatVarIndex mv2)
 Opérateur de comparaison.
 
std::ostream & operator<< (std::ostream &o, const MatVarIndex &mvi)
 Opérateur d'écriture.
 

Description détaillée

Représente un index sur les variables matériaux et milieux.

L'index comprend 2 valeurs:

  • la première (arrayIndex()) est le numéro dans la liste des tableaux de la variable.
  • le deuxième (valueIndex()) est l'indice dans le tableau des valeurs de cette variable.
Note
Pour des raisons de performance, le constructeur par défaut n'initialise par les membres de cette classe. Il faut donc appeler reset() pour initialiser à une valeur invalide.

Définition à la ligne 38 du fichier core/materials/MatVarIndex.h.

Documentation des constructeurs et destructeur

◆ MatVarIndex() [1/2]

constexpr __host__ __device__ Arcane::Materials::MatVarIndex::MatVarIndex ( Int32  array_index,
Int32  value_index 
)
inlineconstexpr

Définition à la ligne 42 du fichier core/materials/MatVarIndex.h.

◆ MatVarIndex() [2/2]

__host__ __device__ Arcane::Materials::MatVarIndex::MatVarIndex ( )
inline

Définition à la ligne 47 du fichier core/materials/MatVarIndex.h.

Documentation des fonctions membres

◆ arrayIndex()

◆ isNull()

constexpr __host__ __device__ bool Arcane::Materials::MatVarIndex::isNull ( ) const
inlineconstexpr

Indique si l'instance représente l'entité nulle.

Définition à la ligne 78 du fichier core/materials/MatVarIndex.h.

◆ null()

constexpr __host__ __device__ bool Arcane::Materials::MatVarIndex::null ( ) const
inlineconstexpr

Indique si l'instance représente l'entité nulle.

Définition à la ligne 72 du fichier core/materials/MatVarIndex.h.

◆ reset()

constexpr __host__ __device__ void Arcane::Materials::MatVarIndex::reset ( )
inlineconstexpr

Positionne l'entité à l'instance nulle.

Définition à la ligne 65 du fichier core/materials/MatVarIndex.h.

◆ setIndex()

constexpr __host__ __device__ void Arcane::Materials::MatVarIndex::setIndex ( Int32  array_index,
Int32  value_index 
)
inlineconstexpr

Positionne l'index.

Définition à la ligne 58 du fichier core/materials/MatVarIndex.h.

◆ valueIndex()

Documentation des fonctions amies et associées

◆ operator!=

constexpr __host__ __device__ friend bool operator!= ( MatVarIndex  mv1,
MatVarIndex  mv2 
)
friend

Opérateur de comparaison.

Définition à la ligne 94 du fichier core/materials/MatVarIndex.h.

◆ operator<<

std::ostream & operator<< ( std::ostream &  o,
const MatVarIndex mvi 
)
friend

Opérateur d'écriture.

Définition à la ligne 27 du fichier MatVarIndex.cc.

◆ operator==

constexpr __host__ __device__ friend bool operator== ( MatVarIndex  mv1,
MatVarIndex  mv2 
)
friend

Opérateur de comparaison.

Définition à la ligne 85 du fichier core/materials/MatVarIndex.h.


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