Salome HOME
Provide missing TUI examples of some algorithms
[modules/smesh.git] / doc / salome / gui / SMESH / input / tui_defining_hypotheses.rst
index 0642126baef019c6c8ea4dfcae0cdf1087019a6b..c839e94b9750a478d8284bd934005dbcc9b77301 100644 (file)
@@ -10,7 +10,7 @@ and hypotheses.
 * Wire discretisation 1D algorithm
   
     * :ref:`tui_1d_adaptive` hypothesis
-    * :ref:`rithmetic Progression <tui_1d_arithmetic>` hypothesis
+    * :ref:`Arithmetic Progression <tui_1d_arithmetic>` hypothesis
     * :ref:`Geometric Progression <tui_1d_arithmetic>` hypothesis
     * :ref:`Deflection and Number of Segments <tui_deflection_1d>` hypotheses
     * :ref:`Start and End Length <tui_start_and_end_length>` hypothesis
@@ -24,20 +24,23 @@ and hypotheses.
     * :ref:`tui_max_element_area` hypothesis 
     * :ref:`tui_length_from_edges` hypothesis 
   
+* Quadrangle: Mapping 2D algorithm
+  
+    * :ref:`Quadrangle Parameters <tui_quadrangle_parameters>` hypothesis 
 
+* :ref:`Radial Quadrangle 1D-2D <tui_radial_quadrangle>` algorithm
 * NETGEN 3D algorithm
   
     *  :ref:`tui_max_element_volume` hypothesis 
     *  :ref:`Viscous layers <tui_viscous_layers>` hypotheses
 
 * :ref:`tui_projection`
-* :ref:`Radial Quadrangle 1D-2D <tui_radial_quadrangle>` algorithm
-* Quadrangle: Mapping 2D algorithm
-  
-    * :ref:`Quadrangle Parameters <tui_quadrangle_parameters>` hypothesis 
-
-* :ref:`tui_radial_prism`
+* :ref:`Extrusion 3D <tui_prism_3d_algo>` algorithm
+* :ref:`Radial Prism <tui_radial_prism>` algorithm
+* :ref:`Body Fitting <tui_cartesian_algo>` algorithm
 * :ref:`Import 1D-2D Elements from Another Mesh <tui_import>` algorithm
+* :ref:`Use Faces to be Created Manually <tui_use_existing_faces>` algorithm
+* :ref:`Segments around Vertex <tui_segments_around_vertex>` algorithm
 
 
 
@@ -262,3 +265,76 @@ Radial Prism example
     :language: python
 
 :download:`Download this script <../../../examples/radial_prism_3d_algo.py>`
+
+.. _tui_cartesian_algo:
+
+Usage of Body Fitting algorithm
+###############################
+
+.. literalinclude:: ../../../examples/cartesian_algo.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <../../../examples/cartesian_algo.py>`
+
+.. _tui_use_existing_faces: 
+
+Usage of "Use Faces to be Created Manually" algorithm
+#####################################################
+
+This sample demonstrates how to use **Use Faces to be Created Manually** algorithm,
+which is actually just a stub allowing to use your own 2D algorithm
+implemented in Python.
+
+.. literalinclude:: ../../../examples/use_existing_faces.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <../../../examples/use_existing_faces.py>`
+
+Resulting mesh:
+
+.. image:: ../images/use_existing_face_sample_mesh.png
+       :align: center
+
+
+.. _tui_prism_3d_algo:
+
+Usage of Extrusion 3D meshing algorithm
+########################################
+
+.. literalinclude:: ../../../examples/prism_3d_algo.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <../../../examples/prism_3d_algo.py>`
+
+The result geometry and mesh is shown below
+
+.. image:: ../images/prism_tui_sample.png
+       :align: center
+
+
+.. _tui_quad_ma_proj_algo:
+
+Usage of Medial Axis Projection algorithm
+#########################################
+
+.. literalinclude:: ../../../examples/quad_medial_axis_algo.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <../../../examples/quad_medial_axis_algo.py>`
+
+
+.. _tui_segments_around_vertex:
+
+Usage of Segments around Vertex algorithm
+#########################################
+
+.. literalinclude:: ../../../examples/defining_hypotheses_len_near_vertex.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <../../../examples/defining_hypotheses_len_near_vertex.py>`
+