<p><b>mpetersen@lanl.gov</b> 2013-03-21 11:14:25 -0600 (Thu, 21 Mar 2013)</p><p>branch commit: add namelist and variables information.<br>
</p><hr noshade><pre><font color="gray">Modified: branches/xml_registry/src/core_ocean/Registry.xml
===================================================================
--- branches/xml_registry/src/core_ocean/Registry.xml        2013-03-21 17:13:59 UTC (rev 2645)
+++ branches/xml_registry/src/core_ocean/Registry.xml        2013-03-21 17:14:25 UTC (rev 2646)
@@ -427,53 +427,53 @@
                />
        </nml_record>
        <nml_record name="split_explicit_ts">
-                <nml_option name="config_n_ts_iter" type="integer" default_value="2" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_n_ts_iter" type="integer" default_value="2" units="unitless"
+                 description="number of large iterations over stages 1-3"
+                 possible_values="any positive integer, but typically 1, 2, or 3"
                />
-                <nml_option name="config_n_bcl_iter_beg" type="integer" default_value="1" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_n_bcl_iter_beg" type="integer" default_value="1" units="unitless"
+                 description="number of iterations of stage 1 (baroclinic solve) on the first split-explicit iteration"
+                 possible_values="any positive integer, but typically 1, 2, or 3"
                />
-                <nml_option name="config_n_bcl_iter_mid" type="integer" default_value="2" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_n_bcl_iter_mid" type="integer" default_value="2" units="unitless"
+                 description="number of iterations of stage 1 (baroclinic solve) on any split-explicit iterations between first and last"
+                 possible_values="any positive integer, but typically 1, 2, or 3"
                />
-                <nml_option name="config_n_bcl_iter_end" type="integer" default_value="2" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_n_bcl_iter_end" type="integer" default_value="2" units="unitless"
+                 description="number of iterations of stage 1 (baroclinic solve) on the last split-explicit iteration"
+                 possible_values="any positive integer, but typically 1, 2, or 3"
                />
-                <nml_option name="config_n_btr_subcycles" type="integer" default_value="20" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_n_btr_subcycles" type="integer" default_value="20" units="unitless"
+                 description="number of barotropic subcycles in stage 2"
+                 possible_values="any positive integer, typically between 10 and 100"
                />
-                <nml_option name="config_n_btr_cor_iter" type="integer" default_value="2" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_n_btr_cor_iter" type="integer" default_value="2" units="unitless"
+                 description="number of iterations of the velocity corrector step in stage 2"
+                 possible_values="any positive integer, but typically 1, 2, or 3"
                />
-                <nml_option name="config_u_correction" type="logical" default_value=".true." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_u_correction" type="logical" default_value=".true." units="unitless"
+                 description="If true, the velocity correction term is included in the horizontal advection of thickness and tracers"
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_btr_subcycle_loop_factor" type="integer" default_value="2" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_btr_subcycle_loop_factor" type="integer" default_value="2" units="unitless"
+                 description="Barotropic subcycles proceed from $t$ to $t+n\Delta t$, where $n$ is this configuration option."
+                 possible_values="Any positive integer, but typically 1 or 2"
                />
-                <nml_option name="config_btr_gam1_uWt1" type="real" default_value="0.5" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_btr_gam1_uWt1" type="real" default_value="0.5" units="unitless"
+                 description="Weighting of velocity in the SSH predictor step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used."
+                 possible_values="between 0 and 1"
                />
-                <nml_option name="config_btr_gam2_SSHWt1" type="real" default_value="1.0" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_btr_gam2_SSHWt1" type="real" default_value="1.0" units="unitless"
+                 description="Weighting of SSH in the velocity corrector step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used."
+                 possible_values="between 0 and 1"
                />
-                <nml_option name="config_btr_gam3_uWt2" type="real" default_value="1.0" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_btr_gam3_uWt2" type="real" default_value="1.0" units="unitless"
+                 description="Weighting of velocity in the SSH corrector step in stage 2. When zero, previous subcycle time is used; when one, new subcycle time is used."
+                 possible_values="between 0 and 1"
                />
-                <nml_option name="config_btr_solve_SSH2" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_btr_solve_SSH2" type="logical" default_value=".false." units="unitless"
+                 description="If true, execute the SSH corrector step in stage 2"
+                 possible_values=".true. or .false."
                />
        </nml_record>
        <nml_record name="debug">
@@ -735,53 +735,53 @@
                <var name="gradVor_n" type="real" dimensions="nVertLevels nEdges Time" units="s^{-1} m^{-1}"
                 description="gradient of vorticity in the normal direction (from cell1 to cell2)"
                />
-                <var name="areaCellGlobal" type="real" dimensions="Time" streams="o" units=""
-                 description=""
+                <var name="areaCellGlobal" type="real" dimensions="Time" streams="o" units="m^2"
+                 description="sum of the areaCell variable over the full domain, used to normalize global statistics"
                />
-                <var name="areaEdgeGlobal" type="real" dimensions="Time" streams="o" units=""
-                 description=""
+                <var name="areaEdgeGlobal" type="real" dimensions="Time" streams="o" units="m^2"
+                 description="sum of the areaEdge variable over the full domain, used to normalize global statistics"
                />
-                <var name="areaTriangleGlobal" type="real" dimensions="Time" streams="o" units=""
-                 description=""
+                <var name="areaTriangleGlobal" type="real" dimensions="Time" streams="o" units="m^2"
+                 description="sum of the areaTriangle variable over the full domain, used to normalize global statistics"
                />
-                <var name="volumeCellGlobal" type="real" dimensions="Time" streams="o" units=""
-                 description=""
+                <var name="volumeCellGlobal" type="real" dimensions="Time" streams="o" units="m^3"
+                 description="sum of the volumeCell variable over the full domain, used to normalize global statistics"
                />
-                <var name="volumeEdgeGlobal" type="real" dimensions="Time" streams="o" units=""
-                 description=""
+                <var name="volumeEdgeGlobal" type="real" dimensions="Time" streams="o" units="m^3"
+                 description="sum of the volumeEdge variable over the full domain, used to normalize global statistics"
                />
-                <var name="CFLNumberGlobal" type="real" dimensions="Time" streams="o" units=""
-                 description=""
+                <var name="CFLNumberGlobal" type="real" dimensions="Time" streams="o" units="unitless"
+                 description="maximum CFL number over the full domain"
                />
-                <var name="nAccumulate" type="real" dimensions="Time" streams="o" units=""
-                 description=""
+                <var name="nAccumulate" type="real" dimensions="Time" streams="o" units="unitless"
+                 description="number of timesteps in time-averaged variables"
                />
-                <var name="acc_ssh" type="real" dimensions="nCells Time" streams="o" units=""
-                 description=""
+                <var name="acc_ssh" type="real" dimensions="nCells Time" streams="o" units="m"
+                 description="time-averaged sea surface height"
                />
-                <var name="acc_sshVar" type="real" dimensions="nCells Time" streams="o" units=""
-                 description=""
+                <var name="acc_sshVar" type="real" dimensions="nCells Time" streams="o" units="m"
+                 description="variance of sea surface height"
                />
-                <var name="acc_uReconstructZonal" type="real" dimensions="nVertLevels nCells Time" streams="o" units=""
-                 description=""
+                <var name="acc_uReconstructZonal" type="real" dimensions="nVertLevels nCells Time" streams="o" units="m s^{-1}"
+                 description="time-averaged velocity in the eastward direction"
                />
-                <var name="acc_uReconstructMeridional" type="real" dimensions="nVertLevels nCells Time" streams="o" units=""
-                 description=""
+                <var name="acc_uReconstructMeridional" type="real" dimensions="nVertLevels nCells Time" streams="o" units="m s^{-1}"
+                 description="time-averaged velocity in the northward direction"
                />
-                <var name="acc_uReconstructZonalVar" type="real" dimensions="nVertLevels nCells Time" streams="o" units=""
-                 description=""
+                <var name="acc_uReconstructZonalVar" type="real" dimensions="nVertLevels nCells Time" streams="o" units="m s^{-1}"
+                 description="variance of velocity in the eastward direction"
                />
-                <var name="acc_uReconstructMeridionalVar" type="real" dimensions="nVertLevels nCells Time" streams="o" units=""
-                 description=""
+                <var name="acc_uReconstructMeridionalVar" type="real" dimensions="nVertLevels nCells Time" streams="o" units="m s^{-1}"
+                 description="variance of velocity in the northward direction"
                />
-                <var name="acc_u" type="real" dimensions="nVertLevels nEdges Time" streams="o" units=""
-                 description=""
+                <var name="acc_u" type="real" dimensions="nVertLevels nEdges Time" streams="o" units="m s^{-1}"
+                 description="time-averaged velocity, normal to cell edge"
                />
-                <var name="acc_uVar" type="real" dimensions="nVertLevels nEdges Time" streams="o" units=""
-                 description=""
+                <var name="acc_uVar" type="real" dimensions="nVertLevels nEdges Time" streams="o" units="m s^{-1}"
+                 description="variance of velocity, normal to cell edge"
                />
-                <var name="acc_vertVelocityTop" type="real" dimensions="nVertLevelsP1 nCells Time" streams="o" units=""
-                 description=""
+                <var name="acc_vertVelocityTop" type="real" dimensions="nVertLevelsP1 nCells Time" streams="o" units="m s^{-1}"
+                 description="time-averaged vertical velocity at top of cell"
                />
        </var_struct>
        <var_struct name="mesh" time_levs="0">
</font>
</pre>