Salome HOME
IMP: SMESH / Yams plug-in: Some more updates for porting to MGSurfOpt 1.1
[modules/smesh.git] / src / Tools / YamsPlug / doc / Mandatory_params.rst
index f657c1d92221d9e3c95db325156b4d5f76a05b75..9a84bdc5e4a77ad8212366e7034c6cef2e2faeb3 100644 (file)
@@ -4,8 +4,8 @@ Simple Remeshing Options
 simple case 
 -----------
 
-   All options, but the input mesh, have default values. however, **you have to specified these
-   simple options in order to drive yams and control remeshing parameters**. 
+   All options, but the input mesh, have default values. however, **you have to specify these
+   simple options in order to drive MG-SurfOpt and control remeshing parameters**. 
 
    You can access Distene documentation by clicking on Help button.
 
@@ -22,54 +22,57 @@ simple case
 Optimisation
 ------------
     
-This is the main remeshing Option.  Yams always does quality improvement. It is done by point smooting and edge swapping.  It can produce a regular mesh for finite element computation (initial mesh is a a geometrical mesh). In this case, the given surface trianglation is modified in accordance to a size map : an intrinsic size map is computed automatically. it is based on the surface proporties.  Yams is also able to  produce a geometrical mesh (initial mesh is a a mesh for finite element computation). In both case, It can coarsen or enrich the mesh.     
+This is the main remeshing Option.  SurfOpt always does quality improvement. It is done by point smooting and edge swapping.  It can produce a regular mesh for finite element computation (initial mesh is a a geometrical mesh). In this case, the given surface trianglation is modified in accordance to a size map : an intrinsic size map is computed automatically. it is based on the surface proporties.  SurfOpt is also able to  produce a geometrical mesh (initial mesh is a a mesh for finite element computation). In both case, It can coarsen or enrich the mesh.     
 
    - **Quality improvement** 
 
-     If you activitate this option, Yams does only quality improvement.  
+     If you activitate this option, SurfOpt does only quality improvement.  
 
-     It is equivalent to Yams's batch option 0.
+     It is equivalent to SurfOpt's batch option *- - optimisation only*.
 
    - **Pure Geometry Enrichement**
 
      The given surface triangulation is enriched (no coarsening at all) in such away that the distance between the elements in the final mesh and those of the initial one is bounded by auser specified tolerance value. One should use this option, to enrich the mesh where purely geometrical features may be insuficiently fine, i.e. the resulting mesh will be least as fine as the input. Mesh and the geometric features will be refined if needed as specified by the other program parameters. The meshes obtained with those settings may not be suitable for computation.
 
-     It is equivalent to Yams's batch option G.
+     It is equivalent to SurfOpt's batch option G.
 
    -  **Uniform subdivision**
 
      A uniform subdivision of the given surface triangulation is performed : each triangle of the given surface triangulation is considered at and is divided into identical triangles.
 
-     It is equivalent to Yams's batch option U.
+     It is equivalent to SurfOpt's batch option *- - uniform_flat_subdivision yes*.
 
    - **Smoothing**
 
      A surface sandpapering without shrinkage of the given surface triangulation is performed, i.e., the high curvature variations of the given surface will be smoothed out without shrinking the volume in doing so. If ridges are defined, they will be kept as they are in the resulting mesh. It could modify the geometry.
-     It is equivalent to Yams's batch option S.
+     It is equivalent to SurfOpt's batch option *- - sand_paper yes*.
 
    - **Geometrical Mesh : Coarsening** 
 
-     The given surface triangulation is modified in such a way that the distance between the elements in the final mesh and those of the initial one is bounded by a user specfied tolerance value.One should use this option, to coarsen when a purely geometrical mesh is needed. (a mesh that keeps and obeys its geometric features only.) The meshes obtained with this option are usually not suitable for computation because anisotropic elements may be generated
+     The given surface triangulation is modified in such a way that the distance between the elements in the final mesh 
+     and those of the initial one is bounded by a user specfied tolerance value.
+     One should use this option, to coarsen when a purely geometrical mesh is needed. (a mesh that keeps and obeys its geometric features only.) 
+     The meshes obtained with this option are usually not suitable for computation because anisotropic elements may be generated
 
-     It is equivalent to Yams's batch option -2.
+     It is equivalent to SurfOpt's batch option *- - Hausdorff_like yes - - enrich no*.
 
    - **Geometrical Mesh : Coarsening and Enrichment** 
 
-     Yams coarses and enrichs meshes to obtain a purely geometrical mesh. The method is the same as above.
+     SurfOpt coarses and enrichs meshes to obtain a purely geometrical mesh. The method is the same as above.
 
-     It is equivalent to Yams's batch option 2.
+     It is equivalent to SurfOpt's batch option *- - Hausdorff_like yes*.
 
    - **Mesh for finite element computation : Coarsening** 
 
      The given surface triangulation is modified in accordance to a size map. The latter is the intrinsic size map (computed automatically and based on the surface properties, i.e. the local curvatures). One should use this option to coarsen  the mesh, when a regular mesh  for computation purposes is desired, i.e. a mesh with good aspect ratios or good quality elements.
 
-     It is equivalent to Yams's batch option -1.
+     It is equivalent to SurfOpt's batch option *- - enrich no*.
 
    - **Mesh for finite element computation : Coarsening and Enrichment**
 
      One should use this option to coarsen  and enrich the mesh, when a regular mesh for computation purposes is desired, i.e. a mesh with good aspect ratios or good quality elements. The method is the same as above.
 
-     It is equivalent to Yams's batch option 1.
+     It is equivalent to the default SurfOpt's behaviour (no option) .
    
 
 Units parameter
@@ -92,7 +95,10 @@ This field enables the user to bound the maximal chordal deviation allowed, that
 This parameter enables the user to specify the maximal chordal deviation epsilon max.
 
 it can be :
-  - relative : the maximal chordal deviation - epsilon max -is set to 0.001 x the parameter. by default, the parameter is set to 0.1 and the maximum deviation is also 0.1 x 1/1000 * the size of the bounding box,  which is equivalent to say that, for a bouding box of 1 meter, the maximal deviation is 0.1 mm.
+  - relative : the maximal chordal deviation - epsilon max - is set to *s x the parameter* where *s* is the size 
+    of the bounding box longest diagonal. 
+    By default, the parameter is set to 0.001 and the maximum deviation is then set to 0.001 x s,  
+    which is equivalent to say that, for a bouding box of 1 meter, the maximal deviation is 1 mm.
   - absolute : the maximal chordal deviation is the parameter itself. eg if the parameter equals 2, the maximal chordal deviation will be 2 (mm if the point coordonates are given in mm).
 
 Following that criterion: