From: ysn Date: Mon, 19 Oct 2015 08:10:14 +0000 (+0300) Subject: Documentation update X-Git-Tag: V8_0_pre~2 X-Git-Url: http://git.salome-platform.org/gitweb/?p=modules%2Fsmesh.git;a=commitdiff_plain;h=ffd0606a85a3124f8143b44d76ba21c4d114fa26 Documentation update --- diff --git a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc index 0995673b3..01deffbcd 100644 --- a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc @@ -250,7 +250,7 @@ negative. \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).
\anchor start_and_end_length_anchor diff --git a/doc/salome/gui/SMESH/input/about_meshes.doc b/doc/salome/gui/SMESH/input/about_meshes.doc index 7550e8934..80266cada 100644 --- a/doc/salome/gui/SMESH/input/about_meshes.doc +++ b/doc/salome/gui/SMESH/input/about_meshes.doc @@ -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 diff --git a/doc/salome/gui/SMESH/input/extrusion.doc b/doc/salome/gui/SMESH/input/extrusion.doc index 56cb32f4c..5a603b229 100644 --- a/doc/salome/gui/SMESH/input/extrusion.doc +++ b/doc/salome/gui/SMESH/input/extrusion.doc @@ -23,10 +23,10 @@ elements is extruded into a corresponding type of result elements: 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" diff --git a/doc/salome/gui/SMESH/input/mesh_infos.doc b/doc/salome/gui/SMESH/input/mesh_infos.doc index 2013cd426..929deb8f3 100644 --- a/doc/salome/gui/SMESH/input/mesh_infos.doc +++ b/doc/salome/gui/SMESH/input/mesh_infos.doc @@ -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. diff --git a/doc/salome/gui/SMESH/input/quad_from_ma_algo.doc b/doc/salome/gui/SMESH/input/quad_from_ma_algo.doc index 6a90f376e..e3df9e4a5 100644 --- a/doc/salome/gui/SMESH/input/quad_from_ma_algo.doc +++ b/doc/salome/gui/SMESH/input/quad_from_ma_algo.doc @@ -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 Number of Layers or Distribution of Layers @@ -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:
    -
  1. If there is a sub-mesh on either sinuous border, then the nodes of +
  2. 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.
    3. -
  3. If there is no sub-meshes on the sinuous borders, then a part of +
  4. 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.
diff --git a/doc/salome/gui/SMESH/input/revolution.doc b/doc/salome/gui/SMESH/input/revolution.doc index f0d4194df..4b1d81240 100644 --- a/doc/salome/gui/SMESH/input/revolution.doc +++ b/doc/salome/gui/SMESH/input/revolution.doc @@ -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. To apply revolution: diff --git a/doc/salome/gui/SMESH/input/selection_filter_library.doc b/doc/salome/gui/SMESH/input/selection_filter_library.doc index c73c1e42e..7189ccc43 100644 --- a/doc/salome/gui/SMESH/input/selection_filter_library.doc +++ b/doc/salome/gui/SMESH/input/selection_filter_library.doc @@ -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 Tools / Selection filter library. +the filters that can be later reused for operations on meshes. You can +access it from the Main Menu via Tools / Selection filter library. 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 Faces: \ref area_page "Area quality control"), which is more, less or equal (within a given Tolerance) to the predefined Threshold Value.
  • -Free edges selects 2D mesh elements having at least one of its -edges not shared with other faces. See also a +Free edges 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".
  • Free faces selects 2D mesh elements, which belong to less than two volumes. diff --git a/doc/salome/gui/SMESH/input/sewing_meshes.doc b/doc/salome/gui/SMESH/input/sewing_meshes.doc index 8697b36f4..cfb6206dd 100644 --- a/doc/salome/gui/SMESH/input/sewing_meshes.doc +++ b/doc/salome/gui/SMESH/input/sewing_meshes.doc @@ -32,9 +32,9 @@ the type of sewing operation you would like to perform.
    • 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.
    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: 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"
    \image html sew_after_merge.png "After merging nodes it is easy to specify border nodes"