| 1 | % $Header: /u/u3/gcmpack/manual/manual.tex,v 1.21 2004/02/17 21:58:56 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 | \newcommand{\varlink}[2]{ | 
| 22 | \htmladdnormallink{\tt #1}{../code_reference/vdb/byname/#2.html} | 
| 23 | } | 
| 24 | \newcommand{\filelink}[2]{ | 
| 25 | \htmladdnormallink{\bf \tt #1}{../code_reference/vdb/byname/#2.html} | 
| 26 | } | 
| 27 |  | 
| 28 | % afe  Commands to standardize typesetting | 
| 29 | \newcommand{\file}[1]{ | 
| 30 | \texttt{#1} | 
| 31 | } | 
| 32 |  | 
| 33 | \newcommand{\sectiontitle}[1]{ | 
| 34 | \textsl{#1} | 
| 35 | } | 
| 36 |  | 
| 37 | \newcommand{\code}[1]{ | 
| 38 | \texttt{#1} | 
| 39 | } | 
| 40 |  | 
| 41 |  | 
| 42 |  | 
| 43 | %eh3 try out the epsfig package | 
| 44 | \usepackage[dvips]{epsfig} | 
| 45 | \def\scalefig#1{\epsfxsize #1\textwidth} | 
| 46 |  | 
| 47 |  | 
| 48 | %ph%\usepackage{epsfig} | 
| 49 | %ph%\usepackage{psfrag} | 
| 50 | %ph%\usepackage{oldgerm} | 
| 51 |  | 
| 52 | % I commented the following because it introduced excessive white space | 
| 53 | %aja%\usepackage{palatcm}              % better PDF | 
| 54 |  | 
| 55 | % page headers and footers | 
| 56 | %cnh%\usepackage{fancyhdr} | 
| 57 | %\pagestyle{fancy} | 
| 58 | %cnh%\fancyhead{} | 
| 59 | %cnh%\fancyhead[LO]{\slshape \rightmark} | 
| 60 | %cnh%\fancyhead[RE]{\slshape \leftmark} | 
| 61 | %cnh%\fancyhead[RO,LE]{\thepage} | 
| 62 | %cnh%\fancyfoot[CO,CE]{\today} | 
| 63 | %cnh%\fancyfoot[RO,LE]{ } | 
| 64 | %cnh%\renewcommand{\headrulewidth}{0.4pt} | 
| 65 | %cnh%\renewcommand{\footrulewidth}{0.4pt} | 
| 66 |  | 
| 67 | % bibtex stuff | 
| 68 | %aja%\newcommand{\BIBPATH}{.} | 
| 69 | %aja%\usepackage{natbib} | 
| 70 | %aja%\bibliographystyle{\BIBPATH/jmr_my} | 
| 71 | %aja%\gdef\harvardleft{[} | 
| 72 | %aja%\gdef\harvardright{]} | 
| 73 | %aja%\bibpunct{[}{]}{,}{a}{}{,} | 
| 74 | \bibliographystyle{plain} | 
| 75 |  | 
| 76 | % referencing | 
| 77 | %ph%\newcommand{\refequ}[1]{equation (\ref{equ:#1})} | 
| 78 | %ph%\newcommand{\refequbig}[1]{Equation (\ref{equ:#1})} | 
| 79 | %ph%\newcommand{\reftab}[1]{Tab.~\ref{tab:#1}} | 
| 80 | %ph%\newcommand{\reftabno}[1]{\ref{tab:#1}} | 
| 81 | %ph%\newcommand{\reffig}[1]{Fig.~\ref{fig:#1}} | 
| 82 | %ph%\newcommand{\reffigno}[1]{\ref{fig:#1}} | 
| 83 |  | 
| 84 | % stuff for psfrag | 
| 85 | %ph%\newcommand{\textinfigure}[1]{{\footnotesize\textbf{\textsf{#1}}}} | 
| 86 | %ph%\newcommand{\mathinfigure}[1]{\small\ensuremath{{#1}}} | 
| 87 |  | 
| 88 | % This allows numbering of subsubsections | 
| 89 | \setcounter{secnumdepth}{3} | 
| 90 | % This changes the the chapter title | 
| 91 | %\renewcommand{\chaptername}{Section} | 
| 92 |  | 
| 93 |  | 
| 94 | % This allows hyperlinks in PDF | 
| 95 | % hyperref package and colors for hyperref package | 
| 96 | \usepackage{color} | 
| 97 | \usepackage[dvips]{hyperref} | 
| 98 | \definecolor{darkgreen}{rgb}{0,0.4,0} | 
| 99 | \definecolor{darkblue}{rgb}{0,0,0.4} | 
| 100 | \definecolor{darkred}{rgb}{0.5,0,0} | 
| 101 | \hypersetup{breaklinks=true, | 
| 102 | colorlinks=true, | 
| 103 | linkcolor=darkgreen, | 
| 104 | citecolor=darkblue, | 
| 105 | pagecolor=darkred, | 
| 106 | pdftitle={MITgcm Release 1 Documentation}, | 
| 107 | pdfauthor={MITgcm-support@mitgcm.org}, | 
| 108 | pdfkeywords={oceanography, ocean model, general circulation model, | 
| 109 | non-hydrostatic, finite volume, inverse methods, adjoint method} | 
| 110 | } | 
| 111 |  | 
| 112 | % Some definitions (AMM) | 
| 113 | \def\p#1{{\partial \over {\partial #1}}} | 
| 114 | \def\pp#1#2{{\partial #1 \over {\partial #2}}} | 
| 115 | \def\dd#1#2{{d #1 \over {d #2}}} | 
| 116 | \def\bq{\begin{equation}} | 
| 117 | \def\bqa{\begin{eqnarray}} | 
| 118 | \def\eq{\end{equation}} | 
| 119 | \def\eqa{\end{eqnarray}} | 
| 120 |  | 
| 121 | \def\h{ {1\over2} } | 
| 122 | \def\txt{\mbox{$2^\circ$ x $2.5^\circ \,$}} | 
| 123 | \def\fxf{\mbox{$4^\circ$ x $5^\circ \,$}} | 
| 124 |  | 
| 125 | \def\blankpage{ \vspace*{\fill} \vspace{5in} \vfill \newpage} | 
| 126 |  | 
| 127 |  | 
| 128 | \begin{document} | 
| 129 |  | 
| 130 | \bodytext{bgcolor="#FFFFFFFF"} | 
| 131 |  | 
| 132 | \tableofcontents | 
| 133 | %\pagebreak | 
| 134 |  | 
| 135 | %\part{MIT GCM basics} | 
| 136 |  | 
| 137 | % Section: Overview | 
| 138 | \input{part1/part1} | 
| 139 | %\pagebreak | 
| 140 |  | 
| 141 | % Section: Discretization and Algorithm | 
| 142 | \input{part2/part2} | 
| 143 | %\pagebreak | 
| 144 |  | 
| 145 | % Section: Getting started | 
| 146 | \input{part3/part3} | 
| 147 | %\pagebreak | 
| 148 |  | 
| 149 | % Section: Software Architecture | 
| 150 | \input{part4/part4} | 
| 151 | %\pagebreak | 
| 152 |  | 
| 153 |  | 
| 154 | %\part{Adjoint of the MIT GCM} | 
| 155 |  | 
| 156 | % Section: Automatic Differentiation | 
| 157 | \input{part5/part5} | 
| 158 | %\pagebreak | 
| 159 |  | 
| 160 |  | 
| 161 | %\part{Additional features} | 
| 162 |  | 
| 163 | % Section: Physical Packages | 
| 164 | \input{part6/part6} | 
| 165 | %\pagebreak | 
| 166 |  | 
| 167 | % Section: Diagnostics | 
| 168 | \input{part7/part7} | 
| 169 | %\pagebreak | 
| 170 |  | 
| 171 | % Section: ECCO | 
| 172 | \input{part8/part8} | 
| 173 | %\pagebreak | 
| 174 |  | 
| 175 | % Section: References: | 
| 176 | %\markboth{BIBLIOGRAPHY}{BIBLIOGRAPHY} | 
| 177 | \addcontentsline{toc}{chapter}{BIBLIOGRAPHY} | 
| 178 | %aja%\bibliography{\BIBPATH/manual_references} | 
| 179 | \bibliography{manual_references} | 
| 180 |  | 
| 181 | \end{document} |