doc/fr/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:: GetHypothesis                                     |
  25 |                                                               |
  26 | **GetHypothesis(hypo_name)**                                  |
  27 |     Retourne l'instance de la classe ``hypothese`` connue par |
  28 |     son nom                                                   |
  29 |                                                               |
  30 |     - ``hypo_name`` : le nom de l'hypothèse                   |
  31 +---------------------------------------------------------------+
  32 | .. module:: GetAllHypothesesName                              |
  33 |                                                               |
  34 | **GetAllHypothesesName()**                                    |
  35 |     Retourne la liste des noms de toutes les hypothèses créées|
  36 |                                                               |
  37 +---------------------------------------------------------------+
  38
  39 Méthodes de la classe hypothese
  40 *******************************
  41
  42 Généralités
  43 ===========
  44
  45 +---------------------------------------------------------------+
  46 +---------------------------------------------------------------+
  47 | .. module:: GetName                                           |
  48 |                                                               |
  49 | **GetName()**                                                 |
  50 |     Retourne le nom de l'hypothèse                            |
  51 +---------------------------------------------------------------+
  52 | .. module:: SetAdapRefinUnRef                                 |
  53 |                                                               |
  54 | **SetAdapRefinUnRef(Adap, Refin, UnRef)**                     |
  55 |     Affecte le mode d'adaptation associé à l'hypothèse        |
  56 |                                                               |
  57 |     - ``Adap`` : entier précisant le type d'adaptation        |
  58 |                                                               |
  59 |         * -1 : uniforme                                       |
  60 |         * 0 : selon des zones                                 |
  61 |         * 1 : selon un champ                                  |
  62 |                                                               |
  63 |     - ``Refin`` : entier précisant si le raffinement est actif|
  64 |                                                               |
  65 |         * 0 : inactif                                         |
  66 |         * 1 : actif                                           |
  67 |                                                               |
  68 |     - ``UnRef`` : entier précisant si déraffinement est actif |
  69 |                                                               |
  70 |         * 0 : inactif                                         |
  71 |         * 1 : actif                                           |
  72 |                                                               |
  73 +---------------------------------------------------------------+
  74 | .. module:: GetAdapType                                       |
  75 |                                                               |
  76 | **GetAdapType()**                                             |
  77 |     Retourne le type d'adaptation                             |
  78 +---------------------------------------------------------------+
  79 | .. module:: GetRefinType                                      |
  80 |                                                               |
  81 | **GetRefinType()**                                            |
  82 |     Retourne le type de raffinement                           |
  83 +---------------------------------------------------------------+
  84 | .. module:: GetUnRefType                                      |
  85 |                                                               |
  86 | **GetUnRefType()**                                            |
  87 |     Retourne le type de déraffinement                         |
  88 +---------------------------------------------------------------+
  89 | .. module:: Delete                                            |
  90 |                                                               |
  91 | **Delete()**                                                  |
  92 |     Detruit l'hypothèse                                       |
  93 |                                                               |
  94 |     Retourne un entier :                                      |
  95 |         * 0 : destruction réussie                             |
  96 |         * autre valeur : problème                             |
  97 +---------------------------------------------------------------+
  98
  99 Le champ et les seuils
 100 ======================
 101
 102 +---------------------------------------------------------------+
 103 +---------------------------------------------------------------+
 104 | .. module:: SetField                                          |
 105 |                                                               |
 106 | **SetField(field_name)**                                      |
 107 |     Attribue un nom de champ à l'hypothèse                    |
 108 |                                                               |
 109 |     - ``field_name`` : le nom du champ                        |
 110 +---------------------------------------------------------------+
 111 | .. module:: GetFieldName                                      |
 112 |                                                               |
 113 | **GetFieldName()**                                            |
 114 |     Retourne le nom du champ                                  |
 115 +---------------------------------------------------------------+
 116 | .. module:: SetUseField                                       |
 117 |                                                               |
 118 | **SetUseField(use_field)**                                    |
 119 |     Attribue un mode d'usage du champ à l'hypothèse           |
 120 |                                                               |
 121 |     - ``use_field`` : entier précisant l'usage du champ       |
 122 |                                                               |
 123 |        * 0 : valeur par élément (défaut)                      |
 124 |        * 1 : saut entre un élément et ses voisins             |
 125 +---------------------------------------------------------------+
 126 | .. module:: SetRefinThr                                       |
 127 |                                                               |
 128 | **SetRefinThr(type_thres, threshold)**                        |
 129 |     Définit les seuils en raffinement                         |
 130 |                                                               |
 131 |     - ``type_thres`` : entier précisant le type de seuil en   |
 132 |       raffinement                                             |
 133 |                                                               |
 134 |        * 1 : valeur absolue                                   |
 135 |        * 2 : valeur relative en %                             |
 136 |        * 3 : fraction des mailles en %                        |
 137 |        * 4 : moyenne + n fois l'écart-type                    |
 138 |                                                               |
 139 |     - ``threshold`` : valeur numérique entrant dans la        |
 140 |                       définition 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 |        * 4 : moyenne - n fois l'écart-type                    |
 159 |                                                               |
 160 |     - ``threshold`` : valeur du seuil                         |
 161 +---------------------------------------------------------------+
 162 | .. module:: GetUnRefThrType                                   |
 163 |                                                               |
 164 | **GetUnRefThrType()**                                         |
 165 |     Retourne le type de seuil de déraffinement                |
 166 +---------------------------------------------------------------+
 167
 168
 169 Les composantes du champ
 170 ========================
 171
 172 +---------------------------------------------------------------+
 173 +---------------------------------------------------------------+
 174 | .. module:: AddComp                                           |
 175 |                                                               |
 176 | **AddComp(comp_name)**                                        |
 177 |     Ajoute une composante du champ à considérer               |
 178 |                                                               |
 179 |     - ``comp_name`` : nom d'une composante à prendre en       |
 180 |       compte                                                  |
 181 |                                                               |
 182 |     Remarque : si cette méthode n'est pas appelée, par défaut |
 183 |     toutes les composantes seront retenues.                   |
 184 +---------------------------------------------------------------+
 185 | .. module:: SetUseComp                                        |
 186 |                                                               |
 187 | **SetUseComp(use_comp)**                                      |
 188 |     Définit l'usage des composantes                           |
 189 |                                                               |
 190 |     - ``use_comp`` : entier précisant l'usage des composantes |
 191 |                                                               |
 192 |        * 0 : norme L2 (défaut)                                |
 193 |        * 1 : norme infinie                                    |
 194 |        * 2 : valeur relative, si une seule composante         |
 195 +---------------------------------------------------------------+
 196 | .. module:: GetComps                                          |
 197 |                                                               |
 198 | **GetComps()**                                                |
 199 |     Retourne la liste des composantes utilisées               |
 200 +---------------------------------------------------------------+
 201 | .. module:: SupprComp                                         |
 202 |                                                               |
 203 | **SupprComp(comp_name)**                                      |
 204 |     Supprime une composante du champ à considérer             |
 205 |                                                               |
 206 |     - ``comp_name`` : nom de la composante à supprimer        |
 207 +---------------------------------------------------------------+
 208 | .. module:: SupprComps                                        |
 209 |                                                               |
 210 | **SupprComps()**                                              |
 211 |     Supprime toutes les composantes du champ à considérer     |
 212 +---------------------------------------------------------------+
 213
 214
 215 Les zones
 216 =========
 217
 218 +---------------------------------------------------------------+
 219 +---------------------------------------------------------------+
 220 | .. module:: AddZone                                           |
 221 |                                                               |
 222 | **AddZone(zone_name, type_use)**                              |
 223 |                                                               |
 224 |     - ``zone_name`` : le nom de la zone à ajouter             |
 225 |     - ``type_use``  : entier précisant l'usage de la zone     |
 226 |                                                               |
 227 |         * 1 : raffinement                                     |
 228 |         * -1 : déraffinement                                  |
 229 +---------------------------------------------------------------+
 230 | .. module:: GetZones                                          |
 231 |                                                               |
 232 | **GetZones()**                                                |
 233 |     Retourne la liste des zones utilisées avec leur usage.    |
 234 |     Attention, l'usage est stocké sous forme de chaîne de     |
 235 |     caractères et non pas d'entier dans la liste.             |
 236 |                                                               |
 237 |     Exemple : ['Zone_A', '1', 'Zone_B', '1', 'Zone_C', '1']   |
 238 +---------------------------------------------------------------+
 239 | .. module:: SupprZone                                         |
 240 |                                                               |
 241 | **SupprZone(zone_name)**                                      |
 242 |     Supprime une zone de l'hypothèse                          |
 243 |                                                               |
 244 |     - ``zone_name`` : nom de la zone à supprimer              |
 245 +---------------------------------------------------------------+
 246 | .. module:: SupprZones                                        |
 247 |                                                               |
 248 | **SupprZones()**                                              |
 249 |     Supprime toutes les zones de l'hypothèse                  |
 250 +---------------------------------------------------------------+
 251
 252
 253 Le filtrage par les groupes
 254 ===========================
 255
 256 +---------------------------------------------------------------+
 257 +---------------------------------------------------------------+
 258 | .. module:: AddGroup                                          |
 259 |                                                               |
 260 | **AddGroup(group_name)**                                      |
 261 |     Ajoute un groupe au filtrage                              |
 262 |                                                               |
 263 |     - ``group_name`` : nom du groupe à prendre en compte      |
 264 +---------------------------------------------------------------+
 265 | .. module:: GetGroups                                         |
 266 |                                                               |
 267 | **GetGroups()**                                               |
 268 |     Retourne la liste des groupes utilisés pour le filtrage   |
 269 +---------------------------------------------------------------+
 270
 271 Les options avancées
 272 ====================
 273
 274 +---------------------------------------------------------------+
 275 +---------------------------------------------------------------+
 276 | .. module:: SetNivMax                                         |
 277 |                                                               |
 278 | **SetNivMax(nivmax)**                                         |
 279 |     Définit le niveau maximal de raffinement                  |
 280 |                                                               |
 281 |     - ``nivmax`` : niveau de raffinement à ne pas dépasser    |
 282 +---------------------------------------------------------------+
 283 | .. module:: GetNivMax                                         |
 284 |                                                               |
 285 | **GetNivMax()**                                               |
 286 |     Retourne le niveau maximal de raffinement                 |
 287 +---------------------------------------------------------------+
 288 | .. module:: SetDiamMin                                        |
 289 |                                                               |
 290 | **SetDiamMin(diammin)**                                       |
 291 |     Définit le diamètre minimal des futures mailles           |
 292 |                                                               |
 293 |     - ``diammin`` : diamètre minimal voulu pour une maille    |
 294 +---------------------------------------------------------------+
 295 | .. module:: GetDiamMin                                        |
 296 |                                                               |
 297 | **GetDiamMin()**                                              |
 298 |     Retourne le diamètre minimal voulu                        |
 299 +---------------------------------------------------------------+
 300 | .. module:: SetAdapInit                                       |
 301 |                                                               |
 302 | **SetAdapInit(option)**                                       |
 303 |     Définit le traitement à appliquer aux mailles où          |
 304 |     le champ de pilotage de l'adaptation n'est pas défini     |
 305 |                                                               |
 306 |     - ``option`` : entier précisant le choix retenu           |
 307 |                                                               |
 308 |         *  0 : aucun effet (défaut)                           |
 309 |         *  1 : les mailles sans indicateurs sont raffinées    |
 310 |         * -1 : les mailles sans indicateurs sont déraffinées  |
 311 +---------------------------------------------------------------+
 312 | .. module:: GetAdapInit                                       |
 313 |                                                               |
 314 | **GetAdapInit()**                                             |
 315 |     Retourne le type de traitement à appliquer aux mailles où |
 316 |     le champ de pilotage de l'adaptation n'est pas défini     |
 317 +---------------------------------------------------------------+
 318 | .. module:: SetLevelOutput                                    |
 319 |                                                               |
 320 | **SetLevelOutput(option)**                                    |
 321 |     Précise si on veut récupérer le niveau de raffinement des |
 322 |     mailles sous la forme d'un champ                          |
 323 |                                                               |
 324 |     - ``option`` : entier précisant le choix retenu           |
 325 |                                                               |
 326 |         *  0 : aucun effet (défaut)                           |
 327 |         *  1 : le champ est produit                           |
 328 +---------------------------------------------------------------+
 329 | .. module:: GetLevelOutput                                    |
 330 |                                                               |
 331 | **GetLevelOutput()**                                          |
 332 |     Retourne le choix retenu pour la récupération du niveau   |
 333 |     de raffinement                                            |
 334 +---------------------------------------------------------------+
 335
 336
 337 Exemple
 338 *******
 339 La création de l'objet hypo_1 se fait ainsi : ::
 340
 341     hypo_1 = homard.CreateHypothesis("HypoField")
 342     hypo_1.SetAdapRefinUnRef(1, 1, 0)
 343     hypo_1.SetField("INDICATEUR")
 344     hypo_1.AddComp("INDX")
 345     hypo_1.AddComp("INDZ")
 346     hypo_1.SetRefinThr(1, 80.)
 347
 348
 349 Saisie graphique correspondante
 350 *******************************
 351 Consulter :ref:`gui_create_hypothese`
 352
 353 .. warning::
 354   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.