Salome HOME
REG: SurfOpt plugin : Documentation update + small corrections
authorrnc <rnc@opencascade.com>
Wed, 4 Dec 2013 09:46:28 +0000 (09:46 +0000)
committerrnc <rnc@opencascade.com>
Wed, 4 Dec 2013 09:46:28 +0000 (09:46 +0000)
src/Tools/YamsPlug/doc/Advanced_params.rst
src/Tools/YamsPlug/doc/Generics_params.rst
src/Tools/YamsPlug/doc/Mandatory_params.rst
src/Tools/YamsPlug/doc/images/Generic.png
src/Tools/YamsPlug/doc/images/Simple.png

index f76a749..23b0385 100644 (file)
@@ -1,16 +1,19 @@
 Advanced Remeshing Options 
 ==========================
 
-** be aware that no control of coherency is done when you set these parameters : for instance, geometrical approximation is only allowed when yams compute a mesh for finite elements but the GUI will let you choose geometrical approximation and compute a visualisation mesh. read DISTENE documentation **
+.. note:: 
+  Be aware that no control of coherency is done when you set these parameters : for instance, geometrical approximation is only allowed when SurfOpt computes a mesh for finite elements but the GUI will let you choose geometrical approximation and compute a visualisation mesh. See Distene's documentation for more details : 
+  :download:`MeshGems-SurfOpt: The automatic surface remeshing tool of the MeshGems Suite <files/mg-surfopt_user_manual.pdf>`.
 
-  - **Ridge detection**
+  
+- **Ridge detection**
 if not set (ridge detection disabled ), MeshGems-SurfOpt will not try to detect any new ridge edge by its own mechanism : 
 it will consider as ridge only the ridges given in the mesh.  All non-ridge edges that would have been detected as ridge by the Ridge angle paramaeter (see below split edge)  will be considered as part of the same continuous patch.  This option should not be checked when all the known ridges of the mesh are given and when all other possible ridges are not geometric ridges to take into account.
 
-  - **Point smoothing**
+- **Point smoothing**
 When not set (point smoothing is disabled), MeshGems-SurfOpt will not try to move the initial given vertices (along an edge, a ridge or onto the surface), hence MeshGems-SurfOpt will only swap edges, remove vertices or add vertices (refines) to change the mesh.
 
-  - **Geometrical  approximation**
+- **Geometrical  approximation**
 this field as well as the Chordal deviation tolerance parameter,enables the user to bound the maximal chordal deviation allowed. it avoids having sharp angles. , that is, the maximal distance allowed between the detected curve and the plane of the corresponding mesh face. It avoids having faces too far away from the curve they represent.
 
 .. image:: images/Tolerance.png
@@ -20,23 +23,23 @@ this field as well as the Chordal deviation tolerance parameter,enables the user
 This parameter P enables the user to specify the maximal chordal deviation  E relatively to the local curvature. the maximal chordal deviation will be set to E=P x r (r is the radius of the circumcercle) if the units parameter is set to relative or E=P if the units parameter is set to absolute.
 
 
-  - **Ridge angle**
+- **Ridge angle**
 
 This parameter specifies the angular values  for the automatic detection of ridges and corners. A ridge is automatically detected if the angle between the normal vectors of two adjacent faces exceeds this value.
 
 
-  - **Maximal/Minimal size around vertices**
+- **Maximal/Minimal size around vertices**
 
 These two parameters allow the user to prescribe a Maximal/Minimal size for the mesh elements, ie the lengths of the edges. 
 
 
-  - **Mesh gradation**
+- **Mesh gradation**
 This paramater P controls the element size variation : MeshGems-SurfOpt will avoid having two adjacent egdes which sizes vary more than th given gradation. a size correction is applied to the size map : if two adjacent edges are respectively e1 and e2 long and e2 > Pxe1, then, the new size for the second edge will be set to P x e1.
-**This procedure is desactived if P=-1***
+**This procedure is desactived if P=-1**
 
 
 
-  - **Split edge**
+- **Split edge**
 If this option is activated, MeshGems-SurfOpt creates new vertices placed on the curved surface and adds them to elements.
 It may be used to obtain higher order elements.
 
index 761f26f..a38e682 100644 (file)
@@ -10,12 +10,12 @@ This parameter (between 0 and 10) indicates the amount of information that MeshG
 
 
 - **Memory Size**
-You usually don't have to set this parameter but you can choose to limit the amount of memory used by MeshGems-SurfOpt. - It requires 370 bytes per node -. Or, if you try to enrich a already big mesh (up to 2 millions nodes), you exceptionally, need to allocate more memory.
+You usually don't have to set this parameter but you can choose to limit the amount of memory used by MeshGems-SurfOpt -- It requires 370 bytes per node. Or, if you try to enrich a already big mesh (up to 2 millions nodes), you exceptionally, need to allocate more memory.
     
     
 - **File** 
 
-You can change the file used to store remeshing hypotheses. see paragraph :ref:`hypothesis-label` for further informations.
+You can change the file used to store remeshing hypotheses, see :ref:`hypothesis-label` for further informations.
 
 .. image:: images/Generic.png
    :align: center
index 9a84bdc..d4aff8f 100644 (file)
@@ -1,7 +1,7 @@
 Simple Remeshing Options
 =========================
 
-simple case 
+Simple case 
 -----------
 
    All options, but the input mesh, have default values. however, **you have to specify these
@@ -42,7 +42,7 @@ This is the main remeshing Option.  SurfOpt always does quality improvement. It
 
      It is equivalent to SurfOpt's batch option *- - uniform_flat_subdivision yes*.
 
-   - **Smoothing**
+   - **Sandpapering**
 
      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 SurfOpt's batch option *- - sand_paper yes*.
index eaabb4c..ff10b2c 100644 (file)
Binary files a/src/Tools/YamsPlug/doc/images/Generic.png and b/src/Tools/YamsPlug/doc/images/Generic.png differ
index 63f61b4..210025a 100644 (file)
Binary files a/src/Tools/YamsPlug/doc/images/Simple.png and b/src/Tools/YamsPlug/doc/images/Simple.png differ