doc/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 de la classe cas
  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 l'itération         |
  42 |     initiale, correspondant au maillage définissant le cas    |
  43 |                                                               |
  44 |     - ``iter_name`` : le nom à donner à la nouvelle itération |
  45 |                                                               |
  46 | Par défaut :                                                  |
  47 |                                                               |
  48 |  * le maillage produit a le même nom que l'itération          |
  49 +---------------------------------------------------------------+
  50 | .. module:: LastIteration                                     |
  51 |                                                               |
  52 | **LastIteration()**                                           |
  53 |     Retourne une instance de la classe ``iteration`` : la     |
  54 |     dernière créée dans la descendance de l'itération initiale|
  55 |     du cas. C'est celle qui est sans fille. Il y a erreur s'il|
  56 |     existe plus d'une branche dans la descendance.            |
  57 |                                                               |
  58 +---------------------------------------------------------------+
  59
  60 Méthodes de la classe iteration
  61 """""""""""""""""""""""""""""""
  62
  63 Généralités
  64 ^^^^^^^^^^^
  65
  66 +---------------------------------------------------------------+
  67 +---------------------------------------------------------------+
  68 | .. module:: NextIteration                                     |
  69 |                                                               |
  70 | **NextIteration(iter_name)**                                  |
  71 |     Retourne une instance de la classe ``iteration`` qui suit |
  72 |     l'itération courante                                      |
  73 |                                                               |
  74 |     - ``iter_name`` : le nom à donner à la nouvelle itération |
  75 |                                                               |
  76 | Par défaut :                                                  |
  77 |                                                               |
  78 |  * le maillage produit a le même nom que l'itération          |
  79 +---------------------------------------------------------------+
  80 | .. index:: single: Compute                                    |
  81 |                                                               |
  82 | **Compute(option)**                                           |
  83 |     Calcule le maillage correspondant à l'itération           |
  84 |                                                               |
  85 |     - ``option`` : un entier précisant ce qui se passe quand  |
  86 |       des fichiers de résultats existent déjà                 |
  87 |                                                               |
  88 |         * 0 : arrêt en erreur                                 |
  89 |         * 1 : écrasement des anciens fichiers                 |
  90 |                                                               |
  91 |     Retourne un entier :                                      |
  92 |         * 0 : adaptation réussie                              |
  93 |         * autre valeur : problème                             |
  94 +---------------------------------------------------------------+
  95 | .. module:: GetName                                           |
  96 |                                                               |
  97 | **GetName()**                                                 |
  98 |     Retourne le nom de l'itération                            |
  99 +---------------------------------------------------------------+
 100 | .. module:: GetNumber                                         |
 101 |                                                               |
 102 | **GetNumber()**                                               |
 103 |     Retourne le numéro de l'itération.                        |
 104 |                                                               |
 105 |     L'itération 0 est celle associée au maillage initial.     |
 106 |     Ensuite, une itération de numéro N est issue de           |
 107 |     l'adaptation d'une itération de numéro N-1.               |
 108 +---------------------------------------------------------------+
 109 | .. module:: GetIterParent                                     |
 110 |                                                               |
 111 | **GetIterParent()**                                           |
 112 |     Retourne l'itération mère                                 |
 113 +---------------------------------------------------------------+
 114 | .. module:: LastIteration                                     |
 115 |                                                               |
 116 | **LastIteration()**                                           |
 117 |     Retourne une instance de la classe ``iteration`` : la     |
 118 |     dernière créée dans la descendance de l'itération. C'est  |
 119 |     celle qui est sans fille. Il y a erreur s'il existe plus  |
 120 |     d'une branche dans la descendance.                        |
 121 +---------------------------------------------------------------+
 122 | .. module:: AssociateHypo                                     |
 123 |                                                               |
 124 | **AssociateHypo(hypo_name)**                                  |
 125 |     Associe une hypothèse à l'itération                       |
 126 |                                                               |
 127 |     - ``hypo_name`` : le nom de l'hypothèse à associer        |
 128 +---------------------------------------------------------------+
 129 | .. module:: GetHypoName                                       |
 130 |                                                               |
 131 | **GetHypoName()**                                             |
 132 |     Retourne le nom de l'hypothèse associée                   |
 133 +---------------------------------------------------------------+
 134 | .. module:: GetCaseName                                       |
 135 |                                                               |
 136 | **GetCaseName()**                                             |
 137 |     Retourne le nom du cas associé                            |
 138 +---------------------------------------------------------------+
 139 | .. module:: GetState                                          |
 140 |                                                               |
 141 | **GetState()**                                                |
 142 |     Retourne l'état de l'itération                            |
 143 |                                                               |
 144 |     - ``0`` : itération non calculée                          |
 145 |     - ``1`` : itération calculée correctement                 |
 146 +---------------------------------------------------------------+
 147 | .. index:: single: Delete                                     |
 148 |                                                               |
 149 | **Delete()**                                                  |
 150 |     Detruit l'itération et toutes ses filles éventuelles. Les |
 151 |     fichiers des maillages associés sont supprimés.           |
 152 |                                                               |
 153 |     Retourne un entier :                                      |
 154 |         * 0 : destruction réussie                             |
 155 |         * autre valeur : problème                             |
 156 +---------------------------------------------------------------+
 157
 158 Informations sur les maillages
 159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 160
 161 +---------------------------------------------------------------+
 162 +---------------------------------------------------------------+
 163 | .. module:: SetMeshName                                       |
 164 |                                                               |
 165 | **SetMeshName(mesh_name)**                                    |
 166 |     Définit le nom du maillage produit                        |
 167 |                                                               |
 168 |     - ``mesh_name`` : le nom du maillage produit              |
 169 +---------------------------------------------------------------+
 170 | .. module:: GetMeshName                                       |
 171 |                                                               |
 172 | **GetMeshName()**                                             |
 173 |     Retourne le nom du maillage produit                       |
 174 +---------------------------------------------------------------+
 175 | .. module:: SetMeshFile                                       |
 176 |                                                               |
 177 | **SetMeshFile(mesh_file)**                                    |
 178 |     Définit le fichier du maillage produit                    |
 179 |                                                               |
 180 |     - ``mesh_file`` : le nom du fichier qui contiendra        |
 181 |       le maillage produit                                     |
 182 +---------------------------------------------------------------+
 183 | .. module:: GetMeshFile                                       |
 184 |                                                               |
 185 | **GetMeshFile()**                                             |
 186 |     Retourne le nom du fichier du maillage produit            |
 187 +---------------------------------------------------------------+
 188
 189 Informations sur le champ
 190 ^^^^^^^^^^^^^^^^^^^^^^^^^
 191
 192 +---------------------------------------------------------------+
 193 +---------------------------------------------------------------+
 194 | .. module:: SetFieldFile                                      |
 195 |                                                               |
 196 | **SetFieldFile(field_file)**                                  |
 197 |     Définit le fichier des champs utiles                      |
 198 |                                                               |
 199 |     - ``field_file`` : le nom du fichier contenant le champ   |
 200 +---------------------------------------------------------------+
 201 | .. module:: SetTimeStepRank                                   |
 202 |                                                               |
 203 | **SetTimeStepRank(TimeStep, Rank)**                           |
 204 |     Définit les instants pour le champ                        |
 205 |                                                               |
 206 |     Inutile si aucun instant n'est défini pour le champ       |
 207 |                                                               |
 208 |     - ``TimeStep`` : l'instant où est pris le champ           |
 209 |     - ``Rank`` : le numéro d'ordre où est pris le champ       |
 210 +---------------------------------------------------------------+
 211 | .. module:: GetFieldFileName                                  |
 212 |                                                               |
 213 | **GetFieldFileName()**                                        |
 214 |     Retourne le nom du fichier du champ                       |
 215 +---------------------------------------------------------------+
 216 | .. module:: GetTimeStep                                       |
 217 |                                                               |
 218 | **GetTimeStep()**                                             |
 219 |     Retourne l'instant où est pris le champ                   |
 220 +---------------------------------------------------------------+
 221 | .. module:: GetRank                                           |
 222 |                                                               |
 223 | **GetRank()**                                                 |
 224 |     Retourne le numéro d'ordre où est pris le champ           |
 225 +---------------------------------------------------------------+
 226
 227 Exemple
 228 """""""
 229 .. index:: single: maillage;initial
 230
 231 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. ::
 232
 233     iter_name = "Iteration_1"
 234     iter_1 = case_1.NextIteration(iter_name)
 235     iter_1.SetField(field_file)
 236     iter_1.SetTimeStepRank( 0, 0)
 237     iter_1.SetMeshName("maill_01")
 238     iter_1.SetMeshFile("/local00/M.01.med")
 239     iter_1.AssociateHypo("HypoField")
 240     codret = iter_1.Compute(1)
 241
 242 Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
 243
 244     iter_name = "Iteration_2"
 245     iter_2 = iter_1.NextIteration(iter_name)
 246     iter_2.SetField(field_file)
 247     iter_2.SetTimeStepRank( 1, 1)
 248     iter_2.SetMeshName("maill_02")
 249     iter_2.SetMeshFile("/local00/M.02.med")
 250     iter_2.AssociateHypo("HypoField")
 251     codret = iter_2.Compute(1)
 252
 253
 254 Saisie graphique correspondante
 255 """""""""""""""""""""""""""""""
 256 Consulter :ref:`gui_create_iteration`