.. index:: single: hypothesis
.. index:: single: zone
-The variables are described in :ref:`gui_create_hypothese`.
+The variables are described in :doc:`gui_create_hypothese`.
Methods of the class homard
***************************
| **GetName()** |
| Returns the name of the hypothesis |
+---------------------------------------------------------------+
-| .. module:: SetAdapRefinUnRef |
-| |
-| **SetAdapRefinUnRef(Adap, Refin, UnRef)** |
-| Gives the type of adaptation to the hypothesis |
+| .. module:: GetAdapType |
| |
-| - ``Adap``: integer that defines the type of adaptation |
+| **GetAdapType()** |
+| Returns the type of the adaptation |
| |
| * -1: uniform |
| * 0: by zones |
| * 1: by a field |
-| |
-| - ``Refin``: integer that informs if the refinement is |
-| active or not |
-| |
-| * 0: unactive |
-| * 1: active |
-| |
-| - ``UnRef``: integer that informs if the refinement is |
-| active or not |
-| |
-| * 0: unactive |
-| * 1: active |
-| |
-+---------------------------------------------------------------+
-| .. module:: GetAdapType |
-| |
-| **GetAdapType()** |
-| Returns the type of the adaptation |
+---------------------------------------------------------------+
| .. module:: GetRefinType |
| |
| **GetRefinType()** |
| Returns the type of the refinement |
+| |
+| * 0: unactive |
+| * 1: active |
+---------------------------------------------------------------+
| .. module:: GetUnRefType |
| |
| **GetUnRefType()** |
| Returns the type of the unrefinement |
+| |
+| * 0: unactive |
+| * 1: active |
+---------------------------------------------------------------+
| .. module:: Delete |
| |
| * other value: problem |
+---------------------------------------------------------------+
+Uniform adaptation
+==================
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: SetUnifRefinUnRef |
+| |
+| **SetUnifRefinUnRef(RefinUnRef)** |
+| Defines a type of adaptation for the whole mesh |
+| |
+| - ``RefinUnRef``: integer that defines the |
+| type of adaptation |
+| |
+| * 1: refinement |
+| * -1: unrefinement |
++---------------------------------------------------------------+
+
+Adaptation by a field
+=====================
+
The driving field and the thresholds
-====================================
+------------------------------------
+---------------------------------------------------------------+
+---------------------------------------------------------------+
The components of the driving field
-===================================
+-----------------------------------
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
-The zones
-=========
+Adaptation by zones
+===================
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
.. note::
- The file and the time steps for the fiels are defined with the iteration; see :ref:`tui_create_iteration`.
+ The file and the time steps for the fiels are defined with the iteration; see :doc:`tui_create_iteration`.
Advanced options
================
| Returns the treatment of the elements where the field that|
| governs the adaptation is not defined |
+---------------------------------------------------------------+
-| .. module:: SetLevelOutput |
+| .. module:: SetExtraOutput |
| |
-| **SetLevelOutput(option)** |
-| Acts if the level of refinement is returned as a field in |
-| the output MED file |
+| **SetExtraOutput(option)** |
+| Acts if some extra information are required into the |
+| output MED file. The option is a product of |
+| 2, 3, 5, 7, 11. |
| |
| - ``option``: integer as follows: |
| |
-| * 0: no effect (default) |
-| * 1: the field is produced |
+| * 1 : no effect (default) |
+| * 2x : the refinement level of every mesh is produced|
+| * 3x : the quality of every mesh |
+| * 5x : the diameter of every mesh |
+| * 7x : common parent of every mesh |
+| * 11x : neighbours of glued cells |
+---------------------------------------------------------------+
-| .. module:: GetLevelOutput |
+| .. module:: GetExtraOutput |
| |
-| **GetLevelOutput()** |
-| Returns the choice for the output of the level of |
-| refinement |
+| **GetExtraOutput()** |
+| Returns the choice for the output of extra information |
+---------------------------------------------------------------+
::
hypo_1 = homard.CreateHypothesis("HypoField")
- hypo_1.SetAdapRefinUnRef(1, 1, 0)
hypo_1.SetField("INDICATEUR")
hypo_1.AddComp("INDX")
hypo_1.AddComp("INDZ")
Similar graphical input
***********************
-Look at :ref:`gui_create_hypothese`
+Look at :doc:`gui_create_hypothese`
.. warning::
With the graphical input mode, if an hypothesis is edited and if one of the characteristic is modified, the value of the threshold for the refinement for example, all the iterations that were computed with this hypothesis are unvalidated. In python mode, that is not true: the iterations stay as they are.
