From 2ec4289dd80d34929c04d847f2e0ec419e523cbb Mon Sep 17 00:00:00 2001 From: vsr Date: Wed, 20 Oct 2010 10:37:03 +0000 Subject: [PATCH] Update documentation for 5.1.5 --- .../gui/SMESH/input/2d_meshing_hypo.doc | 36 ++++---- doc/salome/gui/SMESH/input/about_filters.doc | 17 ++-- .../SMESH/input/adding_nodes_and_elements.doc | 28 +++--- .../SMESH/input/adding_quadratic_elements.doc | 28 +++--- .../gui/SMESH/input/creating_groups.doc | 7 +- .../gui/SMESH/input/double_nodes_page.doc | 2 +- doc/salome/gui/SMESH/input/index.doc | 4 + .../gui/SMESH/input/make_2dmesh_from_3d.doc | 2 +- .../gui/SMESH/input/modifying_meshes.doc | 5 +- .../gui/SMESH/input/pattern_mapping.doc | 87 ++++++++++--------- .../input/removing_nodes_and_elements.doc | 8 +- .../SMESH/input/selection_filter_library.doc | 8 +- doc/salome/gui/SMESH/input/tui_filters.doc | 8 +- 13 files changed, 122 insertions(+), 118 deletions(-) diff --git a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc index 07a33f09c..d72e4d504 100644 --- a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc @@ -49,7 +49,7 @@ length calculated as an average edge length for a given wire. Base vertex parameter allows using Quadrangle (Mapping) algorithm for meshing of triangular faces. In this case it is -necessary to select a vertex, which will be used as the fourth edge +necessary to select the vertex, which will be used as the fourth edge (degenerated). \image html hypo_quad_params_1.png "A face built from 3 edges" @@ -68,31 +68,31 @@ shows the good (left) and the bad (right) results of meshing. \image html hypo_quad_params_res_2.png "The resulting meshes" -Type parameter has sense on faces with different number of -segments on opposite sides. The following types are available: +Type parameter is used on faces with a different number of +segments on opposite sides to define the algorithm of transition +between them. The following types are available: See Also a sample TUI Script of a diff --git a/doc/salome/gui/SMESH/input/about_filters.doc b/doc/salome/gui/SMESH/input/about_filters.doc index 98c74c424..22d88635f 100644 --- a/doc/salome/gui/SMESH/input/about_filters.doc +++ b/doc/salome/gui/SMESH/input/about_filters.doc @@ -2,8 +2,8 @@ \page filters_page About filters -\b Filters allows to pick only those mesh elements which satisfy to -specific condition or set of conditions. Filters can be used to create +\b Filters allow picking only the mesh elements satisfying to a +specific condition or a set of conditions. Filters can be used to create or edit mesh groups, remove elements from the mesh object, control mesh quality by different parameters, etc. @@ -18,15 +18,14 @@ The functinality of mesh filters is available in both GUI and TUI modes: - In GUI, filters are available in some dialog boxes via an additional -"Set Filters" button, clicking on which opens specific dialog box +"Set Filters" button, clicking on which opens the dialog box allowing to specify the list of filter criterions to be applied to the -current selection. Follow to the \subpage selection_filter_library_page page to learn more +current selection. See \subpage selection_filter_library_page page to learn more about selection filters and their usage in GUI. -- In Python scripts, filters can be used to choose only some of mesh - entities (nodes and/or elements) for the operations which require - list of the entities as input parameter (create/modify group, remove +- In Python scripts, filters can be used to choose only some mesh + entities (nodes and/or elements) for the operations, which require the + list of entities as input parameter (create/modify group, remove nodes/elements, etc). The page \ref tui_filters_page provides - examples of the filters usage in the Python scripts. - + examples of the filters usage in Python scripts. */ 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 5c99e8e79..c0168994b 100644 --- a/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc +++ b/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc @@ -27,23 +27,23 @@ following associated submenu will appear: From this submenu select the type of element which you would like to add to your mesh. -\note All dialogs for adding new node or element to the mesh (except for -the dialog for 0D elements) provide a possibility to add it -automatically to the specified group or to create it anew using -Add to group box, that allows to choose an existing group for -the created node or element or to give the name to a new group. By -default, the Add to group check box is switched off. If user +\note All dialogs for new node or element adding to the mesh (except for +the dialog for 0D elements) provide the possibility to automatically add +a node or element to the specified group or to create the 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 existing groups of the corresponding type becomes available. By -default, no any group is selected. In such a case, when user presses +default, no group is selected. In this case, when the user presses Apply or Apply & Close button, the warning message box -informing the user about the necessity to input new group name is -shown. The combo box lists both \ref standalone_group "standalone groups" -and \ref group_on_geom "groups on geometry". If the user has -chosen the group on geometry, he is warned and proposed to -\ref convert_to_standalone "convert this group to the standalone". -If user refuses converting operation, an operation is cancelled and -new node/element is not created! +informs the user about the necessity to input new group name. The +combo box lists both \ref standalone_group "standalone groups" +and \ref group_on_geom "groups on geometry". If the user chooses a +group on geometry, he is warned and proposed to +\ref convert_to_standalone "convert this group to standalone". +If the user rejects conversion operation, it is cancelled and +a new node/element is not created! diff --git a/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc b/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc index 83736c85d..921948630 100644 --- a/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc +++ b/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc @@ -18,23 +18,23 @@ one of the following: \image html image152.png -\note All dialogs for adding quadratic element to the mesh -provide a possibility to add new element -automatically to the specified group or to create it anew using -Add to group box, that allows to choose an existing group for -the created node or element or to give the name to a new group. By -default, the Add to group check box is switched off. If user +\note All dialogs for quadratic element adding to the mesh +provide the possibility to automatically add an element +to the specified group or to create the group 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 existing groups of the corresponding type becomes available. By -default, no any group is selected. In such a case, when user presses +default, no group is selected. In this case, when the user presses Apply or Apply & Close button, the warning message box -informing the user about the necessity to input new group name is -shown. The combo box lists both \ref standalone_group "standalone groups" -and \ref group_on_geom "groups on geometry". If the user has -chosen the group on geometry, he is warned and proposed to -\ref convert_to_standalone "convert this group to the standalone". -If user refuses converting operation, an operation is cancelled and -new node/element is not created! +informs the user about the necessity to input a new group name. The +combo box lists both \ref standalone_group "standalone groups" +and \ref group_on_geom "groups on geometry". If the user chooses a +group on geometry, he is warned and proposed to +\ref convert_to_standalone "convert this group to standalone". +If the user rejects conversion operation, it is cancelled and +a new quadratic element is not created. To create any Quadratic Element specify the nodes which will form your diff --git a/doc/salome/gui/SMESH/input/creating_groups.doc b/doc/salome/gui/SMESH/input/creating_groups.doc index 1b00a6174..85d633a22 100644 --- a/doc/salome/gui/SMESH/input/creating_groups.doc +++ b/doc/salome/gui/SMESH/input/creating_groups.doc @@ -26,7 +26,7 @@ SALOME Platform distinguishes between the two Group types: \anchor standalone_group

"Standalone Group"

Standalone Group consists of mesh elements, which you can define in -the next possible ways: +the following ways: To remove a selected element or elements from the list click the \b Remove button. The Sort List button allows to sort the list of IDs of diff --git a/doc/salome/gui/SMESH/input/double_nodes_page.doc b/doc/salome/gui/SMESH/input/double_nodes_page.doc index eb41ee747..8935f3140 100644 --- a/doc/salome/gui/SMESH/input/double_nodes_page.doc +++ b/doc/salome/gui/SMESH/input/double_nodes_page.doc @@ -1,6 +1,6 @@ /*! -\page double_nodes_page Duplicating Nodes +\page double_nodes_page Duplicate Nodes \n This operation allows to duplicate nodes of your mesh. diff --git a/doc/salome/gui/SMESH/input/index.doc b/doc/salome/gui/SMESH/input/index.doc index af0f76f16..0975842ae 100644 --- a/doc/salome/gui/SMESH/input/index.doc +++ b/doc/salome/gui/SMESH/input/index.doc @@ -25,6 +25,10 @@ array of dedicated operations. Almost all mesh module functionalities are accessible via \subpage smeshpy_interface_page "Mesh module Python interface". +Also it can be useful to have a look at the +\subpage smeshpypkg_page "documentation on SMESH python package". + + \image html image7.jpg "Example of MESH module usage for engineering tasks" */ diff --git a/doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc b/doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc index f4b5b2ba5..ada914ec1 100644 --- a/doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc +++ b/doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc @@ -1,6 +1,6 @@ /*! -\page make_2dmesh_from_3d_page Generate the skin elements (2D) of a mesh having 3D elements +\page make_2dmesh_from_3d_page Create 2D mesh from 3D \n This functionality allows to generate 2D mesh elements as a skin on the existing 3D mesh elements. diff --git a/doc/salome/gui/SMESH/input/modifying_meshes.doc b/doc/salome/gui/SMESH/input/modifying_meshes.doc index 8d5875a9c..0eb82ceb6 100644 --- a/doc/salome/gui/SMESH/input/modifying_meshes.doc +++ b/doc/salome/gui/SMESH/input/modifying_meshes.doc @@ -18,7 +18,9 @@ elements of the mesh. its elements.
  • \subpage rotation_page "Rotate" by the indicated axis and angle the mesh or some of its elements.
    • -
  • \subpage scale_page "Scale Transform" the mesh or some of its elements.
    • +
  • \subpage scale_page "Scale Transform" the mesh or some of its +elements.
    • +
  • \subpage double_nodes_page "Duplicate nodes".
  • Create a \subpage symmetry_page "symmetrical copy" of the mesh through a point or a vector of symmetry.
  • Unite meshes by \subpage sewing_meshes_page "sewing" free borders, @@ -45,7 +47,6 @@ of the selected node or edge.
  • Apply \subpage pattern_mapping_page "pattern mapping".
  • \subpage convert_to_from_quadratic_mesh_page "Convert regular mesh to quadratic", or vice versa.
    • -
  • Create \subpage double_nodes_page "double nodes".
  • \subpage make_2dmesh_from_3d_page "Create 2D mesh from 3D".
    • diff --git a/doc/salome/gui/SMESH/input/pattern_mapping.doc b/doc/salome/gui/SMESH/input/pattern_mapping.doc index 1a48a4644..8421b1d87 100644 --- a/doc/salome/gui/SMESH/input/pattern_mapping.doc +++ b/doc/salome/gui/SMESH/input/pattern_mapping.doc @@ -5,33 +5,31 @@

    About patterns

    The pattern describes a mesh to generate: positions of nodes within a -geometrical domain and nodal connectivity of elements. As well, a -pattern specifies the so-called key-points, i.e. nodes that will be -located at geometrical vertices. Pattern description is stored in +geometrical domain and nodal connectivity of elements. A +pattern also specifies the so-called key-points, i.e. the nodes that will be +located at geometrical vertices. The pattern description is stored in \.smp file. The smp file contains 4 sections: --# The first line holds the total number of the pattern nodes (N). --# The next N lines describe nodes coordinates. Each line holds 2 -coordinates of a node for 2D pattern or 3 cordinates for 3D pattern. -Note, that for 3D pattern only relateive values in range [0;1] are -valid for coordinates of the nodes. --# A key-points line: indices of nodes to be mapped on geometrical -vertices (for 2D pattern only). An index n refers to a node described -on an n-th line of section 2. The first node index is zero. For 3D -pattern key points are not specified. --# The rest lines describe nodal connectivity of elements, one line -for an element. A line holds indices of nodes forming an element. An -index n refers to a node described on an n-th line of the section -2. The first node index is zero. There must be 3 or 4 indices on a -line for 2D pattern (only 2d elements are allowed) and 4, 5, 6 or 8 -indices for 3D pattern (only 3d elements are allowed). +-# The first line indicates the total number of pattern nodes (N). +-# The next N lines describe nodes coordinates. Each line contains 2 +node coordinates for a 2D pattern or 3 node cordinates for a 3D pattern. +Note, that node coordinates of a 3D pattern can be defined only by relative values in range [0;1]. +-# The key-points line contains the indices of the nodes to be mapped on geometrical +vertices (for a 2D pattern only). Index n refers to the node described +on the n-th line of section 2. The index of the first node zero. For a 3D pattern the key points are not specified. +-# The remaining lines describe nodal connectivity of elements, one line +for each element. Each line holds indices of nodes forming an element. +Index n refers to the node described on the n-th line of section 2. +The first node index is zero. There must be 3 or 4 indices on each +line for a 2D pattern (only 2d elements are allowed) and 4, 5, 6 or 8 +indices for a 3D pattern (only 3d elements are allowed). -The 2D pattern must contain at least one element and at least one -key-point. All key-points must lay on boundaries. +A 2D pattern must contain at least one element and at least one +key-point. All key-points must lie on boundaries. -The 3D pattern must contain at least one element. +A 3D pattern must contain at least one element. An example of a simple 2D pattern smp file: @@ -60,7 +58,7 @@ An example of a simple 2D pattern smp file: 8 1 2 \endcode -The image below provides a preview of above described pattern: +The image below provides a preview of the above pattern: \image html pattern2d.png @@ -99,38 +97,41 @@ From the \b Modification menu choose the Pattern Mapping item or click \image html image98.png
    "Pattern mapping" button
    -The following dialog box shall appear: +The following dialog box will appear: + +\n 2D pattern \image html patternmapping1.png -
    2D Pattern Mapping dialog box
    +In this dialog you should specify: + + + +\n 3D pattern \image html patternmapping2.png -
    3D Pattern Mapping dialog box
    - -To apply a pattern to a geometrical object, you should specify: - --# For 2D pattern - - A face having the number of vertices equal to the number of - key-points in the pattern; the number of key-points on internal - boundaries of a pattern must also be equal to the number of vertices - on internal boundaries of a face; - - A vertex to which the first key-point should be mapped; - - Reverse or not the order of key-points. (The order of vertices of - a face is counterclockwise looking from outside). --# For 3D pattern - - 3D block (Solid) object; - - Two vertices that specify the order of nodes in the resulting - mesh. +In this dialog you should specify: + Then you either load a .smp pattern file previously created manually by clicking on the "Load pattern" button, or click on the \b New button for automatic generation of the pattern. -For an automatic generation you just specify a geometrical face (for -2D) or solid (for 3d) having a mesh built on it. Mesh nodes lying on -face vertices become key-points of 2D pattern. Additionally, for 2D +For automatic generation you should specify a geometrical face (for a +2D pattern) or a solid (for a 3D pattern) with a mesh built on it. Mesh nodes lying on +face vertices become key-points of the pattern. Additionally, for a 2D pattern you may choose the way of getting nodes coordinates by projecting nodes on the face instead of using "positions on face" generated by mesher (if there is any). Faces diff --git a/doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc b/doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc index aef20c8ad..0a48ee65e 100644 --- a/doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc +++ b/doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc @@ -51,14 +51,14 @@ node of your mesh all adjacent elements will be also deleted. \anchor removing_orphan_nodes_anchor

    Removing orphan nodes

    -There is a quick way to remove all the orphan (free) nodes. +There is a quick way to remove all orphan (free) nodes. -To remove the orphan nodes: +To remove orphan nodes:
    1. Select your mesh in the Object Browser or in the 3D viewer.
    2. From the Modification menu choose Remove and from the associated -submenu select the Orphan Nodes, or just click "Remove orphan nodes" +submenu select Orphan Nodes, or just click "Remove orphan nodes" button in the toolbar. \image html remove_orphan_nodes_icon.png @@ -68,7 +68,7 @@ The following Warning message box will appear: \image html removeorphannodes.png -Confirm removing nodes by pressing "Yes" button. +Confirm nodes removal by pressing "Yes" button.

    diff --git a/doc/salome/gui/SMESH/input/selection_filter_library.doc b/doc/salome/gui/SMESH/input/selection_filter_library.doc index dd9ae9103..c01dc0a54 100644 --- a/doc/salome/gui/SMESH/input/selection_filter_library.doc +++ b/doc/salome/gui/SMESH/input/selection_filter_library.doc @@ -157,10 +157,10 @@ length, which is more, less or equal (within a given Tolerance) to the pr Threshold Value. See also a \ref length_2d_page "Length 2D quality control".
  • -Coplanar faces selects mesh faces neighboring the one defined by -Threshold Value and whose normal has an angle less then an -angular tolerance (defined in degrees) with normal of the face -selected as threshold. Selection continues among neighboring faces of already +Coplanar faces selects mesh faces neighboring the one selected +by ID in Threshold Value field, if the angle between the +normal to the neighboring face and the normal to the selected face is less then the +angular tolerance (defined in degrees). Selection continues among all neighbor faces of already selected ones.
    • diff --git a/doc/salome/gui/SMESH/input/tui_filters.doc b/doc/salome/gui/SMESH/input/tui_filters.doc index ad6dd5929..0a4fccd3b 100755 --- a/doc/salome/gui/SMESH/input/tui_filters.doc +++ b/doc/salome/gui/SMESH/input/tui_filters.doc @@ -2,8 +2,8 @@ \page tui_filters_page Filters usage -Filters allows to pick only those mesh elements which satisfy to -specific condition or set of conditions. Filters can be used to create +Filters allow picking only the mesh elements satisfying to a +specific condition or a set of conditions. Filters can be used to create or edit mesh groups, remove elements from the mesh object, control mesh quality by different parameters, etc. @@ -12,10 +12,10 @@ AND and \a OR. In addition, applied filter criterion can be reverted using logical operator \a NOT. Mesh filters use the functionality of mesh quality controls to filter -mesh nodes / elements by specific characteristic (Area, Length, etc). +mesh nodes / elements by a specific characteristic (Area, Length, etc). This page provides a short description of the existing mesh filters, -describing required parameters and gives simple examples of usage in +describes required parameters and gives simple examples of usage in Python scripts. \sa \ref tui_quality_controls_page