From: maintenance team <salome-mnt@opencascade.com>
Date: Mon, 24 Nov 2008 08:54:27 +0000 (+0000)
Subject: Update GUI documentation
X-Git-Tag: V5_1_0rc2~13
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=fe84f9495fc94d56e9dbb35af6b1b2b030378af8;p=modules%2Fsmesh.git

Update GUI documentation
---

diff --git a/doc/salome/gui/SMESH/input/blsurf_hypo.doc b/doc/salome/gui/SMESH/input/blsurf_hypo.doc
index 92e1f64f4..b392f3b72 100644
--- a/doc/salome/gui/SMESH/input/blsurf_hypo.doc
+++ b/doc/salome/gui/SMESH/input/blsurf_hypo.doc
@@ -8,44 +8,44 @@ algorithm. This algorithm is a commercial software.
 \image html blsurf_parameters.png
 
 <ul>
-<li><b>Name</b> - allows to define the name of the hypothesis (BLSURF
-Parameters by default).</li>
+<li><b>Name</b> - allows defining the name of the hypothesis (BLSURF
+Parameters_n by default).</li>
 
-<li><b>Physical Mesh</b> - if is set to "Custom", allows to set size
-of mesh elements to generate in <b>User size</b> field.
+<li><b>Physical Mesh</b> - if set to "Custom", allows user input in te
+in <b>User size</b>, <b>Max Physical Size</b> and <b>Min Physical
+Size</b> fields.
 </li>
 
-<li><b>User size</b> - size of mesh elements to generate. </li>
+<li><b>User size</b> - defines the size of the generated mesh elements. </li>
 
-<li><b>Max Physical Size</b> - is an upper limit of mesh element size. </li>
+<li><b>Max Physical Size</b> - defines the upper limit of mesh element size. </li>
 
-<li><b>Min Physical Size</b> - is a lower limit of mesh element size. </li>
+<li><b>Min Physical Size</b> - defines the lower limit of mesh element size. </li>
 
-<li><b>Geometrical mesh</b> - if is set to "Custom", allows to set
-mesh element deflection from curves and surfaces and element
-size change rate in <b>Angle Mesh S</b>, <b>Angle Mesh C</b> and
-<b>Gradation</b> fields correspondingly. These fields control
-computation of element size, so called <i>geometrical size</i>, conform to
+<li><b>Geometrical mesh</b> - if set to "Custom", allows user input in
+ <b>Angle Mesh S</b>, <b>Angle Mesh C</b> and
+<b>Gradation</b> fields. These fields control
+computation of the element size, so called <i>geometrical size</i>, conform to
 the surface geometry considering local curvatures. \n
-The eventual element size at each point will be minimum of <b>User
-size</b>, if given, and the <i>geometrical size</i>. </li>
+If both the <b>User size</b> and the <i>geometrical size</i> are defined, the
+ eventual element size correspond to the least of the two. </li>
 
-<li><b>Angle Mesh S</b> - maximal allowed angle in degrees at a mesh
-node between the mesh face and the tangent to the geometrical surface. </li>
+<li><b>Angle Mesh S</b> - maximum angle between the mesh face and the
+tangent to the geometrical surface at each mesh node, in degrees. </li>
 
-<li><b>Angle Mesh C</b> - maximal allowed angle in degrees at a mesh
-node between the mesh edge and the tangent to the geometrical curve. </li>
+<li><b>Angle Mesh C</b> - maximum angle between the mesh edge and the
+tangent to the geometrical curve at each mesh node, in degrees. </li>
 
-<li><b>Max Geometrical Size</b> - is an upper limit of <i>geometrical size</i>.</li>
+<li><b>Max Geometrical Size</b> - defines the upper limit of the <i>geometrical size</i>.</li>
 
-<li><b>Min Geometrical Size</b> - is a lower limit of <i>geometrical size</i>.</li>
+<li><b>Min Geometrical Size</b> - defines the lower limit of the <i>geometrical size</i>.</li>
 
-<li><b>Gradation</b> - maximal allowed ratio between the lengths of
+<li><b>Gradation</b> - maximum ratio between the lengths of
 two adjacent edges. </li>
 
-<li><b>Allow Quadrangles</b> - to create quadrilateral elements.</li>
+<li><b>Allow Quadrangles</b> - if checked, allows the creation of quadrilateral elements.</li>
 
-<li><b>Patch independent</b> - if this box is checked on, geometrical
+<li><b>Patch independent</b> - if checked, geometrical
 edges are not respected and all geometrical faces are meshed as one
 hyper-face.</li>
 
@@ -56,7 +56,7 @@ not sewed faces.
 <ul>
   <li>"From CAD" means that mesh conformity is assured by conformity
   of a shape.</li>
-  <li>"Pre-process" and "Pre-process++" let BLSURF software
+  <li>"Pre-process" and "Pre-process++" allow the BLSURF software to
   pre-process the geometrical model to eventually produce a conform
   mesh. </li>
 </ul>
@@ -64,16 +64,17 @@ not sewed faces.
 <li><b>Verbosity level</b> - Defines the percentage of "verbosity" of
 BLSURF [0-100].</li>
 
-<li><b>Add option</b> - provides a choice of multiple advanced
-options, each of which, if selected, appear in a table where you can
-enter a value of the option and edit it later.</li>
+<li><b>Add option</b> - provides the choice of multiple advanced
+options, which appear, if selected, in a table where it is possible to
+input the value of the option and to edit it later.</li>
 
-<li><b>Clear option</b> - removes option selected in the table.
+<li><b>Clear option</b> - removes the option selected in the table.
 
 </ul>
 
 \n
-Commonly usable options are following. The name <i>diag</i> stands there for
+The following options are commonly usable. The notion of <i>diag</i>
+used in the descriptions means
 the diagonal of the bounding box of the geometrical object to mesh.
 
 <ul>
@@ -111,16 +112,16 @@ to</i> <i>P2</i> .
 </ul>
 Default is 0.</li>
 
-<li>\b hmean_flag (integer) - determines the computation of the mean of several
+<li>\b hmean_flag (integer) - determines the computation of the average of several
 values:<ul>
 <li>-1 - the minimum is computed.</li>
-<li>0 or 2 - the arithmetic mean computed.
-<li>1 - the geometric mean is computed.</li>
+<li>0 or 2 - the arithmetic average computed.
+<li>1 - the geometric average is computed.</li>
 </ul>
 Default is 0.</li>
 
 <li>\b CheckAdjacentEdges, \b CheckCloseEdges and \b CheckWellDefined
-(integers) - give number of calls of equally named subroutines the
+(integers) - gives the number of calls of equally named subroutines the
 purpose of which is to improve the mesh of domains having narrow
 parts. At each iteration,\b CheckCloseEdges decreases the sizes of the
 edges when two boundary curves are neighboring,\b CheckAdjacentEdges
@@ -131,12 +132,12 @@ the parametric domain is well defined. Default values are 0.</li>
 <li>\b CoefRectangle (real)- defines the relative thickness of the rectangles
 used by subroutine \b CheckCloseEdges (see above). Default is 0.25.</li>
 
-<li>\b eps_collapse (real) - if is more than 0.0, BLSURF removes
-curves whose lengths are less than \b eps_collapse. Here, to obtain an
-approximate value of the length of a curve, the latter is arbitrarily
+<li>\b eps_collapse (real) - if more than 0.0, BLSURF removes
+curves whose lengths are less than \b eps_collapse. To obtain an
+approximate value of the length of a curve, it is arbitrarily
 split into 20 edges. Default is 0.0.</li>
 
-<li>\b eps_ends (real) - is used to detect curves whose lengths are very
+<li>\b eps_ends (real) - is used to detect the curves whose lengths are very
 small, which sometimes constitutes an error. A message is printed
 if<i> fabs(P2-P1) < eps_ends</i>, where <i>P1</i> and <i>P2</i> are the
 extremities of a curve. Default is <i>diag</i>/500.0.</li>
@@ -196,18 +197,18 @@ String variables:
 \n
 Currently BLSURF plugin has the following limitations.
 <ul>
-  <li>Mesh contains inverted elements, if it is based on shape,
+  <li>The created mesh will contain inverted elements if it is based on a shape,
       consisting of more than one face (box, cone, torus...) and if
-      the option "Allow Quadrangles (Test)" was checked before
+      the option "Allow Quadrangles (Test)" has been checked before
       computation.</li>
 
-  <li>SIGFPE exception is raised at trying to compute mesh, based on
-      box, with checked option "Patch independent".</li>
+  <li>SIGFPE exception is raised at the attempt to compute the mesh
+      based on a box when the option "Patch independent" is checked.</li>
 
-  <li>It has been found out that BLSURF algorithm can't be used as a
-      local algorithm (on sub-meshes) and as a provider of low-level
-      mesh for some 3D algorithms because BLSURF mesher (and
-      consequently plugin) does not provide information on node
+  <li>BLSURF algorithm cannot be used as a local algorithm (on
+      sub-meshes) or as a provider of a low-level
+      mesh for some 3D algorithms, because the BLSURF mesher (and
+      consequently plugin) does not provide the information on node
       parameters on edges (U) and faces (U,V). For example the
       following combinations of algorithms are impossible:
       <ul>
diff --git a/doc/salome/gui/SMESH/input/ghs3d_hypo.doc b/doc/salome/gui/SMESH/input/ghs3d_hypo.doc
index 15622b971..414e342fa 100644
--- a/doc/salome/gui/SMESH/input/ghs3d_hypo.doc
+++ b/doc/salome/gui/SMESH/input/ghs3d_hypo.doc
@@ -11,33 +11,35 @@ algorithm. This algorithm is a commercial software.
 <li><b>Name</b> - allows to define the name of the hypothesis (GHS3D 
 Parameters by default).</li>
 
-<li><b>To mesh holes</b> - if this box is checked, the algorithm will 
-create mesh also in holes inside a solid shape, else only the outermost
+<li><b>To mesh holes</b> - if checked, the algorithm will 
+create mesh in the holes inside a solid shape, else only the outermost
 shape will be meshed. Volumic elements created within holes are bound
 to the solid.</li>
 
-<li><b>Optimization level</b> - sets the desired optimization level.
-Optimization levels are: none, light, medium, strong, in increasing 
-order of "quality vs speed" ratio.
+<li><b>Optimization level</b> - allows choosing the required
+optimization level: none, light, medium or strong. Higher level of
+optimisation provides better mesh, but can be time-consuming.
 </li>
 
 \image html ghs3d_parameters_advanced.png
 
 <li><b>Maximum memory size</b> - launches ghs3d software with
-work space limited to specified Megabytes of memory. If this option is
-checked off, the software will be launched with 0.7 * total RAM space. </li>
+work space limited to the specified amount of RAM, in Mbytes. If this option is
+checked off, the software will be launched with 7O% of the total RAM space. </li>
 
 <li><b>Initial memory size</b> - starts ghs3d software with
-specified Megabytes of work space. If this option is checked off, the
+the specified amount of work space, in Mbytes. If this option is checked off, the
 software will be started with 100 Megabytes of working space. </li>
 
-<li><b>Working directory</b> - defines folder for input and output
-files of ghs3d software, which are files starting with "GHS3D_" prefix. </li>
+<li><b>Working directory</b> - allows defining the folder for input and output
+files of ghs3d software, which are the files starting with "GHS3D_" prefix. </li>
 
-<li><b>Keep working files</b> - allows to check input and output files
-of ghs3d software, while usually these files are removed after mesher launch.</li>
+<li><b>Keep working files</b> - allows checking input and output files
+of ghs3d software, while usually these files are removed after the
+launch of the mesher.</li>
 
-<li><b>Verbose level</b> - to choose verbosity level in the range 0 to 10.
+<li><b>Verbose level</b> - to choose verbosity level in the range from
+0 to 10.
 <ul> <li>0, no standard output,
 </li><li>2, prints the data, quality statistics of the skin and final
 meshes and indicates when the final mesh is being saved. In addition
@@ -48,7 +50,7 @@ together with the characteristics of the final mesh.
 </li></ul></li>
 
 <li><b>To create new nodes</b> - if this option is checked off, ghs3d
-tries to create tetrahedrons using only nodes of 2D mesh.</li>
+tries to create tetrahedrons using only the nodes of the 2D mesh.</li>
 
 <li><b>To use boundary recovery version</b> - enables using a
 boundary recovery module which tries to
@@ -59,9 +61,8 @@ resulting volume mesh will however most likely have a very poor
 quality (poor aspect ratio of elements, tetrahedra with a very small
 positive volume).</li>
 
-<li><b>Option as text</b> - allows entering any text that will be
-used as command line option of ghs3d. This is for giving
-advanced options in a free from. </li>
+<li><b>Option as text</b> - allows input of any text as command line
+for ghs3d. This allows the input of advanced options in a free from. </li>
 
 </ul>
 
diff --git a/doc/salome/gui/SMESH/input/mesh_infos.doc b/doc/salome/gui/SMESH/input/mesh_infos.doc
index 7d13b1e45..581440904 100644
--- a/doc/salome/gui/SMESH/input/mesh_infos.doc
+++ b/doc/salome/gui/SMESH/input/mesh_infos.doc
@@ -55,7 +55,8 @@ the information is displayed in Python Console.
 
 The <b>Mesh Element Info</b> box gives basic information about the
 type and the coordinates of the selected mesh element.
-\n It is possible to either give the Id Element or to select it via the visualisation.
+\n It is possible to input the Element ID or to select the Element in
+the Viewer.
 
 \image html eleminfo1.png
 
diff --git a/doc/salome/gui/SMESH/input/selection_filter_library.doc b/doc/salome/gui/SMESH/input/selection_filter_library.doc
index 070f79b6a..e7cd89f97 100644
--- a/doc/salome/gui/SMESH/input/selection_filter_library.doc
+++ b/doc/salome/gui/SMESH/input/selection_filter_library.doc
@@ -25,7 +25,7 @@ criterion. The \b Clear button deletes all criteria.
 \n Each <b>Entity type</b> has its specific list of criteria, however all
 filters have common syntax. For each criterion you should specify the
 <b>Threshold Value</b> and whether we search for the elements that should be
-\b More, \b Less or \b Equal to this \b Value. You can also nagate the
+\b More, \b Less or \b Equal to this \b Value. You can also reverse the
 sense of a criterion using \b Unary operator Not and you should
 specify logical relations between criteria using \b Binary operators
 Or and And.
@@ -42,8 +42,8 @@ the whole \b Mesh, the <b>Initial Selection</b> or the <b>Current Group</b>.
 existing filter from <b>Selection filter library</b> and <b>Add
 to...</b> button gives you a possibility to save your current filter
 in the Library.
-\n <b>Note:</b> If button <b>Apply and Close</b> is disabled, there
-is no selected mesh in Object Browser and the filter can not be
+\n <b>Note:</b> If the button <b>Apply and Close</b> is disabled, there
+is no selected mesh in the Object Browser and the filter can not be
 created. You have to select the mesh and the button will be enabled.
 
 \image html a-filteronedges.png
@@ -51,23 +51,25 @@ created. You have to select the mesh and the button will be enabled.
 Some criteria are applicable to all <b>Entity types</b>:
 <ul><li>
 <b>Belong to Geom</b> selects entities whose all nodes
-lays on the shape defined by <b>Threshold Value</b>.
-The threshold shape can be sub-shape of the main shape of mesh, in
-this case the algorithm works fast, and it also can be any other
-shape, but in this case the algorithm works slower.
+lie on the shape defined by <b>Threshold Value</b>.
+If the threshold shape is a sub-shape of the main shape of the mesh
+the algorithm works faster, if this is any other
+shape the algorithm works slower.
 </li><li>
 <b>Lying on Geom</b> selects entities whose at least one node
-lays on the shape defined by <b>Threshold Value</b>.
-The threshold shape can be sub-shape of the main shape of mesh, in
-this case the algorithm works fast, and it also can be any other
-shape, but in this case the algorithm works slower.
-</li><li>
-<b>Range of IDs</b> allows selection of entities having certain
-IDs. <b>Threshold Value</b> can be like this: "1,2,3,50-60,63,67,70-78"
+lies on the shape defined by the <b>Threshold Value</b>.
+If the hreshold shape is a sub-shape of the main shape of the mesh the
+algorithm works faster, if this is any other
+shape, the algorithm works slower.
+</li><li>
+<b>Range of IDs</b> allows selection of entities with the specified
+IDs. 
+<b>Threshold Value</b> can be, for example: "1,2,3,50-60,63,67,70-78"
 </li>
 </ul>
 
-The following criteria are applicable to all <b>Entity types</b> except <b>Volumes</b>:
+The following criteria are applicable to all <b>Entity types</b>
+except for <b>Volumes</b>:
 <ul><li>
 <b>Belong to Plane</b> selects entities whose all nodes belong to a
 specified plane within a given <b>Tolerance</b>.
diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc
index a21f56d2e..222d80ae3 100644
--- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc
+++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc
@@ -3,50 +3,41 @@
 \page smeshpy_interface_page Python interface smesh.py
 
 \n Python package smesh defines several classes, destined for easy and
-clear mesh creation and edition (see the \ref introduction_to_mesh_python_page "example").
+clear mesh creation and edition.
 
-\n Documentation for smesh package is now available in two forms.
+\n Documentation for smesh package is available in two forms:
 
-\n 1. Here you can find <a href="smeshpy_doc/modules.html">structured
-      documentation for smesh package</a>, where all methods and
-      classes are grouped by their functionality, like it is done in
-      the GUI documentation.
+\n The <a href="smeshpy_doc/modules.html"> structured
+   documentation for smesh package</a>, where all methods and
+   classes are grouped by their functionality, like it is done in the GUI documentation
+\n and the \ref smeshDC "linear documentation for smesh package"
+   grouped only by classes, declared in the smesh.py file.
 
-\n 2. And here the \ref smeshDC "linear documentation for smesh package"
-      is represented, grouped only by classes, declared in the smesh.py file.
+\n The main page of the \ref smeshDC "linear documentation for smesh package"
+   contains a list of data structures and a list of
+   functions, provided by the package smesh.py. The first item in
+   the list of data structures (\ref smeshDC::smeshDC "class smesh")
+   also represents documentation for the methods of the package smesh.py itself.
 
-\n Please draw your attention to the below notes before address to
-the documentation"
+\n The package smesh.py provides an interface to create and handle
+   meshes. Use it to create an empty mesh or to import it from the data file.
 
-\n 1. The main page of the \ref smeshDC "linear documentation for smesh package"
-      contains a list of data structures and a list of
-      functions, provided by the package smesh.py. The first item in
-      the data structures list (\ref smeshDC::smeshDC "class smesh")
-      also represents documentation for methods of the package
-      smesh.py itself.
+\n Once a mesh has been created, it is possible to  manage it via its own
+   methods, described at \ref smeshDC::Mesh "class Mesh" documentation
+   (it is also accessible by the second item "class Mesh" in the list of data structures).
 
-\n 2. Package smesh.py gives interface to create and manage
-      meshes. Please, use it to create an empty mesh or to import
-      it from data file.
+\n Class Mesh allows assigning algorithms to a mesh.
+\n Please note, that some algorithms,
+   included in the standard Salome installation are always available:
+      - REGULAR(1D), COMPOSITE(1D), MEFISTO(2D), Quadrangle(2D), Hexa(3D), etc.
 
-\n 3. Once you have created a mesh, you can manage it via its own
-      methods. See \ref smeshDC::Mesh "class Mesh" documentation for
-      them (it is also accessible by the second item "class Mesh" in the
-      data structures list).
-
-\n 4. Class Mesh allows to assign algorithms to a mesh.
-\n    Please note, that there are always available some algorithms,
-      included in standard Salome installation:
-         - REGULAR(1D), COMPOSITE(1D), MEFISTO(2D), Quadrangle(2D), Hexa(3D), etc.
-
-\n Also there are some algorithms, which can be installed optionally,
+\n There are also some algorithms, which can be installed optionally,
 \n some of them are based on open-source meshers:
          - NETGEN(1D-2D,2D,1D-2D-3D,3D),
 
 \n others are based on commercial meshers:
          - GHS3D(3D), BLSURF(2D).
 
-\n    To add hypotheses, please use interfaces, provided by the
-      assigned algorithms.
+\n    To add hypotheses, use the interfaces, provided by the assigned algorithms.
 
 */