Some hot fix.

work on tuto1

.gitignore

@@ -19,6 +19,8 @@ tmp
 *.pdf
 *.odt
 
+!doc/**/*.pdf
+
 doc/dev/images/auto_*
 doc/dev/documentation.*
 !doc/dev/*.org

.gitlab-ci.yml

@@ -26,6 +26,23 @@ stages:
 # DOWNLOADS #
 #############
 
+variables:
+  MAGE_VERSION: "v8.3.3"
+
+dl-mage-doc:
+  stage: downloads
+  tags:
+    - linux
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
+  script:
+    - mkdir -p doc
+    - cd doc
+    - curl -L -o mage8.pdf https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/$MAGE_VERSION/downloads/documents/Mage-8_Documentation.pdf
+  artifacts:
+    paths:
+      - doc/mage8.pdf
+
 dl-mage-linux:
   stage: downloads
   tags:
@@ -33,7 +50,7 @@ dl-mage-linux:
   rules:
     - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
   script:
-    - curl -L -o mage.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/Test6/downloads/packages/mage_linux.tgz
+    - curl -L -o mage.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/$MAGE_VERSION/downloads/packages/mage_linux.tgz
     - mkdir -p mage-linux
     - cd mage-linux
     - tar xvf ../mage.tgz
@@ -41,7 +58,8 @@ dl-mage-linux:
     paths:
       - mage-linux/mage
       - mage-linux/mage_extraire
-      - mage-linux/mailleurPF
+      - mage-linux/mailleurTT
+      - mage-linux/libbief.so
 
 dl-mage-windows:
   stage: downloads
@@ -50,7 +68,7 @@ dl-mage-windows:
   rules:
     - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
   script:
-    - curl -L -o mage.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/Test6/downloads/packages/mage_windows.tgz
+    - curl -L -o mage.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/$MAGE_VERSION/downloads/packages/mage_windows.tgz
     - mkdir -p mage-windows
     - cd mage-windows
     - tar xvf ../mage.tgz
@@ -58,7 +76,8 @@ dl-mage-windows:
     paths:
       - mage-windows/mage.exe
       - mage-windows/mage_extraire.exe
-      - mage-windows/mailleurPF.exe
+      - mage-windows/mailleurTT.exe
+      - mage-windows/libbief.dll
 
 #############
 # CONFIGURE #
@@ -122,7 +141,7 @@ test-pep8:
     - pip3 install -r ./requirements.txt
     - pip3 install -U -r ./requirements.txt
     - pip3 install pycodestyle
-    - pycodestyle ./src
+    - pycodestyle --exclude="*_to_*.py" ./src
   allow_failure: true
 
 #########
@@ -146,6 +165,24 @@ build-users-doc:
       - doc/users/images/
   allow_failure: true
 
+
+build-td:
+  stage: build
+  tags:
+    - linux
+  needs:
+    - job: set-version
+      artifacts: true
+  script:
+    - cd ./doc/users/Tuto1/
+    - ./build.sh
+  artifacts:
+    paths:
+      - doc/users/Tuto1/step-by-step.pdf
+      - doc/users/Tuto1/pas-a-pas.pdf
+      - doc/users/Tuto1/data/
+  allow_failure: true
+
 build-developers-doc:
   stage: build
   tags:
@@ -186,6 +223,8 @@ build-linux:
   needs:
     - job: dl-mage-linux
       artifacts: true
+    - job: dl-mage-doc
+      artifacts: true
     - job: set-version
       artifacts: true
     - job: build-lang
@@ -194,6 +233,8 @@ build-linux:
       artifacts: true
     - job: build-users-doc
       artifacts: true
+    - job: build-td
+      artifacts: true
   script:
     - mkdir -p linux
     - cd linux
@@ -237,13 +278,25 @@ build-linux:
     - mkdir -p pamhyr/doc/
     - mkdir -p pamhyr/doc/images/
     - mkdir -p pamhyr/doc/html/
-    - cp ../doc/users/documentation.pdf pamhyr/doc/Pamhyr2-users.pdf
-    - cp ../doc/users/documentation.html pamhyr/doc/Pamhyr2-users.html
+    # - cp ../doc/users/documentation.pdf pamhyr/doc/Pamhyr2-users.pdf
+    # - cp ../doc/users/documentation.html pamhyr/doc/Pamhyr2-users.html
+    - cp ../doc/mage8.pdf pamhyr/doc/mage8.pdf
     - cp ../doc/dev/documentation.pdf pamhyr/doc/Pamhyr2-dev.pdf
     - cp ../doc/dev/documentation.html pamhyr/doc/Pamhyr2-dev.html
     #- cp ../doc/users/images/* pamhyr/doc/images
-    - cp ../doc/dev/images/* pamhyr/doc/images
-    - cp ../doc/images/* pamhyr/doc/images
+    - cp -r ../doc/dev/images/* pamhyr/doc/images
+    - cp -r ../doc/images/* pamhyr/doc/images
+    # Copy Tuto
+    - mkdir -p pamhyr/doc/Tuto1/
+    - mkdir -p pamhyr/doc/Tuto1/data
+    - cp ../doc/users/Tuto1/Hogneau_Engees2022.pdf pamhyr/doc/Tuto1/Hogneau_Engees2022.pdf
+    - cp ../doc/users/Tuto1/step-by-step.pdf pamhyr/doc/Tuto1/Tuto1-en.pdf
+    - cp ../doc/users/Tuto1/pas-a-pas.pdf pamhyr/doc/Tuto1/Tuto1-fr.pdf
+    - cp ../doc/users/Tuto1/*.pamhyr pamhyr/doc/Tuto1/
+    - cp ../doc/users/Tuto1/data/* pamhyr/doc/Tuto1/data/
+    # Copy TP charriage
+    - mkdir -p pamhyr/doc/TP_charriage/
+    - cp ../doc/users/TP_charriage/* pamhyr/doc/TP_charriage
     # Create running script
     - echo "#!/bin/sh" > pamhyr/Pamhyr2
     - echo "./pamhyr/pamhyr $@" >> pamhyr/Pamhyr2
@@ -261,6 +314,8 @@ build-windows:
   needs:
     - job: dl-mage-windows
       artifacts: true
+    - job: dl-mage-doc
+      artifacts: true
     - job: set-version
       artifacts: true
     - job: build-lang
@@ -269,6 +324,8 @@ build-windows:
       artifacts: true
     - job: build-users-doc
       artifacts: true
+    - job: build-td
+      artifacts: true
   script:
     - mkdir windows
     - cd windows

README.md

@@ -10,35 +10,50 @@ modelling of rivers.
 + Define boundary conditions
 + Define lateral contribution
 + Edit river friction
++ Add reservoirs
++ Add hydraulic structures
 + Generate initial conditions
 + Edit river sedimentary layers
 + Save the study in a unique file
 + Run Mage 8 on a study and visualize results
 
+Let see the
+[documentation](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home)
+for more details.
+
 ## Install
 
 ### GNU/Linux
 
-Downloads [last
+Downloads the [last
 realease](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/releases/permalink/latest)
 GNU/Linux binary archive.
 
 ```shell
-tar xf pamhyr-gnulinux-amd64.tar.xz
+tar xf pamhyr-gnulinux.tar.xz
 cd pamhyr
-./pamhyr
+./Pamhyr2
 ```
 
 ### Windows
 
-Downloads [last
+Downloads the [last
 realease](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/releases/permalink/latest)
-Windows installer.
+Windows installer or ZIP archive.
 
 ### From source code
 
 ```shell
-# Get source code
+# Get mage
+mkdir mage
+cd mage
+
+curl -L -o mage.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/v8.3.2/downloads/packages/mage_linux.tgz
+tar xf mage.tgz
+
+cd ..
+
+# Get Pamhyr2 source code
 git clone https://gitlab.irstea.fr/theophile.terraz/pamhyr/
 cd pamhyr
 

doc/users/Tuto1/build.sh

@@ -0,0 +1,4 @@
+#! /bin/sh
+
+pdflatex -no-shell-escape step-by-step.tex
+pdflatex -no-shell-escape pas-a-pas.tex

doc/users/Tuto1/data/Bief_1.ST

@@ -65,7 +65,8 @@
    31874.0000      14.5000      22.1900 
    31874.0000      17.6000      22.9900 
      999.9990     999.9990     999.9990 
-     7     0     0     7   31875.0000   PontRD101m
+     7     0     0     9   31875.0000   PontRD101m
+   31875.0000       0.5400      23.0000 
    31875.0000       0.5400      21.8900 
    31875.0000       2.5000      19.6900 rg
    31875.0000       2.5000      18.6900 
@@ -73,8 +74,10 @@
    31875.0000      10.7000      18.9900 
    31875.0000      10.7000      19.9900 rd
    31875.0000      13.8900      21.8900 
+   31875.0000      13.8900      23.0000 
      999.9990     999.9990     999.9990 
-     8     0     0     7   31885.0000   PontRD101v
+     8     0     0     9   31885.0000   PontRD101v
+   31885.0000       0.5400      23.0000 
    31885.0000       0.5400      21.8900 
    31885.0000       2.5000      19.6900 rg
    31885.0000       2.5000      18.6900 
@@ -82,6 +85,7 @@
    31885.0000      10.7000      18.9900 
    31885.0000      10.7000      19.9900 rd
    31885.0000      13.8900      21.8900 
+   31885.0000      13.8900      23.0000 
      999.9990     999.9990     999.9990 
      9     0     0     9   31886.0000   
    31886.0000       0.0000      22.9900 
@@ -303,7 +307,8 @@
    34334.0000      14.0000      18.1000 rd
    34334.0000      16.1000      21.1300 
      999.9990     999.9990     999.9990 
-    26     0     0     7   34335.0000   PontmThivencelle
+    26     0     0     9   34335.0000   PontmThivencelle
+   34335.0000       2.9000      22.0000 
    34335.0000       2.9000      20.7400 
    34335.0000       2.9000      18.2900 rg
    34335.0000       6.4000      17.7900 
@@ -311,8 +316,10 @@
    34335.0000      12.8000      17.2600 
    34335.0000      12.8000      18.3100 rd
    34335.0000      12.8000      20.7400 
+   34335.0000      12.8000      22.0000 
      999.9990     999.9990     999.9990 
-    27     0     0     7   34343.0000   PontvThivencelle
+    27     0     0     9   34343.0000   PontvThivencelle
+   34343.0000       2.9000      22.0000 
    34343.0000       2.9000      20.7400 
    34343.0000       2.9000      18.2900 rg
    34343.0000       6.4000      17.7900 
@@ -320,6 +327,7 @@
    34343.0000      12.8000      17.2600 
    34343.0000      12.8000      18.2900 rd
    34343.0000      12.8000      20.7400 
+   34343.0000      12.8000      22.0000 
      999.9990     999.9990     999.9990 
     28     0     0    10   34345.0000   avalPontThivencell
    34345.0000       0.0000      21.3600 

doc/users/Tuto1/pas-a-pas.tex

@@ -0,0 +1,299 @@
+%% LyX 2.0.2 created this file.  For more info, see http://www.lyx.org/.
+%% Do not edit unless you really know what you are doing.
+\documentclass[12pt,french]{article}
+\usepackage[T1]{fontenc}
+\usepackage[latin9]{inputenc}
+\usepackage{geometry}
+\geometry{verbose,tmargin=2cm,bmargin=2cm,lmargin=2cm,rmargin=2cm,headheight=2cm,headsep=2cm,footskip=2cm}
+\usepackage{textcomp}
+\usepackage{graphicx}
+\usepackage{hyperref}
+
+\makeatletter
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% LyX specific LaTeX commands.
+\newcommand{\noun}[1]{\textsc{#1}}
+%% Because html converters don't know tabularnewline
+\providecommand{\tabularnewline}{\\}
+
+\makeatother
+
+\usepackage{babel}
+\addto\extrasfrench{%
+   \providecommand{\og}{\leavevmode\flqq~}%
+   \providecommand{\fg}{\ifdim\lastskip>\z@\unskip\fi~\frqq}%
+}
+
+\begin{document}
+\includegraphics[width=5cm]{img/Logo-INRAE_Transparent.png}
+
+~
+
+~
+
+~
+
+\begin{center}
+
+Tutoriel pour Pamhyr2
+
+Janvier 2024
+
+\par\end{center}
+
+~
+
+~
+
+\begin{center}
+
+\textbf{\LARGE Modélisation 1D de la rivière  } \\
+\textbf{\LARGE Hogneau (Nord, France) avec Pamhyr2}
+
+\par\end{center}{\LARGE \par}
+
+~
+
+~
+
+\begin{center}
+{\large INRAE Lyon-Grenoble Auvergne-Rhône-Alpes}
+\par\end{center}{\large \par}
+
+\begin{center}
+
+RiverLy, Hydraulique des rivières
+
+\par\end{center}
+
+~
+
+~
+
+~
+
+~
+
+~
+
+~
+
+\begin{center}
+\begin{tabular}{lll}
+Autors : & Pierre-Antoine Rouby & pierre-antoine.rouby@inrae.fr\tabularnewline
+& Théophile TERRAZ & theophile.terraz@inrae.fr\tabularnewline
+& Lionel Pénard & lionel.penard@inrae.fr\tabularnewline
+
+\end{tabular}
+\par\end{center}
+
+~
+
+\pagebreak{}
+
+\begin{center}
+\tableofcontents{}
+\par\end{center}
+
+~
+
+\pagebreak{}
+
+% \section{Introduction}
+%
+% TODO
+%
+% \pagebreak{}
+
+
+\section{Installer Pamhyr2}
+
+Pamhyr2 peut être téléchargé ici : \url{https://gitlab.irstea.fr/theophile.terraz/pamhyr}.
+
+\begin{center}
+\includegraphics[width=15cm]{img/dl.png}
+\par\end{center}
+
+
+Utilisez le bouton de téléchargement GNU Linux ou Windows en fonction de votre système. Sous Windows, lancez le programme d'installation. Sous Linux, décompressez l'archive et lancez Pamhyr2.
+
+
+\section{Créer une première étude}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Fichier] => [Nouvelle étude]} pour créer une nouvelle étude. Choisissez un nom, par exemple Hogneau, et validez
+
+Cliquez sur \texttt{[Réseau] => [Editer le réseau]} pour créer les biefs de votre rivière. Dans cette fenêtre, vous devez définir un graphe orienté qui représente les biefs de votre réseau fluvial : les arêtes sont les biefs et les n½uds sont soit des conditions limites amont, soit des conditions limites aval, soit des jonctions entre biefs.
+Appuyez sur le bouton \includegraphics[width=0.5cm]{img/gtk_add.png} pour entrer dans le mode \textit{Ajout}. Créez deux n½uds en cliquant dans la zone grise de la fenêtre, et créez un lien en cliquant à nouveau sur chaque n½ud. Appuyez à nouveau sur \includegraphics[width=0.5cm]{img/gtk_add.png} pour quitter le mode \textit{Ajout}. Vous avez créé votre premier bief, avec un n½ud amont et un n½ud aval. Dans la partie inférieure de la fenêtre \textit{Editer le réseau hydrographique}, vous pouvez renommer les n½uds et les biefs. Comme le bief que vous avez créé est automatiquement sélectionné, toutes les étapes suivantes s'appliqueront à ce bief. La fenêtre doit se présenter comme suit :
+
+
+\begin{center}
+\includegraphics[width=15cm]{img/network.png}
+\par\end{center}
+
+
+Fermer la fenêtre \textit{Editer le réseau}.
+
+
+\section{Editer la géometrie de la rivière}
+
+Cliquez sur \texttt{[Géometrie] => [Editer la géometrie]} pour définir la géométrie du bief sélectionné. Cliquez sur le bouton \texttt{[Importer]} et sélectionnez le fichier \texttt{Data/Bief\_1.st}. Vous devriez voir :
+
+
+\begin{center}
+\includegraphics[width=15cm]{img/Geo.png}
+\par\end{center}
+
+
+Le panneau de gauche contient une liste de toutes les sections en travers avec leur nom et leur abscisse longitudinale (PK). Dans le graphique en haut à gauche, vous pouvez voir la vue de dessus de la rivière, dans le panneau en haut à droite, la coupe longitudinale de la rivière et dans le graphique en bas, vous pouvez voir la section en travers sélectionnée (bleu) ainsi que la suivante (pointillés violets) et la précédente (pointillés noirs). Vous pouvez vous déplacer dans la liste des sections en cliquant dans le tableau ou à l'aide de l'ascenseur situé entre le tableau et les graphiques.
+
+Vous pouvez éditer la section en travers sélectionnée en cliquant sur l'icône \includegraphics[width=0.5cm]{"img/edit.png"}.
+
+Sélectionnez la section en travers nommée \textit{PontRD101m} et ouvrez la fenêtre d'édition. Vous devriez voir :
+
+\begin{center}
+\includegraphics[width=15cm]{img/editsect.png}
+\par\end{center}
+
+
+Sur le panneau de gauche se trouve la liste de tous les points de la section, avec leurs coordonnées, leur nom et leur abscisse transversale. La coordonnée Z du point le plus haut est inscrite en bleu et celle du point le plus bas en rouge. Les points peuvent avoir un nom. Si un point portant le même nom existe dans toutes les sections d'un bief, il forme une ligne longitudinale (ou ligne directrice). Par exemple, nous avons ici \textit{rg} et \textit{rd} qui représentent la rive gauche et la rive droite du lit mineur.
+
+Sur le graphique figure une projection de la section en travers. Vous pouvez utiliser \texttt{[ctrl + clic]} pour sélectionner un point dans le tracé et \texttt{[maj + clic]} pour sélectionner une ligne d'eau et visualiser des données géométriques utiles. Vous pouvez fermer la fenêtre d'édition de la section en travers et la fenêtre d'édition de la géométrie.
+
+\section{Editer les conditions aux limites}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Hydraulique] => [Conditions aux limites et apports ponctuels]} :
+
+\begin{center}
+\includegraphics[width=15cm]{img/boundary.png}
+\par\end{center}
+
+
+ Utilisez le bouton \textit{ajouter} en haut à gauche de la fenêtre pour ajouter une condition limite pour le liquide.
+ Sur la nouvelle ligne, on peut cliquer pour sélectionner la ligne entière, et double-cliquer pour sélectionner la cellule.
+ Sélectionnez la cellule \textit{Type} pour donner un nom à la condition limite. Ici, nous définirons le débit mesuré lors de la crue de février 2002. Vous pouvez nommer cette condition limite "crue2002".
+ Sélectionner la cellule \textit{Type} et utiliser la combo box pour mettre une loi Q(t).
+ Sélectionnez la cellule \textit{Noeud} et attribuez cette condition au noeud amont.
+ Les noms des noeuds sont rappelés dans le réseau du panneau de droite.
+ Sélectionnez maintenant la ligne entière et cliquez sur le bouton d'édition \includegraphics[width=0.5cm]{"img/edit.png"}. Vous avez ouvert la fenêtre \textit{Éditer les conditions aux limites}.
+ Dans un éditeur de texte, ouvrez le fichier \texttt{Données/Fevrier\_2002.txt}. Copiez le contenu du fichier (par exemple avec \textit{ctrl+a} puis \textit{ctrl+c}) et collez-le dans le panneau gauche de la fenêtre \textit{Éditer les conditions aux limites} avec \textit{ctrl+v}. Vous pouvez maintenant voir la courbe de débit :
+
+\begin{center}
+\includegraphics[width=15cm]{img/fev2002.png}
+\par\end{center}
+
+
+Fermer cette fenêtre. Revenir sur la fenêtre \textit{Conditions aux limites}. Ajouter une nouvelle ligne, lui donner un nom, lui donner le type \textit{Z(T)} et l'associer au noeud aval du réseau. Ouvrez la fenêtre \textit{Éditer les conditions aux limites} (\includegraphics[width=0.5cm]{"img/edit.png"}). Ajoutez deux lignes. Dans la première, entrez le temps : 0.00.00 et Z : 15.000.
+Dans la seconde, saisissez le temps : 1.00.00 et Z : 15.000. Cela crée une côte constante de l'eau en aval. Pour le calcul, Mage extrapolera continuellement l'élévation de l'eau.
+Vous pouvez fermer les fenêtres \textit{Éditer les conditions aux limites} et \textit{Conditions aux limites}.
+
+\section{Créer les conditions initiales}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Hydraulique] => [Conditions initiales]}.
+Si vous ne connaissez pas les conditions initiales de la côte de l'eau et du débit de la rivière, vous pouvez utiliser les boutons \texttt{[Générer une hauteur minimale]} ou \texttt{[Générer un débit constant]} pour laisser Pamhyr2 estimer une condition initiale à l'aide de la formule de Manning-Strickler.
+Cliquez sur \texttt{[Générer à partir du débit]} et saisissez un débit de $4 m^3$ dans la fenêtre contextuelle pour générer une condition initiale de hauteur d'eau basée sur la formule de Manning-Strickler et un débit uniforme de $4 m^3$. Vous devriez voir :
+
+
+\begin{center}
+\includegraphics[width=15cm]{img/ic.png}
+\par\end{center}
+
+
+Fermer la fenêtre \textit{Conditions initiales}
+
+
+\section{Editer les coefficients de frottement}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Hydraulique] => [Editer les frottements]}.
+Vous devez d'abord définir des jeux de coefficients de Strickler. Cliquez sur \includegraphics[width=0.5cm]{"img/edit.png"} pour ouvrir la fenêtre \textit{Strickler}. Vous pouvez y créer des couples de coefficients de Strickler, le premier pour le lit mineur, le second pour le lit moyen. Cliquez quatre fois sur \textit{add} pour créer quatre nouveaux couples. Donnez-leur les valeurs suivantes :
+
+
+\begin{center}
+\includegraphics[width=15cm]{img/K.png}
+\par\end{center}
+
+
+Fermez la fenêtre \textit{Strickler}. Dans la fenêtre \textit{Editer les frottements}, ajoutez quatre lignes avec le bouton \includegraphics[width=0.5cm]{img/gtk_add.png} pour créer quatre zones de frottement. Chaque zone est définie par un PK \textit{début} et de \textit{fin} PK et un couple \textit{begin} et \textit{end} couple de Strickler. Les couples de coefficients de Strickler à l'intérieur d'une zone sont interpolés à partir des couples \textit{begin} et \textit{end}. Dans notre cas, nous utiliserons des coefficients constants par zone. Définissez les zones comme suit :
+
+
+\begin{center}
+\includegraphics[width=15cm]{img/frictions.png}
+\par\end{center}
+
+
+La zone sélectionnée est surlignée en bleu. Fermez la fenêtre \textit{Editer les frottements}.
+
+
+\section{Modélisation des ouvrages hydrauliques}
+
+Parfois, il peut y avoir des sections en travers dans lesquelles les équations de Saint-Venant ne peuvent pas être utilisées pour modéliser l'écoulement de l'eau. Dans ce cas, nous devons définir une autre loi pour relier la côte de l'eau et le débit. C'est le cas, par exemple, au niveau des ponts lorsque la hauteur d'eau est trop élevée, ce qui entraîne un écoulement en charge. Pamhyr2 permet de définir différents ouvrages hydrauliques avec des lois paramétrables. Dans notre cas, on doit représenter un seuil et deux ponts comme ouvrages hydrauliques.
+Dans la fenêtre principale, cliquez sur \texttt{[Hydraulique] => [Ouvrages hydrauliques]} pour ouvrir la fenêtre des ouvrages hydrauliques. Cliquez trois fois sur le bouton \includegraphics[width=0.5cm]{img/gtk_add.png} pour créer trois ouvrages hydrauliques. Chaque structure peut avoir un nom et doit avoir une portée et un PK. Définissez-les comme suit :
+
+
+\begin{center}
+\includegraphics[width=15cm]{img/hs.png}
+\par\end{center}
+
+
+Sélectionnez le seuil aval et cliquez sur \includegraphics[width=0.5cm]{"img/edit.png"} pour modifier les lois de cette ouvrage. Les ouvrages hydrauliques sont composés d'ouvrages hydrauliques élémentaires. Vous pouvez combiner les lois de plusieurs ouvrages hydrauliques élémentaires pour créer votre ouvrage. Pour ce seuil, nous n'avons besoin que d'un ouvrage hydraulique élémentaire de type déversoir. Cliquez sur \includegraphics[width=0.5cm]{img/gtk_add.png} pour ajouter un nouvel ouvrage hydraulique élémentaire, donnez-lui le type \textit{seuil} et configurez-le comme suit :
+
+
+\begin{center}
+\includegraphics[width=15cm]{img/seuil.png}
+\par\end{center}
+
+
+Retournez à la fenêtre \textit{Ouvrages hydrauliques}.
+
+Sélectionnez le pont RS101 et cliquez sur \includegraphics[width=0.5cm]{"img/edit.png"} pour éditer les lois de cet ouvrage. Un pont peut être modélisé comme une combinaison d'un orifice pour l'écoulement sous le pont et d'un déversoir pour l'écoulement au-dessus du pont. Créez deux ouvrages hydrauliques élémentaires et définissez-les comme suit :
+
+\begin{center}
+\includegraphics[width=15cm]{img/seuilRS101.png}
+
+\includegraphics[width=15cm]{img/orificeRS101.png}
+\par\end{center}
+
+
+Revenez à la fenêtre \textit{Ouvrages hydrauliques} et appliquez la même procédure pour le pont de Thivencelle :
+
+\begin{center}
+\includegraphics[width=15cm]{img/orificeThivencelle.png}
+
+\includegraphics[width=15cm]{img/seuilThivencelle.png}
+\par\end{center}
+
+
+Vous pouvez maintenant fermer les fenêtres \textit{Ouvrages hydrauliques}.
+
+\section{Paramètres du solveur}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Exécuter] => [Parameters numériques des solveurs]}.
+Dans la fenêtre \textit{Paramètres du solveur}, sélectionnez l'onglet \textit{Mage v8}. Réglez les paramètres du solveur comme suit :
+
+
+\begin{center}
+\includegraphics[width=15cm]{img/param.png}
+\par\end{center}
+
+
+Fermer la fenêtre \textit{Paramètres du solveur}.
+
+\section{Lancer la simulation}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Exécuter] => [Lancer le solveur]}.
+Sélectionnez \textit{Defaut-Mage - (Mage8)} et cliquez sur le bouton \textit{Exécuter}.
+Deux fenêtres s'ouvrent : la fenêtre \textit{check list} et la fenêtre \textit{Log du solveur}.
+La fenêtre \textit{Check list} donne quelques indications sur la validité de votre modèle, et la fenêtre \textit{Log du solveur} affiche les résultats du solveur.
+À partir de la fenêtre \textit{Log du solveur}, vous pouvez réexécuter le calcul, et vous pouvez cliquer sur le bouton \textit{Résultats} pour ouvrir la fenêtre \textit{Résultats}.
+
+\section{Visualiser les résultats}
+
+il est aussi possible d'ouvrir la fenêtre \textit{Résultats} si vous avez fermé la fenêtre \textit{Log du solveur}, en cliquant sur \texttt{[Résultats] => [Visualiser les derniers résultats]} à partir de la fenêtre principale. Le panneau supérieur vous permet de sélectionner le bief, le panneau inférieur gauche vous permet de sélectionner une section en travers dans ce bief. Les trois diagrammes sur la droite montrent le bief et la section en travers de la même manière que dans la fenêtre \textit{Géométrie}. Vous pouvez utiliser le curseur du bas pour visualiser la côte de l'eau à différents pas de temps.
+Pour visualiser le débit, passez à l'onglet \textit{Hydrogramme}.
+Pour créer des tracés 2D personnalisés, cliquez sur le bouton \includegraphics[width=0.5cm]{img/gtk_add.png} en haut à gauche de la fenêtre. Sélectionnez les valeurs que vous voulez sur les axes $X$ et $Y$ et cliquez sur \textit{OK}.
+Vous pouvez maintenant voir un nouvel onglet avec le tracé 2D personnalisé dans le panneau droit de la fenêtre \textit{Results}.
+
+
+
+\pagebreak{}
+\end{document}
+

doc/users/Tuto1/step-by-step.tex

@@ -25,7 +25,7 @@
 }
 
 \begin{document}
-\includegraphics[width=5cm]{Logo-INRAE_Transparent.png}
+\includegraphics[width=5cm]{img/Logo-INRAE_Transparent.png}
 
 ~
 
@@ -58,7 +58,7 @@ using Pamhyr2
 \par\end{center}{\large \par}
 
 \begin{center}
-Riverly, river hydraulics
+RiverLy, river hydraulics
 \par\end{center}
 
 ~
@@ -75,8 +75,9 @@ Riverly, river hydraulics
 
 \begin{center}
 \begin{tabular}{lll}
-Autors : & Pierre-Antoine Rouby & pierre-antoine.rouby@inrae.fr\tabularnewline
-& Théophile TERRAZ & theophile.terraz@inrae.fr\tabularnewline
+Authors : & Pierre-Antoine Rouby & pierre-antoine.rouby@inrae.fr\tabularnewline
+& Théophile Terraz & theophile.terraz@inrae.fr\tabularnewline
+& Lionel Pénard & lionel.penard@inrae.fr\tabularnewline
 \end{tabular}
 \par\end{center}
 
@@ -92,17 +93,17 @@ Autors : & Pierre-Antoine Rouby & pierre-antoine.rouby@inrae.fr\tabularnewline
 
 \pagebreak{}
 
-\section{Introduction}
-
-TODO
-
-\pagebreak{}
+% \section{Introduction}
+%
+% TODO
+%
+% \pagebreak{}
 
 \section{Install Pamhyr2}
 
 Pamhyr2 can be downloaded from \url{https://gitlab.irstea.fr/theophile.terraz/pamhyr}.
 \begin{center}
-\includegraphics[width=15cm]{dl.png}
+\includegraphics[width=15cm]{img/dl.png}
 \par\end{center}
 
 Use the GNU Linux or the Windows download button depending on your system. On windows, launch the installer. On Linux, unpack the archive and launch Pamhyr2.
@@ -113,10 +114,10 @@ Use the GNU Linux or the Windows download button depending on your system. On wi
 On the main windows, click on \texttt{[Files] => [New Study]} to create a new study.
 
 Click on \texttt{[River Network] => [Edit River Network]} to create the reaches of your river. In this window, you must define an oriented graph that represents the reaches of your river network: the edges are the reaches and the nodes are either upstream boundary conditions, downstream boundary conditions or junctions.
-Press the \includegraphics[width=0.5cm]{gtk_add.png} to enter the \textit{add} mode. Create two nodes by clicking in the grey zone of the window, and create a link by clicking again on each node. press \includegraphics[width=0.5cm]{gtk_add.png} again to exit the \textit{add} mode. You created your first reach, with an upstream node and a downstream node. In the lower part of the \textit{Edit River Network} window you can rename the nodes and the reaches. As the reach you created is automaticaly selected, all the next steps will apply to this reach. The window should look like that:
+Press the \includegraphics[width=0.5cm]{img/gtk_add.png} to enter the \textit{add} mode. Create two nodes by clicking in the grey zone of the window, and create a link by clicking again on each node. press \includegraphics[width=0.5cm]{img/gtk_add.png} again to exit the \textit{add} mode. You created your first reach, with an upstream node and a downstream node. In the lower part of the \textit{Edit River Network} window you can rename the nodes and the reaches. As the reach you created is automaticaly selected, all the next steps will apply to this reach. The window should look like that:
 
 \begin{center}
-\includegraphics[width=15cm]{network.png}
+\includegraphics[width=15cm]{img/network.png}
 \par\end{center}
 
 Close the \textit{Edit River Network} window.
@@ -127,29 +128,29 @@ Close the \textit{Edit River Network} window.
 Click on \texttt{[Geometry] => [Edit Geometry]} to define the geometry of the selected bief. Click on the \texttt{[Import]} button and select the file \texttt{Data/Bief\_1.st}. You should see:
 
 \begin{center}
-\includegraphics[width=15cm]{Geo.png}
+\includegraphics[width=15cm]{img/Geo.png}
 \par\end{center}
 
 On the left panel is a list of all the cross sections with their name and longitudinal abscisa. In the top left plot you can see the top view of the river, on the top right panel the longitudinal cross-section of the river and in the bottom plot you can see the selected cross-section (blue) along with the next one (dashed purple) and previous one (dashed black). You can move in the section list using the slider at the very right of the window.
 
-You can edit the selected cross section by clicking on the \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} icon.
+You can edit the selected cross section by clicking on the \includegraphics[width=0.5cm]{"img/edit.png"} icon.
 
 select the cross section named \textit{PontRD101m} and open the edition window. You should see:
 
 \begin{center}
-\includegraphics[width=15cm]{editsect.png}
+\includegraphics[width=15cm]{img/editsect.png}
 \par\end{center}
 
 On the left panel is the list of all the points of the section, with their coordinates, their name and their transversal absisa. The Z coordinate of the highest point is written in blue and the lowest in red. Points can have a name. If a point with the same name exists in every section in a reach, it forms a longitudinal line. For example, here we have \textit{rg} and \textit{rd} which represent the left bank and the right bank of the main chanel.
 
-On the plot is a projection of the cross section. You can use \texttt{[ctrl + click]} to select a point in the plot. For now we don't have to change anything. You can close the cross section edition window and the geometry edition window.
+On the plot is a projection of the cross section. You can use \texttt{[ctrl + click]} to select a point in the plot and \texttt{[shift + click]} to select a water line and visualize usefull geometric data. You can close the cross section edition window and the geometry edition window.
 
 \section{Edit the boundary conditions}
 
 From the main window, click on \texttt{[Hydraulics] => [Boundary conditions and punctual contributions]}.You should see:
 
 \begin{center}
-\includegraphics[width=15cm]{boundary.png}
+\includegraphics[width=15cm]{img/boundary.png}
 \par\end{center}
 
  Use the \textit{add} button on the top left of the window to add a liquid boundary condition.
@@ -158,24 +159,25 @@ From the main window, click on \texttt{[Hydraulics] => [Boundary conditions and
  Select the \textit{Type} cell and use the combo box to put a Q(t) law.
  Select the \textit{Node} cell and atribute this condition to the upstream node.
  Names of the nodes are recalled in network in the right panel.
- Now select the whole line and click on the edit button \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"}. You opened the \textit{Edit Boundary Conditions} window.
+ Now select the whole line and click on the edit button \includegraphics[width=0.5cm]{"img/edit.png"}. You opened the \textit{Edit Boundary Conditions} window.
  On a text editor, open the \texttt{Data/Fevrier\_2002.txt} file. Copy the content of the file (for example with \textit{ctrl+a ctrl+c}) and paste it in the left panel of the \textit{Edit Boundary Conditions} window with \textit{ctrl+v}. You can now see the flow discharge curve:
 
 \begin{center}
-\includegraphics[width=15cm]{fev2002.png}
+\includegraphics[width=15cm]{img/fev2002.png}
 \par\end{center}
 
-Close this window. Go back on the \textit{Boundary Conditions} window. Add a new line, give it a name, give it the textit{Z(T)} type and associate it to the downstream node of the network. Open the \textit{Edit Boundary Conditions} window (\includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"}). Add two lines. In the first one, enter time: 0.00.00 and Z: 15.000.
+Close this window. Go back on the \textit{Boundary Conditions} window. Add a new line, give it a name, give it the textit{Z(T)} type and associate it to the downstream node of the network. Open the \textit{Edit Boundary Conditions} window (\includegraphics[width=0.5cm]{"img/edit.png"}). Add two lines. In the first one, enter time: 0.00.00 and Z: 15.000.
 On the second one, time: 1.00.00 and Z: 15.000. It creates a constant downstream water elevation. For the computaion, Mage will extrapolate continuously the water elevation, that's why we only need to define one hour.
 You can close the the \textit{Edit Boundary Conditions} and the \textit{Boundary Conditions} window.
 
 \section{Create initial conditions}
 
 From the main window, click on \texttt{[Hydraulics] => [Initial conditions]}.
-Click on \texttt{Generate minimal height} and enter a height of 2 meters in the pop-up window to generate an initial water height condition that verify the folowing conditions: a water height of at least 2 meters and a decreasing water surface elevation from upstream to downstream. You should see:
+If you don't know the initial conditions in water elevation and flow discharge of the river, you can use \texttt{[Generate minimal height]} or \texttt{[Generate from discharge]} buttons to let Pamhyr2 estimate an initial condition using the Manning-Strickler formula.
+Click on \texttt{[Generate from discharge]} and enter a discharge of $4 m^3$ in the pop-up window to generate an initial water height condition based on the Manning-Strickler formula and a uniform discharge of $4 m^3$. You should see:
 
 \begin{center}
-\includegraphics[width=15cm]{ic.png}
+\includegraphics[width=15cm]{img/ic.png}
 \par\end{center}
 
 Close the \textit{Initial conditions} window.
@@ -184,18 +186,83 @@ Close the \textit{Initial conditions} window.
 \section{Edit friction coefficients}
 
 From the main window, click on \texttt{[Hydraulics] => [Edit friction]}.
-You fist have to define sets of Strickler coefficients. Click on \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} to open the \textit{Strickler} window. Here you can create couples of Strickler coefficients, the first one for the minor bed, the second one for the medium bed. Click on \textit{add} four times  to create four new couple. Give them the folowing values:
+You fist have to define sets of Strickler coefficients. Click on \includegraphics[width=0.5cm]{"img/edit.png"} to open the \textit{Strickler} window. Here you can create couples of Strickler coefficients, the first one for the minor bed, the second one for the medium bed. Click on \textit{add} four times to create four new couple. Give them the folowing values:
 
 \begin{center}
-\includegraphics[width=15cm]{K.png}
+\includegraphics[width=15cm]{img/K.png}
 \par\end{center}
 
-Close the \textit{Strickler} window. On the \textit{Edit friction} window, add four lines with the button \includegraphics[width=0.5cm]{gtk_add.png} to create fous friction zones. Each zone is defined by a \textit{begin} and \textit{end} PK and a \textit{begin} and \textit{end} Strickler couple. The strickler coefficient couples inside a zone are interpolated from the \textit{begin} and \textit{end} couples. In our case, we will use constant coefficients per zone. Set the zones as follow:
+Close the \textit{Strickler} window. On the \textit{Edit friction} window, add four lines with the button \includegraphics[width=0.5cm]{img/gtk_add.png} to create four friction zones. Each zone is defined by a \textit{begin} and \textit{end} KP and a \textit{begin} and \textit{end} Strickler couple. The strickler coefficient couples inside a zone are interpolated from the \textit{begin} and \textit{end} couples. In our case, we will use constant coefficients per zone. Set the zones as follow:
 
 \begin{center}
-\includegraphics[width=15cm]{frictions.png}
+\includegraphics[width=15cm]{img/frictions.png}
 \par\end{center}
 
+The selected zone is highlighted in blue. Close the \textit{Edit friction} window.
+
+
+\section{Model hydraulic structures}
+
+Sometimes there can be cross-sections in which Shallow water equations can not be used to model the water flow. In that case, we have to define an other law to link the water elevation and the flow discharge. This is the case, for example, under bridges when the water elevation is too high, leading to a flow in charge. Pamhyr2 enables to define various hydraulic structures with laws that can be parametrized. In our case, a weir and two bridges have to be represented as hydraulic structures.
+From the main window, click on \texttt{[Hydraulics] => [Hydraulic structures]} to open the hydraulic structures window. Click tree times on the \includegraphics[width=0.5cm]{img/gtk_add.png} button to create three hydraulic structures. Each structure can have a name and must have a reach and a KP. Set them as follow:
+
+\begin{center}
+\includegraphics[width=15cm]{img/hs.png}
+\par\end{center}
+
+Select the downstream weir and click on \includegraphics[width=0.5cm]{"img/edit.png"} to edit the laws of this structure. Hydraulic structures are composed of basic hydraulic structures. You can combine the laws of several basic hydraulic structures to setup your structure. For this weir, we only need a weir basic hydraulic structure. Click on \includegraphics[width=0.5cm]{img/gtk_add.png} to add a new basic hydraulic structure, give it the \textit{weir} type and set it up as folow:
+
+\begin{center}
+\includegraphics[width=15cm]{img/seuil.png}
+\par\end{center}
+
+Go back to the \textit{hydraulic structures} window.
+
+Select the RS101 bridge and click on \includegraphics[width=0.5cm]{"img/edit.png"} to edit the laws of this structure. A bridge can be modeled as a combination of an orifice for the flow under the bridge and a weir for the flow over the bridge. Create two basic hydraulic structures and set them as folow:
+
+\begin{center}
+\includegraphics[width=15cm]{img/seuilRS101.png}
+
+\includegraphics[width=15cm]{img/orificeRS101.png}
+\par\end{center}
+
+Go back to the \textit{hydraulic structures} window and aply the same procedure for the Thivencelle bridge:
+
+\begin{center}
+\includegraphics[width=15cm]{img/orificeThivencelle.png}
+
+\includegraphics[width=15cm]{img/seuilThivencelle.png}
+\par\end{center}
+
+You can now close the \textit{hydraulic structures} windows.
+
+\section{Solver parameters}
+
+From the main window, click on \texttt{[Execute] => [Numerical parameters for solvers]}.
+In the window \textit{solver parameters} select the \textit{Mage v8} tab. Set the solver parameters as follow:
+
+\begin{center}
+\includegraphics[width=15cm]{img/param.png}
+\par\end{center}
+
+Close the \textit{solver parameters} window.
+
+\section{Run the simulation}
+
+From the main window, click on \texttt{[Execute] => [Run solver]}.
+Select \textit{Defaut-Mage - (Mage8)} anc click on the \textit{Run} button.
+It will open two windows: the \textit{Check list} window and the \textit{Solver log} window.
+The \textit{Check list} window gives som hints about the validity of your model, and the \textit{Solver log} window displays the outputs of the solver.
+From the \textit{Solver log} window you can re-run the computation, and from the textit{Solver log} window you can click on the \textit{Results} button to open the \textit{Results} window.
+
+\section{Visualize the results}
+
+If you closed the \textit{Solver log} window, you can click on \texttt{[Results] => [Visualize last results]} from the main window to open the \textit{Results} window. The top lets panel let you select your reach, the bottom left panel lets you select a cross-section in that reach. the three plots on the right show the reach and the cross-section the same way than in the \textit{Geometry} window. You can use the bottom slider to visualize the water elevation at different timesteps.
+To visualize the flow discharge, switch to the \textit{Hydrograph} tab.
+To create custom 2D plots, click on the \includegraphics[width=0.5cm]{img/gtk_add.png} button on the top left of the window. Select the values you want on the $X$ and $Y$ axis and click on \textit{OK}.
+You can now see a new tab with the custom 2D plot in the right panel of the \textit{Results} window.
+
+
 \pagebreak{}
 \end{document}
 

packages/make-windows-dir.bat

@@ -42,7 +42,8 @@ rem MAGE
 mkdir pamhyr\mage
 copy /y ..\mage-windows\mage.exe pamhyr\mage\
 copy /y ..\mage-windows\mage_extraire.exe pamhyr\mage\
-copy /y ..\mage-windows\mailleurPF.exe pamhyr\mage\
+copy /y ..\mage-windows\mailleurTT.exe pamhyr\mage\
+copy /y ..\mage-windows\libbief.dll pamhyr\mage\
 
 rem Copy tests_cases
 mkdir pamhyr\tests_cases
@@ -52,10 +53,24 @@ copy /y ..\tests_cases\Saar\Saar.pamhyr pamhyr\tests_cases\Saar\
 rem Documentations
 mkdir pamhyr\doc
 mkdir pamhyr\doc\images
-copy /y ..\doc\users\documentation.pdf pamhyr\doc\Pamhyr2-users.pdf
+rem copy /y ..\doc\users\documentation.pdf pamhyr\doc\Pamhyr2-users.pdf
 copy /y ..\doc\dev\documentation.pdf pamhyr\doc\Pamhyr2-dev.pdf
-copy /y ..\doc\users\documentation.html pamhyr\doc\Pamhyr2-users.html
+copy /y ..\doc\mage8.pdf pamhyr\doc\mage8.pdf
+rem copy /y ..\doc\users\documentation.html pamhyr\doc\Pamhyr2-users.html
 copy /y ..\doc\dev\documentation.html pamhyr\doc\Pamhyr2-dev.html
 copy /y ..\doc\users\images\* pamhyr\doc\images
 copy /y ..\doc\dev\images\* pamhyr\doc\images
 copy /y ..\doc\images\* pamhyr\doc\images
+
+rem Tuto
+mkdir pamhyr\doc\Tuto1\
+mkdir pamhyr\doc\Tuto1\data
+copy /y ..\doc\users\Tuto1\Hogneau_Engees2022.pdf pamhyr\doc\Tuto1\Hogneau_Engees2022.pdf
+copy /y ..\doc\users\Tuto1\step-by-step.pdf pamhyr\doc\Tuto1\Tuto1-en.pdf
+copy /y ..\doc\users\Tuto1\pas-a-pas.pdf pamhyr\doc\Tuto1\Tuto1-fr.pdf
+copy /y ..\doc\users\Tuto1\*.pamhyr pamhyr\doc\Tuto1\
+copy /y ..\doc\users\Tuto1\data\* pamhyr\doc\Tuto1\data\
+
+rem TP charriage
+mkdir pamhyr\doc\TP_charriage
+copy /y ..\doc\users\TP_charriage\ pamhyr\doc\TP_charriage

src/Checker/Mage.py

@@ -24,6 +24,7 @@ from tools import flatten, timer
 from PyQt5.QtCore import QCoreApplication
 
 from Checker.Checker import AbstractModelChecker, STATUS
+from Checker.Study import StudyGeometryChecker
 
 _translate = QCoreApplication.translate
 
@@ -195,3 +196,51 @@ class MageNetworkGraphChecker(AbstractModelChecker):
         self._summary = summary
         self._status = status
         return True
+
+
+class MageGeometryGuideLineChecker(StudyGeometryChecker):
+    def __init__(self):
+        super(MageGeometryGuideLineChecker, self).__init__()
+
+        self._name = _translate("Checker", "Mage geometry guide line checker")
+        self._description = _translate(
+            "Checker",
+            "Check if exists geometry guide line is correctly defined \
+for each reaches of the study"
+        )
+        self._reachs = []
+
+    def run(self, study):
+        ok = super(MageGeometryGuideLineChecker, self).run(study)
+
+        if not ok:
+            return ok
+
+        river = study.river
+        edges = river.enable_edges()
+
+        gls = []
+
+        for edge in edges:
+            comp, incomp = edge.reach.compute_guidelines()
+            if len(incomp) != 0:
+                self._status = STATUS.WARNING
+                self._summary = "incomplete_guideline"
+                return False
+
+            gls.append(comp)
+
+            profiles = edge.reach.profiles
+            for profile in profiles:
+                if not profile.has_standard_named_points():
+                    self._status = STATUS.WARNING
+                    self._summary = "no_standard_guileline_defined"
+                    return False
+
+        for gl in gls[1:]:
+            if len(gls[0].symmetric_difference(gl)) != 0:
+                self._status = STATUS.WARNING
+                self._summary = "no_all_reaches_do_not_have_same_defined"
+                return False
+
+        return ok

src/Checker/Study.py

@@ -82,15 +82,15 @@ class StudyGeometryChecker(AbstractModelChecker):
             self._summary = "no_river_found"
             return False
 
-        edges = list(filter(lambda e: e.is_enable(), river.edges()))
+        edges = river.enable_edges()
         if len(edges) == 0:
             self._status = STATUS.ERROR
             self._summary = "no_reach_defined"
             return False
 
         for edge in edges:
-            if edge.is_enable() and len(edge.reach.profiles) < 3:
-                summary = f"no_geometry_defined"
+            if len(edge.reach.profiles) < 2:
+                summary = "no_geometry_defined"
                 status = STATUS.ERROR
                 ok = False
                 self._reachs.append(edge)

src/Meshing/AMeshingTool.py

@@ -0,0 +1,27 @@
+# AMeshingTool.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+from Model.Except import NotImplementedMethodeError
+
+
+class AMeshingTool(object):
+    def __init__(self):
+        super(AMeshingTool, self).__init__()
+
+    def meshing(self, reach, **kwargs):
+        raise NotImplementedMethodeError(self, self.meshing)

src/Meshing/Mage.py

@@ -0,0 +1,324 @@
+# Mage.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+import os
+import logging
+import tempfile
+
+from ctypes import (
+    cdll,
+    byref, Structure,
+    c_char_p, c_wchar_p,
+    create_string_buffer,
+    POINTER, c_void_p,
+    c_int, c_double, c_bool
+)
+from PyQt5.QtCore import QProcess
+
+from tools import logger_color_red, logger_color_reset
+from Meshing.AMeshingTool import AMeshingTool
+
+logger = logging.getLogger()
+
+
+class MeshingWithMage(AMeshingTool):
+    def __init__(self):
+        super(MeshingWithMage, self).__init__()
+
+        self._init_bief_lib()
+
+    def _init_bief_lib(self):
+        self._bief_lib = cdll.LoadLibrary(self._lib_path())
+
+        self._init_c_init_bief_from_geo_file()
+        self._init_c_get_nb_sections()
+        self._init_c_get_nb_points_section()
+        self._init_c_set_bief_name()
+        self._init_c_st_to_m_compl()
+        self._init_c_interpolate_profils_pas_transversal()
+        self._init_c_purge()
+        self._init_c_output_bief()
+
+    @classmethod
+    def _lib_path(cls):
+        ext = "so" if os.name == "posix" else "dll"
+
+        return os.path.abspath(
+            os.path.join(
+                os.path.dirname(__file__),
+                "..", "..", "..", "mage", f"libbief.{ext}"
+            )
+        )
+
+    def _init_c_init_bief_from_geo_file(self):
+        self._c_init_bief_from_geo_file = getattr(
+            self._bief_lib, 'c_init_bief_from_geo_file'
+        )
+        self._c_init_bief_from_geo_file.argtypes = [
+            c_char_p, POINTER(c_int), POINTER(c_int)
+        ]
+        self._c_init_bief_from_geo_file.restype = None
+
+    def _init_c_get_nb_sections(self):
+        self._c_get_nb_sections = getattr(self._bief_lib, 'c_get_nb_sections')
+        self._c_get_nb_sections.argtypes = [POINTER(c_int)]
+        self._c_get_nb_sections.restype = None
+
+    def _init_c_get_nb_points_section(self):
+        self._c_get_nb_points_section = getattr(
+            self._bief_lib, 'c_get_nb_points_section'
+        )
+        self._c_get_nb_points_section.argtypes = [
+            POINTER(c_int), POINTER(c_int)
+        ]
+        self._c_get_nb_points_section.restype = None
+
+    def _init_c_set_bief_name(self):
+        self._c_set_bief_name = getattr(self._bief_lib, 'c_set_bief_name')
+        self._c_set_bief_name.argtypes = [c_char_p]
+        self._c_set_bief_name.restype = None
+
+    def _init_c_st_to_m_compl(self):
+        self._c_st_to_m_compl = getattr(self._bief_lib, 'c_st_to_m_compl')
+        self._c_st_to_m_compl.argtypes = [POINTER(c_int), c_char_p, c_char_p]
+        self._c_st_to_m_compl.restype = None
+
+    def _init_c_interpolate_profils_pas_transversal(self):
+        self._c_interpolate_profils_pas_transversal = getattr(
+            self._bief_lib, 'c_interpolate_profils_pas_transversal'
+        )
+        self._c_interpolate_profils_pas_transversal.argtypes = [
+            POINTER(c_int), POINTER(c_int),
+            c_char_p, c_char_p,
+            POINTER(c_double), POINTER(c_bool),
+            POINTER(c_int), POINTER(c_bool)
+        ]
+        self._c_interpolate_profils_pas_transversal.restype = None
+
+    def _init_c_purge(self):
+        self._c_purge = getattr(self._bief_lib, 'c_purge')
+        self._c_purge.argtypes = None
+        self._c_purge.restype = None
+
+    def _init_c_output_bief(self):
+        self._c_output_bief = getattr(self._bief_lib, 'c_output_bief')
+        self._c_output_bief.argtypes = [c_char_p]
+        self._c_output_bief.restype = None
+
+    #####################
+    # Binding functions #
+    #####################
+
+    def init_bief_from_geo_file(self, name, with_charriage, with_water):
+        cname = create_string_buffer(name.encode())
+        self._c_init_bief_from_geo_file(
+            cname,
+            byref(c_int(with_charriage)),
+            byref(c_int(with_water))
+        )
+
+    def get_nb_sections(self):
+        nb_sections = c_int(0)
+        self._c_get_nb_sections(byref(nb_sections))
+        return nb_sections.value
+
+    def get_nb_points_section(self, section):
+        nb_points = c_int(0)
+        self._c_get_nb_points_section(
+            byref(c_int(section)), byref(nb_points)
+        )
+        return nb_points.value
+
+    def set_bief_name(self, name):
+        cname = create_string_buffer(name.encode())
+        self._c_set_bief_name(cname)
+
+    def st_to_m_compl(self, npoints, tag1='   ', tag2='   '):
+        cnpoints = c_int(npoints)
+        ctag1 = create_string_buffer(tag1.encode())
+        ctag2 = create_string_buffer(tag2.encode())
+
+        self._c_st_to_m_compl(byref(cnpoints), ctag1, ctag2)
+
+    def interpolate_profils_pas_transversal(self, limite1, limite2,
+                                            directrice1, directrice2,
+                                            pas, lplan=False,
+                                            lm=3, lineaire=False):
+        climite1 = c_int(limite1)
+        climite2 = c_int(limite2)
+        cpas = c_double(pas)
+        clplan = c_bool(lplan)
+        clm = c_int(lm)
+        clineaire = c_bool(lineaire)
+        cdirectrice1 = create_string_buffer(directrice1.encode())
+        cdirectrice2 = create_string_buffer(directrice2.encode())
+
+        self._c_interpolate_profils_pas_transversal(
+            byref(climite1), byref(climite2),
+            cdirectrice1, cdirectrice2,
+            byref(cpas), byref(clplan),
+            byref(clm), byref(clineaire)
+        )
+
+    def output_bief(self, name):
+        cname = create_string_buffer(name.encode())
+        self._c_output_bief(cname)
+
+    ###########
+    # Meshing #
+    ###########
+
+    def meshing(self, reach, step: float = 50):
+        if reach is None or len(reach.profiles) == 0:
+            return reach
+
+        with tempfile.TemporaryDirectory() as tmp:
+            st_file = self.export_reach_to_st(reach, tmp)
+            m_file = st_file.rsplit(".ST", 1)[0] + ".M"
+
+            self.load_st_file(st_file)
+
+            ns, npts_max = self.get_reach_stat()
+
+            gl = reach.compute_guidelines()
+
+            # we make sure that the lines are in the left-to-right order
+            guide_list = [
+                x.name
+                for x in reach.profiles[0].named_points()
+                if x.name in gl[0]
+            ]
+
+            self.complete_cross_section(guide_list)
+            self.interpolate_cross_section(ns, step)
+            self.purge()
+
+            self.export_to_m(m_file)
+
+            self.import_m_file(reach, m_file)
+            return reach
+
+    def export_reach_to_st(self, reach, tmp):
+        tmp_st = os.path.join(tmp, "meshing.ST")
+
+        logger.debug(f"meshing: Export ST to {tmp_st}")
+
+        reach.export_reach(tmp_st)
+        return tmp_st
+
+    def load_st_file(self, st):
+        self.init_bief_from_geo_file(st, 0, 0)
+        self.set_bief_name("tmp")
+
+    def get_reach_stat(self):
+        ns = self.get_nb_sections()
+        npts_max = max(
+            map(
+                lambda i: self.get_nb_points_section(i),
+                range(1, ns)
+            )
+        )
+
+        return ns, npts_max
+
+    def complete_cross_section(self, gl=[]):
+        gl1 = ["un"] + gl
+        gl2 = gl + ["np"]
+
+        for gls in zip(gl1, gl2):
+            self.st_to_m_compl(0, gls[0], gls[1])
+
+    def interpolate_cross_section(self, ns, step: float):
+        self.interpolate_profils_pas_transversal(
+            1, ns,
+            'un', 'np',
+            step
+        )
+
+    def purge(self):
+        self._c_purge()
+
+    def export_to_m(self, m):
+        self.output_bief(m)
+
+    def import_m_file(self, reach, m):
+        reach.purge()
+
+        logger.debug(f"meshing: Import geometry from {m}")
+        reach.import_geometry(m)
+
+
+class MeshingWithMageMailleurTT(AMeshingTool):
+    def __init__(self):
+        super(MeshingWithMageMailleurTT, self).__init__()
+
+    @classmethod
+    def _exe_path(cls):
+        ext = "" if os.name == "posix" else ".exe"
+
+        return os.path.abspath(
+            os.path.join(
+                os.path.dirname(__file__),
+                "..", "..", "..", "mage", f"mailleurTT{ext}"
+            )
+        )
+
+    ###########
+    # Meshing #
+    ###########
+
+    def meshing(self, reach, step: float = 50):
+        if reach is None or len(reach.profiles) == 0:
+            return reach
+
+        with tempfile.TemporaryDirectory() as tmp:
+            logger.debug(f"temp file: {tmp}")
+            st_file = self.export_reach_to_st(reach, tmp)
+            m_file = st_file.rsplit(".ST", 1)[0] + ".M"
+
+            proc = QProcess()
+            proc.setWorkingDirectory(tmp)
+
+            logger.debug(f"mailleurTT '{st_file}, {m_file}, {str(step)}'")
+            proc.start(
+                self._exe_path(), [st_file, m_file, str(step)]
+            )
+            proc.waitForFinished()
+
+            errors = proc.readAllStandardError()
+            if len(errors) != 0:
+                logger.error(
+                    f"{logger_color_red()}{errors}{logger_color_reset()}"
+                )
+            else:
+                self.import_m_file(reach, m_file)
+            return reach
+
+    def export_reach_to_st(self, reach, tmp):
+        tmp_st = os.path.join(tmp, "meshing.ST")
+
+        logger.debug(f"meshing: Export ST to {tmp_st}")
+
+        reach.export_reach(tmp_st)
+        return tmp_st
+
+    def import_m_file(self, reach, m):
+        reach.purge()
+
+        logger.debug(f"meshing: Import geometry from {m}")
+        reach.import_geometry(m)

src/Meshing/__init__.py

@@ -0,0 +1,17 @@
+# __init__.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-

src/Meshing/test_Meshing.py

@@ -0,0 +1,37 @@
+# test_Model.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+import warnings
+import tempfile
+
+from Model.Saved import SavedStatus
+from Model.Study import Study
+from Model.River import River
+
+from Meshing.Mage import MeshingWithMage
+
+mage_mesher = os.path.exists(MeshingWithMage._lib_path())
+
+
+class MeshingTestCase(unittest.TestCase):
+    @unittest.skipIf(not mage_mesher, "libbief is not available")
+    def test_create_meshingtool_mage(self):
+        mesher = MeshingWithMage()
+        self.assertNotEqual(mesher, None)

src/Model/Except.py

@@ -179,3 +179,38 @@ class ClipboardFormatError(ExeceptionWithMessageBox):
 
     def message(self):
         return self.msg
+
+
+class ExternFileMissingError(ExeceptionWithMessageBox):
+    def __init__(self, module="mage", filename="libbief", path="??/libbief.so",
+                 src_except=None):
+        super(ExternFileMissingError, self).__init__(
+            title=_translate(
+                "Exception", "External file dependence is missing"
+            )
+        )
+
+        self.msg = _translate(
+            "Exception",
+            "'@file' is missing for module @module:\n'@path'"
+        )
+        self.msg = self.msg.replace("@file", filename)
+        self.msg = self.msg.replace("@module", module)
+        self.msg = self.msg.replace("@path", path)
+
+        if src_except is not None:
+            self.msg = self.msg + "\n\n" + f"Exception: {src_except}"
+
+        self.alert()
+
+    def __str__(self):
+        return self.msg
+
+    def header(self):
+        return _translate("Exception", "External file dependence is missing")
+
+    def short_message(self):
+        return _translate("Exception", "External file dependence is missing")
+
+    def message(self):
+        return self.msg

src/Model/Friction/Friction.py

@@ -16,10 +16,14 @@
 
 # -*- coding: utf-8 -*-
 
+import logging
+
 from tools import trace, timer
 
 from Model.Tools.PamhyrDB import SQLSubModel
 
+logger = logging.getLogger()
+
 
 class Friction(SQLSubModel):
     def __init__(self, name: str = "", status=None):
@@ -60,7 +64,8 @@ class Friction(SQLSubModel):
     @classmethod
     def _db_load(cls, execute, data=None):
         new = []
-        reach = data["parent"]  # Reach object
+
+        reach = data["reach"]
         status = data["status"]
         stricklers = data["stricklers"].stricklers
 
@@ -69,14 +74,18 @@ class Friction(SQLSubModel):
             f"FROM friction WHERE reach = {reach.id}"
         )
 
-        for _ in table:
-            new.append(None)
-
         for row in table:
             ind = row[0]
             # Get stricklers
-            bs = next(filter(lambda s: s.id == row[3], stricklers))
-            es = next(filter(lambda s: s.id == row[4], stricklers))
+            if int(row[3]) == -1:
+                bs = None
+            else:
+                bs = next(filter(lambda s: s.id == row[3], stricklers))
+
+            if int(row[4]) == -1:
+                es = None
+            else:
+                es = next(filter(lambda s: s.id == row[4], stricklers))
 
             # Create friction
             sec = cls(status=status)
@@ -86,10 +95,21 @@ class Friction(SQLSubModel):
             sec.begin_strickler = bs
             sec.end_strickler = es
 
-            yield ind, sec
+            new.append((ind, sec))
+
+        return new
 
     def _db_save(self, execute, data=None):
         ind = data["ind"]
+
+        b_s_id = -1
+        e_s_id = -1
+
+        if self._begin_strickler is not None:
+            b_s_id = self._begin_strickler.id
+        if self._end_strickler is not None:
+            e_s_id = self._end_strickler.id
+
         execute(
             "INSERT INTO " +
             "friction(ind, begin_kp, end_kp, " +
@@ -97,7 +117,7 @@ class Friction(SQLSubModel):
             "VALUES (" +
             f"{ind}, {self._begin_kp}, {self._end_kp}, " +
             f"{self._edge.id}, " +
-            f"{self._begin_strickler.id}, {self._end_strickler.id}" +
+            f"{b_s_id}, {e_s_id}" +
             ")"
         )
 
@@ -116,6 +136,10 @@ class Friction(SQLSubModel):
     def edge(self):
         return self._edge
 
+    @property
+    def reach(self):
+        return self._edge
+
     @edge.setter
     def edge(self, edge):
         self._edge = edge

src/Model/Friction/FrictionList.py

@@ -50,10 +50,12 @@ class FrictionList(PamhyrModelList):
     def _db_load(cls, execute, data=None):
         new = cls(status=data['status'])
 
-        new._lst = Friction._db_load(
+        ilst = Friction._db_load(
             execute, data
         )
 
+        new._lst = list(map(lambda x: x[1], sorted(ilst)))
+
         return new
 
     def _db_save(self, execute, data=None):

src/Model/Geometry/PointXYZ.py

@@ -116,7 +116,7 @@ class PointXYZ(Point, SQLSubModel):
         sl = self._sl.id if self._sl is not None else -1
 
         sql = (
-            "INSERT OR REPLACE INTO " +
+            "INSERT INTO " +
             "geometry_pointXYZ(ind, name, x, y, z, profile, sl) " +
             "VALUES (" +
             f"{ind}, '{self._db_format(self._name)}', " +

src/Model/Geometry/Profile.py

@@ -214,31 +214,17 @@ class Profile(object):
         self.points.insert(index, point)
         self._status.modified()
 
-    def delete(self, indexes: int):
-        """Delete points at index
-
-        Args:
-            indexes: List of index of points.
-
-        Returns:
-            Nothing.
-        """
-        points = set(
+    def delete_i(self, indexes: list):
+        self._points = list(
             map(
                 lambda e: e[1],
                 filter(
-                    lambda e: e[0] in indexes,
+                    lambda e: e[0] not in indexes,
                     enumerate(self.points)
                 )
             )
         )
 
-        self.points = list(
-            filter(
-                lambda p: p not in points,
-                self.points
-            )
-        )
         self._status.modified()
 
     def delete_points(self, points):
@@ -250,7 +236,7 @@ class Profile(object):
         Returns:
             Nothing.
         """
-        self.points = list(
+        self._points = list(
             filter(
                 lambda p: p not in points,
                 self.points
@@ -286,7 +272,7 @@ class Profile(object):
         elif column == 'z':
             def predicate(p): return p.z
 
-        self.points = sorted(
+        self._points = sorted(
             self.points,
             key=predicate,
             reverse=is_reversed
@@ -298,7 +284,7 @@ class Profile(object):
         if len(self.points) != len(indexes):
             logger.critical("Indexes list do not correspond to point list")
 
-        self.points = list(
+        self._points = list(
             map(
                 lambda x: x[1],
                 sorted(
@@ -351,3 +337,7 @@ class Profile(object):
     # Abstract method for width approximation
     def width_approximation(self):
         raise NotImplementedMethodeError(self, self.width_approximation)
+
+    # Abstract method for width approximation
+    def get_water_limits(self, z):
+        raise NotImplementedMethodeError(self, self.get_water_limits)

src/Model/Geometry/ProfileXYZ.py

@@ -19,6 +19,7 @@
 import logging
 import numpy as np
 from typing import List
+from functools import reduce
 
 from tools import timer
 
@@ -115,9 +116,6 @@ class ProfileXYZ(Profile, SQLSubModel):
             f"WHERE reach = {reach.id}"
         )
 
-        for _ in table:
-            profiles.append(None)
-
         for row in table:
             id = row[0]
             ind = row[1]
@@ -132,7 +130,7 @@ class ProfileXYZ(Profile, SQLSubModel):
                 id=id, num=num,
                 name=name, kp=kp,
                 code1=code1, code2=code2,
-                reach=data["parent"],
+                reach=reach,
                 status=status
             )
 
@@ -151,10 +149,6 @@ class ProfileXYZ(Profile, SQLSubModel):
 
             yield ind, new
 
-        #     profiles[ind] = new
-
-        # return profiles
-
     def _db_save(self, execute, data=None):
         ok = True
         ind = data["ind"]
@@ -191,11 +185,20 @@ class ProfileXYZ(Profile, SQLSubModel):
         profile = None
         try:
             if len(header) == 0:
+                name = data[0]
+                kp = data[1]
+                reach = data[2]
+                status = data[3]
+
                 profile = cls(
-                    *data
+                    id=-1,
+                    name=name,
+                    kp=kp,
+                    reach=reach,
+                    status=status
                 )
             else:
-                valid_header = {'name', 'reach', 'kp'}
+                valid_header = {'name', 'reach', 'kp', 'status'}
                 d = {}
                 for i, v in enumerate(data):
                     h = header[i].strip().lower().split(' ')[0]
@@ -204,16 +207,27 @@ class ProfileXYZ(Profile, SQLSubModel):
 
                 profile = cls(**d)
         except Exception as e:
+            logger.error(e)
             raise ClipboardFormatError(header, data)
 
         return profile
 
     def point_from_data(self, header, data):
+        def float_format(s: str):
+            return float(
+                s.replace(",", ".")
+            )
+
         point = None
         try:
             if len(header) == 0:
+                x = float_format(data[0])
+                y = float_format(data[1])
+                z = float_format(data[2])
+                name = data[3] if len(data) == 4 else ""
+
                 point = PointXYZ(
-                    *data, profile=self, status=self._status
+                    x, y, z, name, profile=self, status=self._status
                 )
             else:
                 valid_header = {'name', 'x', 'y', 'z'}
@@ -306,7 +320,23 @@ class ProfileXYZ(Profile, SQLSubModel):
             )
         except Exception as e:
             logger.debug(f"{e}")
-            raise IndexError(f"Invalid point name: {name}")
+            raise IndexError(
+                f"Invalid point name: {name} " +
+                f"for profile ({self.id}) kp = {self.kp}"
+            )
+
+    def has_standard_named_points(self):
+        l, r = reduce(
+            lambda acc, n: (
+                (acc[0] | (n == "rg")),
+                (acc[1] | (n == "rd"))
+            ),
+            map(lambda p: p.name.lower().strip(),
+                self.points),
+            (False, False)
+        )
+
+        return l & r
 
     def add(self):
         """Add a new PointXYZ to profile.
@@ -438,7 +468,67 @@ class ProfileXYZ(Profile, SQLSubModel):
             return list(map(lambda s: s - constant, station))
 
     def width_approximation(self):
-        rg = self.get_point_by_name("rg")
-        rd = self.get_point_by_name("rd")
+        if self.has_standard_named_points():
+            rg = self.get_point_by_name("rg")
+            rd = self.get_point_by_name("rd")
+        else:
+            rg = self.points[0]
+            rd = self.points[-1]
 
         return abs(rg.dist(rd))
+
+    def get_water_limits(self, z):
+        # ====================================================================
+        #  détermination des points limites RG et RD pour un niveau
+        #  d'eau donné
+        #
+        #  irg et ird sont les premiers indices en partant des rives
+        #  gauche et droite qui correspondent à des points sous la
+        #  surface de l'eau ptX et ptY sont les points interpolés où
+        #  le plan d'eau intersecte le profil known_level est le
+        #  niveau d'eau pour lequel on a obtenu irg, ird, ptX et ptY
+        # ====================================================================
+
+        # initialisation
+        irg = -1
+        ird = -1
+
+        for i in range(self.number_points):
+            if self.point(i).z <= z:
+                irg = i
+
+        for i in reversed(range(self.number_points)):
+            if self.point(i).z <= z:
+                ird = i
+
+        # interpolation des points ptX et ptY
+        if (irg < self.number_points - 1):
+            x = np.interp(
+                z,
+                [self.point(irg).z, self.point(irg + 1).z],
+                [self.point(irg).x, self.point(irg + 1).x]
+            )
+            y = np.interp(
+                z,
+                [self.point(irg).z, self.point(irg + 1).z],
+                [self.point(irg).y, self.point(irg + 1).y]
+            )
+            ptX = PointXYZ(x, y, z)
+        else:
+            ptX = self.point(0)
+        if (ird > 0):
+            x = np.interp(
+                z,
+                [self.point(ird-1).z, self.point(ird).z],
+                [self.point(ird-1).x, self.point(ird).x]
+            )
+            y = np.interp(
+                z,
+                [self.point(ird).z, self.point(ird - 1).z],
+                [self.point(ird).y, self.point(ird - 1).y]
+            )
+            ptY = PointXYZ(x, y, z)
+        else:
+            ptY = self.point(self.number_points - 1)
+
+        return ptX, ptY

src/Model/Geometry/Reach.py

@@ -25,7 +25,7 @@ from copy import deepcopy
 from operator import itemgetter
 from functools import reduce
 
-from tools import flatten, timer, trace
+from tools import flatten, timer, trace, logger_exception
 
 from Model.Tools.PamhyrDB import SQLSubModel
 
@@ -61,7 +61,7 @@ class Reach(SQLSubModel):
 
     @classmethod
     def _db_load(cls, execute, data=None):
-        new = cls(status=data["status"], parent=data["parent"])
+        new = cls(status=data["status"], parent=data["reach"])
 
         new._profiles = ProfileXYZ._db_load(
             execute,
@@ -247,6 +247,11 @@ class Reach(SQLSubModel):
         self._update_profile_numbers()
         self._status.modified()
 
+    def purge(self):
+        self._profiles = []
+        self._update_profile_numbers()
+        self._status.modified()
+
     def move_up_profile(self, index: int):
         if index < len(self.profiles):
             next = index - 1
@@ -264,13 +269,37 @@ class Reach(SQLSubModel):
             self._status.modified()
 
     def get_x(self):
-        return [profile.x() for profile in self.profiles]
+        return list(
+            map(
+                lambda profile: profile.x(),
+                filter(
+                    lambda profile: len(profile) > 0,
+                    self.profiles
+                )
+            )
+        )
 
     def get_y(self):
-        return [profile.y() for profile in self.profiles]
+        return list(
+            map(
+                lambda profile: profile.y(),
+                filter(
+                    lambda profile: len(profile) > 0,
+                    self.profiles
+                )
+            )
+        )
 
     def get_z(self):
-        return [profile.z() for profile in self.profiles]
+        return list(
+            map(
+                lambda profile: profile.z(),
+                filter(
+                    lambda profile: len(profile) > 0,
+                    self.profiles
+                )
+            )
+        )
 
     def get_z_min(self):
         """List of z min for each profile
@@ -278,7 +307,15 @@ class Reach(SQLSubModel):
         Returns:
             List of z min for each profile
         """
-        return [profile.z_min() for profile in self.profiles]
+        return list(
+            map(
+                lambda profile: profile.z_min(),
+                filter(
+                    lambda profile: len(profile) > 0,
+                    self.profiles
+                )
+            )
+        )
 
     def get_z_max(self):
         """List of z max for each profile
@@ -286,7 +323,15 @@ class Reach(SQLSubModel):
         Returns:
             List of z max for each profile
         """
-        return [profile.z_max() for profile in self.profiles]
+        return list(
+            map(
+                lambda profile: profile.z_max(),
+                filter(
+                    lambda profile: len(profile) > 0,
+                    self.profiles
+                )
+            )
+        )
 
     def get_kp(self):
         """List of profiles kp
@@ -296,11 +341,28 @@ class Reach(SQLSubModel):
         """
         return [profile.kp for profile in self.profiles]
 
+    def get_kp_complete_profiles(self):
+        return list(
+            map(
+                lambda profile: profile.kp,
+                filter(
+                    lambda profile: len(profile) > 0,
+                    self.profiles
+                )
+            )
+        )
+
     def get_kp_min(self):
-        return min(self.get_kp())
+        if len(self.get_kp()) > 0:
+            return min(self.get_kp())
+        else:
+            return 0.0
 
     def get_kp_max(self):
-        return max(self.get_kp())
+        if len(self.get_kp()) > 0:
+            return max(self.get_kp())
+        else:
+            return 0.0
 
     # Sediment Layers
 
@@ -369,7 +431,7 @@ class Reach(SQLSubModel):
         Returns:
             Tuple of complete and incomplete guidelines name.
         """
-        # Get all point contains into a guideline
+        # Get all point contained into a guideline
         named_points = [profile.named_points() for profile in self.profiles]
         points_name = list(
             map(
@@ -482,8 +544,7 @@ class Reach(SQLSubModel):
         Returns:
             Nothing.
         """
-        list_profile = []
-        list_header = []
+        imported_profiles = []
 
         try:
             list_profile, list_header = self.read_file_st(str(file_path_name))
@@ -500,9 +561,8 @@ class Reach(SQLSubModel):
                         **d, reach=self, status=self._status
                     )
                     prof.import_points(profile)
-                    self.profiles.append(prof)
-                    self._update_profile_numbers()
 
+                    imported_profiles.append(prof)
                 self._status.modified()
         except FileNotFoundError as e:
             logger.error(e)
@@ -510,6 +570,11 @@ class Reach(SQLSubModel):
         except FileFormatError as e:
             logger.error(e)
             e.alert()
+        finally:
+            self.profiles = imported_profiles + self.profiles
+
+            self._update_profile_numbers()
+            return imported_profiles
 
     @timer
     def read_file_st(self, filename):
@@ -525,6 +590,8 @@ class Reach(SQLSubModel):
         list_header = []
         stop_code = "999.999"
 
+        logger.debug(f"Import geometry from {filename}")
+
         with open(filename, encoding="utf-8") as file_st:
             for line in file_st:
                 if not (line.startswith("#") or line.startswith("*")):
@@ -563,21 +630,31 @@ class Reach(SQLSubModel):
 
     # TODO: Move this function to model reach
     def export_reach(self, filename):
-        with open(f"{filename}", "w") as file_st:
-            for index in range(len(self.profiles)):
-                profile = self.profiles[index]
+        with open(f"{filename}", "w") as st:
+            cnt = 0
+            for profile in self.profiles:
+                num = f"{cnt:>6}"
+                c1 = f"{profile.code1:>6}"
+                c2 = f"{profile.code2:>6}"
+                t = f"{len(profile.points):>6}"
+                kp = f"{profile.kp:>12f}"[0:12]
+                pname = profile.name
+                if profile.name == "":
+                    pname = f"p{profile.id:>3}".replace(" ", "0")
 
-                for v in profile.header:
-                    file_st.write(f"{v:>6}")
-                file_st.write("\n")
+                st.write(f"{num}{c1}{c2}{t} {kp} {pname}\n")
 
-                for point in self._data.profile[index_pro].points:
-                    for i in [point.x, point.y, point.z, point.name]:
-                        file_st.write(f"{i:>13.4f}")
-                        file_st.write("\n")
+                for point in profile.points:
+                    x = f"{point.x:<12.4f}"[0:12]
+                    y = f"{point.y:<12.4f}"[0:12]
+                    z = f"{point.z:<12.4f}"[0:12]
+                    n = f"{point.name:<3}"
 
-                file_st.write("    999.9990     999.9990     999.9990")
-                file_st.write("\n")
+                    st.write(f"{x} {y} {z} {n}\n")
+
+                st.write("    999.9990     999.9990     999.9990")
+                st.write("\n")
+                cnt += 1
 
     def get_incline(self):
         first = self.profile(0)
@@ -671,10 +748,14 @@ class Reach(SQLSubModel):
         logger.debug(f"+{incline_acc}")
         logger.debug(f"-{incline_set}")
 
-        return (
-            reduce(
-                lambda acc, x: acc + x,
-                incline_set,
-                0.0
-            ) / (len(incline_set))
-        )
+        try:
+            return (
+                reduce(
+                    lambda acc, x: acc + x,
+                    incline_set,
+                    0.0
+                ) / (len(incline_set))
+            )
+        except Exception as e:
+            logger_exception(e)
+            return 0

src/Model/HydraulicStructures/Basic/HydraulicStructures.py

@@ -0,0 +1,191 @@
+# HydraulicStructures.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+import logging
+
+from tools import trace, timer
+
+from Model.Tools.PamhyrDB import SQLSubModel
+from Model.Except import NotImplementedMethodeError
+
+from Model.HydraulicStructures.Basic.Value import (
+    BHSValue
+)
+
+logger = logging.getLogger()
+
+
+class BasicHS(SQLSubModel):
+    _sub_classes = [
+        BHSValue,
+    ]
+    _id_cnt = 0
+
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(BasicHS, self).__init__()
+
+        self._status = status
+
+        if id == -1:
+            self.id = BasicHS._id_cnt
+        else:
+            self.id = id
+
+        self._name = name
+        self._type = ""
+        self._enabled = True
+        self._data = []
+
+        BasicHS._id_cnt = max(BasicHS._id_cnt + 1, self.id)
+
+    @classmethod
+    def _db_create(cls, execute):
+        execute("""
+          CREATE TABLE hydraulic_structures_basic(
+            id INTEGER NOT NULL PRIMARY KEY,
+            name TEXT NOT NULL,
+            type TEXT NOT NULL,
+            enabled BOOLEAN NOT NULL,
+            hs INTEGER,
+            FOREIGN KEY(hs) REFERENCES hydraulic_structures(id)
+          )
+        """)
+
+        return cls._create_submodel(execute)
+
+    @classmethod
+    def _db_update(cls, execute, version):
+        major, minor, release = version.strip().split(".")
+        if major == minor == "0":
+            if int(release) < 6:
+                cls._db_create(execute)
+
+        return True
+
+    @classmethod
+    def _get_ctor_from_type(cls, t):
+        from Model.HydraulicStructures.Basic.Types import (
+            BHS_types, NotDefined,
+        )
+
+        res = NotDefined
+
+        if t in BHS_types.keys():
+            res = BHS_types[t]
+
+        return res
+
+    @classmethod
+    def _db_load(cls, execute, data=None):
+        new = []
+
+        table = execute(
+            "SELECT id, name, type, enabled, hs " +
+            "FROM hydraulic_structures_basic " +
+            f"WHERE hs = {data['hs_id']} "
+        )
+
+        for row in table:
+            bhs_id = row[0]
+            name = row[1]
+            type = row[2]
+            enabled = (row[3] == 1)
+            hs_id = row[4]
+
+            ctor = cls._get_ctor_from_type(type)
+            bhs = ctor(
+                id=bhs_id,
+                name=name,
+                status=data['status']
+            )
+
+            bhs.enabled = enabled
+
+            data['bhs_id'] = bhs_id
+            bhs._data = BHSValue._db_load(
+                execute, data
+            )
+
+            new.append(bhs)
+
+        return new
+
+    def _db_save(self, execute, data=None):
+        hs_id = data['hs_id']
+
+        sql = (
+            "INSERT INTO " +
+            "hydraulic_structures_basic(id, name, type, enabled, hs) " +
+            "VALUES (" +
+            f"{self.id}, " +
+            f"'{self._db_format(self._name)}', " +
+            f"'{self._db_format(self._type)}', " +
+            f"{self._db_format(self.enabled)}, " +
+            f"{hs_id} " +
+            ")"
+        )
+        execute(sql)
+
+        data['bhs_id'] = self.id
+        execute(
+            "DELETE FROM hydraulic_structures_basic_value " +
+            f"WHERE bhs = {self.id}"
+        )
+
+        for values in self._data:
+            values._db_save(execute, data)
+
+        return True
+
+    def __len__(self):
+        return len(self._data)
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        self._name = name
+        self._status.modified()
+
+    @property
+    def type(self):
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        self._type = type
+        self._status.modified()
+
+    @property
+    def enabled(self):
+        return self._enabled
+
+    @enabled.setter
+    def enabled(self, enabled):
+        self._enabled = enabled
+        self._status.modified()
+
+    @property
+    def parameters(self):
+        return self._data
+
+    def convert(self, new_type):
+        return new_type(id=self.id, name=self.name, status=self._status)

src/Model/HydraulicStructures/Basic/Types.py

@@ -0,0 +1,249 @@
+# Types.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+from Model.HydraulicStructures.Basic.HydraulicStructures import (
+    BasicHS
+)
+
+from Model.HydraulicStructures.Basic.Value import (
+    BHSValue
+)
+
+
+class NotDefined(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(NotDefined, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "ND"
+        self._data = []
+
+
+class DischargeWeir(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(DischargeWeir, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "S1"
+        self._data = [
+            BHSValue("width", float, 1.0, status=status),
+            BHSValue("elevation", float, 1.0, status=status),
+            BHSValue("discharge_coefficient", float, 0.4, status=status),
+        ]
+
+
+class TrapezoidalWeir(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(TrapezoidalWeir, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "S2"
+        self._data = [
+            BHSValue("width", float, 1.0, status=status),
+            BHSValue("elevation", float, 1.0, status=status),
+            BHSValue("loading_elevation", float, 9999.999, status=status),
+            BHSValue("discharge_coefficient", float, 0.4, status=status),
+            BHSValue("half-angle_tangent", float, 0.0, status=status),
+        ]
+
+
+class TriangularWeir(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(TriangularWeir, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "S3"
+        self._data = [
+            BHSValue("elevation", float, 1.0, status=status),
+            BHSValue("loading_elevation", float, 9999.999, status=status),
+            BHSValue("discharge_coefficient", float, 0.4, status=status),
+            BHSValue("half-angle_tangent", float, 0.0, status=status),
+        ]
+
+
+class RectangularOrifice(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(RectangularOrifice, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "OR"
+        self._data = [
+            BHSValue("width", float, 0.0, status=status),
+            BHSValue("elevation", float, 0.0, status=status),
+            BHSValue("loading_elevation", float, 9999.999,
+                     status=status),
+            BHSValue("discharge_coefficient", float, 0.4, status=status),
+            BHSValue("maximal_loading_elevation", float, 9999.999,
+                     status=status),
+        ]
+
+
+class CircularOrifice(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(CircularOrifice, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "OC"
+        self._data = [
+            BHSValue("diameter", float, 0.0, status=status),
+            BHSValue("elevation", float, 0.0, status=status),
+            BHSValue("siltation_height", float, 0.0, status=status),
+            BHSValue("discharge_coefficient", float, 0.4, status=status),
+        ]
+
+
+class VaultedOrifice(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(VaultedOrifice, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "OV"
+        self._data = [
+            BHSValue("elevation", float, 1.0, status=status),
+            BHSValue("width", float, 1.0, status=status),
+            BHSValue("top_of_the_vault", float, 0.0, status=status),
+            BHSValue("bottom_of_the_vault", float, 0.0, status=status),
+            BHSValue("discharge_coefficient", float, 0.4, status=status),
+        ]
+
+
+class RectangularGate(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(RectangularGate, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "V1"
+        self._data = [
+            BHSValue("width", float, 1.0, status=status),
+            BHSValue("elevation", float, 0.0, status=status),
+            BHSValue("discharge coefficient", float, 0.4, status=status),
+            BHSValue("opening", float, 1.0, status=status),
+            BHSValue("maximal_opening", float, 1.0, status=status),
+        ]
+
+
+class SimplifiedRectangularGate(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(SimplifiedRectangularGate, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "V2"
+        self._data = [
+            BHSValue("width", float, 1.0, status=status),
+            BHSValue("elevation", float, 0.0, status=status),
+            BHSValue("discharge coefficient", float, 0.4, status=status),
+            BHSValue("opening", float, 1.0, status=status),
+            BHSValue("maximal_opening", float, 1.0, status=status),
+        ]
+
+
+class Borda(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(Borda, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "BO"
+        self._data = [
+            BHSValue("step_space", float, 0.1, status=status),
+            BHSValue("weir", float, 0.15, status=status),
+            BHSValue("coefficient", float, 0.4, status=status),
+        ]
+
+
+class CheckValve(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(CheckValve, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "CV"
+        self._data = [
+            BHSValue("width", float, 0.0, status=status),
+            BHSValue("elevation", float, 0.0, status=status),
+            BHSValue("loading_elevation", float, 9999.999,
+                     status=status),
+            BHSValue("discharge_coefficient", float, 0.4, status=status),
+            BHSValue("maximal_loading_elevation", float, 9999.999,
+                     status=status),
+        ]
+
+
+class UserDefined(BasicHS):
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(UserDefined, self).__init__(
+            id=id, name=name,
+            status=status
+        )
+
+        self._type = "UD"
+        self._data = [
+            BHSValue("parameter_1", float, 0.0, status=status),
+            BHSValue("parameter_2", float, 0.0, status=status),
+            BHSValue("parameter_3", float, 0.0, status=status),
+            BHSValue("parameter_4", float, 0.0, status=status),
+            BHSValue("parameter_5", float, 0.0, status=status),
+        ]
+
+
+BHS_types = {
+    "ND": NotDefined,
+    "S1": DischargeWeir,
+    "S2": TrapezoidalWeir,
+    "S3": TriangularWeir,
+    "OR": RectangularOrifice,
+    "OC": CircularOrifice,
+    # "OV": VaultedOrifice,
+    "V1": RectangularGate,
+    "V2": SimplifiedRectangularGate,
+    "BO": Borda,
+    "CV": CheckValve,
+    "UD": UserDefined
+}

src/Model/HydraulicStructures/Basic/Value.py

@@ -0,0 +1,145 @@
+# Value.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+from Model.Tools.PamhyrDB import SQLSubModel
+
+
+class BHSValue(SQLSubModel):
+    _sub_classes = []
+    _id_cnt = 0
+
+    def __init__(self, name: str = "", type=float, value=0.0,
+                 status=None):
+        super(BHSValue, self).__init__()
+
+        self._status = status
+
+        self._name = name
+        self._type = type
+        self._value = type(value)
+
+    @classmethod
+    def _db_create(cls, execute):
+        execute("""
+          CREATE TABLE hydraulic_structures_basic_value(
+            id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+            name TEXT NOT NULL,
+            type TEXT NOT NULL,
+            value TEXT NOT NULL,
+            bhs INTEGER,
+            FOREIGN KEY(bhs) REFERENCES hydraulic_structures_basic(id)
+          )
+        """)
+
+        return cls._create_submodel(execute)
+
+    @classmethod
+    def _db_update(cls, execute, version):
+        major, minor, release = version.strip().split(".")
+        if major == minor == "0":
+            if int(release) < 6:
+                cls._db_create(execute)
+
+        return True
+
+    @classmethod
+    def _str_to_type(cls, type):
+        res = str
+
+        if type == "float":
+            res = float
+        elif type == "int":
+            res = int
+        elif type == "bool":
+            res = bool
+
+        return res
+
+    @classmethod
+    def _type_to_str(cls, type):
+        res = "str"
+
+        if type == float:
+            res = "float"
+        elif type == int:
+            res = "int"
+        elif type == bool:
+            res = "bool"
+
+        return res
+
+    @classmethod
+    def _db_load(cls, execute, data=None):
+        new = []
+        bhs_id = data["bhs_id"]
+
+        table = execute(
+            "SELECT name, type, value " +
+            "FROM hydraulic_structures_basic_value " +
+            f"WHERE bhs = '{bhs_id}'"
+        )
+
+        for row in table:
+            name = row[0]
+            type = cls._str_to_type(row[1])
+            value = row[2]
+
+            val = cls(
+                name=name,
+                type=type,
+                value=value,
+                status=data['status']
+            )
+
+            new.append(val)
+
+        return new
+
+    def _db_save(self, execute, data=None):
+        bhs_id = data["bhs_id"]
+
+        sql = (
+            "INSERT INTO " +
+            "hydraulic_structures_basic_value(name, type, value, bhs) " +
+            "VALUES (" +
+            f"'{self._db_format(self._name)}', " +
+            f"'{self._db_format(self._type_to_str(self._type))}', " +
+            f"'{self._db_format(self._value)}', " +
+            f"{bhs_id}" +
+            ")"
+        )
+        execute(sql)
+
+        return True
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def type(self):
+        return self._type
+
+    @property
+    def value(self):
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        self._value = self._type(value)
+        self._status.modified()

src/Model/HydraulicStructures/HydraulicStructures.py

@@ -0,0 +1,288 @@
+# HydraulicStructures.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+import logging
+from functools import reduce
+
+from tools import trace, timer, old_pamhyr_date_to_timestamp
+
+from Model.Tools.PamhyrDB import SQLSubModel
+from Model.Except import NotImplementedMethodeError
+
+from Model.HydraulicStructures.Basic.HydraulicStructures import BasicHS
+from Model.HydraulicStructures.Basic.Types import (
+    NotDefined,
+)
+
+logger = logging.getLogger()
+
+
+class HydraulicStructure(SQLSubModel):
+    _sub_classes = [
+        BasicHS,
+    ]
+    _id_cnt = 0
+
+    def __init__(self, id: int = -1, name: str = "",
+                 status=None):
+        super(HydraulicStructure, self).__init__()
+
+        self._status = status
+
+        if id == -1:
+            self.id = HydraulicStructure._id_cnt
+        else:
+            self.id = id
+
+        self._name = name
+        self._input_kp = None
+        self._output_kp = None
+        self._input_reach = None
+        self._output_reach = None
+        self._enabled = True
+        self._data = []
+
+        HydraulicStructure._id_cnt = max(
+            HydraulicStructure._id_cnt + 1,
+            self.id
+        )
+
+    @classmethod
+    def _db_create(cls, execute):
+        execute("""
+          CREATE TABLE hydraulic_structures(
+            id INTEGER NOT NULL PRIMARY KEY,
+            name TEXT NOT NULL,
+            enabled BOOLEAN NOT NULL,
+            input_kp REAL NOT NULL,
+            output_kp REAL NOT NULL,
+            input_reach INTEGER,
+            output_reach INTEGER,
+            FOREIGN KEY(input_reach) REFERENCES river_reach(id),
+            FOREIGN KEY(output_reach) REFERENCES river_reach(id)
+          )
+        """)
+
+        return cls._create_submodel(execute)
+
+    @classmethod
+    def _db_update(cls, execute, version):
+        major, minor, release = version.strip().split(".")
+        if major == minor == "0":
+            if int(release) < 6:
+                cls._db_create(execute)
+
+        return True
+
+    @classmethod
+    def _db_load(cls, execute, data=None):
+        new = []
+
+        table = execute(
+            "SELECT id, name, enabled, " +
+            "input_kp, output_kp, " +
+            "input_reach, output_reach " +
+            "FROM hydraulic_structures "
+        )
+
+        for row in table:
+            it = iter(row)
+
+            hs_id = next(it)
+            name = next(it)
+            enabled = (next(it) == 1)
+            input_kp = next(it)
+            output_kp = next(it)
+            input_reach_id = next(it)
+            output_reach_id = next(it)
+
+            hs = cls(
+                id=hs_id,
+                name=name,
+                status=data['status']
+            )
+
+            hs.enabled = enabled
+            hs.input_kp = input_kp if input_kp != -1 else None
+            hs.output_kp = output_kp if output_kp != -1 else None
+
+            hs.input_reach, hs.output_reach = reduce(
+                lambda acc, n: (
+                    n if n.id == input_reach_id else acc[0],
+                    n if n.id == output_reach_id else acc[1]
+                ),
+                data["edges"],
+                [None, None]
+            )
+
+            data['hs_id'] = hs_id
+            hs._data = BasicHS._db_load(execute, data)
+
+            new.append(hs)
+
+        return new
+
+    def _db_save(self, execute, data=None):
+        execute(f"DELETE FROM hydraulic_structures WHERE id = {self.id}")
+
+        input_reach_id = -1
+        if self._input_reach is not None:
+            input_reach_id = self._input_reach.id
+
+        output_reach_id = -1
+        if self._output_reach is not None:
+            output_reach_id = self._output_reach.id
+
+        input_kp = -1
+        if self.input_kp is not None:
+            input_kp = self.input_kp
+
+        output_kp = -1
+        if self.output_kp is not None:
+            output_kp = self.output_kp
+
+        sql = (
+            "INSERT INTO " +
+            "hydraulic_structures(" +
+            "  id, name, enabled, input_kp, output_kp, " +
+            "  input_reach, output_reach" +
+            ") " +
+            "VALUES (" +
+            f"{self.id}, '{self._db_format(self._name)}', " +
+            f"{self._db_format(self.enabled)}, " +
+            f"{input_kp}, {output_kp}, " +
+            f"{input_reach_id}, {output_reach_id}" +
+            ")"
+        )
+        execute(sql)
+
+        data['hs_id'] = self.id
+        execute(
+            "DELETE FROM hydraulic_structures_basic " +
+            f"WHERE hs = {self.id}"
+        )
+
+        for basic in self._data:
+            basic._db_save(execute, data)
+
+        return True
+
+    def __len__(self):
+        return len(self._data)
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        self._name = name
+        self._status.modified()
+
+    @property
+    def input_kp(self):
+        return self._input_kp
+
+    @input_kp.setter
+    def input_kp(self, input_kp):
+        if input_kp is not None:
+            input_kp = float(input_kp)
+
+        self._input_kp = input_kp
+        self._status.modified()
+
+    @property
+    def output_kp(self):
+        return self._output_kp
+
+    @output_kp.setter
+    def output_kp(self, output_kp):
+        self._output_kp = output_kp
+        self._status.modified()
+
+    @property
+    def enabled(self):
+        return self._enabled
+
+    @enabled.setter
+    def enabled(self, enabled):
+        self._enabled = enabled
+        self._status.modified()
+
+    @property
+    def input_reach(self):
+        return self._input_reach
+
+    @input_reach.setter
+    def input_reach(self, input_reach):
+        self._input_reach = input_reach
+        self._status.modified()
+
+    @property
+    def output_reach(self):
+        return self._output_reach
+
+    @output_reach.setter
+    def output_reach(self, output_reach):
+        self._output_reach = output_reach
+        self._status.modified()
+
+    @property
+    def basic_structures(self):
+        return self._data.copy()
+
+    def basic_structure(self, index: int):
+        return self._data[index]
+
+    def add(self, index: int):
+        value = NotDefined(status=self._status)
+        self._data.insert(index, value)
+        self._status.modified()
+        return value
+
+    def insert(self, index: int, value: BasicHS):
+        self._data.insert(index, value)
+        self._status.modified()
+
+    def delete_i(self, indexes):
+        self._data = list(
+            map(
+                lambda e: e[1],
+                filter(
+                    lambda e: e[0] not in indexes,
+                    enumerate(self._data)
+                )
+            )
+        )
+        self._status.modified()
+
+    def delete(self, els):
+        self._data = list(
+            filter(
+                lambda e: e not in els,
+                self._data
+            )
+        )
+        self._status.modified()
+
+    def sort(self, _reverse=False, key=None):
+        if key is None:
+            self._data.sort(reverse=_reverse)
+        else:
+            self._data.sort(reverse=_reverse, key=key)
+        self._status.modified()

src/Model/HydraulicStructures/HydraulicStructuresList.py

@@ -0,0 +1,78 @@
+# HydraulicStructuresList.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+from copy import copy
+from tools import trace, timer
+
+from Model.Tools.PamhyrList import PamhyrModelList
+from Model.HydraulicStructures.HydraulicStructures import HydraulicStructure
+
+
+class HydraulicStructureList(PamhyrModelList):
+    _sub_classes = [
+        HydraulicStructure,
+    ]
+
+    @classmethod
+    def _db_load(cls, execute, data=None):
+        new = cls(status=data['status'])
+
+        if data is None:
+            data = {}
+
+        new._lst = HydraulicStructure._db_load(
+            execute, data
+        )
+
+        return new
+
+    def _db_save(self, execute, data=None):
+        execute("DELETE FROM hydraulic_structures")
+
+        if data is None:
+            data = {}
+
+        for hs in self._lst:
+            hs._db_save(execute, data=data)
+
+        return True
+
+    def new(self, lst, index):
+        n = HydraulicStructure(status=self._status)
+        self._lst.insert(index, n)
+        self._status.modified()
+        return n
+
+    def __copy__(self):
+        new = HydraulicStructureList()
+
+        for lst in self._tabs:
+            new.tabs[lst] = self._tabs[lst].copy()
+
+        return new
+
+    def __deepcopy__(self):
+        new = HydraulicStructureList()
+
+        for lst in self._tabs:
+            new.tabs[lst] = self._tabs[lst].deepcopy()
+
+        return new
+
+    def copy(self):
+        return copy(self)

src/Model/InitialConditions/InitialConditions.py

@@ -250,7 +250,7 @@ class InitialConditions(SQLSubModel):
         )
 
         if new._data is not None:
-            yield new
+            return new
 
     def _db_save(self, execute, data=None):
         ok = True
@@ -376,7 +376,7 @@ class InitialConditions(SQLSubModel):
                  * (abs(incline) ** (0.5)))
             )
 
-            elevation= max(
+            elevation = max(
                 profile.z_min() + height,
                 previous_elevation
             )
@@ -395,6 +395,7 @@ class InitialConditions(SQLSubModel):
             self._data.append(new)
             previous_elevation = elevation
 
+        self._generate_resort_data(profiles)
 
     def generate_discharge(self, discharge: float):
         self._data = []
@@ -421,7 +422,7 @@ class InitialConditions(SQLSubModel):
                 ((width * 0.8) * strickler * (abs(incline) ** (0.5)))
             ) ** (0.6)
 
-            elevation= max(
+            elevation = max(
                 profile.z_min() + height,
                 previous_elevation
             )
@@ -438,3 +439,15 @@ class InitialConditions(SQLSubModel):
 
             previous_elevation = elevation
             self._data.append(new)
+
+        self._generate_resort_data(profiles)
+
+    def _generate_resort_data(self, profiles):
+        is_reverse = False
+        if profiles[0].kp > profiles[-1].kp:
+            is_reverse = True
+
+        self._data.sort(
+            reverse=not is_reverse,
+            key=lambda d: d['kp']
+        )

src/Model/Network/Graph.py

@@ -48,10 +48,14 @@ class Graph(object):
 
     def enable_edges(self):
         return list(
-            filter(
-                lambda e: e.is_enable(),
-                self._edges
-            )
+            self._enable_edges()
+        )
+
+    def _enable_edges(self):
+        """Return a generator"""
+        return filter(
+            lambda e: e.is_enable(),
+            self._edges
         )
 
     def edges_names(self):
@@ -138,8 +142,20 @@ class Graph(object):
                 self._nodes
             )
         )
+        self._remove_associated_edge(node_name)
         self._status.modified()
 
+    def _remove_associated_edge(self, node_name: str):
+        edges = list(
+            filter(
+                lambda e: (e.node1.name == node_name or
+                           e.node2.name == node_name),
+                self._edges,
+            )
+        )
+        for edge in edges:
+            self.remove_edge(edge.name)
+
     def create_node(self, x: float = 0.0, y: float = 0.0):
         node = self._create_node(x, y)
         return node
@@ -186,14 +202,14 @@ class Graph(object):
     def is_upstream_node(self, node):
         return reduce(
             lambda acc, e: (acc and (e.node2 != node or not e.enable)),
-            self._edges,
+            self._enable_edges(),
             True
         )
 
     def is_downstream_node(self, node):
         return reduce(
             lambda acc, e: (acc and (e.node1 != node or not e.enable)),
-            self._edges,
+            self._enable_edges(),
             True
         )
 
@@ -203,12 +219,24 @@ class Graph(object):
                 acc or (
                     (e.node1 == node or
                      e.node2 == node)
-                    and e._enable
                 )
             ),
-            self._edges,
+            self._enable_edges(),
             False
         )
 
     def is_enable_edge(self, edge):
         return edge._enable
+
+    # def get_edge_id(self, reach):
+    #    for i, e in enumerate(self.enable_edges):
+    #        if e.id == reach.id:
+    #            return i
+
+    def get_edge_id(self, reach):
+        return next(
+            filter(
+                lambda e: e[1].id == reach.id,
+                enumerate(self.enable_edges())
+            )
+        )[0]

src/Model/Network/__init__.py

@@ -0,0 +1,17 @@
+# __init__.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-

src/Model/Network/test_network.py

@@ -0,0 +1,182 @@
+# test_Network.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+import tempfile
+
+from Model.Saved import SavedStatus
+
+from Model.Network.Graph import Graph
+from Model.Network.Edge import Edge
+from Model.Network.Node import Node
+
+
+def new_graph():
+    status = SavedStatus()
+    g = Graph(status=status)
+
+    return g
+
+
+class GraphTestCase(unittest.TestCase):
+    def test_graph_0(self):
+        g = new_graph()
+
+        self.assertEqual(g.nodes_counts(), 0)
+        self.assertEqual(g.edges_counts(), 0)
+
+    def test_graph_1(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+
+        self.assertEqual(g.nodes_counts(), 2)
+        self.assertEqual(g.edges_counts(), 1)
+
+    def test_graph_2(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+
+        g.remove_edge(e0.name)
+
+        self.assertEqual(g.nodes_counts(), 2)
+        self.assertEqual(g.edges_counts(), 0)
+
+    def test_graph_3(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+
+        g.remove_node(n0.name)
+
+        self.assertEqual(g.nodes_counts(), 1)
+        self.assertEqual(g.edges_counts(), 0)
+
+    def test_graph_4(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+        n2 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+        e1 = g.add_edge(n1, n2)
+
+        g.remove_node(n1.name)
+
+        self.assertEqual(g.nodes_counts(), 2)
+        self.assertEqual(g.edges_counts(), 0)
+
+    def test_graph_upstream_0(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+        n2 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+        e1 = g.add_edge(n1, n2)
+
+        self.assertEqual(g.is_upstream_node(n0), True)
+        self.assertEqual(g.is_upstream_node(n1), False)
+        self.assertEqual(g.is_upstream_node(n2), False)
+
+    def test_graph_upstream_1(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+        n2 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+        e1 = g.add_edge(n2, n1)
+
+        self.assertEqual(g.is_upstream_node(n0), True)
+        self.assertEqual(g.is_upstream_node(n1), False)
+        self.assertEqual(g.is_upstream_node(n2), True)
+
+    def test_graph_upstream_disable(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+        n2 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+        e1 = g.add_edge(n1, n2)
+
+        e0.disable()
+
+        # self.assertEqual(g.is_upstream_node(n0), False)
+        self.assertEqual(g.is_upstream_node(n1), True)
+        self.assertEqual(g.is_upstream_node(n2), False)
+
+    def test_graph_downstream_0(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+        n2 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+        e1 = g.add_edge(n1, n2)
+
+        self.assertEqual(g.is_downstream_node(n0), False)
+        self.assertEqual(g.is_downstream_node(n1), False)
+        self.assertEqual(g.is_downstream_node(n2), True)
+
+    def test_graph_downstream_1(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+        n2 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+        e1 = g.add_edge(n2, n1)
+
+        self.assertEqual(g.is_downstream_node(n0), False)
+        self.assertEqual(g.is_downstream_node(n1), True)
+        self.assertEqual(g.is_downstream_node(n2), False)
+
+    def test_graph_downstream_disable(self):
+        g = new_graph()
+
+        n0 = g.add_node()
+        n1 = g.add_node()
+        n2 = g.add_node()
+
+        e0 = g.add_edge(n0, n1)
+        e1 = g.add_edge(n1, n2)
+
+        e1.disable()
+
+        self.assertEqual(g.is_downstream_node(n0), False)
+        self.assertEqual(g.is_downstream_node(n1), True)
+        # self.assertEqual(g.is_downstream_node(n2), False)

src/Model/Reservoir/Reservoir.py

@@ -94,7 +94,11 @@ class Reservoir(SQLSubModel):
 
             new_reservoir._node = None
             if node_id != -1:
-                new_reservoir._node = next(filter(lambda n: n.id == node_id, data["nodes"]))
+                new_reservoir._node = next(
+                    filter(
+                        lambda n: n.id == node_id, data["nodes"]
+                    )
+                )
 
             new_data = []
             table = execute(

src/Model/River.py

@@ -16,7 +16,7 @@
 
 # -*- coding: utf-8 -*-
 
-from tools import flatten
+from tools import flatten, logger_exception
 
 from Model.Tools.PamhyrDB import SQLSubModel
 
@@ -37,6 +37,9 @@ from Model.Friction.FrictionList import FrictionList
 from Model.SolverParameters.SolverParametersList import SolverParametersList
 from Model.SedimentLayer.SedimentLayerList import SedimentLayerList
 from Model.Reservoir.ReservoirList import ReservoirList
+from Model.HydraulicStructures.HydraulicStructuresList import (
+    HydraulicStructureList,
+)
 
 from Solver.Solvers import solver_type_list
 
@@ -154,7 +157,9 @@ class RiverReach(Edge, SQLSubModel):
             data = {}
 
         table = execute(
-            "SELECT id, name, enable, node1, node2 FROM river_reach")
+            "SELECT id, name, enable, node1, node2 FROM river_reach"
+        )
+
         for row in table:
             # Update id counter
             cls._id_cnt = max(cls._id_cnt, row[0])
@@ -169,10 +174,9 @@ class RiverReach(Edge, SQLSubModel):
             new = cls(id, name, node1, node2, status=data["status"])
             new.enable(enable=enable)
 
-            data["reach"] = id
-            data["parent"] = new
-            new._reach = Reach._db_load(execute, data)
+            data["reach"] = new
 
+            new._reach = Reach._db_load(execute, data)
             new._frictions = FrictionList._db_load(execute, data)
 
             reachs.append(new)
@@ -219,6 +223,7 @@ class River(Graph, SQLSubModel):
         SolverParametersList,
         SedimentLayerList,
         ReservoirList,
+        HydraulicStructureList,
     ]
 
     def __init__(self, status=None):
@@ -237,6 +242,9 @@ class River(Graph, SQLSubModel):
         self._parameters = {}
         self._sediment_layers = SedimentLayerList(status=self._status)
         self._reservoir = ReservoirList(status=self._status)
+        self._hydraulic_structures = HydraulicStructureList(
+            status=self._status
+        )
 
     @classmethod
     def _db_create(cls, execute):
@@ -303,6 +311,12 @@ class River(Graph, SQLSubModel):
             data
         )
 
+        # Hydraulic Structures
+        new._hydraulic_structures = HydraulicStructureList._db_load(
+            execute,
+            data
+        )
+
         # Parameters
         new._parameters = SolverParametersList._db_load(
             execute,
@@ -312,6 +326,8 @@ class River(Graph, SQLSubModel):
         return new
 
     def _db_save(self, execute, data=None):
+        self._db_save_delete_artefact(execute, data)
+
         objs = (self._nodes + self._edges)
         objs.append(self._boundary_condition)
         objs.append(self._initial_conditions)
@@ -319,6 +335,7 @@ class River(Graph, SQLSubModel):
         objs.append(self._sediment_layers)
         objs.append(self._stricklers)
         objs.append(self._reservoir)
+        objs.append(self._hydraulic_structures)
 
         for solver in self._parameters:
             objs.append(self._parameters[solver])
@@ -326,6 +343,35 @@ class River(Graph, SQLSubModel):
         self._save_submodel(execute, objs, data)
         return True
 
+    def _db_save_delete_artefact(self, execute, data=None):
+        self._db_save_delete_artefact_where_not_id(
+            execute, data,
+            "river_node", self._nodes
+        )
+        self._db_save_delete_artefact_where_not_id(
+            execute, data,
+            "river_reach", self._edges
+
+        )
+
+    def _db_save_delete_artefact_where_not_id(self, execute, data,
+                                              table: str, els: list):
+        if len(els) == 0:
+            return
+
+        try:
+            execute(
+                f"DELETE FROM {table} " +
+                "WHERE " +
+                " OR ".join(
+                    map(
+                        lambda n: f"( id <> {n.id} )", els
+                    )
+                )
+            )
+        except Exception as e:
+            logger_exception(e)
+
     @property
     def boundary_condition(self):
         return self._boundary_condition
@@ -363,6 +409,10 @@ class River(Graph, SQLSubModel):
     def reservoir(self):
         return self._reservoir
 
+    @property
+    def hydraulic_structures(self):
+        return self._hydraulic_structures
+
     @property
     def parameters(self):
         return self._parameters

src/Model/SolverParameters/SolverParametersList.py

@@ -142,6 +142,10 @@ class SolverParametersList(PamhyrModelList):
                         insert(v[0], v[1], ind)
                         ind += 1
 
+                    if int(release) < 7:
+                        insert("mage_init_internal", "N", ind)
+                        ind += 1
+
                     new = [
                         ("mage_sediment_masse_volumique", "2650.0"),
                         ("mage_sediment_angle_repos", "40.0"),

src/Model/Study.py

@@ -41,7 +41,7 @@ class Study(SQLModel):
 
     def __init__(self, filename=None, init_new=True):
         # Metadata
-        self._version = "0.0.5"
+        self._version = "0.0.7"
         self.creation_date = datetime.now()
         self.last_modification_date = datetime.now()
         self.last_save_date = datetime.now()
@@ -86,7 +86,7 @@ class Study(SQLModel):
     def is_saved(self):
         return self.status.is_saved()
 
-    def save(self):
+    def save(self, progress=None):
         # Save a copy of database
         fdir, fname = os.path.split(self.filename)
 
@@ -110,7 +110,7 @@ class Study(SQLModel):
 
         # Save
         self.last_save_date = datetime.now()
-        self._save()
+        self._save(progress=progress)
         self.status.save()
 
     @property
@@ -225,7 +225,8 @@ class Study(SQLModel):
 
         if self._update_submodel(version[0]):
             self.execute(
-                f"UPDATE info SET value='{self._version}' WHERE key='version'")
+                f"UPDATE info SET value='{self._version}' WHERE key='version'"
+            )
             return True
 
         logger.info("TODO: update failed")
@@ -266,38 +267,54 @@ class Study(SQLModel):
 
         return new
 
-    def _save(self):
+    def _save(self, progress=None):
+        progress = progress if progress is not None else lambda: None
+
         self.execute(
             f"UPDATE info SET " +
             f"value='{self._db_format(self.name)}' WHERE key='name'"
         )
+        progress()
         self.execute(
             f"UPDATE info SET " +
             f"value='{self._db_format(self.description)}' " +
             "WHERE key='description'"
         )
+        progress()
         self.execute(
             f"UPDATE info SET " +
             f"value='{self._time_system}' WHERE key='time_system'"
         )
+        progress()
         self.execute(
             f"UPDATE info SET " +
             f"value='{timestamp(self._date)}' WHERE key='date'"
         )
+        progress()
         self.execute(
             f"UPDATE info SET " +
             f"value='{timestamp(self.creation_date)}' " +
             "WHERE key='creation_date'"
         )
+        progress()
         self.execute(
             f"UPDATE info SET " +
             f"value='{timestamp(self.last_save_date)}' " +
             "WHERE key='last_save_date'"
         )
+        progress()
 
-        self._save_submodel([self._river])
+        self._save_submodel([self._river], data=progress)
         self.commit()
 
+    def sql_save_request_count(self):
+        return self._count()
+
+    def _count(self):
+        cnt = self._save_count([self._river])
+        logger.debug(cnt)
+        return cnt + 6
+
     def close(self):
         """Close db connection
 

src/Model/Tools/PamhyrDB.py

@@ -21,6 +21,7 @@ import sqlite3
 import logging
 
 from pathlib import Path
+from functools import reduce
 
 from tools import SQL
 from Model.Except import NotImplementedMethodeError
@@ -87,11 +88,16 @@ class SQLModel(SQL):
         raise NotImplementedMethodeError(self, self._update)
 
     def _save_submodel(self, objs, data=None):
-        def fn(sql): return self.execute(
-            sql,
-            fetch_one=False,
-            commit=False
-        )
+        progress = data if data is not None else lambda: None
+
+        def fn(sql):
+            res = self.execute(
+                sql,
+                fetch_one=False,
+                commit=False
+            )
+            progress()
+            return res
 
         ok = True
         for obj in objs:
@@ -100,9 +106,43 @@ class SQLModel(SQL):
         self.commit()
         return ok
 
-    def _save(self):
+    def _save(self, progress=None):
         raise NotImplementedMethodeError(self, self._save)
 
+    def _count(self):
+        raise NotImplementedMethodeError(self, self._count)
+
+    def _save_count(self, objs, data=None):
+        counter = {
+            "insert": 0,
+            "update": 0,
+            "delete": 0,
+            "other": 0,
+        }
+
+        def fn(sql):
+            if "insert" in sql.lower():
+                counter["insert"] = counter["insert"] + 1
+            elif "update" in sql.lower():
+                counter["update"] = counter["update"] + 1
+            elif "delete" in sql.lower():
+                counter["delete"] = counter["delete"] + 1
+            else:
+                counter["other"] = counter["other"] + 1
+            return []
+
+        ok = True
+        for obj in objs:
+            ok &= obj._db_save(fn)
+
+        logger.debug(counter)
+
+        return reduce(
+            lambda acc, k: acc + counter[k],
+            counter,
+            0
+        )
+
     @classmethod
     def _load(cls, filename=None):
         raise NotImplementedMethodeError(cls, cls._load)

src/Model/Tools/PamhyrDict.py

@@ -67,7 +67,7 @@ class PamhyrModelDict(SQLSubModel):
         if key in self._dict:
             v = self._dict[key]
 
-            if type(v) == types.GeneratorType:
+            if type(v) is types.GeneratorType:
                 return list(v)
 
             return v

src/Scripts/MageMesh.py

@@ -0,0 +1,292 @@
+# MageMesh.py -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+import os
+import logging
+
+from ctypes import (
+    cdll,
+    byref, Structure,
+    c_char_p, c_wchar_p,
+    create_string_buffer,
+    POINTER, c_void_p,
+    c_int, c_double, c_bool
+)
+
+from Scripts.AScript import AScript
+
+logger = logging.getLogger()
+
+bief_lib = None
+c_init_bief_from_geo_file = None
+c_get_nb_sections = None
+c_get_nb_points_section = None
+c_set_bief_name = None
+c_st_to_m_compl = None
+c_interpolate_profils_pas_transversal = None
+c_update_pk = None
+c_output_bief = None
+
+##########################
+# Binding initialisation #
+##########################
+
+
+def init_clib(lib_path):
+    global bief_lib
+    bief_lib = cdll.LoadLibrary(lib_path)
+
+    init_c_init_bief_from_geo_file(bief_lib)
+    init_c_get_nb_sections(bief_lib)
+    init_c_get_nb_points_section(bief_lib)
+    init_c_set_bief_name(bief_lib)
+    init_c_st_to_m_compl(bief_lib)
+    init_c_interpolate_profils_pas_transversal(bief_lib)
+    init_c_update_pk(bief_lib)
+    init_c_output_bief(bief_lib)
+
+
+def init_c_init_bief_from_geo_file(bief_lib):
+    global c_init_bief_from_geo_file
+
+    c_init_bief_from_geo_file = getattr(
+        bief_lib, 'c_init_bief_from_geo_file'
+    )
+    c_init_bief_from_geo_file.argtypes = [
+        c_char_p, POINTER(c_int), POINTER(c_int)
+    ]
+    c_init_bief_from_geo_file.restype = None
+
+
+def init_c_get_nb_sections(bief_lib):
+    global c_get_nb_sections
+
+    c_get_nb_sections = getattr(bief_lib, 'c_get_nb_sections')
+    c_get_nb_sections.argtypes = [POINTER(c_int)]
+    c_get_nb_sections.restype = None
+
+
+def init_c_get_nb_points_section(bief_lib):
+    global c_get_nb_points_section
+
+    c_get_nb_points_section = getattr(bief_lib, 'c_get_nb_points_section')
+    c_get_nb_points_section.argtypes = [POINTER(c_int), POINTER(c_int)]
+    c_get_nb_points_section.restype = None
+
+
+def init_c_set_bief_name(bief_lib):
+    global c_set_bief_name
+
+    c_set_bief_name = getattr(bief_lib, 'c_set_bief_name')
+    c_set_bief_name.argtypes = [c_char_p]
+    c_set_bief_name.restype = None
+
+
+def init_c_st_to_m_compl(bief_lib):
+    global c_st_to_m_compl
+
+    c_st_to_m_compl = getattr(bief_lib, 'c_st_to_m_compl')
+    c_st_to_m_compl.argtypes = [POINTER(c_int), c_char_p, c_char_p]
+    c_st_to_m_compl.restype = None
+
+
+def init_c_interpolate_profils_pas_transversal(bief_lib):
+    global c_interpolate_profils_pas_transversal
+
+    c_interpolate_profils_pas_transversal = getattr(
+        bief_lib, 'c_interpolate_profils_pas_transversal'
+    )
+    c_interpolate_profils_pas_transversal.argtypes = [
+        POINTER(c_int), POINTER(c_int),
+        c_char_p, c_char_p,
+        POINTER(c_double), POINTER(c_bool),
+        POINTER(c_int), POINTER(c_bool)
+    ]
+    c_interpolate_profils_pas_transversal.restype = None
+
+
+def init_c_update_pk(bief_lib):
+    global c_update_pk
+
+    c_update_pk = getattr(bief_lib, 'c_update_pk')
+    c_update_pk.argtypes = [c_char_p]
+    c_update_pk.restype = None
+
+
+def init_c_output_bief(bief_lib):
+    global c_output_bief
+
+    c_output_bief = getattr(bief_lib, 'c_output_bief')
+    c_output_bief.argtypes = [c_char_p]
+    c_output_bief.restype = None
+
+#####################
+# Binding functions #
+#####################
+
+
+def init_bief_from_geo_file(name, with_charriage, with_water):
+    logger.info("! call init_bief_from_geo_file:")
+    cname = create_string_buffer(name.encode())
+    c_init_bief_from_geo_file(
+        cname,
+        byref(c_int(with_charriage)),
+        byref(c_int(with_water))
+    )
+
+
+def get_nb_sections():
+    nb_sections = c_int(0)
+    c_get_nb_sections(byref(nb_sections))
+    return nb_sections.value
+
+
+def get_nb_points_section(section):
+    nb_points = c_int(0)
+    c_get_nb_points_section(byref(c_int(section)), byref(nb_points))
+    return nb_points.value
+
+
+def set_bief_name(name):
+    logger.info(f"! call set_bief_name: {repr(name)}")
+    cname = create_string_buffer(name.encode())
+    c_set_bief_name(cname)
+
+
+def st_to_m_compl(npoints, tag1='   ', tag2='   '):
+    logger.info(f"! call st_to_m_compl: {npoints}")
+    cnpoints = c_int(npoints)
+    ctag1 = create_string_buffer(tag1.encode())
+    ctag2 = create_string_buffer(tag2.encode())
+
+    c_st_to_m_compl(byref(cnpoints), ctag1, ctag2)
+
+
+def interpolate_profils_pas_transversal(limite1, limite2,
+                                        directrice1, directrice2,
+                                        pas, lplan=False,
+                                        lm=3, lineaire=False):
+    logger.info("! call interpolate_profils_pas_transversal:")
+    climite1 = c_int(limite1)
+    climite2 = c_int(limite2)
+    cpas = c_double(pas)
+    clplan = c_bool(lplan)
+    clm = c_int(lm)
+    clineaire = c_bool(lineaire)
+    cdirectrice1 = create_string_buffer(directrice1.encode())
+    cdirectrice2 = create_string_buffer(directrice2.encode())
+
+    c_interpolate_profils_pas_transversal(
+        byref(climite1), byref(climite2),
+        cdirectrice1, cdirectrice2,
+        byref(cpas), byref(clplan),
+        byref(clm), byref(clineaire)
+    )
+
+
+def update_pk(directrice):
+    logger.info("! call update_pk:")
+    cdirectrice = create_string_buffer(directrice.encode())
+    c_update_pk(cdirectrice)
+
+
+def output_bief(name):
+    logger.info("! call output_bief:")
+    cname = create_string_buffer(name.encode())
+    c_output_bief(cname)
+
+
+##########
+# Script #
+##########
+
+
+class MageMesh(AScript):
+    name = "MageMesh"
+    description = "Mesh ST file to M"
+
+    def usage(self):
+        logger.info(
+            f"Usage : {self._args[0]} {self._args[1]} " +
+            "<SO_FILE> <ST_FILE> <STEP>"
+        )
+
+    def run(self):
+        if len(self._args) < 5:
+            return 1
+
+        try:
+            so = self._args[2]
+            st = self._args[3]
+            step = float(self._args[4])
+        except Exception as e:
+            logger.error(f"Argument format error: {e}")
+            return 2
+
+        try:
+            init_clib(so)
+        except Exception as e:
+            logger.error(f"Bindings failed: {e}")
+            return 3
+
+        self.meshing(st, step)
+
+        return 0
+
+    def meshing(self, st_file: str, step: float):
+        workdir = self.get_workdir(st_file)
+        file_name = st_file.rsplit(".", 1)[0]
+        reach_name = os.path.basename(file_name)
+
+        # Open
+        init_bief_from_geo_file(st_file, 0, 0)
+        set_bief_name(reach_name)
+
+        ns = get_nb_sections()
+        npts_max = max(
+            map(
+                lambda i: get_nb_points_section(i),
+                range(1, ns)
+            )
+        )
+
+        # Transform
+        st_to_m_compl(0, ' ', ' ')
+        interpolate_profils_pas_transversal(
+            1, ns,
+            'un', 'np',
+            step
+        )
+        update_pk("un")
+
+        # Save
+        if os.path.isfile(f"{file_name}.M"):
+            os.remove(f"{file_name}.M")
+
+        logger.info(f"Saved meshing geometry to {file_name}.M")
+        output_bief(f"{file_name}.M")
+
+    def get_workdir(self, file):
+        workdir = os.path.abspath(
+            os.path.dirname(file)
+        )
+
+        os.makedirs(workdir, exist_ok=True)
+        logger.info(f"Set working dir to {workdir}")
+
+        return workdir

src/Solver/ASolver.py

@@ -121,6 +121,9 @@ class AbstractSolver(object):
     def is_stoped(self):
         return self._status == STATUS.STOPED
 
+    def has_results_loaded(self):
+        self._status = STATUS.NOT_LAUNCHED
+
     @name.setter
     def name(self, name):
         self._name = name