Documentation de la frontière analytique torique

diff --git a/doc/en/gui_create_boundary.rst b/doc/en/gui_create_boundary.rst
index 8bf860872dfd6e588450363c56ab491b0412120a..5b84c664d8309b5da66d9262da20c57b010c24a1 100644 (file)
--- a/doc/en/gui_create_boundary.rst
+++ b/doc/en/gui_create_boundary.rst
@@ -45,7 +45,7 @@ In the starting up, SALOME shows a table with one only one column. This column c
 .. image:: images/create_boundary_an_1.png
    :align: center
 
-It is necessary to create a first analytical boundary by activation of the button "*New*". We shall have the choice between cylinder, sphere or cone. When the boundary will be validated, its name will appear in header of the second column.
+It is necessary to create a first analytical boundary by activation of the button "*New*". We shall have the choice between cylinder, sphere, cone or torus. When the boundary will be validated, its name will appear in header of the second column.
 
 .. image:: images/create_boundary_an_2.png
    :align: center
@@ -76,6 +76,7 @@ There are three types of analytical boundary:
   - Cylindre
   - Sphere
   - Cone, described by an axis and an angle or by two radius
+  - Torus
 
 .. note::
   The numerical values proposed by default take into account the geometry of the mesh.
@@ -117,6 +118,15 @@ Creation by two points centered on the axis and the associated radius:
 
 .. index:: single: object browser
 
+Torus
+=====
+.. index:: single: torus
+
+The torus is defined by its centre, its axis, the revolution radius and the primary radius. The axis is defined by a vector. The standard of this vector is not inevitably equal to 1; also, its orientation has no importance. A name of boundary is automatically proposed: Boun_1, Boun_2, etc. This name can be modified. It must not already have been used for another boundary.
+
+.. image:: images/create_boundary_an_to.png
+   :align: center
+
 Object browser
 **************
 At the end of this creation of boundaries, the object browser was enriched. We find all the boundaries created, identified there by their name, with the possibility of editing them.

diff --git a/doc/en/images/create_boundary_an_to.png b/doc/en/images/create_boundary_an_to.png
new file mode 100644 (file)
index 0000000..38e3940
Binary files /dev/null and b/doc/en/images/create_boundary_an_to.png differ

diff --git a/doc/en/tui_create_boundary.rst b/doc/en/tui_create_boundary.rst
index 5818fc986bb3693544b02dc93622101bb24d2fc3..b6efe599726daf945f13848b94c5c9020e993c15 100644 (file)
--- a/doc/en/tui_create_boundary.rst
+++ b/doc/en/tui_create_boundary.rst
@@ -68,6 +68,18 @@ These methods returns an instance of the class boundary.
 |     - ``Xc2``, ``Yc2``, ``Zc2``: coordinates of the second centre of the cone          |
 |     - ``R2``: radius of the cone at the second centre of the cone                      |
 +----------------------------------------------------------------------------------------+
+| .. module:: CreateBoundaryTorus                                                        |
+|                                                                                        |
+| **CreateBoundaryTorus(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, RRev, RPri)** |
+|     Returns an instance of the class ``boundary`` analytical type torus                |
+|     after its creation                                                                 |
+|                                                                                        |
+|     - ``boundary_name``: the name of the analytical boundary based on a torus          |
+|     - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of the centre of the torus             |
+|     - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis                                 |
+|     - ``RRev``: revolution radius of the torus                                         |
+|     - ``RPri``: primary radius of the torus                                            |
++----------------------------------------------------------------------------------------+
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -134,6 +146,7 @@ Methods of the class boundary
 |         * 2: sphere                                           |
 |         * 3: cone defined by an axis and an angle             |
 |         * 4: cone defined by 2 radius                         |
+|         * 5: torus                                            |
 +---------------------------------------------------------------+
 | .. module:: GetCoords                                         |
 |                                                               |

diff --git a/doc/fr/gui_create_boundary.rst b/doc/fr/gui_create_boundary.rst
index 914d87cce4e2b31cf7a972fe60ff73d6e330f084..5710384a82e9c00a180fd29ab31389a47ab8cbb8 100644 (file)
--- a/doc/fr/gui_create_boundary.rst
+++ b/doc/fr/gui_create_boundary.rst
@@ -45,7 +45,7 @@ Au d
 .. image:: images/create_boundary_an_1.png
    :align: center
 
-Il faut créer une première frontière analytique par activation du bouton "*Nouveau*". On aura le choix entre cylindre, sphère ou cône. Une fois que la frontière sera validée, son nom figurera en en-tête d'une deuxième colonne.
+Il faut créer une première frontière analytique par activation du bouton "*Nouveau*". On aura le choix entre cylindre, sphère, cône ou tore. Une fois que la frontière sera validée, son nom figurera en en-tête d'une deuxième colonne.
 
 .. image:: images/create_boundary_an_2.png
    :align: center
@@ -76,6 +76,7 @@ Il existe trois types de fronti
   - Cylindre
   - Sphère
   - Cône, décrit par un axe et un angle ou par deux rayons
+  - Tore
 
 .. note::
   Les valeurs numériques proposées par défaut tiennent compte de la géométrie du maillage.
@@ -115,6 +116,15 @@ Cr
 .. image:: images/create_boundary_an_co_2.png
    :align: center
 
+Un tore
+=======
+.. index:: single: tore
+
+Le tore est défini par son centre, son axe, le rayon de révolution et le rayon primaire. L'axe est défini par un vecteur. La norme de ce vecteur n'est pas nécessairement égale à 1 ; de même, son orientation n'a aucune importance. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière.
+
+.. image:: images/create_boundary_an_to.png
+   :align: center
+
 L'arbre d'étude
 ***************
 .. index:: single: arbre d'étude

diff --git a/doc/fr/images/create_boundary_an_to.png b/doc/fr/images/create_boundary_an_to.png
new file mode 100644 (file)
index 0000000..beb362c
Binary files /dev/null and b/doc/fr/images/create_boundary_an_to.png differ

diff --git a/doc/fr/tui_create_boundary.rst b/doc/fr/tui_create_boundary.rst
index 4ef349cb976e2ece1e553a4efef4a571ccd8b7f9..de94f042cafdc3a42a07c166d2f3caca112c33b4 100644 (file)
--- a/doc/fr/tui_create_boundary.rst
+++ b/doc/fr/tui_create_boundary.rst
@@ -69,6 +69,18 @@ Ces m
 |     - ``Xc2``, ``Yc2``, ``Zc2`` : coordonnées du second centre du cône                 |
 |     - ``R2`` : rayon du cône à la hauteur du second centre                             |
 +----------------------------------------------------------------------------------------+
+| .. module:: CreateBoundaryTorus                                                        |
+|                                                                                        |
+| **CreateBoundaryTorus(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, RRev, RPri)** |
+|     Retourne une instance de la classe ``boundary`` analytique de type torique         |
+|     après sa création                                                                  |
+|                                                                                        |
+|     - ``boundary_name`` : le nom de la frontière analytique basée sur un tore          |
+|     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre du tore                     |
+|     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                                  |
+|     - ``RRev`` : rayon de révolution du tore                                           |
+|     - ``RPri`` : rayon primaire du tore                                                |
++----------------------------------------------------------------------------------------+
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -135,6 +147,7 @@ M
 |         * 2 : sphère                                          |
 |         * 3 : cône défini par un axe et un angle              |
 |         * 4 : cône défini par deux rayons                     |
+|         * 5 : tore                                            |
 +---------------------------------------------------------------+
 | .. module:: GetCoords                                         |
 |                                                               |