1%------------------------------------------------------------------------------- 2 3% This file is part of Code_Saturne, a general-purpose CFD tool. 4% 5% Copyright (C) 1998-2021 EDF S.A. 6% 7% This program is free software; you can redistribute it and/or modify it under 8% the terms of the GNU General Public License as published by the Free Software 9% Foundation; either version 2 of the License, or (at your option) any later 10% version. 11% 12% This program is distributed in the hope that it will be useful, but WITHOUT 13% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 14% FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 15% details. 16% 17% You should have received a copy of the GNU General Public License along with 18% this program; if not, write to the Free Software Foundation, Inc., 51 Franklin 19% Street, Fifth Floor, Boston, MA 02110-1301, USA. 20 21%------------------------------------------------------------------------------- 22 23%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 24% csdoc class wich is done for reports 25\documentclass[a4paper,10pt,twoside]{csdoc} 26% 27% MACROS SUPPLEMENTAIRES 28\usepackage{csmacros} 29% 30%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 31% 32%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 33% PACKAGES ET COMMANDES POUR LE DOCUMENTS PDF ET LES HYPERLIENS 34\hypersetup{% 35 pdftitle = {CodeSaturne Theory and Programmer's Guide}, 36 pdfauthor = {MFEE}, 37 pdfpagemode = UseOutlines 38} 39\pdfinfo{/CreationDate (D:20030429000000-01 00 )} 40% 41% Pour avoir les Thumbnails a l'ouverture du document sous ACROREAD : 42% pdfpagemode = UseThumbs 43% 44%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 45% MACROS SUPPLEMENTAIRES 46% \newcommand{/...}{...} 47% 48\setcounter{tocdepth}{1} 49%Compteur de ``programme'' remis a jour dans les part. 50\newcounter{prog}[part] 51\renewcommand{\theprog}{\Alph{prog}} 52\renewcommand{\thesection}{\thechapter.\arabic{section}} 53\renewcommand{\theequation}{\thepart.\thechapter.\arabic{equation}} 54\renewcommand{\thefigure}{\thepart.\thechapter.\arabic{figure}} 55% 56\newcommand{\programme}[1]{% 57\passepage 58\refstepcounter{prog} 59\stepcounter{chapter} 60\setcounter{section}{0} 61\setcounter{equation}{0} 62\setcounter{figure}{0} 63\begin{center} 64\Huge \bf \theprog - \underline{\fort{#1} routine} 65\end{center} 66\addcontentsline{toc}{chapter}{\theprog - #1 routine} 67} 68% 69\renewcommand{\arraystretch}{2.0} 70% 71 72\usepackage{pgfplots} 73\usetikzlibrary{shapes,arrows,positioning,backgrounds,fit,calc} 74\usetikzlibrary{plotmarks} 75\usetikzlibrary{patterns} 76\usetikzlibrary{matrix} 77% 78%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 79% INFO POUR PAGES DE GARDES 80\titreCS{\CS \verscs Theory Guide} 81\docassociesCS{} 82\resumeCS{This document is the theory guide of the kernel of 83 \CS~\verscs. 84This documentation is attached to the corresponding version of 85the code in order to facilitate updates.} 86% 87%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 88% For the List of symbols 89% 90\makenomenclature 91 92% 93%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 94% DEBUT DU DOCUMENT 95\begin{document} 96 97\def\contentsname{\textbf{\normalsize Table of contents}\pdfbookmark[1]{Contents}{contents}} 98 99\renewcommand{\logocs}{cs_logo_v} 100 101\pdfbookmark[1]{Pages de garde}{pdg} 102\large 103\makepdgCS 104\normalsize 105 106\passepage 107\input summary 108 109\passepart 110\begin{center}\begin{singlespace} 111\tableofcontents 112\end{singlespace}\end{center} 113 114 115%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 116% CORPS DU DOCUMENT 117% 118\passepage 119 120\printnomenclature 121%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 122% 123\chapter{Introduction} 124\include{introd} 125 126%\section{Backgrounds and history} 127 128%\section{Notations} 129 130\part{Generic solver capabilities} 131%TODO add that to the class 132%\setcounter{chapter}{0} 133\setcounter{section}{0} 134\setcounter{equation}{0} 135\setcounter{figure}{0} 136 137\chapter{Governing equations}\label{chapter:goveqn} 138\include{goveqn} 139 140\chapter{Time stepping}\label{chapter:timstp} 141\include{timstp} 142 143\chapter{Space discretization}\label{chapter:spadis} 144\include{spadis} 145 146\chapter{Boundary conditions}\label{chapter:bndcnd} 147\include{bndcnd} 148 149%\chapter{Source terms} 150 151%\section{Head losses} 152%\section{Mass source terms} 153%\section{Coriolis source terms} 154 155\chapter{Algebrae} 156\include{algebr} 157 158\part{Advanced modelling} 159 160\setcounter{section}{0} 161\setcounter{equation}{0} 162\setcounter{figure}{0} 163 164\chapter{Turbulence modelling}\label{chapter:turbul} 165\include{turbul} 166 167\chapter{Compressible flows} 168See \S~ \ref{ap:cfbase}. 169\include{comprs} 170 171\chapter{Combustion} 172\include{combustion_intro} 173\include{combustion_thermo} 174\include{combustion_gas} 175\include{combustion_coal} 176 177 178\chapter{Groundwater flows} 179\include{ground_water} 180 181\chapter{Magneto-Hydro Dynamics} 182See \S~ \ref{ap:elbase} and the 183\doxygenfile{cs__elec__model_8c.html}{programmers 184reference of the dedicated subroutine} for further 185details. 186%\section{Electric arcs} 187%\chapter{Radiative transfer} 188 189\chapter{Lagrangian particle tracking} 190\include{lagrangian}. 191 192%\chapter{Atmospheric flows} 193 194\chapter{Atmospheric flow modelling} 195\include{atmo} 196 197%\chapter{Cooling towers} 198 199%\chapter{ALE} 200 201\chapter{Cavitation modelling} 202\include{cavitation} 203% 204%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 205\appendix 206 207\part{Appendices} 208%\setcounter{chapter}{0} 209\setcounter{section}{0} 210\setcounter{equation}{0} 211\setcounter{figure}{0} 212\stepcounter{prog} 213\include{apintr} 214 215\part{Base module} 216\include{bilsc2} 217\include{clptur} 218\include{clptrg} 219\include{clsyvt} 220\include{codits} 221\include{condli} 222\include{covofi} 223\include{gradmc} 224\include{gradrc} 225\include{inimas} 226\include{itrmas} 227\include{matrix} 228\include{navstv} 229\include{predvv} 230\include{resopv} 231\include{turbke} 232\include{turrij} 233\include{viscfa} 234\include{visort} 235\include{visecv} 236 237\part{Compressible module} 238\setcounter{chapter}{0} 239\setcounter{section}{0} 240\setcounter{equation}{0} 241\setcounter{figure}{0} 242 243\include{cfbase} 244\include{cfener} 245\include{cfmsvl} 246\include{cfqdmv} 247\include{cfxtcl} 248 249\part{Electric Arcs} 250\setcounter{chapter}{0} 251\setcounter{section}{0} 252\setcounter{equation}{0} 253\setcounter{figure}{0} 254 255\include{elbase} 256 257\setcounter{section}{0} 258\setcounter{equation}{0} 259\setcounter{figure}{0} 260 261\part{Mesh Handling} 262\setcounter{section}{0} 263\setcounter{equation}{0} 264\setcounter{figure}{0} 265 266\chapter{Mesh Algorithms}\label{chapter:meshalgo} 267\include{mesh_algo} 268 269\chapter{Mesh Quality}\label{chapter:meshquality} 270\include{mesh_quality} 271 272\part{Appendices} 273\stepcounter{prog} 274\setcounter{section}{0} 275\setcounter{equation}{0} 276\setcounter{figure}{0} 277\include{operat} 278 279\part{References} 280\setcounter{chapter}{0} 281\setcounter{section}{0} 282\setcounter{equation}{0} 283\setcounter{figure}{0} 284\stepcounter{prog} 285 286\bibliographystyle{alpha} 287\bibliography{csbiblio} 288% 289%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 290% FIN DU DOCUMENT 291\end{document} 292% 293%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 294