.. _tui_create_iteration:
L'itération
-===========
+###########
.. index:: single: itération
.. index:: single: hypothèse
Les variables sont décrites dans :ref:`gui_create_iteration`.
Méthodes de la classe homard
-""""""""""""""""""""""""""""
+****************************
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
Méthodes communes aux classes cas et iteration
-""""""""""""""""""""""""""""""""""""""""""""""
+**********************************************
+Voir également dans :ref:`tui_create_case`.
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
Méthodes de la classe iteration
-"""""""""""""""""""""""""""""""
+*******************************
Généralités
-^^^^^^^^^^^
+===========
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
Informations sur les maillages
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==============================
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| - ``Inte`` : interpénétration des mailles, par dimension |
+---------------------------------------------------------------+
-Informations sur le champ
-^^^^^^^^^^^^^^^^^^^^^^^^^
+Informations sur les champs
+===========================
+
+Le fichier des champs
+---------------------
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| **SetFieldFile(field_file)** |
| Définit le fichier MED des champs utiles |
| |
-| - ``field_file`` : le nom du fichier MED contenant le |
-| champ |
+| - ``field_file`` : le nom du fichier MED contenant les |
+| champs : champ de pilotage de l'adaptation ou champs |
+| à interpoler |
+---------------------------------------------------------------+
-| .. module:: SetTimeStepRank |
+| .. module:: GetFieldFileName |
| |
-| **SetTimeStepRank(TimeStep, Rank)** |
-| Définit les instants pour le champ |
+| **GetFieldFileName()** |
+| Retourne le nom du fichier MED des champs |
++---------------------------------------------------------------+
+
+Les instants pour le champ de pilotage
+--------------------------------------
+Si une seule occurence du champ de pilotage de l'adaptation est présente dans le fichier des champs, il est inutile de préciser le pas de temps. Sinon, il faut préciser quel pas de temps est retenu.
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: SetTimeStep |
+| |
+| **SetTimeStep(TimeStep)** |
+| Définit l'instant pour le champ de pilotage. Le numéro |
+| d'ordre sera ignoré. |
| |
-| Inutile si aucun instant n'est défini pour le champ |
+| - ``TimeStep`` : l'instant où est pris le champ |
++---------------------------------------------------------------+
+| .. module:: SetTimeStepRank |
| |
-| Si un seul instant est défini pour le champ, il est pris |
-| par défaut. |
+| **SetTimeStepRank(TimeStep, Rank)** |
+| Définit l'instant et le numéro d'ordre pour le champ de |
+| pilotage |
| |
| - ``TimeStep`` : l'instant où est pris le champ |
| - ``Rank`` : le numéro d'ordre où est pris le champ |
| |
| **SetTimeStepRankLast()** |
| Précise que le dernier instant enregistré pour le champ |
-| est utilisé |
-+---------------------------------------------------------------+
-| .. module:: GetFieldFileName |
-| |
-| **GetFieldFileName()** |
-| Retourne le nom du fichier MED du champ |
+| de pilotage est utilisé |
+---------------------------------------------------------------+
| .. module:: GetTimeStep |
| |
| **GetTimeStep()** |
-| Retourne l'instant où est pris le champ |
+| Retourne l'instant où est pris le champ de pilotage |
+---------------------------------------------------------------+
| .. module:: GetRank |
| |
| **GetRank()** |
-| Retourne le numéro d'ordre où est pris le champ |
+| Retourne le numéro d'ordre où est pris le champ de |
+| pilotage |
++---------------------------------------------------------------+
+
+Les instants pour les champs à interpoler
+-----------------------------------------
+
+Les champs à interpoler sont définis dans l'hypothèse (voir :ref:`tui_create_hypothese`).
+Pour un champ donné, si aucune mention de pas de temps n'est précisé, tous les pas de temps seront pris en compte.
+Si on souhaite limiter l'interpolation à un ou plusieurs pas de temps, il faut le préciser ici.
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: SetFieldInterpTimeStep |
+| |
+| **SetFieldInterpTimeStep(FieldName, TimeStep)** |
+| Définit un instant pour le champ à interpoler. Le numéro |
+| d'ordre sera ignoré. |
+| |
+| - ``FieldName`` : le nom du champ à interpoler |
+| - ``TimeStep`` : l'instant où est pris le champ |
++---------------------------------------------------------------+
+| .. module:: SetFieldInterpTimeStepRank |
+| |
+| **SetFieldInterpTimeStepRank(FieldName, TimeStep)** |
+| Définit l'instant et le numéro d'ordre pour le champ à |
+| interpoler. |
+| |
+| - ``FieldName`` : le nom du champ à interpoler |
+| - ``TimeStep`` : l'instant où est pris le champ |
+| - ``Rank`` : le numéro d'ordre où est pris le champ |
++---------------------------------------------------------------+
+| .. module:: GetFieldInterpsTimeStepRank |
+| |
+| **GetFieldInterpsTimeStepRank()** |
+| Retourne l'ensemble des triplets (nom du champ, pas de |
+| temps, numéro d'ordre) |
+| |
+| Attention : l'usage est stocké sous forme de chaîne de |
+| caractères et non pas d'entier dans la liste. |
+| |
+| Exemple : ['DEPL', '1', '1', 'DEPL', '2', '1', 'Masse', |
+| '2', '0', 'Masse', '3', '0'] |
+---------------------------------------------------------------+
Divers
-^^^^^^
+======
+---------------------------------------------------------------+
+---------------------------------------------------------------+
Exemple
-"""""""
+*******
.. index:: single: maillage;initial
-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. ::
+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.
+::
iter_name = "Iteration_1"
iter_1 = case_1.NextIteration(iter_name)
iter_1.AssociateHypo("HypoField")
codret = iter_1.Compute(1, 2)
-Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
+Ensuite, on crée une itération suivante à l'itération parent de laquelle on part.
+::
iter_name = "Iteration_2"
iter_2 = iter_1.NextIteration(iter_name)
Saisie graphique correspondante
-"""""""""""""""""""""""""""""""
+*******************************
Consulter :ref:`gui_create_iteration`