From cc801656b1ace2aeabd388361c8a561d69d057b1 Mon Sep 17 00:00:00 2001 From: vsr Date: Mon, 3 Dec 2012 11:33:20 +0000 Subject: [PATCH] Correction of documentation --- doc/salome/gui/SMESH/input/about_meshes.doc | 6 +- .../SMESH/input/adding_nodes_and_elements.doc | 47 +++++------ .../gui/SMESH/input/additional_hypo.doc | 10 +-- .../gui/SMESH/input/basic_meshing_algos.doc | 2 +- doc/salome/gui/SMESH/input/colors_size.doc | 10 +-- .../gui/SMESH/input/constructing_meshes.doc | 78 +++++++++---------- .../SMESH/input/constructing_submeshes.doc | 20 ++--- .../gui/SMESH/input/cutting_quadrangles.doc | 19 +++-- doc/salome/gui/SMESH/input/extrusion.doc | 5 +- .../input/removing_nodes_and_elements.doc | 11 ++- doc/salome/gui/SMESH/input/reorient_faces.doc | 37 ++++----- .../SMESH/input/selection_filter_library.doc | 14 ++-- .../SMESH/input/uniting_set_of_triangles.doc | 4 +- 13 files changed, 126 insertions(+), 137 deletions(-) diff --git a/doc/salome/gui/SMESH/input/about_meshes.doc b/doc/salome/gui/SMESH/input/about_meshes.doc index 411fc30b5..dc68cff59 100644 --- a/doc/salome/gui/SMESH/input/about_meshes.doc +++ b/doc/salome/gui/SMESH/input/about_meshes.doc @@ -18,11 +18,11 @@ different meshing parameters than the whole mesh. Several created meshes can be \subpage building_compounds_page "combined into another mesh". -The whole mesh or it's part can be \subpage copy_mesh_page "copied" into another mesh. +The whole mesh or its part can be \subpage copy_mesh_page "copied" into another mesh. Meshing parameters of meshes and sub-meshes can be -\subpage editing_meshes_page "edited", then only a path of mesh -depending on changed parameters will be re-computed. +\subpage editing_meshes_page "edited", then only the mesh part +depending on the changed parameters will be re-computed. Meshes can be edited using the MESH functions destined for \ref modifying_meshes_page "modification" of generated meshes. diff --git a/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc b/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc index c0abbd04f..7f4ff562e 100644 --- a/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc +++ b/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc @@ -36,7 +36,7 @@ a node or element to the specified group or to create it anew using Add to group box, that allows choosing an existing group for the created node or element or giving the name to a new group. By default, the Add to group check box is switched off. If the user -swiches this check box on, the combo box listing all currently +switches this check box on, the combo box listing all currently existing groups of the corresponding type becomes available. By default, no group is selected. In this case, when the user presses Apply or Apply & Close button, the warning message box @@ -72,7 +72,7 @@ created: \image html add0delement.png -In this dialog box specify nodes which will form your 0d elements by +In this dialog box specify nodes which will form your 0D elements by selecting them in the 3D viewer and click the \b Apply or Apply and Close button. Your 0D elements will be created: @@ -81,34 +81,29 @@ selecting them in the 3D viewer and click the \b Apply or \anchor adding_0delems_on_all_nodes_anchor

Making 0D elements on Element Nodes

-There is another dialog which lets you create 0D elements. It creates -0D elements on all nodes of selected elements or nodes, where no 0D -elements are yet present. +There is another way to create 0D elements. It is possible to create +0D elements on all nodes of the selected mesh, sub-mesh, or a group of elements or nodes. \image html dlg_0D_on_all_nodes.png In this dialog @@ -117,10 +112,10 @@ criteria). \image html addball.png -In this dialog box specify nodes which will form your ball elements -either by selecting them in the 3D viewer or by manual entering their IDs, +In this dialog box specify the nodes, which will form your ball elements, +either by selecting them in the 3D viewer or by manually entering their IDs, specify the ball diameter and click the \b Apply or Apply and -Close button. Your ball elements with an equal diameter will be created: +Close button. \image html add_ball.png diff --git a/doc/salome/gui/SMESH/input/additional_hypo.doc b/doc/salome/gui/SMESH/input/additional_hypo.doc index 5dab60abc..2fde9c142 100644 --- a/doc/salome/gui/SMESH/input/additional_hypo.doc +++ b/doc/salome/gui/SMESH/input/additional_hypo.doc @@ -50,8 +50,8 @@ segments on all four sides of the face must be even (divisible by 2).

Viscous Layers and Viscous Layers 2D

Viscous Layers and Viscous Layers 2D additional -hypotheses can be used together with some 3D algorithms, -Hexahedron(i,j,k) for example, and 2D algorithm, for example Triangle +hypotheses can be used together with some 3D algorithms, for example, +Hexahedron(i,j,k) or 2D algorithms, for example, Triangle (MEFISTO), correspondingly. These hypotheses allow creation of layers of highly stretched elements, prisms in 3D and quadrilaterals in 2D, near mesh boundary, which is beneficial for high quality viscous @@ -61,7 +61,7 @@ computations. \ref use_existing_anchor "Use existing edges" and \ref use_existing_anchor "Use existing faces" algorithms can be -used to create an 1D or a 2D mesh in a python script. +used to create a 1D or a 2D mesh in a python script. \ref constructing_meshes_page "Constructing meshes" page describes in detail how to apply meshing algorithms. diff --git a/doc/salome/gui/SMESH/input/colors_size.doc b/doc/salome/gui/SMESH/input/colors_size.doc index c0953ff09..e777e84a1 100644 --- a/doc/salome/gui/SMESH/input/colors_size.doc +++ b/doc/salome/gui/SMESH/input/colors_size.doc @@ -14,7 +14,7 @@ shown. - \b Nodes: - \b Color - color of nodes. - - \b Type and \b Scale - these options allow changing of the nodes + - \b Type and \b Scale - these options allow changing the nodes representation (see \subpage point_marker_page "Point Marker" page for more details). - Edges / wireframe: @@ -23,13 +23,13 @@ shown. in wireframe mode). - \b Faces: - \b Front - surface color of face elements (seen in shading mode). - - \b Back - backside surface color of face elements. Use slider to - select this color generated on base of the \b Face color by + - \b Back - backside surface color of face elements. Use the slider to + select this color generated on the base of the \b Face color by changing its brightness and saturation. - \b Volumes: - \b Normal - surface color of normal volume elements (seen in shading mode). - - \b Reversed - surface color of volume elements. Use slider to - select this color generated on base of the \b Normal color by + - \b Reversed - surface color of volume elements. Use the slider to + select this color generated on the base of the \b Normal color by changing its brightness and saturation. - \b Outlines: - \b Color - color of element borders in shading mode. diff --git a/doc/salome/gui/SMESH/input/constructing_meshes.doc b/doc/salome/gui/SMESH/input/constructing_meshes.doc index 23349d0c1..bef709906 100644 --- a/doc/salome/gui/SMESH/input/constructing_meshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_meshes.doc @@ -37,42 +37,42 @@ written in Python. "Create mesh" dialog box contains several tab pages titled \b 3D, \b 2D, \b 1D and \b 0D. The title of each page reflects the dimension of the CAD model (geometry) the algorithms listed on - this page affect to. For example, \b 3D page lists algorithms + this page affect. For example, \b 3D page lists the algorithms that affect 3D geometrical objects (solids). \note - - Some page(s) can be disabled - if the source geometrical + - Some page(s) can be disabled if the source geometrical object does not include shapes (sub-shapes) of the corresponding - dimension(s). For example, if input object is a geometrical face, + dimension(s). For example, if the input object is a geometrical face, \b 3D page is disabled. - - Some algorithms affect on geometry of several dimensions, - i.e. "1D-2D" or "1D-2D-3D". If such algorithm is selected by the - user, dialog box pages related to the corresponding lower level + - Some algorithms affect the geometry of several dimensions, + i.e. "1D-2D" or "1D-2D-3D". If such an algorithm is selected by the + user, the dialog box pages related to the corresponding lower level dimensions are disabled. - \b 0D page does not refer to the 0D elements, but to 0D geometry (vertices). Mesh module does not provide algorithms that produce 0D elements. Currently \b 0D page provides only one - algorithm "Segments around vertex" that allows specyfing required - size of mesh edges about some selected vertex(vertices). + algorithm "Segments around vertex" that allows specyfying the required + size of mesh edges about the selected vertex (or vertices). For example, you need to mesh a 3D object. - First, type the name for your mesh in the \b Name box, by default, + First, type the name of your mesh in the \b Name box, by default, it is "Mesh_1". Then select the geometrical object you wish to mesh in the Object Browser and click "Select" button near \b Geometry - field (if name of the object not yet appeared in \b Geometry field). + field (if the name of the object has not yet appeared in \b Geometry field). \image html image120.png "Select" button Now you can define 3D Algorithm and 3D Hypotheses, which will be - applied to solids of your geometrical object. Click the "Add + applied to the solids of your geometrical object. Click the "Add Hypothesis" button to add a hypothesis. \image html image121.png "Add Hypothesis" button - Click the "Edit Hypothesis" button to change values for the + Click the "Edit Hypothesis" button to change the values for the current hypothesis. \image html image122.png @@ -86,14 +86,14 @@ written in Python. will be used to mesh faces and edges of your geometry. (Note that any object has edges, even if their existence is not apparent, for example, a sphere has 4 edges). Note that the - choice of hypotheses and of an algorithm of lower dimension depends on - the algorithm. + choice of hypotheses and lower dimension algorithms depends on + the higher dimension algorithm. - Some algorithms generate mesh of several dimensions while others, of - only one dimension. In the latter case there must be one Algorithm and zero or several + Some algorithms generate mesh of several dimensions, while others + produce mesh of only one dimension. In the latter case there must be one Algorithm and zero or several Hypotheses for each dimension of your object, otherwise you will not get any mesh at all. Of course, if you wish to mesh a face, - which is a 2D object, you don't need to define 3D Algorithm and + which is a 2D object, you do not need to define a 3D Algorithm and Hypotheses. In the Object Browser the structure of the new mesh will be @@ -122,7 +122,7 @@ written in Python. tags). \image html hypo_sets.png - List of sets of hypotheses: [custom] + List of sets of hypotheses. Tag [custom] is automatically added to the sets defined by the user @@ -164,7 +164,7 @@ Select 1D mesh or 2D mesh preview mode in the Preview dialog. Compute button computes the whole mesh. When the Preview dialog is closed, the question about the storage of temporarily -created mesh elements appers: +created mesh elements appears: \image html preview_tmp_data.png @@ -185,7 +185,7 @@ Choose "Change submesh priority" from the Mesh menu or a pop-up menu. The opened dialog shows a list of submeshes in the order of their priority. -There is an example of submesh order modifications of the Mesh created on a Box +There is an example of submesh order modifications taking a Mesh created on a Box shape. The main Mesh object: