]> SALOME platform Git repositories - modules/smesh.git/commitdiff
Salome HOME
Documentation update
authorysn <ysn@opencascade.com>
Mon, 19 Oct 2015 08:10:14 +0000 (11:10 +0300)
committervsr <vsr@opencascade.com>
Thu, 29 Oct 2015 13:10:30 +0000 (16:10 +0300)
doc/salome/gui/SMESH/input/1d_meshing_hypo.doc
doc/salome/gui/SMESH/input/about_meshes.doc
doc/salome/gui/SMESH/input/extrusion.doc
doc/salome/gui/SMESH/input/mesh_infos.doc
doc/salome/gui/SMESH/input/quad_from_ma_algo.doc
doc/salome/gui/SMESH/input/revolution.doc
doc/salome/gui/SMESH/input/selection_filter_library.doc
doc/salome/gui/SMESH/input/sewing_meshes.doc

index 0995673b393d94a7a7b94b08a1b279c9457b160c..01deffbcd3dd5030cb77f5859b5571bc3367a912 100644 (file)
@@ -250,7 +250,7 @@ negative</b>.
 \ref tui_deflection_1d "Defining Number of Segments" hypothesis
 operation.
 
-\note The plot functionality is available only if GUI module is builded with Plot 2D Viewer (set option SALOME_USE_PLOT2DVIEWER to ON when building GUI module).
+\note The plot functionality is available only if GUI module is built with Plot 2D Viewer (option SALOME_USE_PLOT2DVIEWER is ON when building GUI module).
 
 <br>
 \anchor start_and_end_length_anchor
index 7550e893495c187f75e969a7f1c20f72e2f9d6eb..80266cada3a49cd7c28ce4e8a51c32dd3fb59ec8 100644 (file)
@@ -98,7 +98,7 @@ surface in addition stores its position in parametric space of the
 associated geometrical entity.
 
 Mesh entities are identified by integer IDs starting from 1.
-Nodes and elements are countered separately, i.e. there can be a node
+Nodes and elements are counted separately, i.e. there can be a node
 and element with the same ID.
 
 SALOME supports elements of second order, without a central node
index 56cb32f4c687ea4aa1bdfa8728f47dbc9c2cacf6..5a603b2291732e042761dad674ff92a07cbde40e 100644 (file)
@@ -23,10 +23,10 @@ elements is extruded into a corresponding type of result elements:
 </table>
 
 When 2D elements are extruded, in addition to 3D elements segments are
-created on ribs of the result 3D mesh. Free edges of input 2D elements
+created on the ribs of the resulting 3D mesh. Free edges of input 2D elements
 generate logically horizontal rib segments. Logically vertical rib
-segments are generated from nodes belonging to a sole input 2D element
-(a figure below illustrates this rule).
+segments are generated from the nodes belonging to a sole input 2D element
+(the figure below illustrates this rule).
 
 \image html extru_rib_segs.png "Two triangles extruded: no vertical rib segments generated from nodes #2 and #3 as they are shared by both triangles"
 
index 2013cd426aca786b2bf7ce75ca87b481f26be2a7..929deb8f3f34e98d1b8eb885ba7c8235fefecfb8 100644 (file)
@@ -46,7 +46,7 @@ information about the selected mesh node(s) or element(s), namely:
   - Node ID;
   - Coordinates (X, Y, Z);
   - Connectivity information (connected elements); double click in
-    this line makes the dialog show information of these elements;
+    this line reveals information about these elements;
   - Position on a shape (for meshes built on a geometry);
   - Groups information (names of groups the node belongs to).
 
@@ -59,7 +59,7 @@ information about the selected mesh node(s) or element(s), namely:
   - Type (triangle, quadrangle, etc.);
   - Gravity center (X, Y, Z coordinates);
   - Connectivity information (connected nodes); double click in
-    a line of a node makes the dialog show information of this node;
+    a line of a node reveals the information about this node;
   - Quality controls (area, aspect ration, volume, etc.);
   - Position on a shape (for meshes built on a geometry);
   - Groups information (names of groups the element belongs to).
@@ -156,7 +156,7 @@ button. Also, values are automatically computed if the number of
 nodes / elements does not exceed the "Automatic controls compute limit" set 
 via the "Mesh information" preferences (zero value means that there is no limit).
 
-\note The plot functionality is available only if GUI module is builded with Plot 2D Viewer (set option SALOME_USE_PLOT2DVIEWER to ON when building GUI module).
+\note The plot functionality is available only if the GUI module is built with Plot 2D Viewer (option SALOME_USE_PLOT2DVIEWER is ON when building GUI module).
 
 The button \b "Dump" allows printing the information displayed in the
 dialog box to a .txt file.
index 6a90f376e4e63b7de1e9bba8c631fbf7815c1c2a..e3df9e4a51cb28f6c1593f70c9c1d25cbb361744 100644 (file)
@@ -3,9 +3,9 @@
 \page quad_from_ma_algo_page Medial Axis Projection Quadrangle meshing algorithm
 
 Medial Axis Projection algorithm can be used for meshing faces with
-sinuous borders and having channel-like shape, for which is it
-difficult to define 1D hypotheses so that generated quadrangles to be
-of good shape. The algorithm can be also applied to faces with ring
+sinuous borders and a channel-like shape, for which it can be
+difficult to define 1D hypotheses such that to obtain a good shape of
+resulting quadrangles. The algorithm can be also applied to faces with ring
 topology, which can be viewed as a closed 'channel'. In the latter
 case radial discretization of a ring can be specified by
 using <em>Number of Layers</em> or <em>Distribution of Layers</em>
@@ -13,7 +13,7 @@ hypothesis.
 
 \image html quad_from_ma_mesh.png "A mesh of a river model to the left and of a ring-face to the right"
 
-The algorithm assures good shape of quadrangles by constructing Medial
+The algorithm provides proper shape of quadrangles by constructing Medial
 Axis between sinuous borders of the face and using it to
 discretize the borders. (Shape of quadrangles can be not perfect at
 locations where opposite sides of a 'channel' are far from being parallel.)
@@ -22,13 +22,13 @@ locations where opposite sides of a 'channel' are far from being parallel.)
 
 The Medial Axis is used in two ways:
 <ol>
-<li>If there is a sub-mesh on either sinuous border, then the nodes of
+<li>If there is a sub-mesh on a sinuous border, then the nodes of
   this border are mapped to the opposite border via the Medial
   Axis.</li>
-<li> If there is no sub-meshes on the sinuous borders, then a part of
+<li> If there are no sub-meshes on sinuous borders, then the part of
   the Medial Axis that can be mapped to both borders is discretized
   using a 1D hypothesis assigned to the face or its ancestor shapes,
-  and the division points are mapped from the Medial Axis to the both
+  and the division points are mapped from the Medial Axis to both
   borders to find positions of nodes.</li>
 </ol>
 
index f0d4194df922cd2740cc5de2a62fc8b49a377a70..4b1d8124057b511f576c9db87c447ae61c0d29d7 100644 (file)
@@ -7,7 +7,7 @@ dimension than the input ones.  Boundary elements around generated
 mesh of plus one dimension are additionally created. All created
 elements can be automatically grouped. Revolution can be used to create
 a \ref extrusion_struct "structured mesh from scratch". 
-See \ref extrusion_page page for general information on Revolution
+See \ref extrusion_page page for general information on Revolution,
 which can be viewed as extrusion along a circular path.
 
 <em>To apply revolution:</em>
index c73c1e42e67995a5f856fe3d7b6aa508de2b1e28..7189ccc437a066e9038cedaa523cbeecccdbf3a3 100644 (file)
@@ -3,8 +3,8 @@
 \page selection_filter_library_page Selection filter library
 
 \n Selection filter library allows creating and storing in files
-filters that can be later loaded and used for operations on meshes. You can
-access to it from the Main Menu via <b>Tools / Selection filter library</b>.
+the filters that can be later reused for operations on meshes. You can
+access it from the Main Menu via <b>Tools / Selection filter library</b>.
 It is also possible to save any filter by invoking the filter library
 from \a Filter dialog launched from any mesh operation.
 
@@ -182,8 +182,8 @@ The following criteria allow selecting mesh <b>Faces</b>:
 \ref area_page "Area quality control"), which is more, less or equal (within a given
 <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 </li><li>
-<b>Free edges</b> selects 2D mesh elements having at least one of its
-edges not shared with other faces. See also a
+<b>Free edges</b> selects 2D mesh elements having at least one 
+edge, which is not shared with other faces. See also a
 \ref free_edges_page "Free Edges quality control".
 </li><li>
 <b>Free faces</b> selects 2D mesh elements, which belong to less than two volumes.
index 8697b36f48b7437b7a04232c5f6acc9e28f4790d..cfb6206dd34d66b6226df0465d9a8bf423ba6f5c 100644 (file)
@@ -32,9 +32,9 @@ the type of sewing operation you would like to perform.</li>
 This functionality allows you to unite free borders of a 2D mesh.
 
 There are two working modes: \a Automatic and \a Manual. In the \b
-Automatic mode, the program finds free borders coincident within a
+Automatic mode, the program finds free borders coincident within the
 specified tolerance and sews them. Optionally it is possible to
-visually check and correct is necessary the found free borders before
+visually check and correct if necessary the found free borders before
 sewing. <br>
 In the \b Manual mode you are to define borders to sew by picking
 three nodes of each of two borders.
@@ -44,14 +44,14 @@ three nodes of each of two borders.
 
 To use \b Automatic sewing:
 <ul>
-<li>Specify a mesh you want to sew by selecting it or any its part
+<li>Specify the mesh you want to sew by selecting it or any its part
   (group or sub-mesh) in the Object Browser or in the VTK Viewer.</li>
-<li>Specify the \b Tolerance within which free borders are considered
+<li>Specify the \b Tolerance, within which free borders are considered
   coincident. At the default zero \b Tolerance, the tolerance used by
   the search algorithm is defined as one tenth of an average size of
-  elements adjacent to free borders being compared.</li>
+  elements adjacent to compared free borders.</li>
 <li>To visually check the coincident free borders found by the
-  algorithm, switch off <b>Auto Sewing</b> check-box. Then controls
+  algorithm, switch off <b>Auto Sewing</b> check-box. The controls
   to adjust groups of coincident free borders will become available in
   the dialog.</li>
 
@@ -60,13 +60,13 @@ To use \b Automatic sewing:
 
 <li>\b Detect button launches the algorithm of search of coincident
   free borders.</li>
-<li>The found groups of <b>Coincident Free Borders</b> are shown in a
-  list, a group per a line. Each group has its own color which is used
-  to display the borders of the group in the VTK Viewer. A free border
-  within a group is designated by IDs of its first, second and last
-  nodes within parenthesis. All borders present in the list will be
-  sewn upon \b Apply.</li>
-<li>\b Remove button removes selected groups from the list.</li>
+<li>The found groups of <b>Coincident Free Borders</b> are shown in the
+  list, one group per line. Each group has its own color, which is used
+  to display the group borders in the VTK Viewer. A free border
+  within a group is designated by the IDs of its first, second and
+  last nodes within parenthesis. All borders present in the list will
+  be sewn upon \b Apply. </li>
+<li>\b Remove button removes the selected groups from the list.</li>
 <li><b>Select All</b> check-box selects all groups in the list.</li>
 <li>When a group is selected, its borders appear in <b>Edit Selected
     Group</b> list that allows you to change this group.</li>
@@ -77,12 +77,12 @@ To use \b Automatic sewing:
   to this border during sewing.
 </li><li>
 \image html remove.png
-<em>Remove Border</em> button removes selected borders from the
+<em>Remove Border</em> button removes the selected borders from the
   group. It is active if there are more than two borders in the group.
 </li>
-<li>Selection of a border in the list allows to change its first and
+<li>Selection of a border in the list allows changing its first and
   last nodes whose IDs appear in two fields below the list. \a Arrow
-  buttons near each field move the corresponding end node by
+  buttons near each field move the corresponding end node by the
   number of nodes defined by \b Step field.</li>
 <li>
 \image html swap.png
@@ -92,7 +92,7 @@ To use \b Automatic sewing:
 </ul>
 
 For sewing free borders manually you should switch the \b Mode to \b
-Manual and define three points on each border: first, second and the
+Manual and define three points on each border: the first, the second and the
 last node:
 
 \image html sewing_manual.png
@@ -119,7 +119,7 @@ they coincide with the first and the last nodes of the other
 border. To cope with this,
 \ref merging_nodes_page "merge" coincident nodes into one
 beforehand. Two figures below illustrate this approach.
-\image html sew_using_merge.png "Merge coincident nodes which are difficult to distinguish"
+\image html sew_using_merge.png "Merge coincident nodes, which are difficult to distinguish"
 <br>
 \image html sew_after_merge.png "After merging nodes it is easy to specify border nodes"