source: branches/nemo_v3_3_beta/DOC/NEMO_book.tex @ 2340

Last change on this file since 2340 was 2282, checked in by gm, 11 years ago

ticket:#658 merge DOC of all the branches that form the v3.3 beta

  • Property svn:executable set to *
File size: 11.7 KB
Line 
1%description: Book template
2
3% template of document for LaTeX
4% (C) Xavier Perseguers 2002 - xavier.perseguers@epfl.ch
5
6\documentclass[a4paper,12pt]{book}
7
8%  makeindex NEMO_book     <== to regenerate the index
9%  bibtex         NEMO_book   <== to generate  the bibliography
10
11% ================================================================
12% HEADERS DEFINITION
13% ================================================================
14
15\usepackage[french]{babel}
16\usepackage{fancyhdr}
17
18\usepackage{alltt}      %%  alltt for namelist
19\usepackage{verbatim}   %%  alltt for namelist
20
21%hyperref  ===>>>  don't work.....
22%\usepackage[a4paper=true,ps2pdf=true,pagebackref=true,breaklinks=true]{hyperref}
23%gn
24\usepackage[%
25  pdftitle={NEMO ocean engine},%
26  pdfauthor={Gurvan Madec},% pdfsubject={The preprint document class
27                           % elsart},% pdfkeywords={diapycnal diffusion,numerical mixing,z-level models},%
28  pdfstartview=FitH,%
29  bookmarks=true,%
30  bookmarksopen=true,%
31  breaklinks=true,%
32  colorlinks=true,%
33  linkcolor=blue,anchorcolor=blue,%
34  citecolor=blue,filecolor=blue,%
35  menucolor=blue,pagecolor=blue,%
36  urlcolor=blue]{hyperref}
37%gn end
38
39%\usepackage{amssymb}
40\pagestyle{fancy}
41% with this we ensure that the chapter and section
42% headings are in lowercase.
43\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
44\renewcommand{\sectionmark}[1]{\markright{\thesection.\ #1}}
45\fancyhf{}             % delete current setting for header and footer
46\fancyhead[LE,RO]{\bfseries\thepage}
47\fancyhead[LO]{\bfseries\hspace{-0em}\rightmark}
48\fancyhead[RE]{\bfseries\leftmark}
49\renewcommand{\headrulewidth}{0.5pt}
50\renewcommand{\footrulewidth}{0pt}
51\addtolength{\headheight}{2.6pt}   % make space for the rule
52%\addtolength{\headheight}{1.6pt}   % make space for the rule
53\fancypagestyle{plain}{
54  \fancyhead{}         % get rid of headers on plain pages
55  \renewcommand{\headrulewidth}{0pt}  % and the line
56}
57
58% Leave blank pages completely empty, w/o header
59\makeatletter
60\def\cleardoublepage{\clearpage\if@twoside \ifodd\c@page\else
61  \hbox{}
62  \vspace*{\fill}
63  \vspace{\fill}
64  \thispagestyle{empty}
65  \newpage
66  \if@twocolumn\hbox{}\newpage\fi\fi\fi}
67\makeatother
68
69\usepackage{makeidx}
70
71\usepackage{minitoc}          %in french : \usepackage[french]{minitoc}
72
73%\usepackage{mtcoff}          % invalidate the use of minitocs
74\usepackage[latin1]{inputenc}
75\usepackage{graphics}            % allows insertion of pictures
76\usepackage{times}               % use vector fonts instead of bitmap
77\usepackage{fancybox}
78\usepackage{graphicx}
79%\usepackage{color}
80%\usepackage{colortbl}
81
82%%%% add by Word2Tex
83%\documentclass{amsart}
84\usepackage{latexsym}
85\usepackage{amssymb}
86\usepackage{amsmath}
87\usepackage{graphicx}
88\allowdisplaybreaks[1]           % allow page breaks in the middle of equations
89%%%%
90
91%%%%
92%\usepackage{mathtime}      % font for illustrator to work (belleek fonts )
93%%%%
94
95%\usepackage{showidx}            % show the index entry
96
97
98
99%%%% define the style of title for chapter  %%%
100\usepackage{pstricks}
101\makeatletter
102\def\LigneVerticale{\vrule height 5cm depth 2cm\hspace{0.1cm}\relax}
103\def\LignesVerticales{%
104  \let\LV\LigneVerticale\LV\LV\LV\LV\LV\LV\LV\LV\LV\LV}
105\def\GrosCarreAvecUnChiffre#1{%
106  \rlap{\vrule height 0.8cm width 1cm depth 0.2cm}%
107  \rlap{\hbox to 1cm{\hss\mbox{\white #1}\hss}}%
108  \vrule height 0pt width 1cm depth 0pt}
109\def\GrosCarreAvecTroisChiffre#1{%
110  \rlap{\vrule height 0.8cm width 1.6cm depth 0.2cm}%
111  \rlap{\hbox to 1.5cm{\hss\mbox{\white #1}\hss}}%
112  \vrule height 0pt width 1cm depth 0pt}
113
114\def\@makechapterhead#1{\hbox{%
115    \huge 
116    \LignesVerticales
117    \hspace{-0.5cm}%
118    \GrosCarreAvecUnChiffre{\thechapter}
119    \hspace{0.2cm}\hbox{#1}%
120%    \GrosCarreAvecTroisChiffre{\thechapter}
121%    \hspace{1cm}\hbox{#1}%
122%}\par\vskip 2cm}
123}\par\vskip 1cm}
124\def\@makeschapterhead#1{\hbox{%
125    \huge 
126    \LignesVerticales
127    %\hspace{0.5cm}%
128    \hbox{#1}%
129}\par\vskip 2cm}
130
131%\def\thechapter{\Roman{chapter}}      % chapter number to be Roman
132
133%%%% end style chapter %%%
134
135%%% use maths shortcuts :
136%\newcommand{\vect} [1] { \rm{\textbf{#1}} }    % vector style: non-italic bold
137\usepackage{./TexFiles/math_abbrev}
138
139
140%%% essai commande
141\newcommand{\nl} [1] {\texttt{\small {\textcolor{blue}{#1}} } } 
142
143%%% index commands :   
144\newcommand{\mdl} [1] {\textit{#1.F90}\index{Modules!#1}}         %module (mdl)
145\newcommand{\rou} [1] {\textit{#1}\index{Routines!#1}}            %module (routine)
146\newcommand{\hf} [1] {\textit{#1.h90}\index{h90 file!#1}}            %module (h90 files)
147\newcommand{\np} [1] {\textit{#1}\index{Namelist parameters!#1}}     %namelist parameter (nampar)
148\newcommand{\jp} [1] {\textit{#1}\index{Model parameters!#1}}        %model parameter (jp)
149\newcommand{\pp} [1] {\textit{#1}\index{Model parameters!#1}}        %namelist parameter (pp)
150\newcommand{\ifile} [1] {\textit{#1.nc}\index{Input NetCDF files!#1.nc}}   %input NetCDF files (.nc)
151\newcommand{\key} [1] {\textbf{key\_#1}\index{CPP keys!key\_#1}}  %key_cpp (key)
152\newcommand{\NEMO} {\textit{NEMO }}                %NEMO (nemo)
153% command to "commented out" portions of text ({} argument) or not ({#1} argument)
154\newcommand{\amtcomment}[1]{}    % command to "commented out" portions of text or not (#1 in argument)
155\newcommand{\sgacomment}[1]{}    % command to "commented out" portions of
156\newcommand{\gmcomment}[1]{}     % command to "commented out" portions of
157%                                               % text that span line breaks
158\newcommand{\alpbet} {\left(\alpha / \beta \right)}   % alpha/beta  for slp computation
159
160%--------------------------------------------namlist---------------------------------------------------------
161\newcommand{\namdisplay} [1] { 
162   \begin{alltt}  {{\tiny \verbatiminput{./TexFiles/Namelist/#1}}}  \end{alltt} 
163                               \vspace{-10pt}   }
164%--------------------------------------------------------------------------------------------------------------
165
166%Red (NR) or Yellow(WARN)
167%\newcommand{\NR} {\colorbox{red}{#1}}
168%\newcommand{\WARN} {{ \colorbox{yellow}{#1}} }
169
170%---------------------%%%%%  Section number in Margin  %%%%%-----------------------------
171% typeset the number of each section in the left margin, with the start of each instance of
172% sectional heading text aligned with the left hand edge of  the body text.
173\makeatletter 
174\def\@seccntformat#1{\protect\makebox[0pt][r]{\csname the#1\endcsname\quad}} 
175\makeatother 
176%--------------------------------------------------------------------------------------------------------------
177
178%----------------------------%%%%%   Bilbiography   %%%%%%-------------------------------%
179\usepackage[nottoc, notlof, notlot]{tocbibind}
180\usepackage[square, comma]{natbib}
181\bibpunct{[}{]}{,}{a}{}{;}                           %suppress "," after "et al."
182\providecommand{\bibfont}{\small}
183%--------------------------------------------------------------------------------------------------------------
184
185% ================================================================
186% FRONT PAGE
187% ================================================================
188
189\title{ 
190\psset{unit=1.1in,linewidth=4pt}    %parameters of the units for pstricks
191\rput(-1.4,2){ \includegraphics[width=0.2\textwidth]{./TexFiles/Figures/logo_CNRS.pdf}           }
192\quad
193\rput(-.15,2){ \includegraphics[width=0.2\textwidth]{./TexFiles/Figures/logo_MERCATOR.pdf} }
194\quad
195\rput(.85,2){ \includegraphics[width=0.1\textwidth]{./TexFiles/Figures/logo_UKMO.pdf}            }
196\quad
197\rput(1.85,2){ \includegraphics[width=0.2\textwidth]{./TexFiles/Figures/logo_NERC.pdf}             } \\
198\vspace{0.1cm}
199\includegraphics[width=0.9\textwidth]{./TexFiles/Figures/NEMO_logo_Black.pdf} \\
200\vspace{1.4cm}
201\rule{345pt}{1.5pt} \\
202\vspace{0.45cm}
203 {\Huge NEMO ocean engine} 
204\rule{345pt}{1.5pt} \\ 
205{\small  -- version 3.3 --}   }
206%{ -- Draft --}   }
207%\date{\today}
208\date{
209October 2010  \\
210\\
211\textit{\small Note du P\^ole de mod\'{e}lisation de l'Institut Pierre-Simon Laplace No 27 }\\
212\vspace{0.45cm}
213{ ISSN No 1288-1619.}
214}
215
216
217%%\includegraphics[width=0.2\textwidth]{./TexFiles/Figures/logo_NERC.pdf} \\
218
219%%    \hbox{\mbox{%
220%%       \hspace{4pt}%
221%%         \fbox{\includegraphics[width=3em]{./TexFiles/Figures/logo_CNRS.pdf}}%
222%%        \hspace{4pt}
223%%        }  }%
224
225\author{ 
226\Large Gurvan Madec, and the NEMO team  \\
227 \texttt{\small gurvan.madec@locean-ipsl.umpc.fr} \\
228 \texttt{\small nemo\_st@hermes.locean-ipsl.umpc.fr} \\
229%{\small Laboratoire d'Oc\'{e}anographie  et du Climat: Exp\'{e}rimentation et Approches Num\'{e}riques }
230}
231
232\dominitoc
233\makeindex        %type this first :     makeindex -s NEMO.ist NEMO_book.idx
234
235% ================================================================
236%      Include ONLY order
237% ================================================================
238
239%\includeonly{./TexFiles/Chapters/Chap_MISC}
240%\includeonly{./TexFiles/Chapters/Chap_ZDF}
241%\includeonly{./TexFiles/Chapters/Chap_STP,./TexFiles/Chapters/Chap_SBC,./TexFiles/Chapters/Chap_TRA}
242%\includeonly{./TexFiles/Chapters/Chap_LBC,./TexFiles/Chapters/Chap_MISC}
243%\includeonly{./TexFiles/Chapters/Chap_Model_Basics}
244%\includeonly{./TexFiles/Chapters/Annex_A,./TexFiles/Chapters/Annex_B,./TexFiles/Chapters/Annex_C,./TexFiles/Chapters/Annex_D}
245
246% ================================================================
247% ================================================================
248\begin{document}
249
250\maketitle                 % generate the title
251
252\frontmatter
253
254\tableofcontents              % generate a table of content
255%\listoffigures               % generate a table of content
256%\listoftables             % generate a table of content
257
258\mainmatter
259
260% ================================================================
261% Abstract - Foreword
262% ================================================================
263
264\include{./TexFiles/Chapters/Abstracts_Foreword}
265
266% ================================================================
267% INTRODUCTION
268% ================================================================
269
270\include{./TexFiles/Chapters/Introduction}
271
272% ================================================================
273% CHAPTERS
274% ================================================================
275
276\include{./TexFiles/Chapters/Chap_Model_Basics}
277
278\include{./TexFiles/Chapters/Chap_STP}       % Time discretisation (time stepping strategy)
279
280\include{./TexFiles/Chapters/Chap_DOM}       % Space discretisation
281
282\include{./TexFiles/Chapters/Chap_TRA}       % Tracer advection/diffusion equation
283
284\include{./TexFiles/Chapters/Chap_DYN}       % Dynamics : momentum equation
285
286\include{./TexFiles/Chapters/Chap_SBC}       % Surface Boundary Conditions
287
288\include{./TexFiles/Chapters/Chap_LBC}       % Lateral Boundary Conditions
289
290\include{./TexFiles/Chapters/Chap_LDF}       % Lateral diffusion
291
292\include{./TexFiles/Chapters/Chap_ZDF}       % Vertical diffusion
293
294\include{./TexFiles/Chapters/Chap_MISC}         % Miscellaneous topics
295
296% ================================================================
297% APPENDIX
298% ================================================================
299
300\appendix
301
302%\include{./TexFiles/Chapters/Chap_Conservation}
303\include{./TexFiles/Chapters/Annex_A}        % generalised vertical coordinate
304\include{./TexFiles/Chapters/Annex_B}        % diffusive operator
305\include{./TexFiles/Chapters/Annex_C}        % Discrete invariants of the eqs.
306\include{./TexFiles/Chapters/Annex_D}        % Coding rules
307\include{./TexFiles/Chapters/Annex_ISO}                     % Notes on some on going staff (no included in the DOC)
308%\include{./TexFiles/Chapters/Annex_E}                   % Notes on some on going staff (no included in the DOC)
309
310% ================================================================
311% INDEX
312% ================================================================
313
314\addcontentsline{toc}{chapter}{Index}
315\printindex
316
317% ================================================================
318% BIBLIOGRAPHY
319% ================================================================
320
321%%\bibliographystyle{plainat}
322\bibliographystyle{./TexFiles/ametsoc}       % AMS biblio style (JPO)
323\bibliography{./TexFiles/Biblio/Biblio}
324
325% ================================================================
326\end{document}
Note: See TracBrowser for help on using the repository browser.