Salome HOME
IMP: SMESH/Yams plug-in: Update to use Meshgems-SurfOpt 1.1 (new name of Yams)
[modules/smesh.git] / src / Tools / YamsPlug / doc / editHypo.rst
index 414d8ad0da7facd967f452e1eee03f6e6908fd4e..5a53da35517d8a80b947e13c64048df43e430c3f 100644 (file)
@@ -1,20 +1,26 @@
 .. _hypothesis-label:
 
 ===========================
-How to save Yams Parameters 
+How to save MeshGems-SurfOpt Parameters 
 ===========================
 
-As Yams hypothesis are not meshing hypothesis for Salome (but hypothesis for yams), parameters
-are stored in a special file. Default file is $HOME/.yams.dat. It is strongly recommended that you
-change this name if you want to preserve the way you obtain a mesh : This file is never cleaned.
-All sets of parameters are logged in it.
+MeshGems-SurfOpt hypothesis is not meshing hypothesis for Salome, but hypothesis for yams.
+The current set of parameters is automatically written in the salome study object browser when you run computation.
 
+Theses parameters could also be stored in a special file.
+Default file is $HOME/.yams.dat.
+This ASCII file is appended, and never cleaned.
 
-- To save the current setting, click on "Save Params" pushbutton. 
-- A set of parameters is automatically written in the .yams.dat file when you run computation.  
-- Restoring the default settings can be done by pushing "Default Params". 
-- "Loading Params" will reload the last set of parameters
+In frame "Plug-in Generic Options":
 
+- To save the current setting in this file, click on "Save" pushbutton.
+- To load the last set of parameters saved, click on "Load" pushbutton.
+
+At the bottom of the dialog window:
+  
+- To save a current setting in the study object browser, click on "Save" pushbutton.
+- To load a current setting from the study object browser, click on "Load" pushbutton.
+- To load the default setting, click on "Default" pushbutton. .
 
 
 **example of .yams.dat**
@@ -22,39 +28,25 @@ All sets of parameters are logged in it.
 
 .. code-block:: python
 
-   # Save intermediate params
-   # Params for mesh :
-   Optimisation ='Quality improvement Only (0)'
-   Units ='Relative'
-   Chordal_Tolerance_Deviation=1.0
-   Ridge_Detection=True
-   Split_Edge=False
-   Point_Smoothing=True
-   Geometrical_Approximation=0.04
-   Ridge_Angle=45.0
-   Maximum_Size=-2.0
-   Minimum_Size=-2.0
-   Mesh_Gradation=1.3
-   Verbosity=3
-   Memory=0
-   
-   
-   
-   # Params for Hypothese : monHypo_Yams_0
+   # YAMS hypothesis parameters
    # Params for mesh : Mesh_1
-   Optimisation ='Quality improvement Only (0)'
-   Units ='Relative'
-   Chordal_Tolerance_Deviation=1.0
-   Ridge_Detection=True
-   Split_Edge=False
-   Point_Smoothing=True
-   Geometrical_Approximation=0.04
-   Ridge_Angle=45.0
-   Maximum_Size=-2.0
-   Minimum_Size=-2.0
-   Mesh_Gradation=1.3
+   # Date : 23/05/13 14:23:18
+   # Command : yams -v 3 -O 0 -Drelative,tolerance=0.100000,maxsize=0.010000,minsize=0.000000 /tmp/ForYams_1.mesh
+   Optimisation=Quality improvement Only (0)
+   Units=Relative
+   ChordalToleranceDeviation=0.1
+   RidgeDetection=True
+   SplitEdge=False
+   PointSmoothing=True
+   GeometricalApproximation=0.04
+   RidgeAngle=45.0
+   MaximumSize=0.01
+   MinimumSize=0.0
+   MeshGradation=1.3
    Verbosity=3
    Memory=0
+   
+