X-Git-Url: http://git.salome-platform.org/gitweb/?p=modules%2Fsmesh.git;a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FSMESH%2Finput%2Fsmeshpy_interface.doc;h=c690fb7efd8e5eb4a8e28a6a46877f627734233c;hp=29ff056b79125addfb5905f84be623cdbc22be15;hb=88068fce89e10cb32b60ea51cae3440240d42e9f;hpb=f5016d85b7b4b88623723027a1585c6414c4dc66 diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc index 29ff056b7..c690fb7ef 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -9,17 +9,21 @@ Documentation for SALOME %Mesh module Python API is available in two forms: - Structured documentation, where all methods and classes are grouped by their functionality, like it is done in the GUI documentation - Linear documentation grouped only by classes, declared -in the \ref smesh and StdMeshersDC Python packages. +in the \ref smeshBuilder and \ref StdMeshersBuilder Python packages. -Python package \ref smesh provides an interface to create and handle +\n With SALOME 7.2, the Python interface for %Mesh has been slightly modified to offer new functionality, +\n You may have to modify your scripts generated with SALOME 6 or older versions. +\n Please see \ref smesh_migration_page + +Class \ref smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle meshes. It can be used to create an empty mesh or to import mesh from the data file. As soon as mesh is created, it is possible to manage it via its own -methods, described in \ref smesh.Mesh "class Mesh" documentation. +methods, described in class \ref smeshBuilder.Mesh "Mesh" documentation. -Class \ref smesh.Mesh "Mesh" allows assigning algorithms to a mesh. +Class \ref smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh. Please note that some algorithms, included in the standard SALOME -distribution are always available. Python package \ref StdMeshersDC +distribution are always available. Python package \ref StdMeshersBuilder "StdMeshersBuilder" provides an interface for standard meshing algorithms included into the SALOME %Mesh module distribution, like: - REGULAR (1D) @@ -36,86 +40,14 @@ An example below demonstrates usage of the Python API for 3d mesh generation. \anchor example_3d_mesh

Example of 3d mesh generation:

- -\code -from geompy import * -import smesh - -### -# Geometry: an assembly of a box, a cylinder and a truncated cone -# meshed with tetrahedral -### - -# Define values -name = "ex21_lamp" -cote = 60 -section = 20 -size = 200 -radius_1 = 80 -radius_2 = 40 -height = 100 - -# Build a box -box = MakeBox(-cote, -cote, -cote, +cote, +cote, +cote) - -# Build a cylinder -pt1 = MakeVertex(0, 0, cote/3) -di1 = MakeVectorDXDYDZ(0, 0, 1) -cyl = MakeCylinder(pt1, di1, section, size) - -# Build a truncated cone -pt2 = MakeVertex(0, 0, size) -cone = MakeCone(pt2, di1, radius_1, radius_2, height) - -# Fuse -box_cyl = MakeFuse(box, cyl) -piece = MakeFuse(box_cyl, cone) - -# Add to the study -addToStudy(piece, 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 to the group -faces = SubShapeAllIDs(piece, ShapeType["FACE"]) -UnionIDs(group, faces) - -### -# Create a mesh -### - -# Define a mesh on a geometry -tetra = smesh.Mesh(piece, name) - -# Define 1D hypothesis -algo1d = tetra.Segment() -algo1d.LocalLength(10) - -# Define 2D hypothesis -algo2d = tetra.Triangle() -algo2d.LengthFromEdges() - -# Define 3D hypothesis -algo3d = tetra.Tetrahedron() -algo3d.MaxElementVolume(100) - -# Compute the mesh -tetra.Compute() - -# Create a groupe of faces -tetra.Group(group) - -\endcode +\tui_script{3dmesh.py} Examples of Python scripts for Mesh operations are available by the following links: - \subpage tui_creating_meshes_page - \subpage tui_cartesian_algo +- \subpage tui_use_existing_faces - \subpage tui_viewing_meshes_page - \subpage tui_defining_hypotheses_page - \subpage tui_quality_controls_page @@ -127,5 +59,6 @@ the following links: - \subpage tui_measurements_page - \subpage tui_generate_flat_elements_page - \subpage tui_work_on_objects_from_gui +- \subpage tui_prism_3d_algo */