/[MITgcm]/manual/s_examples/global_oce_latlon/inp_data.templ
ViewVC logotype

Diff of /manual/s_examples/global_oce_latlon/inp_data.templ

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

revision 1.3 by jmc, Mon May 2 12:30:44 2011 UTC revision 1.4 by jmc, Sun May 8 15:17:07 2011 UTC
# Line 4  Line 4 
4  %\subsubsection{File {\it input/data}}  %\subsubsection{File {\it input/data}}
5  %\label{www:tutorials}  %\label{www:tutorials}
6    
7  This file, reproduced completely below, specifies the main parameters  This file, reproduced completely below, specifies the main parameters
8  for the experiment. The parameters that are significant for this configuration  for the experiment. The parameters that are significant for this configuration
9  are  are
10    
11  \begin{itemize}  \begin{itemize}
12    
13  \item Lines 7--8  \item Lines PUT_LINE_NB:tRef=--PUT_LINE_NB:sRef=
14  \begin{verbatim}  \begin{verbatim}
15  tRef= 15*20.,  tRef= 15*20.,
16  sRef= 15*35.,  sRef= 15*35.,
17  \end{verbatim}  \end{verbatim}
18  %$\cdots$  %$\cdots$
19  %\\  %\\
20  set reference values for potential  set reference values for potential
21  temperature and salinity at each model level in units of $^{\circ}\mathrm{C}$ and  temperature and salinity at each model level in units of $^{\circ}\mathrm{C}$ and
22  ${\rm ppt}$. The entries are ordered from surface to depth.  ${\rm ppt}$. The entries are ordered from surface to depth.
23  Density is calculated from anomalies at each level evaluated  Density is calculated from anomalies at each level evaluated
24  with respect to the reference values set here.\\  with respect to the reference values set here.\\
# Line 29  with respect to the reference values set Line 29  with respect to the reference values set
29  \end{minipage}  \end{minipage}
30  }  }
31    
32  \item Line 9,  \item Line PUT_LINE_NB:viscAr=,
33  \begin{verbatim}  \begin{verbatim}
34  viscAr=1.E-3,  viscAr=1.E-3,
35  \end{verbatim}  \end{verbatim}
36  this line sets the vertical Laplacian dissipation coefficient to  this line sets the vertical Laplacian dissipation coefficient to
# Line 43  for this operator are specified later. Line 43  for this operator are specified later.
43  \end{minipage}  \end{minipage}
44  }  }
45    
46  \item Line 10,  \item Line PUT_LINE_NB:viscAh=,
47  \begin{verbatim}  \begin{verbatim}
48  viscAh=5.E5,  viscAh=5.E5,
49  \end{verbatim}  \end{verbatim}
50  this line sets the horizontal Laplacian frictional dissipation coefficient to  this line sets the horizontal Laplacian frictional dissipation coefficient to
51  $5 \times 10^{5} {\rm m^{2}s^{-1}}$. Boundary conditions  $5 \times 10^{5} {\rm m^{2}s^{-1}}$. Boundary conditions
52  for this operator are specified later.  for this operator are specified later.
53    
54  \item Lines 11 and 13,  \item Lines PUT_LINE_NB:diffKhT= and PUT_LINE_NB:diffKhS=,
55  \begin{verbatim}  \begin{verbatim}
56  diffKhT=0.0,  diffKhT=0.,
57  diffKhS=0.0,  diffKhS=0.,
58  \end{verbatim}  \end{verbatim}
59  set the horizontal diffusion coefficient for temperature and salinity  set the horizontal diffusion coefficient for temperature and salinity
60  to 0, since package GMREDI is used.  to 0, since package GMREDI is used.
61    
62  \item Lines 12 and 14,  \item Lines PUT_LINE_NB:diffKrT= and PUT_LINE_NB:diffKrS=,
63  \begin{verbatim}  \begin{verbatim}
64  diffKrT=3.E-5,  diffKrT=3.E-5,
65  diffKrS=3.E-5,  diffKrS=3.E-5,
66  \end{verbatim}  \end{verbatim}
67  set the vertical diffusion coefficient for temperature and salinity  set the vertical diffusion coefficient for temperature and salinity
68  to $3 \times 10^{-5}\,{\rm m^{2}s^{-1}}$. The boundary  to $3 \times 10^{-5}\,{\rm m^{2}s^{-1}}$. The boundary
69  condition on this operator is $\frac{\partial}{\partial z}=0$ at both  condition on this operator is $\frac{\partial}{\partial z}=0$ at both
70  the upper and lower boundaries.  the upper and lower boundaries.
71    
72  \item Lines 15--17  \item Lines PUT_LINE_NB:rhonil=--PUT_LINE_NB:eosType=
73  \begin{verbatim}  \begin{verbatim}
74  rhonil=1035.,  rhonil=1035.,
75  rhoConstFresh=1000.,  rhoConstFresh=1000.,
76  eosType = 'JMD95Z',  eosType = 'JMD95Z',
77  \end{verbatim}  \end{verbatim}
78  set the reference densities for sea water and fresh water, and selects  set the reference densities for sea water and fresh water, and selects
79  the equation of state \citep{jackett95}  the equation of state \citep{jackett95}
# Line 90  the equation of state \citep{jackett95} Line 90  the equation of state \citep{jackett95}
90  }  }
91    
92    
93  \item Lines 18--19,  \item Lines PUT_LINE_NB:ivdc_kappa=--PUT_LINE_NB:implicitDiffusion=,
94  \begin{verbatim}  \begin{verbatim}
95   ivdc_kappa=100.,   ivdc_kappa=100.,
96   implicitDiffusion=.TRUE.,   implicitDiffusion=.TRUE.,
# Line 104  diffusivity of 100~m$^2$/s in case of in Line 104  diffusivity of 100~m$^2$/s in case of in
104    
105  \item \ldots  \item \ldots
106    
107  \item Line 28,  \item Line PUT_LINE_NB:readBinaryPrec=,
108  \begin{verbatim}  \begin{verbatim}
109  readBinaryPrec=32,  readBinaryPrec=32,
110  \end{verbatim}  \end{verbatim}
# Line 117  use 32-bit representation for floating-p Line 117  use 32-bit representation for floating-p
117  \end{minipage}  \end{minipage}
118  }  }
119    
120  \item Line 33,  \item Line PUT_LINE_NB:cg2dMaxIters=,
121  \begin{verbatim}  \begin{verbatim}
122  cg2dMaxIters=500,  cg2dMaxIters=500,
123  \end{verbatim}  \end{verbatim}
124  Sets maximum number of iterations the two-dimensional, conjugate  Sets maximum number of iterations the two-dimensional, conjugate
125  gradient solver will use, {\bf irrespective of convergence  gradient solver will use, {\bf irrespective of convergence
126  criteria being met}.\\  criteria being met}.\\
127  \fbox{  \fbox{
128  \begin{minipage}{5.0in}  \begin{minipage}{5.0in}
# Line 130  criteria being met}.\\ Line 130  criteria being met}.\\
130  \end{minipage}  \end{minipage}
131  }  }
132    
133  \item Line 34,  \item Line PUT_LINE_NB:cg2dTargetResidual=,
134  \begin{verbatim}  \begin{verbatim}
135  cg2dTargetResidual=1.E-13,  cg2dTargetResidual=1.E-13,
136  \end{verbatim}  \end{verbatim}
137  Sets the tolerance which the two-dimensional, conjugate  Sets the tolerance which the two-dimensional, conjugate
138  gradient solver will use to test for convergence in equation  gradient solver will use to test for convergence in equation
139  %- note: Description of Conjugate gradient method (& related params) is missing  %- note: Description of Conjugate gradient method (& related params) is missing
140  %  in the mean time, substitute this eq ref:  %  in the mean time, substitute this eq ref:
141  \ref{eq:elliptic-backward-free-surface} %\ref{eq:congrad_2d_resid}  \ref{eq:elliptic-backward-free-surface} %\ref{eq:congrad_2d_resid}
142  to $1 \times 10^{-13}$.  to $1 \times 10^{-13}$.
143  Solver will iterate until tolerance falls below this value or until the  Solver will iterate until tolerance falls below this value or until the
144  maximum number of solver iterations is reached.\\  maximum number of solver iterations is reached.\\
145  \fbox{  \fbox{
146  \begin{minipage}{5.0in}  \begin{minipage}{5.0in}
# Line 148  maximum number of solver iterations is r Line 148  maximum number of solver iterations is r
148  \end{minipage}  \end{minipage}
149  }  }
150    
151  \item Line 39,  \item Line PUT_LINE_NB:nIter0=,
152  \begin{verbatim}  \begin{verbatim}
153  nIter0=0,  nIter0=0,
154  \end{verbatim}  \end{verbatim}
155  Sets the starting time for the model internal time counter.  Sets the starting time for the model internal time counter.
156  When set to non-zero this option implicitly requests a  When set to non-zero this option implicitly requests a
157  checkpoint file be read for initial state.  checkpoint file be read for initial state.
158  By default the checkpoint file is named according to  By default the checkpoint file is named according to
159  the integer number of time step value \verb+nIter0+.  the integer number of time step value \verb+nIter0+.
160  The internal time counter works in seconds. Alternatively,  The internal time counter works in seconds. Alternatively,
161  \verb+startTime+ can be set.  \verb+startTime+ can be set.
162    
163  \item Line 40,  \item Line PUT_LINE_NB:nTimeSteps=,
164  \begin{verbatim}  \begin{verbatim}
165  nTimesteps=20,  nTimeSteps=20,
166  \end{verbatim}  \end{verbatim}
167  Sets the time step number at which this simulation will terminate.  Sets the time step number at which this simulation will terminate.
168  At the end of a simulation a checkpoint file is automatically  At the end of a simulation a checkpoint file is automatically
169  written so that a numerical experiment can consist of multiple  written so that a numerical experiment can consist of multiple
170  stages. Alternatively \verb+endTime+ can be set.  stages. Alternatively \verb+endTime+ can be set.
171    
172  \item Line 44,  \item Line PUT_LINE_NB:deltaTmom=,
173  \begin{verbatim}  \begin{verbatim}
174  deltaTmom=1800.0,  deltaTmom=1800.,
175  \end{verbatim}  \end{verbatim}
176  Sets the timestep $\delta t_{v}$ used in the momentum equations to  Sets the timestep $\delta t_{v}$ used in the momentum equations to
177  $30~{\rm mins}$.  $30~{\rm mins}$.
# Line 185  See section \ref{sec:time_stepping}. %\r Line 185  See section \ref{sec:time_stepping}. %\r
185  \end{minipage}  \end{minipage}
186  }  }
187    
188  \item Line 45,  \item Line PUT_LINE_NB:tauCD=,
189  \begin{verbatim}  \begin{verbatim}
190  tauCD=321428.,  tauCD=321428.,
191  \end{verbatim}  \end{verbatim}
192  Sets the D-grid to C-grid coupling time scale $\tau_{CD}$  Sets the D-grid to C-grid coupling time scale $\tau_{CD}$
193  used in the momentum equations.  used in the momentum equations.
194  %- note: description of CD-scheme pkg (and related params) is missing;  %- note: description of CD-scheme pkg (and related params) is missing;
195  %  in the mean time, comment out this ref.  %  in the mean time, comment out this ref.
# Line 202  used in the momentum equations. Line 202  used in the momentum equations.
202  \end{minipage}  \end{minipage}
203  }  }
204    
205  \item Lines 46--48,  \item Lines PUT_LINE_NB:deltaTtracer=--PUT_LINE_NB:deltaTfreesurf=,
206  \begin{verbatim}  \begin{verbatim}
207  deltaTtracer=86400.,  deltaTtracer=86400.,
208  deltaTClock = 86400.,  deltaTClock = 86400.,
# Line 221  See section \ref{sec:time_stepping}. %\r Line 221  See section \ref{sec:time_stepping}. %\r
221  \end{minipage}  \end{minipage}
222  }  }
223    
224  \item Line 76,  \item Line PUT_LINE_NB:bathyFile=,
225  \begin{verbatim}  \begin{verbatim}
226  bathyFile='bathymetry.bin'  bathyFile='bathymetry.bin'
227  \end{verbatim}  \end{verbatim}
228  This line specifies the name of the file from which the domain  This line specifies the name of the file from which the domain
229  bathymetry is read. This file is a two-dimensional ($x,y$) map of  bathymetry is read. This file is a two-dimensional ($x,y$) map of
230  depths. This file is assumed to contain 32-bit binary numbers  depths. This file is assumed to contain 32-bit binary numbers
231  giving the depth of the model at each grid cell, ordered with the x  giving the depth of the model at each grid cell, ordered with the x
232  coordinate varying fastest. The points are ordered from low coordinate  coordinate varying fastest. The points are ordered from low coordinate
233  to high coordinate for both axes. The units and orientation of the  to high coordinate for both axes. The units and orientation of the
234  depths in this file are the same as used in the MITgcm code. In this  depths in this file are the same as used in the MITgcm code. In this
# Line 236  experiment, a depth of $0m$ indicates a Line 236  experiment, a depth of $0m$ indicates a
236  of $<0m$ indicates open ocean.  of $<0m$ indicates open ocean.
237    
238    
239  \item Line 79--80,  \item Lines PUT_LINE_NB:zonalWindFile=--PUT_LINE_NB:meridWindFile=,
240  \begin{verbatim}  \begin{verbatim}
241  zonalWindFile='trenberth_taux.bin'  zonalWindFile='trenberth_taux.bin'
242  meridWindFile='trenberth_tauy.bin'  meridWindFile='trenberth_tauy.bin'
# Line 244  meridWindFile='trenberth_tauy.bin' Line 244  meridWindFile='trenberth_tauy.bin'
244    These lines specify the names of the files from which the x- and y-    These lines specify the names of the files from which the x- and y-
245    direction surface wind stress is read. These files are also    direction surface wind stress is read. These files are also
246    three-dimensional ($x,y,time$) maps and are enumerated and formatted    three-dimensional ($x,y,time$) maps and are enumerated and formatted
247    in the same manner as the bathymetry file.    in the same manner as the bathymetry file.
248  \end{itemize}  \end{itemize}
249    
250  \noindent other lines in the file {\it input/data} are standard values  \noindent other lines in the file {\it input/data} are standard values

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

  ViewVC Help
Powered by ViewVC 1.1.22