doc/fr/tui_create_iteration.rst

   1 .. _tui_create_iteration:
   2
   3 L'itération
   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_iteration`.
  11
  12 Méthodes de la classe homard
  13 """"""""""""""""""""""""""""
  14
  15 +---------------------------------------------------------------+
  16 +---------------------------------------------------------------+
  17 | .. module:: GetIteration                                      |
  18 |                                                               |
  19 | **GetIteration(iter_name)**                                   |
  20 |     Retourne l'instance de la classe ``iteration`` connue par |
  21 |     son nom                                                   |
  22 |                                                               |
  23 |     - ``iter_name`` : le nom de l'itération                   |
  24 +---------------------------------------------------------------+
  25 | .. module:: GetAllIterationsName                              |
  26 |                                                               |
  27 | **GetAllIterationsName()**                                    |
  28 |     Retourne la liste des noms de toutes les itérations créées|
  29 |                                                               |
  30 +---------------------------------------------------------------+
  31
  32 Méthodes communes aux classes cas et iteration
  33 """"""""""""""""""""""""""""""""""""""""""""""
  34
  35 +---------------------------------------------------------------+
  36 +---------------------------------------------------------------+
  37 | .. module:: NextIteration                                     |
  38 |                                                               |
  39 | **NextIteration(iter_name)**                                  |
  40 |     Retourne une instance de la classe ``iteration`` après    |
  41 |     sa création. Elle suit immédiatement :                    |
  42 |                                                               |
  43 |     - pour un cas : l'itération initiale, correspondant au    |
  44 |       maillage définissant le cas                             |
  45 |     - pour une itération : l'itération courante               |
  46 |                                                               |
  47 | Par défaut, le maillage produit a le même nom que l'itération |
  48 |                                                               |
  49 |     - ``iter_name`` : le nom à donner à la nouvelle itération |
  50 +---------------------------------------------------------------+
  51 | .. module:: LastIteration                                     |
  52 |                                                               |
  53 | **LastIteration()**                                           |
  54 |     Retourne une instance de la classe ``iteration``. C'est   |
  55 |     la dernière créée dans la descendance de :                |
  56 |                                                               |
  57 |     - pour un cas : l'itération initiale du cas               |
  58 |     - pour une itération : l'itération courante               |
  59 |                                                               |
  60 |     C'est celle qui est sans fille. Il y a erreur s'il existe |
  61 |     plus d'une branche dans la descendance.                   |
  62 |                                                               |
  63 +---------------------------------------------------------------+
  64
  65 Méthodes de la classe iteration
  66 """""""""""""""""""""""""""""""
  67
  68 Généralités
  69 ^^^^^^^^^^^
  70
  71 +---------------------------------------------------------------+
  72 +---------------------------------------------------------------+
  73 | .. module:: Compute                                           |
  74 |                                                               |
  75 | **Compute(option1, option2)**                                 |
  76 |     Calcule le maillage correspondant à l'itération           |
  77 |                                                               |
  78 |     - ``option1`` : un entier précisant ce qui se passe quand |
  79 |       des fichiers de résultats existent déjà                 |
  80 |                                                               |
  81 |         * 0 : arrêt en erreur                                 |
  82 |         * 1 : écrasement des anciens fichiers                 |
  83 |                                                               |
  84 |     - ``option2`` : un entier précisant ce qui est fait des   |
  85 |       résultats                                               |
  86 |                                                               |
  87 |         * 1 : aucune action particulière                      |
  88 |         * 2 : publication dans le module SMESH                |
  89 |                                                               |
  90 |     Retourne un entier :                                      |
  91 |         * 0 : adaptation réussie                              |
  92 |         * autre valeur : problème                             |
  93 +---------------------------------------------------------------+
  94 | .. module:: GetName                                           |
  95 |                                                               |
  96 | **GetName()**                                                 |
  97 |     Retourne le nom de l'itération                            |
  98 +---------------------------------------------------------------+
  99 | .. module:: GetNumber                                         |
 100 |                                                               |
 101 | **GetNumber()**                                               |
 102 |     Retourne le numéro de l'itération.                        |
 103 |                                                               |
 104 |     L'itération 0 est celle associée au maillage initial.     |
 105 |     Ensuite, une itération de numéro N est issue de           |
 106 |     l'adaptation d'une itération de numéro N-1.               |
 107 +---------------------------------------------------------------+
 108 | .. module:: GetIterParent                                     |
 109 |                                                               |
 110 | **GetIterParent()**                                           |
 111 |     Retourne l'itération mère                                 |
 112 +---------------------------------------------------------------+
 113 | .. module:: AssociateHypo                                     |
 114 |                                                               |
 115 | **AssociateHypo(hypo_name)**                                  |
 116 |     Associe une hypothèse à l'itération                       |
 117 |                                                               |
 118 |     - ``hypo_name`` : le nom de l'hypothèse à associer        |
 119 +---------------------------------------------------------------+
 120 | .. module:: GetHypoName                                       |
 121 |                                                               |
 122 | **GetHypoName()**                                             |
 123 |     Retourne le nom de l'hypothèse associée                   |
 124 +---------------------------------------------------------------+
 125 | .. module:: GetCaseName                                       |
 126 |                                                               |
 127 | **GetCaseName()**                                             |
 128 |     Retourne le nom du cas associé                            |
 129 +---------------------------------------------------------------+
 130 | .. module:: GetState                                          |
 131 |                                                               |
 132 | **GetState()**                                                |
 133 |     Retourne l'état de l'itération                            |
 134 |                                                               |
 135 |     - ``2`` : itération calculée correctement                 |
 136 |     - ``1`` : itération non calculée                          |
 137 |     - ``<=0`` : itération initiale à ne pas calculer, de      |
 138 |       numéro valant la valeur absolue de l'état               |
 139 +---------------------------------------------------------------+
 140 | .. module:: GetLogFile                                        |
 141 |                                                               |
 142 | **GetLogFile()**                                              |
 143 |     Retourne le nom du fichier retraçant le déroulement de    |
 144 |     l'exécution de HOMARD                                     |
 145 +---------------------------------------------------------------+
 146 | .. module:: GetFileInfo                                       |
 147 |                                                               |
 148 | **GetFileInfo()**                                             |
 149 |     Retourne le nom du fichier contenant l'analyse du maillage|
 150 +---------------------------------------------------------------+
 151 | .. module:: GetDirName                                        |
 152 |                                                               |
 153 | **GetDirName()**                                              |
 154 |     Retourne le nom du répertoire des résutats associé à      |
 155 |     l'itération                                               |
 156 +---------------------------------------------------------------+
 157 | .. module:: Delete                                            |
 158 |                                                               |
 159 | **Delete(option)**                                            |
 160 |     Detruit l'itération et toutes ses filles éventuelles.     |
 161 |                                                               |
 162 |     - ``option`` : un entier précisant ce qui est fait des    |
 163 |       fichiers de maillage associés                           |
 164 |                                                               |
 165 |         * 0 : les fichiers sont conservés                     |
 166 |         * 1 : les fichiers sont détruits                      |
 167 |                                                               |
 168 |     Retourne un entier :                                      |
 169 |         * 0 : destruction réussie                             |
 170 |         * autre valeur : problème                             |
 171 +---------------------------------------------------------------+
 172
 173 Informations sur les maillages
 174 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 175
 176 +---------------------------------------------------------------+
 177 +---------------------------------------------------------------+
 178 | .. module:: SetMeshName                                       |
 179 |                                                               |
 180 | **SetMeshName(mesh_name)**                                    |
 181 |     Définit le nom du maillage produit                        |
 182 |                                                               |
 183 |     - ``mesh_name`` : le nom du maillage produit              |
 184 +---------------------------------------------------------------+
 185 | .. module:: GetMeshName                                       |
 186 |                                                               |
 187 | **GetMeshName()**                                             |
 188 |     Retourne le nom du maillage produit                       |
 189 +---------------------------------------------------------------+
 190 | .. module:: SetMeshFile                                       |
 191 |                                                               |
 192 | **SetMeshFile(mesh_file)**                                    |
 193 |     Définit le fichier MED du maillage produit                |
 194 |                                                               |
 195 |     - ``mesh_file`` : le nom du fichier MED qui contiendra    |
 196 |       le maillage produit                                     |
 197 +---------------------------------------------------------------+
 198 | .. module:: GetMeshFile                                       |
 199 |                                                               |
 200 | **GetMeshFile()**                                             |
 201 |     Retourne le nom du fichier MED du maillage produit        |
 202 +---------------------------------------------------------------+
 203 | .. module:: MeshInfo                                          |
 204 |                                                               |
 205 | **MeshInfo(Qual, Diam, Conn, Tail, Inte)**                    |
 206 |     Donne des informations sur le maillage. Pour chaque       |
 207 |     option, le choix 0 correspond à ne rien faire, alors que  |
 208 |     le choix 1 active l'option.                               |
 209 |                                                               |
 210 |     - ``Qual`` : qualité des mailles                          |
 211 |     - ``Diam`` : diamètre des mailles                         |
 212 |     - ``Conn`` : connexité du domaine ; en un seul morceau,   |
 213 |       combien de trous, etc.                                  |
 214 |     - ``Tail`` : tailles des constituants du domaine, groupe  |
 215 |       par groupe                                              |
 216 |     - ``Inte`` : interpénétration des mailles, par dimension  |
 217 +---------------------------------------------------------------+
 218
 219 Informations sur le champ
 220 ^^^^^^^^^^^^^^^^^^^^^^^^^
 221
 222 +---------------------------------------------------------------+
 223 +---------------------------------------------------------------+
 224 | .. module:: SetFieldFile                                      |
 225 |                                                               |
 226 | **SetFieldFile(field_file)**                                  |
 227 |     Définit le fichier MED des champs utiles                  |
 228 |                                                               |
 229 |     - ``field_file`` : le nom du fichier MED contenant le     |
 230 |       champ                                                   |
 231 +---------------------------------------------------------------+
 232 | .. module:: SetTimeStepRank                                   |
 233 |                                                               |
 234 | **SetTimeStepRank(TimeStep, Rank)**                           |
 235 |     Définit les instants pour le champ                        |
 236 |                                                               |
 237 |     Inutile si aucun instant n'est défini pour le champ       |
 238 |                                                               |
 239 |     Si un seul instant est défini pour le champ, il est pris  |
 240 |     par défaut.                                               |
 241 |                                                               |
 242 |     - ``TimeStep`` : l'instant où est pris le champ           |
 243 |     - ``Rank`` : le numéro d'ordre où est pris le champ       |
 244 +---------------------------------------------------------------+
 245 | .. module:: SetTimeStepRankLast                               |
 246 |                                                               |
 247 | **SetTimeStepRankLast()**                                     |
 248 |     Précise que le dernier instant enregistré pour le champ   |
 249 |     est utilisé                                               |
 250 +---------------------------------------------------------------+
 251 | .. module:: GetFieldFileName                                  |
 252 |                                                               |
 253 | **GetFieldFileName()**                                        |
 254 |     Retourne le nom du fichier MED du champ                   |
 255 +---------------------------------------------------------------+
 256 | .. module:: GetTimeStep                                       |
 257 |                                                               |
 258 | **GetTimeStep()**                                             |
 259 |     Retourne l'instant où est pris le champ                   |
 260 +---------------------------------------------------------------+
 261 | .. module:: GetRank                                           |
 262 |                                                               |
 263 | **GetRank()**                                                 |
 264 |     Retourne le numéro d'ordre où est pris le champ           |
 265 +---------------------------------------------------------------+
 266
 267 Divers
 268 ^^^^^^
 269
 270 +---------------------------------------------------------------+
 271 +---------------------------------------------------------------+
 272 | .. module:: SetInfoCompute                                    |
 273 |                                                               |
 274 | **SetInfoCompute(MessInfo)**                                  |
 275 |     Précise des options d'informations sur le déroulement du  |
 276 |     calcul de l'itération                                     |
 277 |                                                               |
 278 |     - ``MessInfo`` : entier pilotant des écritures, sous la   |
 279 |       forme d'un entier multiple de 2, 3 et 5                 |
 280 |                                                               |
 281 |         * 1 : aucune écriture (défaut)                        |
 282 |         * 2x : temps de calcul                                |
 283 |         * 3x : fichiers MED                                   |
 284 |         * 5x : mémoire                                        |
 285 +---------------------------------------------------------------+
 286 | .. module:: GetInfoCompute                                    |
 287 |                                                               |
 288 | **GetInfoCompute()**                                          |
 289 |     Retourne les options d'informations sur le déroulement du |
 290 |     calcul de l'itération                                     |
 291 +---------------------------------------------------------------+
 292
 293
 294 Exemple
 295 """""""
 296 .. index:: single: maillage;initial
 297
 298 Pour la création de la première itération, on part de celle qui correspond au maillage initial. C'est celle contenue dans le cas. ::
 299
 300     iter_name = "Iteration_1"
 301     iter_1 = case_1.NextIteration(iter_name)
 302     iter_1.SetField(field_file)
 303     iter_1.SetTimeStepRank( 0, 0)
 304     iter_1.SetMeshName("maill_01")
 305     iter_1.SetMeshFile("/local00/M.01.med")
 306     iter_1.AssociateHypo("HypoField")
 307     codret = iter_1.Compute(1, 2)
 308
 309 Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
 310
 311     iter_name = "Iteration_2"
 312     iter_2 = iter_1.NextIteration(iter_name)
 313     iter_2.SetField(field_file)
 314     iter_2.SetTimeStepRank( 1, 1)
 315     iter_2.SetMeshName("maill_02")
 316     iter_2.SetMeshFile("/local00/M.02.med")
 317     iter_2.AssociateHypo("HypoField")
 318     codret = iter_2.Compute(1, 2)
 319
 320
 321 Saisie graphique correspondante
 322 """""""""""""""""""""""""""""""
 323 Consulter :ref:`gui_create_iteration`