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]{csshortdoc} 26% MACROS SUPPLEMENTAIRES 27\usepackage{csmacros} 28% 29%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 30 31% 32%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 33% PACKAGES ET COMMANDES POUR LE DOCUMENTS PDF ET LES HYPERLIENS 34\hypersetup{% 35 pdftitle = {CodeSaturne practical user's guide}, 36 pdfauthor = {MFEE}, 37 pdfpagemode = UseOutlines 38} 39\pdfinfo{/CreationDate (D:20030429000000-01 00 )} 40% 41% To have thumbnails upon opening the document under ACROREAD 42% pdfpagemode = UseThumbs 43% 44%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 45% REALISATION D'UN INDEX 46\usepackage{makeidx} 47\makeindex 48% 49%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 50% PACKAGES ALLTT D'ENVIRONNEMENT VERBATIM AMELIORE 51\usepackage{alltt} 52% 53%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 54% INFO POUR PAGES DE GARDES 55\titreCS{\CS version~\verscs practical user's guide} 56\docassociesCS{} 57\resumeCS{This document presents all the necessary elements to run a calculation 58with \CS version \verscs. It then lists all the variables of the code 59which may be useful for more advanced utilisation. 60The user subroutines of all the modules within the code are also documented. 61Eventually, for each key word and user-modifiable parameter in the code, 62their definition, allowed values, default values and conditions for use are given. 63These key words and parameters are grouped under headings 64based on their function. An alphabetical index list is also given at the end of 65the document for easier consultation.} 66% 67%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 68% DEBUT DU DOCUMENT 69\begin{document} 70 71\def\contentsname{\textbf{\normalsize TABLE OF CONTENTS}\pdfbookmark[1]{Table of 72contents}{contents}} 73\def\indexname{Index of the main variables and keywords} 74 75\renewcommand{\logocs}{cs_logo_h} 76 77\pdfbookmark[1]{Flyleaf}{pdg} 78\large 79\makepdgCS 80\normalsize 81 82\input summary 83 84\passepage 85 86\begin{center}\begin{singlespace} 87\tableofcontents 88\end{singlespace}\end{center} 89% 90%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 91% CORPS DU DOCUMENT 92% 93\passepage 94\include{saturne1} 95\include{saturne2} 96% 97%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 98% REFERENCES 99\include{biblio} 100% 101%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 102% ANNEXES 103%\passepage 104\phantomsection\addcontentsline{toc}{section}{\indexname} 105\printindex 106% 107%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 108% FIN DU DOCUMENT 109\end{document} 110% 111%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 112