From 4f3f2d161039017fa53c697761f4288ff58c60a3 Mon Sep 17 00:00:00 2001 From: eap Date: Wed, 27 May 2015 20:49:30 +0300 Subject: [PATCH] docs revised --- .../gui/SMESH/input/1d_meshing_hypo.doc | 3 +- doc/salome/gui/SMESH/input/about_hypo.doc | 18 +++++------ .../gui/SMESH/input/additional_hypo.doc | 16 +++++++--- .../gui/SMESH/input/basic_meshing_algos.doc | 3 +- .../gui/SMESH/input/building_compounds.doc | 9 +++--- .../gui/SMESH/input/constructing_meshes.doc | 31 ++++++++++--------- doc/salome/gui/SMESH/input/extrusion.doc | 6 ++-- .../gui/SMESH/input/grouping_elements.doc | 6 ++-- .../input/importing_exporting_meshes.doc | 4 +-- doc/salome/gui/SMESH/input/index.doc | 16 ++++++---- .../gui/SMESH/input/merging_elements.doc | 5 +-- doc/salome/gui/SMESH/input/merging_nodes.doc | 9 +++--- .../gui/SMESH/input/mesh_preferences.doc | 2 +- .../SMESH/input/selection_filter_library.doc | 4 +-- doc/salome/gui/SMESH/input/smoothing.doc | 3 +- .../SMESH/input/uniting_set_of_triangles.doc | 2 +- .../gui/SMESH/input/uniting_two_triangles.doc | 4 +-- 17 files changed, 80 insertions(+), 61 deletions(-) diff --git a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc index 62db9d0ad..2ab53e44d 100644 --- a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc @@ -337,7 +337,8 @@ parameter of the hypotheses depending on edge direction. geometrical model in the 3D Viewer, which can help to understand the location of a set of edges within the model. -Propagation chains group allows splitting opposite edges of quadrilateral faces +Propagation chains group allows defining Reversed Edges +for splitting opposite edges of quadrilateral faces in a logically uniform direction. When this group is activated, the list is filled with propagation chains found within the model. When a chain is selected in the list its edges are diff --git a/doc/salome/gui/SMESH/input/about_hypo.doc b/doc/salome/gui/SMESH/input/about_hypo.doc index 651b38a91..12f5c02e1 100644 --- a/doc/salome/gui/SMESH/input/about_hypo.doc +++ b/doc/salome/gui/SMESH/input/about_hypo.doc @@ -15,15 +15,15 @@ The choice of a hypothesis depends on the selected algorithm. Hypotheses are created during creation and edition of \ref constructing_meshes_page "meshes" and \ref constructing_submeshes_page "sub-meshes". -Once created a hypotheses can be reused during creation and -edition of other meshes and sub-meshes. All created hypotheses and -algorithms are present in the Object Browser in \a Hypotheses and -\a Algorithms folders correspondingly. It is possible to open a dialog -to modify the parameters of a hypothesis from its context menu. -This menu also provides \b Unassign command that will unassign the hypothesis from all -meshes and sub-meshes using it. -Modification of any parameter of a hypothesis and its unassignment lead -to automatic removal of elements generated using it. +Once created a hypotheses can be reused during creation and edition of +other meshes and sub-meshes. All created hypotheses and algorithms are +present in the Object Browser in \a Hypotheses and \a Algorithms +folders correspondingly. It is possible to open a dialog to modify the +parameters of a hypothesis from its context menu. This menu also +provides \b Unassign command that will unassign the hypothesis from +all meshes and sub-meshes using it. Modification of any parameter of a +hypothesis and its unassignment leads to automatic removal of elements +generated using it. In \b MESH there are the following Basic Hypotheses:
  • For meshing of 2D entities (faces):
    • diff --git a/doc/salome/gui/SMESH/input/building_compounds.doc b/doc/salome/gui/SMESH/input/building_compounds.doc index c10455d5c..ce5f3ce50 100644 --- a/doc/salome/gui/SMESH/input/building_compounds.doc +++ b/doc/salome/gui/SMESH/input/building_compounds.doc @@ -32,10 +32,11 @@ The following dialog box will appear:
  • Processing identical groups - allows selecting the method of processing the namesake groups existing in the input meshes. They can be either See \ref grouping_elements_page "Creating Groups" for more information about groups.
    • diff --git a/doc/salome/gui/SMESH/input/constructing_meshes.doc b/doc/salome/gui/SMESH/input/constructing_meshes.doc index de4167b6c..666cfca25 100644 --- a/doc/salome/gui/SMESH/input/constructing_meshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_meshes.doc @@ -101,9 +101,10 @@ creation and computing) of the following steps: 3D sub-shapes (solids) and generate 3D mesh elements (tetrahedra, hexahedra etc.) - As soon as you have selected an algorithm, you can create a hypothesis (or - select an already created one). A set of accessible - hypotheses includes only the hypotheses that can be used by the selected algorithm. + As soon as you have selected an algorithm, you can create a + hypothesis (or select an already created one). A set of accessible + hypotheses includes only the hypotheses that can be used by the + selected algorithm. \note - Some page(s) can be disabled if the geometrical @@ -115,7 +116,7 @@ creation and computing) of the following steps: dialog pages related to the corresponding lower dimensions are disabled. - \b 0D page refers to 0D geometry (vertices) rather than - to 0D elements. Mesh module does not provide algorithms that + to 0D elements. Mesh module does not provide algorithms that produce 0D elements. Currently \b 0D page provides only one algorithm "Segments around vertex" that allows specifying the required size of mesh edges about the selected vertex (or vertices). @@ -123,8 +124,8 @@ creation and computing) of the following steps: For example, you need to mesh a 3D object. First, you can change a default name of your mesh in the \b Name - box. Then check that the selected geometrical object - indicated in \b Geometry field, is what you wish to mesh; if not, select + box. Then check that the selected geometrical object indicated in + \b Geometry field, is what you wish to mesh; if not, select the correct object in the Object Browser. Click "Select" button near \b Geometry field if the name of the object has not yet appeared in \b Geometry field. @@ -221,9 +222,9 @@ creation and computing) of the following steps: \note - - \a "Automatic" in the names of predefined sets of - hypotheses does not actually mean that they are suitable for - meshing any geometry. + - \a "Automatic" in the names of predefined sets of hypotheses + does not actually mean that they are suitable for meshing any + geometry. - The list of sets of hypotheses can be shorter than in the above image depending on the geometry dimension. @@ -376,13 +377,13 @@ click "Compute" button of the toolbar. After the mesh computation finishes, the Mesh Computation information box appears. If you close this box and click "Compute" button again, -without previously changing meshing parameters, the mesh will -NOT be re-computed and the Mesh Computation information box will be shown with -the same contents. (To fully re-compute the mesh, invoke \ref -clear_mesh_anchor "Clear Mesh Data" command before). +without previously changing meshing parameters, the mesh will NOT be +re-computed and the Mesh Computation information box will be shown +with the same contents. (To fully re-compute the mesh, invoke +\ref clear_mesh_anchor "Clear Mesh Data" command before). -If the mesh computation has been a success, the box shows information on the number of entities -of different types in the mesh. +If the mesh computation has been a success, the box shows information +on the number of entities of different types in the mesh. \image html meshcomputationsucceed.png diff --git a/doc/salome/gui/SMESH/input/extrusion.doc b/doc/salome/gui/SMESH/input/extrusion.doc index e248114d2..53b76a8e5 100644 --- a/doc/salome/gui/SMESH/input/extrusion.doc +++ b/doc/salome/gui/SMESH/input/extrusion.doc @@ -58,7 +58,8 @@ The following dialog will appear:
  • If the Extrusion to Distance radio button is selected - specify the translation vector by which the elements will be extruded.
    • - +


    + \image html extrusionalongaline2.png
  • If the Extrusion Along Vector radio button is selected @@ -70,7 +71,8 @@ The following dialog will appear: be negative).
    • - +


    + \image html extrusionalongaline3.png
  • If the Extrusion By Normal radio button is selected, diff --git a/doc/salome/gui/SMESH/input/grouping_elements.doc b/doc/salome/gui/SMESH/input/grouping_elements.doc index 335f5b071..9548913da 100644 --- a/doc/salome/gui/SMESH/input/grouping_elements.doc +++ b/doc/salome/gui/SMESH/input/grouping_elements.doc @@ -70,9 +70,9 @@ The created groups can be later: - \ref importing_exporting_meshes_page "Exported" into a file as a whole mesh. -In the Object Browser, if an item contains more -than one group, it is possible to sort its groups by name in -ascending order using Sort children context menu item. +In the Object Browser, if an item contains more than one child group, +it is possible to sort the groups by name in ascending order +using Sort children context menu item. \image html smesh_sort_groups.png "Sorting groups" diff --git a/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc b/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc index 516981cd9..b8951f00a 100644 --- a/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc +++ b/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc @@ -4,8 +4,8 @@ \n In MESH there is a functionality allowing import/export of meshes from/to \b MED, \b UNV (I-DEAS 10), \b DAT (simple ascii format), \b STL, -\b GMF (internal format of DISTENE products, namely BLSurf, GHS3D and -Hexotic algorithms) and \b CGNS format files. You can also export a +\b GMF (internal format of DISTENE products, namely MG-CADSurf, MG-Tetra and +MG-Hexa algorithms) and \b CGNS format files. You can also export a group as a whole mesh. diff --git a/doc/salome/gui/SMESH/input/index.doc b/doc/salome/gui/SMESH/input/index.doc index 10475e5b3..f81ce43ed 100644 --- a/doc/salome/gui/SMESH/input/index.doc +++ b/doc/salome/gui/SMESH/input/index.doc @@ -16,10 +16,11 @@ either \ref importing_exporting_meshes_page "imported" or manually created);
    • -
  • \ref importing_exporting_meshes_page "importing and exporting meshes in various formats";
    • +
  • \ref importing_exporting_meshes_page "importing and exporting meshes in various formats";
  • \subpage modifying_meshes_page "modifying meshes" with a vast array of dedicated operations;
    • -
  • \subpage grouping_elements_page "creating groups of mesh elements";
    • +
  • \subpage grouping_elements_page "creating groups of mesh + elements";
  • filtering mesh entities (nodes or elements) using \subpage filters_page "Filters" functionality for \ref grouping_elements_page "creating groups" and applying \ref @@ -27,14 +28,17 @@
  • \subpage viewing_meshes_overview_page "viewing meshes" in the VTK viewer;
  • applying to meshes \subpage quality_page "Quality Controls", - allowing to highlight important elements; -
  • taking various \subpage measurements_page "measurements" of the mesh objects. + allowing to highlight important elements;
    • +
  • taking various \subpage measurements_page "measurements" of the + mesh objects.
    • It is possible to use the variables predefined in -\subpage using_notebook_mesh_page "Salome notebook" to set parameters of operations. +\subpage using_notebook_mesh_page "Salome notebook" to set parameters +of operations. -Mesh module preferences are described in the \subpage mesh_preferences_page section of SALOME Mesh Help. +Mesh module preferences are described in the \subpage mesh_preferences_page +section of SALOME Mesh Help. Almost all mesh module functionalities are accessible via \subpage smeshpy_interface_page "Mesh module Python interface". diff --git a/doc/salome/gui/SMESH/input/merging_elements.doc b/doc/salome/gui/SMESH/input/merging_elements.doc index c892b16c8..e5786c094 100644 --- a/doc/salome/gui/SMESH/input/merging_elements.doc +++ b/doc/salome/gui/SMESH/input/merging_elements.doc @@ -38,7 +38,8 @@ object selectable in the dialog box. Two elements are considered coincident if t in the selected object.
  • Coincident elements is a list of groups of elements for merging. After the operation all elements of each group will - be united into one element. + be united into one element. The first element of a group is kept and + the others are removed.