/[MITgcm]/manual/s_examples/baroclinic_gyre/fourlayer.tex
ViewVC logotype

Diff of /manual/s_examples/baroclinic_gyre/fourlayer.tex

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

revision 1.13 by adcroft, Thu May 16 15:54:37 2002 UTC revision 1.17 by edhill, Thu Jan 29 17:36:26 2004 UTC
# Line 104  non-linear, we use $\theta$ to represent Line 104  non-linear, we use $\theta$ to represent
104  the quantity that is carried in the model core equations.  the quantity that is carried in the model core equations.
105    
106  \begin{figure}  \begin{figure}
107  \begin{center}  %% \begin{center}
108   \resizebox{7.5in}{5.5in}{  %%  \resizebox{7.5in}{5.5in}{
109     \includegraphics*[0.2in,0.7in][10.5in,10.5in]  %%    \includegraphics*[0.2in,0.7in][10.5in,10.5in]
110     {part3/case_studies/fourlayer_gyre/simulation_config.eps} }  %%    {part3/case_studies/fourlayer_gyre/simulation_config.eps} }
111  \end{center}  %% \end{center}
112    \centerline{
113      \scalefig{.95}
114      \epsfbox{part3/case_studies/fourlayer_gyre/simulation_config.eps}
115    }
116  \caption{Schematic of simulation domain and wind-stress forcing function  \caption{Schematic of simulation domain and wind-stress forcing function
117  for the four-layer gyre numerical experiment. The domain is enclosed by solid  for the four-layer gyre numerical experiment. The domain is enclosed by solid
118  walls at $0^{\circ}$~E, $60^{\circ}$~E, $0^{\circ}$~N and $60^{\circ}$~N.  walls at $0^{\circ}$~E, $60^{\circ}$~E, $0^{\circ}$~N and $60^{\circ}$~N.
# Line 360  directory {\it verification/exp2/}.  The Line 364  directory {\it verification/exp2/}.  The
364  \item {\it code/CPP\_OPTIONS.h},  \item {\it code/CPP\_OPTIONS.h},
365  \item {\it code/SIZE.h}.  \item {\it code/SIZE.h}.
366  \end{itemize}  \end{itemize}
367  contain the code customisations and parameter settings for this  contain the code customisations and parameter settings for this
368  experiments. Below we describe the customisations  experiment. Below we describe the customisations to these files
369  to these files associated with this experiment.  associated with this experiment.
370    
371  \subsubsection{File {\it input/data}}  \subsubsection{File {\it input/data}}
372  \label{www:tutorials}  \label{www:tutorials}
# Line 375  are Line 379  are
379    
380  \item Line 4,  \item Line 4,
381  \begin{verbatim} tRef=20.,10.,8.,6., \end{verbatim}  \begin{verbatim} tRef=20.,10.,8.,6., \end{verbatim}
382  this line sets  this line sets the initial and reference values of potential
383  the initial and reference values of potential temperature at each model  temperature at each model level in units of $^{\circ}$C.  The entries
384  level in units of $^{\circ}$C.  are ordered from surface to depth. For each depth level the initial
385  The entries are ordered from surface to depth. For each  and reference profiles will be uniform in $x$ and $y$. The values
386  depth level the initial and reference profiles will be uniform in  specified here are read into the variable \varlink{tRef}{tRef} in the
387  $x$ and $y$. The values specified here are read into the  model code, by procedure \filelink{INI\_PARMS}{model-src-ini_parms.F}
 variable  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/names/OK.htm> \end{rawhtml}  
 tRef  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
 in the model code, by procedure  
 {\it  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}  
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 }.  
   
 %% \codelink{var:tref} tRef \endlink  
 %% \codelink{file:ini_parms} {\it INI\_PARMS } \endlink  
 %% \codelink{proc:ini_parms} {\it INI\_PARMS } \endlink  
 %% \var{tref}  
 %% \proc{ini_parms}  
 %% \file{ini_parms}  
 \newcommand{\VARtref}{  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/names/OK.htm> \end{rawhtml}  
 tRef  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
 }  
   
   
388    
389  \fbox{  \fbox{
390  \begin{minipage}{5.0in}    \begin{minipage}{5.0in}
391  {\it S/R INI\_THETA}      {\it S/R INI\_THETA}({\it ini\_theta.F})
392  ({\it ini\_theta.F})    \end{minipage}
 \end{minipage}  
393  }  }
394  {\bf  \filelink{ini\_theta.F}{model-src-ini_theta.F}
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/98.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
   
395    
396  \item Line 6,  \item Line 6,
397  \begin{verbatim} viscAz=1.E-2, \end{verbatim}  \begin{verbatim} viscAz=1.E-2, \end{verbatim}
398  this line sets the vertical Laplacian dissipation coefficient to  this line sets the vertical Laplacian dissipation coefficient to $1
399  $1 \times 10^{-2} {\rm m^{2}s^{-1}}$. Boundary conditions  \times 10^{-2} {\rm m^{2}s^{-1}}$. Boundary conditions for this
400  for this operator are specified later.  operator are specified later.  The variable \varlink{viscAz}{viscAz}
401  The variable  is read in the routine \filelink{ini\_parms.F}{model-src-ini_parms.F}
402  {\bf  and is copied into model general vertical coordinate variable
403  \begin{rawhtml} <A href=../../../code_reference/vdb/names/ZQ.htm> \end{rawhtml}  \varlink{viscAr}{viscAr} At each time step, the viscous term
404  viscAz  contribution to the momentum equations is calculated in routine
405  \begin{rawhtml} </A>\end{rawhtml}  \varlink{CALC\_DIFFUSIVITY}{CALC_DIFFUSIVITY}
 }  
 is read in the routine  
 {\it  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}  
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
 and is copied into model general vertical coordinate variable  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/names/PF.htm> \end{rawhtml}  
 viscAr  
 \begin{rawhtml} </A>\end{rawhtml}  
 }. At each time step, the viscous term contribution to the momentum equations  
 is calculated in routine  
 {\it S/R CALC\_DIFFUSIVITY}.  
406    
407  \fbox{  \fbox{
408  \begin{minipage}{5.0in}  \begin{minipage}{5.0in}
409  {\it S/R CALC\_DIFFUSIVITY}({\it calc\_diffusivity.F})  {\it S/R CALC\_DIFFUSIVITY}({\it calc\_diffusivity.F})
410  \end{minipage}  \end{minipage}
411  }  }
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/53.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
412    
413  \item Line 7,  \item Line 7,
414  \begin{verbatim}  \begin{verbatim}
415  viscAh=4.E2,  viscAh=4.E2,
416  \end{verbatim}  \end{verbatim}
417  this line sets the horizontal laplacian frictional dissipation coefficient to    this line sets the horizontal laplacian frictional dissipation
418  $1 \times 10^{-2} {\rm m^{2}s^{-1}}$. Boundary conditions    coefficient to $1 \times 10^{-2} {\rm m^{2}s^{-1}}$. Boundary
419  for this operator are specified later.    conditions for this operator are specified later.  The variable
420  The variable    \varlink{viscAh}{viscAh} is read in the routine
421  {\bf    \varlink{INI\_PARMS}{INI_PARMS} and applied in routines
422  \begin{rawhtml} <A href=../../../code_reference/vdb/names/SI.htm> \end{rawhtml}    \varlink{CALC\_MOM\_RHS}{CALC_MOM_RHS} and
423  viscAh    \varlink{CALC\_GW}{CALC_GW}.
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
 is read in the routine  
 {\it  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}  
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 } and applied in routines {\it CALC\_MOM\_RHS} and {\it CALC\_GW}.  
424    
425  \fbox{  \fbox{
426  \begin{minipage}{5.0in}    \begin{minipage}{5.0in}
427  {\it S/R CALC\_MOM\_RHS}({\it calc\_mom\_rhs.F})      {\it S/R CALC\_MOM\_RHS}({\it calc\_mom\_rhs.F})
428  \end{minipage}    \end{minipage}
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/60.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
429  }  }
   
430  \fbox{  \fbox{
431  \begin{minipage}{5.0in}    \begin{minipage}{5.0in}
432  {\it S/R CALC\_GW}({\it calc\_gw.F})      {\it S/R CALC\_GW}({\it calc\_gw.F})
433  \end{minipage}    \end{minipage}
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/58.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
434  }  }
435    
436  \item Lines 8,  \item Line 8,
437  \begin{verbatim}  \begin{verbatim}
438  no_slip_sides=.FALSE.  no_slip_sides=.FALSE.
439  \end{verbatim}  \end{verbatim}
440  this line selects a free-slip lateral boundary condition for    this line selects a free-slip lateral boundary condition for the
441  the horizontal laplacian friction operator    horizontal laplacian friction operator e.g. $\frac{\partial
442  e.g. $\frac{\partial u}{\partial y}$=0 along boundaries in $y$ and      u}{\partial y}$=0 along boundaries in $y$ and $\frac{\partial
443  $\frac{\partial v}{\partial x}$=0 along boundaries in $x$.      v}{\partial x}$=0 along boundaries in $x$.  The variable
444  The variable    \varlink{no\_slip\_sides}{no_slip_sides} is read in the routine
445  {\bf    \varlink{INI\_PARMS}{INI_PARMS} and the boundary condition is
446  \begin{rawhtml} <A href=../../../code_reference/vdb/names/UT.htm> \end{rawhtml}    evaluated in routine
447  no\_slip\_sides  
448  \begin{rawhtml} </A>\end{rawhtml}    \fbox{
449  }      \begin{minipage}{5.0in}
450  is read in the routine        {\it S/R CALC\_MOM\_RHS}({\it calc\_mom\_rhs.F})
451  {\it      \end{minipage}
452  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    }
453  INI\_PARMS    \filelink{calc\_mom\_rhs.F}{calc_mom_rhs.F}
454  \begin{rawhtml} </A>\end{rawhtml}    
 } and the boundary condition is evaluated in routine  
 {\it S/R CALC\_MOM\_RHS}.  
   
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R CALC\_MOM\_RHS}({\it calc\_mom\_rhs.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/60.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
   
455  \item Lines 9,  \item Lines 9,
456  \begin{verbatim}  \begin{verbatim}
457  no_slip_bottom=.TRUE.  no_slip_bottom=.TRUE.
458  \end{verbatim}  \end{verbatim}
459  this line selects a no-slip boundary condition for bottom    this line selects a no-slip boundary condition for bottom boundary
460  boundary condition in the vertical laplacian friction operator    condition in the vertical laplacian friction operator e.g. $u=v=0$
461  e.g. $u=v=0$ at $z=-H$, where $H$ is the local depth of the domain.    at $z=-H$, where $H$ is the local depth of the domain.  The variable
462  The variable    \varlink{no\_slip\_bottom}{no\_slip\_bottom} is read in the routine
463  {\bf    \filelink{INI\_PARMS}{model-src-ini_parms.F} and is applied in the
464  \begin{rawhtml} <A href=../../../code_reference/vdb/names/UK.htm> \end{rawhtml}    routine \varlink{CALC\_MOM\_RHS}{CALC_MOM_RHS}.
465  no\_slip\_bottom  
466  \begin{rawhtml} </A>\end{rawhtml}    \fbox{
467  }      \begin{minipage}{5.0in}
468  is read in the routine        {\it S/R CALC\_MOM\_RHS}({\it calc\_mom\_rhs.F})
469  {\it      \end{minipage}
470  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    }
471  INI\_PARMS    \filelink{calc\_mom\_rhs.F}{calc_mom_rhs.F}
 \begin{rawhtml} </A>\end{rawhtml}  
 } and is applied in the routine {\it S/R CALC\_MOM\_RHS}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R CALC\_MOM\_RHS}({\it calc\_mom\_rhs.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/60.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
472    
473  \item Line 10,  \item Line 10,
474  \begin{verbatim}  \begin{verbatim}
475  diffKhT=4.E2,  diffKhT=4.E2,
476  \end{verbatim}  \end{verbatim}
477  this line sets the horizontal diffusion coefficient for temperature    this line sets the horizontal diffusion coefficient for temperature
478  to $400\,{\rm m^{2}s^{-1}}$. The boundary condition on this    to $400\,{\rm m^{2}s^{-1}}$. The boundary condition on this operator
479  operator is $\frac{\partial}{\partial x}=\frac{\partial}{\partial y}=0$ at    is $\frac{\partial}{\partial x}=\frac{\partial}{\partial y}=0$ at
480  all boundaries.    all boundaries.  The variable \varlink{diffKhT}{diffKhT} is read in
481  The variable    the routine \varlink{INI\_PARMS}{INI_PARMS} and used in routine
482  {\bf    \varlink{CALC\_GT}{CALC_GT}.
483  \begin{rawhtml} <A href=../../../code_reference/vdb/names/RC.htm> \end{rawhtml}  
484  diffKhT    \fbox{ \begin{minipage}{5.0in}
485  \begin{rawhtml} </A>\end{rawhtml}        {\it S/R CALC\_GT}({\it calc\_gt.F})
486  }      \end{minipage}
487  is read in the routine    }
488  {\it    \filelink{calc\_gt.F}{model-src-calc_gt.F}
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}  
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 } and used in routine {\it S/R CALC\_GT}.  
   
 \fbox{ \begin{minipage}{5.0in}  
 {\it S/R CALC\_GT}({\it calc\_gt.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/57.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
489    
490  \item Line 11,  \item Line 11,
491  \begin{verbatim}  \begin{verbatim}
492  diffKzT=1.E-2,  diffKzT=1.E-2,
493  \end{verbatim}  \end{verbatim}
494  this line sets the vertical diffusion coefficient for temperature    this line sets the vertical diffusion coefficient for temperature to
495  to $10^{-2}\,{\rm m^{2}s^{-1}}$. The boundary condition on this    $10^{-2}\,{\rm m^{2}s^{-1}}$. The boundary condition on this
496  operator is $\frac{\partial}{\partial z}$ = 0 on all boundaries.    operator is $\frac{\partial}{\partial z}$ = 0 on all boundaries.
497  The variable    The variable \varlink{diffKzT}{diffKzT} is read in the routine
498  {\bf    \varlink{INI\_PARMS}{INI_PARMS}. It is copied into model general
499  \begin{rawhtml} <A href=../../../code_reference/vdb/names/ZT.htm> \end{rawhtml}    vertical coordinate variable \varlink{diffKrT}{diffKrT} which is
500  diffKzT    used in routine \varlink{CALC\_DIFFUSIVITY}{CALC_DIFFUSIVITY}.
501  \begin{rawhtml} </A>\end{rawhtml}  
502  }    \fbox{ \begin{minipage}{5.0in}
503  is read in the routine        {\it S/R CALC\_DIFFUSIVITY}({\it calc\_diffusivity.F})
504  {\it      \end{minipage}
505  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    }
506  INI\_PARMS    \filelink{calc\_diffusivity.F}{model-src-calc_diffusivity.F}
 \begin{rawhtml} </A>\end{rawhtml}  
 }.  
 It is copied into model general vertical coordinate variable  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/names/PD.htm> \end{rawhtml}  
 diffKrT  
 \begin{rawhtml} </A>\end{rawhtml}  
 } which is used in routine {\it S/R CALC\_DIFFUSIVITY}.  
   
 \fbox{ \begin{minipage}{5.0in}  
 {\it S/R CALC\_DIFFUSIVITY}({\it calc\_diffusivity.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/53.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
   
   
507    
508  \item Line 13,  \item Line 13,
509  \begin{verbatim}  \begin{verbatim}
510  tAlpha=2.E-4,  tAlpha=2.E-4,
511  \end{verbatim}  \end{verbatim}
512  This line sets the thermal expansion coefficient for the fluid    This line sets the thermal expansion coefficient for the fluid to $2
513  to $2 \times 10^{-4}\,{\rm degrees}^{-1}$    \times 10^{-4}\,{\rm degrees}^{-1}$ The variable
514  The variable    \varlink{tAlpha}{tAlpha} is read in the routine
515  {\bf    \varlink{INI\_PARMS}{INI_PARMS}. The routine
516  \begin{rawhtml} <A href=../../../code_reference/vdb/names/ZV.htm> \end{rawhtml}    \varlink{FIND\_RHO}{FIND\_RHO} makes use of {\bf tAlpha}.
517  tAlpha  
518  \begin{rawhtml} </A>\end{rawhtml}    \fbox{
519  }      \begin{minipage}{5.0in}
520  is read in the routine        {\it S/R FIND\_RHO}({\it find\_rho.F})
521  {\it      \end{minipage}
522  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    }
523  INI\_PARMS    \filelink{find\_rho.F}{model-src-find_rho.F}
 \begin{rawhtml} </A>\end{rawhtml}  
 }. The routine {\it S/R FIND\_RHO} makes use of {\bf tAlpha}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R FIND\_RHO}({\it find\_rho.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/79.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
524    
525  \item Line 18,  \item Line 18,
526  \begin{verbatim}  \begin{verbatim}
527  eosType='LINEAR'  eosType='LINEAR'
528  \end{verbatim}  \end{verbatim}
529  This line selects the linear form of the equation of state.    This line selects the linear form of the equation of state.  The
530  The variable    variable \varlink{eosType}{eosType} is read in the routine
531  {\bf    \varlink{INI\_PARMS}{INI_PARMS}. The values of {\bf eosType} sets
532  \begin{rawhtml} <A href=../../../code_reference/vdb/names/WV.htm> \end{rawhtml}    which formula in routine {\it FIND\_RHO} is used to calculate
533  eosType    density.
534  \begin{rawhtml} </A>\end{rawhtml}  
535  }    \fbox{
536  is read in the routine      \begin{minipage}{5.0in}
537  {\it        {\it S/R FIND\_RHO}({\it find\_rho.F})
538  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}      \end{minipage}
539  INI\_PARMS    }
540  \begin{rawhtml} </A>\end{rawhtml}    \filelink{find\_rho.F}{model-src-find_rho.F}
 }. The values of {\bf eosType} sets which formula in routine  
 {\it FIND\_RHO} is used to calculate density.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R FIND\_RHO}({\it find\_rho.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/79.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
   
   
541    
542  \item Line 40,  \item Line 40,
543  \begin{verbatim}  \begin{verbatim}
544  usingSphericalPolarGrid=.TRUE.,  usingSphericalPolarGrid=.TRUE.,
545  \end{verbatim}  \end{verbatim}
546  This line requests that the simulation be performed in a    This line requests that the simulation be performed in a spherical
547  spherical polar coordinate system. It affects the interpretation of    polar coordinate system. It affects the interpretation of grid input
548  grid input parameters, for example {\bf delX} and {\bf delY} and    parameters, for example {\bf delX} and {\bf delY} and causes the
549  causes the grid generation routines to initialize an internal grid based    grid generation routines to initialize an internal grid based on
550  on spherical polar geometry.    spherical polar geometry.  The variable
551  The variable    \varlink{usingSphericalPolarGrid}{usingSphericalPolarGrid} is read
552  {\bf    in the routine \varlink{INI\_PARMS}{INI_PARMS}. When set to {\bf
553  \begin{rawhtml} <A href=../../../code_reference/vdb/names/10T.htm> \end{rawhtml}      .TRUE.} the settings of {\bf delX} and {\bf delY} are taken to be
554  usingSphericalPolarGrid    in degrees. These values are used in the routine
555  \begin{rawhtml} </A>\end{rawhtml}  
556  }    \fbox{
557  is read in the routine      \begin{minipage}{5.0in}
558  {\it        {\it S/R INI\_SPEHRICAL\_POLAR\_GRID}({\it ini\_spherical\_polar\_grid.F})
559  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}      \end{minipage}
560  INI\_PARMS    }
561  \begin{rawhtml} </A>\end{rawhtml}    \filelink{ini\_spherical\_polar\_grid.F}{model-src-ini_spherical_polar_grid.F}
 }. When set to {\bf .TRUE.} the settings of {\bf delX} and {\bf delY} are  
 taken to be in degrees. These values are used in the  
 routine {\it INI\_SPEHRICAL\_POLAR\_GRID}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R INI\_SPEHRICAL\_POLAR\_GRID}({\it ini\_spherical\_polar\_grid.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/97.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
562    
563  \item Line 41,  \item Line 41,
564  \begin{verbatim}  \begin{verbatim}
565  phiMin=0.,  phiMin=0.,
566  \end{verbatim}  \end{verbatim}
567  This line sets the southern boundary of the modeled    This line sets the southern boundary of the modeled domain to
568  domain to $0^{\circ}$ latitude. This value affects both the    $0^{\circ}$ latitude. This value affects both the generation of the
569  generation of the locally orthogonal grid that the model    locally orthogonal grid that the model uses internally and affects
570  uses internally and affects the initialization of the coriolis force.    the initialization of the coriolis force.  Note - it is not required
571  Note - it is not required to set    to set a longitude boundary, since the absolute longitude does not
572  a longitude boundary, since the absolute longitude does    alter the kernel equation discretisation.  The variable
573  not alter the kernel equation discretisation.    \varlink{phiMin}{phiMin} is read in the
574  The variable    routine \varlink{INI\_PARMS}{INI_PARMS} and is used in routine
575  {\bf  
576  \begin{rawhtml} <A href=../../../code_reference/vdb/names/110.htm> \end{rawhtml}    \fbox{
577  phiMin      \begin{minipage}{5.0in}
578  \begin{rawhtml} </A>\end{rawhtml}        {\it S/R INI\_SPEHRICAL\_POLAR\_GRID}({\it ini\_spherical\_polar\_grid.F})
579  }      \end{minipage}
580  is read in the routine    }
581  {\it    \filelink{ini\_spherical\_polar\_grid.F}{model-src-ini_spherical_polar_grid.F}
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}  
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 } and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R INI\_SPEHRICAL\_POLAR\_GRID}({\it ini\_spherical\_polar\_grid.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/97.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
582    
583  \item Line 42,  \item Line 42,
584  \begin{verbatim}  \begin{verbatim}
585  delX=60*1.,  delX=60*1.,
586  \end{verbatim}  \end{verbatim}
587  This line sets the horizontal grid spacing between each y-coordinate line    This line sets the horizontal grid spacing between each y-coordinate
588  in the discrete grid to $1^{\circ}$ in longitude.    line in the discrete grid to $1^{\circ}$ in longitude.  The variable
589  The variable    \varlink{delX}{delX} is read in the routine
590  {\bf    \varlink{INI\_PARMS}{INI_PARMS} and is used in routine
591  \begin{rawhtml} <A href=../../../code_reference/vdb/names/10Z.htm> \end{rawhtml}  
592  delX    \fbox{
593  \begin{rawhtml} </A>\end{rawhtml}      \begin{minipage}{5.0in}
594  }        {\it S/R INI\_SPEHRICAL\_POLAR\_GRID}({\it ini\_spherical\_polar\_grid.F})
595  is read in the routine      \end{minipage}
596  {\it    }
597  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    \filelink{ini\_spherical\_polar\_grid.F}{model-src-ini_spherical_polar_grid.F}
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 } and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R INI\_SPEHRICAL\_POLAR\_GRID}({\it ini\_spherical\_polar\_grid.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/97.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
598    
599  \item Line 43,  \item Line 43,
600  \begin{verbatim}  \begin{verbatim}
601  delY=60*1.,  delY=60*1.,
602  \end{verbatim}  \end{verbatim}
603  This line sets the horizontal grid spacing between each y-coordinate line    This line sets the horizontal grid spacing between each y-coordinate
604  in the discrete grid to $1^{\circ}$ in latitude.    line in the discrete grid to $1^{\circ}$ in latitude.  The variable
605  The variable    \varlink{delY}{delY} is read in the routine
606  {\bf    \varlink{INI\_PARMS}{INI_PARMS} and is used in routine
607  \begin{rawhtml} <A href=../../../code_reference/vdb/names/UB.htm> \end{rawhtml}  
608  delY      \fbox{
609  \begin{rawhtml} </A>\end{rawhtml}      \begin{minipage}{5.0in}
610  }        {\it S/R INI\_SPEHRICAL\_POLAR\_GRID}({\it ini\_spherical\_polar\_grid.F})
611  is read in the routine      \end{minipage}
612  {\it    }
613  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    \filelink{ini\_spherical\_polar\_grid.F}{model-src-ini_spherical_polar_grid.F}
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 } and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R INI\_SPEHRICAL\_POLAR\_GRID}({\it ini\_spherical\_polar\_grid.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/97.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
614    
615  \item Line 44,  \item Line 44,
616  \begin{verbatim}  \begin{verbatim}
617  delZ=500.,500.,500.,500.,  delZ=500.,500.,500.,500.,
618  \end{verbatim}  \end{verbatim}
619  This line sets the vertical grid spacing between each z-coordinate line    This line sets the vertical grid spacing between each z-coordinate
620  in the discrete grid to $500\,{\rm m}$, so that the total model depth    line in the discrete grid to $500\,{\rm m}$, so that the total model
621  is $2\,{\rm km}$.    depth is $2\,{\rm km}$.  The variable \varlink{delZ}{delZ} is read
622  The variable    in the routine \varlink{INI\_PARMS}{INI_PARMS}.  It is copied into
623  {\bf    the internal model coordinate variable \varlink{delR}{delR} which is
624  \begin{rawhtml} <A href=../../../code_reference/vdb/names/10W.htm> \end{rawhtml}    used in routine
625  delZ  
626  \begin{rawhtml} </A>\end{rawhtml}    \fbox{
627  }      \begin{minipage}{5.0in}
628  is read in the routine        {\it S/R INI\_VERTICAL\_GRID}({\it ini\_vertical\_grid.F})
629  {\it      \end{minipage}
630  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    }
631  INI\_PARMS    \filelink{ini\_vertical\_grid.F}{model-src-ini_vertical_grid.F}
 \begin{rawhtml} </A>\end{rawhtml}  
 }.  
 It is copied into the internal  
 model coordinate variable  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/names/10Y.htm> \end{rawhtml}  
 delR  
 \begin{rawhtml} </A>\end{rawhtml}  
 } which is used in routine {\it INI\_VERTICAL\_GRID}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R INI\_VERTICAL\_GRID}({\it ini\_vertical\_grid.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/100.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
632    
633  \item Line 47,  \item Line 47,
634  \begin{verbatim}  \begin{verbatim}
635  bathyFile='topog.box'  bathyFile='topog.box'
636  \end{verbatim}  \end{verbatim}
637  This line specifies the name of the file from which the domain    This line specifies the name of the file from which the domain
638  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
639  depths. This file is assumed to contain 64-bit binary numbers    depths. This file is assumed to contain 64-bit binary numbers giving
640  giving the depth of the model at each grid cell, ordered with the x    the depth of the model at each grid cell, ordered with the x
641  coordinate varying fastest. The points are ordered from low coordinate    coordinate varying fastest. The points are ordered from low
642  to high coordinate for both axes. The units and orientation of the    coordinate to high coordinate for both axes. The units and
643  depths in this file are the same as used in the MITgcm code. In this    orientation of the depths in this file are the same as used in the
644  experiment, a depth of $0m$ indicates a solid wall and a depth    MITgcm code. In this experiment, a depth of $0m$ indicates a solid
645  of $-2000m$ indicates open ocean. The matlab program    wall and a depth of $-2000m$ indicates open ocean. The matlab
646  {\it input/gendata.m} shows an example of how to generate a    program {\it input/gendata.m} shows an example of how to generate a
647  bathymetry file.    bathymetry file.  The variable \varlink{bathyFile}{bathyFile} is
648  The variable    read in the routine \varlink{INI\_PARMS}{INI_PARMS}.  The bathymetry
649  {\bf    file is read in the routine
650  \begin{rawhtml} <A href=../../../code_reference/vdb/names/179.htm> \end{rawhtml}  
651  bathyFile    \fbox{
652  \begin{rawhtml} </A>\end{rawhtml}      \begin{minipage}{5.0in}
653  }        {\it S/R INI\_DEPTHS}({\it ini\_depths.F})
654  is read in the routine      \end{minipage}
655  {\it    }
656  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    \filelink{ini\_depths.F}{model-src-ini_depths.F}
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 }. The bathymetry file is read in the routine {\it INI\_DEPTHS}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R INI\_DEPTHS}({\it ini\_depths.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/88.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
   
657    
658  \item Line 50,  \item Line 50,
659  \begin{verbatim}  \begin{verbatim}
660  zonalWindFile='windx.sin_y'  zonalWindFile='windx.sin_y'
661  \end{verbatim}  \end{verbatim}
662  This line specifies the name of the file from which the x-direction    This line specifies the name of the file from which the x-direction
663  (zonal) surface wind stress is read. This file is also a two-dimensional    (zonal) surface wind stress is read. This file is also a
664  ($x,y$) map and is enumerated and formatted in the same manner as the    two-dimensional ($x,y$) map and is enumerated and formatted in the
665  bathymetry file. The matlab program {\it input/gendata.m} includes example    same manner as the bathymetry file. The matlab program {\it
666  code to generate a valid      input/gendata.m} includes example code to generate a valid {\bf
667  {\bf zonalWindFile}      zonalWindFile} file.  The variable
668  file.      \varlink{zonalWindFile}{zonalWindFile} is read in the routine
669  The variable    \varlink{INI\_PARMS}{INI_PARMS}.  The wind-stress file is read in
670  {\bf    the routine
671  \begin{rawhtml} <A href=../../../code_reference/vdb/names/13W.htm> \end{rawhtml}  
672  zonalWindFile    \fbox{
673  \begin{rawhtml} </A>\end{rawhtml}      \begin{minipage}{5.0in}
674  }        {\it S/R EXTERNAL\_FIELDS\_LOAD}({\it external\_fields\_load.F})
675  is read in the routine      \end{minipage}
676  {\it    }
677  \begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml}    \filelink{external\_fields\_load.F}{model-src-external_fields_load.F}
 INI\_PARMS  
 \begin{rawhtml} </A>\end{rawhtml}  
 }.  The wind-stress file is read in the routine  
 {\it EXTERNAL\_FIELDS\_LOAD}.  
   
 \fbox{  
 \begin{minipage}{5.0in}  
 {\it S/R EXTERNAL\_FIELDS\_LOAD}({\it external\_fields\_load.F})  
 \end{minipage}  
 }  
 {\bf  
 \begin{rawhtml} <A href=../../../code_reference/vdb/code/75.htm> \end{rawhtml}  
 goto code  
 \begin{rawhtml} </A>\end{rawhtml}  
 }  
678    
679  \end{itemize}  \end{itemize}
680    
# Line 967  customisations for this experiment. Line 701  customisations for this experiment.
701  \subsubsection{File {\it input/windx.sin\_y}}  \subsubsection{File {\it input/windx.sin\_y}}
702  \label{www:tutorials}  \label{www:tutorials}
703    
704  The {\it input/windx.sin\_y} file specifies a two-dimensional ($x,y$)  The {\it input/windx.sin\_y} file specifies a two-dimensional ($x,y$)
705  map of wind stress ,$\tau_{x}$, values. The units used are $Nm^{-2}$ (the  map of wind stress ,$\tau_{x}$, values. The units used are $Nm^{-2}$
706  default for MITgcm).  (the default for MITgcm).  Although $\tau_{x}$ is only a function of
707  Although $\tau_{x}$ is only a function of latitude, $y$,  latitude, $y$, in this experiment this file must still define a
708  in this experiment  complete two-dimensional map in order to be compatible with the
709  this file must still define a complete two-dimensional map in order  standard code for loading forcing fields in MITgcm (routine {\it
710  to be compatible with the standard code for loading forcing fields    EXTERNAL\_FIELDS\_LOAD}.  The included matlab program {\it
711  in MITgcm (routine {\it EXTERNAL\_FIELDS\_LOAD}.    input/gendata.m} gives a complete code for creating the {\it
712  The included matlab program {\it input/gendata.m} gives a complete    input/windx.sin\_y} file.
 code for creating the {\it input/windx.sin\_y} file.  
713    
714  \subsubsection{File {\it input/topog.box}}  \subsubsection{File {\it input/topog.box}}
715  \label{www:tutorials}  \label{www:tutorials}
Legend:
Removed from v.1.13  
changed lines
  Added in v.1.17
  ViewVC Help
Powered by ViewVC 1.1.22