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:: CreateIteration                                   |
  18 |                                                               |
  19 | **CreateIteration(iter_name, iter_parent_name)**              |
  20 |     Retourne une instance de la classe iteration              |
  21 |                                                               |
  22 |     - ``iter_name`` : le nom de l'itération                   |
  23 |     - ``iter_parent_name`` : le nom de l'itération mère       |
  24 |                                                               |
  25 | Par défaut :                                                  |
  26 |                                                               |
  27 |  * le maillage produit a le même nom que l'itération          |
  28 +---------------------------------------------------------------+
  29 | .. module:: AssociateIterHypo                                 |
  30 |                                                               |
  31 | **AssociateIterHypo(iter_name, hypo_name)**                   |
  32 |                                                               |
  33 |     - ``iter_name`` : le nom de l'itération                   |
  34 |     - ``hypo_name`` : le nom de l'hypothèse à associer        |
  35 +---------------------------------------------------------------+
  36
  37 Méthodes de la classe iteration
  38 """""""""""""""""""""""""""""""
  39
  40 Généralités
  41 ^^^^^^^^^^^
  42
  43 +---------------------------------------------------------------+
  44 +---------------------------------------------------------------+
  45 | .. index:: single: Compute                                    |
  46 |                                                               |
  47 | **Compute(option)**                                           |
  48 |     Calcule le maillage correspondant à l'itération           |
  49 |                                                               |
  50 |     - ``option`` : un entier précisant ce qui se passe quand  |
  51 |       des fichiers de résultats existent déjà                 |
  52 |                                                               |
  53 |         * 0 : arrêt en erreur                                 |
  54 |         * 1 : écrasement des anciens fichiers                 |
  55 |                                                               |
  56 |     Retourne un entier :                                      |
  57 |         * 0 : adaptation réussie                              |
  58 |         * autre valeur : problème                             |
  59 +---------------------------------------------------------------+
  60 | .. module:: GetName                                           |
  61 |                                                               |
  62 | **GetName()**                                                 |
  63 |     Retourne le nom de l'itération                            |
  64 +---------------------------------------------------------------+
  65 | .. module:: GetNumber                                         |
  66 |                                                               |
  67 | **GetNumber()**                                               |
  68 |     Retourne le numéro de l'itération                         |
  69 +---------------------------------------------------------------+
  70 | .. module:: GetIterParent                                     |
  71 |                                                               |
  72 | **GetIterParent()**                                           |
  73 |     Retourne le nom de l'itération mère                       |
  74 +---------------------------------------------------------------+
  75 | .. module:: GetHypoName                                       |
  76 |                                                               |
  77 | **GetHypoName()**                                             |
  78 |     Retourne le nom de l'hypothèse associée                   |
  79 +---------------------------------------------------------------+
  80 | .. module:: GetCaseName                                       |
  81 |                                                               |
  82 | **GetCaseName()**                                             |
  83 |     Retourne le nom du cas associé                            |
  84 +---------------------------------------------------------------+
  85 | .. module:: GetState                                          |
  86 |                                                               |
  87 | **GetState()**                                                |
  88 |     Retourne l'état de l'itération                            |
  89 |                                                               |
  90 |     - ``0`` : itération non calculée                          |
  91 |     - ``1`` : itération calculée correctement                 |
  92 +---------------------------------------------------------------+
  93
  94 Informations sur les maillages
  95 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  96
  97 +---------------------------------------------------------------+
  98 +---------------------------------------------------------------+
  99 | .. module:: GetMeshName                                       |
 100 |                                                               |
 101 | **GetMeshName()**                                             |
 102 |     Retourne le nom du maillage produit                       |
 103 +---------------------------------------------------------------+
 104 | .. module:: SetMeshFile                                       |
 105 |                                                               |
 106 | **SetMeshFile(mesh_file)**                                    |
 107 |                                                               |
 108 |     - ``mesh_file`` : le nom du fichier qui contiendra        |
 109 |       le maillage produit                                     |
 110 +---------------------------------------------------------------+
 111 | .. module:: GetMeshFile                                       |
 112 |                                                               |
 113 | **GetMeshFile()**                                             |
 114 |     Retourne le nom du fichier du maillage produit            |
 115 +---------------------------------------------------------------+
 116
 117 Informations sur le champ
 118 ^^^^^^^^^^^^^^^^^^^^^^^^^
 119
 120 +---------------------------------------------------------------+
 121 +---------------------------------------------------------------+
 122 | .. module:: SetFieldFile                                      |
 123 |                                                               |
 124 | **SetFieldFile(field_file)**                                  |
 125 |                                                               |
 126 |     - ``field_file`` : le nom du fichier contenant le champ   |
 127 +---------------------------------------------------------------+
 128 | .. module:: SetTimeStepRank                                   |
 129 |                                                               |
 130 | **SetTimeStepRank(TimeStep, Rank)**                           |
 131 |                                                               |
 132 |     - ``TimeStep`` : l'instant où est pris le champ           |
 133 |     - ``Rank`` : le numéro d'ordre où est pris le champ       |
 134 +---------------------------------------------------------------+
 135 | .. module:: GetFieldFileName                                  |
 136 |                                                               |
 137 | **GetFieldFileName()**                                        |
 138 |     Retourne le nom du fichier du champ                       |
 139 +---------------------------------------------------------------+
 140 | .. module:: GetTimeStep                                       |
 141 |                                                               |
 142 | **GetTimeStep()**                                             |
 143 |     Retourne l'instant où est pris le champ                   |
 144 +---------------------------------------------------------------+
 145 | .. module:: GetRank                                           |
 146 |                                                               |
 147 | **GetRank()**                                                 |
 148 |     Retourne le numéro d'ordre où est pris le champ           |
 149 +---------------------------------------------------------------+
 150
 151 Exemple
 152 """""""
 153 .. index:: single: maillage;initial
 154
 155 Pour la création de la première itération, il faut récupérer le nom qui a été donné à celle qui correspond au maillage initial. Ce nom s'obtient avec la méthode ``GetIter0Name`` appliquée au cas. ::
 156
 157     iter_name = "Iteration_1"
 158     iter_1 = homard.CreateIteration(iter_name, case_1.GetIter0Name())
 159     iter_1.SetField(field_file, 0, 0)
 160     iter_1.SetMeshName("maill_01")
 161     iter_1.SetMeshFile("/local00/M.01.med")
 162     homard.AssociateIterHypo(iter_name, "HypoField")
 163     codret = iter_1.Compute(1)
 164
 165 Pour la création d'une itération suivante, on donnera le nom de l'itération parent de laquelle on part. ::
 166
 167     iter_name = "Iteration_2"
 168     iter_2 = homard.CreateIteration(iter_name, "Iteration_1")
 169     iter_2.SetField(field_file, 0, 0)
 170     iter_2.SetMeshName("maill_02")
 171     iter_2.SetMeshFile("/local00/M.02.med")
 172     homard.AssociateIterHypo(iter_name, "HypoField")
 173     codret = iter_2.Compute(1)
 174
 175
 176 Saisie graphique correspondante
 177 """""""""""""""""""""""""""""""
 178 Consulter :ref:`gui_create_iteration`