.. _tui_create_iteration:

L'itration
===========

.. index:: single: itration
.. index:: single: hypothse
.. index:: single: zone

Les variables sont dcrites dans :ref:`gui_create_iteration`.

Mthodes de la classe homard
""""""""""""""""""""""""""""

+---------------------------------------------------------------+
+===============================================================+
| .. module:: CreateIteration                                   |
|                                                               |
| **CreateIteration(iter_name, iter_parent_name)**              |
|     Retourne une instance de la classe iteration              |
|                                                               |
|     - ``iter_name`` : le nom de l'itration                   |
|     - ``iter_parent_name`` : le nom de l'itration mre       |
|                                                               |
| Par dfaut :                                                  |
|                                                               |
|  * le maillage produit a le mme nom que l'itration          |
+---------------------------------------------------------------+
| .. module:: AssociateIterHypo                                 |
|                                                               |
| **AssociateIterHypo(iter_name, hypo_name)**                   |
|                                                               |
|     - ``iter_name`` : le nom de l'itration                   |
|     - ``hypo_name`` : le nom de l'hypothse  associer        |
+---------------------------------------------------------------+

Mthodes de la classe iteration
"""""""""""""""""""""""""""""""

Gnralits
^^^^^^^^^^^

+---------------------------------------------------------------+
+===============================================================+
| .. module:: GetName                                           |
|                                                               |
| **GetName()**                                                 |
|     Retourne le nom de l'itration                            |
+---------------------------------------------------------------+
| .. module:: GetNumber                                         |
|                                                               |
| **GetNumber()**                                               |
|     Retourne le numro de l'itration                         |
+---------------------------------------------------------------+
| .. module:: GetIterParent                                     |
|                                                               |
| **GetIterParent()**                                           |
|     Retourne le nom de l'itration mre                       |
+---------------------------------------------------------------+
| .. module:: GetHypoName                                       |
|                                                               |
| **GetHypoName()**                                             |
|     Retourne le nom de l'hypothse associe                   |
+---------------------------------------------------------------+
| .. module:: GetCaseName                                       |
|                                                               |
| **GetCaseName()**                                             |
|     Retourne le nom du cas associ                            |
+---------------------------------------------------------------+
| .. module:: GetState                                          |
|                                                               |
| **GetState()**                                                |
|     Retourne l'tat de l'itration                            |
|                                                               |
|     - ``0`` : itration non calcule                          |
|     - ``1`` : itration calcule correctement                 |
+---------------------------------------------------------------+

Informations sur les maillages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+---------------------------------------------------------------+
+===============================================================+
| .. module:: GetMeshName                                       |
|                                                               |
| **GetMeshName()**                                             |
|     Retourne le nom du maillage produit                       |
+---------------------------------------------------------------+
| .. module:: SetMeshFile                                       |
|                                                               |
| **SetMeshFile(mesh_file)**                                    |
|                                                               |
|     - ``mesh_file`` : le nom du fichier qui contiendra        |
|       le maillage produit                                     |
+---------------------------------------------------------------+
| .. module:: GetMeshFile                                       |
|                                                               |
| **GetMeshFile()**                                             |
|     Retourne le nom du fichier du maillage produit            |
+---------------------------------------------------------------+

Informations sur le champ
^^^^^^^^^^^^^^^^^^^^^^^^^

+---------------------------------------------------------------+
+===============================================================+
| .. module:: SetFieldFile                                      |
|                                                               |
| **SetFieldFile(field_file)**                                  |
|                                                               |
|     - ``field_file`` : le nom du fichier contenant le champ   |
+---------------------------------------------------------------+
| .. module:: SetTimeStepRank                                   |
|                                                               |
| **SetTimeStepRank(fTimeStep, Rank)**                          |
|                                                               |
|     - ``TimeStep`` : l'instant o est pris le champ           |
|     - ``Rank`` : le numro d'ordre o est pris le champ       |
+---------------------------------------------------------------+
| .. module:: GetFieldFileName                                  |
|                                                               |
| **GetFieldFileName()**                                        |
|     Retourne le nom du fichier du champ                       |
+---------------------------------------------------------------+
| .. module:: GetTimeStep                                       |
|                                                               |
| **GetTimeStep()**                                             |
|     Retourne l'instant o est pris le champ                   |
+---------------------------------------------------------------+
| .. module:: GetRank                                           |
|                                                               |
| **GetRank()**                                                 |
|     Retourne le numro d'ordre o est pris le champ           |
+---------------------------------------------------------------+

Exemple
"""""""
.. index:: single: maillage;initial

Pour la cration de la premire itration, il faut rcuprer le nom qui a t donn  celle qui correspond au maillage initial. Ce nom s'obtient avec la mthode ``GetIter0Name`` applique au cas. ::

    iter_name = "Iteration_1"
    iter_1 = homard.CreateIteration(iter_name, case_1.GetIter0Name())
    iter_1.SetField(field_file, 0, 0)
    iter_1.SetMeshName("maill_01")
    iter_1.SetMeshFile("/local00/M.01.med")
    homard.AssociateIterHypo(iter_name, "HypoField")

Pour la cration d'une itration suivante, on donnera le nom de l'itration parent de laquelle on part. ::

    iter_name = "Iteration_2"
    iter_1 = homard.CreateIteration(iter_name, "Iteration_1")
    iter_1.SetField(field_file, 0, 0)
    iter_1.SetMeshName("maill_02")
    iter_1.SetMeshFile("/local00/M.02.med")
    homard.AssociateIterHypo(iter_name, "HypoField")

