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 | .. module:: GetName                                           |
  46 |                                                               |
  47 | **GetName()**                                                 |
  48 |     Retourne le nom de l'itération                            |
  49 +---------------------------------------------------------------+
  50 | .. module:: GetNumber                                         |
  51 |                                                               |
  52 | **GetNumber()**                                               |
  53 |     Retourne le numéro de l'itération                         |
  54 +---------------------------------------------------------------+
  55 | .. module:: GetIterParent                                     |
  56 |                                                               |
  57 | **GetIterParent()**                                           |
  58 |     Retourne le nom de l'itération mère                       |
  59 +---------------------------------------------------------------+
  60 | .. module:: GetHypoName                                       |
  61 |                                                               |
  62 | **GetHypoName()**                                             |
  63 |     Retourne le nom de l'hypothèse associée                   |
  64 +---------------------------------------------------------------+
  65 | .. module:: GetCaseName                                       |
  66 |                                                               |
  67 | **GetCaseName()**                                             |
  68 |     Retourne le nom du cas associé                            |
  69 +---------------------------------------------------------------+
  70 | .. module:: GetState                                          |
  71 |                                                               |
  72 | **GetState()**                                                |
  73 |     Retourne l'état de l'itération                            |
  74 |                                                               |
  75 |     - ``0`` : itération non calculée                          |
  76 |     - ``1`` : itération calculée correctement                 |
  77 +---------------------------------------------------------------+
  78
  79 Informations sur les maillages
  80 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  81
  82 +---------------------------------------------------------------+
  83 +===============================================================+
  84 | .. module:: GetMeshName                                       |
  85 |                                                               |
  86 | **GetMeshName()**                                             |
  87 |     Retourne le nom du maillage produit                       |
  88 +---------------------------------------------------------------+
  89 | .. module:: SetMeshFile                                       |
  90 |                                                               |
  91 | **SetMeshFile(mesh_file)**                                    |
  92 |                                                               |
  93 |     - ``mesh_file`` : le nom du fichier qui contiendra        |
  94 |       le maillage produit                                     |
  95 +---------------------------------------------------------------+
  96 | .. module:: GetMeshFile                                       |
  97 |                                                               |
  98 | **GetMeshFile()**                                             |
  99 |     Retourne le nom du fichier du maillage produit            |
 100 +---------------------------------------------------------------+
 101
 102 Informations sur le champ
 103 ^^^^^^^^^^^^^^^^^^^^^^^^^
 104
 105 +---------------------------------------------------------------+
 106 +===============================================================+
 107 | .. module:: SetFieldFile                                      |
 108 |                                                               |
 109 | **SetFieldFile(field_file)**                                  |
 110 |                                                               |
 111 |     - ``field_file`` : le nom du fichier contenant le champ   |
 112 +---------------------------------------------------------------+
 113 | .. module:: SetTimeStepRank                                   |
 114 |                                                               |
 115 | **SetTimeStepRank(fTimeStep, Rank)**                          |
 116 |                                                               |
 117 |     - ``TimeStep`` : l'instant où est pris le champ           |
 118 |     - ``Rank`` : le numéro d'ordre où est pris le champ       |
 119 +---------------------------------------------------------------+
 120 | .. module:: GetFieldFileName                                  |
 121 |                                                               |
 122 | **GetFieldFileName()**                                        |
 123 |     Retourne le nom du fichier du champ                       |
 124 +---------------------------------------------------------------+
 125 | .. module:: GetTimeStep                                       |
 126 |                                                               |
 127 | **GetTimeStep()**                                             |
 128 |     Retourne l'instant où est pris le champ                   |
 129 +---------------------------------------------------------------+
 130 | .. module:: GetRank                                           |
 131 |                                                               |
 132 | **GetRank()**                                                 |
 133 |     Retourne le numéro d'ordre où est pris le champ           |
 134 +---------------------------------------------------------------+
 135
 136 Exemple
 137 """""""
 138 .. index:: single: maillage;initial
 139
 140 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. ::
 141
 142     iter_name = "Iteration_1"
 143     iter_1 = homard.CreateIteration(iter_name, case_1.GetIter0Name())
 144     iter_1.SetField(field_file, 0, 0)
 145     iter_1.SetMeshName("maill_01")
 146     iter_1.SetMeshFile("/local00/M.01.med")
 147     homard.AssociateIterHypo(iter_name, "HypoField")
 148
 149 Pour la création d'une itération suivante, on donnera le nom de l'itération parent de laquelle on part. ::
 150
 151     iter_name = "Iteration_2"
 152     iter_1 = homard.CreateIteration(iter_name, "Iteration_1")
 153     iter_1.SetField(field_file, 0, 0)
 154     iter_1.SetMeshName("maill_02")
 155     iter_1.SetMeshFile("/local00/M.02.med")
 156     homard.AssociateIterHypo(iter_name, "HypoField")
 157