X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fen%2Ftui_create_hypothese.rst;h=63fb554ba5f32c01b651f4d4d1299a10f3c19fce;hb=62808839ada9e23777f265885f60073d53b898ab;hp=957eadf780dc5cc3394879ba538a3129fad414e3;hpb=ba14a0351e1afaea289f6e17e96e7dbdeadb73a8;p=modules%2Fhomard.git diff --git a/doc/en/tui_create_hypothese.rst b/doc/en/tui_create_hypothese.rst index 957eadf7..63fb554b 100644 --- a/doc/en/tui_create_hypothese.rst +++ b/doc/en/tui_create_hypothese.rst @@ -50,44 +50,30 @@ General methods | **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 | | | @@ -99,8 +85,28 @@ General methods | * 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 -==================================== +------------------------------------ +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -172,7 +178,7 @@ The driving field and the thresholds The components of the driving field -=================================== +----------------------------------- +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -217,8 +223,8 @@ The components of the driving field +---------------------------------------------------------------+ -The zones -========= +Adaptation by zones +=================== +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -404,22 +410,23 @@ 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. | | | | - ``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 | +---------------------------------------------------------------+ -| .. 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 | +---------------------------------------------------------------+ @@ -429,7 +436,6 @@ The creation of the object hypo_1 is done as follows: :: hypo_1 = homard.CreateHypothesis("HypoField") - hypo_1.SetAdapRefinUnRef(1, 1, 0) hypo_1.SetField("INDICATEUR") hypo_1.AddComp("INDX") hypo_1.AddComp("INDZ")