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