| 1 |
% $Header$ |
% $Header$ |
| 2 |
% $Name$ |
% $Name$ |
| 3 |
|
|
| 4 |
\section{Tutorials} |
\section[MITgcm Example Experiments]{Example experiments} |
| 5 |
\label{sect:tutorials} |
\label{sect:modelExamples} |
| 6 |
\label{www:tutorials} |
\begin{rawhtml} |
| 7 |
|
<!-- CMIREDIR:modelExamples: --> |
| 8 |
|
\end{rawhtml} |
| 9 |
|
|
| 10 |
|
%% a set of pre-configured numerical experiments |
| 11 |
|
|
| 12 |
|
The full MITgcm distribution comes with a set of pre-configured numerical experiments. |
| 13 |
|
Some of these example experiments are tests of individual parts of the model code, but many |
| 14 |
|
are fully fledged numerical simulations. Full tutorials exist for a few of the examples, |
| 15 |
|
and are documented in sections \ref{sect:eg-baro} - \ref{sect:eg-tank}. The other examples |
| 16 |
|
follow the same general structure as the tutorial examples. However, they only include brief |
| 17 |
|
instructions in a text file called {\it README}. The examples are located in subdirectories |
| 18 |
|
under the directory \texttt{verification}. Each example is briefly described below. |
| 19 |
|
|
| 20 |
|
\subsection{Full list of model examples} |
| 21 |
|
|
| 22 |
|
\begin{enumerate} |
| 23 |
|
|
| 24 |
|
\item \texttt{tutorial\_barotropic\_gyre} - single layer, ocean double gyre |
| 25 |
|
(barotropic with free-surface). This experiment is described in detail in section |
| 26 |
|
\ref{sect:eg-baro}. |
| 27 |
|
|
| 28 |
|
\item \texttt{tutorial\_baroclinic\_gyre} - Four layer, ocean double gyre. This experiment |
| 29 |
|
is described in detail in section \ref{sect:eg-fourlayer}. |
| 30 |
|
|
| 31 |
|
\item \texttt{tutorial\_global\_oce\_latlon} - 4x4 degree global ocean simulation with steady |
| 32 |
|
climatological forcing. This experiment is described in detail in section \ref{sect:eg-global}. |
| 33 |
|
|
| 34 |
|
\item \texttt{exp4} - Flow over a Gaussian bump in open-water or channel with open boundaries. |
| 35 |
|
|
| 36 |
|
\item \texttt{tutorial\_deep\_convection} - Inhomogenously forced ocean convection in a |
| 37 |
|
doubly periodic box. This experiment is described in detail in section \ref{sect:eg-bconv}. |
| 38 |
|
|
| 39 |
|
\item \texttt{front\_relax} - Relaxation of an ocean thermal front (test for |
| 40 |
|
Gent/McWilliams scheme). 2D (Y-Z). |
| 41 |
|
|
| 42 |
|
\item \texttt{internal\_wave} - Ocean internal wave forced by open |
| 43 |
|
boundary conditions. |
| 44 |
|
|
| 45 |
|
\item \texttt{natl\_box} - Eastern subtropical North Atlantic with KPP |
| 46 |
|
scheme; 1 month integration |
| 47 |
|
|
| 48 |
|
\item \texttt{hs94.1x64x5} - Zonal averaged atmosphere using Held and |
| 49 |
|
Suarez '94 forcing. |
| 50 |
|
|
| 51 |
|
\item \texttt{hs94.128x64x5} - 3D atmosphere dynamics using Held and |
| 52 |
|
Suarez '94 forcing. |
| 53 |
|
|
| 54 |
|
\item \texttt{hs94.cs-32x32x5} - 3D atmosphere dynamics using Held and Suarez |
| 55 |
|
(1994) forcing on the cubed sphere. This experiment is described in detail in |
| 56 |
|
section \ref{sect:eg-hs}. |
| 57 |
|
|
| 58 |
|
\item \texttt{aim.5l\_zon-ave} - Intermediate Atmospheric physics. |
| 59 |
|
Global Zonal Mean configuration, 1x64x5 resolution. |
| 60 |
|
|
| 61 |
|
\item \texttt{aim.5l\_XZ\_Equatorial\_Slice} - Intermediate |
| 62 |
|
Atmospheric physics, equatorial Slice configuration. 2D (X-Z). |
| 63 |
|
|
| 64 |
|
\item \texttt{aim.5l\_Equatorial\_Channel} - Intermediate Atmospheric |
| 65 |
|
physics. 3D Equatorial Channel configuration. |
| 66 |
|
|
| 67 |
|
\item \texttt{aim.5l\_LatLon} - Intermediate Atmospheric physics. |
| 68 |
|
Global configuration, on latitude longitude grid with 128x64x5 grid |
| 69 |
|
points ($2.8^\circ$ resolution). |
| 70 |
|
|
| 71 |
|
\item \texttt{adjustment.128x64x1} Barotropic adjustment problem on |
| 72 |
|
latitude longitude grid with 128x64 grid points ($2.8^\circ$ resolution). |
| 73 |
|
|
| 74 |
|
\item \texttt{adjustment.cs-32x32x1} Barotropic adjustment problem on |
| 75 |
|
cube sphere grid with 32x32 points per face (roughly $2.8^\circ$ |
| 76 |
|
resolution). |
| 77 |
|
|
| 78 |
|
\item \texttt{advect\_cs} Two-dimensional passive advection test on |
| 79 |
|
cube sphere grid. |
| 80 |
|
|
| 81 |
|
\item \texttt{advect\_xy} Two-dimensional (horizontal plane) passive |
| 82 |
|
advection test on Cartesian grid. |
| 83 |
|
|
| 84 |
|
\item \texttt{advect\_yz} Two-dimensional (vertical plane) passive |
| 85 |
|
advection test on Cartesian grid. |
| 86 |
|
|
| 87 |
|
\item \texttt{tutorial\_tracer\_adjsens} Simple passive tracer experiment. Includes |
| 88 |
|
derivative calculation. This experiment is described in detail in section |
| 89 |
|
\ref{sect:eg-simple-tracer}. |
| 90 |
|
|
| 91 |
|
\item \texttt{flt\_example} Example of using float package. |
| 92 |
|
|
| 93 |
|
\item \texttt{global\_ocean.90x40x15} Global circulation with GM, flux |
| 94 |
|
boundary conditions and poles. |
| 95 |
|
|
| 96 |
|
\item \texttt{tutorial\_global\_oce\_in\_p} Global circulation in pressure |
| 97 |
|
coordinate (non-Boussinesq ocean model). Described in detail in |
| 98 |
|
section \ref{sect:eg-globalpressure}. |
| 99 |
|
|
| 100 |
|
\item \texttt{solid-body.cs-32x32x1} Solid body rotation test for cube |
| 101 |
|
sphere grid. |
| 102 |
|
|
| 103 |
|
\item \texttt{tutorial\_plume\_on\_slope} Gravity Plume on a continental slope. |
| 104 |
|
This experiment is described in detail in section \ref{sect:eg-gravityplume}. |
| 105 |
|
|
| 106 |
|
\item \texttt{tutorial\_global\_oce\_biogeo} Ocean model coupled to the dissolved |
| 107 |
|
inorganic carbon biogeochemistry model. This experiment is described in detail in section |
| 108 |
|
\ref{sect:eg-biogeochem\_tutorial}. |
| 109 |
|
|
| 110 |
|
\item \texttt{tutorial\_global\_oce\_optim} Global ocean state estimation at $4^\circ$ resolution. |
| 111 |
|
This experiment is described in detail in section \ref{sect:eg-global\_state\_estimate}. |
| 112 |
|
|
| 113 |
|
\item \texttt{tutorial\_offline} Offline form of the MITgcm to study advection of a passive |
| 114 |
|
tracer. This experiment is described in detail in section \ref{sect:eg-offline}. |
| 115 |
|
|
| 116 |
|
\item \texttt{rotating\_tank} Rotating tank simulation in cylindrical coordinates. |
| 117 |
|
This experiment is described in detail in section \ref{sect:eg-tank}. |
| 118 |
|
|
| 119 |
|
\end{enumerate} |
| 120 |
|
|
| 121 |
|
\subsection{Directory structure of model examples} |
| 122 |
|
|
| 123 |
|
Each example directory has the following subdirectories: |
| 124 |
|
|
| 125 |
|
\begin{itemize} |
| 126 |
|
\item \texttt{code}: contains the code particular to the example. At a |
| 127 |
|
minimum, this directory includes the following files: |
| 128 |
|
|
| 129 |
|
\begin{itemize} |
| 130 |
|
\item \texttt{code/packages.conf}: declares the list of packages or |
| 131 |
|
package groups to be used. If not included, the default version |
| 132 |
|
is located in \texttt{pkg/pkg\_default}. Package groups are |
| 133 |
|
simply convenient collections of commonly used packages which are |
| 134 |
|
defined in \texttt{pkg/pkg\_default}. Some packages may require |
| 135 |
|
other packages or may require their absence (that is, they are |
| 136 |
|
incompatible) and these package dependencies are listed in |
| 137 |
|
\texttt{pkg/pkg\_depend}. |
| 138 |
|
|
| 139 |
|
\item \texttt{code/CPP\_EEOPTIONS.h}: declares CPP keys relative to |
| 140 |
|
the ``execution environment'' part of the code. The default |
| 141 |
|
version is located in \texttt{eesupp/inc}. |
| 142 |
|
|
| 143 |
|
\item \texttt{code/CPP\_OPTIONS.h}: declares CPP keys relative to |
| 144 |
|
the ``numerical model'' part of the code. The default version is |
| 145 |
|
located in \texttt{model/inc}. |
| 146 |
|
|
| 147 |
|
\item \texttt{code/SIZE.h}: declares size of underlying |
| 148 |
|
computational grid. The default version is located in |
| 149 |
|
\texttt{model/inc}. |
| 150 |
|
\end{itemize} |
| 151 |
|
|
| 152 |
|
In addition, other include files and subroutines might be present in |
| 153 |
|
\texttt{code} depending on the particular experiment. See Section 2 |
| 154 |
|
for more details. |
| 155 |
|
|
| 156 |
|
\item \texttt{input}: contains the input data files required to run |
| 157 |
|
the example. At a minimum, the \texttt{input} directory contains the |
| 158 |
|
following files: |
| 159 |
|
|
| 160 |
|
\begin{itemize} |
| 161 |
|
\item \texttt{input/data}: this file, written as a namelist, |
| 162 |
|
specifies the main parameters for the experiment. |
| 163 |
|
|
| 164 |
|
\item \texttt{input/data.pkg}: contains parameters relative to the |
| 165 |
|
packages used in the experiment. |
| 166 |
|
|
| 167 |
|
\item \texttt{input/eedata}: this file contains ``execution |
| 168 |
|
environment'' data. At present, this consists of a specification |
| 169 |
|
of the number of threads to use in $X$ and $Y$ under multithreaded |
| 170 |
|
execution. |
| 171 |
|
\end{itemize} |
| 172 |
|
|
| 173 |
|
In addition, you will also find in this directory the forcing and |
| 174 |
|
topography files as well as the files describing the initial state |
| 175 |
|
of the experiment. This varies from experiment to experiment. See |
| 176 |
|
section 2 for more details. |
| 177 |
|
|
| 178 |
|
\item \texttt{results}: this directory contains the output file |
| 179 |
|
\texttt{output.txt} produced by the simulation example. This file is |
| 180 |
|
useful for comparison with your own output when you run the |
| 181 |
|
experiment. |
| 182 |
|
\end{itemize} |
| 183 |
|
|
| 184 |
|
Once you have chosen the example you want to run, you are ready to |
| 185 |
|
compile the code. |
| 186 |
|
|
| 187 |
|
|
| 188 |
|
\newpage |
| 189 |
\input{part3/case_studies/barotropic_gyre/baro.tex} |
\input{part3/case_studies/barotropic_gyre/baro.tex} |
| 190 |
|
|
| 191 |
\newpage |
\newpage |
| 198 |
\input{part3/case_studies/ogcm_in_pressure/ogcm_in_pressure.tex} |
\input{part3/case_studies/ogcm_in_pressure/ogcm_in_pressure.tex} |
| 199 |
|
|
| 200 |
\newpage |
\newpage |
| 201 |
\input{part3/case_studies/hs_atmosphere/hs_atmos.tex} |
\input{part3/case_studies/held_suarez_cs/held_suarez_cs.tex} |
| 202 |
|
|
| 203 |
\newpage |
\newpage |
| 204 |
\input{part3/case_studies/doubly_periodic_convection/convection.tex} |
\input{part3/case_studies/doubly_periodic_convection/convection.tex} |
| 212 |
\newpage |
\newpage |
| 213 |
\input{part3/case_studies/biogeochem_tutorial/biogeochem.tex} |
\input{part3/case_studies/biogeochem_tutorial/biogeochem.tex} |
| 214 |
|
|
| 215 |
\begin{versionprivate} |
\newpage |
| 216 |
|
\input{part3/case_studies/global_oce_estimation/global_oce_estimation.tex} |
| 217 |
|
|
| 218 |
|
\newpage |
| 219 |
|
\input{part3/case_studies/sens_airsea_tracer/doc_ad_examples.tex} |
| 220 |
|
|
| 221 |
|
\newpage |
| 222 |
|
\input{part3/case_studies/offline/offline_tutorial.tex} |
| 223 |
|
|
| 224 |
\newpage |
\newpage |
| 225 |
\input{part3/case_studies/rotating_tank/tank.tex} |
\input{part3/case_studies/rotating_tank/tank.tex} |
|
\end{versionprivate} |
|
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch