1 |
% $Header: /u/gcmpack/manual/manual.tex,v 1.24 2004/03/22 02:08:30 edhill Exp $ |
2 |
% $Name: $ |
3 |
|
4 |
\documentclass[12pt]{book} |
5 |
|
6 |
%To help cross-reference |
7 |
%\usepackage{showlabels} |
8 |
|
9 |
%aja%\usepackage{amsfonts} |
10 |
\usepackage{amsmath} |
11 |
\usepackage{html} |
12 |
\usepackage{hthtml} |
13 |
\usepackage{graphicx} |
14 |
|
15 |
%cnh%\usepackage{array} |
16 |
%cnh%\usepackage{multirow} |
17 |
|
18 |
%eh3 Commands to reference either files or symbols within the "HTML-ized" |
19 |
%eh3 ("vdb") code. |
20 |
%eh3 |
21 |
%afe seems like these need to be long, sorry |
22 |
\newcommand{\varlink}[2]{\htmladdnormallink{\tt #1}{../code_reference/vdb/byname/#2.html}} |
23 |
\newcommand{\filelink}[2]{\htmladdnormallink{\bf \tt #1}{../code_reference/vdb/byname/#2.html}} |
24 |
|
25 |
% afe Commands to standardize typesetting |
26 |
\newcommand{\file}[1]{\texttt{#1}} |
27 |
\newcommand{\sectiontitle}[1]{\textsl{#1}} |
28 |
\newcommand{\code}[1]{\texttt{#1}} |
29 |
|
30 |
%% EH3 : try out the epsfig package |
31 |
\usepackage[dvips]{epsfig} |
32 |
\def\scalefig#1{\epsfxsize #1\textwidth} |
33 |
|
34 |
%EH3% ========================================================== |
35 |
%EH3% *** PRIVATE SECTIONS ****** PRIVATE SECTIONS *** |
36 |
%EH3% |
37 |
%EH3% Directions: To build the ``private'' or ``local-only'' |
38 |
%EH3% version of this manual, then edit the following so |
39 |
%EH3% they appear as: |
40 |
%EH3% |
41 |
%EH3% % \includecomment{versionprivate} |
42 |
%EH3% \excludecoment{versionprivate} |
43 |
%EH3% |
44 |
%EH3% The default is to include everything which is: |
45 |
%EH3% |
46 |
%EH3% \includecomment{versionprivate} |
47 |
%EH3% % \excludecoment{versionprivate} |
48 |
|
49 |
%\includecomment{versionprivate} |
50 |
\excludecomment{versionprivate} |
51 |
|
52 |
%EH3% |
53 |
%EH3% To use this comment, simply bracket any part of the |
54 |
%EH3% manual with two lines that contain ONLY the following |
55 |
%EH3% pair: |
56 |
%EH3% |
57 |
%EH3% \begin{versionprivate} |
58 |
%EH3% \end{versionprivate} |
59 |
%EH3% |
60 |
%EH3% with NO additional comments or other commands on the |
61 |
%EH3% lines containing the \begin{...}\end{...} statements. |
62 |
%EH3% |
63 |
%EH3% *** PRIVATE SECTIONS ****** PRIVATE SECTIONS *** |
64 |
%EH3% ========================================================== |
65 |
|
66 |
|
67 |
%ph%\usepackage{epsfig} |
68 |
%ph%\usepackage{psfrag} |
69 |
%ph%\usepackage{oldgerm} |
70 |
|
71 |
% I commented the following because it introduced excessive white space |
72 |
%aja%\usepackage{palatcm} % better PDF |
73 |
|
74 |
% page headers and footers |
75 |
%cnh%\usepackage{fancyhdr} |
76 |
%\pagestyle{fancy} |
77 |
%cnh%\fancyhead{} |
78 |
%cnh%\fancyhead[LO]{\slshape \rightmark} |
79 |
%cnh%\fancyhead[RE]{\slshape \leftmark} |
80 |
%cnh%\fancyhead[RO,LE]{\thepage} |
81 |
%cnh%\fancyfoot[CO,CE]{\today} |
82 |
%cnh%\fancyfoot[RO,LE]{ } |
83 |
%cnh%\renewcommand{\headrulewidth}{0.4pt} |
84 |
%cnh%\renewcommand{\footrulewidth}{0.4pt} |
85 |
|
86 |
% bibtex stuff |
87 |
%aja%\newcommand{\BIBPATH}{.} |
88 |
%aja%\usepackage{natbib} |
89 |
%aja%\bibliographystyle{\BIBPATH/jmr_my} |
90 |
%aja%\gdef\harvardleft{[} |
91 |
%aja%\gdef\harvardright{]} |
92 |
%aja%\bibpunct{[}{]}{,}{a}{}{,} |
93 |
\bibliographystyle{plain} |
94 |
|
95 |
% referencing |
96 |
%ph%\newcommand{\refequ}[1]{equation (\ref{equ:#1})} |
97 |
%ph%\newcommand{\refequbig}[1]{Equation (\ref{equ:#1})} |
98 |
%ph%\newcommand{\reftab}[1]{Tab.~\ref{tab:#1}} |
99 |
%ph%\newcommand{\reftabno}[1]{\ref{tab:#1}} |
100 |
%ph%\newcommand{\reffig}[1]{Fig.~\ref{fig:#1}} |
101 |
%ph%\newcommand{\reffigno}[1]{\ref{fig:#1}} |
102 |
|
103 |
% stuff for psfrag |
104 |
%ph%\newcommand{\textinfigure}[1]{{\footnotesize\textbf{\textsf{#1}}}} |
105 |
%ph%\newcommand{\mathinfigure}[1]{\small\ensuremath{{#1}}} |
106 |
|
107 |
% This allows numbering of subsubsections |
108 |
\setcounter{secnumdepth}{3} |
109 |
% This changes the the chapter title |
110 |
%\renewcommand{\chaptername}{Section} |
111 |
|
112 |
|
113 |
% This allows hyperlinks in PDF |
114 |
% hyperref package and colors for hyperref package |
115 |
\usepackage{color} |
116 |
\usepackage[dvips]{hyperref} |
117 |
\definecolor{darkgreen}{rgb}{0,0.4,0} |
118 |
\definecolor{darkblue}{rgb}{0,0,0.4} |
119 |
\definecolor{darkred}{rgb}{0.5,0,0} |
120 |
\hypersetup{breaklinks=true, |
121 |
colorlinks=true, |
122 |
linkcolor=darkgreen, |
123 |
citecolor=darkblue, |
124 |
pagecolor=darkred, |
125 |
pdftitle={MITgcm Release 1 Documentation}, |
126 |
pdfauthor={MITgcm-support@mitgcm.org}, |
127 |
pdfkeywords={oceanography, ocean model, general circulation model, |
128 |
non-hydrostatic, finite volume, inverse methods, adjoint method} |
129 |
} |
130 |
|
131 |
% Some definitions (AMM) |
132 |
\def\p#1{{\partial \over {\partial #1}}} |
133 |
\def\pp#1#2{{\partial #1 \over {\partial #2}}} |
134 |
\def\dd#1#2{{d #1 \over {d #2}}} |
135 |
\def\bq{\begin{equation}} |
136 |
\def\bqa{\begin{eqnarray}} |
137 |
\def\eq{\end{equation}} |
138 |
\def\eqa{\end{eqnarray}} |
139 |
|
140 |
\def\h{ {1\over2} } |
141 |
\def\txt{\mbox{$2^\circ$ x $2.5^\circ \,$}} |
142 |
\def\fxf{\mbox{$4^\circ$ x $5^\circ \,$}} |
143 |
|
144 |
\def\blankpage{ \vspace*{\fill} \vspace{5in} \vfill \newpage} |
145 |
|
146 |
|
147 |
\begin{document} |
148 |
|
149 |
\bodytext{bgcolor="#FFFFFFFF"} |
150 |
|
151 |
\tableofcontents |
152 |
%\pagebreak |
153 |
|
154 |
%\part{MIT GCM basics} |
155 |
|
156 |
% Section: Overview |
157 |
\input{part1/part1} |
158 |
%\pagebreak |
159 |
|
160 |
% Section: Discretization and Algorithm |
161 |
\input{part2/part2} |
162 |
%\pagebreak |
163 |
|
164 |
% Section: Getting started |
165 |
\input{part3/part3} |
166 |
%\pagebreak |
167 |
|
168 |
% Section: Software Architecture |
169 |
\input{part4/part4} |
170 |
%\pagebreak |
171 |
|
172 |
|
173 |
%\part{Adjoint of the MIT GCM} |
174 |
|
175 |
% Section: Automatic Differentiation |
176 |
\input{part5/part5} |
177 |
%\pagebreak |
178 |
|
179 |
|
180 |
%\part{Additional features} |
181 |
|
182 |
% Section: Physical Packages |
183 |
\input{part6/part6} |
184 |
%\pagebreak |
185 |
|
186 |
% Section: Diagnostics |
187 |
\input{part7/part7} |
188 |
%\pagebreak |
189 |
|
190 |
% Section: ECCO |
191 |
\input{part8/part8} |
192 |
%\pagebreak |
193 |
|
194 |
% Section: Model Uses |
195 |
\input{model_uses} |
196 |
%\pagebreak |
197 |
|
198 |
% Section: References: |
199 |
%\markboth{BIBLIOGRAPHY}{BIBLIOGRAPHY} |
200 |
\addcontentsline{toc}{chapter}{BIBLIOGRAPHY} |
201 |
%aja%\bibliography{\BIBPATH/manual_references} |
202 |
\bibliography{manual_references} |
203 |
|
204 |
\end{document} |