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