<p><b>dwj07@fsu.edu</b> 2013-03-21 09:11:11 -0600 (Thu, 21 Mar 2013)</p><p><br>
-- DOCUMENT COMMIT --<br>
<br>
Updating ocean users guide documents.<br>
</p><hr noshade><pre><font color="gray">Modified: trunk/documents/users_guide/ocean/dimension_table_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocean/dimension_table_documentation.tex 2013-03-21 15:05:34 UTC (rev 2640)
+++ trunk/documents/users_guide/ocean/dimension_table_documentation.tex 2013-03-21 15:11:11 UTC (rev 2641)
@@ -7,33 +7,33 @@
{\bf Name} & {\bf Units} & {\bf Description} \\
\hline
\hline
- nCells & unitless & The number of polygons in the primary grid. \\
+ nCells & $unitless$ & The number of polygons in the primary grid. \\
\hline
- nEdges & unitless & The number of edge midpoints in either the primary or dual grid. \\
+ nEdges & $unitless$ & The number of edge midpoints in either the primary or dual grid. \\
\hline
- maxEdges & unitless & The largest number of edges any polygon within the grid has. \\
+ maxEdges & $unitless$ & The largest number of edges any polygon within the grid has. \\
\hline
- maxEdges2 & unitless & Two times the largest number of edges any polygon within the grid has. \\
+ maxEdges2 & $unitless$ & Two times the largest number of edges any polygon within the grid has. \\
\hline
- nAdvectionCells & unitless & The largest number of advection cells for any edge. \\
+ nAdvectionCells & $unitless$ & The largest number of advection cells for any edge. \\
\hline
- nVertices & unitless & The total number of cells in the dual grid. Also the number of corners in the primary grid. \\
+ nVertices & $unitless$ & The total number of cells in the dual grid. Also the number of corners in the primary grid. \\
\hline
- TWO & unitless & The number two as a dimension. \\
+ TWO & $unitless$ & The number two as a dimension. \\
\hline
- R3 & unitless & The number three as a dimension. \\
+ R3 & $unitless$ & The number three as a dimension. \\
\hline
- FIFTEEN & unitless & The number 15 as a dimension. \\
+ FIFTEEN & $unitless$ & The number 15 as a dimension. \\
\hline
- TWENTYONE & unitless & The number 21 as a dimension. \\
+ TWENTYONE & $unitless$ & The number 21 as a dimension. \\
\hline
- vertexDegree & unitless & The number of cells or edges touching each vertex. \\
+ vertexDegree & $unitless$ & The number of cells or edges touching each vertex. \\
\hline
- nVertLevels & unitless & The number of levels in the vertical direction. All vertical levels share the same horizontal locations. \\
+ nVertLevels & $unitless$ & The number of levels in the vertical direction. All vertical levels share the same horizontal locations. \\
\hline
- nVertLevelsP1 & unitless & The number of interfaces in the vertical direction. \\
+ nVertLevelsP1 & $unitless$ & The number of interfaces in the vertical direction. \\
\hline
- nMonths & unitless & The number of forcing slices in the monthly forcing fields. {\bf \color{red} Deprecated. Should be removed.} \\
+ nMonths & $unitless$ & The number of forcing slices in the monthly forcing fields. {\bf \color{red} Deprecated. Should be removed.} \\
\hline
\end{longtable}
\end{center}
Modified: trunk/documents/users_guide/ocean/namelist_section_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocean/namelist_section_documentation.tex 2013-03-21 15:05:34 UTC (rev 2640)
+++ trunk/documents/users_guide/ocean/namelist_section_documentation.tex 2013-03-21 15:11:11 UTC (rev 2641)
@@ -274,7 +274,7 @@
\hline
Default Value: & 3000.0 \\
\hline
- Possible Values: & Any real value, but limited by CFL condition. \\
+ Possible Values: & Any positive real value, but limited by CFL condition. \\
\hline
\caption{config\_dt: Length of model time-step.}
\end{longtable}
@@ -458,7 +458,7 @@
\hline
Possible Values: & .true. or .false. \\
\hline
- \caption{config\_hmix\_ScaleWithMesh: {\bf \color{red} MISSING}}
+ \caption{config\_hmix\_ScaleWithMesh: If false, del2 and del4 coefficients are constant throughout the mesh (equivalent to setting $\rho\_m=1$ throughout the mesh). If true, these coefficients scale as mesh density to the -3/4 power.}
\end{longtable}
\end{center}
\subsection[config\_visc\_vorticity\_term]{\hyperref[sec:nm_tab_hmix]{config\_visc\_vorticity\_term}}
@@ -474,7 +474,7 @@
\hline
Possible Values: & .true. or .false. \\
\hline
- \caption{config\_visc\_vorticity\_term: {\bf \color{red} MISSING}}
+ \caption{config\_visc\_vorticity\_term: {\color{red} TO BE DELETED}}
\end{longtable}
\end{center}
\subsection[config\_apvm\_scale\_factor]{\hyperref[sec:nm_tab_hmix]{config\_apvm\_scale\_factor}}
@@ -488,9 +488,9 @@
\hline
Default Value: & 0.0 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & Any non-negative number, typically between zero and one. \\
\hline
- \caption{config\_apvm\_scale\_factor: {\bf \color{red} MISSING}}
+ \caption{config\_apvm\_scale\_factor: Anticipated potential vorticity (APV) method scale factor, $c\_{apv}$ . When zero, APV is off.}
\end{longtable}
\end{center}
\section[hmix\_del2]{\hyperref[sec:nm_tab_hmix_del2]{hmix\_del2}}
@@ -508,7 +508,7 @@
\hline
Possible Values: & .true. or .false. \\
\hline
- \caption{config\_use\_mom\_del2: {\bf \color{red} MISSING}}
+ \caption{config\_use\_mom\_del2: If true, the 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: {\bf \color{red} MISSING}}
+ \caption{config\_use\_tracer\_del2: If true, the 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}}
@@ -534,13 +534,13 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-1}$ \\
\hline
Default Value: & 0.0 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive real \\
\hline
- \caption{config\_mom\_del2: {\bf \color{red} MISSING}}
+ \caption{config\_mom\_del2: Horizonal viscosity, $</font>
<font color="gray">u\_h$ .}
\end{longtable}
\end{center}
\subsection[config\_tracer\_del2]{\hyperref[sec:nm_tab_hmix_del2]{config\_tracer\_del2}}
@@ -550,13 +550,13 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-1}$ \\
\hline
Default Value: & 0.0 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive real \\
\hline
- \caption{config\_tracer\_del2: {\bf \color{red} MISSING}}
+ \caption{config\_tracer\_del2: Horizonal diffusion, $\kappa\_h$ .}
\end{longtable}
\end{center}
\subsection[config\_vorticity\_del2\_scale]{\hyperref[sec:nm_tab_hmix_del2]{config\_vorticity\_del2\_scale}}
@@ -572,7 +572,7 @@
\hline
Possible Values: & {\bf \color{red} MISSING} \\
\hline
- \caption{config\_vorticity\_del2\_scale: {\bf \color{red} MISSING}}
+ \caption{config\_vorticity\_del2\_scale: {\color{red} TO BE DELETED}}
\end{longtable}
\end{center}
\section[hmix\_del4]{\hyperref[sec:nm_tab_hmix_del4]{hmix\_del4}}
@@ -616,13 +616,13 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^4$ $s^{-1}$ \\
\hline
Default Value: & 5.0e13 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive real \\
\hline
- \caption{config\_mom\_del4: {\bf \color{red} MISSING}}
+ \caption{config\_mom\_del4: Coefficient for horizontal biharmonic operator on momentum.}
\end{longtable}
\end{center}
\subsection[config\_tracer\_del4]{\hyperref[sec:nm_tab_hmix_del4]{config\_tracer\_del4}}
@@ -632,13 +632,13 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^4$ $s^{-1}$ \\
\hline
Default Value: & 0.0 \\
\hline
- Possible Values: & {\bf \color{red} MISSING} \\
+ Possible Values: & any positive real \\
\hline
- \caption{config\_tracer\_del4: {\bf \color{red} MISSING}}
+ \caption{config\_tracer\_del4: Coefficient for horizontal biharmonic operator on momentum.}
\end{longtable}
\end{center}
\subsection[config\_vorticity\_del4\_scale]{\hyperref[sec:nm_tab_hmix_del4]{config\_vorticity\_del4\_scale}}
@@ -654,7 +654,7 @@
\hline
Possible Values: & {\bf \color{red} MISSING} \\
\hline
- \caption{config\_vorticity\_del4\_scale: {\bf \color{red} MISSING}}
+ \caption{config\_vorticity\_del4\_scale: {\color{red} TO BE DELETED}}
\end{longtable}
\end{center}
\section[hmix\_Leith]{\hyperref[sec:nm_tab_hmix_Leith]{hmix\_Leith}}
@@ -786,7 +786,7 @@
\hline
Default Value: & 0.0 \\
\hline
- Possible Values: & Any real value. \\
+ Possible Values: & Any positive real value. \\
\hline
\caption{config\_Rayleigh\_damping\_coeff: Inverse-time coefficient for the Rayleigh damping term, $c\_R$ .}
\end{longtable}
@@ -1148,7 +1148,7 @@
\hline
Default Value: & 90.0 \\
\hline
- Possible Values: & any real value, but typically between 30 and 90 days. \\
+ Possible Values: & any positive real value, but typically between 30 and 90 days. \\
\hline
\caption{config\_restoreT\_timescale: Restoring timescale for temperature, $\tau\_r.$ }
\end{longtable}
@@ -1164,7 +1164,7 @@
\hline
Default Value: & 90.0 \\
\hline
- Possible Values: & any real value, but typically between 30 and 90 days. \\
+ Possible Values: & any positive real value, but typically between 30 and 90 days. \\
\hline
\caption{config\_restoreS\_timescale: Restoring timescale for salinity, $\tau\_r$ .}
\end{longtable}
@@ -1264,7 +1264,7 @@
\hline
Default Value: & 1.0e-3 \\
\hline
- Possible Values: & any real, typically 1.0e-3 \\
+ Possible Values: & any positive real, typically 1.0e-3 \\
\hline
\caption{config\_bottom\_drag\_coeff: Dimensionless bottom drag coefficient, $c\_{drag}$ .}
\end{longtable}
@@ -1294,11 +1294,11 @@
\hline
Type: & real \\
\hline
- Units: & $kg m^{-3}$ \\
+ Units: & $kg$ $m^{-3}$ \\
\hline
Default Value: & 1014.65 \\
\hline
- Possible Values: & any real, but typically 1000-1035 \\
+ Possible Values: & any positive real, but typically 1000-1035 \\
\hline
\caption{config\_rho0: Density used as a coefficient of the pressure gradient terms, $\rho\_0$ . This is a constant due to the Boussinesq approximation.}
\end{longtable}
Modified: trunk/documents/users_guide/ocean/namelist_table_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocean/namelist_table_documentation.tex 2013-03-21 15:05:34 UTC (rev 2640)
+++ trunk/documents/users_guide/ocean/namelist_table_documentation.tex 2013-03-21 15:11:11 UTC (rev 2641)
@@ -129,11 +129,11 @@
{\bf Name} & {\bf Description} \\
\hline
\hline
- \hyperref[subsec:nm_sec_config_hmix_ScaleWithMesh]{config\_hmix\_ScaleWithMesh} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_hmix_ScaleWithMesh]{config\_hmix\_ScaleWithMesh} & If false, del2 and del4 coefficients are constant throughout the mesh (equivalent to setting $\rho\_m=1$ throughout the mesh). If true, these coefficients scale as mesh density to the -3/4 power. \\
\hline
- \hyperref[subsec:nm_sec_config_visc_vorticity_term]{config\_visc\_vorticity\_term} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_visc_vorticity_term]{config\_visc\_vorticity\_term} & {\color{red} TO BE DELETED} \\
\hline
- \hyperref[subsec:nm_sec_config_apvm_scale_factor]{config\_apvm\_scale\_factor} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_apvm_scale_factor]{config\_apvm\_scale\_factor} & Anticipated potential vorticity (APV) method scale factor, $c\_{apv}$ . When zero, APV is off. \\
\hline
\end{longtable}
\end{center}
@@ -148,15 +148,15 @@
{\bf Name} & {\bf Description} \\
\hline
\hline
- \hyperref[subsec:nm_sec_config_use_mom_del2]{config\_use\_mom\_del2} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_use_mom_del2]{config\_use\_mom\_del2} & If true, the Laplacian horizontal mixing is used on the momentum equation. \\
\hline
- \hyperref[subsec:nm_sec_config_use_tracer_del2]{config\_use\_tracer\_del2} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_use_tracer_del2]{config\_use\_tracer\_del2} & If true, the Laplacian horizontal mixing is used on the tracer equation. \\
\hline
- \hyperref[subsec:nm_sec_config_mom_del2]{config\_mom\_del2} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_mom_del2]{config\_mom\_del2} & Horizonal viscosity, $</font>
<font color="gray">u\_h$ . \\
\hline
- \hyperref[subsec:nm_sec_config_tracer_del2]{config\_tracer\_del2} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_tracer_del2]{config\_tracer\_del2} & Horizonal diffusion, $\kappa\_h$ . \\
\hline
- \hyperref[subsec:nm_sec_config_vorticity_del2_scale]{config\_vorticity\_del2\_scale} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_vorticity_del2_scale]{config\_vorticity\_del2\_scale} & {\color{red} TO BE DELETED} \\
\hline
\end{longtable}
\end{center}
@@ -175,11 +175,11 @@
\hline
\hyperref[subsec:nm_sec_config_use_tracer_del4]{config\_use\_tracer\_del4} & {\bf \color{red} MISSING} \\
\hline
- \hyperref[subsec:nm_sec_config_mom_del4]{config\_mom\_del4} & {\bf \color{red} MISSING} \\
+ \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} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_tracer_del4]{config\_tracer\_del4} & Coefficient for horizontal biharmonic operator on momentum. \\
\hline
- \hyperref[subsec:nm_sec_config_vorticity_del4_scale]{config\_vorticity\_del4\_scale} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:nm_sec_config_vorticity_del4_scale]{config\_vorticity\_del4\_scale} & {\color{red} TO BE DELETED} \\
\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 15:05:34 UTC (rev 2640)
+++ trunk/documents/users_guide/ocean/variable_section_documentation.tex 2013-03-21 15:11:11 UTC (rev 2641)
@@ -10,7 +10,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $degrees$ $Celsius$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -24,7 +24,7 @@
\hline
Array Group: & dynamics \\
\hline
- \caption{temperature: {\bf \color{red} MISSING}}
+ \caption{temperature: potential temperature}
\end{longtable}
\end{center}
\subsection[salinity]{\hyperref[sec:var_tab_state]{salinity}}
@@ -34,7 +34,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $grams$ $salt$ $per$ $kilogram$ $seawater$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -48,7 +48,7 @@
\hline
Array Group: & dynamics \\
\hline
- \caption{salinity: {\bf \color{red} MISSING}}
+ \caption{salinity: salinity}
\end{longtable}
\end{center}
\subsection[tracer1]{\hyperref[sec:var_tab_state]{tracer1}}
@@ -58,7 +58,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -72,7 +72,7 @@
\hline
Array Group: & testing \\
\hline
- \caption{tracer1: {\bf \color{red} MISSING}}
+ \caption{tracer1: A tracer with value 1.0 to test conservation. {\color{red} REMOVE THIS VARIABLE}}
\end{longtable}
\end{center}
\subsection[xtime]{\hyperref[sec:var_tab_state]{xtime}}
@@ -82,7 +82,7 @@
\hline
Type: & text \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & Time \\
\hline
@@ -92,7 +92,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% xtime \\
\hline
- \caption{xtime: {\bf \color{red} MISSING}}
+ \caption{xtime: model time, with format 'YYYY-MM-DD\_HH:MM:SS'}
\end{longtable}
\end{center}
\subsection[u]{\hyperref[sec:var_tab_state]{u}}
@@ -102,7 +102,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -112,7 +112,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% u \\
\hline
- \caption{u: {\bf \color{red} MISSING}}
+ \caption{u: horizonal velocity, normal component to an edge}
\end{longtable}
\end{center}
\subsection[h]{\hyperref[sec:var_tab_state]{h}}
@@ -122,7 +122,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -132,7 +132,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% h \\
\hline
- \caption{h: {\bf \color{red} MISSING}}
+ \caption{h: layer thickness}
\end{longtable}
\end{center}
\subsection[rho]{\hyperref[sec:var_tab_state]{rho}}
@@ -142,7 +142,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $kg$ $m^{-3}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -152,7 +152,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% rho \\
\hline
- \caption{rho: {\bf \color{red} MISSING}}
+ \caption{rho: density}
\end{longtable}
\end{center}
\subsection[uBtr]{\hyperref[sec:var_tab_state]{uBtr}}
@@ -162,7 +162,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nEdges Time \\
\hline
@@ -172,7 +172,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uBtr \\
\hline
- \caption{uBtr: {\bf \color{red} MISSING}}
+ \caption{uBtr: barotropic velocity, used in split-explicit time-stepping}
\end{longtable}
\end{center}
\subsection[ssh]{\hyperref[sec:var_tab_state]{ssh}}
@@ -182,7 +182,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nCells Time \\
\hline
@@ -192,7 +192,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% ssh \\
\hline
- \caption{ssh: {\bf \color{red} MISSING}}
+ \caption{ssh: sea surface height}
\end{longtable}
\end{center}
\subsection[uBtrSubcycle]{\hyperref[sec:var_tab_state]{uBtrSubcycle}}
@@ -202,7 +202,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nEdges Time \\
\hline
@@ -212,7 +212,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uBtrSubcycle \\
\hline
- \caption{uBtrSubcycle: {\bf \color{red} MISSING}}
+ \caption{uBtrSubcycle: barotropic velocity, used in subcycling in stage 2 of split-explicit time-stepping}
\end{longtable}
\end{center}
\subsection[sshSubcycle]{\hyperref[sec:var_tab_state]{sshSubcycle}}
@@ -222,7 +222,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nCells Time \\
\hline
@@ -232,7 +232,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% sshSubcycle \\
\hline
- \caption{sshSubcycle: {\bf \color{red} MISSING}}
+ \caption{sshSubcycle: sea surface height, used in subcycling in stage 2 of split-explicit time-stepping}
\end{longtable}
\end{center}
\subsection[FBtr]{\hyperref[sec:var_tab_state]{FBtr}}
@@ -242,7 +242,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-1}$ \\
\hline
Dimension: & nEdges Time \\
\hline
@@ -252,7 +252,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% FBtr \\
\hline
- \caption{FBtr: {\bf \color{red} MISSING}}
+ \caption{FBtr: Barotropic thickness flux at each edge, used to advance sea surface height in each subcycle of stage 2 of the split-explicit algorithm.}
\end{longtable}
\end{center}
\subsection[GBtrForcing]{\hyperref[sec:var_tab_state]{GBtrForcing}}
@@ -262,7 +262,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-2}$ \\
\hline
Dimension: & nEdges Time \\
\hline
@@ -272,7 +272,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% GBtrForcing \\
\hline
- \caption{GBtrForcing: {\bf \color{red} MISSING}}
+ \caption{GBtrForcing: Barotropic tendency computed from the baroclinic equations in stage 1 of the split-explicit algorithm.}
\end{longtable}
\end{center}
\subsection[uBcl]{\hyperref[sec:var_tab_state]{uBcl}}
@@ -282,7 +282,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -292,7 +292,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uBcl \\
\hline
- \caption{uBcl: {\bf \color{red} MISSING}}
+ \caption{uBcl: baroclinic velocity, used in split-explicit time-stepping}
\end{longtable}
\end{center}
\subsection[zMid]{\hyperref[sec:var_tab_state]{zMid}}
@@ -302,7 +302,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -312,7 +312,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% zMid \\
\hline
- \caption{zMid: {\bf \color{red} MISSING}}
+ \caption{zMid: z-coordinate of the mid-depth of the layer}
\end{longtable}
\end{center}
\subsection[v]{\hyperref[sec:var_tab_state]{v}}
@@ -322,7 +322,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -332,7 +332,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% v \\
\hline
- \caption{v: {\bf \color{red} MISSING}}
+ \caption{v: horizontal velocity, tangential to an edge}
\end{longtable}
\end{center}
\subsection[uTransport]{\hyperref[sec:var_tab_state]{uTransport}}
@@ -342,7 +342,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -352,7 +352,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uTransport \\
\hline
- \caption{uTransport: {\bf \color{red} MISSING}}
+ \caption{uTransport: horizontal velocity used to transport mass and tracers}
\end{longtable}
\end{center}
\subsection[uBolusGM]{\hyperref[sec:var_tab_state]{uBolusGM}}
@@ -542,7 +542,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -552,7 +552,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% divergence \\
\hline
- \caption{divergence: {\bf \color{red} MISSING}}
+ \caption{divergence: divergence of horizonal velocity}
\end{longtable}
\end{center}
\subsection[vorticity]{\hyperref[sec:var_tab_state]{vorticity}}
@@ -562,7 +562,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ \\
\hline
Dimension: & nVertLevels nVertices Time \\
\hline
@@ -572,7 +572,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% vorticity \\
\hline
- \caption{vorticity: {\bf \color{red} MISSING}}
+ \caption{vorticity: curl of horizontal velocity}
\end{longtable}
\end{center}
\subsection[Vor\_edge]{\hyperref[sec:var_tab_state]{Vor\_edge}}
@@ -582,7 +582,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -592,7 +592,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% Vor\_edge \\
\hline
- \caption{Vor\_edge: {\bf \color{red} MISSING}}
+ \caption{Vor\_edge: vorticity averaged from vertices to edges}
\end{longtable}
\end{center}
\subsection[h\_edge]{\hyperref[sec:var_tab_state]{h\_edge}}
@@ -602,7 +602,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -612,7 +612,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% h\_edge \\
\hline
- \caption{h\_edge: {\bf \color{red} MISSING}}
+ \caption{h\_edge: layer thickness averaged from cell center to edges}
\end{longtable}
\end{center}
\subsection[h\_vertex]{\hyperref[sec:var_tab_state]{h\_vertex}}
@@ -622,7 +622,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nVertLevels nVertices Time \\
\hline
@@ -632,7 +632,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% h\_vertex \\
\hline
- \caption{h\_vertex: {\bf \color{red} MISSING}}
+ \caption{h\_vertex: layer thickness averaged from cell center to vertices}
\end{longtable}
\end{center}
\subsection[ke]{\hyperref[sec:var_tab_state]{ke}}
@@ -642,7 +642,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -652,7 +652,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% ke \\
\hline
- \caption{ke: {\bf \color{red} MISSING}}
+ \caption{ke: kinetic energy of horizonal velocity}
\end{longtable}
\end{center}
\subsection[kev]{\hyperref[sec:var_tab_state]{kev}}
@@ -662,7 +662,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-2}$ \\
\hline
Dimension: & nVertLevels nVertices Time \\
\hline
@@ -672,7 +672,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% kev \\
\hline
- \caption{kev: {\bf \color{red} MISSING}}
+ \caption{kev: kinetic energy of horizonal velocity defined at vertices}
\end{longtable}
\end{center}
\subsection[kevc]{\hyperref[sec:var_tab_state]{kevc}}
@@ -682,7 +682,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -692,7 +692,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% kevc \\
\hline
- \caption{kevc: {\bf \color{red} MISSING}}
+ \caption{kevc: kinetic energy of horizonal velocity defined at vertices}
\end{longtable}
\end{center}
\subsection[ke\_edge]{\hyperref[sec:var_tab_state]{ke\_edge}}
@@ -702,7 +702,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-2}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -712,7 +712,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% ke\_edge \\
\hline
- \caption{ke\_edge: {\bf \color{red} MISSING}}
+ \caption{ke\_edge: kinetic energy of horizonal velocity defined at edges}
\end{longtable}
\end{center}
\subsection[Vor\_vertex]{\hyperref[sec:var_tab_state]{Vor\_vertex}}
@@ -722,7 +722,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ \\
\hline
Dimension: & nVertLevels nVertices Time \\
\hline
@@ -732,7 +732,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% Vor\_vertex \\
\hline
- \caption{Vor\_vertex: {\bf \color{red} MISSING}}
+ \caption{Vor\_vertex: curl of horizontal velocity defined at vertices}
\end{longtable}
\end{center}
\subsection[Vor\_cell]{\hyperref[sec:var_tab_state]{Vor\_cell}}
@@ -742,7 +742,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -752,7 +752,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% Vor\_cell \\
\hline
- \caption{Vor\_cell: {\bf \color{red} MISSING}}
+ \caption{Vor\_cell: curl of horizontal velocity defined at cell centers}
\end{longtable}
\end{center}
\subsection[uReconstructX]{\hyperref[sec:var_tab_state]{uReconstructX}}
@@ -762,7 +762,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -772,7 +772,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uReconstructX \\
\hline
- \caption{uReconstructX: {\bf \color{red} MISSING}}
+ \caption{uReconstructX: component of horizontal velocity in the x-direction (cartesian)}
\end{longtable}
\end{center}
\subsection[uReconstructY]{\hyperref[sec:var_tab_state]{uReconstructY}}
@@ -782,7 +782,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -792,7 +792,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uReconstructY \\
\hline
- \caption{uReconstructY: {\bf \color{red} MISSING}}
+ \caption{uReconstructY: component of horizontal velocity in the y-direction (cartesian)}
\end{longtable}
\end{center}
\subsection[uReconstructZ]{\hyperref[sec:var_tab_state]{uReconstructZ}}
@@ -802,7 +802,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -812,7 +812,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uReconstructZ \\
\hline
- \caption{uReconstructZ: {\bf \color{red} MISSING}}
+ \caption{uReconstructZ: component of horizontal velocity in the z-direction (cartesian)}
\end{longtable}
\end{center}
\subsection[uReconstructZonal]{\hyperref[sec:var_tab_state]{uReconstructZonal}}
@@ -822,7 +822,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -832,7 +832,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uReconstructZonal \\
\hline
- \caption{uReconstructZonal: {\bf \color{red} MISSING}}
+ \caption{uReconstructZonal: component of horizontal velocity in the eastward direction}
\end{longtable}
\end{center}
\subsection[uReconstructMeridional]{\hyperref[sec:var_tab_state]{uReconstructMeridional}}
@@ -842,7 +842,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -852,7 +852,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uReconstructMeridional \\
\hline
- \caption{uReconstructMeridional: {\bf \color{red} MISSING}}
+ \caption{uReconstructMeridional: component of horizontal velocity in the northward}
\end{longtable}
\end{center}
\subsection[uSrcReconstructX]{\hyperref[sec:var_tab_state]{uSrcReconstructX}}
@@ -862,7 +862,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $N$ $m^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -872,7 +872,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uSrcReconstructX \\
\hline
- \caption{uSrcReconstructX: {\bf \color{red} MISSING}}
+ \caption{uSrcReconstructX: wind stress in the x-direction (cartesian)}
\end{longtable}
\end{center}
\subsection[uSrcReconstructY]{\hyperref[sec:var_tab_state]{uSrcReconstructY}}
@@ -882,7 +882,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $N$ $m^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -892,7 +892,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uSrcReconstructY \\
\hline
- \caption{uSrcReconstructY: {\bf \color{red} MISSING}}
+ \caption{uSrcReconstructY: wind stress in the y-direction (cartesian)}
\end{longtable}
\end{center}
\subsection[uSrcReconstructZ]{\hyperref[sec:var_tab_state]{uSrcReconstructZ}}
@@ -902,7 +902,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $N$ $m^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -912,7 +912,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uSrcReconstructZ \\
\hline
- \caption{uSrcReconstructZ: {\bf \color{red} MISSING}}
+ \caption{uSrcReconstructZ: wind stress in the z-direction (cartesian)}
\end{longtable}
\end{center}
\subsection[uSrcReconstructZonal]{\hyperref[sec:var_tab_state]{uSrcReconstructZonal}}
@@ -922,7 +922,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $N$ $m^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -932,7 +932,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uSrcReconstructZonal \\
\hline
- \caption{uSrcReconstructZonal: {\bf \color{red} MISSING}}
+ \caption{uSrcReconstructZonal: wind stress in the eastward direction}
\end{longtable}
\end{center}
\subsection[uSrcReconstructMeridional]{\hyperref[sec:var_tab_state]{uSrcReconstructMeridional}}
@@ -942,7 +942,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $N$ $m^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -952,7 +952,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% uSrcReconstructMeridional \\
\hline
- \caption{uSrcReconstructMeridional: {\bf \color{red} MISSING}}
+ \caption{uSrcReconstructMeridional: wind stress in the northward direction}
\end{longtable}
\end{center}
\subsection[MontPot]{\hyperref[sec:var_tab_state]{MontPot}}
@@ -982,7 +982,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $N$ $m^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -992,7 +992,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% pressure \\
\hline
- \caption{pressure: {\bf \color{red} MISSING}}
+ \caption{pressure: pressure used in the velocity equation}
\end{longtable}
\end{center}
\subsection[wTop]{\hyperref[sec:var_tab_state]{wTop}}
@@ -1022,7 +1022,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevelsP1 nCells Time \\
\hline
@@ -1032,7 +1032,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% vertVelocityTop \\
\hline
- \caption{vertVelocityTop: {\bf \color{red} MISSING}}
+ \caption{vertVelocityTop: vertical velocity defined at center (horizonally) and top (vertically) of cell}
\end{longtable}
\end{center}
\subsection[rhoDisplaced]{\hyperref[sec:var_tab_state]{rhoDisplaced}}
@@ -1062,7 +1062,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-2}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -1072,7 +1072,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% BruntVaisalaFreqTop \\
\hline
- \caption{BruntVaisalaFreqTop: {\bf \color{red} MISSING}}
+ \caption{BruntVaisalaFreqTop: Brunt Vaisala frequency defined at the center (horizontally) and top (vertically) of cell}
\end{longtable}
\end{center}
\subsection[viscosity]{\hyperref[sec:var_tab_state]{viscosity}}
@@ -1082,7 +1082,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -1092,7 +1092,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% viscosity \\
\hline
- \caption{viscosity: {\bf \color{red} MISSING}}
+ \caption{viscosity: horizontal viscosity}
\end{longtable}
\end{center}
\subsection[vh]{\hyperref[sec:var_tab_state]{vh}}
@@ -1102,7 +1102,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -1112,7 +1112,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% vh \\
\hline
- \caption{vh: {\bf \color{red} MISSING}}
+ \caption{vh: thickness flux in the tangent direction (from vertex1 to vertex2)}
\end{longtable}
\end{center}
\subsection[circulation]{\hyperref[sec:var_tab_state]{circulation}}
@@ -1122,7 +1122,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nVertices Time \\
\hline
@@ -1132,7 +1132,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% circulation \\
\hline
- \caption{circulation: {\bf \color{red} MISSING}}
+ \caption{circulation: area-integrated vorticity}
\end{longtable}
\end{center}
\subsection[gradVor\_t]{\hyperref[sec:var_tab_state]{gradVor\_t}}
@@ -1142,7 +1142,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ $m^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -1152,7 +1152,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% gradVor\_t \\
\hline
- \caption{gradVor\_t: {\bf \color{red} MISSING}}
+ \caption{gradVor\_t: gradient of vorticity in the tangent direction (from vertex1 to vertex2)}
\end{longtable}
\end{center}
\subsection[gradVor\_n]{\hyperref[sec:var_tab_state]{gradVor\_n}}
@@ -1162,7 +1162,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ $m^{-1}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -1172,7 +1172,7 @@
\hline
Location in code: & domain \% blocklist \% state \% time\_levs(:) \% state \% gradVor\_n \\
\hline
- \caption{gradVor\_n: {\bf \color{red} MISSING}}
+ \caption{gradVor\_n: gradient of vorticity in the normal direction (from cell1 to cell2)}
\end{longtable}
\end{center}
\subsection[areaCellGlobal]{\hyperref[sec:var_tab_state]{areaCellGlobal}}
@@ -1504,7 +1504,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $radians$ \\
\hline
Dimension: & nCells \\
\hline
@@ -1514,7 +1514,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% latCell \\
\hline
- \caption{latCell: {\bf \color{red} MISSING}}
+ \caption{latCell: Latitude location of cell centers in radians.}
\end{longtable}
\end{center}
\subsection[lonCell]{\hyperref[sec:var_tab_mesh]{lonCell}}
@@ -1524,7 +1524,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $radians$ \\
\hline
Dimension: & nCells \\
\hline
@@ -1534,7 +1534,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% lonCell \\
\hline
- \caption{lonCell: {\bf \color{red} MISSING}}
+ \caption{lonCell: Longitude location of cell centers in radians.}
\end{longtable}
\end{center}
\subsection[xCell]{\hyperref[sec:var_tab_mesh]{xCell}}
@@ -1544,7 +1544,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nCells \\
\hline
@@ -1554,7 +1554,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% xCell \\
\hline
- \caption{xCell: {\bf \color{red} MISSING}}
+ \caption{xCell: X Coordinate in cartesian space of cell centers.}
\end{longtable}
\end{center}
\subsection[yCell]{\hyperref[sec:var_tab_mesh]{yCell}}
@@ -1564,7 +1564,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nCells \\
\hline
@@ -1574,7 +1574,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% yCell \\
\hline
- \caption{yCell: {\bf \color{red} MISSING}}
+ \caption{yCell: Y Coordinate in cartesian space of cell centers.}
\end{longtable}
\end{center}
\subsection[zCell]{\hyperref[sec:var_tab_mesh]{zCell}}
@@ -1584,7 +1584,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nCells \\
\hline
@@ -1594,7 +1594,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% zCell \\
\hline
- \caption{zCell: {\bf \color{red} MISSING}}
+ \caption{zCell: Z Coordinate in cartesian space of cell centers.}
\end{longtable}
\end{center}
\subsection[indexToCellID]{\hyperref[sec:var_tab_mesh]{indexToCellID}}
@@ -1604,7 +1604,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nCells \\
\hline
@@ -1614,7 +1614,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% indexToCellID \\
\hline
- \caption{indexToCellID: {\bf \color{red} MISSING}}
+ \caption{indexToCellID: List of global cell IDs.}
\end{longtable}
\end{center}
\subsection[latEdge]{\hyperref[sec:var_tab_mesh]{latEdge}}
@@ -1624,7 +1624,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $radians$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1634,7 +1634,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% latEdge \\
\hline
- \caption{latEdge: {\bf \color{red} MISSING}}
+ \caption{latEdge: Latitude location of edge midpoints in radians.}
\end{longtable}
\end{center}
\subsection[lonEdge]{\hyperref[sec:var_tab_mesh]{lonEdge}}
@@ -1644,7 +1644,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $radians$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1654,7 +1654,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% lonEdge \\
\hline
- \caption{lonEdge: {\bf \color{red} MISSING}}
+ \caption{lonEdge: Longitude location of edge midpoints in radians.}
\end{longtable}
\end{center}
\subsection[xEdge]{\hyperref[sec:var_tab_mesh]{xEdge}}
@@ -1664,7 +1664,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1674,7 +1674,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% xEdge \\
\hline
- \caption{xEdge: {\bf \color{red} MISSING}}
+ \caption{xEdge: X Coordinate in cartesian space of edge midpoints.}
\end{longtable}
\end{center}
\subsection[yEdge]{\hyperref[sec:var_tab_mesh]{yEdge}}
@@ -1684,7 +1684,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1694,7 +1694,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% yEdge \\
\hline
- \caption{yEdge: {\bf \color{red} MISSING}}
+ \caption{yEdge: Y Coordinate in cartesian space of edge midpoints.}
\end{longtable}
\end{center}
\subsection[zEdge]{\hyperref[sec:var_tab_mesh]{zEdge}}
@@ -1704,7 +1704,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1714,7 +1714,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% zEdge \\
\hline
- \caption{zEdge: {\bf \color{red} MISSING}}
+ \caption{zEdge: Z Coordinate in cartesian space of edge midpoints.}
\end{longtable}
\end{center}
\subsection[indexToEdgeID]{\hyperref[sec:var_tab_mesh]{indexToEdgeID}}
@@ -1724,7 +1724,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1734,7 +1734,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% indexToEdgeID \\
\hline
- \caption{indexToEdgeID: {\bf \color{red} MISSING}}
+ \caption{indexToEdgeID: List of global edge IDs.}
\end{longtable}
\end{center}
\subsection[latVertex]{\hyperref[sec:var_tab_mesh]{latVertex}}
@@ -1744,7 +1744,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $radians$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -1754,7 +1754,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% latVertex \\
\hline
- \caption{latVertex: {\bf \color{red} MISSING}}
+ \caption{latVertex: Latitude location of vertices in radians.}
\end{longtable}
\end{center}
\subsection[lonVertex]{\hyperref[sec:var_tab_mesh]{lonVertex}}
@@ -1764,7 +1764,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $radians$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -1774,7 +1774,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% lonVertex \\
\hline
- \caption{lonVertex: {\bf \color{red} MISSING}}
+ \caption{lonVertex: Longitude location of vertices in radians.}
\end{longtable}
\end{center}
\subsection[xVertex]{\hyperref[sec:var_tab_mesh]{xVertex}}
@@ -1784,7 +1784,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -1794,7 +1794,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% xVertex \\
\hline
- \caption{xVertex: {\bf \color{red} MISSING}}
+ \caption{xVertex: X Coordinate in cartesian space of vertices.}
\end{longtable}
\end{center}
\subsection[yVertex]{\hyperref[sec:var_tab_mesh]{yVertex}}
@@ -1804,7 +1804,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -1814,7 +1814,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% yVertex \\
\hline
- \caption{yVertex: {\bf \color{red} MISSING}}
+ \caption{yVertex: Y Coordinate in cartesian space of vertices.}
\end{longtable}
\end{center}
\subsection[zVertex]{\hyperref[sec:var_tab_mesh]{zVertex}}
@@ -1824,7 +1824,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -1834,7 +1834,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% zVertex \\
\hline
- \caption{zVertex: {\bf \color{red} MISSING}}
+ \caption{zVertex: Z Coordinate in cartesian space of vertices.}
\end{longtable}
\end{center}
\subsection[indexToVertexID]{\hyperref[sec:var_tab_mesh]{indexToVertexID}}
@@ -1844,7 +1844,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -1854,7 +1854,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% indexToVertexID \\
\hline
- \caption{indexToVertexID: {\bf \color{red} MISSING}}
+ \caption{indexToVertexID: List of global vertex IDs.}
\end{longtable}
\end{center}
\subsection[meshDensity]{\hyperref[sec:var_tab_mesh]{meshDensity}}
@@ -1864,7 +1864,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nCells \\
\hline
@@ -1874,7 +1874,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% meshDensity \\
\hline
- \caption{meshDensity: {\bf \color{red} MISSING}}
+ \caption{meshDensity: Value of density function used to generate a particular mesh at cell centers.}
\end{longtable}
\end{center}
\subsection[meshScalingDel2]{\hyperref[sec:var_tab_mesh]{meshScalingDel2}}
@@ -1884,7 +1884,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1904,7 +1904,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1924,7 +1924,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1944,7 +1944,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & TWO nEdges \\
\hline
@@ -1954,7 +1954,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% cellsOnEdge \\
\hline
- \caption{cellsOnEdge: {\bf \color{red} MISSING}}
+ \caption{cellsOnEdge: List of cells that straddle each edge.}
\end{longtable}
\end{center}
\subsection[nEdgesOnCell]{\hyperref[sec:var_tab_mesh]{nEdgesOnCell}}
@@ -1964,7 +1964,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nCells \\
\hline
@@ -1974,7 +1974,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% nEdgesOnCell \\
\hline
- \caption{nEdgesOnCell: {\bf \color{red} MISSING}}
+ \caption{nEdgesOnCell: Number of edges that border each cell.}
\end{longtable}
\end{center}
\subsection[nEdgesOnEdge]{\hyperref[sec:var_tab_mesh]{nEdgesOnEdge}}
@@ -1984,7 +1984,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -1994,7 +1994,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% nEdgesOnEdge \\
\hline
- \caption{nEdgesOnEdge: {\bf \color{red} MISSING}}
+ \caption{nEdgesOnEdge: Number of edges that surround each of the cells that straddle each edge. These edges are used to reconstruct the tangential velocities.}
\end{longtable}
\end{center}
\subsection[edgesOnCell]{\hyperref[sec:var_tab_mesh]{edgesOnCell}}
@@ -2004,7 +2004,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & maxEdges nCells \\
\hline
@@ -2014,7 +2014,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% edgesOnCell \\
\hline
- \caption{edgesOnCell: {\bf \color{red} MISSING}}
+ \caption{edgesOnCell: List of edges that border each cell.}
\end{longtable}
\end{center}
\subsection[edgesOnEdge]{\hyperref[sec:var_tab_mesh]{edgesOnEdge}}
@@ -2024,7 +2024,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & maxEdges2 nEdges \\
\hline
@@ -2034,7 +2034,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% edgesOnEdge \\
\hline
- \caption{edgesOnEdge: {\bf \color{red} MISSING}}
+ \caption{edgesOnEdge: List of edges that border each of the cells that straddle each edge.}
\end{longtable}
\end{center}
\subsection[weightsOnEdge]{\hyperref[sec:var_tab_mesh]{weightsOnEdge}}
@@ -2044,7 +2044,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & maxEdges2 nEdges \\
\hline
@@ -2054,7 +2054,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% weightsOnEdge \\
\hline
- \caption{weightsOnEdge: {\bf \color{red} MISSING}}
+ \caption{weightsOnEdge: Reconstruction weights associated with each of the edgesOnEdge.}
\end{longtable}
\end{center}
\subsection[dvEdge]{\hyperref[sec:var_tab_mesh]{dvEdge}}
@@ -2064,7 +2064,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -2074,7 +2074,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% dvEdge \\
\hline
- \caption{dvEdge: {\bf \color{red} MISSING}}
+ \caption{dvEdge: Length of each edge, computed as the distance between verticesOnEdge.}
\end{longtable}
\end{center}
\subsection[dcEdge]{\hyperref[sec:var_tab_mesh]{dcEdge}}
@@ -2084,7 +2084,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -2094,7 +2094,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% dcEdge \\
\hline
- \caption{dcEdge: {\bf \color{red} MISSING}}
+ \caption{dcEdge: Length of each edge, computed as the distance between cellsOnEdge.}
\end{longtable}
\end{center}
\subsection[angleEdge]{\hyperref[sec:var_tab_mesh]{angleEdge}}
@@ -2104,7 +2104,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $radians$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -2114,7 +2114,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% angleEdge \\
\hline
- \caption{angleEdge: {\bf \color{red} MISSING}}
+ \caption{angleEdge: Angle the edge normal makes with local eastward direction.}
\end{longtable}
\end{center}
\subsection[areaCell]{\hyperref[sec:var_tab_mesh]{areaCell}}
@@ -2124,7 +2124,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ \\
\hline
Dimension: & nCells \\
\hline
@@ -2134,7 +2134,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% areaCell \\
\hline
- \caption{areaCell: {\bf \color{red} MISSING}}
+ \caption{areaCell: Area of each cell in the primary grid.}
\end{longtable}
\end{center}
\subsection[areaTriangle]{\hyperref[sec:var_tab_mesh]{areaTriangle}}
@@ -2144,7 +2144,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -2154,7 +2154,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% areaTriangle \\
\hline
- \caption{areaTriangle: {\bf \color{red} MISSING}}
+ \caption{areaTriangle: Area of each cell (triangle) in the dual grid.}
\end{longtable}
\end{center}
\subsection[edgeNormalVectors]{\hyperref[sec:var_tab_mesh]{edgeNormalVectors}}
@@ -2164,7 +2164,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & R3 nEdges \\
\hline
@@ -2174,7 +2174,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% edgeNormalVectors \\
\hline
- \caption{edgeNormalVectors: {\bf \color{red} MISSING}}
+ \caption{edgeNormalVectors: Normal vector defined at an edge.}
\end{longtable}
\end{center}
\subsection[localVerticalUnitVectors]{\hyperref[sec:var_tab_mesh]{localVerticalUnitVectors}}
@@ -2184,7 +2184,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & R3 nCells \\
\hline
@@ -2194,7 +2194,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% localVerticalUnitVectors \\
\hline
- \caption{localVerticalUnitVectors: {\bf \color{red} MISSING}}
+ \caption{localVerticalUnitVectors: Unit surface normal vectors defined at cell centers.}
\end{longtable}
\end{center}
\subsection[cellTangentPlane]{\hyperref[sec:var_tab_mesh]{cellTangentPlane}}
@@ -2204,7 +2204,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & R3 TWO nCells \\
\hline
@@ -2214,7 +2214,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% cellTangentPlane \\
\hline
- \caption{cellTangentPlane: {\bf \color{red} MISSING}}
+ \caption{cellTangentPlane: The two vectors that define a tangent plane at a cell center.}
\end{longtable}
\end{center}
\subsection[cellsOnCell]{\hyperref[sec:var_tab_mesh]{cellsOnCell}}
@@ -2224,7 +2224,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & maxEdges nCells \\
\hline
@@ -2234,7 +2234,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% cellsOnCell \\
\hline
- \caption{cellsOnCell: {\bf \color{red} MISSING}}
+ \caption{cellsOnCell: List of cells that neighbor each cell.}
\end{longtable}
\end{center}
\subsection[verticesOnCell]{\hyperref[sec:var_tab_mesh]{verticesOnCell}}
@@ -2244,7 +2244,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & maxEdges nCells \\
\hline
@@ -2254,7 +2254,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% verticesOnCell \\
\hline
- \caption{verticesOnCell: {\bf \color{red} MISSING}}
+ \caption{verticesOnCell: List of vertices that border each cell.}
\end{longtable}
\end{center}
\subsection[verticesOnEdge]{\hyperref[sec:var_tab_mesh]{verticesOnEdge}}
@@ -2264,7 +2264,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & TWO nEdges \\
\hline
@@ -2274,7 +2274,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% verticesOnEdge \\
\hline
- \caption{verticesOnEdge: {\bf \color{red} MISSING}}
+ \caption{verticesOnEdge: List of vertices that straddle each edge.}
\end{longtable}
\end{center}
\subsection[edgesOnVertex]{\hyperref[sec:var_tab_mesh]{edgesOnVertex}}
@@ -2284,7 +2284,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & vertexDegree nVertices \\
\hline
@@ -2294,7 +2294,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% edgesOnVertex \\
\hline
- \caption{edgesOnVertex: {\bf \color{red} MISSING}}
+ \caption{edgesOnVertex: List of edges that share a vertex as an endpoint.}
\end{longtable}
\end{center}
\subsection[cellsOnVertex]{\hyperref[sec:var_tab_mesh]{cellsOnVertex}}
@@ -2304,7 +2304,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & vertexDegree nVertices \\
\hline
@@ -2314,7 +2314,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% cellsOnVertex \\
\hline
- \caption{cellsOnVertex: {\bf \color{red} MISSING}}
+ \caption{cellsOnVertex: List of cells that share a vertex.}
\end{longtable}
\end{center}
\subsection[kiteAreasOnVertex]{\hyperref[sec:var_tab_mesh]{kiteAreasOnVertex}}
@@ -2324,7 +2324,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ \\
\hline
Dimension: & vertexDegree nVertices \\
\hline
@@ -2334,7 +2334,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% kiteAreasOnVertex \\
\hline
- \caption{kiteAreasOnVertex: {\bf \color{red} MISSING}}
+ \caption{kiteAreasOnVertex: Area of the portions of each dual cell that are part of each cellsOnVertex.}
\end{longtable}
\end{center}
\subsection[fEdge]{\hyperref[sec:var_tab_mesh]{fEdge}}
@@ -2344,7 +2344,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -2354,7 +2354,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% fEdge \\
\hline
- \caption{fEdge: {\bf \color{red} MISSING}}
+ \caption{fEdge: Coriolis parameter at edges.}
\end{longtable}
\end{center}
\subsection[fVertex]{\hyperref[sec:var_tab_mesh]{fVertex}}
@@ -2364,7 +2364,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $s^{-1}$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -2374,7 +2374,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% fVertex \\
\hline
- \caption{fVertex: {\bf \color{red} MISSING}}
+ \caption{fVertex: Coriolis parameter at vertices.}
\end{longtable}
\end{center}
\subsection[bottomDepth]{\hyperref[sec:var_tab_mesh]{bottomDepth}}
@@ -2384,7 +2384,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nCells \\
\hline
@@ -2394,7 +2394,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% bottomDepth \\
\hline
- \caption{bottomDepth: {\bf \color{red} MISSING}}
+ \caption{bottomDepth: Depth of the bottom of the ocean. Given as a positive distance from sea level.}
\end{longtable}
\end{center}
\subsection[deriv\_two]{\hyperref[sec:var_tab_mesh]{deriv\_two}}
@@ -2414,7 +2414,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% deriv\_two \\
\hline
- \caption{deriv\_two: {\bf \color{red} MISSING}}
+ \caption{deriv\_two: Value of the second derivative of the polynomial used for reconstruction of cell center quantities at edges.}
\end{longtable}
\end{center}
\subsection[adv\_coefs]{\hyperref[sec:var_tab_mesh]{adv\_coefs}}
@@ -2434,7 +2434,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% adv\_coefs \\
\hline
- \caption{adv\_coefs: {\bf \color{red} MISSING}}
+ \caption{adv\_coefs: Weighting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines.}
\end{longtable}
\end{center}
\subsection[adv\_coefs\_2nd]{\hyperref[sec:var_tab_mesh]{adv\_coefs\_2nd}}
@@ -2454,7 +2454,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% adv\_coefs\_2nd \\
\hline
- \caption{adv\_coefs\_2nd: {\bf \color{red} MISSING}}
+ \caption{adv\_coefs\_2nd: Weighting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines.}
\end{longtable}
\end{center}
\subsection[adv\_coefs\_3rd]{\hyperref[sec:var_tab_mesh]{adv\_coefs\_3rd}}
@@ -2474,7 +2474,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% adv\_coefs\_3rd \\
\hline
- \caption{adv\_coefs\_3rd: {\bf \color{red} MISSING}}
+ \caption{adv\_coefs\_3rd: Wegihting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines.}
\end{longtable}
\end{center}
\subsection[advCellsForEdge]{\hyperref[sec:var_tab_mesh]{advCellsForEdge}}
@@ -2484,7 +2484,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nAdvectionCells nEdges \\
\hline
@@ -2494,7 +2494,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% advCellsForEdge \\
\hline
- \caption{advCellsForEdge: {\bf \color{red} MISSING}}
+ \caption{advCellsForEdge: List of cells used to reconstruct a cell quantity at an edge. Used in advection routines.}
\end{longtable}
\end{center}
\subsection[nAdvCellsForEdge]{\hyperref[sec:var_tab_mesh]{nAdvCellsForEdge}}
@@ -2504,7 +2504,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -2514,7 +2514,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% nAdvCellsForEdge \\
\hline
- \caption{nAdvCellsForEdge: {\bf \color{red} MISSING}}
+ \caption{nAdvCellsForEdge: Number of cells used in reconstruction of cell center quantities at an edge. Used in advection routines.}
\end{longtable}
\end{center}
\subsection[highOrderAdvectionMask]{\hyperref[sec:var_tab_mesh]{highOrderAdvectionMask}}
@@ -2524,7 +2524,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nEdges \\
\hline
@@ -2534,7 +2534,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% highOrderAdvectionMask \\
\hline
- \caption{highOrderAdvectionMask: {\bf \color{red} MISSING}}
+ \caption{highOrderAdvectionMask: Mask for high order advection. Values are 1 if high order is used, and 0 if not.}
\end{longtable}
\end{center}
\subsection[lowOrderAdvectionMask]{\hyperref[sec:var_tab_mesh]{lowOrderAdvectionMask}}
@@ -2544,7 +2544,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nEdges \\
\hline
@@ -2554,7 +2554,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% lowOrderAdvectionMask \\
\hline
- \caption{lowOrderAdvectionMask: {\bf \color{red} MISSING}}
+ \caption{lowOrderAdvectionMask: Mask for low order advection. Values are 1 if low order is used, and 0 if not.}
\end{longtable}
\end{center}
\subsection[defc\_a]{\hyperref[sec:var_tab_mesh]{defc\_a}}
@@ -2574,7 +2574,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% defc\_a \\
\hline
- \caption{defc\_a: {\bf \color{red} MISSING}}
+ \caption{defc\_a: Variable used with advection setup to compute advection coefficients. Deformation weight coefficients.}
\end{longtable}
\end{center}
\subsection[defc\_b]{\hyperref[sec:var_tab_mesh]{defc\_b}}
@@ -2594,7 +2594,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% defc\_b \\
\hline
- \caption{defc\_b: {\bf \color{red} MISSING}}
+ \caption{defc\_b: Variable used with advection setup to compute advection coefficients. Deformation weight coefficients.}
\end{longtable}
\end{center}
\subsection[kdiff]{\hyperref[sec:var_tab_mesh]{kdiff}}
@@ -2614,7 +2614,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% kdiff \\
\hline
- \caption{kdiff: {\bf \color{red} MISSING}}
+ \caption{kdiff: {\color{red} TO BE REMOVED}}
\end{longtable}
\end{center}
\subsection[coeffs\_reconstruct]{\hyperref[sec:var_tab_mesh]{coeffs\_reconstruct}}
@@ -2634,7 +2634,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% coeffs\_reconstruct \\
\hline
- \caption{coeffs\_reconstruct: {\bf \color{red} MISSING}}
+ \caption{coeffs\_reconstruct: {\color{red} TO BE REMOVED}}
\end{longtable}
\end{center}
\subsection[maxLevelCell]{\hyperref[sec:var_tab_mesh]{maxLevelCell}}
@@ -2644,7 +2644,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nCells \\
\hline
@@ -2654,7 +2654,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% maxLevelCell \\
\hline
- \caption{maxLevelCell: {\bf \color{red} MISSING}}
+ \caption{maxLevelCell: Index to the last active ocean cell in each column.}
\end{longtable}
\end{center}
\subsection[maxLevelEdgeTop]{\hyperref[sec:var_tab_mesh]{maxLevelEdgeTop}}
@@ -2664,7 +2664,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -2674,7 +2674,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% maxLevelEdgeTop \\
\hline
- \caption{maxLevelEdgeTop: {\bf \color{red} MISSING}}
+ \caption{maxLevelEdgeTop: Index to the last edge in a column with active ocean cells on both sides of it.}
\end{longtable}
\end{center}
\subsection[maxLevelEdgeBot]{\hyperref[sec:var_tab_mesh]{maxLevelEdgeBot}}
@@ -2684,7 +2684,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nEdges \\
\hline
@@ -2694,7 +2694,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% maxLevelEdgeBot \\
\hline
- \caption{maxLevelEdgeBot: {\bf \color{red} MISSING}}
+ \caption{maxLevelEdgeBot: Index to the last edge in a column with at least one active ocean cell on either side of it.}
\end{longtable}
\end{center}
\subsection[maxLevelVertexTop]{\hyperref[sec:var_tab_mesh]{maxLevelVertexTop}}
@@ -2704,7 +2704,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -2714,7 +2714,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% maxLevelVertexTop \\
\hline
- \caption{maxLevelVertexTop: {\bf \color{red} MISSING}}
+ \caption{maxLevelVertexTop: Index to the last vertex in a column with all active cells around it.}
\end{longtable}
\end{center}
\subsection[maxLevelVertexBot]{\hyperref[sec:var_tab_mesh]{maxLevelVertexBot}}
@@ -2724,7 +2724,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertices \\
\hline
@@ -2734,7 +2734,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% maxLevelVertexBot \\
\hline
- \caption{maxLevelVertexBot: {\bf \color{red} MISSING}}
+ \caption{maxLevelVertexBot: Index to the last vertex in a column with at least one active ocean cell around it.}
\end{longtable}
\end{center}
\subsection[refBottomDepth]{\hyperref[sec:var_tab_mesh]{refBottomDepth}}
@@ -2744,7 +2744,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nVertLevels \\
\hline
@@ -2754,7 +2754,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% refBottomDepth \\
\hline
- \caption{refBottomDepth: {\bf \color{red} MISSING}}
+ \caption{refBottomDepth: Reference depth of ocean for each vertical level. Used in 'z-level' type runs.}
\end{longtable}
\end{center}
\subsection[refBottomDepthTopOfCell]{\hyperref[sec:var_tab_mesh]{refBottomDepthTopOfCell}}
@@ -2764,7 +2764,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nVertLevelsP1 \\
\hline
@@ -2774,7 +2774,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% refBottomDepthTopOfCell \\
\hline
- \caption{refBottomDepthTopOfCell: {\bf \color{red} MISSING}}
+ \caption{refBottomDepthTopOfCell: Reference depth of ocean for each vertical interface. Used in 'z-level' type runs.}
\end{longtable}
\end{center}
\subsection[hZLevel]{\hyperref[sec:var_tab_mesh]{hZLevel}}
@@ -2784,7 +2784,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ \\
\hline
Dimension: & nVertLevels \\
\hline
@@ -2794,7 +2794,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% hZLevel \\
\hline
- \caption{hZLevel: {\bf \color{red} MISSING}}
+ \caption{hZLevel: {\color{red} TO BE REMOVED}}
\end{longtable}
\end{center}
\subsection[vertCoordMovementWeights]{\hyperref[sec:var_tab_mesh]{vertCoordMovementWeights}}
@@ -2804,7 +2804,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels \\
\hline
@@ -2814,7 +2814,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% vertCoordMovementWeights \\
\hline
- \caption{vertCoordMovementWeights: {\bf \color{red} MISSING}}
+ \caption{vertCoordMovementWeights: Weights used for distribution of sea surface heigh purturbations through multiple vertical levels.}
\end{longtable}
\end{center}
\subsection[boundaryEdge]{\hyperref[sec:var_tab_mesh]{boundaryEdge}}
@@ -2824,7 +2824,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nEdges \\
\hline
@@ -2834,7 +2834,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% boundaryEdge \\
\hline
- \caption{boundaryEdge: {\bf \color{red} MISSING}}
+ \caption{boundaryEdge: Mask for determining boundary edges. A boundary edge has only one active ocean cell neighboring it.}
\end{longtable}
\end{center}
\subsection[boundaryVertex]{\hyperref[sec:var_tab_mesh]{boundaryVertex}}
@@ -2844,7 +2844,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nVertices \\
\hline
@@ -2854,7 +2854,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% boundaryVertex \\
\hline
- \caption{boundaryVertex: {\bf \color{red} MISSING}}
+ \caption{boundaryVertex: Mask for determining boundary vertices. A boundary vertex has at least one inactive cell neighboring it.}
\end{longtable}
\end{center}
\subsection[boundaryCell]{\hyperref[sec:var_tab_mesh]{boundaryCell}}
@@ -2864,7 +2864,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nCells \\
\hline
@@ -2874,7 +2874,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% boundaryCell \\
\hline
- \caption{boundaryCell: {\bf \color{red} MISSING}}
+ \caption{boundaryCell: Mask for determining boundary cells. A boundary cell has at least one inactive cell neighboring it.}
\end{longtable}
\end{center}
\subsection[edgeMask]{\hyperref[sec:var_tab_mesh]{edgeMask}}
@@ -2884,7 +2884,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nEdges \\
\hline
@@ -2894,7 +2894,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% edgeMask \\
\hline
- \caption{edgeMask: {\bf \color{red} MISSING}}
+ \caption{edgeMask: Mask on edges that determines if computations should be done on edge.}
\end{longtable}
\end{center}
\subsection[vertexMask]{\hyperref[sec:var_tab_mesh]{vertexMask}}
@@ -2904,7 +2904,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nVertices \\
\hline
@@ -2914,7 +2914,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% vertexMask \\
\hline
- \caption{vertexMask: {\bf \color{red} MISSING}}
+ \caption{vertexMask: Mask on vertices that determines if computations should be done on vertice.}
\end{longtable}
\end{center}
\subsection[cellMask]{\hyperref[sec:var_tab_mesh]{cellMask}}
@@ -2924,7 +2924,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & nVertLevels nCells \\
\hline
@@ -2934,7 +2934,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% cellMask \\
\hline
- \caption{cellMask: {\bf \color{red} MISSING}}
+ \caption{cellMask: Mask on cells that determines if computations should be done on cell.}
\end{longtable}
\end{center}
\subsection[u\_src]{\hyperref[sec:var_tab_mesh]{u\_src}}
@@ -2944,7 +2944,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $N$ $m^{-2}$ \\
\hline
Dimension: & nVertLevels nEdges \\
\hline
@@ -2954,7 +2954,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% u\_src \\
\hline
- \caption{u\_src: {\bf \color{red} MISSING}}
+ \caption{u\_src: Velocity forcing field. Defines a forcing at an edge.}
\end{longtable}
\end{center}
\subsection[temperatureRestore]{\hyperref[sec:var_tab_mesh]{temperatureRestore}}
@@ -2964,7 +2964,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $^\circ$ $C$ \\
\hline
Dimension: & nCells \\
\hline
@@ -2974,7 +2974,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% temperatureRestore \\
\hline
- \caption{temperatureRestore: {\bf \color{red} MISSING}}
+ \caption{temperatureRestore: Temperature restoring field, for restoring temperature at the surface.}
\end{longtable}
\end{center}
\subsection[salinityRestore]{\hyperref[sec:var_tab_mesh]{salinityRestore}}
@@ -2984,7 +2984,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $PSU$ \\
\hline
Dimension: & nCells \\
\hline
@@ -2994,7 +2994,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% salinityRestore \\
\hline
- \caption{salinityRestore: {\bf \color{red} MISSING}}
+ \caption{salinityRestore: Salinity restoring field, for restoring salinity at the surface.}
\end{longtable}
\end{center}
\subsection[windStressMonthly]{\hyperref[sec:var_tab_mesh]{windStressMonthly}}
@@ -3004,7 +3004,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $N$ $m^{-2}$ \\
\hline
Dimension: & nMonths nEdges \\
\hline
@@ -3014,7 +3014,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% windStressMonthly \\
\hline
- \caption{windStressMonthly: {\bf \color{red} MISSING}}
+ \caption{windStressMonthly: Monthly wind stress field, defined at the surface for use in monthly forcing.}
\end{longtable}
\end{center}
\subsection[temperatureRestoreMonthly]{\hyperref[sec:var_tab_mesh]{temperatureRestoreMonthly}}
@@ -3024,7 +3024,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $^\circ$ $C$ \\
\hline
Dimension: & nMonths nCells \\
\hline
@@ -3034,7 +3034,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% temperatureRestoreMonthly \\
\hline
- \caption{temperatureRestoreMonthly: {\bf \color{red} MISSING}}
+ \caption{temperatureRestoreMonthly: Monthly temperature restorying field, defined at the surface for use in monthly forcing.}
\end{longtable}
\end{center}
\subsection[salinityRestoreMonthly]{\hyperref[sec:var_tab_mesh]{salinityRestoreMonthly}}
@@ -3044,7 +3044,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $PSU$ \\
\hline
Dimension: & nMonths nCells \\
\hline
@@ -3054,7 +3054,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% salinityRestoreMonthly \\
\hline
- \caption{salinityRestoreMonthly: {\bf \color{red} MISSING}}
+ \caption{salinityRestoreMonthly: Monthly salinity resotring field, defined at the surface, for use in monthly forcing.}
\end{longtable}
\end{center}
\subsection[edgeSignOnCell]{\hyperref[sec:var_tab_mesh]{edgeSignOnCell}}
@@ -3064,7 +3064,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & maxEdges nCells \\
\hline
@@ -3074,7 +3074,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% edgeSignOnCell \\
\hline
- \caption{edgeSignOnCell: {\bf \color{red} MISSING}}
+ \caption{edgeSignOnCell: Sign of edge contributions to a cell for each edge on cell. Used for bit-reproducible loops. Represents directionality of vector connecting cells.}
\end{longtable}
\end{center}
\subsection[edgeSignOnVertex]{\hyperref[sec:var_tab_mesh]{edgeSignOnVertex}}
@@ -3084,7 +3084,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & maxEdges nVertices \\
\hline
@@ -3094,7 +3094,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% edgeSignOnVertex \\
\hline
- \caption{edgeSignOnVertex: {\bf \color{red} MISSING}}
+ \caption{edgeSignOnVertex: Sign of edge contributions to a vertex for each edge on vertex. Used for bit-reproducible loops. Represents directionality of vector connecting vertices.}
\end{longtable}
\end{center}
\subsection[kiteIndexOnCell]{\hyperref[sec:var_tab_mesh]{kiteIndexOnCell}}
@@ -3104,7 +3104,7 @@
\hline
Type: & integer \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $unitless$ \\
\hline
Dimension: & maxEdges nCells \\
\hline
@@ -3114,7 +3114,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% kiteIndexOnCell \\
\hline
- \caption{kiteIndexOnCell: {\bf \color{red} MISSING}}
+ \caption{kiteIndexOnCell: Index of kite in dual grid, based on verticesOnCell.}
\end{longtable}
\end{center}
\subsection[seaSurfacePressure]{\hyperref[sec:var_tab_mesh]{seaSurfacePressure}}
@@ -3124,7 +3124,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $Pa$ \\
\hline
Dimension: & nCells Time \\
\hline
@@ -3134,7 +3134,7 @@
\hline
Location in code: & domain \% blocklist \% mesh \% seaSurfacePressure \\
\hline
- \caption{seaSurfacePressure: {\bf \color{red} MISSING}}
+ \caption{seaSurfacePressure: Pressure defined at the sea surface.}
\end{longtable}
\end{center}
\section[tend]{\hyperref[sec:var_tab_tend]{tend}}
@@ -3146,7 +3146,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $K$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -3160,7 +3160,7 @@
\hline
Array Group: & dynamics \\
\hline
- \caption{tend\_temperature: {\bf \color{red} MISSING}}
+ \caption{tend\_temperature: time tendency of potential temperature}
\end{longtable}
\end{center}
\subsection[tend\_salinity]{\hyperref[sec:var_tab_tend]{tend\_salinity}}
@@ -3170,7 +3170,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $PSU$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -3184,7 +3184,7 @@
\hline
Array Group: & dynamics \\
\hline
- \caption{tend\_salinity: {\bf \color{red} MISSING}}
+ \caption{tend\_salinity: time tendency of salinity measured as change in practical salinity units per second}
\end{longtable}
\end{center}
\subsection[tend\_tracer1]{\hyperref[sec:var_tab_tend]{tend\_tracer1}}
@@ -3194,7 +3194,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $tracer$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -3208,7 +3208,7 @@
\hline
Array Group: & testing \\
\hline
- \caption{tend\_tracer1: {\bf \color{red} MISSING}}
+ \caption{tend\_tracer1: time tendency of an arbitary tracer}
\end{longtable}
\end{center}
\subsection[tend\_u]{\hyperref[sec:var_tab_tend]{tend\_u}}
@@ -3218,7 +3218,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-2}$ \\
\hline
Dimension: & nVertLevels nEdges Time \\
\hline
@@ -3228,7 +3228,7 @@
\hline
Location in code: & domain \% blocklist \% tend \% u \\
\hline
- \caption{tend\_u: {\bf \color{red} MISSING}}
+ \caption{tend\_u: time tendency of normal component of velocity}
\end{longtable}
\end{center}
\subsection[tend\_h]{\hyperref[sec:var_tab_tend]{tend\_h}}
@@ -3238,7 +3238,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nVertLevels nCells Time \\
\hline
@@ -3248,7 +3248,7 @@
\hline
Location in code: & domain \% blocklist \% tend \% h \\
\hline
- \caption{tend\_h: {\bf \color{red} MISSING}}
+ \caption{tend\_h: time tendency of layer thickness}
\end{longtable}
\end{center}
\subsection[tend\_ssh]{\hyperref[sec:var_tab_tend]{tend\_ssh}}
@@ -3258,7 +3258,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m$ $s^{-1}$ \\
\hline
Dimension: & nCells Time \\
\hline
@@ -3268,7 +3268,7 @@
\hline
Location in code: & domain \% blocklist \% tend \% ssh \\
\hline
- \caption{tend\_ssh: {\bf \color{red} MISSING}}
+ \caption{tend\_ssh: time tendency of sea-surface height}
\end{longtable}
\end{center}
\section[diagnostics]{\hyperref[sec:var_tab_diagnostics]{diagnostics}}
@@ -3280,7 +3280,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $nondimensional$ \\
\hline
Dimension: & nVertLevelsP1 nCells Time \\
\hline
@@ -3290,7 +3290,7 @@
\hline
Location in code: & domain \% blocklist \% diagnostics \% RiTopOfCell \\
\hline
- \caption{RiTopOfCell: {\bf \color{red} MISSING}}
+ \caption{RiTopOfCell: gradient Richardson number defined at the center (horizontally) and top (vertically)}
\end{longtable}
\end{center}
\subsection[RiTopOfEdge]{\hyperref[sec:var_tab_diagnostics]{RiTopOfEdge}}
@@ -3300,7 +3300,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $nondimensional$ \\
\hline
Dimension: & nVertLevelsP1 nEdges Time \\
\hline
@@ -3310,7 +3310,7 @@
\hline
Location in code: & domain \% blocklist \% diagnostics \% RiTopOfEdge \\
\hline
- \caption{RiTopOfEdge: {\bf \color{red} MISSING}}
+ \caption{RiTopOfEdge: gradient Richardson number defined at the edge (horizontally) and top (vertically)}
\end{longtable}
\end{center}
\subsection[vertViscTopOfEdge]{\hyperref[sec:var_tab_diagnostics]{vertViscTopOfEdge}}
@@ -3320,7 +3320,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-1}$ \\
\hline
Dimension: & nVertLevelsP1 nEdges Time \\
\hline
@@ -3330,7 +3330,7 @@
\hline
Location in code: & domain \% blocklist \% diagnostics \% vertViscTopOfEdge \\
\hline
- \caption{vertViscTopOfEdge: {\bf \color{red} MISSING}}
+ \caption{vertViscTopOfEdge: vertical viscosity defined at the edge (horizontally) and top (vertically)}
\end{longtable}
\end{center}
\subsection[vertDiffTopOfCell]{\hyperref[sec:var_tab_diagnostics]{vertDiffTopOfCell}}
@@ -3340,7 +3340,7 @@
\hline
Type: & real \\
\hline
- Units: & {\bf \color{red} MISSING} \\
+ Units: & $m^2$ $s^{-1}$ \\
\hline
Dimension: & nVertLevelsP1 nCells Time \\
\hline
@@ -3350,6 +3350,6 @@
\hline
Location in code: & domain \% blocklist \% diagnostics \% vertDiffTopOfCell \\
\hline
- \caption{vertDiffTopOfCell: {\bf \color{red} MISSING}}
+ \caption{vertDiffTopOfCell: vertical diffusion defined at the edge (horizontally) and top (vertically)}
\end{longtable}
\end{center}
Modified: trunk/documents/users_guide/ocean/variable_table_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocean/variable_table_documentation.tex 2013-03-21 15:05:34 UTC (rev 2640)
+++ trunk/documents/users_guide/ocean/variable_table_documentation.tex 2013-03-21 15:11:11 UTC (rev 2641)
@@ -10,45 +10,45 @@
\hline
{\bf Name} & {\bf Description} \\
\hline
- \hyperref[subsec:var_sec_state_temperature]{temperature} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_temperature]{temperature} & potential temperature \\
\hline
- \hyperref[subsec:var_sec_state_salinity]{salinity} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_salinity]{salinity} & salinity \\
\hline
- \hyperref[subsec:var_sec_state_tracer1]{tracer1} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_tracer1]{tracer1} & A tracer with value 1.0 to test conservation. {\color{red} REMOVE THIS VARIABLE} \\
\hline
- \hyperref[subsec:var_sec_state_temperature]{temperature} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_temperature]{temperature} & potential temperature \\
\hline
- \hyperref[subsec:var_sec_state_salinity]{salinity} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_salinity]{salinity} & salinity \\
\hline
- \hyperref[subsec:var_sec_state_tracer1]{tracer1} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_tracer1]{tracer1} & A tracer with value 1.0 to test conservation. {\color{red} REMOVE THIS VARIABLE} \\
\hline
- \hyperref[subsec:var_sec_state_xtime]{xtime} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_xtime]{xtime} & model time, with format 'YYYY-MM-DD\_HH:MM:SS' \\
\hline
- \hyperref[subsec:var_sec_state_u]{u} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_u]{u} & horizonal velocity, normal component to an edge \\
\hline
- \hyperref[subsec:var_sec_state_h]{h} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_h]{h} & layer thickness \\
\hline
- \hyperref[subsec:var_sec_state_rho]{rho} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_rho]{rho} & density \\
\hline
- \hyperref[subsec:var_sec_state_uBtr]{uBtr} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uBtr]{uBtr} & barotropic velocity, used in split-explicit time-stepping \\
\hline
- \hyperref[subsec:var_sec_state_ssh]{ssh} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_ssh]{ssh} & sea surface height \\
\hline
- \hyperref[subsec:var_sec_state_uBtrSubcycle]{uBtrSubcycle} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uBtrSubcycle]{uBtrSubcycle} & barotropic velocity, used in subcycling in stage 2 of split-explicit time-stepping \\
\hline
- \hyperref[subsec:var_sec_state_sshSubcycle]{sshSubcycle} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_sshSubcycle]{sshSubcycle} & sea surface height, used in subcycling in stage 2 of split-explicit time-stepping \\
\hline
- \hyperref[subsec:var_sec_state_FBtr]{FBtr} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_FBtr]{FBtr} & Barotropic thickness flux at each edge, used to advance sea surface height in each subcycle of stage 2 of the split-explicit algorithm. \\
\hline
- \hyperref[subsec:var_sec_state_GBtrForcing]{GBtrForcing} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_GBtrForcing]{GBtrForcing} & Barotropic tendency computed from the baroclinic equations in stage 1 of the split-explicit algorithm. \\
\hline
- \hyperref[subsec:var_sec_state_uBcl]{uBcl} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uBcl]{uBcl} & baroclinic velocity, used in split-explicit time-stepping \\
\hline
- \hyperref[subsec:var_sec_state_zMid]{zMid} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_zMid]{zMid} & z-coordinate of the mid-depth of the layer \\
\hline
- \hyperref[subsec:var_sec_state_v]{v} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_v]{v} & horizontal velocity, tangential to an edge \\
\hline
- \hyperref[subsec:var_sec_state_uTransport]{uTransport} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uTransport]{uTransport} & horizontal velocity used to transport mass and tracers \\
\hline
\hyperref[subsec:var_sec_state_uBolusGM]{uBolusGM} & {\bf \color{red} MISSING} \\
\hline
@@ -68,69 +68,69 @@
\hline
\hyperref[subsec:var_sec_state_h_kappa_q]{h\_kappa\_q} & {\bf \color{red} MISSING} \\
\hline
- \hyperref[subsec:var_sec_state_divergence]{divergence} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_divergence]{divergence} & divergence of horizonal velocity \\
\hline
- \hyperref[subsec:var_sec_state_vorticity]{vorticity} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_vorticity]{vorticity} & curl of horizontal velocity \\
\hline
- \hyperref[subsec:var_sec_state_Vor_edge]{Vor\_edge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_Vor_edge]{Vor\_edge} & vorticity averaged from vertices to edges \\
\hline
- \hyperref[subsec:var_sec_state_h_edge]{h\_edge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_h_edge]{h\_edge} & layer thickness averaged from cell center to edges \\
\hline
- \hyperref[subsec:var_sec_state_h_vertex]{h\_vertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_h_vertex]{h\_vertex} & layer thickness averaged from cell center to vertices \\
\hline
- \hyperref[subsec:var_sec_state_ke]{ke} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_ke]{ke} & kinetic energy of horizonal velocity \\
\hline
- \hyperref[subsec:var_sec_state_kev]{kev} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_kev]{kev} & kinetic energy of horizonal velocity defined at vertices \\
\hline
- \hyperref[subsec:var_sec_state_kevc]{kevc} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_kevc]{kevc} & kinetic energy of horizonal velocity defined at vertices \\
\hline
- \hyperref[subsec:var_sec_state_ke_edge]{ke\_edge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_ke_edge]{ke\_edge} & kinetic energy of horizonal velocity defined at edges \\
\hline
- \hyperref[subsec:var_sec_state_Vor_vertex]{Vor\_vertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_Vor_vertex]{Vor\_vertex} & curl of horizontal velocity defined at vertices \\
\hline
- \hyperref[subsec:var_sec_state_Vor_cell]{Vor\_cell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_Vor_cell]{Vor\_cell} & curl of horizontal velocity defined at cell centers \\
\hline
- \hyperref[subsec:var_sec_state_uReconstructX]{uReconstructX} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uReconstructX]{uReconstructX} & component of horizontal velocity in the x-direction (cartesian) \\
\hline
- \hyperref[subsec:var_sec_state_uReconstructY]{uReconstructY} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uReconstructY]{uReconstructY} & component of horizontal velocity in the y-direction (cartesian) \\
\hline
- \hyperref[subsec:var_sec_state_uReconstructZ]{uReconstructZ} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uReconstructZ]{uReconstructZ} & component of horizontal velocity in the z-direction (cartesian) \\
\hline
- \hyperref[subsec:var_sec_state_uReconstructZonal]{uReconstructZonal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uReconstructZonal]{uReconstructZonal} & component of horizontal velocity in the eastward direction \\
\hline
- \hyperref[subsec:var_sec_state_uReconstructMeridional]{uReconstructMeridional} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uReconstructMeridional]{uReconstructMeridional} & component of horizontal velocity in the northward \\
\hline
- \hyperref[subsec:var_sec_state_uSrcReconstructX]{uSrcReconstructX} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uSrcReconstructX]{uSrcReconstructX} & wind stress in the x-direction (cartesian) \\
\hline
- \hyperref[subsec:var_sec_state_uSrcReconstructY]{uSrcReconstructY} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uSrcReconstructY]{uSrcReconstructY} & wind stress in the y-direction (cartesian) \\
\hline
- \hyperref[subsec:var_sec_state_uSrcReconstructZ]{uSrcReconstructZ} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uSrcReconstructZ]{uSrcReconstructZ} & wind stress in the z-direction (cartesian) \\
\hline
- \hyperref[subsec:var_sec_state_uSrcReconstructZonal]{uSrcReconstructZonal} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_uSrcReconstructZonal]{uSrcReconstructZonal} & wind stress in the eastward direction \\
\hline
- \hyperref[subsec:var_sec_state_uSrcReconstructMeridional]{uSrcReconstructMeridional} & {\bf \color{red} MISSING} \\
+ \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} \\
\hline
- \hyperref[subsec:var_sec_state_pressure]{pressure} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_pressure]{pressure} & pressure used in the velocity equation \\
\hline
\hyperref[subsec:var_sec_state_wTop]{wTop} & {\bf \color{red} MISSING} \\
\hline
- \hyperref[subsec:var_sec_state_vertVelocityTop]{vertVelocityTop} & {\bf \color{red} MISSING} \\
+ \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} \\
\hline
- \hyperref[subsec:var_sec_state_BruntVaisalaFreqTop]{BruntVaisalaFreqTop} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_BruntVaisalaFreqTop]{BruntVaisalaFreqTop} & Brunt Vaisala frequency defined at the center (horizontally) and top (vertically) of cell \\
\hline
- \hyperref[subsec:var_sec_state_viscosity]{viscosity} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_viscosity]{viscosity} & horizontal viscosity \\
\hline
- \hyperref[subsec:var_sec_state_vh]{vh} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_vh]{vh} & thickness flux in the tangent direction (from vertex1 to vertex2) \\
\hline
- \hyperref[subsec:var_sec_state_circulation]{circulation} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_circulation]{circulation} & area-integrated vorticity \\
\hline
- \hyperref[subsec:var_sec_state_gradVor_t]{gradVor\_t} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_state_gradVor_t]{gradVor\_t} & gradient of vorticity in the tangent direction (from vertex1 to vertex2) \\
\hline
- \hyperref[subsec:var_sec_state_gradVor_n]{gradVor\_n} & {\bf \color{red} MISSING} \\
+ \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} \\
\hline
@@ -176,43 +176,43 @@
\hline
{\bf Name} & {\bf Description} \\
\hline
- \hyperref[subsec:var_sec_mesh_latCell]{latCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_latCell]{latCell} & Latitude location of cell centers in radians. \\
\hline
- \hyperref[subsec:var_sec_mesh_lonCell]{lonCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_lonCell]{lonCell} & Longitude location of cell centers in radians. \\
\hline
- \hyperref[subsec:var_sec_mesh_xCell]{xCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_xCell]{xCell} & X Coordinate in cartesian space of cell centers. \\
\hline
- \hyperref[subsec:var_sec_mesh_yCell]{yCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_yCell]{yCell} & Y Coordinate in cartesian space of cell centers. \\
\hline
- \hyperref[subsec:var_sec_mesh_zCell]{zCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_zCell]{zCell} & Z Coordinate in cartesian space of cell centers. \\
\hline
- \hyperref[subsec:var_sec_mesh_indexToCellID]{indexToCellID} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_indexToCellID]{indexToCellID} & List of global cell IDs. \\
\hline
- \hyperref[subsec:var_sec_mesh_latEdge]{latEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_latEdge]{latEdge} & Latitude location of edge midpoints in radians. \\
\hline
- \hyperref[subsec:var_sec_mesh_lonEdge]{lonEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_lonEdge]{lonEdge} & Longitude location of edge midpoints in radians. \\
\hline
- \hyperref[subsec:var_sec_mesh_xEdge]{xEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_xEdge]{xEdge} & X Coordinate in cartesian space of edge midpoints. \\
\hline
- \hyperref[subsec:var_sec_mesh_yEdge]{yEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_yEdge]{yEdge} & Y Coordinate in cartesian space of edge midpoints. \\
\hline
- \hyperref[subsec:var_sec_mesh_zEdge]{zEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_zEdge]{zEdge} & Z Coordinate in cartesian space of edge midpoints. \\
\hline
- \hyperref[subsec:var_sec_mesh_indexToEdgeID]{indexToEdgeID} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_indexToEdgeID]{indexToEdgeID} & List of global edge IDs. \\
\hline
- \hyperref[subsec:var_sec_mesh_latVertex]{latVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_latVertex]{latVertex} & Latitude location of vertices in radians. \\
\hline
- \hyperref[subsec:var_sec_mesh_lonVertex]{lonVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_lonVertex]{lonVertex} & Longitude location of vertices in radians. \\
\hline
- \hyperref[subsec:var_sec_mesh_xVertex]{xVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_xVertex]{xVertex} & X Coordinate in cartesian space of vertices. \\
\hline
- \hyperref[subsec:var_sec_mesh_yVertex]{yVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_yVertex]{yVertex} & Y Coordinate in cartesian space of vertices. \\
\hline
- \hyperref[subsec:var_sec_mesh_zVertex]{zVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_zVertex]{zVertex} & Z Coordinate in cartesian space of vertices. \\
\hline
- \hyperref[subsec:var_sec_mesh_indexToVertexID]{indexToVertexID} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_indexToVertexID]{indexToVertexID} & List of global vertex IDs. \\
\hline
- \hyperref[subsec:var_sec_mesh_meshDensity]{meshDensity} & {\bf \color{red} MISSING} \\
+ \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} \\
\hline
@@ -220,125 +220,125 @@
\hline
\hyperref[subsec:var_sec_mesh_meshScaling]{meshScaling} & {\bf \color{red} MISSING} \\
\hline
- \hyperref[subsec:var_sec_mesh_cellsOnEdge]{cellsOnEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_cellsOnEdge]{cellsOnEdge} & List of cells that straddle each edge. \\
\hline
- \hyperref[subsec:var_sec_mesh_nEdgesOnCell]{nEdgesOnCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_nEdgesOnCell]{nEdgesOnCell} & Number of edges that border each cell. \\
\hline
- \hyperref[subsec:var_sec_mesh_nEdgesOnEdge]{nEdgesOnEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_nEdgesOnEdge]{nEdgesOnEdge} & Number of edges that surround each of the cells that straddle each edge. These edges are used to reconstruct the tangential velocities. \\
\hline
- \hyperref[subsec:var_sec_mesh_edgesOnCell]{edgesOnCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_edgesOnCell]{edgesOnCell} & List of edges that border each cell. \\
\hline
- \hyperref[subsec:var_sec_mesh_edgesOnEdge]{edgesOnEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_edgesOnEdge]{edgesOnEdge} & List of edges that border each of the cells that straddle each edge. \\
\hline
- \hyperref[subsec:var_sec_mesh_weightsOnEdge]{weightsOnEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_weightsOnEdge]{weightsOnEdge} & Reconstruction weights associated with each of the edgesOnEdge. \\
\hline
- \hyperref[subsec:var_sec_mesh_dvEdge]{dvEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_dvEdge]{dvEdge} & Length of each edge, computed as the distance between verticesOnEdge. \\
\hline
- \hyperref[subsec:var_sec_mesh_dcEdge]{dcEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_dcEdge]{dcEdge} & Length of each edge, computed as the distance between cellsOnEdge. \\
\hline
- \hyperref[subsec:var_sec_mesh_angleEdge]{angleEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_angleEdge]{angleEdge} & Angle the edge normal makes with local eastward direction. \\
\hline
- \hyperref[subsec:var_sec_mesh_areaCell]{areaCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_areaCell]{areaCell} & Area of each cell in the primary grid. \\
\hline
- \hyperref[subsec:var_sec_mesh_areaTriangle]{areaTriangle} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_areaTriangle]{areaTriangle} & Area of each cell (triangle) in the dual grid. \\
\hline
- \hyperref[subsec:var_sec_mesh_edgeNormalVectors]{edgeNormalVectors} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_edgeNormalVectors]{edgeNormalVectors} & Normal vector defined at an edge. \\
\hline
- \hyperref[subsec:var_sec_mesh_localVerticalUnitVectors]{localVerticalUnitVectors} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_localVerticalUnitVectors]{localVerticalUnitVectors} & Unit surface normal vectors defined at cell centers. \\
\hline
- \hyperref[subsec:var_sec_mesh_cellTangentPlane]{cellTangentPlane} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_cellTangentPlane]{cellTangentPlane} & The two vectors that define a tangent plane at a cell center. \\
\hline
- \hyperref[subsec:var_sec_mesh_cellsOnCell]{cellsOnCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_cellsOnCell]{cellsOnCell} & List of cells that neighbor each cell. \\
\hline
- \hyperref[subsec:var_sec_mesh_verticesOnCell]{verticesOnCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_verticesOnCell]{verticesOnCell} & List of vertices that border each cell. \\
\hline
- \hyperref[subsec:var_sec_mesh_verticesOnEdge]{verticesOnEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_verticesOnEdge]{verticesOnEdge} & List of vertices that straddle each edge. \\
\hline
- \hyperref[subsec:var_sec_mesh_edgesOnVertex]{edgesOnVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_edgesOnVertex]{edgesOnVertex} & List of edges that share a vertex as an endpoint. \\
\hline
- \hyperref[subsec:var_sec_mesh_cellsOnVertex]{cellsOnVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_cellsOnVertex]{cellsOnVertex} & List of cells that share a vertex. \\
\hline
- \hyperref[subsec:var_sec_mesh_kiteAreasOnVertex]{kiteAreasOnVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_kiteAreasOnVertex]{kiteAreasOnVertex} & Area of the portions of each dual cell that are part of each cellsOnVertex. \\
\hline
- \hyperref[subsec:var_sec_mesh_fEdge]{fEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_fEdge]{fEdge} & Coriolis parameter at edges. \\
\hline
- \hyperref[subsec:var_sec_mesh_fVertex]{fVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_fVertex]{fVertex} & Coriolis parameter at vertices. \\
\hline
- \hyperref[subsec:var_sec_mesh_bottomDepth]{bottomDepth} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_bottomDepth]{bottomDepth} & Depth of the bottom of the ocean. Given as a positive distance from sea level. \\
\hline
- \hyperref[subsec:var_sec_mesh_deriv_two]{deriv\_two} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_deriv_two]{deriv\_two} & Value of the second derivative of the polynomial used for reconstruction of cell center quantities at edges. \\
\hline
- \hyperref[subsec:var_sec_mesh_adv_coefs]{adv\_coefs} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_adv_coefs]{adv\_coefs} & Weighting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines. \\
\hline
- \hyperref[subsec:var_sec_mesh_adv_coefs_2nd]{adv\_coefs\_2nd} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_adv_coefs_2nd]{adv\_coefs\_2nd} & Weighting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines. \\
\hline
- \hyperref[subsec:var_sec_mesh_adv_coefs_3rd]{adv\_coefs\_3rd} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_adv_coefs_3rd]{adv\_coefs\_3rd} & Wegihting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines. \\
\hline
- \hyperref[subsec:var_sec_mesh_advCellsForEdge]{advCellsForEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_advCellsForEdge]{advCellsForEdge} & List of cells used to reconstruct a cell quantity at an edge. Used in advection routines. \\
\hline
- \hyperref[subsec:var_sec_mesh_nAdvCellsForEdge]{nAdvCellsForEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_nAdvCellsForEdge]{nAdvCellsForEdge} & Number of cells used in reconstruction of cell center quantities at an edge. Used in advection routines. \\
\hline
- \hyperref[subsec:var_sec_mesh_highOrderAdvectionMask]{highOrderAdvectionMask} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_highOrderAdvectionMask]{highOrderAdvectionMask} & Mask for high order advection. Values are 1 if high order is used, and 0 if not. \\
\hline
- \hyperref[subsec:var_sec_mesh_lowOrderAdvectionMask]{lowOrderAdvectionMask} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_lowOrderAdvectionMask]{lowOrderAdvectionMask} & Mask for low order advection. Values are 1 if low order is used, and 0 if not. \\
\hline
- \hyperref[subsec:var_sec_mesh_defc_a]{defc\_a} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_defc_a]{defc\_a} & Variable used with advection setup to compute advection coefficients. Deformation weight coefficients. \\
\hline
- \hyperref[subsec:var_sec_mesh_defc_b]{defc\_b} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_defc_b]{defc\_b} & Variable used with advection setup to compute advection coefficients. Deformation weight coefficients. \\
\hline
- \hyperref[subsec:var_sec_mesh_kdiff]{kdiff} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_kdiff]{kdiff} & {\color{red} TO BE REMOVED} \\
\hline
- \hyperref[subsec:var_sec_mesh_coeffs_reconstruct]{coeffs\_reconstruct} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_coeffs_reconstruct]{coeffs\_reconstruct} & {\color{red} TO BE REMOVED} \\
\hline
- \hyperref[subsec:var_sec_mesh_maxLevelCell]{maxLevelCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_maxLevelCell]{maxLevelCell} & Index to the last active ocean cell in each column. \\
\hline
- \hyperref[subsec:var_sec_mesh_maxLevelEdgeTop]{maxLevelEdgeTop} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_maxLevelEdgeTop]{maxLevelEdgeTop} & Index to the last edge in a column with active ocean cells on both sides of it. \\
\hline
- \hyperref[subsec:var_sec_mesh_maxLevelEdgeBot]{maxLevelEdgeBot} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_maxLevelEdgeBot]{maxLevelEdgeBot} & Index to the last edge in a column with at least one active ocean cell on either side of it. \\
\hline
- \hyperref[subsec:var_sec_mesh_maxLevelVertexTop]{maxLevelVertexTop} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_maxLevelVertexTop]{maxLevelVertexTop} & Index to the last vertex in a column with all active cells around it. \\
\hline
- \hyperref[subsec:var_sec_mesh_maxLevelVertexBot]{maxLevelVertexBot} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_maxLevelVertexBot]{maxLevelVertexBot} & Index to the last vertex in a column with at least one active ocean cell around it. \\
\hline
- \hyperref[subsec:var_sec_mesh_refBottomDepth]{refBottomDepth} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_refBottomDepth]{refBottomDepth} & Reference depth of ocean for each vertical level. Used in 'z-level' type runs. \\
\hline
- \hyperref[subsec:var_sec_mesh_refBottomDepthTopOfCell]{refBottomDepthTopOfCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_refBottomDepthTopOfCell]{refBottomDepthTopOfCell} & Reference depth of ocean for each vertical interface. Used in 'z-level' type runs. \\
\hline
- \hyperref[subsec:var_sec_mesh_hZLevel]{hZLevel} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_hZLevel]{hZLevel} & {\color{red} TO BE REMOVED} \\
\hline
- \hyperref[subsec:var_sec_mesh_vertCoordMovementWeights]{vertCoordMovementWeights} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_vertCoordMovementWeights]{vertCoordMovementWeights} & Weights used for distribution of sea surface heigh purturbations through multiple vertical levels. \\
\hline
- \hyperref[subsec:var_sec_mesh_boundaryEdge]{boundaryEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_boundaryEdge]{boundaryEdge} & Mask for determining boundary edges. A boundary edge has only one active ocean cell neighboring it. \\
\hline
- \hyperref[subsec:var_sec_mesh_boundaryVertex]{boundaryVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_boundaryVertex]{boundaryVertex} & Mask for determining boundary vertices. A boundary vertex has at least one inactive cell neighboring it. \\
\hline
- \hyperref[subsec:var_sec_mesh_boundaryCell]{boundaryCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_boundaryCell]{boundaryCell} & Mask for determining boundary cells. A boundary cell has at least one inactive cell neighboring it. \\
\hline
- \hyperref[subsec:var_sec_mesh_edgeMask]{edgeMask} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_edgeMask]{edgeMask} & Mask on edges that determines if computations should be done on edge. \\
\hline
- \hyperref[subsec:var_sec_mesh_vertexMask]{vertexMask} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_vertexMask]{vertexMask} & Mask on vertices that determines if computations should be done on vertice. \\
\hline
- \hyperref[subsec:var_sec_mesh_cellMask]{cellMask} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_cellMask]{cellMask} & Mask on cells that determines if computations should be done on cell. \\
\hline
- \hyperref[subsec:var_sec_mesh_u_src]{u\_src} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_u_src]{u\_src} & Velocity forcing field. Defines a forcing at an edge. \\
\hline
- \hyperref[subsec:var_sec_mesh_temperatureRestore]{temperatureRestore} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_temperatureRestore]{temperatureRestore} & Temperature restoring field, for restoring temperature at the surface. \\
\hline
- \hyperref[subsec:var_sec_mesh_salinityRestore]{salinityRestore} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_salinityRestore]{salinityRestore} & Salinity restoring field, for restoring salinity at the surface. \\
\hline
- \hyperref[subsec:var_sec_mesh_windStressMonthly]{windStressMonthly} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_windStressMonthly]{windStressMonthly} & Monthly wind stress field, defined at the surface for use in monthly forcing. \\
\hline
- \hyperref[subsec:var_sec_mesh_temperatureRestoreMonthly]{temperatureRestoreMonthly} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_temperatureRestoreMonthly]{temperatureRestoreMonthly} & Monthly temperature restorying field, defined at the surface for use in monthly forcing. \\
\hline
- \hyperref[subsec:var_sec_mesh_salinityRestoreMonthly]{salinityRestoreMonthly} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_salinityRestoreMonthly]{salinityRestoreMonthly} & Monthly salinity resotring field, defined at the surface, for use in monthly forcing. \\
\hline
- \hyperref[subsec:var_sec_mesh_edgeSignOnCell]{edgeSignOnCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_edgeSignOnCell]{edgeSignOnCell} & Sign of edge contributions to a cell for each edge on cell. Used for bit-reproducible loops. Represents directionality of vector connecting cells. \\
\hline
- \hyperref[subsec:var_sec_mesh_edgeSignOnVertex]{edgeSignOnVertex} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_edgeSignOnVertex]{edgeSignOnVertex} & Sign of edge contributions to a vertex for each edge on vertex. Used for bit-reproducible loops. Represents directionality of vector connecting vertices. \\
\hline
- \hyperref[subsec:var_sec_mesh_kiteIndexOnCell]{kiteIndexOnCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_kiteIndexOnCell]{kiteIndexOnCell} & Index of kite in dual grid, based on verticesOnCell. \\
\hline
- \hyperref[subsec:var_sec_mesh_seaSurfacePressure]{seaSurfacePressure} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_mesh_seaSurfacePressure]{seaSurfacePressure} & Pressure defined at the sea surface. \\
\hline
\end{longtable}
\end{center}
@@ -352,23 +352,23 @@
\hline
{\bf Name} & {\bf Description} \\
\hline
- \hyperref[subsec:var_sec_tend_tend_temperature]{tend\_temperature} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_temperature]{tend\_temperature} & time tendency of potential temperature \\
\hline
- \hyperref[subsec:var_sec_tend_tend_salinity]{tend\_salinity} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_salinity]{tend\_salinity} & time tendency of salinity measured as change in practical salinity units per second \\
\hline
- \hyperref[subsec:var_sec_tend_tend_tracer1]{tend\_tracer1} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_tracer1]{tend\_tracer1} & time tendency of an arbitary tracer \\
\hline
- \hyperref[subsec:var_sec_tend_tend_temperature]{tend\_temperature} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_temperature]{tend\_temperature} & time tendency of potential temperature \\
\hline
- \hyperref[subsec:var_sec_tend_tend_salinity]{tend\_salinity} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_salinity]{tend\_salinity} & time tendency of salinity measured as change in practical salinity units per second \\
\hline
- \hyperref[subsec:var_sec_tend_tend_tracer1]{tend\_tracer1} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_tracer1]{tend\_tracer1} & time tendency of an arbitary tracer \\
\hline
- \hyperref[subsec:var_sec_tend_tend_u]{tend\_u} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_u]{tend\_u} & time tendency of normal component of velocity \\
\hline
- \hyperref[subsec:var_sec_tend_tend_h]{tend\_h} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_h]{tend\_h} & time tendency of layer thickness \\
\hline
- \hyperref[subsec:var_sec_tend_tend_ssh]{tend\_ssh} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_tend_tend_ssh]{tend\_ssh} & time tendency of sea-surface height \\
\hline
\end{longtable}
\end{center}
@@ -382,13 +382,13 @@
\hline
{\bf Name} & {\bf Description} \\
\hline
- \hyperref[subsec:var_sec_diagnostics_RiTopOfCell]{RiTopOfCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_diagnostics_RiTopOfCell]{RiTopOfCell} & gradient Richardson number defined at the center (horizontally) and top (vertically) \\
\hline
- \hyperref[subsec:var_sec_diagnostics_RiTopOfEdge]{RiTopOfEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_diagnostics_RiTopOfEdge]{RiTopOfEdge} & gradient Richardson number defined at the edge (horizontally) and top (vertically) \\
\hline
- \hyperref[subsec:var_sec_diagnostics_vertViscTopOfEdge]{vertViscTopOfEdge} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_diagnostics_vertViscTopOfEdge]{vertViscTopOfEdge} & vertical viscosity defined at the edge (horizontally) and top (vertically) \\
\hline
- \hyperref[subsec:var_sec_diagnostics_vertDiffTopOfCell]{vertDiffTopOfCell} & {\bf \color{red} MISSING} \\
+ \hyperref[subsec:var_sec_diagnostics_vertDiffTopOfCell]{vertDiffTopOfCell} & vertical diffusion defined at the edge (horizontally) and top (vertically) \\
\hline
\end{longtable}
\end{center}
</font>
</pre>