<p><b>mpetersen@lanl.gov</b> 2013-03-21 11:14:36 -0600 (Thu, 21 Mar 2013)</p><p>user's guide: update namelist sections<br>
</p><hr noshade><pre><font color="gray">Modified: trunk/documents/users_guide/ocean/namelist_section_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocean/namelist_section_documentation.tex 2013-03-21 17:14:25 UTC (rev 2646)
+++ trunk/documents/users_guide/ocean/namelist_section_documentation.tex 2013-03-21 17:14:36 UTC (rev 2647)
@@ -508,7 +508,7 @@
\hline
Possible Values: & .true. or .false. \\
\hline
- \caption{config\_use\_mom\_del2: If true, the Laplacian horizontal mixing is used on the momentum equation.}
+ \caption{config\_use\_mom\_del2: If true, Laplacian horizontal mixing is used on the momentum equation.}
\end{longtable}
\end{center}
\subsection[config\_use\_tracer\_del2]{\hyperref[sec:nm_tab_hmix_del2]{config\_use\_tracer\_del2}}
@@ -524,7 +524,7 @@
\hline
Possible Values: & .true. or .false. \\
\hline
- \caption{config\_use\_tracer\_del2: If true, the Laplacian horizontal mixing is used on the tracer equation.}
+ \caption{config\_use\_tracer\_del2: If true, Laplacian horizontal mixing is used on the tracer equation.}
\end{longtable}
\end{center}
\subsection[config\_mom\_del2]{\hyperref[sec:nm_tab_hmix_del2]{config\_mom\_del2}}
@@ -590,7 +590,7 @@
\hline
Possible Values: & .true. or .false. \\
\hline
- \caption{config\_use\_mom\_del4: {\bf \color{red} MISSING}}
+ \caption{config\_use\_mom\_del4: If true, biharmonic horizontal mixing is used on the momentum equation.}
\end{longtable}
\end{center}
\subsection[config\_use\_tracer\_del4]{\hyperref[sec:nm_tab_hmix_del4]{config\_use\_tracer\_del4}}
@@ -606,7 +606,7 @@
\hline
Possible Values: & .true. or .false. \\
\hline
- \caption{config\_use\_tracer\_del4: {\bf \color{red} MISSING}}
+ \caption{config\_use\_tracer\_del4: If true, biharmonic horizontal mixing is used on the tracer equation.}
\end{longtable}
\end{center}
\subsection[config\_mom\_del4]{\hyperref[sec:nm_tab_hmix_del4]{config\_mom\_del4}}
@@ -638,7 +638,7 @@
\hline
Possible Values: & any positive real \\
\hline
- \caption{config\_tracer\_del4: Coefficient for horizontal biharmonic operator on momentum.}
+ \caption{config\_tracer\_del4: Coefficient for horizontal biharmonic operator on tracers.}
\end{longtable}
\end{center}
\subsection[config\_vorticity\_del4\_scale]{\hyperref[sec:nm_tab_hmix_del4]{config\_vorticity\_del4\_scale}}
@@ -1412,13 +1412,13 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 2 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive integer, but typically 1, 2, or 3 \\
\hline
- \caption{config\_n\_ts\_iter: {\bf \color{red} MISSING}}
+ \caption{config\_n\_ts\_iter: number of large iterations over stages 1-3}
\end{longtable}
\end{center}
\subsection[config\_n\_bcl\_iter\_beg]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_n\_bcl\_iter\_beg}}
@@ -1428,13 +1428,13 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 1 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive integer, but typically 1, 2, or 3 \\
\hline
- \caption{config\_n\_bcl\_iter\_beg: {\bf \color{red} MISSING}}
+ \caption{config\_n\_bcl\_iter\_beg: number of iterations of stage 1 (baroclinic solve) on the first split-explicit iteration}
\end{longtable}
\end{center}
\subsection[config\_n\_bcl\_iter\_mid]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_n\_bcl\_iter\_mid}}
@@ -1444,13 +1444,13 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 2 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive integer, but typically 1, 2, or 3 \\
\hline
- \caption{config\_n\_bcl\_iter\_mid: {\bf \color{red} MISSING}}
+ \caption{config\_n\_bcl\_iter\_mid: number of iterations of stage 1 (baroclinic solve) on any split-explicit iterations between first and last}
\end{longtable}
\end{center}
\subsection[config\_n\_bcl\_iter\_end]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_n\_bcl\_iter\_end}}
@@ -1460,13 +1460,13 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 2 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive integer, but typically 1, 2, or 3 \\
\hline
- \caption{config\_n\_bcl\_iter\_end: {\bf \color{red} MISSING}}
+ \caption{config\_n\_bcl\_iter\_end: number of iterations of stage 1 (baroclinic solve) on the last split-explicit iteration}
\end{longtable}
\end{center}
\subsection[config\_n\_btr\_subcycles]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_n\_btr\_subcycles}}
@@ -1476,13 +1476,13 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 20 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive integer, typically between 10 and 100 \\
\hline
- \caption{config\_n\_btr\_subcycles: {\bf \color{red} MISSING}}
+ \caption{config\_n\_btr\_subcycles: number of barotropic subcycles in stage 2}
\end{longtable}
\end{center}
\subsection[config\_n\_btr\_cor\_iter]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_n\_btr\_cor\_iter}}
@@ -1492,13 +1492,13 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 2 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive integer, but typically 1, 2, or 3 \\
\hline
- \caption{config\_n\_btr\_cor\_iter: {\bf \color{red} MISSING}}
+ \caption{config\_n\_btr\_cor\_iter: number of iterations of the velocity corrector step in stage 2}
\end{longtable}
\end{center}
\subsection[config\_u\_correction]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_u\_correction}}
@@ -1508,13 +1508,13 @@
\hline
Type: & logical \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & .true. \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & .true. or .false. \\
\hline
- \caption{config\_u\_correction: {\bf \color{red} MISSING}}
+ \caption{config\_u\_correction: If true, the velocity correction term is included in the horizontal advection of thickness and tracers}
\end{longtable}
\end{center}
\subsection[config\_btr\_subcycle\_loop\_factor]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_btr\_subcycle\_loop\_factor}}
@@ -1524,13 +1524,13 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 2 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & Any positive integer, but typically 1 or 2 \\
\hline
- \caption{config\_btr\_subcycle\_loop\_factor: {\bf \color{red} MISSING}}
+ \caption{config\_btr\_subcycle\_loop\_factor: Barotropic subcycles proceed from $t$ to $t+n\Delta t$ , where $n$ is this configuration option.}
\end{longtable}
\end{center}
\subsection[config\_btr\_gam1\_uWt1]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_btr\_gam1\_uWt1}}
@@ -1540,13 +1540,13 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 0.5 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & between 0 and 1 \\
\hline
- \caption{config\_btr\_gam1\_uWt1: {\bf \color{red} MISSING}}
+ \caption{config\_btr\_gam1\_uWt1: Weighting of velocity in the SSH predictor step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used.}
\end{longtable}
\end{center}
\subsection[config\_btr\_gam2\_SSHWt1]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_btr\_gam2\_SSHWt1}}
@@ -1556,13 +1556,13 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 1.0 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & between 0 and 1 \\
\hline
- \caption{config\_btr\_gam2\_SSHWt1: {\bf \color{red} MISSING}}
+ \caption{config\_btr\_gam2\_SSHWt1: Weighting of SSH in the velocity corrector step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used.}
\end{longtable}
\end{center}
\subsection[config\_btr\_gam3\_uWt2]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_btr\_gam3\_uWt2}}
@@ -1572,13 +1572,13 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & 1.0 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & between 0 and 1 \\
\hline
- \caption{config\_btr\_gam3\_uWt2: {\bf \color{red} MISSING}}
+ \caption{config\_btr\_gam3\_uWt2: Weighting of velocity in the SSH corrector step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used.}
\end{longtable}
\end{center}
\subsection[config\_btr\_solve\_SSH2]{\hyperref[sec:nm_tab_split_explicit_ts]{config\_btr\_solve\_SSH2}}
@@ -1588,13 +1588,13 @@
\hline
Type: & logical \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Default Value: & .false. \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & .true. or .false. \\
\hline
- \caption{config\_btr\_solve\_SSH2: {\bf \color{red} MISSING}}
+ \caption{config\_btr\_solve\_SSH2: If true, execute the SSH corrector step in stage 2}
\end{longtable}
\end{center}
\section[debug]{\hyperref[sec:nm_tab_debug]{debug}}
Modified: trunk/documents/users_guide/ocean/namelist_table_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocean/namelist_table_documentation.tex 2013-03-21 17:14:25 UTC (rev 2646)
+++ trunk/documents/users_guide/ocean/namelist_table_documentation.tex 2013-03-21 17:14:36 UTC (rev 2647)
@@ -148,9 +148,9 @@
{\bf Name} & {\bf Description} \\
\hline
\hline
- \hyperref[subsec:nm_sec_config_use_mom_del2]{config\_use\_mom\_del2} & If true, the Laplacian horizontal mixing is used on the momentum equation. \\
+ \hyperref[subsec:nm_sec_config_use_mom_del2]{config\_use\_mom\_del2} & If true, Laplacian horizontal mixing is used on the momentum equation. \\
\hline
- \hyperref[subsec:nm_sec_config_use_tracer_del2]{config\_use\_tracer\_del2} & If true, the Laplacian horizontal mixing is used on the tracer equation. \\
+ \hyperref[subsec:nm_sec_config_use_tracer_del2]{config\_use\_tracer\_del2} & If true, Laplacian horizontal mixing is used on the tracer equation. \\
\hline
\hyperref[subsec:nm_sec_config_mom_del2]{config\_mom\_del2} & Horizonal viscosity, $</font>
<font color="gray">u\_h$ . \\
\hline
@@ -171,13 +171,13 @@
{\bf Name} & {\bf Description} \\
\hline
\hline
- \hyperref[subsec:nm_sec_config_use_mom_del4]{config\_use\_mom\_del4} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_use_mom_del4]{config\_use\_mom\_del4} & If true, biharmonic horizontal mixing is used on the momentum equation. \\
\hline
- \hyperref[subsec:nm_sec_config_use_tracer_del4]{config\_use\_tracer\_del4} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_use_tracer_del4]{config\_use\_tracer\_del4} & If true, biharmonic horizontal mixing is used on the tracer equation. \\
\hline
\hyperref[subsec:nm_sec_config_mom_del4]{config\_mom\_del4} & Coefficient for horizontal biharmonic operator on momentum. \\
\hline
- \hyperref[subsec:nm_sec_config_tracer_del4]{config\_tracer\_del4} & Coefficient for horizontal biharmonic operator on momentum. \\
+ \hyperref[subsec:nm_sec_config_tracer_del4]{config\_tracer\_del4} & Coefficient for horizontal biharmonic operator on tracers. \\
\hline
\hyperref[subsec:nm_sec_config_vorticity_del4_scale]{config\_vorticity\_del4\_scale} & {\color{red} TO BE DELETED} \\
\hline
@@ -448,29 +448,29 @@
{\bf Name} & {\bf Description} \\
\hline
\hline
- \hyperref[subsec:nm_sec_config_n_ts_iter]{config\_n\_ts\_iter} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_n_ts_iter]{config\_n\_ts\_iter} & number of large iterations over stages 1-3 \\
\hline
- \hyperref[subsec:nm_sec_config_n_bcl_iter_beg]{config\_n\_bcl\_iter\_beg} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_n_bcl_iter_beg]{config\_n\_bcl\_iter\_beg} & number of iterations of stage 1 (baroclinic solve) on the first split-explicit iteration \\
\hline
- \hyperref[subsec:nm_sec_config_n_bcl_iter_mid]{config\_n\_bcl\_iter\_mid} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_n_bcl_iter_mid]{config\_n\_bcl\_iter\_mid} & number of iterations of stage 1 (baroclinic solve) on any split-explicit iterations between first and last \\
\hline
- \hyperref[subsec:nm_sec_config_n_bcl_iter_end]{config\_n\_bcl\_iter\_end} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_n_bcl_iter_end]{config\_n\_bcl\_iter\_end} & number of iterations of stage 1 (baroclinic solve) on the last split-explicit iteration \\
\hline
- \hyperref[subsec:nm_sec_config_n_btr_subcycles]{config\_n\_btr\_subcycles} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_n_btr_subcycles]{config\_n\_btr\_subcycles} & number of barotropic subcycles in stage 2 \\
\hline
- \hyperref[subsec:nm_sec_config_n_btr_cor_iter]{config\_n\_btr\_cor\_iter} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_n_btr_cor_iter]{config\_n\_btr\_cor\_iter} & number of iterations of the velocity corrector step in stage 2 \\
\hline
- \hyperref[subsec:nm_sec_config_u_correction]{config\_u\_correction} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_u_correction]{config\_u\_correction} & If true, the velocity correction term is included in the horizontal advection of thickness and tracers \\
\hline
- \hyperref[subsec:nm_sec_config_btr_subcycle_loop_factor]{config\_btr\_subcycle\_loop\_factor} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_btr_subcycle_loop_factor]{config\_btr\_subcycle\_loop\_factor} & Barotropic subcycles proceed from $t$ to $t+n\Delta t$ , where $n$ is this configuration option. \\
\hline
- \hyperref[subsec:nm_sec_config_btr_gam1_uWt1]{config\_btr\_gam1\_uWt1} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_btr_gam1_uWt1]{config\_btr\_gam1\_uWt1} & Weighting of velocity in the SSH predictor step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used. \\
\hline
- \hyperref[subsec:nm_sec_config_btr_gam2_SSHWt1]{config\_btr\_gam2\_SSHWt1} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_btr_gam2_SSHWt1]{config\_btr\_gam2\_SSHWt1} & Weighting of SSH in the velocity corrector step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used. \\
\hline
- \hyperref[subsec:nm_sec_config_btr_gam3_uWt2]{config\_btr\_gam3\_uWt2} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_btr_gam3_uWt2]{config\_btr\_gam3\_uWt2} & Weighting of velocity in the SSH corrector step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used. \\
\hline
- \hyperref[subsec:nm_sec_config_btr_solve_SSH2]{config\_btr\_solve\_SSH2} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_btr_solve_SSH2]{config\_btr\_solve\_SSH2} & If true, execute the SSH corrector step in stage 2 \\
\hline
\end{longtable}
\end{center}
Modified: trunk/documents/users_guide/ocean/variable_section_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocean/variable_section_documentation.tex 2013-03-21 17:14:25 UTC (rev 2646)
+++ trunk/documents/users_guide/ocean/variable_section_documentation.tex 2013-03-21 17:14:36 UTC (rev 2647)
@@ -962,7 +962,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -972,7 +972,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% MontPot \\
\hline
- \caption{MontPot: {\bf \color{red} MISSING}}
+ \caption{MontPot: Montgomery potential, may be used as the pressure for isopycnal coordinates.}
\end{longtable}
\end{center}
\subsection[pressure]{\hyperref[sec:var_tab_state]{pressure}}
@@ -992,7 +992,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% pressure \\
\hline
- \caption{pressure: pressure used in the velocity equation}
+ \caption{pressure: pressure used in the momentum equation}
\end{longtable}
\end{center}
\subsection[wTop]{\hyperref[sec:var_tab_state]{wTop}}
@@ -1002,7 +1002,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevelsP1 nCells Time \\
\hline
@@ -1012,7 +1012,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% wTop \\
\hline
- \caption{wTop: {\bf \color{red} MISSING}}
+ \caption{wTop: vertical transport through the layer interface at the top of the cell}
\end{longtable}
\end{center}
\subsection[vertVelocityTop]{\hyperref[sec:var_tab_state]{vertVelocityTop}}
@@ -1042,7 +1042,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $kg$ $m^{-3}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -1052,7 +1052,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% rhoDisplaced \\
\hline
- \caption{rhoDisplaced: {\bf \color{red} MISSING}}
+ \caption{rhoDisplaced: potential density displaced to the mid-depth of top layer}
\end{longtable}
\end{center}
\subsection[BruntVaisalaFreqTop]{\hyperref[sec:var_tab_state]{BruntVaisalaFreqTop}}
@@ -1182,7 +1182,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ \\
\hline
Dimension: & Time \\
\hline
@@ -1192,7 +1192,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% areaCellGlobal \\
\hline
- \caption{areaCellGlobal: {\bf \color{red} MISSING}}
+ \caption{areaCellGlobal: sum of the areaCell variable over the full domain, used to normalize global statistics}
\end{longtable}
\end{center}
\subsection[areaEdgeGlobal]{\hyperref[sec:var_tab_state]{areaEdgeGlobal}}
@@ -1202,7 +1202,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ \\
\hline
Dimension: & Time \\
\hline
@@ -1212,7 +1212,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% areaEdgeGlobal \\
\hline
- \caption{areaEdgeGlobal: {\bf \color{red} MISSING}}
+ \caption{areaEdgeGlobal: sum of the areaEdge variable over the full domain, used to normalize global statistics}
\end{longtable}
\end{center}
\subsection[areaTriangleGlobal]{\hyperref[sec:var_tab_state]{areaTriangleGlobal}}
@@ -1222,7 +1222,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ \\
\hline
Dimension: & Time \\
\hline
@@ -1232,7 +1232,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% areaTriangleGlobal \\
\hline
- \caption{areaTriangleGlobal: {\bf \color{red} MISSING}}
+ \caption{areaTriangleGlobal: sum of the areaTriangle variable over the full domain, used to normalize global statistics}
\end{longtable}
\end{center}
\subsection[volumeCellGlobal]{\hyperref[sec:var_tab_state]{volumeCellGlobal}}
@@ -1242,7 +1242,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^3$ \\
\hline
Dimension: & Time \\
\hline
@@ -1252,7 +1252,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% volumeCellGlobal \\
\hline
- \caption{volumeCellGlobal: {\bf \color{red} MISSING}}
+ \caption{volumeCellGlobal: sum of the volumeCell variable over the full domain, used to normalize global statistics}
\end{longtable}
\end{center}
\subsection[volumeEdgeGlobal]{\hyperref[sec:var_tab_state]{volumeEdgeGlobal}}
@@ -1262,7 +1262,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^3$ \\
\hline
Dimension: & Time \\
\hline
@@ -1272,7 +1272,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% volumeEdgeGlobal \\
\hline
- \caption{volumeEdgeGlobal: {\bf \color{red} MISSING}}
+ \caption{volumeEdgeGlobal: sum of the volumeEdge variable over the full domain, used to normalize global statistics}
\end{longtable}
\end{center}
\subsection[CFLNumberGlobal]{\hyperref[sec:var_tab_state]{CFLNumberGlobal}}
@@ -1282,7 +1282,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & Time \\
\hline
@@ -1292,7 +1292,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% CFLNumberGlobal \\
\hline
- \caption{CFLNumberGlobal: {\bf \color{red} MISSING}}
+ \caption{CFLNumberGlobal: maximum CFL number over the full domain}
\end{longtable}
\end{center}
\subsection[nAccumulate]{\hyperref[sec:var_tab_state]{nAccumulate}}
@@ -1302,7 +1302,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & Time \\
\hline
@@ -1312,7 +1312,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% nAccumulate \\
\hline
- \caption{nAccumulate: {\bf \color{red} MISSING}}
+ \caption{nAccumulate: number of timesteps in time-averaged variables}
\end{longtable}
\end{center}
\subsection[acc\_ssh]{\hyperref[sec:var_tab_state]{acc\_ssh}}
@@ -1322,7 +1322,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nCells Time \\
\hline
@@ -1332,7 +1332,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_ssh \\
\hline
- \caption{acc\_ssh: {\bf \color{red} MISSING}}
+ \caption{acc\_ssh: time-averaged sea surface height}
\end{longtable}
\end{center}
\subsection[acc\_sshVar]{\hyperref[sec:var_tab_state]{acc\_sshVar}}
@@ -1342,7 +1342,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nCells Time \\
\hline
@@ -1352,7 +1352,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_sshVar \\
\hline
- \caption{acc\_sshVar: {\bf \color{red} MISSING}}
+ \caption{acc\_sshVar: variance of sea surface height}
\end{longtable}
\end{center}
\subsection[acc\_uReconstructZonal]{\hyperref[sec:var_tab_state]{acc\_uReconstructZonal}}
@@ -1362,7 +1362,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -1372,7 +1372,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_uReconstructZonal \\
\hline
- \caption{acc\_uReconstructZonal: {\bf \color{red} MISSING}}
+ \caption{acc\_uReconstructZonal: time-averaged velocity in the eastward direction}
\end{longtable}
\end{center}
\subsection[acc\_uReconstructMeridional]{\hyperref[sec:var_tab_state]{acc\_uReconstructMeridional}}
@@ -1382,7 +1382,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -1392,7 +1392,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_uReconstructMeridional \\
\hline
- \caption{acc\_uReconstructMeridional: {\bf \color{red} MISSING}}
+ \caption{acc\_uReconstructMeridional: time-averaged velocity in the northward direction}
\end{longtable}
\end{center}
\subsection[acc\_uReconstructZonalVar]{\hyperref[sec:var_tab_state]{acc\_uReconstructZonalVar}}
@@ -1402,7 +1402,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -1412,7 +1412,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_uReconstructZonalVar \\
\hline
- \caption{acc\_uReconstructZonalVar: {\bf \color{red} MISSING}}
+ \caption{acc\_uReconstructZonalVar: variance of velocity in the eastward direction}
\end{longtable}
\end{center}
\subsection[acc\_uReconstructMeridionalVar]{\hyperref[sec:var_tab_state]{acc\_uReconstructMeridionalVar}}
@@ -1422,7 +1422,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -1432,7 +1432,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_uReconstructMeridionalVar \\
\hline
- \caption{acc\_uReconstructMeridionalVar: {\bf \color{red} MISSING}}
+ \caption{acc\_uReconstructMeridionalVar: variance of velocity in the northward direction}
\end{longtable}
\end{center}
\subsection[acc\_u]{\hyperref[sec:var_tab_state]{acc\_u}}
@@ -1442,7 +1442,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -1452,7 +1452,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_u \\
\hline
- \caption{acc\_u: {\bf \color{red} MISSING}}
+ \caption{acc\_u: time-averaged velocity, normal to cell edge}
\end{longtable}
\end{center}
\subsection[acc\_uVar]{\hyperref[sec:var_tab_state]{acc\_uVar}}
@@ -1462,7 +1462,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -1472,7 +1472,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_uVar \\
\hline
- \caption{acc\_uVar: {\bf \color{red} MISSING}}
+ \caption{acc\_uVar: variance of velocity, normal to cell edge}
\end{longtable}
\end{center}
\subsection[acc\_vertVelocityTop]{\hyperref[sec:var_tab_state]{acc\_vertVelocityTop}}
@@ -1482,7 +1482,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevelsP1 nCells Time \\
\hline
@@ -1492,7 +1492,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% acc\_vertVelocityTop \\
\hline
- \caption{acc\_vertVelocityTop: {\bf \color{red} MISSING}}
+ \caption{acc\_vertVelocityTop: time-averaged vertical velocity at top of cell}
\end{longtable}
\end{center}
\section[mesh]{\hyperref[sec:var_tab_mesh]{mesh}}
@@ -1894,7 +1894,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% meshScalingDel2 \\
\hline
- \caption{meshScalingDel2: {\bf \color{red} MISSING}}
+ \caption{meshScalingDel2: Coefficient to Laplacian mixing terms in momentum and tracer equations, so that viscosity and diffusion scale with mesh.}
\end{longtable}
\end{center}
\subsection[meshScalingDel4]{\hyperref[sec:var_tab_mesh]{meshScalingDel4}}
@@ -1914,7 +1914,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% meshScalingDel4 \\
\hline
- \caption{meshScalingDel4: {\bf \color{red} MISSING}}
+ \caption{meshScalingDel4: Coefficient to biharmonic mixing terms in momentum and tracer equations, so that biharmonic viscosity and diffusion coefficients scale with mesh.}
\end{longtable}
\end{center}
\subsection[meshScaling]{\hyperref[sec:var_tab_mesh]{meshScaling}}
@@ -1934,7 +1934,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% meshScaling \\
\hline
- \caption{meshScaling: {\bf \color{red} MISSING}}
+ \caption{meshScaling: Coefficient used for mesh scaling, such as the Leith parameter.}
\end{longtable}
\end{center}
\subsection[cellsOnEdge]{\hyperref[sec:var_tab_mesh]{cellsOnEdge}}
Modified: trunk/documents/users_guide/ocean/variable_table_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocean/variable_table_documentation.tex 2013-03-21 17:14:25 UTC (rev 2646)
+++ trunk/documents/users_guide/ocean/variable_table_documentation.tex 2013-03-21 17:14:36 UTC (rev 2647)
@@ -110,15 +110,15 @@
\hline
\hyperref[subsec:var_sec_state_uSrcReconstructMeridional]{uSrcReconstructMeridional} & wind stress in the northward direction \\
\hline
- \hyperref[subsec:var_sec_state_MontPot]{MontPot} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_MontPot]{MontPot} & Montgomery potential, may be used as the pressure for isopycnal coordinates. \\
\hline
- \hyperref[subsec:var_sec_state_pressure]{pressure} & pressure used in the velocity equation \\
+ \hyperref[subsec:var_sec_state_pressure]{pressure} & pressure used in the momentum equation \\
\hline
- \hyperref[subsec:var_sec_state_wTop]{wTop} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_wTop]{wTop} & vertical transport through the layer interface at the top of the cell \\
\hline
\hyperref[subsec:var_sec_state_vertVelocityTop]{vertVelocityTop} & vertical velocity defined at center (horizonally) and top (vertically) of cell \\
\hline
- \hyperref[subsec:var_sec_state_rhoDisplaced]{rhoDisplaced} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_rhoDisplaced]{rhoDisplaced} & potential density displaced to the mid-depth of top layer \\
\hline
\hyperref[subsec:var_sec_state_BruntVaisalaFreqTop]{BruntVaisalaFreqTop} & Brunt Vaisala frequency defined at the center (horizontally) and top (vertically) of cell \\
\hline
@@ -132,37 +132,37 @@
\hline
\hyperref[subsec:var_sec_state_gradVor_n]{gradVor\_n} & gradient of vorticity in the normal direction (from cell1 to cell2) \\
\hline
- \hyperref[subsec:var_sec_state_areaCellGlobal]{areaCellGlobal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_areaCellGlobal]{areaCellGlobal} & sum of the areaCell variable over the full domain, used to normalize global statistics \\
\hline
- \hyperref[subsec:var_sec_state_areaEdgeGlobal]{areaEdgeGlobal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_areaEdgeGlobal]{areaEdgeGlobal} & sum of the areaEdge variable over the full domain, used to normalize global statistics \\
\hline
- \hyperref[subsec:var_sec_state_areaTriangleGlobal]{areaTriangleGlobal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_areaTriangleGlobal]{areaTriangleGlobal} & sum of the areaTriangle variable over the full domain, used to normalize global statistics \\
\hline
- \hyperref[subsec:var_sec_state_volumeCellGlobal]{volumeCellGlobal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_volumeCellGlobal]{volumeCellGlobal} & sum of the volumeCell variable over the full domain, used to normalize global statistics \\
\hline
- \hyperref[subsec:var_sec_state_volumeEdgeGlobal]{volumeEdgeGlobal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_volumeEdgeGlobal]{volumeEdgeGlobal} & sum of the volumeEdge variable over the full domain, used to normalize global statistics \\
\hline
- \hyperref[subsec:var_sec_state_CFLNumberGlobal]{CFLNumberGlobal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_CFLNumberGlobal]{CFLNumberGlobal} & maximum CFL number over the full domain \\
\hline
- \hyperref[subsec:var_sec_state_nAccumulate]{nAccumulate} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_nAccumulate]{nAccumulate} & number of timesteps in time-averaged variables \\
\hline
- \hyperref[subsec:var_sec_state_acc_ssh]{acc\_ssh} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_ssh]{acc\_ssh} & time-averaged sea surface height \\
\hline
- \hyperref[subsec:var_sec_state_acc_sshVar]{acc\_sshVar} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_sshVar]{acc\_sshVar} & variance of sea surface height \\
\hline
- \hyperref[subsec:var_sec_state_acc_uReconstructZonal]{acc\_uReconstructZonal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_uReconstructZonal]{acc\_uReconstructZonal} & time-averaged velocity in the eastward direction \\
\hline
- \hyperref[subsec:var_sec_state_acc_uReconstructMeridional]{acc\_uReconstructMeridional} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_uReconstructMeridional]{acc\_uReconstructMeridional} & time-averaged velocity in the northward direction \\
\hline
- \hyperref[subsec:var_sec_state_acc_uReconstructZonalVar]{acc\_uReconstructZonalVar} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_uReconstructZonalVar]{acc\_uReconstructZonalVar} & variance of velocity in the eastward direction \\
\hline
- \hyperref[subsec:var_sec_state_acc_uReconstructMeridionalVar]{acc\_uReconstructMeridionalVar} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_uReconstructMeridionalVar]{acc\_uReconstructMeridionalVar} & variance of velocity in the northward direction \\
\hline
- \hyperref[subsec:var_sec_state_acc_u]{acc\_u} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_u]{acc\_u} & time-averaged velocity, normal to cell edge \\
\hline
- \hyperref[subsec:var_sec_state_acc_uVar]{acc\_uVar} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_uVar]{acc\_uVar} & variance of velocity, normal to cell edge \\
\hline
- \hyperref[subsec:var_sec_state_acc_vertVelocityTop]{acc\_vertVelocityTop} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_acc_vertVelocityTop]{acc\_vertVelocityTop} & time-averaged vertical velocity at top of cell \\
\hline
\end{longtable}
\end{center}
@@ -214,11 +214,11 @@
\hline
\hyperref[subsec:var_sec_mesh_meshDensity]{meshDensity} & Value of density function used to generate a particular mesh at cell centers. \\
\hline
- \hyperref[subsec:var_sec_mesh_meshScalingDel2]{meshScalingDel2} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_meshScalingDel2]{meshScalingDel2} & Coefficient to Laplacian mixing terms in momentum and tracer equations, so that viscosity and diffusion scale with mesh. \\
\hline
- \hyperref[subsec:var_sec_mesh_meshScalingDel4]{meshScalingDel4} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_meshScalingDel4]{meshScalingDel4} & Coefficient to biharmonic mixing terms in momentum and tracer equations, so that biharmonic viscosity and diffusion coefficients scale with mesh. \\
\hline
- \hyperref[subsec:var_sec_mesh_meshScaling]{meshScaling} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_meshScaling]{meshScaling} & Coefficient used for mesh scaling, such as the Leith parameter. \\
\hline
\hyperref[subsec:var_sec_mesh_cellsOnEdge]{cellsOnEdge} & List of cells that straddle each edge. \\
\hline
</font>
</pre>