From: vsr Date: Wed, 11 Nov 2009 15:09:39 +0000 (+0000) Subject: Fix documentation problems (reported as doxygen warnings) X-Git-Tag: V5_1_3rc3~10 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=b363a7ea2b631dd89e0926514ee0a67439db6e64;p=modules%2Fsmesh.git Fix documentation problems (reported as doxygen warnings) --- diff --git a/doc/salome/gui/SMESH/input/basic_meshing_algos.doc b/doc/salome/gui/SMESH/input/basic_meshing_algos.doc index 9a0fd91f5..a83a64f9f 100644 --- a/doc/salome/gui/SMESH/input/basic_meshing_algos.doc +++ b/doc/salome/gui/SMESH/input/basic_meshing_algos.doc @@ -47,7 +47,7 @@ tetrahedral (pyramidal) elements. \image html image126.gif "Example of a hexahedral 3D mesh" -\Note that BLSURF and GHS3D are commercial meshers and require a +\note BLSURF and GHS3D are commercial meshers and require a license to be used within the Mesh module. There is also a number of more specific algorithms: diff --git a/doc/salome/gui/SMESH/input/constructing_meshes.doc b/doc/salome/gui/SMESH/input/constructing_meshes.doc index be7def6a8..625cff3bd 100644 --- a/doc/salome/gui/SMESH/input/constructing_meshes.doc +++ b/doc/salome/gui/SMESH/input/constructing_meshes.doc @@ -126,7 +126,7 @@ visualizing the geometrical entity that causes it. \image html failed_computation.png "Example of the invalid input mesh" -\Note Mesh Computation Information box does not appear if you set +\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 diff --git a/doc/salome/gui/SMESH/input/editing_groups.doc b/doc/salome/gui/SMESH/input/editing_groups.doc index b5031468a..6cbe5ceb4 100644 --- a/doc/salome/gui/SMESH/input/editing_groups.doc +++ b/doc/salome/gui/SMESH/input/editing_groups.doc @@ -2,7 +2,7 @@ \page editing_groups_page Editing groups -\n To edit an existing group of elements: +To edit an existing group of elements:
  1. Select your group in the Object Browser and in the \b Mesh menu click the Edit Group item or "Edit Group" button in the toolbar.
  2. @@ -17,11 +17,12 @@ The following dialog box will appear: In this dialog box you can modify the name of your group and add or remove the elements forming it. For more information see \ref creating_groups_page "Creating Groups" page. +
  3. Click the \b Apply or Apply and Close button to confirm modification of the group.
-\n To convert an existing group on geometry into standalone group +To convert an existing group on geometry into standalone group of elements and modify:
  1. Select your group on geometry in the Object Browser and in the \b Mesh menu click @@ -31,11 +32,12 @@ the Edit Group as Standalone item.
  2. "Edit Group as Standalone" button
    The group on geometry will be converted into standalone group and can -be modified as group of elements +be modified as group of elements. +
  3. Click the \b Apply or Apply and Close button to confirm modification of the group.
  4. +
-
See Also a sample TUI Script of an -\ref tui_edit_group "Edit Group" operation. +\sa A sample TUI Script of an \ref tui_edit_group "Edit Group" operation. */ diff --git a/doc/salome/gui/SMESH/input/free_faces.doc b/doc/salome/gui/SMESH/input/free_faces.doc index 0c852f32c..d35caa9ac 100644 --- a/doc/salome/gui/SMESH/input/free_faces.doc +++ b/doc/salome/gui/SMESH/input/free_faces.doc @@ -2,16 +2,17 @@ \page free_faces_page Free faces -\n This mesh quality control highlights the faces connected to +This mesh quality control highlights the faces connected to less than two mesh volume elements. The free faces are shown with a color different from the color of shared faces. \image html free_faces.png -
In this picture some volume mesh elements have been removed, as + +In this picture some volume mesh elements have been removed, as a result some faces became connected only to one volume. i.e. became free. -
See Also a sample TUI Script of a -\ref tui_free_faces "Free Faces quality control" operation. +\sa A sample TUI Script of a \ref tui_free_faces "Free Faces quality control" +operation. */ diff --git a/doc/salome/gui/SMESH/input/free_nodes.doc b/doc/salome/gui/SMESH/input/free_nodes.doc index 1caaf9e4b..8a06fe3de 100644 --- a/doc/salome/gui/SMESH/input/free_nodes.doc +++ b/doc/salome/gui/SMESH/input/free_nodes.doc @@ -2,14 +2,15 @@ \page free_nodes_page Free nodes -\n This mesh quality control highlights the nodes which are not connected +This mesh quality control highlights the nodes which are not connected to any mesh element. \image html free_nodes.png -
In this picture some nodes are not connected to any mesh + +In this picture some nodes are not connected to any mesh element after deleting some elements and adding several isolated nodes. -
See Also a sample TUI Script of a -\ref tui_free_nodes "Free Nodes quality control" operation. +\sa A sample TUI Script of a \ref tui_free_nodes "Free Nodes quality control" +operation. */ diff --git a/doc/salome/gui/SMESH/input/grouping_elements.doc b/doc/salome/gui/SMESH/input/grouping_elements.doc index f5c7fed67..638d70112 100644 --- a/doc/salome/gui/SMESH/input/grouping_elements.doc +++ b/doc/salome/gui/SMESH/input/grouping_elements.doc @@ -12,19 +12,15 @@ 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 \ref creating_groups_page "Create group" dialog.
  • -
  • by creating a group including all types of elements from an existing geometrical object - using \subpage create_groups_from_geometry_page "Create Groups from Geometry" 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.
  • -
  • by creating groups of entities from existing groups of superior dimensions - using \subpage group_of_underlying_elements_page "Create Group of Underlying Elements" dialog.
  • - @@ -32,12 +28,12 @@ The created groups can be later:
    • \subpage editing_groups_page "Edited"
    • -
    • \subpage using_operations_on_groups_page "Subjected to Boolean operations", or
    • +
    • \subpage using_operations_on_groups_page "Subjected to Boolean operations"
    • \subpage deleting_groups_page "Deleted"
    An important tool, providing filters for creation of \b Standalone -groups is \subpage selection_filter_library_page. +groups is \subpage selection_filter_library_page. */ diff --git a/doc/salome/gui/SMESH/input/netgen_2d_3d_hypo.doc b/doc/salome/gui/SMESH/input/netgen_2d_3d_hypo.doc index 0c872d32b..bbb7c59ff 100644 --- a/doc/salome/gui/SMESH/input/netgen_2d_3d_hypo.doc +++ b/doc/salome/gui/SMESH/input/netgen_2d_3d_hypo.doc @@ -2,7 +2,7 @@ \page netgen_2d_3d_hypo_page Netgen 2D and 3D hypotheses -\n Netgen 2D and Netgen 3D hypotheses work only with Netgen 1D-2D and +Netgen 2D and Netgen 3D hypotheses work only with Netgen 1D-2D and Netgen 1D-2D-3D algorithms. These algorithms do not require definition of lower-level hypotheses and algorithms (2D and 1D for meshing 3D objects and 1D for meshing 2D objects). They prove to be @@ -11,68 +11,64 @@ of the meshed object. \image html netgen2d.png -
      -
    • Name - allows to define the name for the algorithm (Netgen -2D (or 3D) Parameters by default).
    • -
    • Max Size - maximum linear dimensions for mesh cells.
    • -
    • Second Order - if this box is checked in, the algorithm will +- Name - allows to define the name for the algorithm (Netgen +2D (or 3D) Parameters by default). +- Max Size - maximum linear dimensions for mesh cells. +- Second Order - if this box is checked in, the algorithm will create second order nodes on the mesh, which actually will become -\ref adding_quadratic_elements_page "Quadratic".
    • -
    • Fineness - ranging from Very Coarse to Very Fine allows to set the +\ref adding_quadratic_elements_page "Quadratic". +- Fineness - ranging from Very Coarse to Very Fine allows to set the level of meshing detalization using the three parameters below. You -can select Custom to define them manually.
    • -
    • Growth rate - allows to define how much the linear dimensions of -two adjacent cells can differ (i.e. 0.3 means 30%).
    • -
    • Nb. Segs per Edge and Nb Segs per Radius - allows to define the +can select Custom to define them manually. +- Growth rate - allows to define how much the linear dimensions of +two adjacent cells can differ (i.e. 0.3 means 30%). +- Nb. Segs per Edge and Nb Segs per Radius - allows to define the minimum number of mesh segments in which edges and radiuses will be -split.
    • -
    • Allow Quadrangles - allows to use quadrangle elements in a +split. +- Allow Quadrangles - allows to use quadrangle elements in a triangle 2D mesh. This checkbox is not present in Netgen 3D parameters because currently building a tetrahedral mesh with quadrangle faces is -not possible.
    • -
    • Optimize - if this box is checked in, the algorithm will try to -create regular (possessing even sides) elements.
    • -
    +not possible. +- Optimize - if this box is checked in, the algorithm will try to +create regular (possessing even sides) elements. \image html netgen3d_simple.png -Netgen 2D simple parameters and Netgen 3D simple parameters allow defining the size of elements for each dimension.
    +Netgen 2D simple parameters and Netgen 3D simple +parameters allow defining the size of elements for each +dimension. \b 1D group allows defining the size of 1D elements in either of two ways: -
      -
    • Number of Segments has the same sense as \ref +- Number of Segments has the same sense as \ref number_of_segments_anchor "Number of segments" hypothesis with -equidistant distribution.
    • -
    • Average Length has the same sense as \ref -average_length_anchor "Average Length" hypothesis.
    • -
    +equidistant distribution. +- Average Length has the same sense as \ref +average_length_anchor "Average Length" hypothesis. \b 2D group allows defining the size of 2D elements -
      -
    • Length from edges if checked in, acts like \ref -length_from_edges_anchor "Length from Edges" hypothesis, else
    • -
    • Max. Element Area defines the maximum element area like \ref -max_element_area_anchor "Max Element Area" hypothesis.
    • -
    +- Length from edges if checked in, acts like \ref +length_from_edges_anchor "Length from Edges" hypothesis, else +- Max. Element Area defines the maximum element area like \ref +max_element_area_anchor "Max Element Area" hypothesis. \b 3D groups allows defining the size of 3D elements. -
      -
    • Length from faces if checked in, the area of sides of -volumic elements will be equal to an average area of 2D elements, else
    • -
    • Max. Element Volume defines the maximum element volume like +- Length from faces if checked in, the area of sides of +volumic elements will be equal to an average area of 2D elements, else +- Max. Element Volume defines the maximum element volume like \ref max_element_volume_hypo_page "Max Element Volume" -hypothesis.
    • -
        +hypothesis. -\n Note that Netgen algorithm does not strictly follow the input -parameters. The actual mesh can be more or less dense than required. There are several factors in it: -
          -
        1. NETGEN does not actually use "NbOfSegments" parameter for discretization of -edge. This parameter is used only to define the local element size (size at the given point), so local sizes of adjacent edges influence each other.
        2. -
        3. NETGEN additionally restricts the element size according to edge curvature.
        4. -
        5. The local size of edges influences the size of close triangles.
        6. -
        7. The order of elements and their size in the 1D mesh generated by +\note Netgen algorithm does not strictly follow the input +parameters. The actual mesh can be more or less dense than +required. There are several factors in it: +- NETGEN does not actually use "NbOfSegments" parameter for discretization of +edge. This parameter is used only to define the local element size +(size at the given point), so local sizes of adjacent edges influence +each other. +- NETGEN additionally restricts the element size according to edge curvature. +- The local size of edges influences the size of close triangles. +- The order of elements and their size in the 1D mesh generated by NETGEN differ from those in the 1D mesh generated by Regular_1D -algorithm, resulting in different 2D and 3D meshes.
        8. -
        -*/ \ No newline at end of file +algorithm, resulting in different 2D and 3D meshes. + +*/ diff --git a/doc/salome/gui/SMESH/input/radial_quadrangle_1D2D_algo.doc b/doc/salome/gui/SMESH/input/radial_quadrangle_1D2D_algo.doc index 24bd883a9..9f54f3eef 100644 --- a/doc/salome/gui/SMESH/input/radial_quadrangle_1D2D_algo.doc +++ b/doc/salome/gui/SMESH/input/radial_quadrangle_1D2D_algo.doc @@ -17,4 +17,6 @@ of mesh layers along the radius. The distribution of layers can be set with any \image html mesh_radquad_02.png "Radial Quadrangle 2D mesh on a part of circle" +\sa A sample \ref tui_radial_quadrangle "TUI Script". + */ diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc index efbafc617..e0fe78ec9 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -2,129 +2,140 @@ \page smeshpy_interface_page Python interface -\n Python package smesh defines several classes, destined for easy and +Python package smesh defines several classes, destined for easy and clear mesh creation and edition. -\n Documentation for smesh package is available in two forms: - -\n The structured - documentation for smesh package, where all methods and - classes are grouped by their functionality, like it is done in the GUI documentation -\n and the \ref smeshDC "linear documentation for smesh package" - grouped only by classes, declared in the smesh.py file. - -\n The main page of the \ref smeshDC "linear documentation for smesh package" - contains a list of data structures and a list of - functions, provided by the package smesh.py. The first item in - the list of data structures (\ref smeshDC::smeshDC "class smesh") - also represents documentation for the methods of the package smesh.py itself. - -\n The package smesh.py provides an interface to create and handle - meshes. Use it to create an empty mesh or to import it from the data file. - -\n Once a mesh has been created, it is possible to manage it via its own - methods, described at \ref smeshDC::Mesh "class Mesh" documentation - (it is also accessible by the second item "class Mesh" in the list of data structures). - -\n Class Mesh allows assigning algorithms to a mesh. -\n Please note, that some algorithms, - included in the standard Salome installation are always available: - - REGULAR(1D), COMPOSITE(1D), MEFISTO(2D), Quadrangle(2D), Hexa(3D), etc. - -\n There are also some algorithms, which can be installed optionally, -\n some of them are based on open-source meshers: - - NETGEN(1D-2D,2D,1D-2D-3D,3D), - -\n others are based on commercial meshers: - - GHS3D(3D), BLSURF(2D). - -\n To add hypotheses, use the interfaces, provided by the assigned +Documentation for smesh package is available in two forms: + +The structured +documentation for smesh package, where all methods and +classes are grouped by their functionality, like it is done in the GUI documentation +and the \ref smeshDC "linear documentation for smesh package" +grouped only by classes, declared in the smesh.py file. + +The main page of the \ref smeshDC "linear documentation for smesh package" +contains a list of data structures and a list of +functions, provided by the package smesh.py. The first item in +the list of data structures (\ref smeshDC::smeshDC "class smesh") +also represents documentation for the methods of the package smesh.py itself. + +The package smesh.py provides an interface to create and handle +meshes. Use it to create an empty mesh or to import it from the data file. + +Once a mesh has been created, it is possible to manage it via its own +methods, described at \ref smeshDC::Mesh "class Mesh" documentation +(it is also accessible by the second item "class Mesh" in the list of data structures). + +Class \b Mesh allows assigning algorithms to a mesh. +Please note, that some algorithms, included in the standard SALOME +distribution are always available: +- REGULAR (1D) +- COMPOSITE (1D) +- MEFISTO (2D) +- Quadrangle (2D) +- Hexa(3D) +- etc... + +There are also some algorithms, which can be installed optionally, +some of them are based on open-source meshers: +- NETGEN (1D-2D, 2D, 1D-2D-3D, 3D) + +... and others are based on commercial meshers: +- GHS3D (3D) +- BLSURF (2D) + +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. +Below you can see an example of usage of the package smesh for 3d mesh generation. +\anchor example_3d_mesh

        Example of 3d mesh generation with NETGEN:

        -\n from geompy import * -\n import smesh +\code +from geompy import * +import smesh -# Geometry -\n # an assembly of a box, a cylinder and a truncated cone meshed with tetrahedral. +### +# Geometry: 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 +# Define values +name = "ex21_lamp" +cote = 60 +section = 20 +size = 200 +radius_1 = 80 +radius_2 = 40 +height = 100 -# Build a box -\n box = MakeBox(-cote, -cote, -cote, +cote, +cote, +cote) +# Build a box +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 cylinder +pt1 = MakeVertex(0, 0, cote/3) +di1 = MakeVectorDXDYDZ(0, 0, 1) +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) +# Build a truncated cone +pt2 = MakeVertex(0, 0, size) +cone = MakeCone(pt2, di1, radius_1, radius_2, height) -# Fuse -\n box_cyl = MakeFuse(box, cyl) -\n piece = MakeFuse(box_cyl, cone) +# Fuse +box_cyl = MakeFuse(box, cyl) +piece = MakeFuse(box_cyl, cone) -# Add in study -\n addToStudy(piece, name) +# Add to the study +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) +# Create a group of faces +group = CreateGroup(piece, ShapeType["FACE"]) +group_name = name + "_grp" +addToStudy(group, group_name) +group.SetName(group_name) -# Add faces in the group -\n faces = SubShapeAllIDs(piece, ShapeType["FACE"]) -\n UnionIDs(group, faces) +# Add faces to the group +faces = SubShapeAllIDs(piece, ShapeType["FACE"]) +UnionIDs(group, faces) -# Create a mesh +### +# Create a mesh +### -# Define a mesh on a geometry -\n tetra = smesh.Mesh(piece, name) +# Define a mesh on a geometry +tetra = smesh.Mesh(piece, name) -# Define 1D hypothesis -\n algo1d = tetra.Segment() -\n algo1d.LocalLength(10) +# Define 1D hypothesis +algo1d = tetra.Segment() +algo1d.LocalLength(10) -# Define 2D hypothesis -\n algo2d = tetra.Triangle() -\n algo2d.LengthFromEdges() +# Define 2D hypothesis +algo2d = tetra.Triangle() +algo2d.LengthFromEdges() -# Define 3D hypothesis -\n algo3d = tetra.Tetrahedron(smesh.NETGEN) -\n algo3d.MaxElementVolume(100) +# Define 3D hypothesis +algo3d = tetra.Tetrahedron(smesh.NETGEN) +algo3d.MaxElementVolume(100) -# Compute the mesh -\n tetra.Compute() +# Compute the mesh +tetra.Compute() -# Create a groupe of faces -\n tetra.Group(group) +# Create a groupe of faces +tetra.Group(group) -\n Examples of Python scripts for all Mesh operations are available by -the following links: +\endcode -
          -
        • \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
        • -
        • \subpage tui_notebook_smesh_page
        • -
        +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 +- \subpage tui_notebook_smesh_page */ diff --git a/doc/salome/gui/SMESH/input/translation.doc b/doc/salome/gui/SMESH/input/translation.doc index e4589b5a6..2f0f0743e 100644 --- a/doc/salome/gui/SMESH/input/translation.doc +++ b/doc/salome/gui/SMESH/input/translation.doc @@ -64,13 +64,9 @@ name in the adjacent box);
      -
    • Click \b Apply or Apply and Close button to confirm the -operation.
    • - +
    • Click \b Apply or Apply and Close button to confirm the operation.
    • - -
      See Also a sample TUI Script of a -\ref tui_translation "Translation" operation. +
      See Also a sample TUI Script of a \ref tui_translation "Translation" operation. */ diff --git a/doc/salome/gui/SMESH/input/tui_creating_meshes.doc b/doc/salome/gui/SMESH/input/tui_creating_meshes.doc index 9048afef1..87f740e98 100644 --- a/doc/salome/gui/SMESH/input/tui_creating_meshes.doc +++ b/doc/salome/gui/SMESH/input/tui_creating_meshes.doc @@ -2,7 +2,7 @@ \page tui_creating_meshes_page Creating Meshes -\n First of all see \ref introduction_to_mesh_python_page "Example of 3d mesh generation", +\n First of all see \ref example_3d_mesh "Example of 3d mesh generation", which is an example of good python script style for Mesh module.
      diff --git a/doc/salome/gui/SMESH/input/tui_grouping_elements.doc b/doc/salome/gui/SMESH/input/tui_grouping_elements.doc index e03433f1c..b77edd21e 100644 --- a/doc/salome/gui/SMESH/input/tui_grouping_elements.doc +++ b/doc/salome/gui/SMESH/input/tui_grouping_elements.doc @@ -1,4 +1,4 @@ -/*! + /*! \page tui_grouping_elements_page Grouping Elements @@ -318,13 +318,13 @@ salome.sg.updateObjBrowser(1) \endcode \image html dimgroup_tui1.png -
      Source groups of faces<\center> +
      Source groups of faces
      \image html dimgroup_tui2.png -
      Result groups of edges and nodes<\center> +
      Result groups of edges and nodes
      -*/ \ 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 01a272de2..ee4c6dd4a 100644 --- a/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc +++ b/doc/salome/gui/SMESH/input/viewing_meshes_overview.doc @@ -38,7 +38,7 @@ meshes.
    • \subpage transparency_page "Transparency" - allows to change the transparency of mesh elements.
    • \subpage clipping_page "Clipping" - allows to create cross-sections of the selected objects.
    • -
    • \ref about_quality_controls_page "Controls" - graphically +
    • \ref quality_page "Controls" - graphically presents various information about meshes.
    • Hide - allows to hide the selected mesh from the viewer.
    • Show Only -allows to display only the selected mesh, hiding all other from the viewer.
    • diff --git a/src/SMESH_SWIG/smeshDC.py b/src/SMESH_SWIG/smeshDC.py index a9babb02f..a2b797088 100644 --- a/src/SMESH_SWIG/smeshDC.py +++ b/src/SMESH_SWIG/smeshDC.py @@ -810,8 +810,8 @@ class smeshDC(SMESH._objref_SMESH_Gen): print "Error: given parameter is not numerucal functor type." ## Creates hypothesis - # @param - # @param + # @param theHType mesh hypothesis type (string) + # @param theLibName mesh plug-in library name # @return created hypothesis instance def CreateHypothesis(self, theHType, theLibName="libStdMeshersEngine.so"): return SMESH._objref_SMESH_Gen.CreateHypothesis(self, theHType, theLibName ) @@ -1320,6 +1320,8 @@ class Mesh: # Exports the mesh in a file in MED format and chooses the \a version of MED format # @param f the file name # @param version values are SMESH.MED_V2_1, SMESH.MED_V2_2 + # @param opt boolean parameter for creating/not creating + # the groups Group_On_All_Nodes, Group_On_All_Faces, ... # @ingroup l2_impexp def ExportToMED(self, f, version, opt=0): self.mesh.ExportToMED(f, opt, version) @@ -2190,6 +2192,8 @@ class Mesh: # @param x the X coordinate of a point # @param y the Y coordinate of a point # @param z the Z coordinate of a point + # @param NodeID if specified (>0), the node with this ID is moved, + # otherwise, the node closest to point (@a x,@a y,@a z) is moved # @return the ID of a node # @ingroup l2_modif_throughp def MoveClosestNodeToPoint(self, x, y, z, NodeID): @@ -5175,7 +5179,7 @@ omniORB.registerObjref(StdMeshers._objref_StdMeshers_MaxElementArea._NP_Reposito class MaxElementVolume(StdMeshers._objref_StdMeshers_MaxElementVolume): ## Set Max Element Volume parameter value - # @param area numerical value or name of variable from notebook + # @param volume numerical value or name of variable from notebook def SetMaxElementVolume(self, volume): volume ,parameters = ParseParameters(StdMeshers._objref_StdMeshers_MaxElementVolume.GetLastParameters(self),1,1,volume) StdMeshers._objref_StdMeshers_MaxElementVolume.SetParameters(self,parameters)