doc/tui_create_hypothese.rst

   1 .. _tui_create_hypothese:
   2
   3 L'hypothèse
   4 ===========
   5
   6 .. index:: single: itération
   7 .. index:: single: hypothèse
   8 .. index:: single: zone
   9
  10 Les variables sont décrites dans :ref:`gui_create_hypothese`.
  11
  12 Méthodes de la classe homard
  13 """"""""""""""""""""""""""""
  14
  15 +---------------------------------------------------------------+
  16 +---------------------------------------------------------------+
  17 | .. module:: CreateHypothesis                                  |
  18 |                                                               |
  19 | **CreateHypothesis(hypo_name)**                               |
  20 |     Retourne une instance de la classe ``hypothese``          |
  21 |                                                               |
  22 |     - ``hypo_name`` : le nom de l'hypothèse                   |
  23 +---------------------------------------------------------------+
  24 | .. module:: AssociateHypoZone                                 |
  25 |                                                               |
  26 | **AssociateHypoZone(hypo_name, zone_name, type_use)**         |
  27 |                                                               |
  28 |     - ``hypo_name`` : le nom de l'hypothèse                   |
  29 |     - ``zone_name`` : le nom de la zone à associer            |
  30 |     - ``type_use``  : entier précisant l'usage de la zone     |
  31 |                                                               |
  32 |         * 1 : raffinement                                     |
  33 |         * -1 : déraffinement                                  |
  34 +---------------------------------------------------------------+
  35 | .. module:: GetHypothesis                                     |
  36 |                                                               |
  37 | **GetHypothesis(hypo_name)**                                  |
  38 |     Retourne l'instance de la classe ``hypothese`` connue par |
  39 |     son nom                                                   |
  40 |                                                               |
  41 |     - ``hypo_name`` : le nom de l'hypothèse                   |
  42 +---------------------------------------------------------------+
  43 | .. module:: GetAllHypotheses                                  |
  44 |                                                               |
  45 | **GetAllHypotheses()**                                        |
  46 |     Retourne la liste des noms de toutes les hypothèses créées|
  47 |                                                               |
  48 +---------------------------------------------------------------+
  49
  50 Méthodes de la classe hypothese
  51 """""""""""""""""""""""""""""""
  52
  53 Généralités
  54 ^^^^^^^^^^^
  55
  56 +---------------------------------------------------------------+
  57 +---------------------------------------------------------------+
  58 | .. module:: GetName                                           |
  59 |                                                               |
  60 | **GetName()**                                                 |
  61 |     Retourne le nom de l'hypothèse                            |
  62 +---------------------------------------------------------------+
  63 | .. module:: SetAdapRefinUnRef                                 |
  64 |                                                               |
  65 | **SetAdapRefinUnRef(Adap, Refin, UnRef)**                     |
  66 |     Affecte le mode d'adaptation associé à l'hypothèse        |
  67 |                                                               |
  68 |     - ``Adap`` : entier précisant le type d'adaptation        |
  69 |                                                               |
  70 |         * -1 : uniforme                                       |
  71 |         * 0 : selon des zones                                 |
  72 |         * 1 : selon un champ                                  |
  73 |                                                               |
  74 |     - ``Refin`` : entier précisant si le raffinement est actif|
  75 |                                                               |
  76 |         * 0 : inactif                                         |
  77 |         * 1 : actif                                           |
  78 |                                                               |
  79 |     - ``UnRef`` : entier précisant si déraffinement est actif |
  80 |                                                               |
  81 |         * 0 : inactif                                         |
  82 |         * 1 : actif                                           |
  83 |                                                               |
  84 +---------------------------------------------------------------+
  85 | .. module:: GetAdapType                                       |
  86 |                                                               |
  87 | **GetAdapType()**                                             |
  88 |     Retourne le type d'adaptation                             |
  89 +---------------------------------------------------------------+
  90 | .. module:: GetRefinType                                      |
  91 |                                                               |
  92 | **GetRefinType()**                                            |
  93 |     Retourne le type de raffinement                           |
  94 +---------------------------------------------------------------+
  95 | .. module:: GetUnRefType                                      |
  96 |                                                               |
  97 | **GetUnRefType()**                                            |
  98 |     Retourne le type de déraffinement                         |
  99 +---------------------------------------------------------------+
 100
 101 Le champ et les seuils
 102 ^^^^^^^^^^^^^^^^^^^^^^
 103
 104 +---------------------------------------------------------------+
 105 +---------------------------------------------------------------+
 106 | .. module:: SetField                                          |
 107 |                                                               |
 108 | **SetField(field_name)**                                      |
 109 |     Attribue un nom de champ à l'hypothèse                    |
 110 |                                                               |
 111 |     - ``field_name`` : le nom du champ                        |
 112 +---------------------------------------------------------------+
 113 | .. module:: GetFieldName                                      |
 114 |                                                               |
 115 | **GetFieldName()**                                            |
 116 |     Retourne le nom du champ                                  |
 117 +---------------------------------------------------------------+
 118 | .. module:: SetUseField                                       |
 119 |                                                               |
 120 | **SetUseField(use_field)**                                    |
 121 |     Attribue un mode d'usage du champ à l'hypothèse           |
 122 |                                                               |
 123 |     - ``use_field`` : entier précisant l'usage du champ       |
 124 |                                                               |
 125 |        * 0 : valeur par élément (défaut)                      |
 126 |        * 1 : saut entre un élément et ses voisins             |
 127 +---------------------------------------------------------------+
 128 | .. module:: SetRefinThr                                       |
 129 |                                                               |
 130 | **SetRefinThr(type_thres, threshold)**                        |
 131 |     Définit les seuils en raffinement                         |
 132 |                                                               |
 133 |     - ``type_thres`` : entier précisant le type de seuil en   |
 134 |       raffinement                                             |
 135 |                                                               |
 136 |        * 1 : valeur absolue                                   |
 137 |        * 2 : valeur relative en %                             |
 138 |        * 3 : fraction des mailles en %                        |
 139 |                                                               |
 140 |     - ``threshold`` : valeur du seuil                         |
 141 +---------------------------------------------------------------+
 142 | .. module:: GetRefinThrType                                   |
 143 |                                                               |
 144 | **GetRefinThrType()**                                         |
 145 |     Retourne le type de seuil de raffinement                  |
 146 +---------------------------------------------------------------+
 147 | .. module:: SetUnRefThr                                       |
 148 |                                                               |
 149 | **SetUnRefThr(type_thres, threshold)**                        |
 150 |     Définit les seuils en déraffinement                       |
 151 |                                                               |
 152 |     - ``type_thres`` : entier précisant le type de seuil en   |
 153 |       déraffinement                                           |
 154 |                                                               |
 155 |        * 1 : valeur absolue                                   |
 156 |        * 2 : valeur relative en %                             |
 157 |        * 3 : fraction des mailles en %                        |
 158 |                                                               |
 159 |     - ``threshold`` : valeur du seuil                         |
 160 +---------------------------------------------------------------+
 161 | .. module:: GetUnRefThrType                                   |
 162 |                                                               |
 163 | **GetUnRefThrType()**                                         |
 164 |     Retourne le type de seuil de déraffinement                |
 165 +---------------------------------------------------------------+
 166
 167
 168 Les composantes du champ
 169 ^^^^^^^^^^^^^^^^^^^^^^^^
 170
 171 +---------------------------------------------------------------+
 172 +---------------------------------------------------------------+
 173 | .. module:: AddComp                                           |
 174 |                                                               |
 175 | **AddComp(comp_name)**                                        |
 176 |     Ajoute une composante du champ à considérer               |
 177 |                                                               |
 178 |     - ``comp_name`` : nom d'une composante à prendre en       |
 179 |       compte                                                  |
 180 +---------------------------------------------------------------+
 181 | .. module:: SetUseComp                                        |
 182 |                                                               |
 183 | **SetUseComp(use_comp)**                                      |
 184 |     Définit l'usage des composantes                           |
 185 |                                                               |
 186 |     - ``use_comp`` : entier précisant l'usage des composantes |
 187 |                                                               |
 188 |        * 0 : norme L2 (défaut)                                |
 189 |        * 1 : norme infinie                                    |
 190 |        * 2 : valeur relative, si une seule composante         |
 191 +---------------------------------------------------------------+
 192 | .. module:: GetListComp                                       |
 193 |                                                               |
 194 | **GetListComp()**                                             |
 195 |     Retourne la liste des composantes utilisées               |
 196 +---------------------------------------------------------------+
 197
 198 Le filtrage par les groupes
 199 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 200
 201 +---------------------------------------------------------------+
 202 +---------------------------------------------------------------+
 203 | .. module:: AddGroup                                          |
 204 |                                                               |
 205 | **AddGroup(group_name)**                                      |
 206 |     Ajoute un groupe au filtrage                              |
 207 |                                                               |
 208 |     - ``group_name`` : nom du groupe à prendre en compte      |
 209 +---------------------------------------------------------------+
 210 | .. module:: GetGroups                                         |
 211 |                                                               |
 212 | **GetGroups()**                                               |
 213 |     Retourne la liste des groupes utilisés pour le filtrage   |
 214 +---------------------------------------------------------------+
 215
 216 Les options avancées
 217 ^^^^^^^^^^^^^^^^^^^^
 218
 219 +---------------------------------------------------------------+
 220 +---------------------------------------------------------------+
 221 | .. module:: SetNivMax                                         |
 222 |                                                               |
 223 | **SetNivMax(nivmax)**                                         |
 224 |     Définit le niveau maximal de raffinement                  |
 225 |                                                               |
 226 |     - ``nivmax`` : niveau de raffinement à ne pas dépasser    |
 227 +---------------------------------------------------------------+
 228 | .. module:: GetNivMax                                         |
 229 |                                                               |
 230 | **GetNivMax()**                                               |
 231 |     Retourne le niveau maximal de raffinement                 |
 232 +---------------------------------------------------------------+
 233 | .. module:: SetDiamMin                                        |
 234 |                                                               |
 235 | **SetDiamMin(diammin)**                                       |
 236 |     Définit le diamètre minimal des futures mailles           |
 237 |                                                               |
 238 |     - ``diammin`` : diamètre minimal voulu pour une maille    |
 239 +---------------------------------------------------------------+
 240 | .. module:: GetDiamMin                                        |
 241 |                                                               |
 242 | **GetDiamMin()**                                              |
 243 |     Retourne le diamètre minimal voulu                        |
 244 +---------------------------------------------------------------+
 245 | .. module:: SetAdapInit                                       |
 246 |                                                               |
 247 | **SetAdapInit(option)**                                       |
 248 |     Définit le traitement à appliquer aux mailles où          |
 249 |     le champ de pilotage du raffinement n'est pas défini      |
 250 |                                                               |
 251 |     - ``option`` : entier précisant le choix retenu           |
 252 |                                                               |
 253 |         *  0 : aucun effet (défaut)                           |
 254 |         *  1 : les mailles sans indicateurs sont raffinées    |
 255 |         * -1 : les mailles sans indicateurs sont déraffinées  |
 256 +---------------------------------------------------------------+
 257 | .. module:: GetAdapInit                                       |
 258 |                                                               |
 259 | **GetAdapInit()**                                             |
 260 |     Retourne le type de traitement à appliquer aux mailles où |
 261 |     le champ de pilotage du raffinement n'est pas défini      |
 262 +---------------------------------------------------------------+
 263 | .. module:: SetLevelOutput                                    |
 264 |                                                               |
 265 | **SetLevelOutput(option)**                                    |
 266 |     Précise si on veut récupérer le niveau de raffinement des |
 267 |     mailles sous la forme d'un champ                          |
 268 |                                                               |
 269 |     - ``option`` : entier précisant le choix retenu           |
 270 |                                                               |
 271 |         *  0 : aucun effet (défaut)                           |
 272 |         *  1 : le champ est produit                           |
 273 +---------------------------------------------------------------+
 274 | .. module:: GetLevelOutput                                    |
 275 |                                                               |
 276 | **GetLevelOutput()**                                          |
 277 |     Retourne le choix retenu pour la récupération du niveau   |
 278 |     de raffinement                                            |
 279 +---------------------------------------------------------------+
 280
 281
 282 Exemple
 283 """""""
 284 La création de l'objet hypo_1 se fait ainsi : ::
 285
 286     hypo_1 = homard.CreateHypothesis("HypoField")
 287     hypo_1.SetAdapRefinUnRef(1, 1, 0)
 288     hypo_1.SetField("INDICATEUR")
 289     hypo_1.AddComp("INDX")
 290     hypo_1.AddComp("INDZ")
 291     hypo_1.SetRefinThr(1, 80.)
 292
 293
 294 Saisie graphique correspondante
 295 """""""""""""""""""""""""""""""
 296 Consulter :ref:`gui_create_hypothese`
 297
 298 .. warning::
 299   En mode graphique, si on édite une hypothèse et que l'on modifie une de ses caractéristiques, par exemple le seuil de raffinement, toutes les itérations qui ont été calculées précédemment avec cette hypothèse sont invalidées. En mode python, cela n'est plus vrai : les itérations restent telles quelles.