TrioCFD v1.9.2

Based on trust Id SHA1 : see ./src/Version_info

Merge branch 'TCFD221548_DocumentationRelease'

README.md

@@ -13,28 +13,28 @@ This software is OpenSource (BSD license).
 
 
 
-# **How to install TrioCFD-1.9.1 version ?**
+# **How to install TrioCFD-1.9.2 version ?**
 
-### If TRUST-1.9.1 is not already installed, [please follow TRUST install instructions](https://github.com/cea-trust-platform/trust-code#readme).
+### If TRUST-1.9.2 is not already installed, [please follow TRUST install instructions](https://github.com/cea-trust-platform/trust-code#readme).
 
-### Once TRUST installed, install TrioCFD-1.9.1 using one of these methods:
+### Once TRUST installed, install TrioCFD-1.9.2 using one of these methods:
 
 ### **First method**
 ```bash
-git clone https://github.com/cea-trust-platform/TrioCFD-code.git TrioCFD-1.9.1
-cd TrioCFD-1.9.1
-source PathToTRUST-1.9.1/env_TRUST.sh
+git clone https://github.com/cea-trust-platform/TrioCFD-code.git TrioCFD-1.9.2
+cd TrioCFD-1.9.2
+source PathToTRUST-1.9.2/env_TRUST.sh
 baltik_build_configure -execute
 make optim debug
 ```
 
 ### **Second method**
 ```bash
-wget ftp://ftp.cea.fr/pub/TRUST/TrioCFD/versions/v1.9.1/TrioCFD-1.9.1.tar.gz
-tar xzf TrioCFD-1.9.1.tar.gz
-mv TrioCFD TrioCFD-1.9.1
-cd TrioCFD-1.9.1
-source PathToTRUST-1.9.1/env_TRUST.sh
+wget ftp://ftp.cea.fr/pub/TRUST/TrioCFD/versions/v1.9.2/TrioCFD-1.9.2.tar.gz
+tar xzf TrioCFD-1.9.2.tar.gz
+mv TrioCFD TrioCFD-1.9.2
+cd TrioCFD-1.9.2
+source PathToTRUST-1.9.2/env_TRUST.sh
 baltik_build_configure -execute
 make optim debug
 ```

share/RELEASE_NOTES

@@ -1,11 +1,21 @@
 --------------------------------------------------------------------------------------------------
 Release notes version 1.9.2 : Enhancements, modifications and corrected bugs since version 1.9.1 :
 --------------------------------------------------------------------------------------------------
-01/06/23 (TrioCFD) Change     : FTD - Adding an optional criterion to smooth the interface conditionally (based on local curvature variation)
-25/04/23 (TrioCFD) Change     : New project organization (all modues are gathered)
-02/02/23 (TRUST) Major Change : Domain and Zone are now merged into a single concept: Domaine. All former keywords remain supported (Sous_Zone, Create_domain_from_sous_zone, etc...), but internally the code now only work with Domaine.
-27/01/23 (TRUST) Portability  : C++14 compilers are now mandatory so old GNU compilers (<5.0) are not supported anymore
-04/01/23 (TRUST) Major Change : For Pb_Multiphase, simple calls are now applied to compute fluid/saturations properties (improve significantly the performance especially with libraries like EOS, RefProp, ...)
+02/06/23 (TrioCFD) Doc         : CMFD - Documentation for drift velocities 
+01/06/23 (TrioCFD) Change      : FTD - Adding an optional criterion to smooth the interface conditionally (based on local curvature variation)
+25/05/23 (TrioCFD) Tests       : FTD - Adding TCL (contact line model) validation reports 
+16/05/23 (TrioCFD) Tests       : FT IJK - Fix some validation reports
+03/05/23 (TrioCFD) Change      : FSI & SA - No more mask
+25/04/23 (TrioCFD) Major Change: New project organization (all modues are gathered)
+13/04/23 (TrioCFD) Doc         : Update documentation generation scripts
+20/03/23 (TrioCFD) Change      : CMFD - 'Probleme_multiphase' development in progress
+21/02/23 (TrioCFD) New Feature : CMFD - Development in progress
+13/02/23 (TrioCFD) New Feature : FT IJK - New shear boundary condition
+08/02/23 (TrioCFD) New Feature : Turbulence - adding the possibility (still experimental) to compute turbulent viscosity using harmonic mean
+06/02/23 (TRUST)   Change      : C++ template are used (no more macros)
+02/02/23 (TRUST)   Major Change: Domain and Zone are now merged into a single concept: Domaine. All former keywords remain supported (Sous_Zone, Create_domain_from_sous_zone, etc...), but internally the code now only work with Domaine.
+27/01/23 (TrioCFD) New feature : Phase_field - Extension to N components
+04/01/23 (TRUST)   Major Change: For Pb_Multiphase, simple calls are now applied to compute fluid/saturations properties (improve significantly the performance especially with libraries like EOS, RefProp, ...)
 --------------------------------------------------------------------------------------------------
 Release notes version 1.9.1 : Enhancements, modifications and corrected bugs since version 1.9.0 :
 --------------------------------------------------------------------------------------------------

share/doc_src/PGC/TrioCFD_PGC.tex

@@ -40,7 +40,6 @@
 \usetikzlibrary{decorations.pathreplacing}
 \usepackage{hyperref,varioref}
 \hypersetup{linkcolor=blue,colorlinks=true,bookmarks=true,bookmarksopen=true,bookmarksnumbered=true}
-%
 
 \setlength\hoffset{0cm}
 \setlength\voffset{0cm}
@@ -81,14 +80,14 @@
 \makeatother
 %
 \fancypagestyle{part}{%
-\lfoot{\textit{Plan de Gestion Logiciel TrioCFD, v1.9.1}}
+\lfoot{\textit{Plan de Gestion Logiciel TrioCFD, v\codeVersion}}
 \cfoot{}
 \rfoot{\thepage}
 \renewcommand{\headrulewidth}{0.5pt}
 \renewcommand{\footrulewidth}{0.3pt}}
 %
 \fancypagestyle{chapter}{%
-\lfoot{\textit{Plan de Gestion Logiciel TrioCFD, v1.9.1}}
+\lfoot{\textit{Plan de Gestion Logiciel TrioCFD, v\codeVersion}}
 \cfoot{}
 \rfoot{\thepage}
 \renewcommand{\headrulewidth}{0.5pt}
@@ -100,7 +99,7 @@
 \renewcommand{\headrulewidth}{0.5pt}
 \renewcommand{\footrulewidth}{0.3pt}
 \chead{}
-\lfoot{\textit{Plan de Gestion Logiciel TrioCFD, v1.9.1}}
+\lfoot{\textit{Plan de Gestion Logiciel TrioCFD, v\codeVersion}}
 \cfoot{}
 \rfoot{\thepage}
 %
@@ -150,6 +149,11 @@
 %
 \counterwithin*{chapter}{part}
 %
+
+% Variables definition
+% - TrioCFD version
+\newcommand\codeVersion{1.9.2}
+
 \makeindex
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % debut du document
@@ -171,7 +175,8 @@
 \begin{center} \vspace{1.8cm}
 \parbox[t]{12cm}{\hspace{1.2cm}\huge{\textbf{USER DOCUMENTATION :}}
 \vspace{0.4cm}\\
-\hspace{2.8cm}\LARGE{\textbf{Plan de Gestion de Configuration de  TrioCFD v1.9.1}}} \end{center}
+\hspace{2.8cm}\LARGE{\textbf{Plan de Gestion de Configuration de  TrioCFD v\codeVersion}}}
+\end{center}
 \vspace{0.3cm}
 \begin{center}\includegraphics[scale=0.7]{pictures/TrioCFD.png} \end{center}
 \vspace{0.3cm}
@@ -181,10 +186,10 @@
 \begin{tabular}{ Sc|Sc|Sc|Sc }
 \hline
 Code Version & Date & Code manager & Authors \\
- & & J. DARONA & \\ \hline
- & &\multirow{3}{*}{\includegraphics[scale=0.55]{pictures/sign_JD.png}} &  \\
-v1.9.1 & \today && J.DARONA\\
- & &&  \\ \hline
+\hline
+v\codeVersion & \today & \includegraphics[scale=0.05]{../pictures/signTrioCFDManager.png} & J.DARONA\\
+              &        & F. BUFFA                                           & \\
+\hline
 \multicolumn{2}{Sc|}{ } & \multicolumn{2}{Sl}{\textit{Input file : } PGC\_TrioCFD.tex } \\
 \multicolumn{2}{c|}{\textbf{DES/ISAS/DM2S} } & \multicolumn{2}{l}{\textit{Software : } TrioCFD } \\
 \multicolumn{2}{c|}{\textbf{CEA SACLAY} } & \multicolumn{2}{c}{ } \\

share/doc_src/PGC/generer_PGC.sh

@@ -9,10 +9,10 @@ pdflatex ${DOC}.tex
 pdflatex ${DOC}.tex
 
 # Installation of the final pdf report
-cp ${DOC}.pdf ../../doc
+#cp ${DOC}.pdf ../../doc
 
 # Cleaning
-for ext in aux bbl blg idx lof log lot toc pdf
+for ext in aux bbl blg idx lof log lot toc
 do
   rm "${DOC}.${ext}"
 done

share/doc_src/PGC/part1-introduction.tex

@@ -199,7 +199,7 @@ \chapter{Un peu d'histoire}
 \ref{figure:Histo-triocfd}.\smallskip
 
 \begin{tikzpicture}
-	\draw[<-,>=stealth] (8,0) -- (8,14.12) ;
+	\draw[<-,>=stealth] (8,-1.63) -- (8,14.12) ;
 	\draw (0,0) -- (0,0.01) ; 
 	\draw (7.8,14.12) -- (8.2,14.12) ;
 	\draw (7.8,14.12) node[left]{$2015$} ;
@@ -297,13 +297,18 @@ \chapter{Un peu d'histoire}
 	\draw (8.8,00.82) node[right]{\textcolor{blue}{v1.9.1} \textbf{Baltik} Fluid\_Structure\_Interaction};
 	\draw (7.8,00.68) -- (8.2,00.68) ;
 	\draw (7.8,00.68) node[left]{$2023$} ;
-%	\draw (7.8,01.84) -- (8.0,01.84) ;
-%	\draw (7.8,01.42) -- (8.0,01.42) ;
-%	\draw (7.8,01.00) -- (8.2,01.00) ;
-%	\draw (7.8,01.00) node[left]{$2022$} ;
+	\draw (7.8,00.26) -- (8.0,00.26);
+	\draw (7.8,-00.16) -- (8.0,-00.16);
+	\draw (7.8,-00.58) -- (8.0,-00.58);
+	\draw[blue,thick,dashed] (8.0,-00.16) -- (8.7,-00.16);
+	\draw (8.8,-00.16) node[right]{\textcolor{blue}{v1.9.2} R\'eorganisation des fichiers sources};
+	\draw (7.8,-1.00) -- (8.2, -1.00);
+	\draw (7.8,-1.00) node[left]{$2024$};
 \end{tikzpicture}\smallskip
 \begin{center}\captionof{figure}{\label{figure:Histo-triocfd}Historique de TrioCFD}\end{center}\smallskip
-Il est \`a noter que m\^eme si TRUST supporte la partie "sch\'emas num\'eriques", lorsqu'un nouveau sch\'ema est amen\'e \`a \^etre d\'evelopp\'e pour des besoins TrioCFD, l'\'elaboration de ce nouveau sch\'ema est, dans un premier temps d\'evelopp\'e, v\'erif\'e et valid\'e dans TrioCFD avant d'\^etre revers\'e dans TRUST si d'autres Baltiks sous base TRUST (FLICA5, Genepi2,...) sont int\'eress\'es par ce sch\'ema.\newpage
+
+\newpage
+Il est \`a noter que m\^eme si TRUST supporte la partie "sch\'emas num\'eriques", lorsqu'un nouveau sch\'ema est amen\'e \`a \^etre d\'evelopp\'e pour des besoins TrioCFD, l'\'elaboration de ce nouveau sch\'ema est, dans un premier temps d\'evelopp\'e, v\'erif\'e et valid\'e dans TrioCFD avant d'\^etre revers\'e dans TRUST si d'autres Baltiks sous base TRUST (FLICA5, Genepi2,...) sont int\'eress\'es par ce sch\'ema.
 
 Depuis la cr\'eation du projet, de nombreuses améliorations sur la parallélisme du produit ont permis d'augmenter, de manière très importante, les capacités de calcul. La plateforme TRUST/TrioCFD est maintenant en mesure d'effectuer des calculs haute performance (en anglais : High Performance Computing ou HPC). Les progrès récents (2020-2021) sur cet aspect viennent de 3 améliorations majeures :
 \begin{itemize}
@@ -383,56 +388,68 @@ \chapter{Pr\'esentation g\'en\'erale et cartographie}
   \end{itemize}
 \end{itemize}\smallskip
 
-Tous ces outils étant hérités de TRUST, leur gestion est du ressort de l'équipe TRUST. Par conséquent, leur processus ne sera pas décrit dans ce présent PGC. Toutefois, une description de certains de ces outils sera faite dans les sections suivantes.\\
-TrioCFD est en langage C++ pour la partie source du code tandis que les procédures sont en Python ou en bash. Le code source est constitué d'environ 1 500 classes et 513 636 lignes de code (fichiers .cpp et .h). La mod\'elisation d'un applicatif considéré est définie dans un Jeu De Données (.data) et toutes les ex\'ecutions (compilation du code, lancement du jeu de données,...) se font en ligne de commande. \smallskip\\
+Tous ces outils \'etant h\'erit\'es de TRUST, leur gestion est du ressort de l'\'equipe TRUST.
+Par cons\'equent, leur processus ne sera pas d\'ecrit dans ce pr\'esent PGC. Toutefois, une description de certains de ces outils sera faite dans les sections suivantes.\\
+TrioCFD est en langage C++ pour la partie source du code tandis que les proc\'edures sont en Python ou en bash.
+Le code source est constitu\'e d'environ 1 500 classes et de plus 510 00 lignes de code (fichiers .cpp et .h).
+La mod\'elisation d'un applicatif consid\'er\'e est d\'efinie dans un Jeu De Donn\'ees (.data)
+et toutes les ex\'ecutions (compilation du code, lancement du jeu de donn\'ees,...) se font en ligne de commande. \smallskip\\
 
-TrioCFD est lui-même composé de plusieurs Baltiks et sous-Baltiks ayant tous un domaine de compétence spécifique. Ils sont \`a l'heure actuelle au nombre de 10 et 2 d'entre eux contiennent eux-même 2 sous-Baltiks. Le tableau \ref{tab:carto-baltiks} dresse la liste de ces Baltiks et sous-Baltiks, leur domaine de compétence ainsi que leur dépendance interne.
+Depuis la r\'eorganisation du code intervenue dans la version v1.9.2, TrioCFD est un seul et unique Baltik
+compos\'e de plusieurs modules et sous-modules ayant tous un domaine de comp\'etence sp\'ecifique.
+Ils sont \`a l'heure actuelle au nombre de 9.
+Deux d'entre eux (Multiphase et Rayonnement) contiennent eux-m\^eme des sous-modules.
+Le tableau \ref{tab:carto-modules} dresse la liste de ces modules et sous-modules et leur domaine de comp\'etence.
 
 \begin{table}[H]
 \begin{centering}
 \footnotesize
-\begin{tabular}{Sc Sc Sc}
-\hline\hline
-\rowcolor{lightgray}\textbf{Baltik} & \textbf{Description}  & \textbf{D\'ependances} \tabularnewline
+\begin{tabular}{Sc Sc}
 \hline
-
-\textbf{Critere\_Entrainement\_Gaz} & Crit\`ere num\'erique bas\'e sur la voriticit\'e & Turbulence \tabularnewline
-& pour pr\'edire l'aparition d'un vortex & Turbulence \tabularnewline\hline
- & M\'ethode Arbitrary Langrangian-Eulerian  & Turbulence \tabularnewline
-\textbf{Fluid\_Structure\_Interaction} & pour les interactions fluide-structure & \tabularnewline
-  & mod\`ele vibratoire de poutre & \tabularnewline\hline
-\textbf{Multiphase} & & \tabularnewline
-$\hookrightarrow$ CMFD & Computational Multiphase Fluid Dynamics  & SO \tabularnewline
-$\hookrightarrow$ Front\_tracking\_IJK & Int\'egration de TrioIJK dans TrioCFD  & Turbulence \& FTD \tabularnewline
-$\hookrightarrow$ Front\_tracking\_discontinu & Suivi d'interface avec la méthode de Front-Tracking & Turbulence \tabularnewline
-$\hookrightarrow$ Phase\_field & Écoulements diphasiques incompressibles de & SO \tabularnewline
-& fluides non miscibles & \tabularnewline\hline
-\textbf{P1NCP0RT} & Approximation P1/P0 non conforme avec les &  \tabularnewline
-& éléments de Raviart-Thomas & SO \tabularnewline\hline
-\textbf{Rayonnement} & Rayonnement thermique & \tabularnewline
-$\hookrightarrow$ Rayonnement\_milieu\_transparent & dans différents & Turbulence \tabularnewline
-$\hookrightarrow$ Rayonnement\_semi\_transp & milieux & Turbulence \tabularnewline\hline
-\textbf{Schema\_Euler\_Implicite\_Stationnaire} &  & Turbulence \tabularnewline\hline
-& Quantification des changements dans la solution d'un & \tabularnewline
-\textbf{Sensitivity\_analysis} &  système d'EDP (ici Navier-Stokes) dus aux variations & SO \tabularnewline
-& des paramètres d'entrée & \tabularnewline\hline
-& Baltik principal de TrioCFD dont quasiment & \tabularnewline
-\textbf{Turbulence} & tous les autres Baltiks dépendent. Il contient l'ensemble & SO \tabularnewline
-& des modèles de turbulence (Bas-Reynolds, k-epsilon, & \tabularnewline
-& lois de parois,...) quelle que soit la discrétisation considérée & \tabularnewline\hline
-& Baltik contenant les fiches de validation pour & \tabularnewline
-\textbf{validation} & les tests à effets intégraux. Les fiches de validation & Turbulence \tabularnewline
-& des tests à effets séparés sont présents dans le répertoire & \tabularnewline
-& \texttt{/share} du Baltik concerné &  \tabularnewline\hline
-\textbf{Zoom} & & Turbulence \tabularnewline
+\hline
+\rowcolor{lightgray}\textbf{Module} & \textbf{Description} \tabularnewline
+\hline
+\textbf{Critere\_Entrainement\_Gaz} & Crit\`ere num\'erique bas\'e sur la voriticit\'e \tabularnewline
+                                    & pour pr\'edire l'aparition d'un vortex \tabularnewline
+\hline
+                                       & M\'ethode Arbitrary Langrangian-Eulerian \tabularnewline
+\textbf{Fluid\_Structure\_Interaction} & pour les interactions fluide-structure \tabularnewline
+                                       & mod\`ele vibratoire de poutre \tabularnewline
+\hline
+\textbf{Multiphase} & \tabularnewline
+$\hookrightarrow$ CMFD                        & Computational Multiphase Fluid Dynamics  \tabularnewline
+$\hookrightarrow$ Front\_tracking\_IJK        & Int\'egration de TrioIJK dans TrioCFD  \tabularnewline
+$\hookrightarrow$ Front\_tracking\_discontinu & Suivi d'interface avec la méthode de Front-Tracking \tabularnewline
+$\hookrightarrow$ Phase\_field                & Écoulements diphasiques incompressibles de \tabularnewline
+                                              & fluides non miscibles \tabularnewline
+\hline
+\textbf{P1NCP0RT} & Approximation P1/P0 non conforme avec les \tabularnewline
+                  & éléments de Raviart-Thomas \tabularnewline
+\hline
+\textbf{Rayonnement} & Rayonnement thermique \tabularnewline
+$\hookrightarrow$ Rayonnement\_milieu\_transparent & dans différents \tabularnewline
+$\hookrightarrow$ Rayonnement\_semi\_transp        & milieux \tabularnewline
+\hline
+\textbf{Schema\_Euler\_Implicite\_Stationnaire} & \tabularnewline
+\hline
+                               & Quantification des changements dans la solution d'un \tabularnewline
+\textbf{Sensitivity\_analysis} &  système d'EDP (ici Navier-Stokes) dus aux variations \tabularnewline
+                               & des paramètres d'entrée \tabularnewline
+\hline
+                    & Module principal de TrioCFD que quasiment \tabularnewline
+\textbf{Turbulence} & tous les autres modules utilisent. Il contient l'ensemble \tabularnewline
+                    & des modèles de turbulence (Bas-Reynolds, k-epsilon, \tabularnewline
+                    & lois de parois,...) quelle que soit la discrétisation considérée \tabularnewline
+\hline
+\textbf{Zoom} & \tabularnewline
 \hline\hline
 \end{tabular}
 \normalsize
 \par\end{centering}
-\caption{\label{tab:carto-baltiks}Cartographie des BALTIKS et sous-BALTIKS de TrioCFD}
+\caption{\label{tab:carto-modules}Cartographie des modules et sous-modules de TrioCFD}
 \end{table}
 
-Ces différents Baltiks permettent de couvrir les domaines de modélisation physique suivants :
+Ces différents modules permettent de couvrir les domaines de modélisation physique suivants :
 \begin{itemize}[label=$\Rightarrow$, font=\LARGE]
   \item Hydraulique avec ou sans turbulence
   \item Thermohydraulique avec ou sans turbulence
@@ -441,7 +458,7 @@ \chapter{Pr\'esentation g\'en\'erale et cartographie}
   \begin{itemize}
     \item Front-Tracking
     \item Interface diffuse incompressible
-    \item Modèle Homogène Équilibré (HEM) pr\'esent dans le Baltik CMFD
+    \item Modèle Homogène Équilibré (HEM) pr\'esent dans le module CMFD
   \end{itemize}
   \item Interactions fluide/structure par la méthode ALE
   \item Chimie