%
%     This file is part of the Code_Saturne Preprocessor, element of the
%     Code_Saturne CFD tool.
%
%     Copyright (C) 1998-2010 EDF S.A., France
%
%     contact: saturne-support@edf.fr
%
%     The Code_Saturne Preprocessor 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 2 of
%     the License, or (at your option) any later version.
%
%     The Code_Saturne Preprocessor 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 the Code_Saturne Preprocessor; if not, write to the
%     Free Software Foundation, Inc.,
%     51 Franklin St, Fifth Floor,
%     Boston, MA  02110-1301  USA
%
%---------------------------------------------------------------------
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Title:  Code_Saturne Preprocessor Theory Manual                    %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\documentclass[a4paper,10pt,twoside]{article}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Required packages
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\usepackage{csdoc}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Packages and commands for documents and hyperlinks
\hypersetup{%
  pdftitle = {Code_Saturne Preprocessor Theory Manual},
  pdfauthor = {MFEE},
  pdfpagemode = UseOutlines
}
\pdfinfo{/CreationDate (D:20030429000000-01 00 )}

% To have thumbnails upon opening the document under Acrobat Reader
% pdfpagemode = UseThumbs

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Build and index
\usepackage{makeidx}
\makeindex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Additional packages
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\usepackage{times}
\usepackage{placeins}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Additional macros
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% \newcommand{/...}{...}

% directory and extensions for graphics
\newcommand{\repgraphics}{../graphics}
\newcommand{\extgraphics}{pdf}

% Acronyms and tool names

\newcommand{\CS}{%
{\fontfamily{ppl}\fontshape{it}\selectfont Code\_Saturne}\xspace}
\newcommand{\ensight}{\emph{EnSight}\xspace}
\newcommand{\ICEMCFD}{\emph{ICEM~CFD}\xspace}
\newcommand{\ideas}{\emph{I-deas}\xspace}
\newcommand{\med}{\emph{MED}\xspace}
\newcommand{\paraview}{\emph{ParaView}\xspace}
\newcommand{\simail}{\emph{SIMAIL}\xspace}

\newcommand{\C}{\emph{C}\xspace}
\newcommand{\Cpp}{\emph{C++}\xspace}
\newcommand{\env}{Enveloppe\xspace}
\newcommand{\python}{\emph{Python}\xspace}
\newcommand{\swig}{\emph{SWIG}\xspace}
\newcommand{\uml}{\emph{UML}\xspace}
\newcommand{\zlib}{\emph{Zlib}\xspace}

% Polices

\newcommand{\fc}[1]{{\ttfamily #1}}

% References

\newcommand{\numpar}[1]{{\S}~\ref{#1} page~\pageref{#1}}
\newcommand{\refpar}[1]{(cf. {\S}~\ref{#1}, page~\pageref{#1})}
\newcommand{\refex}[1]{(cf. Exemple~\ref{#1}, page~\pageref{#1})}
\newcommand{\reffig}[1]{(cf. Figure~\ref{#1}, page~\pageref{#1})}


\newbox\tempbox
\newcommand{\motcle}[7]{%
   \noindent
   \setbox\tempbox\hbox{\hspace*{2.5cm}}
   \makebox[2.5cm][l]{#1}\index{#1}\makebox[1.3cm][l]{#2}\makebox[5.5cm][l]{#3}%
   \makebox[4.5cm][l]{[#4]}#5\hspace{1cm}#6\\
   \hangindent\wd\tempbox\quad\ignorespaces#7\bigskip}
\newcommand{\motcleb}[7]{%
   \noindent
   \setbox\tempbox\hbox{\hspace*{2.5cm}}
   \makebox[2.5cm][l]{\bf #1}\index{#1}\makebox[1.3cm][l]{#2}\makebox[5.5cm][l]{#3}%
   \makebox[4.5cm][l]{[#4]}#5\hspace{1cm}#6\\
   \hangindent\wd\tempbox\quad\ignorespaces#7\bigskip}
\newcommand{\varenv}[1]{\medskip\noindent{\ttfamily \large #1}}

%\newcommand{\variab}[4]{%
%       \hangindent\wd\tempbox\noindent{#2\index{#1} [#3] \quad\\}
%       \hspace*{0.5cm}\ignorespaces#4.}
\newcommand{\variab}[4]{%
       \setbox\tempbox\hbox{IFACEL [E] : }
       \hangindent\wd\tempbox\noindent{#2\index{#1} [#3] :\quad}\ignorespaces#4.}

% Utility command for \raggedright in tabular

\newcommand{\PreserveBackslash}[1]{\let\temp=\\#1\let\\=\temp}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Info for header pages
\titreCS{\CS\ version~{\verscs}: Preprocessor Theory Guide}
\docassociesCS{}

\resumeCS{This note is a theory guide for the \CS version \verscs
Preprocessor.}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% DEBUT DU DOCUMENT
\begin{document}

\def\contentsname{\textbf{\normalsize SUMMARY}\pdfbookmark[1]{Sommaire}{contents}}
\def\indexname{Index of main variables and keywords}

\pdfbookmark[1]{Title pages}{pdg}
\large
\makepdgCS
\normalsize

\passepage
\input mt_ecs_synthese

\passepage

\begin{center}\begin{singlespace}
\tableofcontents
\end{singlespace}\end{center}

\vspace{2cm}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Document body
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\passepage
\include{mt_ecs_algo}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% References
\include{mt_ecs_biblio}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Appendices

\printindex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Document end

\end{document}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
