/[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.24 by jmc, Wed May 11 19:17:52 2011 UTC revision 1.25 by jmc, Tue Mar 26 13:21:28 2013 UTC
# 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
# Line 34  Each example is briefly described below. Line 34  Each example is briefly described below.
34    \ref{sec: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{sec: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
# Line 65  Each example is briefly described below. Line 65  Each example is briefly described below.
65  \item \texttt{tutorial\_held\_suarez\_cs} - 3D atmosphere dynamics  \item \texttt{tutorial\_held\_suarez\_cs} - 3D atmosphere dynamics
66    using Held and Suarez (1994) forcing on cubed sphere grid.  This    using Held and Suarez (1994) forcing on cubed sphere grid.  This
67    experiment is described in detail in section \ref{sec:eg-hs}.    experiment is described in detail in section \ref{sec:eg-hs}.
68      
69  \item \texttt{tutorial\_offline} - Offline form of the MITgcm to study  \item \texttt{tutorial\_offline} - Offline form of the MITgcm to study
70    advection of a passive tracer.  This experiment is described in    advection of a passive tracer.  This experiment is described in
71    detail in section \ref{sec:eg-offline}.    detail in section \ref{sec:eg-offline}.
# Line 80  Each example is briefly described below. Line 80  Each example is briefly described below.
80    
81  \item \texttt{adjustment.128x64x1} - Barotropic adjustment problem on  \item \texttt{adjustment.128x64x1} - Barotropic adjustment problem on
82    latitude longitude grid with 128x64 grid points ($2.8^\circ$ resolution).    latitude longitude grid with 128x64 grid points ($2.8^\circ$ resolution).
83      
84  \item \texttt{adjustment.cs-32x32x1} - Barotropic adjustment problem on  \item \texttt{adjustment.cs-32x32x1} - Barotropic adjustment problem on
85    cube sphere grid with 32x32 points per face (roughly $2.8^\circ$    cube sphere grid with 32x32 points per face (roughly $2.8^\circ$
86    resolution).\\    resolution).\\
87    Also contains a non-linear free-surface adjustment version ({\it input.nlfs/}).    Also contains a non-linear free-surface adjustment version ({\it input.nlfs/}).
88      
89  \item \texttt{advect\_cs} Two-dimensional passive advection test on  \item \texttt{advect\_cs} Two-dimensional passive advection test on
90    cube sphere grid (32x32 grid points per face, roughly $2.8^\circ$)    cube sphere grid (32x32 grid points per face, roughly $2.8^\circ$)
91      
92  \item \texttt{advect\_xy} - Two-dimensional (horizontal plane) passive  \item \texttt{advect\_xy} - Two-dimensional (horizontal plane) passive
93    advection test on Cartesian grid.\\    advection test on Cartesian grid.\\
94    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/}).
95      
96  \item \texttt{advect\_xz} - Two-dimensional (vertical plane) passive  \item \texttt{advect\_xz} - Two-dimensional (vertical plane) passive
97    advection test on Cartesian grid.    advection test on Cartesian grid.
98      
99  \item \texttt{aim.5l\_Equatorial\_Channel}  \item \texttt{aim.5l\_Equatorial\_Channel}
100    - 5-levels Intermediate Atmospheric physics,    - 5-levels Intermediate Atmospheric physics,
101    3D Equatorial Channel configuration.    3D Equatorial Channel configuration.
102      
103  \item \texttt{aim.5l\_LatLon} - 5-levels Intermediate Atmospheric physics,  \item \texttt{aim.5l\_LatLon} - 5-levels Intermediate Atmospheric physics,
104    Global configuration, on latitude longitude grid with 128x64x5 grid    Global configuration, on latitude longitude grid with 128x64x5 grid
105    points ($2.8^\circ$ resolution).    points ($2.8^\circ$ resolution).
106      
107  \item \texttt{aim.5l\_cs} - 5-levels Intermediate Atmospheric physics,  \item \texttt{aim.5l\_cs} - 5-levels Intermediate Atmospheric physics,
108    Global configuration on cube sphere grid    Global configuration on cube sphere grid
109    (32x32 grid points per face, roughly $2.8^\circ$).\\    (32x32 grid points per face, roughly $2.8^\circ$).\\
110    Also contains an additional set-up with an ocean mixed layer and thermodynamics    Also contains an additional set-up with an ocean mixed layer and thermodynamics
111    sea-ice ({\it input.thSI/}).    sea-ice ({\it input.thSI/}).
# Line 116  Each example is briefly described below. Line 116  Each example is briefly described below.
116  \item \texttt{cfc\_example} - Global ocean with online computation and  \item \texttt{cfc\_example} - Global ocean with online computation and
117    advection of CFC11 and CFC12.    advection of CFC11 and CFC12.
118    
119  \item \texttt{cpl\_aim+ocn} - Coupled Ocean - Atmosphere realistic  \item \texttt{cpl\_aim+ocn} - Coupled Ocean - Atmosphere realistic
120    configuration on cubed-sphere cs32 horizontal grid,    configuration on cubed-sphere cs32 horizontal grid,
121    using Intermediate Atmospheric physics ({\it pkg/aim\_v23})    using Intermediate Atmospheric physics ({\it pkg/aim\_v23})
122    thermodynamics seaice ({\it pkg/thsice}) and land packages.    thermodynamics seaice ({\it pkg/thsice}) and land packages.
123    on cubed-sphere cs32 in a realistics configuration.    on cubed-sphere cs32 in a realistics configuration.
124    
125  \item \texttt{cpl\_atm2d+ocn} - Coupled Ocean - Atmosphere realistic  \item \texttt{cpl\_atm2d+ocn} - Coupled Ocean - Atmosphere realistic
126    configuration using 2-D Atmospheric Model ({\it pkg/atm2d}).    configuration using 2-D Atmospheric Model ({\it pkg/atm2d}).
127    
128  \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 131  Each example is briefly described below.
131    
132  \item \texttt{dome} - Idealized 3D test of a density-driven bottom current.  \item \texttt{dome} - Idealized 3D test of a density-driven bottom current.
133    
134  \item \texttt{exp2} - Old version of the global ocean experiment (no GM,  \item \texttt{exp2} - Old version of the global ocean experiment (no GM,
135        no partial-cells).\\        no partial-cells).\\
136    Also contains an additional set-up with ridid-lid ({\it input.rigidLid/}).    Also contains an additional set-up with ridid-lid ({\it input.rigidLid/}).
137    
138  \item \texttt{exp4} - Flow over a Gaussian bump in open-water or  \item \texttt{exp4} - Flow over a Gaussian bump in open-water or
139    channel with open boundaries.    channel with open boundaries.
140      
141  \item \texttt{exp5} - Deep convection.  \item \texttt{exp5} - Deep convection.
142    
143  \item \texttt{fizhi-cs-32x32x40} - Global atmospheric simulation with  \item \texttt{fizhi-cs-32x32x40} - Global atmospheric simulation with
# Line 154  Each example is briefly described below. Line 154  Each example is briefly described below.
154    dynamical forcing running on different vertical grids.    dynamical forcing running on different vertical grids.
155    
156  \item \texttt{flt\_example} - Example of using float package.  \item \texttt{flt\_example} - Example of using float package.
157      
158  \item \texttt{front\_relax} - Relaxation of an ocean thermal front  \item \texttt{front\_relax} - Relaxation of an ocean thermal front
159    (test for Gent/McWilliams scheme). 2D (Y-Z).\\    (test for Gent/McWilliams scheme). 2D (Y-Z).\\
160    Also contains an additional set-up with Mixed-Layer Eddy parameterization    Also contains an additional set-up with Mixed-Layer Eddy parameterization
# Line 165  Each example is briefly described below. Line 165  Each example is briefly described below.
165    
166  \item \texttt{global2x2\_tot} - ECCO production configuration version 0  \item \texttt{global2x2\_tot} - ECCO production configuration version 0
167    
168  \item \texttt{global\_ocean.90x40x15} Global ocean simulation at 4x4  \item \texttt{global\_ocean.90x40x15} Global ocean simulation at 4x4
169    degree resolution. Similar to tutorial\_global\_oce\_latlon, with    degree resolution. Similar to tutorial\_global\_oce\_latlon, with
170    quasi-non-hydrostatics and non-hydrostatic metric terms.\\    quasi-non-hydrostatics and non-hydrostatic metric terms.\\
171    Also contains an adjoint set-up ({\it code\_ad/, input\_ad/}).    Also contains an adjoint set-up ({\it code\_ad/, input\_ad/}).
172    
173  \item \texttt{global\_ocean.cs32x15} - Global ocean experiment on the  \item \texttt{global\_ocean.cs32x15} - Global ocean experiment on the
174    cubed sphere grid.\\    cubed sphere grid.\\
175    Also contains additional set-ups:    Also contains additional set-ups:
176    \begin{enumerate}    \begin{enumerate}
177     \item non-hydrostratic with biharmonic viscosity ({\it input.viscA4/})     \item non-hydrostratic with biharmonic viscosity ({\it input.viscA4/})
# Line 191  Each example is briefly described below. Line 191  Each example is briefly described below.
191    
192  \item \texttt{hs94.128x64x5} - 3D atmosphere dynamics on lat-lon grid,  \item \texttt{hs94.128x64x5} - 3D atmosphere dynamics on lat-lon grid,
193    using Held and Suarez '94 forcing.    using Held and Suarez '94 forcing.
194      
195  \item \texttt{hs94.1x64x5} - Zonal averaged atmosphere dynamics  \item \texttt{hs94.1x64x5} - Zonal averaged atmosphere dynamics
196    using Held and Suarez '94 forcing.\\    using Held and Suarez '94 forcing.\\
197    Also contains an adjoint set-up ({\it code\_ad/, input\_ad/}).    Also contains an adjoint set-up ({\it code\_ad/, input\_ad/}).
198      
199  \item \texttt{hs94.cs-32x32x5} - 3D atmosphere dynamics using Held and  \item \texttt{hs94.cs-32x32x5} - 3D atmosphere dynamics using Held and
200    Suarez (1994) forcing on the cubed sphere. 5 vertical levels.\\    Suarez (1994) forcing on the cubed sphere. 5 vertical levels.\\
201    Also contains an additional set-up with Implicit Internal gravity waves    Also contains an additional set-up with Implicit Internal gravity waves
# Line 251  Each example is briefly described below. Line 251  Each example is briefly described below.
251     \item with sea-ice ({\it pkg/seaice}) thermodynamics ({\it input.seaicetd/})     \item with sea-ice ({\it pkg/seaice}) thermodynamics ({\it input.seaicetd/})
252     \item an adjoint test ({\it code\_ad/, input\_ad/}).     \item an adjoint test ({\it code\_ad/, input\_ad/}).
253    \end{enumerate}    \end{enumerate}
254      
255  \item \texttt{OpenAD} simple Adjoint experiement (used also to test  \item \texttt{OpenAD} simple Adjoint experiement (used also to test
256    open-AD compiler)    open-AD compiler)
257    
258  \item \texttt{rotating\_tank} Rotating tank simulation in cylindrical  \item \texttt{rotating\_tank} Rotating tank simulation in cylindrical
# Line 270  Each example is briefly described below. Line 270  Each example is briefly described below.
270    
271  \item \texttt{vermix} Simple test in a small domain (3 columns) for  \item \texttt{vermix} Simple test in a small domain (3 columns) for
272    ocean vertical mixing schemes. The standard set-up ({\it input/}) uses    ocean vertical mixing schemes. The standard set-up ({\it input/}) uses
273    KPP scheme.\\    KPP scheme \cite[]{lar-eta:94}.\\
274    Also contains additional set-ups:    Also contains additional set-ups:
275    \begin{enumerate}    \begin{enumerate}
276     \item with Gaspar et al. (1990) ({\it pkg/ggl90}) scheme ({\it input.ggl90/})     \item with \cite{gas-eta:90} ({\it pkg/ggl90}) scheme ({\it input.ggl90/})
277     \item with Mellor \& Yamada (1982) level 2. ({\it pkg/my82}) scheme ({\it input.my82/})     \item with \cite{Mellor:Yamada1982} level 2. ({\it pkg/my82}) scheme ({\it input.my82/})
278     \item with Paluszkiewicz \& Romea (1997) ({\it pkg/opps}) scheme ({\it input.opps/})     \item with \cite{pal-rom:97} ({\it pkg/opps}) scheme ({\it input.opps/})
279     \item with Pacanowski \& Philander (1981) ({\it pkg/pp81}) scheme ({\it input.pp81/})     \item with \cite{Pacanowski:Philander1981} ({\it pkg/pp81}) scheme ({\it input.pp81/})
280    \end{enumerate}    \end{enumerate}
281    
282  \end{enumerate}  \end{enumerate}
# Line 302  Each example directory has the following Line 302  Each example directory has the following
302    \item \texttt{code/CPP\_EEOPTIONS.h}: declares CPP keys relative to    \item \texttt{code/CPP\_EEOPTIONS.h}: declares CPP keys relative to
303      the ``execution environment'' part of the code. The default      the ``execution environment'' part of the code. The default
304      version is located in \texttt{eesupp/inc}.      version is located in \texttt{eesupp/inc}.
305      
306    \item \texttt{code/CPP\_OPTIONS.h}: declares CPP keys relative to    \item \texttt{code/CPP\_OPTIONS.h}: declares CPP keys relative to
307      the ``numerical model'' part of the code. The default version is      the ``numerical model'' part of the code. The default version is
308      located in \texttt{model/inc}.      located in \texttt{model/inc}.
309      
310    \item \texttt{code/SIZE.h}: declares size of underlying    \item \texttt{code/SIZE.h}: declares size of underlying
311      computational grid.  The default version is located in      computational grid.  The default version is located in
312      \texttt{model/inc}.      \texttt{model/inc}.
313    \end{itemize}    \end{itemize}
314      
315    In addition, other include files and subroutines might be present in    In addition, other include files and subroutines might be present in
316    \texttt{code} depending on the particular experiment. See Section 2    \texttt{code} depending on the particular experiment. See Section 2
317    for more details.    for more details.
318      
319  \item \texttt{input}: contains the input data files required to run  \item \texttt{input}: contains the input data files required to run
320    the example. At a minimum, the \texttt{input} directory contains the    the example. At a minimum, the \texttt{input} directory contains the
321    following files:    following files:
# Line 323  Each example directory has the following Line 323  Each example directory has the following
323    \begin{itemize}    \begin{itemize}
324    \item \texttt{input/data}: this file, written as a namelist,    \item \texttt{input/data}: this file, written as a namelist,
325      specifies the main parameters for the experiment.      specifies the main parameters for the experiment.
326      
327    \item \texttt{input/data.pkg}: contains parameters relative to the    \item \texttt{input/data.pkg}: contains parameters relative to the
328      packages used in the experiment.      packages used in the experiment.
329      
330    \item \texttt{input/eedata}: this file contains ``execution    \item \texttt{input/eedata}: this file contains ``execution
331      environment'' data. At present, this consists of a specification      environment'' data. At present, this consists of a specification
332      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 multithreaded
333      execution.      execution.
334    \end{itemize}    \end{itemize}
335      
336    In addition, you will also find in this directory the forcing and    In addition, you will also find in this directory the forcing and
337    topography files as well as the files describing the initial state    topography files as well as the files describing the initial state
338    of the experiment.  This varies from experiment to experiment. See    of the experiment.  This varies from experiment to experiment. See

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.25

  ViewVC Help
Powered by ViewVC 1.1.22