/[MITgcm]/manual/s_examples/text/model_examples.tex
ViewVC logotype

Diff of /manual/s_examples/text/model_examples.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.22 by jmc, Fri Aug 27 18:21:43 2010 UTC revision 1.26 by jmc, Fri Aug 29 17:08:21 2014 UTC
# Line 2  Line 2 
2  % $Name$  % $Name$
3    
4  \section[MITgcm Example Experiments]{Example experiments}  \section[MITgcm Example Experiments]{Example experiments}
5  \label{sect:modelExamples}  \label{sec:modelExamples}
6  \begin{rawhtml}  \begin{rawhtml}
7  <!-- CMIREDIR:modelExamples: -->  <!-- CMIREDIR:modelExamples: -->
8  \end{rawhtml}  \end{rawhtml}
# Line 13  The full MITgcm distribution comes with Line 13  The full MITgcm distribution comes with
13  numerical experiments.  Some of these example experiments are tests of  numerical experiments.  Some of these example experiments are tests of
14  individual parts of the model code, but many are fully fledged  individual parts of the model code, but many are fully fledged
15  numerical simulations. Full tutorials exist for a few of the examples,  numerical simulations. Full tutorials exist for a few of the examples,
16  and are documented in sections \ref{sect:eg-baro} -  and are documented in sections \ref{sec:eg-baro} -
17  \ref{sect:eg-tank}. The other examples follow the same general  \ref{sec:eg-tank}. The other examples follow the same general
18  structure as the tutorial examples. However, they only include brief  structure as the tutorial examples. However, they only include brief
19  instructions in a text file called {\it README}.  The examples are  instructions in a text file called {\it README}.  The examples are
20  located in subdirectories under the directory \texttt{verification}.  located in subdirectories under the directory \texttt{verification}.
# Line 23  Each example is briefly described below. Line 23  Each example is briefly described below.
23  \subsection{Full list of model examples}  \subsection{Full list of model examples}
24    
25  \begin{enumerate}  \begin{enumerate}
26      
27  \item \texttt{tutorial\_advection\_in\_gyre} - Test of various  \item \texttt{tutorial\_advection\_in\_gyre} - Test of various
28    advection schemes in a single-layer double-gyre experiment.    advection schemes in a single-layer double-gyre experiment.
29    This experiment is described in detail in section    This experiment is described in detail in section
30    \ref{sect:eg-adv-gyre}.    \ref{sec:eg-adv-gyre}.
31    
32  \item \texttt{tutorial\_baroclinic\_gyre} - Four layer, ocean double  \item \texttt{tutorial\_baroclinic\_gyre} - Four layer, ocean double
33    gyre. This experiment is described in detail in section    gyre. This experiment is described in detail in section
34    \ref{sect:eg-fourlayer}.    \ref{sec:eg-fourlayer}.
35    
36  \item \texttt{tutorial\_barotropic\_gyre} - Single layer, ocean double  \item \texttt{tutorial\_barotropic\_gyre} - Single layer, ocean double
37    gyre (barotropic with free-surface).    gyre (barotropic with free-surface).
38    This experiment is described in detail in section \ref{sect:eg-baro}.    This experiment is described in detail in section \ref{sec:eg-baro}.
39    
40  \item \texttt{tutorial\_cfc\_offline} - Offline form of the MITgcm to  \item \texttt{tutorial\_cfc\_offline} - Offline form of the MITgcm to
41    study advection of a passive tracer and CFCs.    study advection of a passive tracer and CFCs.
42    This experiment is described in detail in section \ref{sect:eg-offline-cfc}.    This experiment is described in detail in section \ref{sec:eg-offline-cfc}.
43    
44  \item \texttt{tutorial\_deep\_convection} - Inhomogenously forced  \item \texttt{tutorial\_deep\_convection} - Non-uniformly forced
45    ocean convection in a doubly periodic box. This experiment is    ocean convection in a doubly periodic box. This experiment is
46    described in detail in section \ref{sect:eg-bconv}.    described in detail in section \ref{sec:eg-bconv}.
47    
48    \item \texttt{tutorial\_dic\_adoffline} - Offline form of MITgcm
49      dynamics coupled to the dissolved inorganic carbon biogeochemistry model;
50      adjoint set-up.
51    
52  \item \texttt{tutorial\_global\_oce\_biogeo} - Ocean model coupled to  \item \texttt{tutorial\_global\_oce\_biogeo} - Ocean model coupled to
53    the dissolved inorganic carbon biogeochemistry model. This    the dissolved inorganic carbon biogeochemistry model. This
54    experiment is described in detail in section    experiment is described in detail in section
55    \ref{sect:eg-biogeochem_tutorial}.    \ref{sec:eg-biogeochem_tutorial}.
56    
57  \item \texttt{tutorial\_global\_oce\_in\_p} - Global ocean simulation in  \item \texttt{tutorial\_global\_oce\_in\_p} - Global ocean simulation in
58    pressure coordinate (non-Boussinesq ocean model). Described in    pressure coordinate (non-Boussinesq ocean model). Described in
59    detail in section \ref{sect:eg-globalpressure}.    detail in section \ref{sec:eg-globalpressure}.
60    
61  \item \texttt{tutorial\_global\_oce\_latlon} - 4x4 degree global ocean  \item \texttt{tutorial\_global\_oce\_latlon} - 4x4 degree global ocean
62    simulation with steady climatological forcing. This experiment is    simulation with steady climatological forcing. This experiment is
63    described in detail in section \ref{sect:eg-global}.    described in detail in section \ref{sec:eg-global}.
64    
65  \item \texttt{tutorial\_global\_oce\_optim} - Global ocean state  \item \texttt{tutorial\_global\_oce\_optim} - Global ocean state
66    estimation at $4^\circ$ resolution.  This experiment is described in    estimation at $4^\circ$ resolution.  This experiment is described in
67    detail in section \ref{sect:eg-global_state_estimate}.    detail in section \ref{sec:eg-global_state_estimate}.
68    
69  \item \texttt{tutorial\_held\_suarez\_cs} - 3D atmosphere dynamics  \item \texttt{tutorial\_held\_suarez\_cs} - 3D atmosphere dynamics
70    using Held and Suarez (1994) forcing on cubed sphere grid.  This    using Held and Suarez (1994) forcing on cubed sphere grid.  This
71    experiment is described in detail in section \ref{sect:eg-hs}.    experiment is described in detail in section \ref{sec:eg-hs}.
72      
73  \item \texttt{tutorial\_offline} - Offline form of the MITgcm to study  \item \texttt{tutorial\_offline} - Offline form of the MITgcm to study
74    advection of a passive tracer.  This experiment is described in    advection of a passive tracer.  This experiment is described in
75    detail in section \ref{sect:eg-offline}.    detail in section \ref{sec:eg-offline}.
76    
77  \item \texttt{tutorial\_plume\_on\_slope} - Gravity Plume on a  \item \texttt{tutorial\_plume\_on\_slope} - Gravity Plume on a
78    continental slope.  This experiment is described in detail in    continental slope.  This experiment is described in detail in
79    section \ref{sect:eg-gravityplume}.    section \ref{sec:eg-gravityplume}.
80    
81  \item \texttt{tutorial\_tracer\_adjsens} - Simple passive tracer  \item \texttt{tutorial\_tracer\_adjsens} - Simple passive tracer
82    experiment. Includes derivative calculation. This experiment is    experiment. Includes derivative calculation. This experiment is
83    described in detail in section \ref{sect:eg-simple-tracer-adjoint}.    described in detail in section \ref{sec:eg-simple-tracer-adjoint}.\\
84      Also contains an additional set-up using Secon Order Moment (SOM) advection
85      scheme ({\it input\_ad.som81/}).
86    
87    \item \texttt{1D\_ocean\_ice\_column} - Oceanic column with seaice on top.
88    
89  \item \texttt{adjustment.128x64x1} - Barotropic adjustment problem on  \item \texttt{adjustment.128x64x1} - Barotropic adjustment problem on
90    latitude longitude grid with 128x64 grid points ($2.8^\circ$ resolution).    latitude longitude grid with 128x64 grid points ($2.8^\circ$ resolution).
91      
92  \item \texttt{adjustment.cs-32x32x1} - Barotropic adjustment problem on  \item \texttt{adjustment.cs-32x32x1} - Barotropic adjustment problem on
93    cube sphere grid with 32x32 points per face (roughly $2.8^\circ$    cube sphere grid with 32x32 points per face (roughly $2.8^\circ$
94    resolution).\\    resolution).\\
95    Also contains a non-linear free-surface adjustment version ({\it input.nlfs/}).    Also contains a non-linear free-surface adjustment version ({\it input.nlfs/}).
96      
97  \item \texttt{advect\_cs} Two-dimensional passive advection test on  \item \texttt{advect\_cs} - Two-dimensional passive advection test on
98    cube sphere grid (32x32 grid points per face, roughly $2.8^\circ$)    cube sphere grid (32x32 grid points per face, roughly $2.8^\circ$ resolution)
99      
100  \item \texttt{advect\_xy} - Two-dimensional (horizontal plane) passive  \item \texttt{advect\_xy} - Two-dimensional (horizontal plane) passive
101    advection test on Cartesian grid.\\    advection test on Cartesian grid.\\
102    Also contains an additional set-up using Adams-Bashforth 3 ({\it input.ab3\_c4/}).    Also contains an additional set-up using Adams-Bashforth 3 ({\it input.ab3\_c4/}).
103      
104  \item \texttt{advect\_xz} - Two-dimensional (vertical plane) passive  \item \texttt{advect\_xz} - Two-dimensional (vertical plane) passive
105    advection test on Cartesian grid.    advection test on Cartesian grid.\\
106        Also contains an additional set-up using non-linear free-surface
107  \item \texttt{aim.5l\_Equatorial\_Channel}     with divergent barotropic flow and implicit vertical advection ({\it input.nlfs/}).
108    - 5-levels Intermediate Atmospheric physics,  
109    \item \texttt{aim.5l\_Equatorial\_Channel} -
110      5-levels Intermediate Atmospheric physics,
111    3D Equatorial Channel configuration.    3D Equatorial Channel configuration.
112      
113  \item \texttt{aim.5l\_LatLon} - 5-levels Intermediate Atmospheric physics,  \item \texttt{aim.5l\_LatLon} - 5-levels Intermediate Atmospheric physics,
114    Global configuration, on latitude longitude grid with 128x64x5 grid    Global configuration, on latitude longitude grid with 128x64x5 grid
115    points ($2.8^\circ$ resolution).    points ($2.8^\circ$ resolution).
116      
117  \item \texttt{aim.5l\_cs} - 5-levels Intermediate Atmospheric physics,  \item \texttt{aim.5l\_cs} - 5-levels Intermediate Atmospheric physics,
118    Global configuration on cube sphere grid    Global configuration on cube sphere grid
119    (32x32 grid points per face, roughly $2.8^\circ$).\\    (32x32 grid points per face, roughly $2.8^\circ$).\\
120    Also contains an additional set-up with an ocean mixed layer and thermodynamics    Also contains an additional set-up with a slab-ocean and thermodynamic
121    sea-ice ({\it input.thSI/}).    sea-ice ({\it input.thSI/}).
122    
123  \item \texttt{bottom\_ctrl\_5x5} - Adjoint test using the bottom  \item \texttt{bottom\_ctrl\_5x5} - Adjoint test using the bottom
# Line 116  Each example is briefly described below. Line 126  Each example is briefly described below.
126  \item \texttt{cfc\_example} - Global ocean with online computation and  \item \texttt{cfc\_example} - Global ocean with online computation and
127    advection of CFC11 and CFC12.    advection of CFC11 and CFC12.
128    
129  \item \texttt{cpl\_aim+ocn} - Coupled Ocean - Atmosphere realistic  \item \texttt{cheapAML\_box} - Example using cheap atmospheric mixed layer
130    configuration on cubed-sphere cs32 horizontal grid,     (cheapAML) package.
131    
132    \item \texttt{cpl\_aim+ocn} - Coupled Ocean - Atmosphere realistic
133      configuration on cubed-sphere cs32 horizontal grid,
134    using Intermediate Atmospheric physics ({\it pkg/aim\_v23})    using Intermediate Atmospheric physics ({\it pkg/aim\_v23})
135    thermodynamics seaice ({\it pkg/thsice}) and land packages.    thermodynamic seaice ({\it pkg/thsice}) and land packages.
136    on cubed-sphere cs32 in a realistics configuration.    on cubed-sphere cs32 in a realistic configuration.
137    
138  \item \texttt{cpl\_atm2d+ocn} - Coupled Ocean - Atmosphere realistic  \item \texttt{cpl\_atm2d+ocn} - Coupled Ocean - Atmosphere realistic
139    configuration using 2-D Atmospheric Model ({\it pkg/atm2d}).    configuration using 2-D Atmospheric Model ({\it pkg/atm2d}).
140    
141  \item \texttt{deep\_anelastic} - Convection simulation on a giant planet:  \item \texttt{deep\_anelastic} - Convection simulation on a giant planet:
# Line 131  Each example is briefly described below. Line 144  Each example is briefly described below.
144    
145  \item \texttt{dome} - Idealized 3D test of a density-driven bottom current.  \item \texttt{dome} - Idealized 3D test of a density-driven bottom current.
146    
147  \item \texttt{exp2} - Old version of the global ocean experiment (no GM,  \item \texttt{exp2} - Old version of the global ocean experiment (no GM,
148        no partial-cells).\\        no partial-cells).\\
149    Also contains an additional set-up with ridid-lid ({\it input.rigidLid/}).    Also contains an additional set-up with rigid-lid ({\it input.rigidLid/}).
150    
151  \item \texttt{exp4} - Flow over a Gaussian bump in open-water or  \item \texttt{exp4} - Flow over a Gaussian bump in open-water or
152    channel with open boundaries.    channel with open boundaries.\\
153        Also contains an additional set-up using non-linear free-surface ({\it input.nlfs/}).
 \item \texttt{exp5} - Deep convection.  
154    
155  \item \texttt{fizhi-cs-32x32x40} - Global atmospheric simulation with  \item \texttt{fizhi-cs-32x32x40} - Global atmospheric simulation with
156    realistic topography, 40 vertical levels, a cubed sphere grid and    realistic topography, 40 vertical levels, a cubed sphere grid and
# Line 154  Each example is briefly described below. Line 166  Each example is briefly described below.
166    dynamical forcing running on different vertical grids.    dynamical forcing running on different vertical grids.
167    
168  \item \texttt{flt\_example} - Example of using float package.  \item \texttt{flt\_example} - Example of using float package.
169      
170  \item \texttt{front\_relax} - Relaxation of an ocean thermal front  \item \texttt{front\_relax} - Relaxation of an ocean thermal front
171    (test for Gent/McWilliams scheme). 2D (Y-Z).\\    (test for Gent/McWilliams scheme). 2D (y-z).\\
172    Also contains an additional set-up with Mixed-Layer Eddy parameterization    Also contains additional set-ups:
173    (Ferrari \& McWilliams, 2007) ({\it input.mxl/}).    \begin{enumerate}
174       \item using the Boundary-Value Problem method
175  \item \texttt{global1x1\_tot} - ECCO-GODAE production configuration            (Ferrari et al., 2010) ({\it input.bvp/}).
176   version 1, 2 \& 3     \item with Mixed-Layer Eddy parameterization
177              (Ferrari \& McWilliams, 2007) ({\it input.mxl/}).
178  \item \texttt{global2x2\_tot} - ECCO production configuration version 0    \end{enumerate}
   
 \item \texttt{global\_ocean.90x40x15} Global ocean simulation at 4x4  
   degree resolution. Similar to tutorial\_global\_oce\_latlon, with  
   quasi-non-hydrostatics and non-hydrostatic metric terms.\\  
   Also contains an adjoint set-up ({\it code\_ad/, input\_ad/}).  
179    
180  \item \texttt{global\_ocean.cs32x15} - Global ocean experiment on the  \item \texttt{global\_ocean.90x40x15} - Global ocean simulation at 4x4
181    cubed sphere grid.\\    degree resolution. Similar to tutorial\_global\_oce\_latlon, but using
182      $z^*$ coordinates with quasi-non-hydrostatic and non-hydrostatic metric terms.
183      This experiment also illustrate the use of SBO package.
184    Also contains additional set-ups:    Also contains additional set-ups:
185    \begin{enumerate}    \begin{enumerate}
186     \item non-hydrostratic with biharmonic viscosity ({\it input.viscA4/})     \item using down-slope package ({\it pkg/down\_slope}) ({\it input.dwnslp/})
187       \item an Open-AD adjoint set-up ({\it code\_oad/, input\_oad/}).
188       \item four TAF adjoint set-ups ({\it code\_ad/}):
189       \begin{enumerate}
190         \item standard experiment ({\it input\_ad/}).
191         \item with bottom drag as a control ({\it input\_ad.bottomdrag/}).
192         \item with kappa GM as a control ({\it input\_ad.kapgm/}).
193         \item with kappa Redi as a control ({\it input\_ad.kapredi/}).
194       \end{enumerate}
195      \end{enumerate}
196    
197    \item \texttt{global\_ocean.cs32x15} - Global ocean experiment on the
198      cubed sphere grid.\\
199      Also contains additional forward set-ups:
200      \begin{enumerate}
201       \item non-hydrostatic with biharmonic viscosity ({\it input.viscA4/})
202     \item using thermodynamic sea ice and bulk force ({\it input.thsice/})     \item using thermodynamic sea ice and bulk force ({\it input.thsice/})
203     \item using thermodynamic ({\it pkg/thsice}) dynamics ({\it pkg/seaice}) sea-ice     \item using thermodynamic ({\it pkg/thsice}) dynamic ({\it pkg/seaice}) sea-ice
204           and EXF package ({\it input.icedyn/})           and {\it exf} package ({\it input.icedyn/})
205       \item using thermodynamic - dynamic ({\it pkg/seaice}) sea-ice
206             with {\it exf} package ({\it input.seaice/})
207      \end{enumerate}
208      and few additional adjoint set-ups ({\it code\_ad/}):
209      \begin{enumerate}
210       \item standard experiment without sea-ice ({\it input\_ad/}).
211       \item using thermodynamic - dynamic sea-ice ({\it input\_ad.seaice/})
212       \item same as above without adjoint sea-ice dynamics ({\it input\_ad.seaice\_dynmix/})
213       \item using thermodynamic sea-ice from {\it thsice} package ({\it input\_ad.thsice/})
214    \end{enumerate}    \end{enumerate}
215    
216  \item \texttt{global\_ocean\_ebm} - Global ocean experiment on a lat-lon  \item \texttt{global\_ocean\_ebm} - Global ocean experiment on a lat-lon
# Line 186  Each example is briefly described below. Line 219  Each example is briefly described below.
219    Also contains an adjoint set-up ({\it code\_ad/, input\_ad/}).    Also contains an adjoint set-up ({\it code\_ad/, input\_ad/}).
220    
221  \item \texttt{global\_with\_exf} - Global ocean experiment on a lat-lon  \item \texttt{global\_with\_exf} - Global ocean experiment on a lat-lon
222    grid using the exf package. Similar to global\_ocean.90x40x15    grid using the {\it exf} package. Similar to tutorial\_global\_oce\_latlon
223    experiment.    experiment.\\
224      Also contains a secondary set-up with yearly {\it exf} fields ({\it input\_ad.yearly/}).
225    
226    \item \texttt{halfpipe\_streamice} - Example using package "streamice".\\
227      Also contains adjoint set-ups using TAF ({\it code\_ad/, input\_ad/})
228       and using Open-AD ({\it code\_oad/, input\_oad/}).
229    
230  \item \texttt{hs94.128x64x5} - 3D atmosphere dynamics on lat-lon grid,  \item \texttt{hs94.128x64x5} - 3D atmosphere dynamics on lat-lon grid,
231    using Held and Suarez '94 forcing.    using Held and Suarez '94 forcing.
232      
233  \item \texttt{hs94.1x64x5} - Zonal averaged atmosphere dynamics  \item \texttt{hs94.1x64x5} - Zonal averaged atmosphere dynamics
234    using Held and Suarez '94 forcing.\\    using Held and Suarez '94 forcing.\\
235    Also contains an adjoint set-up ({\it code\_ad/, input\_ad/}).    Also contains adjoint set-ups using TAF ({\it code\_ad/, input\_ad/})
236         and using Open-AD ({\it code\_oad/, input\_oad/}).
237    
238  \item \texttt{hs94.cs-32x32x5} - 3D atmosphere dynamics using Held and  \item \texttt{hs94.cs-32x32x5} - 3D atmosphere dynamics using Held and
239    Suarez (1994) forcing on the cubed sphere. 5 vertical levels.\\    Suarez (1994) forcing on the cubed sphere, similar to tutorial\_held\_suarez\_cs
240      experiment but using linear free-surface and only 5 levels.\\
241    Also contains an additional set-up with Implicit Internal gravity waves    Also contains an additional set-up with Implicit Internal gravity waves
242    treatment ({\it input.impIGW/}).    treatment and Adams-Bashforth 3 ({\it input.impIGW/}).
243    
244  \item \texttt{ideal\_2D\_oce} - Idealized 2D global ocean simulation on  \item \texttt{ideal\_2D\_oce} - Idealized 2D global ocean simulation on
245    an aqua planet.    an aqua planet.
246    
247  \item \texttt{internal\_wave} - Ocean internal wave forced by open  \item \texttt{internal\_wave} - Ocean internal wave forced by open
248    boundary conditions.    boundary conditions.\\
249      Also contains an additional set-up using {\it pkg/kl10} (see section
250       \ref{sec:pkg:kl10}, Klymak and Legg, 2010) ({\it input.kl10/}).
251    
252  \item \texttt{inverted\_barometer} - Simple test of ocean response to  \item \texttt{inverted\_barometer} - Simple test of ocean response to
253    atmospheric pressure loading.    atmospheric pressure loading.
254    
255  \item \texttt{isomip} - ISOMIP like set-up including ice-shelf cavities  \item \texttt{isomip} - ISOMIP like set-up including ice-shelf cavities
256    ({\it pkg/shelfice}).\\    ({\it pkg/shelfice}).\\
257    Also contains an additional set-up with ({\it input.htd/})    Also contains additional set-ups:
258    but only Martin knows what "htd" stands for.    \begin{enumerate}
259       \item with "htd" ({\it input.htd/})
260              but only Martin knows what "htd" stands for.
261       \item using package {\it icefront} ({\it input.icefront})
262      \end{enumerate}
263      and also adjoint set-ups using TAF ({\it code\_ad/, input\_ad/, input\_ad.htd/})
264      or using Open-AD ({\it code\_oad/, input\_oad/}).
265    
266  \item \texttt{lab\_sea} - Regional Labrador Sea simulation on a lat-lon  \item \texttt{lab\_sea} - Regional Labrador Sea simulation on a lat-lon
267    grid using the sea ice package.\\    grid using the sea ice package.\\
268    Also contains additional set-ups:    Also contains additional set-ups:
269    \begin{enumerate}    \begin{enumerate}
270     \item using the LSR solver (instead of EVP dynamics) ({\it input.lsr/})     \item using the simple "free-drift" assumption for seaice ({\it input.fd/})
271     \item using Hibler and Bryan (1987) sea-ice ocean stress ({\it input.hb87/})     \item using EVP dynamics (instead of LSR solver) and Hibler \& Bryan (1987)
272             sea-ice ocean stress ({\it input.hb87/})
273     \item using package {\it salt\_plume} ({\it input.salt\_plume/})     \item using package {\it salt\_plume} ({\it input.salt\_plume/})
274    \end{enumerate}    \end{enumerate}
275    and also 3 adjoint set-ups ({\it code\_ad/, input\_ad/, input\_ad.noseaicedyn/,    and also 3 adjoint set-ups ({\it code\_ad/, input\_ad/, input\_ad.noseaicedyn/,
276    input\_ad.noseaice/}).     input\_ad.noseaice/}).
277    
278  \item \texttt{matrix\_example} - Test of experimental method to  \item \texttt{matrix\_example} - Test of experimental method to
279    accelerated convergence towards equillibrium.    accelerated convergence towards equilibrium.
280    
281  \item \texttt{MLAdjust} - Simple tests for different viscosity formulations.\\  \item \texttt{MLAdjust} - Simple tests for different viscosity formulations.\\
282    Also contains additional set-ups:    Also contains additional set-ups (see: {\it verification/MLAdjust/README}):
283    \begin{enumerate}    \begin{enumerate}
284     \item ({\it input.0.leith/})     \item ({\it input.A4FlxF/})
285     \item ({\it input.0.leithD/})     \item ({\it input.AhFlxF/})
286     \item ({\it input.0.smag/})     \item ({\it input.AhVrDv/})
287     \item ({\it input.1.leith/})     \item ({\it input.AhStTn/})
288    \end{enumerate}    \end{enumerate}
289    
290  \item \texttt{natl\_box} - Eastern subtropical North Atlantic with KPP  \item \texttt{natl\_box} - Eastern subtropical North Atlantic with KPP
291    scheme; 1 month integration    scheme; 1 month integration
292    
293  \item \texttt{natl\_box\_adjoint} - Eastern subtropical North Atlantic with KPP  \item \texttt{obcs\_ctrl} - Adjoint test using Open-Boundary conditions
294    scheme; adjoint set-up.    as control parameters.
295    
296  \item \texttt{offline\_exf\_seaice} - oceanic surface forcing computed  \item \texttt{offline\_exf\_seaice} - Seaice on top of oceanic surface layer
297    by bulk-formulae ({\it pkg/exf}) and inposed SST (offline ocean).\\    in an idealized channel. Forcing is computed by bulk-formulae ({\it pkg/exf})
298      with temperature relaxation to prescribed SST (offline ocean).\\
299    Also contains additional set-ups:    Also contains additional set-ups:
300    \begin{enumerate}    \begin{enumerate}
301     \item with sea-ice ({\it pkg/seaice}) thermodynamics ({\it input.seaicetd/})     \item sea-ice dynamics-only using JFNK solver
302     \item an adjoint test ({\it code\_ad/, input\_ad/}).           and {\it pkg/thsice} advection ({\it input.dyn\_jfnk/})
303       \item sea-ice dynamics-only using LSR solver
304             and {\it pkg/seaice} advection ({\it input.dyn\_lsr/})
305       \item sea-ice thermodynamics-only using {\it pkg/seaice} ({\it input.thermo/})
306       \item sea-ice thermodynamics-only using {\it pkg/thsice} ({\it input.thsice/})
307    \end{enumerate}    \end{enumerate}
308        and also 2 adjoint set-ups ({\it code\_ad/, input\_ad/, input\_ad.thsice/}).
 \item \texttt{OpenAD} simple Adjoint experiement (used also to test  
   open-AD compiler)  
309    
310  \item \texttt{rotating\_tank} Rotating tank simulation in cylindrical  \item \texttt{OpenAD} - Simple Adjoint experiment (used also to test
311      Open-AD compiler)
312    
313    \item \texttt{rotating\_tank} - Rotating tank simulation in cylindrical
314    coordinates.  This experiment is described in detail in section    coordinates.  This experiment is described in detail in section
315    \ref{sect:eg-tank}.    \ref{sec:eg-tank}.
316    
317    \item \texttt{seaice\_itd} - Seaice example using Ice Thickness Distribution (ITD).\\
318      Also contains additional set-ups:
319      \begin{enumerate}
320       \item ({\it input.thermo/})
321       \item ({\it input.lipscomb07/})
322      \end{enumerate}
323    
324  \item \texttt{seaice\_obcs} similar to "lab\_sea" ({\it input.salt\_plume/})  \item \texttt{seaice\_obcs} - Similar to "lab\_sea" ({\it input.salt\_plume/})
325    experiment with only a fraction of the domain and open-boundary conditions    experiment with only a fraction of the domain and open-boundary conditions
326    derived from "lab\_sea" experiment.    derived from "lab\_sea" experiment.\\
327      Also contains additional set-ups:
328      \begin{enumerate}
329       \item ({\it input.seaiceSponge/})
330       \item ({\it input.tides/})
331      \end{enumerate}
332    
333    \item \texttt{short\_surf\_wave} - Short surface wave adjusment
334       (non-hydrostatic) in homogeneous 2-D vertical section (x-z).
335    
336  \item \texttt{solid-body.cs-32x32x1} Solid body rotation test for cube  \item \texttt{so\_box\_biogeo} - Open-boundary Southern ocean box around
337     Drake passage, using same model parameters and forcing as experiment
338      "tutorial\_global\_oce\_biogeo" from which initial conditions
339     and OB conditions have been extracted.
340    
341    \item \texttt{solid-body.cs-32x32x1} - Solid body rotation test for cube
342    sphere grid.    sphere grid.
343    
344  \item \texttt{tidal\_basin\_2d} 2-D vertical section (X-Z) with tidal forcing  \item \texttt{tidal\_basin\_2d} - 2-D vertical section (x-z) with tidal forcing
345     (untested)
346    
347  \item \texttt{vermix} Simple test in a small domain (3 columns) for  \item \texttt{vermix} - Simple test in a small domain (3 columns) for
348    ocean vertical mixing schemes. The standard set-up ({\it input/}) uses    ocean vertical mixing schemes. The standard set-up ({\it input/}) uses
349    KPP scheme.\\    KPP scheme \cite[]{lar-eta:94}.\\
350    Also contains additional set-ups:    Also contains additional set-ups:
351    \begin{enumerate}    \begin{enumerate}
352     \item with Gaspar et al. (1990) ({\it pkg/ggl90}) scheme ({\it input.ggl90/})     \item with Double Diffusion scheme from KPP ({\it input.dd/})
353     \item with Mellor \& Yamada (1982) level 2. ({\it pkg/my82}) scheme ({\it input.my82/})     \item with \cite{gas-eta:90} ({\it pkg/ggl90}) scheme ({\it input.ggl90/})
354     \item with Paluszkiewicz \& Romea (1997) ({\it pkg/opps}) scheme ({\it input.opps/})     \item with \cite{Mellor:Yamada1982} level 2. ({\it pkg/my82}) scheme ({\it input.my82/})
355     \item with Pacanowski \& Philander (1981) ({\it pkg/pp81}) scheme ({\it input.pp81/})     \item with \cite{pal-rom:97} ({\it pkg/opps}) scheme ({\it input.opps/})
356       \item with \cite{Pacanowski:Philander1981} ({\it pkg/pp81}) scheme ({\it input.pp81/})
357    \end{enumerate}    \end{enumerate}
358    
359  \end{enumerate}  \end{enumerate}
# Line 302  Each example directory has the following Line 379  Each example directory has the following
379    \item \texttt{code/CPP\_EEOPTIONS.h}: declares CPP keys relative to    \item \texttt{code/CPP\_EEOPTIONS.h}: declares CPP keys relative to
380      the ``execution environment'' part of the code. The default      the ``execution environment'' part of the code. The default
381      version is located in \texttt{eesupp/inc}.      version is located in \texttt{eesupp/inc}.
382      
383    \item \texttt{code/CPP\_OPTIONS.h}: declares CPP keys relative to    \item \texttt{code/CPP\_OPTIONS.h}: declares CPP keys relative to
384      the ``numerical model'' part of the code. The default version is      the ``numerical model'' part of the code. The default version is
385      located in \texttt{model/inc}.      located in \texttt{model/inc}.
386      
387    \item \texttt{code/SIZE.h}: declares size of underlying    \item \texttt{code/SIZE.h}: declares size of underlying
388      computational grid.  The default version is located in      computational grid.  The default version is located in
389      \texttt{model/inc}.      \texttt{model/inc}.
390    \end{itemize}    \end{itemize}
391      
392    In addition, other include files and subroutines might be present in    In addition, other include files and subroutines might be present in
393    \texttt{code} depending on the particular experiment. See Section 2    \texttt{code} depending on the particular experiment. See Section 2
394    for more details.    for more details.
395      
396  \item \texttt{input}: contains the input data files required to run  \item \texttt{input}: contains the input data files required to run
397    the example. At a minimum, the \texttt{input} directory contains the    the example. At a minimum, the \texttt{input} directory contains the
398    following files:    following files:
# Line 323  Each example directory has the following Line 400  Each example directory has the following
400    \begin{itemize}    \begin{itemize}
401    \item \texttt{input/data}: this file, written as a namelist,    \item \texttt{input/data}: this file, written as a namelist,
402      specifies the main parameters for the experiment.      specifies the main parameters for the experiment.
403      
404    \item \texttt{input/data.pkg}: contains parameters relative to the    \item \texttt{input/data.pkg}: contains parameters relative to the
405      packages used in the experiment.      packages used in the experiment.
406      
407    \item \texttt{input/eedata}: this file contains ``execution    \item \texttt{input/eedata}: this file contains ``execution
408      environment'' data. At present, this consists of a specification      environment'' data. At present, this consists of a specification
409      of the number of threads to use in $X$ and $Y$ under multithreaded      of the number of threads to use in $X$ and $Y$ under multi-threaded
410      execution.      execution.
411    \end{itemize}    \end{itemize}
412      
413    In addition, you will also find in this directory the forcing and    In addition, you will also find in this directory the forcing and
414    topography files as well as the files describing the initial state    topography files as well as the files describing the initial state
415    of the experiment.  This varies from experiment to experiment. See    of the experiment.  This varies from experiment to experiment. See
# Line 343  Each example directory has the following Line 420  Each example directory has the following
420    useful for comparison with your own output when you run the    useful for comparison with your own output when you run the
421    experiment.    experiment.
422    
423  \item \texttt{build}: this directory is where the model is compiled  \item \texttt{build}: this directory is initially empty and is used
424    and loaded, and where the executable resides.    to compile and load the model, and to generate the executable.
425    
426    \item \texttt{run}: this directory is initially empty and is used
427      to run the executable.
428    
429  \end{itemize}  \end{itemize}
430    

Legend:
Removed from v.1.22  
changed lines
  Added in v.1.26

  ViewVC Help
Powered by ViewVC 1.1.22