and automatically applies the translations on import and export.
* **Constraint line**: Line used to support and structure the mesh.
- In SALOME, these lines are defined in the Geometry (GEOM module) as “edge”.
+ In SALOME, these lines are defined in the Geometry (GEOM module) as "edge".
Not every line created in the HYDRO module will necessarily be kept in the geometry.
* **Hydraulic axis**: The orientation of river flow.
The regions can be divided into several zones with each zone corresponding
to a computational mode for the bathymetry.
- * **Land Cover Map** : Carte d'occupation des sols, qui donne la nature des terrains, selon une codification
- *Corine Land Cover*.
+ * **Land Cover Map** : A map describing the region of interest, giving the kind of land cover
+ (for instance: forest, cultivated area, town...), following the *Corine Land Cover* classification.
- * **Table de Strickler** : Donne le *coefficient de Stricker* (frottement au sol)
- par type de Zone *Corine Land Cover*.
- Ces coefficients sont à ajuster au cas par cas, selon le type de calcul.
+ * **Strickler table** : Gives the *Stricker coefficient* (friction)
+ for each kind of land cover (entry of the *Corine Land Cover* classification).
+ These coefficients must be redefined on each case, following the type of calculation.
################################################
* GEOM: the case is taken up in GEOM to complete the identification of the groups associated
to the different regions of the domain and the boundary conditions
- * SMESH: the mesh assumptions (“hypotheses” in the dialogs) and algorithms are chosen,
+ * SMESH: the mesh assumptions ("hypotheses" in the dialogs) and algorithms are chosen,
the mesh is calculated and the corresponding MED file is exported
* HYDROSOLVER: the Z interpolation Python script giving z coordinates on mesh nodes
Preliminary data requirements
=============================
-* Pour les fichiers image : disposer de fichiers images des fonds carto ou photo et avoir repéré dans le système de travail
- les coordonnées de 2 ou 3 points bien répartis sur l’image (suffisament éloignés pour améliorer la précision).
- Avec trois points, on peut faire une transformation affine de l'image, pour le cas improbable ou celle-ci ne
- correspondrait pas à une projection verticale.
+* For the image files: have map or photo background image files and have identified in the working system
+ the coordinates of 2 or 3 points that are well-distributed over the image (far enough apart to ensure high precision).
+ With three points, an affine transformation of the image can be applied in the unlikely case that the latter is not
+ consistent with direct vertical (orthographic) projection.
-* Disposer des données de bathy au format ASCII.
+* Have bathymetry data available in ASCII format.
-Pour l’instant les fichiers de bathymetrie doivent porter l’extension .xyz (3 colonnes x,y,z) ou .asc
-(format de type grille a pas régulier, tel que fourni dans la BD Alti de l'IGN, par exemple).
+For the moment, the bathymetry files must have either an .xyz (3 columns x,y,z) or an .asc extension
+(raster grid-type format, as provided in the IGN Alti database, for example).
-* Si l'on dispose de profils en travers pour le lit mineur, il peuvent être fournis au format .xyz
- avec une ligne blanche séparant chaque profil, ou au format SinusX décrit plus loin.
+* If cross profiles are available for the river, they can be given either on xyz format with an empty line
+ between each profile, or on SinusX format (see description below).
-Import d'images
-================
+Image import
+============
-Il est possible d’importer des plans, cartes, et photos dans le module Hydro dans le dossier Images de l’arbre de l'étude.
-L’idée est de partir d’images satellitaires et/ou de cartes de la zone à mailler,
-géoréférencées dans le même système de coordonnées que l’ensemble des données (Lambert93 par exemple).
-Il est possible de récupérer l’intersection de deux images, de les fusionner, de restreindre une image à partir d’une polyline.
+Plans, maps and photos are imported into the Images folder of the study tree in the Hydro module.
+The idea is to work from satellite images and/or maps of the area to be meshed,
+georeferenced in the same system of coordinates as all the data (Lambert93 for example).
+It is possible to find the intersection of two images, to fusion the images and to clip an image using a polyline.
-Les manipulations d'images sont introduites dans l'exercice plus bas.
+Image manipulation is introduced in the subsequent exercise.
-Choix d'un repère local
-=======================
+Selection of a local reference point
+====================================
-**Il est vivement conseillé de changer l’origine du système de coordonnées local**
-pour éviter de manipuler de très grands nombres et avoir plus de précisions dans les différents calculs, notamment pour le maillage.
+**It is strongly advised to change the origin of the local coordinate system**
+to avoid having to deal with very large numbers and to increase the calculation precision,
+particularly for the mesh generation.
-Pour cela il faut utiliser le menu *Hydro/change local CS* et renseigner les coordonnées de la nouvelle origine.
+To do so, the *Hydro/change local CS* menu must be used to enter the coordinates of the new origin.
-Import de Bathymetries
-=======================
+Bathymetry import
+=================
-Le mode opératoire est expliqué dans l'exercice plus bas.
+The procedure is explained in the exercise section.
- * **remarque** : Si les altitudes sont inférieures à 0, la bathymétrie peut être cachée par les cartes ou photos
- (qui sont à Z = 0 par convention). Si l'on a besoin de voir simultanément la bathymétrie et les images,
- on peut, par exemple, soit passer en vue de dessous, soit éditer la bathymetrie (menu contextuel "edit imported bathymetry")
- pour inverser les z, le temps de contrôler la superposition des cartes et de la bathymétrie
- (ne pas oublier d'enlever l'inversion de z après !).
+ * **Note** : If the altitudes are less than 0, the bathymetry may be hidden by the maps or photos
+ (which are at Z = 0 by convention).
+ If the bathymetry needs to be seen at the same time as the images, this can be achieved either
+ by switching to the bottom view, or by editing the bathymetry
+ ("edit imported bathymetry" context menu) to invert the Z values while verifying for example
+ the alignment of the maps and the bathymetry
+ (and not forgetting to revert to the original Z values afterwards!).
-Récupération de données de bathymétrie d'un ancien maillage
------------------------------------------------------------
+Retrieving bathymetry data from old mesh
+----------------------------------------
-Pour les différentes opérations ci-dessous, le mode opératoire précis reste à détailler. Les scripts Python cités
-ne sont pas fournis avec cette version, is nécesitent des adaptations au cas par cas.
+Precise details of the procedure for the following operations remain to be finalized.
+The Python scripts mentioned below are not provided with this version;
+they require adaptation on a case by case basis.
- * Il est possible de récupérer un ancien maillage d’un cas d’étude, en le transformant avec un convertisseur
- intégré dans SALOME-HYDRO du format selafin (.slf) au format .med (format dédié pour la plate-forme Salomé en général).
+ * It is possible to retrieve an old mesh from a case study by converting the data from selafin format (.slf)
+ to .med format (dedicated format for the Salomé platform in general),
+ using the integrated file converter in SALOME-HYDRO
- * A partir de l’ancien maillage, il peut être nécessaire d’appliquer une translation (par exemple +2 000 000)
- à la position y des nœuds pour passer en système de géoréférencement connu (par exemple LambertIIEtendu).
+ * Based on the old mesh, it may be necessary to apply a translation (for example +2,000,000)
+ to the y-position of the nodes to switch to a known georeferencing system
+ (for example LambertIIEtendu).
- * Puis la bathymétrie (champ de fond Z) est récupérée à l’aide d’un script Python qui crée un fichier .xyz
- (position x du nœud, position y du nœud, Champ Z associé).
+ * The bathymetry (depth field Z) is then retrieved using a Python script which creates an .xyz file
+ (x node position, y node position, associated Z field).
- * Ce fichier .xyz est converti en Lambert93 grâce au logiciel libre Circé (sous Windows).
+ * This .xyz file is converted into Lambert 93 using the Circé freeware (under Windows).
- * Ensuite les positions des nœuds des bords sont récupérées à l’aide d’un script Python qui parcourt les nœuds,
- constate s'ils sont au bord et crée un fichier dans lequel chaque bord récupéré est mis en forme pour un import direct
- dans le module HYDRO.
+ * The edge node positions are then retrieved using a Python script that traverses the nodes,
+ determines whether they are at the boundary edge and creates a file in which each boundary retrieved
+ is formatted for direct import into the HYDRO module.
- * On peut isoler de cette façon le contour de l’emprise, des piles de ponts, et les îles éventuelles.
+ * This procedure enables isolating the contour of the site, bridge piers and islands, if there are any.
-Import d'objets de type lignes
-==================================
+Importing line-type objects
+===========================
-Le format SinusX (ASCII) décrit en annexe permet de décrire plusieurs types de lignes et de profils.
-Les fichiers au format SinusX qui respectent les conventions décrites en annexe peuvent être importés
-dans SALOME HYDRO.
+The SinusX (ASCII) format described in the appendix permits describing several line and profile types.
+Files in this format that respect the conventions detailed in the appendix can be imported into SALOME HYDRO.
-polylignes
------------
+polylines
+---------
-définition : lignes dans le plan XY, généralement utilisées pour définir des contours, des zones.
+Definition : lines in the XY plane, generally used to define contours and zones.
-profils
-----------
-
-Deux types de profils : géoréférencés ou non.
+profiles
+--------
-Les profils géoréférencés sont définis dans XYZ, les autres dans XZ (XY).
-Utilité : section de digue, de canal, de rivière.
+There are two types of profile: georeferenced or not.
-On définit une seule section pour un canal ou une digue, une série de profils pour une rivière.
+Georeferenced profiles are defined in XYZ coordinates and others in XZ (XY).
+Utility: embankment, canal, channel and river sections.
-Pour une digue, la valeur Z=0 correspond à la ligne de crête, pour un canal, c'est la ligne de fond.
+A single cross-section is defined for a channel, canal or an embankment and a series of profiles for a river.
-On considère uniquement des profils symétriques (par rapport à la ligne de crête ou de fond).
+For an embankment, the value Z=0 corresponds to the crest line, for a channel it is the bottom line.
+Only symmetrical profiles (in relation to the crest or bottom line) are considered.
Streams
--------
-Rivière décrite par une succession de profils en travers, ordonnés via une ligne amont-aval qui passe par ces profils.
-Cette ligne peut être l'axe hydraulique, mais ce n'est pas obligatoire.
+River described by a series of cross profiles, ordered along an upstream-downstream line which passes
+through these profiles. This line can be the hydraulic axis, though this is not compulsory.
-Les fichiers de stream peuvent être des fichiers XYZ pour lequels chaque profil est séparé par une ligne vide.
+The stream files can be XYZ files in which each profile is separated by an empty line.
+Line drawing
+============
-Dessin de lignes
-=================
-
-Les contours de type polyligne sont nécessaires à la création de la géométrie.
-Ils permettent la construction de l’emprise du modèle, des îles, du lit mineur d’un fleuve, ainsi que des digues, des canaux, des routes...
+Polyline-type contours are needed to create the geometry. They are used to construct the terrain model,
+ islands and the minor river bed, as well as embankments, channels, canals, roads and so forth.
-On peut afficher la bathymetrie ou les cartes lors de la saisie des contours pour se repérer.
+The bathymetry or maps can be displayed when entering contours as an orientation guide.
polylines
---------
-Dans SALOME les polylignes sont de deux types :
+There are two types of polyline in SALOME:
- * polylignes (ligne brisée constituée d'une série de segments droits, pour décrire un objet géométrique)
+ * Polylines (broken lines composed of a series of straight segments, to describe a geometric object)
- * splines (suite d’arcs qui donne une courbe à dérivée continue,
- pour décrire une courbure naturelle, qui s’adaptera à la finesse de la discrétisation).
+ * Splines (set of arcs that form a smooth parametric curve with a continuous derivative,
+ to describe a natural curve, which will adapt to the fineness of the discretisation).
-L’utilisation de splines permet de définir des contours sans que le maillage qui s’appuie dessus
-ne s’accroche à tous les points de la ligne : seule la forme générale compte.
+The use of splines enables contours to be defined without any need for the mesh based on these
+to adhere to all the points on the line: only the general shape counts.
-Le mode opératoire est détaillé dans l'exercice ci-dessous.
+The procedure is detailed in the exercise below.
-Il est possible de créer des lignes combinant polylignes et splines.
-Voir plus loin le pararaphe de manipulation des polylignes.
+it is possible to build lines mixing polylines and splines.
+See below the chapter on polyline manipulation.
-profils de digue ou canal
---------------------------
+Embankment or channel profiles
+------------------------------
-On peut importer ou dessiner ce type de profils.
-Le mode opératoire du dessin est détaillé dans l'exercice ci-dessous.
+These types of profile can be imported or drawn.
+The drawing procedure is detailed in the practical exercise.
-profils de rivière
-------------------
+River profiles
+--------------
-Seul l'import de ces profils est prévu.
+Only the import of these profiles is supported.
-Création d'objets "naturels" type "zone immersible"
-===================================================
+Creating "natural" objects of the "immersible zone" type
+========================================================
-Une **zone immersible** est une zone qui sera maillée. Les iles qui ne sont pas submersibles peuvent être exclues du maillage.
-Dans SALOME HYDRO, on distingue les îles du reste en désactivant leur attribut **Submersible**.
+An **immersible zone** will be meshed. Dry islands can be excluded from the mesh.
+In SALOME HYDRO, this type of island is differentiated from the others by deactivating the Submersible attribute.
-Créer une zone immersible consiste à créer une face géométrique à partir d’un des contours dessinés précédemment.
-On renseigne donc pour cela la polyline (obligatoire) sur laquelle va reposer la face et la bathymétrie (facultative)
-que l’on souhaite associer à cette zone géographique.
+Creating an immersible zone consists in the creation of a geometric face from one of the contours previously drawn.
+This is achieved by entering the polyline (compulsory) on which the face will be built
+and the desired bathymetry (optional) to associate with this geographical zone.
- * Remarque : la bathymétrie est facultative dans la création des objets naturels, notamment dans le cas des îles.
+ * **Note**: the bathymetry is optional when creating natural objects, particularly islands.
- * Remarque : Il est possible de changer l’ordre d’affichage des différents objets naturels et artificiels qui sont tous par convention
- dans le plan z=0, pour remettre "dessus" les petits objets.
+ * **Note**: It is possible to change the display order of the different natural and artificial objects,
+ which are all by convention in the z=0 plane, to put the small objects "above".
-Création d'objets "naturels" type "stream"
-==========================================
+Creating "stream" type "natural" objects
+========================================
-Le mode opératoire est détaillé dans l'exemple plus bas.
+The procedure is explained in detail in a later chapter.
-Création d'objet "artificiel" type digue ou canal
-=================================================
+Creating embankment or channel-type "artificial" objects
+========================================================
-Le mode opératoire est détaillé dans l'exemple plus bas.
+Details of the operating procedure are provided in a later chapter.
Obstacles
-============
-
-Objets géométriques complexes (bâtiments...) importés depuis GEOM,
-pour constituer des zones non submersibles ("iles" ou assimilés).
-Il faut mettre ces objets dans le repère local avant des les importer.
+=========
-Tables de coefficients de Strickler, Land Cover maps
-====================================================
+Complex geometric objects (buildings, etc.) imported from GEOM to constitute the dry zones
+("islands" or assimilated). These objects must be put into the local reference frame coordinates
+before importing them.
-Il est possible définir une carte des coefficients de Strickler (frottements sur le fond) couvrant le domaine d'étude.
+Strickler coefficient tables, Land Cover maps
+=============================================
-Des cartes décrivant la nature des sols (Land cover Map) peuvent être récupérées sur différents sites.
-Il est notamment possible de télécharger et d'éditer dans un outil de SIG (Systeme d'Information Géographique)
-comme *qgis* les cartes "Corine Land Cover".
-Ces cartes s'appuient sur une nomenclature standard des différents types de territoire.
+It is possible to build a Strickler coefficents map (friction) on the domain of interest.
-On définit en parallèle une table des coefficients de Strickler qui donne le coefficient pour chaque type défini dans la nomenclature.
-Les coefficients de Strickler sont en général ajustés pour une étude donnée, pour recaler le modèle.
+Maps giving the type of soils (Land Cover Map) can be obtained on various websites.
+For instance, with a Geographical Information System tool like *Qgis*, "Corine Land Cover" maps
+can be downloaded and edited.
+These maps follow a standard classification of soils.
-Les Land Cover Map peuvent être importées depuis qgis ou créées "from scratch" dans SALOME-HYDRO.
-Il est également possible d'éditer ces cartes dans SALOME-HYDRO : ajout, suppression, regroupement, modification de zones...
+For each study, the Strickler coefficents associated to the Land Cover Map should be adapted, following each type of soil
+of the map.
-Constitution d'un cas de calcul
-================================
+The Land Cover Maps are either imported from Qgis or created from scratch in SALOME-HYDRO.
+The Land Cover Maps can always be edited in SALOME-HYDRO: add, suppress, regroup, modify zones...
-Lors de la constitution d'un cas de calcul, il est possible de ne sélectionner que certains des objets définis précedemment.
-A partir d'une même base d'objets, on peut créer plusieurs cas de calculs plus ou moins complexes (prise en compte ou non
-de détails comme des piles de ponts, par exemple).
-
-L'emprise du domaine est définie par un contour polygonal particulier.
-
-Le chevauchement des différents objets crée des zones "en conflit" pour lesquelles il faut faire des choix pour le calcul de
-la bathymétrie.
-
-Le résultat du découpage en zones des différents objets se chevauchant constitue l'opération dite de **partition**.
+Calculation case set-up
+=======================
-On peut regrouper des zones en régions homogènes dans la structure du maillage visée,
-pour s’affranchir des contours que l'on ne veut pas garder en tant que lignes de contraintes.
+When configuring a calculation case, it is possible to select only some of the previously defined objects.
+The choice depends on the case complexity and several cases at different levels of complexity
+(details such as bridge piers, for example, being accounted for or not) can be created from the same object base.
-Dans le cas de calcul, il est possible d'identifier certaines lignes qui serviront de support aux conditions limites.
+The domain is enclosed with a given polygonal contour defining its boundaries.
-Le resultat est exporté dans le module de géométrie.
+The overlapping of different objects creates "conflicts" between zones for which choices have to be made
+in terms of the bathymetry computation.
-Le mode opératoire est détaillé dans l'exemple plus bas.
+Splitting the overlapping objects into different zones constitutes the **partition** or segmentation operation.
-Géométrie: Module GEOM
-======================
+Zones may be regrouped into homogeneous regions in the target mesh structure, to avoid the use of contours
+that we do not want to keep as constraint lines.
+
+In the calculation case, specific lines onto which the boundary conditions will be applied can be identified.
-Une fois le cas de calcul terminé et exporté il apparaît dans le module GEOM.
+The result is exported into the geometry module.
-Il faut activer ce module pour pouvoir visualiser et modifier le cas exporté.
+The procedure is explained in detail in the practical exercise.
-Il est conseillé de faire un *show only* sur la géométrie :
-dans l'arbre, se placer sur le cas de calcul dans la géométrie et menu contextuel clic droit *show only*.
+Geometry: GEOM module
+=====================
-Dans GEOM, on voit notre cas de calcul sous le nom <nom de cas>_N auquel est attaché le (ou les) contour(s)
-choisis au moment au moment de la définition du cas de calcul.
+Once the calculation case is completed and exported, it appears in the GEOM module.
-Il se peut qu’on ait besoin d'identifier certaines parties :
+This module must be activated to be able to view and modify the exported case.
- * Faces : pour mailler de façon différentes certaines zones
+In GEOM, the calculation case is seen under the name <case name>_N to which is attached
+the contour(s) selected when the calculation case was defined.
- * Segments : pour définir les conditions aux limites.
+Certain mesh parts may need to be identified:
-Le mode opératoire est détaillé dans l'exemple plus bas.
+ * Faces: to mesh certain zones in a different way
- * remarque : Il est possible d'utiliser le module de géométrie pour définir un certain nombre de
- contraintes sur le maillage. par exemple, on peut définir des points fixes de notre maillage
- (qui vont par exemple correspondre à des points de mesure).
- **Toute modification de la géométrie se traduit par la création d'un nouvel objet et la perte des groupes
- définis dans l'objet initial. Il faut donc créer les groupes en dernier, sur la géométrie finale,
- et, si possible éviter les modifications qui font perdre les définitions automatiques du module HYDRO.**
+ * Segments: to define the boundary conditions.
-Maillage: Module SMESH
-=======================
+The procedure is explained in detail in the practical exercise.
+
+ * **Note**: The geometry module may be used to define a certain number of mesh constraints; for example,
+ fixed points can defined in the mesh (which could for instance correspond to measurement points).
+ **Any modification to the geometry results in the creation of a new object and the loss of the groups
+ defined in the initial object. Groups must therefore be created last, on the final geometry,
+ and modifications that provoke the loss of the HYDRO module automatic definitions should be avoided,
+ if and whenever possible.**
-On se réferera aux formations SALOME pour l'utilisation du module SMESH.
+Mesh: SMESH module
+==================
-Le mode opératoire pour SALOME-HYDRO est détaillé dans l'exemple plus bas.
+Users should refer to the SALOME training materials for guidance on the use of the SMESH Module.
-Interpolation en Z
-===================
+The procedure for SALOME HYDRO is detailed in the exercise below.
-principes
----------
+Z Interpolation
+===============
-En hydrodynamique il est primordial de connaître la valeur de la bathymétrie en chaque nœud de calcul.
+Principles
+----------
-Le calcul de la bathymétrie est fait zone par zone, a chaque zone est associé un mode de calcul de la bathymétrie :
+In hydrodynamics, it is vital to know the bathymetry value at each computational node.
+
+The bathymetry is calculated zone by zone, with each zone associated to a specific method of calculation:
- * à partir des nuages de points
+ * From point clouds
- * à partir des profils de rivière
+ * From river profiles
- * à partir de l'axe et de la section des digues et canaux
+ * From embankments and canal/channel axes and cross-sections
- * à partir de la CAO des obstacles
+ * From the CAD of the obstacles
-Pour les nuages de points, on dispose dans HYDROSOLVER d’un utilitaire générant un script Python
-qui permet d’interpoler la bathymétrie sur le maillage.
-Ce script utilise un algorithme qui prend soit la valeur du Z du point le plus proche, soit la valeur Z interpolée
-sur une triangulation préalable du nuage.
+For the point clouds, a script is available in version 1.0 enabling to interpolate the bathymetry onto the mesh.
+This script uses an algorithm which takes either the Z value of the closest point or the Z value interpolated
+on a prior triangulation of the data points.
+
+The procedure is explained in detail in the practical exercise.
-Le mode opératoire est détaillé dans l'exemple plus bas.
+Input of physical/numerical data for TELEMAC
+============================================
-Mise en données Physico-numérique pour TELEMAC
-===============================================
+The HYDROSOLVER module is used to input these parameters and to assemble the calculation case.
-Cette mise en données fait intervenir le module HYDROSOLVER pour l'assemblage du cas de calcul.
+Description of the boundary conditions
+--------------------------------------
-description des conditions limites
-----------------------------------
+Each boundary condition region corresponds to a named group in the mesh.
+The types of boundary condition associated to a group are defined in a file whose syntax is given
+in the practical example.
-Chaque zone de condition limite correspond à un groupe nommé dans le maillage.
-Les types de conditon limites associés à un groupe sont définis dans un fichier.
Dans le module HYDROSOLVER, un outil permet d'associer des types de condition limites aux groupes concernés ans le maillage,
+Editing the Case file
+---------------------
-édition du fichier Cas
-----------------------
+The calculation parameters are defined in the Case file with the TELEMAC 2D syntax
+(using either EFICAS editor provided in GYDROSOLVER module or a standard text editor).
-Les paramètres de calcul sont définis dans le fichier Cas avec la syntaxe TELEMAC 2D (avec un éditeur de texte standard).
+List of files needed by TELEMAC 2D
+----------------------------------
-inventaire des fichiers utilisés par TELEMAC 2D
------------------------------------------------
+To be completed, see the example case.
-A compléter, voir l'exemple ci-dessous.
+Starting and monitoring the simulation
+======================================
-Lancement et suivi du calcul
-============================
+The HYDROSOLVER module is used to start TELEMAC 2D.
-Le module HYDROSOLVER permet de lancer TELEMAC 2D.
+The procedure is explained in the example case.
-Le mode opératoire est détaillé dans l'exemple plus bas.
+Result analysis
+===============
-Dépouillement des résultats
-===========================
+The PARAVIS module is used to exploit the results.
+Reference can be made to the SALOME training materials for further information on the use of the PARAVIS module.
-Le module PARAVIS est utilisé pour l'exploitation des résultats.
-On se réferera aux formations SALOME pour l'utilisation du module PARAVIS.
