Salome HOME
Corrections of examples path after install with scbi
[modules/hydro.git] / doc / salome / tutorial / english / english_polylignes.rst
index 1bc010df0ed14e3df6cc8a5fa098f54b6a870d89..86264a1849256273bd99fe92df57c4b251ac680f 100644 (file)
    along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
 
 #########################################
-Création, modification de polylignes
+Creation / modification of polylines
 #########################################
 
-.. |contour_garonne| image:: /../_static/contourGaronne.png
+.. |contour_garonne| image:: ../_static/contourGaronne.png
    :align: middle
 
-.. |contour_lit_majeur| image:: /../_static/contourLitMajeur.png
+.. |contour_lit_majeur| image:: ../_static/contourLitMajeur.png
    :align: middle
 
-.. |icone_polyligne_xy| image:: /../_static/icon_polyline_xy.png
+.. |icone_polyligne_xy| image:: ../_static/icon_polyline_xy.png
    :align: middle
 
-.. |createPolyligneDialogue1| image:: /../_static/createPolyligneDialogue1.png
+.. |createPolyligneDialogue1| image:: ../_static/createPolyligneDialogue1.png
    :align: middle
 
-.. |insertNewSection| image:: /../_static/insertNewSection.png
+.. |insertNewSection| image:: ../_static/insertNewSection.png
    :align: middle
 
-.. |createPolyligneDialogue2| image:: /../_static/createPolyligneDialogue2.png
+.. |createPolyligneDialogue2| image:: ../_static/createPolyligneDialogue2.png
    :align: middle
 
-.. |addition_mode| image:: /../_static/additionMode.png
+.. |addition_mode| image:: ../_static/additionMode.png
    :align: middle
 
-.. |ajoutPointsPolyligne| image:: /../_static/ajoutPointsPolyligne.png
+.. |ajoutPointsPolyligne| image:: ../_static/ajoutPointsPolyligne.png
    :align: middle
 
-.. |modification_mode| image:: /../_static/modificationMode.png
+.. |modification_mode| image:: ../_static/modificationMode.png
    :align: middle
 
-.. |undoPoly| image:: /../_static/undoPoly.png
+.. |undoPoly| image:: ../_static/undoPoly.png
    :align: middle
 
-.. |modificationPolyligne2| image:: /../_static/modificationPolyligne2.png
+.. |modificationPolyligne2| image:: ../_static/modificationPolyligne2.png
    :align: middle
 
-Nous allons créer trois lignes en dessinant sur les cartes et la bathymétrie.
+We are going to create three lines by drawing on the maps and the bathymetry.
 
-* Un contour fermé représentant une portion de la Garonne
-  (débordant du domaine d'étude défini plus loin), représenté par la surface bleu foncé ci-dessous :
+* A closed contour representing a portion of the Garonne (extending beyond the study domain defined later)
+  represented by the dark blue surface in the following image:
 
   |contour_garonne|
 
-* Un autre contour fermé sur une portion du lit majeur du fleuve
-  (toujours débordant du domaine d'étude en amont et en aval),
-  correspondant au champ de bathymétrie garonne_point_L93.
+* Another closed contour on a portion of the major bed of the river (still extending beyond the study domain
+  both upstream and downstream), corresponding to the bathymetry field garonne_point_L93.
 
-* Un contour fermé en lignes brisées qui délimitera notre domaine d'étude.
+* A closed contour in broken lines that will delineate the boundaries of our study domain.
 
-Le contour du lit majeur et du domaine d'étude :
+The contour of the major bed and the study domain:
 
   |contour_lit_majeur|
 
-Dessin des rives du fleuve
-==========================
+Drawing the river banks
+=======================
 
-Pour créer une polyligne, nous utilisons le menu contextuel de la rubrique *POLYLIGNES* dans l'arbre de
-l'étude SALOME : |icone_polyligne_xy|
+The context menu |icone_polyligne_xy| of the *POLYLINES* folder in the SALOME study tree is used to create a polyline.
 
-La première partie du dialogue de création permet de nommer la polyligne.
-Il est important de donner des noms significatifs aux objets, nous pourrons être amenés à en manipuler un grand nombre.
+The first section of the creation dialog box is used to name the polyline.
+It is important to give the objects meaningful names as a large number of them may be need to be handled.
 
-* **remarque** : attention à ne pas utiliser d'espaces ou d'accents pour les noms d'objets : problèmes potentiels
-  à différents niveaux dont les scripts Python.
-  
-Il est toujours possible de renommer les objets après coup :
+* **remark** : do not use accentuated characters in object names: this may induce problems, fr instance in dump Python scripts.
+
+They can always be renamed later:
 
   |createPolyligneDialogue1|
 
-Les polylignes peuvent comprendre plusieurs sections. Nous n'en utiliserons qu'une seule, il faut la créer :
+The polylines may comprise several sections. We will only be using one, which has to be created:
 
   |insertNewSection|
 
-Dans le dialogue relatif à la section, nous choisissons une ligne de type spline, fermée et cliquons sur le bouton add.
+In the dialog box related to the section, choose a spline-type, closed line and click on the add button.
 
   |createPolyligneDialogue2|
 
- * **remarque** : Les polylignes sont de deux types : 
+ * **Note**: There are two types of polyline:
+
+   * *spline*: a single continuous line, with derivative continuity passing through all the points.
+     This type of line is privileged when creating curved lines; the control points will not be reused in the mesh,
+     resulting in more flexibility control of the mesh refinement.
 
-   * *spline* : une seule ligne continue, a dérivée continue, passant par tous les points.
-     **On privilégie ce type de ligne pour toutes les lignes courbes, les points de définition ne 
-     seront pas repris dans le maillage**, ce qui donne une plus grande souplesse sur le contrôle
-     du raffinement de maillage.
-   * *polyline* : une seule ligne continue, composée de segments droits. Il faut utiliser
-     ce type de ligne pour les objets artificiels composés de segments droits, et chaque fois
-     que l'on a besoin de lignes brisées. Les points sont conservés dans le maillage.
+   * polyline: a single continuous line, composed of straight segments. This type of line must be used for artificial
+     objects comprising straight segments and whenever broken lines are needed. The points are kept in the mesh.
 
-Une fois la section créée, il faut ajouter des points en passant en mode addition :
+Once the section has been created, points must be added by switching to the addition mode:
 
   |addition_mode|
 
-Nous cliquons alors sur la carte, en suivant le contour du fleuve. **Il faut commencer à une extrémité
-(amont ou aval du domaine)**. Chaque clic dépose un point, et le contour fermé se dessine progressivement.
-Il est possible d'annuler un ou plusieurs des derniers points, avec les boutons undo / redo :
+Now click on the map, starting at one end **(upstream or downstream of the domain)** and follow the contour of the river.
+Each click adds a point and the closed contour is progressively drawn. One or more of the last points can be deleted
+with the undo / redo buttons:
 
   |undoPoly|
 
- * **remarque** : **Il est important de choisir ou commence une ligne fermée : le point correspondant est le 
-   seul qui reste imposé dans le maillage. Dans le cas d'un fleuve, autant mettre ce point hors du domaine.**
+ * **Note**: **The choice of where to start a closed line is important: the corresponding point is the only mesh-imposed
+   point. In the case of a river, it is best to put this point outside the domain.**
 
   |ajoutPointsPolyligne|
 
-Nous ajoutons des points jusqu'à revenir au point de départ après avoir décrit les deux rives.
-Il est inutile de mettre trop de points, sauf à vouloir capturer les détails d'une rive très découpée.
-A titre d'exemple, il faut une soixantaine de points pour la portion de fleuve qui nous intéresse.
+Continue to add points as needed until you arrive back at the starting point, having represented the two banks.
+There is no need to add too many points, unless the riverbank is deeply incised and these details need to be captured.
+For example, about sixty points are required along the river portion of interest in this case.
+
+When the entry is finished, confirm the created section by clicking *apply and close*.
 
-Quand la saisie est terminée, il faut valider avec *apply and close*.
+Modifying and editing polylines
+-------------------------------
 
-modification, édition de polyligne
-----------------------------------
-Si le résultat n'est pas satisfaisant, il est possible de modifier la polyligne en utilisant le menu
-contextuel de la polyligne. Dans le dialogue qui s'affiche, il faut sélectionner la section, puis
-cliquer sur le mode modification :
+If the result is not satisfactory, the polyline can be modified through the associated context menu,
+by first selecting the section and afterwards clicking on modification mode:
 
   |modification_mode|
 
-Il est alors possible de :
+It is then possible to:
 
- * sélectionner un seul point en cliquant dessus,
+ * Select a single point by clicking on it,
 
- * sélectionner plusieurs points en les encadrant,
+ * Select several points by enclosing them in a selection box,
 
- * créer un point intermédiaire en cliquant sur la ligne, entre deux points.
+ * Create an intermediate point by clicking on the line, between two points.
 
-Le ou les points sélectionnés peuvent être déplacés avec un clic-déplacement
-(le bouton gauche et maintenu enfoncé sur le déplacement).
+The selected point(s) can be moved using drag-and-drop (left button click and hold down while moving).
 
-Les points restent sélectionnés tant qu'il n'y a pas d'autre clic ou sélection.
+They remain selected until another click or selection is made.
 
-Le bouton Undo permet d'annuler les dernières modifications.
+The Undo button can be used, if needed, to cancel the latest changes.
 
-Les coordonnées des points sélectionnés sont affichées dans le dialogue. Elles sont éditables.
+The coordinates of the selected points are displayed in the dialog box as editable text.
 
   |modificationPolyligne2|
 
-En cours d'édition, on voit deux lignes. La ligne noire, précise, n'est pas recalculée à chaque fois.
-La ligne rouge est modifiée à chaque action, elle est moins précise, mais redessinée plus vite
-(c'est sensible pour les lignes comprenant un grand nombre de points).
+Two lines appear when editing: a precise, solid black line that is not recalculated each time an edit is made
+and a red line that changes with each modification. The latter is less precise but is redrawn more quickly
+(This is an important factor when lines containing a "large" number of points need to be modified).
 
-Il est possible de recalculer la ligne sans quitter le dialogue : il faut utiliser le bouton *apply*,
-puis, si l'on veut poursuivre les modifications, resélectionner la section avec un double clic,
-suivi de *OK* ou *Cancel* 
+The line can be recalculated from within the dialog box by clicking the *apply* button.
+If you wish to continue the modifications, the section can then be reselected with a double click,
+followed by *OK* or *Cancel*.
 
- * **Remarque** : On notera qu'il est possible de changer le type *spline* ou *polyline*, la fermeture,
-   en mode édition, avec un double clic sur la section.  
+ * **Note**: In edition mode, double clicking on the section provides options to change the segment type,
+   from spline to polyline or vice versa, and the closure.
 
-Dessin du contour du lit majeur et du domaine de calcul
-=======================================================
+Drawing the contour of the major bed and the study domain
+=========================================================
 
-Une fois le fleuve dessiné, nous poursuivons avec le dessin du contour de la bathymétrie du lit majeur, garonne_point_L93,
-puis la définition du contour du domaine de calcul, qui doit couper les deux autres lignes en amont et en aval.
+Once the river has been drawn, the next step is to draw the contour of the major river bed bathymetry,
+*garonne_point_L93*, then define the outside contour of the computational domain,
+which must cut the other two lines upstream and downstream.
+
+**It is preferable for the computational domain to cut the river perpendicular to its axis,
+in order to correctly define the upstream and downstream boundary conditions.
+The creation of acute angles at the boundary of the domain should be avoided, as they increase the risk
+of over-constrained triangles appearing when the mesh is created**
+(this problem that can be corrected by diagonal detection and inversion).
 
-**Il est préférable que le domaine de calcul coupe le fleuve perpendiculairement à son axe, de façon à
-définir correctement les conditions limites amont et aval. Il faut aussi éviter de créer des angles aigus en limite
-du domaine, ce qui risquerait de favoriser l'apparition de triangles surcontraints lors du maillage** (ce qui peut se
-corriger par une détection et une inversion de diagonale). 
- 
 .. only:: html
- 
-   :ref:`ref_exempleInondation`
+
+   :ref:`ref_english_exempleInondation`