From: maintenance team Date: Fri, 12 Dec 2008 12:49:51 +0000 (+0000) Subject: Update SMESH documentation X-Git-Tag: V5_1_0~1 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=e1d4df199bc2d7b93c55cef670465db239d6fc79;p=modules%2Fsmesh.git Update SMESH documentation --- diff --git a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc index 1d6154014..30838a332 100644 --- a/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/1d_meshing_hypo.doc @@ -22,7 +22,7 @@ beginning from a given starting length and up to a given end length. \image html a-arithmetic1d.png -\image html b-ithmetic1d.png +\image html b-ithmetic1d.png "Arithmetic 1D hypothesis - the size of mesh elements gradually increases" See Also a sample TUI Script of a \ref tui_1d_arithmetic "Defining Arithmetic 1D hypothesis" operation. @@ -42,7 +42,7 @@ locations and 1D mesh elements are constructed on segments. \image html a-deflection1d.png -\image html b-flection1d.png +\image html b-flection1d.png "Deflection 1D hypothesis - useful for meshing curvilinear edges" See Also a sample TUI Script of a \ref tui_deflection_1d "Defining Deflection 1D hypothesis" operation. @@ -71,7 +71,7 @@ integer. Default value is 1e-07. \image html a-averagelength.png -\image html b-erage_length.png +\image html b-erage_length.png "Average length hypothesis - all 1D mesh elements are roughly equal" See Also a sample TUI Script of a \ref tui_average_length "Defining Average Length" hypothesis @@ -100,8 +100,6 @@ You can set the type of distribution for this hypothesis in the
Equidistant Distribution - all segments will have the same length, you define only the Number of Segments. -\image html b-mberofsegments.png -
Scale Distribution - length of segments gradually changes depending on the Scale Factor, which is a ratio of the first segment length to the last segment length. \image html a-nbsegments2.png @@ -130,14 +128,14 @@ operation. Start and End Length hypothesis allows to divide a geometrical edge into segments so that the first and the last segments have a specified -length. The length of each but the first segment differs from length -of the previous one by a constant factor. Then mesh nodes are +length. The length medium segments changes with automatically chosen +geometric progression. Then mesh nodes are constructed at segment ends location and 1D mesh elements are constructed on them. \image html a-startendlength.png -\image html b-art_end_length.png +\image html b-art_end_length.png "The lengths of the first and the last segment are strictly defined" See Also a sample TUI Script of a \ref tui_start_and_end_length "Defining Start and End Length" @@ -158,8 +156,7 @@ low number of elements) to 1 (extremely fine mesh, great number of elements). Compare one and the same object (sphere) meshed with minimum and maximum value of this parameter. -\image html image147.gif - -\image html image148.gif +\image html image147.gif "Example of a very rough mesh. Automatic Length works for 0." +\image html image148.gif "Example of a very fine mesh. Automatic Length works for 1." */ diff --git a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc index 292a5034a..6d89e53d5 100644 --- a/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc +++ b/doc/salome/gui/SMESH/input/2d_meshing_hypo.doc @@ -22,7 +22,7 @@ which will compose the mesh of these 2D faces. \image html a-maxelarea.png -\image html max_el_area.png +\image html max_el_area.png "In this example, Max. element area is very small compared to the 1D hypothesis" See Also a sample TUI Script of a \ref tui_max_element_area "Maximum Element Area" hypothesis diff --git a/doc/salome/gui/SMESH/input/about_hypo.doc b/doc/salome/gui/SMESH/input/about_hypo.doc index f0ae51083..86081743f 100644 --- a/doc/salome/gui/SMESH/input/about_hypo.doc +++ b/doc/salome/gui/SMESH/input/about_hypo.doc @@ -13,7 +13,7 @@ generate a rough or a more refined mesh or submesh. In \b MESH there are the following Basic Hypotheses (to introduce them, you operate numerical values): -There also exist some -\ref additional_hypo_page "Additional Hypotheses": +Some hypotheses are strictly combined with plug-in +meshers and thus, work only with definite algorithms. + + +There also exist +\subpage additional_hypo_page "Additional Hypotheses" used together +with other hypotheses: + */ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/about_meshes.doc b/doc/salome/gui/SMESH/input/about_meshes.doc index 3864329e4..61865173b 100644 --- a/doc/salome/gui/SMESH/input/about_meshes.doc +++ b/doc/salome/gui/SMESH/input/about_meshes.doc @@ -3,15 +3,25 @@ \page about_meshes_page About meshes \n \b MESH represents a discretization of a geometrical CAD model into -a set of entities with a simple topology. In MESH there are two -options of creation of meshes, you can: +a set of entities with a simple topology. - +Meshes are stored in DAT, MED and UNV formats and can be +\subpage importing_exporting_meshes_page "imported from and exported to" + the file in these formats. + +However, it is possible to \subpage constructing_meshes_page "construct meshes" +on the basis of geometrical shapes produced in the GEOM module. +It is also possible to \subpage constructing_submeshes_page "create mesh on a part of the geometrical object", +for example, a face. + +Several created meshes can be \subpage building_compounds_page "combined into mesh compounds". + +All created meshes and submeshes can be \subpage editing_meshes_page "edited". + +Meshes can be also using the MESH functions destined for +\ref modifying_meshes_page "modification" of generated meshes. -The topology of a mesh is described by the relationships between its +The \b topology of a mesh is described by the relationships between its entities including: -\image html image123.gif +\image html image123.gif "Example of a triangular 2D mesh" -\image html image124.gif +\image html image124.gif "Example of a quadrangular 2D mesh"
  • For meshing of 3D entities (volume objects):
    • @@ -40,18 +40,20 @@ hexahedral (cubic) elements. tetrahedral (pyramidal) elements. -\image html image125.gif +\image html image125.gif "Example of a tetrahedral 3D mesh" -\image html image126.gif +\image html image126.gif "Example of a hexahedral 3D mesh" -Note that BLSURF and GHS3D are commercial meshers.\n +\Note that BLSURF and GHS3D are commercial meshers and require a +license to be used within the Mesh module. -There also is a number of more specific algorithms: +There is also a number of more specific algorithms: \ref constructing_meshes_page "Constructing meshes" page describes in diff --git a/doc/salome/gui/SMESH/input/building_compounds.doc b/doc/salome/gui/SMESH/input/building_compounds.doc index d42f38866..faf636b82 100644 --- a/doc/salome/gui/SMESH/input/building_compounds.doc +++ b/doc/salome/gui/SMESH/input/building_compounds.doc @@ -10,7 +10,7 @@ From the \b Mesh menu select Build Compound or click "Build Compound Mesh" button in the toolbar. -\image html image161.gif +\image html image161.png
    "Build Compound Mesh" button
    \par @@ -45,8 +45,6 @@ and elements, in which case it is possible to define the \b Tolerance for this operation. -\n Example: - -\image html image160.gif +\image html image160.gif "Example of a compound of two meshed cubes" */ diff --git a/doc/salome/gui/SMESH/input/changing_orientation_of_elements.doc b/doc/salome/gui/SMESH/input/changing_orientation_of_elements.doc index 3af3983df..410245b04 100644 --- a/doc/salome/gui/SMESH/input/changing_orientation_of_elements.doc +++ b/doc/salome/gui/SMESH/input/changing_orientation_of_elements.doc @@ -11,7 +11,7 @@ nodes of the selected elements.
  • In the \b Modification menu select the \b Orientation item or click Orientation button in the toolbar. -\image html image79.gif +\image html image79.png
    "Orientation" button
    The following dialog box will appear: diff --git a/doc/salome/gui/SMESH/input/clipping.doc b/doc/salome/gui/SMESH/input/clipping.doc index 6c6346ee1..f3b19f374 100644 --- a/doc/salome/gui/SMESH/input/clipping.doc +++ b/doc/salome/gui/SMESH/input/clipping.doc @@ -16,12 +16,12 @@ object, if it is set to 0.5 the object is split in two halves; and Z). If the Show preview button is on, you can see the clipping plane in the 3D Viewer. -\image html image79.jpg +\image html image79.jpg "The plane and the cut object" If the Auto Apply button is on, you can preview the cross-section in the 3D Viewer. -\image html image99.gif +\image html image99.gif "The cross-section" To get a new object from \b Clipping, click \b Apply. diff --git a/doc/salome/gui/SMESH/input/constructing_groups_of_specific_elements.doc b/doc/salome/gui/SMESH/input/constructing_groups_of_specific_elements.doc deleted file mode 100644 index 654b6aab8..000000000 --- a/doc/salome/gui/SMESH/input/constructing_groups_of_specific_elements.doc +++ /dev/null @@ -1,17 +0,0 @@ -/*! - -\page constructing_groups_of_specific_elements_page Constructing groups of specific elements - -\n In MESH you can easily construct groups of specific elements (nodes, -edges, faces or volumes) which will be taken from a definite submesh. - -To construct a group of specific elements: - -\par -Right-click on a submesh in the Object Browser and choose the -Construct Group item or select your submesh in the Object Browser and -in the \b Mesh menu choose the Construct Group item. MESH will construct -several groups consisting of elements of the definite type: nodes, -edges, faces or volumes. - -*/ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/constructing_meshes.doc b/doc/salome/gui/SMESH/input/constructing_meshes.doc index d905ff23e..d62feac7c 100644 --- a/doc/salome/gui/SMESH/input/constructing_meshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_meshes.doc @@ -5,8 +5,8 @@ \n Construction of a mesh consists of: @@ -15,7 +15,7 @@ this mesh.
  • In the \b Mesh menu select Create Mesh or click "Create Mesh" button in the toolbar. -\image html image32.gif +\image html image32.png
    "Create Mesh" button
    The following dialog box will appear: @@ -27,7 +27,7 @@ The following dialog box will appear: it is "Mesh_1". Then select the object you wish to mesh in the Object Browser and click the "Add" button. -\image html image120.gif +\image html image120.png
    "Add" button
    Now you can define 1d Algorithm and 1d Hypotheses, which will be @@ -35,13 +35,13 @@ applied to the edges of your object. (Note that any object has edges, even if their existence is not apparent, for example, a sphere has 4 edges). Click the "Add Hypothesis" button to add a hypothesis. -\image html image121.gif +\image html image121.png
    "Add Hypothesis" button
    Click the "Edit Hypothesis" button to define values for the current hypothesis. -\image html image122.gif +\image html image122.png
    "Edit Hypothesis" button
    The use of additional hypotheses is optional (i.e. you may leave @@ -77,7 +77,7 @@ settings. In the same way you can apply this functionality for meshing Browser. From the \b Mesh menu select \b Compute or click "Compute" button of the toolbar. -\image html image28.gif +\image html image28.png
    "Compute" button
    The Mesh Computation information box appears. @@ -92,7 +92,14 @@ failure is provided. After you select the error, Show Subshape button allows visualizing the geometrical entity that causes it. -\image html failed_computation.png +\image html failed_computation.png "Example of the invalid input mesh" + +\Note Mesh Computation Information box does not appear if you set +"Mesh computation/Show a computation result notification" preference +to the "Never" value. This option gives the possibility to control mesh +computation reporting. There are the following possibilities: always +show information box, only if an error occurs or never. +By default, the information box is always shown after mesh computation operation. Publish Subshape button publishes the subshape, whose meshing failed, in GEOM component as a child of the mesh geometry, which diff --git a/doc/salome/gui/SMESH/input/constructing_submeshes.doc b/doc/salome/gui/SMESH/input/constructing_submeshes.doc index 74e01205e..a17569f7c 100644 --- a/doc/salome/gui/SMESH/input/constructing_submeshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_submeshes.doc @@ -31,11 +31,11 @@ at computation of this submesh

    • To construct a submesh: \par -From the \b Mesh menu select Local Hyp. or click "Create +From the \b Mesh menu select Create Submesh or click "Create Sum-mesh" button in the toolbar. \image html image33.gif -
    "Create Sum-mesh" button
    +
    "Create Submesh" button
    \par The following dialog box will appear: diff --git a/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc b/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc index 84974a21c..072a91f7a 100644 --- a/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc +++ b/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc @@ -12,7 +12,7 @@ for more information about quadratic meshes. Mesh item, or click "Convert to/from quadratic" button in the toolbar. -\image html image154.gif +\image html image154.png
    "Convert to/from quadratic" button
    The following dialog box will appear: diff --git a/doc/salome/gui/SMESH/input/creating_meshes.doc b/doc/salome/gui/SMESH/input/creating_meshes.doc deleted file mode 100644 index b8256ada9..000000000 --- a/doc/salome/gui/SMESH/input/creating_meshes.doc +++ /dev/null @@ -1,33 +0,0 @@ -/*! - -\page creating_meshes_page Creating meshes - - - -*/ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/cutting_quadrangles.doc b/doc/salome/gui/SMESH/input/cutting_quadrangles.doc index be6d0fdd8..cbc412855 100644 --- a/doc/salome/gui/SMESH/input/cutting_quadrangles.doc +++ b/doc/salome/gui/SMESH/input/cutting_quadrangles.doc @@ -12,7 +12,7 @@ corners.
  • In the \b Modification menu select the Cutting of quadrangles item or click "Cutting of quadrangles" button in the toolbar. -\image html image82.gif +\image html image82.png
    "Cutting of quadrangles" button
    The following dialog box will appear: @@ -53,9 +53,9 @@ list.
  • Click the \b Apply or Apply and Close button to confirm the operation.
    • -\image html image52.jpg +\image html image52.jpg "The chosen quadrangular element" -\image html image51.jpg +\image html image51.jpg "Two resulting triangular elements"
    See Also a sample TUI Script of a \ref tui_cutting_quadrangles "Cutting Quadrangles" operation. diff --git a/doc/salome/gui/SMESH/input/defining_algos.doc b/doc/salome/gui/SMESH/input/defining_algos.doc deleted file mode 100644 index 1ddac9f37..000000000 --- a/doc/salome/gui/SMESH/input/defining_algos.doc +++ /dev/null @@ -1,13 +0,0 @@ -/*! - -\page defining_algos_page Defining Algorithms - - - -*/ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/defining_hypo.doc b/doc/salome/gui/SMESH/input/defining_hypo.doc deleted file mode 100644 index fb4fa9728..000000000 --- a/doc/salome/gui/SMESH/input/defining_hypo.doc +++ /dev/null @@ -1,16 +0,0 @@ -/*! - -\page defining_hypo_page Defining hypotheses - - - -*/ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/diagonal_inversion_of_elements.doc b/doc/salome/gui/SMESH/input/diagonal_inversion_of_elements.doc index 998665996..8642ebfdb 100644 --- a/doc/salome/gui/SMESH/input/diagonal_inversion_of_elements.doc +++ b/doc/salome/gui/SMESH/input/diagonal_inversion_of_elements.doc @@ -10,7 +10,7 @@ formed by two neighboring triangles with one common edge.
  • From the \b Modification menu choose the Diagonal inversion item or click "Diagonal Inversion" button in the toolbar. -\image html image70.gif +\image html image70.png
    "Diagonal Inversion" button
    The following dialog box shall appear: @@ -23,9 +23,9 @@ this edge in the 3D viewer.
  • Click the \b Apply or Apply and Close button.
    • -\image html image38.jpg +\image html image38.jpg "The selected edge" -\image html image36.jpg +\image html image36.jpg "The inverted edge"
    See Also a sample TUI Script of a \ref tui_diagonal_inversion "Diagonal Inversion of Elements" operation. diff --git a/doc/salome/gui/SMESH/input/display_mode.doc b/doc/salome/gui/SMESH/input/display_mode.doc index 7ba8e54bf..6817d29f9 100644 --- a/doc/salome/gui/SMESH/input/display_mode.doc +++ b/doc/salome/gui/SMESH/input/display_mode.doc @@ -17,6 +17,6 @@ and selecting Display Mode, you can display your mesh as: \b Shading and \b Wireframe modes can combine with \b Shrink, however \b Nodes can't. -\image html image55.gif +\image html image55.gif Shrink */ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/editing_meshes.doc b/doc/salome/gui/SMESH/input/editing_meshes.doc index b36f7849f..62685e557 100644 --- a/doc/salome/gui/SMESH/input/editing_meshes.doc +++ b/doc/salome/gui/SMESH/input/editing_meshes.doc @@ -13,17 +13,15 @@ Creation. You can also change values for the current hypothesis by clicking the "Edit Hypothesis" button. -\image html image122.gif +\image html image122.png
    "Edit Hypothesis" button
    -See how a mesh constructed on one and the same geometrical object +See how the mesh constructed on a geometrical object changes if we apply different algorithms to it. -\image html edit_mesh1.png +\image html edit_mesh1.png "Example of a mesh with Max. Element area 2D hypothesis roughly corresponding to 1D hypotheses on edges" -\image html edit_mesh_remove_hyp.png - -\image html edit_mesh_change_value_hyp.png +\image html edit_mesh_change_value_hyp.png "And now the Max Element area is greatly reduced"
    See Also a sample TUI Script of an \ref tui_editing_mesh "Edit Mesh" operation. diff --git a/doc/salome/gui/SMESH/input/extrusion.doc b/doc/salome/gui/SMESH/input/extrusion.doc index 674a9d9b4..8151f8f36 100644 --- a/doc/salome/gui/SMESH/input/extrusion.doc +++ b/doc/salome/gui/SMESH/input/extrusion.doc @@ -13,7 +13,7 @@ and Hexahedron solids respectively.
  • From the \b Modification menu choose the \b Extrusion item or click "Extrusion" button in the toolbar. -\image html image91.gif +\image html image91.png
    "Extrusion" button
    The following dialog box will appear: @@ -39,9 +39,9 @@ elements of the source mesh to the newly created one.
  • Click the \b Apply or \b OK button.
    • -\image html image77.jpg +\image html image77.jpg "The mesh with an edge selected for extrusion" -\image html image76.jpg +\image html image76.jpg "The mesh with extruded edge"
    See Also a sample TUI Script of an \ref tui_extrusion "Extrusion" operation. diff --git a/doc/salome/gui/SMESH/input/extrusion_along_path.doc b/doc/salome/gui/SMESH/input/extrusion_along_path.doc index f11746aa0..80f86730e 100644 --- a/doc/salome/gui/SMESH/input/extrusion_along_path.doc +++ b/doc/salome/gui/SMESH/input/extrusion_along_path.doc @@ -85,7 +85,7 @@ mesh.
  • From the \b Modification menu choose the Extrusion along a path item or click "Extrusion along a path" button in the toolbar. -\image html image101.gif +\image html image101.png
    "Extrusion along a path" button
    The following dialog box will appear: @@ -129,10 +129,10 @@ mesh in a helical fashion. You can set the values of angles at the right, add them to the list of angles at the left by pressing the "Add" button and remove them from the list by pressing the "Remove" button. -\image html image105.gif +\image html add.png
    "Add" button
    -\image html image106.gif +\image html remove.png
    "Remove" button
    Linear variation of the angles option allows defining the angle of gradual rotation for the whole path. diff --git a/doc/salome/gui/SMESH/input/grouping_elements.doc b/doc/salome/gui/SMESH/input/grouping_elements.doc index a9a636793..56fe14c0d 100644 --- a/doc/salome/gui/SMESH/input/grouping_elements.doc +++ b/doc/salome/gui/SMESH/input/grouping_elements.doc @@ -2,13 +2,30 @@ \page grouping_elements_page Grouping elements +In Mesh module it is possible to \subpage creating_groups_page "create groups of mesh elements": +nodes, edges, faces or volumes:
      -
    • \subpage creating_groups_page
      • -
    • \subpage editing_groups_page
      • -
    • \subpage using_operations_on_groups_page
      • -
    • \subpage constructing_groups_of_specific_elements_page
      • -
    • \subpage deleting_groups_page
      • -
    • \subpage selection_filter_library_page
      • +
    • by selecting the elements of the specified kind by their IDs or +directly on the presentation in the VTK viewer - Standalone group tab of Create group +dialog.
      • +
    • by creating a group of elements of the selected type from all +such elements of the chosen geometrical object - Group on +geometry tab of Create group dialog.
      • +
    • by creating several groups of elements (nodes, +edges, faces and volumes) from the chosen submesh - using Mesh -> Construct +Group Menu item. In this case groups of elements are created automatically.
    +The created groups can be later: + +
      +
    • \subpage editing_groups_page "Edited"
      • +
    • \subpage using_operations_on_groups_page "Subjected to Boolean operations", or
      • +
    • \subpage deleting_groups_page "Deleted"
      • +
    + +An important tool, providing filters for creation of \b Standalone +groups is \subpage selection_filter_library_page
    • . + + */ diff --git a/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc b/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc index e016ffff1..dbf96ab89 100644 --- a/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc +++ b/doc/salome/gui/SMESH/input/importing_exporting_meshes.doc @@ -3,7 +3,9 @@ \page importing_exporting_meshes_page Importing and exporting meshes \n In MESH there is a functionality allowing importation/exportation -of meshes from \b MED, \b UNV (I-DEAS 10), \b DAT (Nastran) and STL format files. +of meshes from \b MED, \b UNV (I-DEAS 10), \b DAT (Nastran) and STL +format files. + To import a mesh: @@ -12,7 +14,8 @@ of meshes from \b MED, \b UNV (I-DEAS 10), \b DAT (Nastran) and STL format files select the corresponding format (MED, UNV and DAT) of the file containing your mesh.
  • In the standard Search File dialog box find the file for -importation.
    • +importation. It is possible to select multiple files to be imported all at once. +
  • Click the \b OK button.
    • diff --git a/doc/salome/gui/SMESH/input/index.doc b/doc/salome/gui/SMESH/input/index.doc index 4f772a285..7e40add11 100644 --- a/doc/salome/gui/SMESH/input/index.doc +++ b/doc/salome/gui/SMESH/input/index.doc @@ -1,116 +1,26 @@ /*! -\mainpage SMESH Module Reference Documentation +\mainpage Introduction to MESH - +\image html sewing.png "Sewing button" + To sew elements of different meshes:
    1. From the \b Modification menu choose the \b Transformation item @@ -63,7 +65,7 @@ enough to merge, if difference of their parameters is less than one fifth of minimum length of adjacent face edges on the borders.
    -\image html image22.jpg +\image html image22.jpg "Sewing free borders" See Also a sample TUI Script of a \ref tui_sew_free_borders "Sew Free Borders" operation. @@ -90,7 +92,7 @@ second border. the first border and two points on the second one. User can select these nodes in 3D viewer or define node by its id. -\image html image22.jpg +\image html image23.jpg "Sewing conform free borders" See Also a sample TUI Script of a \ref tui_sew_conform_free_borders "Sew Conform Free Borders" @@ -120,7 +122,7 @@ border and two points on the side. User can select these nodes in 3D viewer or define node by its id. -\image html image30.jpg +\image html image30.jpg "Sewing border to side" See Also a sample TUI Script of a \ref tui_sew_meshes_border_to_side "Sew Border to Side" operation. @@ -145,9 +147,9 @@ belong to one element and must be located on an element set boundary. Sewing algorithm finds and merges the corresponding nodes starting from the specified ones. -\image html image31.jpg +\image html image31.jpg "Step-by-step sewing process" -\image html image32.jpg +\image html image32.jpg "The result of side elements sewing" For sewing side elements you should define elements for sewing and two nodes for merging on the each side. User can select these elements and diff --git a/doc/salome/gui/SMESH/input/skew.doc b/doc/salome/gui/SMESH/input/skew.doc index 582ada3a1..5235b4ddd 100644 --- a/doc/salome/gui/SMESH/input/skew.doc +++ b/doc/salome/gui/SMESH/input/skew.doc @@ -16,7 +16,7 @@ criterion can be applied to elements composed of 4 and 3 nodes
  • Choose Controls > Skew or click "Skew" button of the toolbar. -\image html image40.gif +\image html image40.png
    "Skew" button
    Your mesh will be displayed in the viewer with its elements colored diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc index 222d80ae3..17255212c 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -1,6 +1,6 @@ /*! -\page smeshpy_interface_page Python interface smesh.py +\page smeshpy_interface_page Python interface \n Python package smesh defines several classes, destined for easy and clear mesh creation and edition. @@ -38,6 +38,92 @@ clear mesh creation and edition. \n others are based on commercial meshers: - GHS3D(3D), BLSURF(2D). -\n To add hypotheses, use the interfaces, provided by the assigned algorithms. +\n To add hypotheses, use the interfaces, provided by the assigned +algorithms. + +\n Below you can see an example of usage of the package smesh for 3d mesh generation. + +

    Example of 3d mesh generation with NETGEN:

    + +\n from geompy import * +\n import smesh + +# Geometry +\n # an assembly of a box, a cylinder and a truncated cone meshed with tetrahedral. + +# Define values +\n name = "ex21_lamp" +\n cote = 60 +\n section = 20 +\n size = 200 +\n radius_1 = 80 +\n radius_2 = 40 +\n height = 100 + +# Build a box +\n box = MakeBox(-cote, -cote, -cote, +cote, +cote, +cote) + +# Build a cylinder +\n pt1 = MakeVertex(0, 0, cote/3) +\n di1 = MakeVectorDXDYDZ(0, 0, 1) +\n cyl = MakeCylinder(pt1, di1, section, size) + +# Build a truncated cone +\n pt2 = MakeVertex(0, 0, size) +\n cone = MakeCone(pt2, di1, radius_1, radius_2, height) + +# Fuse +\n box_cyl = MakeFuse(box, cyl) +\n piece = MakeFuse(box_cyl, cone) + +# Add in study +\n addToStudy(piece, name) + +# Create a group of faces +\n group = CreateGroup(piece, ShapeType["FACE"]) +\n group_name = name + "_grp" +\n addToStudy(group, group_name) +\n group.SetName(group_name) + +# Add faces in the group +\n faces = SubShapeAllIDs(piece, ShapeType["FACE"]) +\n UnionIDs(group, faces) + +# Create a mesh + +# Define a mesh on a geometry +\n tetra = smesh.Mesh(piece, name) + +# Define 1D hypothesis +\n algo1d = tetra.Segment() +\n algo1d.LocalLength(10) + +# Define 2D hypothesis +\n algo2d = tetra.Triangle() +\n algo2d.LengthFromEdges() + +# Define 3D hypothesis +\n algo3d = tetra.Tetrahedron(smesh.NETGEN) +\n algo3d.MaxElementVolume(100) + +# Compute the mesh +\n tetra.Compute() + +# Create a groupe of faces +\n tetra.Group(group) + +\n Examples of Python scripts for all Mesh operations are available by +the following links: + +
      +
    • \subpage tui_creating_meshes_page
      • +
    • \subpage tui_viewing_meshes_page
      • +
    • \subpage tui_defining_hypotheses_page
      • +
    • \subpage tui_quality_controls_page
      • +
    • \subpage tui_grouping_elements_page
      • +
    • \subpage tui_modifying_meshes_page
      • +
    • \subpage tui_transforming_meshes_page
      • +
    + */ diff --git a/doc/salome/gui/SMESH/input/smoothing.doc b/doc/salome/gui/SMESH/input/smoothing.doc index f1991d62b..fe9770340 100644 --- a/doc/salome/gui/SMESH/input/smoothing.doc +++ b/doc/salome/gui/SMESH/input/smoothing.doc @@ -11,7 +11,7 @@
  • In the \b Modification menu select the \b Smoothing item or click "Smoothing" button in the toolbar. -\image html image84.gif +\image html image84.png
    "Smoothing" button
    The dialog box contains the following fields which should be @@ -67,9 +67,9 @@ faces in the 3D space is improved.
  • Click the \b Apply or \b OK button to confirm the operation.
    • -\image html smoothing1.png +\image html smoothing1.png "The initial mesh" -\image html smoothing2.png +\image html smoothing2.png "The smoothed mesh"
    See Also a sample TUI Script of a \ref tui_smoothing "Smoothing" operation. diff --git a/doc/salome/gui/SMESH/input/symmetry.doc b/doc/salome/gui/SMESH/input/symmetry.doc index c18089e63..6bbe66873 100644 --- a/doc/salome/gui/SMESH/input/symmetry.doc +++ b/doc/salome/gui/SMESH/input/symmetry.doc @@ -5,6 +5,8 @@ \n This geometrical operation allows to perform a symmetrical copy of your mesh or some of its elements. +\image html symmetry.png "Symmetry button" + To apply symmetry to your mesh: \par From the \b Modification choose \b Transformation and from its diff --git a/doc/salome/gui/SMESH/input/taper.doc b/doc/salome/gui/SMESH/input/taper.doc index a207990b7..d2c4dd2b4 100644 --- a/doc/salome/gui/SMESH/input/taper.doc +++ b/doc/salome/gui/SMESH/input/taper.doc @@ -6,7 +6,7 @@ of two triangles separated by a diagonal. So it can be calculated only for elements consisting of 4 nodes. -\image html image25.gif +\image html image25.png
    To apply the Taper quality criterion to your mesh: @@ -16,7 +16,7 @@ for elements consisting of 4 nodes.
  • Choose Controls > Taper or click "Taper" button in the toolbar. -\image html image36.gif +\image html image36.png
    "Taper" button
    Your mesh will be displayed in the viewer with its elements colored diff --git a/doc/salome/gui/SMESH/input/transforming_meshes.doc b/doc/salome/gui/SMESH/input/transforming_meshes.doc deleted file mode 100644 index 206c6401c..000000000 --- a/doc/salome/gui/SMESH/input/transforming_meshes.doc +++ /dev/null @@ -1,14 +0,0 @@ -/*! - -\page transforming_meshes_page Transforming meshes - -
      -
    • \subpage translation_page
      • -
    • \subpage rotation_page
      • -
    • \subpage symmetry_page
      • -
    • \subpage sewing_meshes_page
      • -
    • \subpage merging_nodes_page
      • -
    • \subpage merging_elements_page
      • -
    - -*/ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/translation.doc b/doc/salome/gui/SMESH/input/translation.doc index 1f48901d5..390feb7fc 100644 --- a/doc/salome/gui/SMESH/input/translation.doc +++ b/doc/salome/gui/SMESH/input/translation.doc @@ -5,6 +5,8 @@ \n This geometrical operation allows to translate in space your mesh or some of its elements. +\image html translation.png "Translation button" + To translate your mesh: \par From the \b Modification choose \b Transformation and from its diff --git a/doc/salome/gui/SMESH/input/tui_scripts.doc b/doc/salome/gui/SMESH/input/tui_scripts.doc deleted file mode 100644 index 4c19b9d7b..000000000 --- a/doc/salome/gui/SMESH/input/tui_scripts.doc +++ /dev/null @@ -1,15 +0,0 @@ -/*! - -\page tui_scripts_page TUI Scripts - -
      -
    • \subpage tui_creating_meshes_page
      • -
    • \subpage tui_viewing_meshes_page
      • -
    • \subpage tui_defining_hypotheses_page
      • -
    • \subpage tui_quality_controls_page
      • -
    • \subpage tui_grouping_elements_page
      • -
    • \subpage tui_modifying_meshes_page
      • -
    • \subpage tui_transforming_meshes_page
      • -
    - -*/ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/uniting_set_of_triangles.doc b/doc/salome/gui/SMESH/input/uniting_set_of_triangles.doc index 9c1413523..bcf153119 100644 --- a/doc/salome/gui/SMESH/input/uniting_set_of_triangles.doc +++ b/doc/salome/gui/SMESH/input/uniting_set_of_triangles.doc @@ -11,7 +11,7 @@ once many triangles if they have adjacent edges.
  • In the \b Modification menu select the Union of triangles item or click "Union of triangles" button in the toolbar. -\image html image80.gif +\image html image80.png
    "Union of triangles" button
    The following dialog box will appear: @@ -43,9 +43,9 @@ the list.
    • If some selected triangle elements have no adjacent edges with one of the others, the operation on these elements shall take no effect. -\image html uniting_a_set_of_triangles1.png +\image html uniting_a_set_of_triangles1.png "The chosen triangles" -\image html uniting_a_set_of_triangles2.png +\image html uniting_a_set_of_triangles2.png "The union of several triangles - several quadrangular cells are created"
    See Also a sample TUI Script of a \ref tui_uniting_set_of_triangles "Uniting a Set of Triangles" operation. diff --git a/doc/salome/gui/SMESH/input/uniting_two_triangles.doc b/doc/salome/gui/SMESH/input/uniting_two_triangles.doc index ef883522e..95b9fced6 100644 --- a/doc/salome/gui/SMESH/input/uniting_two_triangles.doc +++ b/doc/salome/gui/SMESH/input/uniting_two_triangles.doc @@ -11,7 +11,7 @@ of the common edge. triangles item or click "Union of two triangles" button in the toolbar. -\image html image71.gif +\image html image71.png
    "Union of two triangles" button
    The following dialog box shall appear: @@ -24,9 +24,9 @@ this edge in the 3D viewer.
  • Click the \b Apply or Apply and Close button.
    • -\image html uniting_two_triangles1.png +\image html uniting_two_triangles1.png "The selected triangles" -\image html uniting_two_triangles2.png +\image html uniting_two_triangles2.png "The union of two triangles"
    See Also a sample TUI Script of a \ref tui_uniting_two_triangles "Uniting Two Triangles" operation. diff --git a/doc/salome/gui/SMESH/input/viewing_meshes.doc b/doc/salome/gui/SMESH/input/viewing_meshes.doc deleted file mode 100644 index aac10da54..000000000 --- a/doc/salome/gui/SMESH/input/viewing_meshes.doc +++ /dev/null @@ -1,15 +0,0 @@ -/*! - -\page viewing_meshes_page Viewing meshes - - - -*/ \ No newline at end of file diff --git a/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc b/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc index 5cddd5db3..7f9ae7fae 100644 --- a/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc +++ b/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc @@ -1,6 +1,6 @@ /*! -\page viewing_meshes_overview_page Overview +\page viewing_meshes_overview_page Viewing meshes \n After definition of algorithms and hypotheses a new mesh is listed in the Object Browser. Right-click on it and select \b Compute - the @@ -20,24 +20,24 @@ right-clicking on the selected mesh.
  • Hide all - allows to hide all objects in the viewer.
  • Update - refreshes the presentation of your mesh in the Object Browser, applying all recent changes.
    • -
  • \ref advanced_mesh_infos_anchor "Advanced Mesh Infos" - provides -more detailed information about the mesh.
    • -
  • \ref standard_mesh_infos_anchor "Standard Mesh Infos" - provides -basic information about the mesh.
    • +
  • \subpage mesh_infos_page "Mesh Infos" - provides +information about the mesh.
  • \ref mesh_element_info_anchor "Mesh Element Info" - provides basic information about the selected element of the mesh.
    • -
  • \ref numbering_page "Numbering" - allows to display the ID +
  • \subpage numbering_page "Numbering" - allows to display the ID numbers of all meshing elements or nodes composing your mesh in the viewer.
    • -
  • \ref display_mode_page "Display Mode" - allows to select between +
  • \subpage display_mode_page "Display Mode" - allows to select between Wireframe, Shading and Nodes presentation.
    • -
  • \ref display_entity_page "Display Entity" - allows to display +
  • \subpage display_entity_page "Display Entity" - allows to display Faces, Edges or both.
    • +
  • Orientation of faces - shows vectors of orientation of +faces of the selected mesh
  • Colors / Size - allows to select color and size of meshes.
    • -
  • \ref transparency_page "Transparency" - allows to change the +
  • \subpage transparency_page "Transparency" - allows to change the transparency of mesh elements.
    • -
  • \ref clipping_page "Clipping" - allows to create cross-sections of the selected objects.
    • +
  • \subpage clipping_page "Clipping" - allows to create cross-sections of the selected objects.
  • \ref about_quality_controls_page "Controls" - graphically presents various information about meshes.
  • Hide - allows to hide the selected mesh from the viewer.
    • diff --git a/doc/salome/gui/SMESH/input/volume.doc b/doc/salome/gui/SMESH/input/volume.doc index 391b09023..ba99c193e 100644 --- a/doc/salome/gui/SMESH/input/volume.doc +++ b/doc/salome/gui/SMESH/input/volume.doc @@ -12,7 +12,7 @@
  • Choose Controls > Volume or click "Volume" button in the toolbar. -\image html image145.gif +\image html image145.png
    "Volume" button
    Your mesh will be displayed in the viewer with its elements colored diff --git a/doc/salome/gui/SMESH/input/warping.doc b/doc/salome/gui/SMESH/input/warping.doc index 9b97aa6a2..83bfaa3ac 100644 --- a/doc/salome/gui/SMESH/input/warping.doc +++ b/doc/salome/gui/SMESH/input/warping.doc @@ -27,7 +27,7 @@ projection height ?h? to the half edge length ?l?.
  • Choose Controls > Warping Angle or click "Warping angle" button of the toolbar. -\image html image39.gif +\image html image39.png
    "Warping angle" button
    Your mesh will be displayed in the viewer with its elements colored