X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fen%2Ftui_create_boundary.rst;h=1a33efc005b9f714bd336c613e41ef52705389a1;hb=5e710af6c92f7ebcc3b71ed1316ab265c1a346cc;hp=89fceb2ea6d51cdd0eafa72aed58088260cbb57a;hpb=f5e49913942af634c4cddfe20dc791666db625a8;p=modules%2Fhomard.git diff --git a/doc/en/tui_create_boundary.rst b/doc/en/tui_create_boundary.rst index 89fceb2e..1a33efc0 100644 --- a/doc/en/tui_create_boundary.rst +++ b/doc/en/tui_create_boundary.rst @@ -1,16 +1,16 @@ .. _tui_create_boundary: The boundary -============ +############ .. index:: single: boundary .. index:: single: cylinder .. index:: single: sphere -The variables are described in :ref:`gui_create_boundary`. +The variables are described in :doc:`gui_create_boundary`. Methods of the class homard -""""""""""""""""""""""""""" +*************************** These methods returns an instance of the class boundary. +----------------------------------------------------------------------------------------+ @@ -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 | ++----------------------------------------------------------------------------------------+ +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -88,8 +100,8 @@ These methods returns an instance of the class boundary. +---------------------------------------------------------------+ Methods of the class cas -""""""""""""""""""""""""" -See also in :ref:`tui_create_case`. +************************ +See also in :doc:`tui_create_case`. +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -115,7 +127,7 @@ See also in :ref:`tui_create_case`. +---------------------------------------------------------------+ Methods of the class boundary -"""""""""""""""""""""""""""""" +***************************** +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -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 | | | @@ -155,7 +168,7 @@ Methods of the class boundary Example -""""""" +******* Creation of a discrete boundary, a spherical boundary, and a cylindrical boundary: :: @@ -165,5 +178,5 @@ Creation of a discrete boundary, a spherical boundary, and a cylindrical boundar Similar graphical input -""""""""""""""""""""""" -Look at :ref:`gui_create_boundary` +*********************** +Look at :doc:`gui_create_boundary`