From 54195af1ae9e72afdd2ef716fc04770d0b90a348 Mon Sep 17 00:00:00 2001 From: akl Date: Mon, 18 Feb 2013 13:09:16 +0000 Subject: [PATCH] Improve tui examples way of documenting by specifying doxygen alias --- doc/salome/gui/SMESH/doxyfile.in | 7 +- .../gui/SMESH/input/smeshpy_interface.doc | 3 +- .../gui/SMESH/input/tui_cartesian_algo.doc | 3 +- .../gui/SMESH/input/tui_creating_meshes.doc | 24 ++-- .../SMESH/input/tui_defining_hypotheses.doc | 52 +++------ doc/salome/gui/SMESH/input/tui_filters.doc | 108 ++++++------------ .../input/tui_generate_flat_elements.doc | 3 +- .../gui/SMESH/input/tui_grouping_elements.doc | 24 ++-- .../gui/SMESH/input/tui_measurements.doc | 6 +- .../gui/SMESH/input/tui_modifying_meshes.doc | 78 +++++-------- .../gui/SMESH/input/tui_notebook_smesh.doc | 3 +- .../gui/SMESH/input/tui_prism_3d_algo.doc | 3 +- .../gui/SMESH/input/tui_quality_controls.doc | 66 ++++------- .../SMESH/input/tui_transforming_meshes.doc | 39 +++---- .../SMESH/input/tui_use_existing_faces.doc | 3 +- .../gui/SMESH/input/tui_viewing_meshes.doc | 6 +- 16 files changed, 146 insertions(+), 282 deletions(-) diff --git a/doc/salome/gui/SMESH/doxyfile.in b/doc/salome/gui/SMESH/doxyfile.in index a6a5fc1f1..6b27a0c76 100755 --- a/doc/salome/gui/SMESH/doxyfile.in +++ b/doc/salome/gui/SMESH/doxyfile.in @@ -42,7 +42,7 @@ INPUT = @srcdir@/input @top_srcdir@/src/Tools/padder/doc/input FILE_PATTERNS = *.doc EXCLUDE = IMAGE_PATH = @srcdir@/images @top_srcdir@/src/Tools/padder/doc/images -EXAMPLE_PATH = @top_srcdir@/src/SMESH_SWIG @top_srcdir@/doc/salome/examples +EXAMPLE_PATH = @top_srcdir@/doc/salome/examples @top_srcdir@/src/SMESH_SWIG #--------------------------------------------------------------------------- #HTML related options @@ -80,3 +80,8 @@ GENERATE_RTF = NO TAGFILES = smeshpy_doc.tag=../SMESH/smeshpy_doc #rnv: 07.04.2011 Workaround for the doxygen 1.7.3: #because it wrongly defines location of the html files for search. SEARCHENGINE = YES + +#--------------------------------------------------------------------------- +#Custom commands +#--------------------------------------------------------------------------- +ALIASES += tui_script{1}="\include \1 Download this script" diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc index 699e5c981..72d4585e1 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -36,8 +36,7 @@ An example below demonstrates usage of the Python API for 3d mesh generation. \anchor example_3d_mesh

Example of 3d mesh generation:

-\include 3dmesh.py -Download this script +\tui_script{3dmesh.py} Examples of Python scripts for Mesh operations are available by the following links: diff --git a/doc/salome/gui/SMESH/input/tui_cartesian_algo.doc b/doc/salome/gui/SMESH/input/tui_cartesian_algo.doc index 4cc1ec654..dccf68a5f 100644 --- a/doc/salome/gui/SMESH/input/tui_cartesian_algo.doc +++ b/doc/salome/gui/SMESH/input/tui_cartesian_algo.doc @@ -1,7 +1,6 @@ /*! \page tui_cartesian_algo Usage of Body Fitting algorithm -\include cartesian_algo.py -Download this script +\tui_script{cartesian_algo.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_creating_meshes.doc b/doc/salome/gui/SMESH/input/tui_creating_meshes.doc index bdeeb8a7a..d7edad332 100644 --- a/doc/salome/gui/SMESH/input/tui_creating_meshes.doc +++ b/doc/salome/gui/SMESH/input/tui_creating_meshes.doc @@ -7,52 +7,44 @@

Construction of a Mesh

-\include creating_meshes_ex01.py -Download this script +\tui_script{creating_meshes_ex01.py}
\anchor tui_construction_submesh

Construction of a Submesh

-\include creating_meshes_ex02.py -Download this script +\tui_script{creating_meshes_ex02.py}

Change priority of submeshes in Mesh

-\include creating_meshes_ex03.py -Download this script +\tui_script{creating_meshes_ex03.py}
\anchor tui_editing_mesh

Editing of a mesh

-\include creating_meshes_ex04.py -Download this script +\tui_script{creating_meshes_ex04.py}
\anchor tui_export_mesh

Export of a Mesh

-\include creating_meshes_ex05.py -Download this script +\tui_script{creating_meshes_ex05.py}

How to mesh a cylinder with hexahedrons?

Here you can see an example of python script, creating a hexahedral mesh on a cylinder. And a picture below the source code of the script, demonstrating the resulting mesh. -\include creating_meshes_ex06.py -Download this script +\tui_script{creating_meshes_ex06.py} \image html mesh_cylinder_hexa.png
\anchor tui_building_compound

Building a compound of meshes

-\include creating_meshes_ex07.py -Download this script +\tui_script{creating_meshes_ex07.py}
\anchor tui_copy_mesh

Mesh Copying

-\include creating_meshes_ex08.py -Download this script +\tui_script{creating_meshes_ex08.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc b/doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc index 3f3124db3..71abf33b6 100644 --- a/doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc +++ b/doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc @@ -44,102 +44,84 @@ This page provides example codes of \ref tui_defining_meshing_algos
\anchor tui_1d_arithmetic

Arithmetic 1D

-\include defining_hypotheses_ex01.py -Download this script +\tui_script{defining_hypotheses_ex01.py}
\anchor tui_deflection_1d

Deflection 1D and Number of Segments

-\include defining_hypotheses_ex02.py -Download this script +\tui_script{defining_hypotheses_ex02.py}
\anchor tui_start_and_end_length

Start and End Length

-\include defining_hypotheses_ex03.py -Download this script +\tui_script{defining_hypotheses_ex03.py}
\anchor tui_average_length

Local Length

-\include defining_hypotheses_ex04.py -Download this script +\tui_script{defining_hypotheses_ex04.py}

Defining 2D and 3D hypotheses


\anchor tui_max_element_area

Maximum Element Area

-\include defining_hypotheses_ex05.py -Download this script +\tui_script{defining_hypotheses_ex05.py}
\anchor tui_max_element_volume

Maximum Element Volume

-\include defining_hypotheses_ex06.py -Download this script +\tui_script{defining_hypotheses_ex06.py}
\anchor tui_length_from_edges

Length from Edges

-\include defining_hypotheses_ex07.py -Download this script +\tui_script{defining_hypotheses_ex07.py}

Defining Additional Hypotheses


\anchor tui_propagation

Propagation

-\include defining_hypotheses_ex08.py -Download this script +\tui_script{defining_hypotheses_ex08.py}
\anchor tui_defining_meshing_algos

Defining Meshing Algorithms

-\include defining_hypotheses_ex09.py -Download this script +\tui_script{defining_hypotheses_ex09.py}
\anchor tui_projection

Projection Algorithms

-\include defining_hypotheses_ex10.py -Download this script +\tui_script{defining_hypotheses_ex10.py}

Projection 1D2D

-\include defining_hypotheses_ex11.py -Download this script +\tui_script{defining_hypotheses_ex11.py}
\anchor tui_fixed_points

1D Mesh with Fixed Points example

-\include defining_hypotheses_ex12.py -Download this script +\tui_script{defining_hypotheses_ex12.py} \anchor tui_radial_quadrangle

Radial Quadrangle 1D2D example

-\include defining_hypotheses_ex13.py -Download this script +\tui_script{defining_hypotheses_ex13.py} \anchor tui_quadrangle_parameters

Quadrangle Parameters example 1 (meshing a face with 3 edges)

-\include defining_hypotheses_ex14.py -Download this script +\tui_script{defining_hypotheses_ex14.py}

Quadrangle Parameters example 2 (using different types)

-\include defining_hypotheses_ex15.py -Download this script +\tui_script{defining_hypotheses_ex15.py} \anchor tui_import

"Use Existing Elements" example

-\include defining_hypotheses_ex16.py -Download this script +\tui_script{defining_hypotheses_ex16.py} \anchor tui_viscous_layers

Viscous layers construction

- -\include defining_hypotheses_ex17.py -Download this script +\tui_script{defining_hypotheses_ex17.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_filters.doc b/doc/salome/gui/SMESH/input/tui_filters.doc index 2540f52b8..eaf5d2803 100755 --- a/doc/salome/gui/SMESH/input/tui_filters.doc +++ b/doc/salome/gui/SMESH/input/tui_filters.doc @@ -27,8 +27,7 @@ Filter 2D mesh elements (faces) according to the aspect ratio value: - functor type should be \a smesh.FT_AspectRatio - threshold is floating point value (aspect ratio) -\include filters_ex01.py -Download this script +\tui_script{filters_ex01.py} \sa \ref tui_aspect_ratio @@ -39,8 +38,7 @@ Filter 3D mesh elements (volumes) according to the aspect ratio value: - functor type is \a smesh.FT_AspectRatio3D - threshold is floating point value (aspect ratio) -\include filters_ex02.py -Download this script +\tui_script{filters_ex02.py} \sa \ref tui_aspect_ratio_3d @@ -51,8 +49,7 @@ Filter 2D mesh elements (faces) according to the warping angle value: - functor type is \a smesh.FT_Warping - threshold is floating point value (warping angle) -\include filters_ex03.py -Download this script +\tui_script{filters_ex03.py} \sa \ref tui_warping @@ -63,8 +60,7 @@ Filter 2D mesh elements (faces) according to the minimum angle value: - functor type is \a smesh.FT_MinimumAngle - threshold is floating point value (minimum angle) -\include filters_ex04.py -Download this script +\tui_script{filters_ex04.py} \sa \ref tui_minimum_angle @@ -75,8 +71,7 @@ Filter 2D mesh elements (faces) according to the taper value: - functor type is \a smesh.FT_Taper - threshold is floating point value (taper) -\include filters_ex05.py -Download this script +\tui_script{filters_ex05.py} \sa \ref tui_taper @@ -87,8 +82,7 @@ Filter 2D mesh elements (faces) according to the skew value: - functor type is \a smesh.FT_Skew - threshold is floating point value (skew) -\include filters_ex06.py -Download this script +\tui_script{filters_ex06.py} \sa \ref tui_skew @@ -99,8 +93,7 @@ Filter 2D mesh elements (faces) according to the area value: - functor type is \a smesh.FT_Area - threshold is floating point value (area) -\include filters_ex07.py -Download this script +\tui_script{filters_ex07.py} \sa \ref tui_area @@ -111,8 +104,7 @@ Filter 3D mesh elements (volumes) according to the volume value: - functor type is \a smesh.FT_Volume3D - threshold is floating point value (volume) -\include filters_ex08.py -Download this script +\tui_script{filters_ex08.py} \sa \ref tui_volume @@ -123,8 +115,7 @@ Filter 1D mesh elements (edges) which represent free borders of a mesh: - functor type is \a smesh.FT_FreeBorders - threshold value is not required -\include filters_ex09.py -Download this script +\tui_script{filters_ex09.py} \sa \ref tui_free_borders @@ -136,8 +127,7 @@ element of mesh only: - functor type is \a smesh.FT_FreeEdges - threshold value is not required -\include filters_ex10.py -Download this script +\tui_script{filters_ex10.py} \sa \ref tui_free_edges @@ -148,8 +138,7 @@ Filter free nodes: - functor type is \a smesh.FT_FreeNodes - threshold value is not required -\include filters_ex11.py -Download this script +\tui_script{filters_ex11.py} \sa \ref tui_free_nodes @@ -160,8 +149,7 @@ Filter free faces: - functor type is \a smesh.FT_FreeFaces - threshold value is not required -\include filters_ex12.py -Download this script +\tui_script{filters_ex12.py} \sa \ref tui_free_faces @@ -172,8 +160,7 @@ Filter faces with bare borders: - functor type is \a smesh.FT_BareBorderFace - threshold value is not required -\include filters_ex13.py -Download this script +\tui_script{filters_ex13.py} \sa \ref tui_bare_border_faces @@ -185,8 +172,7 @@ Filter faces with bare borders: - threshold value is the face ID - tolerance is in degrees -\include filters_ex14.py -Download this script +\tui_script{filters_ex14.py} \section filter_over_constrained_faces Over-constrained faces @@ -195,8 +181,7 @@ Filter over-constrained faces: - functor type is \a smesh.FT_OverConstrainedFace - threshold value is not required -\include filters_ex15.py -Download this script +\tui_script{filters_ex15.py} \sa \ref tui_over_constrained_faces @@ -208,8 +193,7 @@ filter mesh elements basing on the same set of nodes: smesh.FT_EqualFaces or \a smesh.FT_EqualVolumes, - threshold value is not required -\include filters_ex16.py -Download this script +\tui_script{filters_ex16.py} \section tui_double_nodes_control Double nodes @@ -220,8 +204,7 @@ filters mesh nodes which are coincident with other nodes (within a given toleran - threshold value is not required - default tolerance is 1.0e-7 -\include filters_ex17.py -Download this script +\tui_script{filters_ex17.py} \section filter_borders_multiconnection Borders at multi-connection @@ -232,8 +215,7 @@ connections (faces belonging the border edges) - functor type is \a smesh.FT_MultiConnection - threshold is integer value (number of connections) -\include filters_ex18.py -Download this script +\tui_script{filters_ex18.py} \sa \ref tui_borders_at_multiconnection @@ -245,8 +227,7 @@ to the specified number of mesh elements - functor type is \a smesh.FT_MultiConnection2D - threshold is integer value (number of connections) -\include filters_ex19.py -Download this script +\tui_script{filters_ex19.py} \sa \ref tui_borders_at_multiconnection_2d @@ -257,8 +238,7 @@ Filter 1D mesh elements (edges) according to the edge length value: - functor type should be \a smesh.FT_Length - threshold is floating point value (length) -\include filters_ex20.py -Download this script +\tui_script{filters_ex20.py} \sa \ref tui_length_1d @@ -270,8 +250,7 @@ value of its edges: - functor type should be \a smesh.FT_Length2D - threshold is floating point value (edge length) -\include filters_ex21.py -Download this script +\tui_script{filters_ex21.py} \sa \ref tui_length_2d @@ -283,8 +262,7 @@ value of its edges and diagonals: - functor type should be \a smesh.FT_MaxElementLength2D - threshold is floating point value (edge/diagonal length) -\include filters_ex22.py -Download this script +\tui_script{filters_ex22.py} \sa \ref tui_max_element_length_2d @@ -296,8 +274,7 @@ value of its edges and diagonals: - functor type should be \a smesh.FT_MaxElementLength3D - threshold is floating point value (edge/diagonal length) -\include filters_ex23.py -Download this script +\tui_script{filters_ex23.py} \sa \ref tui_max_element_length_3d @@ -308,8 +285,7 @@ Filter 3D mesh elements with bare borders: - functor type is \a smesh.FT_BareBorderVolume - threshold value is not required -\include filters_ex24.py -Download this script +\tui_script{filters_ex24.py} \sa \ref tui_bare_border_volumes @@ -320,8 +296,7 @@ Filter over-constrained volumes: - functor type is \a smesh.FT_OverConstrainedVolume - threshold value is not required -\include filters_ex25.py -Download this script +\tui_script{filters_ex25.py} \sa \ref tui_over_constrained_faces @@ -333,8 +308,7 @@ shape defined by threshold value: - functor type should be \a smesh.FT_BelongToGeom - threshold is geometrical object -\include filters_ex26.py -Download this script +\tui_script{filters_ex26.py} \section filter_lying_on_geom Lying on Geom @@ -344,8 +318,7 @@ shape defined by threshold value: - functor type should be \a smesh.FT_LyingOnGeom - threshold is geometrical object -\include filters_ex27.py -Download this script +\tui_script{filters_ex27.py} \section filter_belong_to_plane Belong to Plane @@ -356,8 +329,7 @@ plane defined by threshold value with the given tolerance: - threshold is geometrical object (plane) - default tolerance is 1.0e-7 -\include filters_ex28.py -Download this script +\tui_script{filters_ex28.py} \section filter_belong_to_cylinder Belong to Cylinder @@ -368,8 +340,7 @@ cylindrical face defined by threshold value with the given tolerance: - threshold is geometrical object (cylindrical face) - default tolerance is 1.0e-7 -\include filters_ex29.py -Download this script +\tui_script{filters_ex29.py} \section filter_belong_to_surface Belong to Surface @@ -380,8 +351,7 @@ arbitrary surface defined by threshold value with the given tolerance: - threshold is geometrical object (arbitrary surface) - default tolerance is 1.0e-7 -\include filters_ex30.py -Download this script +\tui_script{filters_ex30.py} \section filter_range_of_ids Range of IDs @@ -391,8 +361,7 @@ specified identifiers range: - functor type is \a smesh.FT_RangeOfIds - threshold is string listing required IDs and/or ranges of IDs, e.g."1,2,3,50-60,63,67,70-78" -\include filters_ex31.py -Download this script +\tui_script{filters_ex31.py} \section filter_bad_oriented_volume Badly oriented volume @@ -402,8 +371,7 @@ the point of view of MED convention. - functor type is \a smesh.FT_BadOrientedVolume - threshold is not required -\include filters_ex32.py -Download this script +\tui_script{filters_ex32.py} \section filter_linear_or_quadratic Linear / quadratic @@ -414,8 +382,7 @@ Filter linear / quadratic mesh elements: - if unary operator is set to smesh.FT_LogicalNOT, the quadratic elements are selected, otherwise (by default) linear elements are selected -\include filters_ex33.py -Download this script +\tui_script{filters_ex33.py} \section filter_group_color Group color @@ -424,8 +391,7 @@ Filter mesh entities, belonging to the group with the color defined by the thres - functor type is \a smesh.FT_GroupColor - threshold should be of SALOMEDS.Color type -\include filters_ex34.py -Download this script +\tui_script{filters_ex34.py} \section filter_geom_type Geometry type @@ -436,8 +402,7 @@ entity type. - functor type should be \a smesh.FT_ElemGeomType - threshold is of smesh.GeometryType value -\include filters_ex35.py -Download this script +\tui_script{filters_ex35.py} \section combining_filters How to combine filters with Criterion structures? @@ -445,8 +410,7 @@ Filters can be combined by making use of "criteria". Example : -\include filters_ex36.py -Download this script +\tui_script{filters_ex36.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc b/doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc index 36e13d304..7284a76b5 100644 --- a/doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc +++ b/doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc @@ -17,8 +17,7 @@ by flat elements. \n This example represents an iron cable (a thin cylinder) in a concrete bloc (a big cylinder). The big cylinder is defined by two geometric volumes. -\include generate_flat_elements.py -Download this script +\tui_script{generate_flat_elements.py} \n Here, the 4 groups of volumes [Solid_1_1, Solid_2_1, Solid_3_1, Solid_4_1] constitute a partition of the mesh. The flat elements on group boundaries and on faces are built with the diff --git a/doc/salome/gui/SMESH/input/tui_grouping_elements.doc b/doc/salome/gui/SMESH/input/tui_grouping_elements.doc index d3113ab2c..a264f2542 100644 --- a/doc/salome/gui/SMESH/input/tui_grouping_elements.doc +++ b/doc/salome/gui/SMESH/input/tui_grouping_elements.doc @@ -5,29 +5,25 @@
\anchor tui_create_standalone_group

Create a Standalone Group

-\include grouping_elements_ex01.py -Download this script +\tui_script{grouping_elements_ex01.py} \image html create_group.png
\anchor tui_create_group_on_geometry

Create a Group on Geometry

-\include grouping_elements_ex02.py -Download this script +\tui_script{grouping_elements_ex02.py}
\anchor tui_create_group_on_filter

Create a Group on Filter

-\include grouping_elements_ex03.py -Download this script +\tui_script{grouping_elements_ex03.py}
\anchor tui_edit_group

Edit a Group

-\include grouping_elements_ex04.py -Download this script +\tui_script{grouping_elements_ex04.py} \image html editing_groups1.png @@ -36,8 +32,7 @@
\anchor tui_union_of_groups

Union of groups

-\include grouping_elements_ex05.py -Download this script +\tui_script{grouping_elements_ex05.py} \image html union_groups1.png @@ -48,8 +43,7 @@
\anchor tui_intersection_of_groups

Intersection of groups

-\include grouping_elements_ex06.py -Download this script +\tui_script{grouping_elements_ex06.py} \image html intersect_groups1.png @@ -60,8 +54,7 @@
\anchor tui_cut_of_groups

Cut of groups

-\include grouping_elements_ex07.py -Download this script +\tui_script{grouping_elements_ex07.py} \image html cut_groups1.png @@ -72,8 +65,7 @@
\anchor tui_create_dim_group

Creating groups of entities from existing groups of superior dimensions

-\include grouping_elements_ex08.py -Download this script +\tui_script{grouping_elements_ex08.py} \image html dimgroup_tui1.png
Source groups of faces
diff --git a/doc/salome/gui/SMESH/input/tui_measurements.doc b/doc/salome/gui/SMESH/input/tui_measurements.doc index 8ca283fc3..4d25c7358 100644 --- a/doc/salome/gui/SMESH/input/tui_measurements.doc +++ b/doc/salome/gui/SMESH/input/tui_measurements.doc @@ -3,11 +3,9 @@ \page tui_measurements_page Measurements \section tui_min_distance Minimum Distance -\include measurements_ex01.py -Download this script +\tui_script{measurements_ex01.py} \section tui_bounding_box Bounding Box -\include measurements_ex02.py -Download this script +\tui_script{measurements_ex02.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_modifying_meshes.doc b/doc/salome/gui/SMESH/input/tui_modifying_meshes.doc index e7844327c..7ceb5ebf7 100644 --- a/doc/salome/gui/SMESH/input/tui_modifying_meshes.doc +++ b/doc/salome/gui/SMESH/input/tui_modifying_meshes.doc @@ -9,62 +9,52 @@
\anchor tui_add_node

Add Node

-\include modifying_meshes_ex01.py -Download this script +\tui_script{modifying_meshes_ex01.py}
\anchor tui_add_0DElement

Add 0D Element

-\include modifying_meshes_ex02.py -Download this script +\tui_script{modifying_meshes_ex02.py}
\anchor tui_add_0DElement_on_all_nodes

Add 0D Element on Element Nodes

-\include modifying_meshes_ex03.py -Download this script +\tui_script{modifying_meshes_ex03.py}
\anchor tui_add_edge

Add Edge

-\include modifying_meshes_ex04.py -Download this script +\tui_script{modifying_meshes_ex04.py}
\anchor tui_add_triangle

Add Triangle

-\include modifying_meshes_ex05.py -Download this script +\tui_script{modifying_meshes_ex05.py}
\anchor tui_add_quadrangle

Add Quadrangle

-\include modifying_meshes_ex06.py -Download this script +\tui_script{modifying_meshes_ex06.py}
\anchor tui_add_tetrahedron

Add Tetrahedron

-\include modifying_meshes_ex07.py -Download this script +\tui_script{modifying_meshes_ex07.py}
\anchor tui_add_hexahedron

Add Hexahedron

-\include modifying_meshes_ex08.py -Download this script +\tui_script{modifying_meshes_ex08.py}
\anchor tui_add_polygon

Add Polygon

-\include modifying_meshes_ex09.py -Download this script +\tui_script{modifying_meshes_ex09.py}
\anchor tui_add_polyhedron

Add Polyhedron

-\include modifying_meshes_ex10.py -Download this script +\tui_script{modifying_meshes_ex10.py}
\anchor tui_removing_nodes_and_elements @@ -73,97 +63,81 @@
\anchor tui_removing_nodes

Removing Nodes

-\include modifying_meshes_ex11.py -Download this script +\tui_script{modifying_meshes_ex11.py}
\anchor tui_removing_elements

Removing Elements

-\include modifying_meshes_ex12.py -Download this script +\tui_script{modifying_meshes_ex12.py}
\anchor tui_removing_orphan_nodes

Removing Orphan Nodes

-\include modifying_meshes_ex13.py -Download this script +\tui_script{modifying_meshes_ex13.py}
\anchor tui_renumbering_nodes_and_elements

Renumbering Nodes and Elements

-\include modifying_meshes_ex14.py -Download this script +\tui_script{modifying_meshes_ex14.py}
\anchor tui_moving_nodes

Moving Nodes

-\include modifying_meshes_ex15.py -Download this script +\tui_script{modifying_meshes_ex15.py}
\anchor tui_diagonal_inversion

Diagonal Inversion

-\include modifying_meshes_ex16.py -Download this script +\tui_script{modifying_meshes_ex16.py}
\anchor tui_uniting_two_triangles

Uniting two Triangles

-\include modifying_meshes_ex17.py -Download this script +\tui_script{modifying_meshes_ex17.py}
\anchor tui_uniting_set_of_triangles

Uniting a Set of Triangles

-\include modifying_meshes_ex18.py -Download this script +\tui_script{modifying_meshes_ex18.py}
\anchor tui_orientation

Orientation

-\include modifying_meshes_ex19.py -Download this script +\tui_script{modifying_meshes_ex19.py}
\anchor tui_cutting_quadrangles

Cutting Quadrangles

-\include modifying_meshes_ex20.py -Download this script +\tui_script{modifying_meshes_ex20.py}
\anchor tui_smoothing

Smoothing

-\include modifying_meshes_ex21.py -Download this script +\tui_script{modifying_meshes_ex21.py}
\anchor tui_extrusion

Extrusion

-\include modifying_meshes_ex22.py -Download this script +\tui_script{modifying_meshes_ex22.py}
\anchor tui_extrusion_along_path

Extrusion along a Path

-\include modifying_meshes_ex23.py -Download this script +\tui_script{modifying_meshes_ex23.py}
\anchor tui_revolution

Revolution

-\include modifying_meshes_ex24.py -Download this script +\tui_script{modifying_meshes_ex24.py}
\anchor tui_pattern_mapping

Pattern Mapping

-\include modifying_meshes_ex25.py -Download this script +\tui_script{modifying_meshes_ex25.py}
\anchor tui_quadratic

Convert mesh to/from quadratic

-\include modifying_meshes_ex26.py -Download this script +\tui_script{modifying_meshes_ex26.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_notebook_smesh.doc b/doc/salome/gui/SMESH/input/tui_notebook_smesh.doc index 340359069..7f34deca9 100644 --- a/doc/salome/gui/SMESH/input/tui_notebook_smesh.doc +++ b/doc/salome/gui/SMESH/input/tui_notebook_smesh.doc @@ -3,7 +3,6 @@ \page tui_notebook_smesh_page Using SALOME NoteBook \anchor tui_notebook_smesh -\include notebook_smesh.py -Download this script +\tui_script{notebook_smesh.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_prism_3d_algo.doc b/doc/salome/gui/SMESH/input/tui_prism_3d_algo.doc index d0234a7ab..6ba5e25d3 100644 --- a/doc/salome/gui/SMESH/input/tui_prism_3d_algo.doc +++ b/doc/salome/gui/SMESH/input/tui_prism_3d_algo.doc @@ -1,8 +1,7 @@ /*! \page tui_prism_3d_algo Use 3D extrusion meshing algorithm -\include prism_3d_algo.py -Download this script +\tui_script{prism_3d_algo.py} The result geometry and mesh is shown below \image html prism_tui_sample.png diff --git a/doc/salome/gui/SMESH/input/tui_quality_controls.doc b/doc/salome/gui/SMESH/input/tui_quality_controls.doc index e09389d3f..be849962c 100644 --- a/doc/salome/gui/SMESH/input/tui_quality_controls.doc +++ b/doc/salome/gui/SMESH/input/tui_quality_controls.doc @@ -3,91 +3,69 @@ \page tui_quality_controls_page Quality Controls \section tui_free_borders Free Borders -\include quality_controls_ex01.py -Download this script +\tui_script{quality_controls_ex01.py} \section tui_borders_at_multiconnection Borders at Multiconnection -\include quality_controls_ex02.py -Download this script +\tui_script{quality_controls_ex02.py} \section tui_length_1d Length 1D -\include quality_controls_ex03.py -Download this script +\tui_script{quality_controls_ex03.py} \section tui_free_edges Free Edges -\include quality_controls_ex04.py -Download this script +\tui_script{quality_controls_ex04.py} \section tui_free_nodes Free Nodes -\include quality_controls_ex05.py -Download this script +\tui_script{quality_controls_ex05.py} \section tui_free_faces Free Faces -\include quality_controls_ex06.py -Download this script +\tui_script{quality_controls_ex06.py} \section tui_bare_border_faces Bare border faces -\include quality_controls_ex07.py -Download this script +\tui_script{quality_controls_ex07.py} \section tui_bare_border_volumes Bare border volumes -\include quality_controls_ex08.py -Download this script +\tui_script{quality_controls_ex08.py} \section tui_over_constrained_faces Over-constrained faces -\include quality_controls_ex09.py -Download this script +\tui_script{quality_controls_ex09.py} \section tui_over_constrained_volumes Over-constrained volumes -\include quality_controls_ex10.py -Download this script +\tui_script{quality_controls_ex10.py} \section tui_length_2d Length 2D -\include quality_controls_ex11.py -Download this script +\tui_script{quality_controls_ex11.py} \section tui_borders_at_multiconnection_2d Borders at Multiconnection 2D -\include quality_controls_ex12.py -Download this script +\tui_script{quality_controls_ex12.py} \section tui_area Area -\include quality_controls_ex13.py -Download this script +\tui_script{quality_controls_ex13.py} \section tui_taper Taper -\include quality_controls_ex14.py -Download this script +\tui_script{quality_controls_ex14.py} \section tui_aspect_ratio Aspect Ratio -\include quality_controls_ex15.py -Download this script +\tui_script{quality_controls_ex15.py} \section tui_minimum_angle Minimum Angle -\include quality_controls_ex16.py -Download this script +\tui_script{quality_controls_ex16.py} \section tui_warping Warping -\include quality_controls_ex17.py -Download this script +\tui_script{quality_controls_ex17.py} \section tui_skew Skew -\include quality_controls_ex18.py -Download this script +\tui_script{quality_controls_ex18.py} \section tui_max_element_length_2d Element Diameter 2D -\include quality_controls_ex19.py -Download this script +\tui_script{quality_controls_ex19.py} \section tui_aspect_ratio_3d Aspect Ratio 3D -\include quality_controls_ex20.py -Download this script +\tui_script{quality_controls_ex20.py} \section tui_volume Volume -\include quality_controls_ex21.py -Download this script +\tui_script{quality_controls_ex21.py} \section tui_max_element_length_3d Element Diameter 3D -\include quality_controls_ex22.py -Download this script +\tui_script{quality_controls_ex22.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_transforming_meshes.doc b/doc/salome/gui/SMESH/input/tui_transforming_meshes.doc index 3b77fab34..303b7cec4 100644 --- a/doc/salome/gui/SMESH/input/tui_transforming_meshes.doc +++ b/doc/salome/gui/SMESH/input/tui_transforming_meshes.doc @@ -7,81 +7,68 @@
\anchor tui_translation

Translation

-\include transforming_meshes_ex01.py -Download this script +\tui_script{transforming_meshes_ex01.py}
\anchor tui_rotation

Rotation

-\include transforming_meshes_ex02.py -Download this script +\tui_script{transforming_meshes_ex02.py}
\anchor tui_scale

Scale

-\include transforming_meshes_ex03.py -Download this script +\tui_script{transforming_meshes_ex03.py}
\anchor tui_symmetry

Symmetry

-\include transforming_meshes_ex04.py -Download this script +\tui_script{transforming_meshes_ex04.py}
\anchor tui_merging_nodes

Merging Nodes

-\include transforming_meshes_ex05.py -Download this script +\tui_script{transforming_meshes_ex05.py}
\anchor tui_merging_elements

Merging Elements

-\include transforming_meshes_ex06.py -Download this script +\tui_script{transforming_meshes_ex06.py}

Sewing Meshes


\anchor tui_sew_meshes_border_to_side

Sew Meshes Border to Side

-\include transforming_meshes_ex07.py -Download this script +\tui_script{transforming_meshes_ex07.py}
\anchor tui_sew_conform_free_borders

Sew Conform Free Borders

-\include transforming_meshes_ex08.py -Download this script +\tui_script{transforming_meshes_ex08.py}
\anchor tui_sew_free_borders

Sew Free Borders

-\include transforming_meshes_ex09.py -Download this script +\tui_script{transforming_meshes_ex09.py}
\anchor tui_sew_side_elements

Sew Side Elements

-\include transforming_meshes_ex10.py -Download this script +\tui_script{transforming_meshes_ex10.py}
\anchor tui_duplicate_nodes

Duplicate nodes

-\include transforming_meshes_ex11.py -Download this script +\tui_script{transforming_meshes_ex11.py}
\anchor tui_make_2dmesh_from_3d

Create boundary elements

-\include transforming_meshes_ex12.py -Download this script +\tui_script{transforming_meshes_ex12.py}
\anchor tui_reorient_faces

Reorient faces by vector

-\include transforming_meshes_ex13.py -Download this script +\tui_script{transforming_meshes_ex13.py} */ diff --git a/doc/salome/gui/SMESH/input/tui_use_existing_faces.doc b/doc/salome/gui/SMESH/input/tui_use_existing_faces.doc index 46dfe1e05..ddc56cb83 100644 --- a/doc/salome/gui/SMESH/input/tui_use_existing_faces.doc +++ b/doc/salome/gui/SMESH/input/tui_use_existing_faces.doc @@ -6,8 +6,7 @@ This sample demonstrates how to use Use existing faces algorithm, which is actulally just a stub allowing to use your own 2D algoritm implemented in Python. -\include use_existing_faces.py -Download this script +\tui_script{use_existing_faces.py} Resulting mesh: \image html use_existing_face_sample_mesh.png diff --git a/doc/salome/gui/SMESH/input/tui_viewing_meshes.doc b/doc/salome/gui/SMESH/input/tui_viewing_meshes.doc index 06586ffea..2f3c4b404 100644 --- a/doc/salome/gui/SMESH/input/tui_viewing_meshes.doc +++ b/doc/salome/gui/SMESH/input/tui_viewing_meshes.doc @@ -5,13 +5,11 @@
\anchor tui_viewing_mesh_infos

Viewing Mesh Infos

-\include viewing_meshes_ex01.py -Download this script +\tui_script{viewing_meshes_ex01.py}
\anchor tui_find_element_by_point

Find Element by Point

-\include viewing_meshes_ex02.py -Download this script +\tui_script{viewing_meshes_ex02.py} */ -- 2.30.2