Salome HOME
first tutorial update
authorPaul RASCLE <paul.rascle@openfields.fr>
Fri, 25 Sep 2020 14:56:58 +0000 (16:56 +0200)
committerYOANN AUDOUIN <B61570@dsp0851742.postes.calibre.edf.fr>
Fri, 30 Oct 2020 16:08:45 +0000 (17:08 +0100)
.gitignore
CMakeLists.txt
doc/salome/tutorial/CMakeLists.txt
doc/salome/tutorial/_static/changes_coords.png [new file with mode: 0644]
doc/salome/tutorial/_static/dialogChangeCoords.png [new file with mode: 0644]
doc/salome/tutorial/_static/dialogChangeCoords2.png [new file with mode: 0644]
doc/salome/tutorial/changeCoordSystem.rst [new file with mode: 0644]
doc/salome/tutorial/conf.py.in
doc/salome/tutorial/index.rst
doc/salome/tutorial/modifBathy.rst [new file with mode: 0644]

index d46008d899ab1bf95417001154ee5a28db7d06bc..53208629b58b31c3b13c38201a70a9d71f8873f0 100644 (file)
@@ -1,5 +1,7 @@
 .gitignore
 .cproject
 .project
+.pydevproject
+.settings
 .yamm
 
index 8d537f43400c784fbf6cc59602d7db6db5714984..24415905df6ea7536e74f346a05bb1914347a69e 100644 (file)
@@ -9,7 +9,7 @@ INCLUDE(CMakeDependentOption)
 STRING(TOUPPER ${PROJECT_NAME} PROJECT_NAME_UC)
 
 SET(${PROJECT_NAME_UC}_MAJOR_VERSION 2)
-SET(${PROJECT_NAME_UC}_MINOR_VERSION 2)
+SET(${PROJECT_NAME_UC}_MINOR_VERSION 3)
 SET(${PROJECT_NAME_UC}_PATCH_VERSION 0)
 SET(${PROJECT_NAME_UC}_VERSION
   ${${PROJECT_NAME_UC}_MAJOR_VERSION}.${${PROJECT_NAME_UC}_MINOR_VERSION}.${${PROJECT_NAME_UC}_PATCH_VERSION})
index 014553e0f5ed681318c2dba921f28e96ee51e73f..f86ecff07eb1c2b08e34c0f6aeb83c7b7d39d774 100644 (file)
@@ -17,6 +17,7 @@
 
 SET(RSTFILES
   casCalcul.rst
+  changeCoordSystem.rst
   depouillementCalcul.rst
   donneesPrealables.rst
   format_sinusx.rst
@@ -33,6 +34,7 @@ SET(RSTFILES
   maillage.rst
   manipsPolys.rst
   miseEnDonneesTelemac.rst
+  modifBathy.rst
   objetsArtificiels.rst
   objetsNaturels.rst
   piegesAEviter.rst
diff --git a/doc/salome/tutorial/_static/changes_coords.png b/doc/salome/tutorial/_static/changes_coords.png
new file mode 100644 (file)
index 0000000..953c2b3
Binary files /dev/null and b/doc/salome/tutorial/_static/changes_coords.png differ
diff --git a/doc/salome/tutorial/_static/dialogChangeCoords.png b/doc/salome/tutorial/_static/dialogChangeCoords.png
new file mode 100644 (file)
index 0000000..a49ba0c
Binary files /dev/null and b/doc/salome/tutorial/_static/dialogChangeCoords.png differ
diff --git a/doc/salome/tutorial/_static/dialogChangeCoords2.png b/doc/salome/tutorial/_static/dialogChangeCoords2.png
new file mode 100644 (file)
index 0000000..e5a6396
Binary files /dev/null and b/doc/salome/tutorial/_static/dialogChangeCoords2.png differ
diff --git a/doc/salome/tutorial/changeCoordSystem.rst b/doc/salome/tutorial/changeCoordSystem.rst
new file mode 100644 (file)
index 0000000..829d01f
--- /dev/null
@@ -0,0 +1,56 @@
+..
+   Copyright (C) 2015-2016 EDF
+
+   This file is part of SALOME HYDRO module.
+
+   SALOME HYDRO module is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   SALOME HYDRO module is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
+
+###############################################
+Changement de système de coordonnées, d'origine
+###############################################
+
+.. |changes_coords| image:: /_static/changes_coords.png
+   :align: middle
+   :width: 16pt
+   :height: 16pt
+
+.. |dialogChangeCoords| image:: /_static/dialogChangeCoords.png
+   :align: middle
+
+.. |dialogChangeCoords2| image:: /_static/dialogChangeCoords2.png
+   :align: middle
+
+
+Il peut arriver que l'on récupère un maillage existant dans un système de coordonnées que l'on souhaite changer,
+ou simplement avec une origine locale que l'on souhaite décaler.
+
+Dans le module *HYDROSOLVER*, on utilise le dialogue *change Coordinates* accessible depuis le menu *Hydro*
+ou l'icone |changes_coords|.
+
+Si on laisse décochée la case *Change coordinates system*, Le dialogue permet une simple translation du maillage, 
+**sans perte des champs que le fichier peut contenir**. Une fois sélectionné le fichier du maillage d'origine,
+le dialogue propose un nom de fichier pour le maillage translaté en ajoutant un suffixe. Il est possible de prendre le nom de son choix.
+Il faut indiquer les coordonnées du repère local d'origine, et celles d'arrivée.
+
+  |dialogChangeCoords|
+
+Si l'on coche la case *Change coordinates system*, il est possible de sélectionner les systèmes de coordonnées d'origine et d'arrivée,
+dans une liste préétablie. Il est impératif de donner les coordonnées du repère local d'origine pour un fonctionnement correct.
+
+  |dialogChangeCoords2|
+
+.. only:: html
+ 
+   :ref:`ref_outilsReprise`
+
index 81d74c521efefaf93cf2bc7e37f06e772a089c7e..a5d1a03175adb6486fc4ecbf125e776fe869c400 100644 (file)
@@ -57,7 +57,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'SALOME HYDRO'
-copyright = u'2015-2017, EDF'
+copyright = u'2015-2020, EDF'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -65,10 +65,10 @@ copyright = u'2015-2017, EDF'
 #
 # The short X.Y version.
 #version = '@SALOMEHYDRO_VERSION@'
-version = '8.3.0'
+version = '9.5.0'
 # The full version, including alpha/beta/rc tags.
 #release = '@SALOMEHYDRO_VERSION@'
-release = '8.3.0- module HYDRO -@SALOMEHYDRO_VERSION@-2017.07.10'
+release = '9.5.0- module HYDRO -@SALOMEHYDRO_VERSION@-2020.10.01'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
index 01d2ed985e0b25683d05685ecbe407afd6322cf6..81533494b2c59b1cf5e438f7bc3a6fb0de631c3c 100644 (file)
@@ -135,7 +135,31 @@ On introduit ici quelques concepts non abordés dans l'exemple simple précéden
    objetsArtificiels.rst
    manipsPolys.rst
    landCoverMap.rst
+   
+.. _ref_outilsReprise:
 
+###################################
+Des outils pour la reprise d'études
+###################################
+
+Il arrive fréquemment que l'on doive reprendre des études, par exemple pour étendre ou modifier un maillage, changer la bathymétrie.
+Ces études peuvent avoir été générées avec d'autres outils que SALOME HYDRO.
+On suppose que l'on dispose a minima d'un fichier maillage au format MED correspondant à l'étude à reprendre,
+contenant éventuellement des groupes (conditions limites ou autres) que l'on souhaite récupérer.
+
+Le script *converter.py* fourni avec Telemac permet de convertir les types de maillages lus par Telemac au format MED.
+Il est accessible depuis le shell SALOME. ::
+
+  <appli_XXX>/salome shell
+  converter.py --help
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   modifBathy.rst
+   changeCoordSystem.rst
+   
 .. _ref_formatsSpecs:
 
 ###################################
diff --git a/doc/salome/tutorial/modifBathy.rst b/doc/salome/tutorial/modifBathy.rst
new file mode 100644 (file)
index 0000000..6c1f86e
--- /dev/null
@@ -0,0 +1,48 @@
+..
+   Copyright (C) 2015-2016 EDF
+
+   This file is part of SALOME HYDRO module.
+
+   SALOME HYDRO module is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   SALOME HYDRO module is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
+
+#########################################
+Modification d'une bathymetrie
+#########################################
+
+On souhaite appliquer une nouvelle bathymétrie sur tout ou partie d'un maillage existant, pour lequel l'on ne dispose que d'un maillage MED,
+contenant un champ de bathymetrie nommé *'BOTTOM'*.
+
+Supposons par exemple que l'on a une nouvelle bathymétrie pour le lit mineur, identifié dans le maillage par un groupe de mailles *'litMineur'*.
+Cette bathymétrie doit être dans le même système de coordonnéees que le maillage.
+
+En python, depuis la console embarquée de SALOME, ou depuis un shell SALOME : ::
+
+  <appli_XXX>/salome shell
+  python
+  
+  from salome.hydrotools.changeBathy import changeBathy
+  changeBathy(meshFileIn, meshFileOut, newBathy, 'litMineur', Xoffset, Yoffset)
+
+Ici, 
+
+  * *meshFileIn* : le chemin complet du maillage d'origine avec son champ 'BOTTOM' à modifier,
+  * *meshFileOut* : le chemin complet du maillage avec le nouveau champ 'BOTTOM',
+  * *newBathy* : le chemin complet du nouveau fichier de bathymetrie,
+  * *'litMineur'* : le nom du groupe de mailles dont on modifie la bathymétrie,
+  * *Xoffset, Yoffset* : les coordonnées du repère local, optionnelles, si non nulles.
+
+.. only:: html
+ 
+   :ref:`ref_outilsReprise`
+