| 2 |
% $Name$ |
% $Name$ |
| 3 |
|
|
| 4 |
\section{Four Layer Baroclinic Ocean Gyre In Spherical Coordinates} |
\section{Four Layer Baroclinic Ocean Gyre In Spherical Coordinates} |
| 5 |
|
\label{www:tutorials} |
| 6 |
\label{sect:eg-fourlayer} |
\label{sect:eg-fourlayer} |
| 7 |
|
|
| 8 |
\bodytext{bgcolor="#FFFFFFFF"} |
\bodytext{bgcolor="#FFFFFFFF"} |
| 27 |
for four layers and in a spherical polar coordinate system. |
for four layers and in a spherical polar coordinate system. |
| 28 |
|
|
| 29 |
\subsection{Overview} |
\subsection{Overview} |
| 30 |
|
\label{www:tutorials} |
| 31 |
|
|
| 32 |
This example experiment demonstrates using the MITgcm to simulate |
This example experiment demonstrates using the MITgcm to simulate |
| 33 |
a baroclinic, wind-forced, ocean gyre circulation. The experiment |
a baroclinic, wind-forced, ocean gyre circulation. The experiment |
| 120 |
\end{figure} |
\end{figure} |
| 121 |
|
|
| 122 |
\subsection{Equations solved} |
\subsection{Equations solved} |
| 123 |
|
\label{www:tutorials} |
| 124 |
For this problem |
For this problem |
| 125 |
the implicit free surface, {\bf HPE} (see section \ref{sect:hydrostatic_and_quasi-hydrostatic_forms}) form of the |
the implicit free surface, {\bf HPE} (see section \ref{sect:hydrostatic_and_quasi-hydrostatic_forms}) form of the |
| 126 |
equations described in Marshall et. al \cite{marshall:97a} are |
equations described in Marshall et. al \cite{marshall:97a} are |
| 205 |
|
|
| 206 |
|
|
| 207 |
\subsection{Discrete Numerical Configuration} |
\subsection{Discrete Numerical Configuration} |
| 208 |
|
\label{www:tutorials} |
| 209 |
|
|
| 210 |
The domain is discretised with |
The domain is discretised with |
| 211 |
a uniform grid spacing in latitude and longitude |
a uniform grid spacing in latitude and longitude |
| 265 |
\ref{sect:finding_the_pressure_field}. |
\ref{sect:finding_the_pressure_field}. |
| 266 |
|
|
| 267 |
\subsubsection{Numerical Stability Criteria} |
\subsubsection{Numerical Stability Criteria} |
| 268 |
|
\label{www:tutorials} |
| 269 |
|
|
| 270 |
The Laplacian viscosity coefficient, $A_{h}$, is set to $400 m s^{-1}$. |
The Laplacian viscosity coefficient, $A_{h}$, is set to $400 m s^{-1}$. |
| 271 |
This value is chosen to yield a Munk layer width, |
This value is chosen to yield a Munk layer width, |
| 345 |
stability limit of 0.25. |
stability limit of 0.25. |
| 346 |
|
|
| 347 |
\subsection{Code Configuration} |
\subsection{Code Configuration} |
| 348 |
|
\label{www:tutorials} |
| 349 |
\label{SEC:eg_fourl_code_config} |
\label{SEC:eg_fourl_code_config} |
| 350 |
|
|
| 351 |
The model configuration for this experiment resides under the |
The model configuration for this experiment resides under the |
| 365 |
to these files associated with this experiment. |
to these files associated with this experiment. |
| 366 |
|
|
| 367 |
\subsubsection{File {\it input/data}} |
\subsubsection{File {\it input/data}} |
| 368 |
|
\label{www:tutorials} |
| 369 |
|
|
| 370 |
This file, reproduced completely below, specifies the main parameters |
This file, reproduced completely below, specifies the main parameters |
| 371 |
for the experiment. The parameters that are significant for this configuration |
for the experiment. The parameters that are significant for this configuration |
| 383 |
$x$ and $y$. The values specified here are read into the |
$x$ and $y$. The values specified here are read into the |
| 384 |
variable |
variable |
| 385 |
{\bf |
{\bf |
| 386 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/OK.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/OK.htm> \end{rawhtml} |
| 387 |
tRef |
tRef |
| 388 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 389 |
} |
} |
| 390 |
in the model code, by procedure |
in the model code, by procedure |
| 391 |
{\it |
{\it |
| 392 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 393 |
INI\_PARMS |
INI\_PARMS |
| 394 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 395 |
}. |
}. |
| 402 |
%% \file{ini_parms} |
%% \file{ini_parms} |
| 403 |
\newcommand{\VARtref}{ |
\newcommand{\VARtref}{ |
| 404 |
{\bf |
{\bf |
| 405 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/OK.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/OK.htm> \end{rawhtml} |
| 406 |
tRef |
tRef |
| 407 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 408 |
} |
} |
| 417 |
\end{minipage} |
\end{minipage} |
| 418 |
} |
} |
| 419 |
{\bf |
{\bf |
| 420 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/98.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/98.htm> \end{rawhtml} |
| 421 |
goto code |
goto code |
| 422 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 423 |
} |
} |
| 430 |
for this operator are specified later. |
for this operator are specified later. |
| 431 |
The variable |
The variable |
| 432 |
{\bf |
{\bf |
| 433 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/ZQ.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/ZQ.htm> \end{rawhtml} |
| 434 |
viscAz |
viscAz |
| 435 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 436 |
} |
} |
| 437 |
is read in the routine |
is read in the routine |
| 438 |
{\it |
{\it |
| 439 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 440 |
INI\_PARMS |
INI\_PARMS |
| 441 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 442 |
} |
} |
| 443 |
and is copied into model general vertical coordinate variable |
and is copied into model general vertical coordinate variable |
| 444 |
{\bf |
{\bf |
| 445 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/PF.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/PF.htm> \end{rawhtml} |
| 446 |
viscAr |
viscAr |
| 447 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 448 |
}. At each time step, the viscous term contribution to the momentum equations |
}. At each time step, the viscous term contribution to the momentum equations |
| 455 |
\end{minipage} |
\end{minipage} |
| 456 |
} |
} |
| 457 |
{\bf |
{\bf |
| 458 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/53.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/53.htm> \end{rawhtml} |
| 459 |
goto code |
goto code |
| 460 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 461 |
} |
} |
| 469 |
for this operator are specified later. |
for this operator are specified later. |
| 470 |
The variable |
The variable |
| 471 |
{\bf |
{\bf |
| 472 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/SI.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/SI.htm> \end{rawhtml} |
| 473 |
viscAh |
viscAh |
| 474 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 475 |
} |
} |
| 476 |
is read in the routine |
is read in the routine |
| 477 |
{\it |
{\it |
| 478 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 479 |
INI\_PARMS |
INI\_PARMS |
| 480 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 481 |
} and applied in routines {\it CALC\_MOM\_RHS} and {\it CALC\_GW}. |
} and applied in routines {\it CALC\_MOM\_RHS} and {\it CALC\_GW}. |
| 486 |
\end{minipage} |
\end{minipage} |
| 487 |
} |
} |
| 488 |
{\bf |
{\bf |
| 489 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/60.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/60.htm> \end{rawhtml} |
| 490 |
goto code |
goto code |
| 491 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 492 |
} |
} |
| 497 |
\end{minipage} |
\end{minipage} |
| 498 |
} |
} |
| 499 |
{\bf |
{\bf |
| 500 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/58.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/58.htm> \end{rawhtml} |
| 501 |
goto code |
goto code |
| 502 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 503 |
} |
} |
| 512 |
$\frac{\partial v}{\partial x}$=0 along boundaries in $x$. |
$\frac{\partial v}{\partial x}$=0 along boundaries in $x$. |
| 513 |
The variable |
The variable |
| 514 |
{\bf |
{\bf |
| 515 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/UT.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/UT.htm> \end{rawhtml} |
| 516 |
no\_slip\_sides |
no\_slip\_sides |
| 517 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 518 |
} |
} |
| 519 |
is read in the routine |
is read in the routine |
| 520 |
{\it |
{\it |
| 521 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 522 |
INI\_PARMS |
INI\_PARMS |
| 523 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 524 |
} and the boundary condition is evaluated in routine |
} and the boundary condition is evaluated in routine |
| 531 |
\end{minipage} |
\end{minipage} |
| 532 |
} |
} |
| 533 |
{\bf |
{\bf |
| 534 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/60.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/60.htm> \end{rawhtml} |
| 535 |
goto code |
goto code |
| 536 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 537 |
} |
} |
| 545 |
e.g. $u=v=0$ at $z=-H$, where $H$ is the local depth of the domain. |
e.g. $u=v=0$ at $z=-H$, where $H$ is the local depth of the domain. |
| 546 |
The variable |
The variable |
| 547 |
{\bf |
{\bf |
| 548 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/UK.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/UK.htm> \end{rawhtml} |
| 549 |
no\_slip\_bottom |
no\_slip\_bottom |
| 550 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 551 |
} |
} |
| 552 |
is read in the routine |
is read in the routine |
| 553 |
{\it |
{\it |
| 554 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 555 |
INI\_PARMS |
INI\_PARMS |
| 556 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 557 |
} and is applied in the routine {\it S/R CALC\_MOM\_RHS}. |
} and is applied in the routine {\it S/R CALC\_MOM\_RHS}. |
| 562 |
\end{minipage} |
\end{minipage} |
| 563 |
} |
} |
| 564 |
{\bf |
{\bf |
| 565 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/60.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/60.htm> \end{rawhtml} |
| 566 |
goto code |
goto code |
| 567 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 568 |
} |
} |
| 577 |
all boundaries. |
all boundaries. |
| 578 |
The variable |
The variable |
| 579 |
{\bf |
{\bf |
| 580 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/RC.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/RC.htm> \end{rawhtml} |
| 581 |
diffKhT |
diffKhT |
| 582 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 583 |
} |
} |
| 584 |
is read in the routine |
is read in the routine |
| 585 |
{\it |
{\it |
| 586 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 587 |
INI\_PARMS |
INI\_PARMS |
| 588 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 589 |
} and used in routine {\it S/R CALC\_GT}. |
} and used in routine {\it S/R CALC\_GT}. |
| 593 |
\end{minipage} |
\end{minipage} |
| 594 |
} |
} |
| 595 |
{\bf |
{\bf |
| 596 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/57.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/57.htm> \end{rawhtml} |
| 597 |
goto code |
goto code |
| 598 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 599 |
} |
} |
| 607 |
operator is $\frac{\partial}{\partial z}$ = 0 on all boundaries. |
operator is $\frac{\partial}{\partial z}$ = 0 on all boundaries. |
| 608 |
The variable |
The variable |
| 609 |
{\bf |
{\bf |
| 610 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/ZT.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/ZT.htm> \end{rawhtml} |
| 611 |
diffKzT |
diffKzT |
| 612 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 613 |
} |
} |
| 614 |
is read in the routine |
is read in the routine |
| 615 |
{\it |
{\it |
| 616 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 617 |
INI\_PARMS |
INI\_PARMS |
| 618 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 619 |
}. |
}. |
| 620 |
It is copied into model general vertical coordinate variable |
It is copied into model general vertical coordinate variable |
| 621 |
{\bf |
{\bf |
| 622 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/PD.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/PD.htm> \end{rawhtml} |
| 623 |
diffKrT |
diffKrT |
| 624 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 625 |
} which is used in routine {\it S/R CALC\_DIFFUSIVITY}. |
} which is used in routine {\it S/R CALC\_DIFFUSIVITY}. |
| 629 |
\end{minipage} |
\end{minipage} |
| 630 |
} |
} |
| 631 |
{\bf |
{\bf |
| 632 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/53.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/53.htm> \end{rawhtml} |
| 633 |
goto code |
goto code |
| 634 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 635 |
} |
} |
| 644 |
to $2 \times 10^{-4}\,{\rm degrees}^{-1}$ |
to $2 \times 10^{-4}\,{\rm degrees}^{-1}$ |
| 645 |
The variable |
The variable |
| 646 |
{\bf |
{\bf |
| 647 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/ZV.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/ZV.htm> \end{rawhtml} |
| 648 |
tAlpha |
tAlpha |
| 649 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 650 |
} |
} |
| 651 |
is read in the routine |
is read in the routine |
| 652 |
{\it |
{\it |
| 653 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 654 |
INI\_PARMS |
INI\_PARMS |
| 655 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 656 |
}. The routine {\it S/R FIND\_RHO} makes use of {\bf tAlpha}. |
}. The routine {\it S/R FIND\_RHO} makes use of {\bf tAlpha}. |
| 661 |
\end{minipage} |
\end{minipage} |
| 662 |
} |
} |
| 663 |
{\bf |
{\bf |
| 664 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/79.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/79.htm> \end{rawhtml} |
| 665 |
goto code |
goto code |
| 666 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 667 |
} |
} |
| 673 |
This line selects the linear form of the equation of state. |
This line selects the linear form of the equation of state. |
| 674 |
The variable |
The variable |
| 675 |
{\bf |
{\bf |
| 676 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/WV.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/WV.htm> \end{rawhtml} |
| 677 |
eosType |
eosType |
| 678 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 679 |
} |
} |
| 680 |
is read in the routine |
is read in the routine |
| 681 |
{\it |
{\it |
| 682 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 683 |
INI\_PARMS |
INI\_PARMS |
| 684 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 685 |
}. The values of {\bf eosType} sets which formula in routine |
}. The values of {\bf eosType} sets which formula in routine |
| 691 |
\end{minipage} |
\end{minipage} |
| 692 |
} |
} |
| 693 |
{\bf |
{\bf |
| 694 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/79.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/79.htm> \end{rawhtml} |
| 695 |
goto code |
goto code |
| 696 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 697 |
} |
} |
| 709 |
on spherical polar geometry. |
on spherical polar geometry. |
| 710 |
The variable |
The variable |
| 711 |
{\bf |
{\bf |
| 712 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/10T.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/10T.htm> \end{rawhtml} |
| 713 |
usingSphericalPolarGrid |
usingSphericalPolarGrid |
| 714 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 715 |
} |
} |
| 716 |
is read in the routine |
is read in the routine |
| 717 |
{\it |
{\it |
| 718 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 719 |
INI\_PARMS |
INI\_PARMS |
| 720 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 721 |
}. When set to {\bf .TRUE.} the settings of {\bf delX} and {\bf delY} are |
}. When set to {\bf .TRUE.} the settings of {\bf delX} and {\bf delY} are |
| 728 |
\end{minipage} |
\end{minipage} |
| 729 |
} |
} |
| 730 |
{\bf |
{\bf |
| 731 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/97.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/97.htm> \end{rawhtml} |
| 732 |
goto code |
goto code |
| 733 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 734 |
} |
} |
| 746 |
not alter the kernel equation discretisation. |
not alter the kernel equation discretisation. |
| 747 |
The variable |
The variable |
| 748 |
{\bf |
{\bf |
| 749 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/110.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/110.htm> \end{rawhtml} |
| 750 |
phiMin |
phiMin |
| 751 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 752 |
} |
} |
| 753 |
is read in the routine |
is read in the routine |
| 754 |
{\it |
{\it |
| 755 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 756 |
INI\_PARMS |
INI\_PARMS |
| 757 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 758 |
} and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}. |
} and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}. |
| 763 |
\end{minipage} |
\end{minipage} |
| 764 |
} |
} |
| 765 |
{\bf |
{\bf |
| 766 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/97.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/97.htm> \end{rawhtml} |
| 767 |
goto code |
goto code |
| 768 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 769 |
} |
} |
| 776 |
in the discrete grid to $1^{\circ}$ in longitude. |
in the discrete grid to $1^{\circ}$ in longitude. |
| 777 |
The variable |
The variable |
| 778 |
{\bf |
{\bf |
| 779 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/10Z.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/10Z.htm> \end{rawhtml} |
| 780 |
delX |
delX |
| 781 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 782 |
} |
} |
| 783 |
is read in the routine |
is read in the routine |
| 784 |
{\it |
{\it |
| 785 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 786 |
INI\_PARMS |
INI\_PARMS |
| 787 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 788 |
} and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}. |
} and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}. |
| 793 |
\end{minipage} |
\end{minipage} |
| 794 |
} |
} |
| 795 |
{\bf |
{\bf |
| 796 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/97.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/97.htm> \end{rawhtml} |
| 797 |
goto code |
goto code |
| 798 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 799 |
} |
} |
| 806 |
in the discrete grid to $1^{\circ}$ in latitude. |
in the discrete grid to $1^{\circ}$ in latitude. |
| 807 |
The variable |
The variable |
| 808 |
{\bf |
{\bf |
| 809 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/UB.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/UB.htm> \end{rawhtml} |
| 810 |
delY |
delY |
| 811 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 812 |
} |
} |
| 813 |
is read in the routine |
is read in the routine |
| 814 |
{\it |
{\it |
| 815 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 816 |
INI\_PARMS |
INI\_PARMS |
| 817 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 818 |
} and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}. |
} and is used in routine {\it INI\_SPEHRICAL\_POLAR\_GRID}. |
| 823 |
\end{minipage} |
\end{minipage} |
| 824 |
} |
} |
| 825 |
{\bf |
{\bf |
| 826 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/97.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/97.htm> \end{rawhtml} |
| 827 |
goto code |
goto code |
| 828 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 829 |
} |
} |
| 837 |
is $2\,{\rm km}$. |
is $2\,{\rm km}$. |
| 838 |
The variable |
The variable |
| 839 |
{\bf |
{\bf |
| 840 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/10W.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/10W.htm> \end{rawhtml} |
| 841 |
delZ |
delZ |
| 842 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 843 |
} |
} |
| 844 |
is read in the routine |
is read in the routine |
| 845 |
{\it |
{\it |
| 846 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 847 |
INI\_PARMS |
INI\_PARMS |
| 848 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 849 |
}. |
}. |
| 850 |
It is copied into the internal |
It is copied into the internal |
| 851 |
model coordinate variable |
model coordinate variable |
| 852 |
{\bf |
{\bf |
| 853 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/10Y.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/10Y.htm> \end{rawhtml} |
| 854 |
delR |
delR |
| 855 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 856 |
} which is used in routine {\it INI\_VERTICAL\_GRID}. |
} which is used in routine {\it INI\_VERTICAL\_GRID}. |
| 861 |
\end{minipage} |
\end{minipage} |
| 862 |
} |
} |
| 863 |
{\bf |
{\bf |
| 864 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/100.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/100.htm> \end{rawhtml} |
| 865 |
goto code |
goto code |
| 866 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 867 |
} |
} |
| 883 |
bathymetry file. |
bathymetry file. |
| 884 |
The variable |
The variable |
| 885 |
{\bf |
{\bf |
| 886 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/179.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/179.htm> \end{rawhtml} |
| 887 |
bathyFile |
bathyFile |
| 888 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 889 |
} |
} |
| 890 |
is read in the routine |
is read in the routine |
| 891 |
{\it |
{\it |
| 892 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 893 |
INI\_PARMS |
INI\_PARMS |
| 894 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 895 |
}. The bathymetry file is read in the routine {\it INI\_DEPTHS}. |
}. The bathymetry file is read in the routine {\it INI\_DEPTHS}. |
| 900 |
\end{minipage} |
\end{minipage} |
| 901 |
} |
} |
| 902 |
{\bf |
{\bf |
| 903 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/88.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/88.htm> \end{rawhtml} |
| 904 |
goto code |
goto code |
| 905 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 906 |
} |
} |
| 919 |
file. |
file. |
| 920 |
The variable |
The variable |
| 921 |
{\bf |
{\bf |
| 922 |
\begin{rawhtml} <A href=../../../code_reference/vdb/names/13W.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/names/13W.htm> \end{rawhtml} |
| 923 |
zonalWindFile |
zonalWindFile |
| 924 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 925 |
} |
} |
| 926 |
is read in the routine |
is read in the routine |
| 927 |
{\it |
{\it |
| 928 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/94.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/94.htm> \end{rawhtml} |
| 929 |
INI\_PARMS |
INI\_PARMS |
| 930 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 931 |
}. The wind-stress file is read in the routine |
}. The wind-stress file is read in the routine |
| 937 |
\end{minipage} |
\end{minipage} |
| 938 |
} |
} |
| 939 |
{\bf |
{\bf |
| 940 |
\begin{rawhtml} <A href=../../../code_reference/vdb/code/75.htm> \end{rawhtml} |
\begin{rawhtml} <A href=../code_reference/vdb/code/75.htm> \end{rawhtml} |
| 941 |
goto code |
goto code |
| 942 |
\begin{rawhtml} </A>\end{rawhtml} |
\begin{rawhtml} </A>\end{rawhtml} |
| 943 |
} |
} |
| 953 |
\begin{rawhtml}</PRE>\end{rawhtml} |
\begin{rawhtml}</PRE>\end{rawhtml} |
| 954 |
|
|
| 955 |
\subsubsection{File {\it input/data.pkg}} |
\subsubsection{File {\it input/data.pkg}} |
| 956 |
|
\label{www:tutorials} |
| 957 |
|
|
| 958 |
This file uses standard default values and does not contain |
This file uses standard default values and does not contain |
| 959 |
customisations for this experiment. |
customisations for this experiment. |
| 960 |
|
|
| 961 |
\subsubsection{File {\it input/eedata}} |
\subsubsection{File {\it input/eedata}} |
| 962 |
|
\label{www:tutorials} |
| 963 |
|
|
| 964 |
This file uses standard default values and does not contain |
This file uses standard default values and does not contain |
| 965 |
customisations for this experiment. |
customisations for this experiment. |
| 966 |
|
|
| 967 |
\subsubsection{File {\it input/windx.sin\_y}} |
\subsubsection{File {\it input/windx.sin\_y}} |
| 968 |
|
\label{www:tutorials} |
| 969 |
|
|
| 970 |
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$) |
| 971 |
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}$ (the |
| 979 |
code for creating the {\it input/windx.sin\_y} file. |
code for creating the {\it input/windx.sin\_y} file. |
| 980 |
|
|
| 981 |
\subsubsection{File {\it input/topog.box}} |
\subsubsection{File {\it input/topog.box}} |
| 982 |
|
\label{www:tutorials} |
| 983 |
|
|
| 984 |
|
|
| 985 |
The {\it input/topog.box} file specifies a two-dimensional ($x,y$) |
The {\it input/topog.box} file specifies a two-dimensional ($x,y$) |
| 991 |
code for creating the {\it input/topog.box} file. |
code for creating the {\it input/topog.box} file. |
| 992 |
|
|
| 993 |
\subsubsection{File {\it code/SIZE.h}} |
\subsubsection{File {\it code/SIZE.h}} |
| 994 |
|
\label{www:tutorials} |
| 995 |
|
|
| 996 |
Two lines are customized in this file for the current experiment |
Two lines are customized in this file for the current experiment |
| 997 |
|
|
| 1018 |
\end{small} |
\end{small} |
| 1019 |
|
|
| 1020 |
\subsubsection{File {\it code/CPP\_OPTIONS.h}} |
\subsubsection{File {\it code/CPP\_OPTIONS.h}} |
| 1021 |
|
\label{www:tutorials} |
| 1022 |
|
|
| 1023 |
This file uses standard default values and does not contain |
This file uses standard default values and does not contain |
| 1024 |
customisations for this experiment. |
customisations for this experiment. |
| 1025 |
|
|
| 1026 |
|
|
| 1027 |
\subsubsection{File {\it code/CPP\_EEOPTIONS.h}} |
\subsubsection{File {\it code/CPP\_EEOPTIONS.h}} |
| 1028 |
|
\label{www:tutorials} |
| 1029 |
|
|
| 1030 |
This file uses standard default values and does not contain |
This file uses standard default values and does not contain |
| 1031 |
customisations for this experiment. |
customisations for this experiment. |
| 1032 |
|
|
| 1033 |
\subsubsection{Other Files } |
\subsubsection{Other Files } |
| 1034 |
|
\label{www:tutorials} |
| 1035 |
|
|
| 1036 |
Other files relevant to this experiment are |
Other files relevant to this experiment are |
| 1037 |
\begin{itemize} |
\begin{itemize} |
| 1044 |
\end{itemize} |
\end{itemize} |
| 1045 |
|
|
| 1046 |
\subsection{Running The Example} |
\subsection{Running The Example} |
| 1047 |
|
\label{www:tutorials} |
| 1048 |
\label{SEC:running_the_example} |
\label{SEC:running_the_example} |
| 1049 |
|
|
| 1050 |
\subsubsection{Code Download} |
\subsubsection{Code Download} |
| 1051 |
|
\label{www:tutorials} |
| 1052 |
|
|
| 1053 |
In order to run the examples you must first download the code distribution. |
In order to run the examples you must first download the code distribution. |
| 1054 |
Instructions for downloading the code can be found in section |
Instructions for downloading the code can be found in section |
| 1055 |
\ref{sect:obtainingCode}. |
\ref{sect:obtainingCode}. |
| 1056 |
|
|
| 1057 |
\subsubsection{Experiment Location} |
\subsubsection{Experiment Location} |
| 1058 |
|
\label{www:tutorials} |
| 1059 |
|
|
| 1060 |
This example experiments is located under the release sub-directory |
This example experiments is located under the release sub-directory |
| 1061 |
|
|
| 1063 |
{\it verification/exp2/ } |
{\it verification/exp2/ } |
| 1064 |
|
|
| 1065 |
\subsubsection{Running the Experiment} |
\subsubsection{Running the Experiment} |
| 1066 |
|
\label{www:tutorials} |
| 1067 |
|
|
| 1068 |
To run the experiment |
To run the experiment |
| 1069 |
|
|