.. _tui_create_iteration:
The iteration
-=============
+#############
.. index:: single: iteration
.. index:: single: hypothesis
The variables are described in :ref:`gui_create_iteration`.
Methods of the class homard
-""""""""""""""""""""""""""""
+***************************
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
Methods of both classes cas and iteration
-"""""""""""""""""""""""""""""""""""""""""
+****************************************"
+See also in :ref:`tui_create_case`.
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
Methods of the class iteration
-""""""""""""""""""""""""""""""
+******************************
General methods
-^^^^^^^^^^^^^^^
+===============
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
Information about the meshes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+============================
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
Information about the field
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+===========================
+
+The file of the fields
+----------------------
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: SetFieldFile |
| |
| **SetFieldFile(field_file)** |
-| Defines the MED file of the field |
+| Defines the MED file of the fields |
| |
-| - ``field_file``: the name of the MED file of the field |
+| - ``field_file``: the name of the MED file of the fields: |
+| the driving field for the adaptation, or the fields to |
+| be interpolated |
+---------------------------------------------------------------+
-| .. module:: SetTimeStepRank |
+| .. module:: GetFieldFileName |
| |
-| **SetTimeStepRank(TimeStep, Rank)** |
-| Defines the time steps for the fields |
+| **GetFieldFileName()** |
+| Returns the name of the MED file of the fields |
++---------------------------------------------------------------+
+
+The time step for the driving field
+-----------------------------------
+
+If no time step is defined for the field or if a single time step is defined for the field, the definition of a time step is useless. That will be the default choice.
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: SetTimeStep |
+| |
+| **SetTimeStep(TimeStep)** |
+| Defines the time step for the driving field for the |
+| adaptation. The rank will be ignored. |
| |
-| Useless if no time step is defined for the field. |
+| - ``TimeStep``: the selected time step |
++---------------------------------------------------------------+
+| .. module:: SetTimeStepRank |
| |
-| If a single time step is defined for the filed, it is the |
-| default choice. |
+| **SetTimeStepRank(TimeStep, Rank)** |
+| Defines the time step and the rank for the driving field |
+| for the adaptation |
| |
| - ``TimeStep``: the selected time step |
| - ``Rank``: the selected rank |
| .. module:: SetTimeStepRankLast |
| |
| **SetTimeStepRankLast()** |
-| The last time step will be used, whatever its value |
-+---------------------------------------------------------------+
-| .. module:: GetFieldFileName |
-| |
-| **GetFieldFileName()** |
-| Returns the name of the MED file of the field |
+| The last time step will be used for the driving field for |
+| the adaptation, whatever its value |
+---------------------------------------------------------------+
| .. module:: GetTimeStep |
| |
| **GetTimeStep()** |
-| Returns the selected time step for the field |
+| Returns the selected time step for the driving field |
+---------------------------------------------------------------+
| .. module:: GetRank |
| |
| **GetRank()** |
-| Returns the selected rank for the field |
+| Returns the selected rank for the driving field |
++---------------------------------------------------------------+
+
+The time steps for the fields to interpolate
+--------------------------------------------
+
+The choice of the fields to interpolated are defined in the hypothesis (see :ref:`tui_create_hypothese`).
+For a given field, if nothing is declared, every single time step will be considered.
+If some time steps are wanted, they must be defined as follows.
+
++---------------------------------------------------------------+
+---------------------------------------------------------------+
+| .. module:: SetFieldInterpTimeStep |
+| |
+| **SetFieldInterpTimeStep(FieldName, TimeStep)** |
+| Defines the time step for the interpolation of the field. |
+| The rank will be ignored. |
+| |
+| - ``FieldName``: the name of the field to interpolate |
+| - ``TimeStep``: the selected time step |
++---------------------------------------------------------------+
+| .. module:: SetFieldInterpTimeStepRank |
+| |
+| **SetFieldInterpTimeStepRank(FieldName, TimeStep)** |
+| Defines the time step and the rank for the interpolation |
+| of the field. |
+| |
+| - ``FieldName``: the name of the field to interpolate |
+| - ``TimeStep``: the selected time step |
+| - ``Rank``: the selected rank |
++---------------------------------------------------------------+
+| .. module:: GetFieldInterpsTimeStepRank |
+| |
+| **GetFieldInterpsTimeStepRank()** |
+| Returns the information (name of the field, time step, |
+| rank) |
+| |
+| Warning: the time step and the rank are stored as strings |
+| in the list and not as integers. |
+| |
+| Example: ['DEPL', '1', '1', 'DEPL', '2', '1', 'Mass', |
+| '2', '0', 'Mass', '3', '0'] |
++---------------------------------------------------------------+
+
+Miscellenaous
+=============
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: SetInfoCompute |
+| |
+| **SetInfoCompute(MessInfo)** |
+| Defines options to track the computation of the iteration |
+| |
+| - ``MessInfo``: integer that drives prints, as a multiple |
+| of 2, 3 and 5 |
+| |
+| * 1 : nothing (default) |
+| * 2x : computational time |
+| * 3x : MED files |
+| * 5x : memory |
++---------------------------------------------------------------+
+| .. module:: GetInfoCompute |
+| |
+| **GetInfoCompute()** |
+| Returns the options to track the computation |
++---------------------------------------------------------------+
+
Example
-"""""""
+*******
.. index:: single: mesh;initial
To create the first iteration, the starting point is the iteration associated to the initial mesh. It is the one that defines the case.
Similar graphical input
-"""""""""""""""""""""""
+***********************
Look at :ref:`gui_create_iteration`
