<p><b>dwj07@fsu.edu</b> 2013-03-15 09:30:26 -0600 (Fri, 15 Mar 2013)</p><p><br>
        -- BRANCH COMMIT --<br>
<br>
        Adding some documentation to Registry file.<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-15 15:30:08 UTC (rev 2618)
+++ branches/xml_registry/src/core_ocean/Registry.xml        2013-03-15 15:30:26 UTC (rev 2619)
@@ -1,69 +1,69 @@
<?xml version="1.0"?>
<registry>
        <dims>
-                <dim name="nCells" units=""
-                 description=""
+                <dim name="nCells" units="unitless"
+                 description="The number of polygons in the primary grid."
                />
-                <dim name="nEdges" units=""
-                 description=""
+                <dim name="nEdges" units="unitless"
+                 description="The number of edge midpoints in either the primary or dual grid."
                />
-                <dim name="maxEdges" units=""
-                 description=""
+                <dim name="maxEdges" units="unitless"
+                 description="The largest number of edges any polygon within the grid has."
                />
-                <dim name="maxEdges2" units=""
-                 description=""
+                <dim name="maxEdges2" units="unitless"
+                 description="Two times the largest number of edges any polygon within the grid has."
                />
-                <dim name="nAdvectionCells" definition="maxEdges2+0" units=""
-                 description=""
+                <dim name="nAdvectionCells" definition="maxEdges2+0" units="unitless"
+                 description="The largest number of advection cells for any edge."
                />
-                <dim name="nVertices" units=""
-                 description=""
+                <dim name="nVertices" units="unitless"
+                 description="The total number of cells in the dual grid. Also the number of corners in the primary grid."
                />
-                <dim name="TWO" definition="2" units=""
-                 description=""
+                <dim name="TWO" definition="2" units="unitless"
+                 description="The number two as a dimension."
                />
-                <dim name="R3" definition="3" units=""
-                 description=""
+                <dim name="R3" definition="3" units="unitless"
+                 description="The number three as a dimension."
                />
-                <dim name="FIFTEEN" definition="15" units=""
-                 description=""
+                <dim name="FIFTEEN" definition="15" units="unitless"
+                 description="The number 15 as a dimension."
                />
-                <dim name="TWENTYONE" definition="21" units=""
-                 description=""
+                <dim name="TWENTYONE" definition="21" units="unitless"
+                 description="The number 21 as a dimension."
                />
-                <dim name="vertexDegree" units=""
-                 description=""
+                <dim name="vertexDegree" units="unitless"
+                 description="The number of cells or edges touching each vertex."
                />
-                <dim name="nVertLevels" units=""
-                 description=""
+                <dim name="nVertLevels" units="unitless"
+                 description="The number of levels in the vertical direction. All vertical levels share the same horizontal locations."
                />
-                <dim name="nVertLevelsP1" definition="nVertLevels+1" units=""
-                 description=""
+                <dim name="nVertLevelsP1" definition="nVertLevels+1" units="unitless"
+                 description="The number of interfaces in the vertical direction."
                />
-                <dim name="nMonths" units=""
-                 description=""
+                <dim name="nMonths" units="unitless"
+                         description="The number of forcing slices in the monthly forcing fields. {\bf \color{red} Deprecated. Should be removed.}"
                />
        </dims>
        <nml_record name="time_management">
-                <nml_option name="config_do_restart" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_do_restart" type="logical" default_value=".false." units="unitless"
+                 description="Determines if the initial conditions should be read from a restart file, or an input file."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_start_time" type="character" default_value="'0000-01-01_00:00:00'" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_start_time" type="character" default_value="'0000-01-01_00:00:00'" units="unitless"
+                 description="Timestamp describing the initial time of the simulation. If it is set to 'file', the initial time is read from restart_timestamp."
+                 possible_values="'YYYY-MM-DD_HH:MM:SS' or 'file'"
                />
-                <nml_option name="config_stop_time" type="character" default_value="'none'" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_stop_time" type="character" default_value="'none'" units="unitless"
+                 description="Timestamp descriping the final time of the simulation. If it is set to 'none' the final time is determined from config_start_time and config_run_duration."
+                 possible_values="'YYYY-MM-DD_HH:MM:SS' or 'none'"
                />
-                <nml_option name="config_run_duration" type="character" default_value="'0_06:00:00'" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_run_duration" type="character" default_value="'0_06:00:00'" units="unitless"
+                 description="Timestamp describing the length of the simulation. If it is set to 'none' the duraction is determined from config_start_time and config_stop_time. config_run_duration overrides inconsistent values of config_stop_time."
+                 possible_values="'DDDD_HH:MM:SS' or 'none'"
                />
-                <nml_option name="config_calendar_type" type="character" default_value="'360day'" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_calendar_type" type="character" default_value="'360day'" units="unitless"
+                 description="Selection of the type of calendar that should be used in the simulation."
+                 possible_values="'gregorian', 'gregorian_noleap', or '360day'"
                />
        </nml_record>
        <nml_record name="io">
@@ -123,43 +123,43 @@
                />
        </nml_record>
        <nml_record name="grid">
-                <nml_option name="config_num_halos" type="integer" default_value="3" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_num_halos" type="integer" default_value="3" units="unitless"
+                 description="Determines the number of halo cells extending from a blocks owned cells (Called the 0-Halo). The default of 3 is the minimum that can be used with monotonic advection."
+                 possible_values="Any positive interger value."
                />
-                <nml_option name="config_vert_coord_movement" type="character" default_value="'uniform_stretching'" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_vert_coord_movement" type="character" default_value="'uniform_stretching'" units="unitless"
+                 description="Determines the vertical coordinate movement type. 'uniform_stretching' distrubtes SSH perturbations through all vertical levels, 'fixed' places them all in the top level, 'user_specified' allows the input file to determine the distribution, and 'isopycnal' causes levels to be pure isopycnal."
+                 possible_values="'uniform_stretching', 'fixed', 'user_specified', 'isopycnal'"
                />
-                <nml_option name="config_alter_ICs_for_pbcs" type="character" default_value="'zlevel_pbcs_off'" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_alter_ICs_for_pbcs" type="character" default_value="'zlevel_pbcs_off'" units="unitless"
+                 description="Determines the method of alteration for partial bottom cells. 'zlevel_pbcs_on' alters the initial conditions for partial bottom cells, 'zlevel_pbcs_off' alters the initial conditions to have full cells everwhere, and 'off' does nothing to the initial conditions."
+                 possible_values="'zlevel_pbcs_on', 'zlevel_pbcs_off', 'off'"
                />
-                <nml_option name="config_min_pbc_fraction" type="real" default_value="0.10" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_min_pbc_fraction" type="real" default_value="0.10" units="unitless"
+                 description="Determines the minimum fraction of a cell altering the initial conditions can create."
+                 possible_values="Any real between 0 and 1."
                />
                <nml_option name="config_check_ssh_consistency" type="logical" default_value=".true." units=""
-                 description=""
+                 description="Enables a check to determine if the SSH is consistent across relevant variables."
                 possible_values=""
                />
        </nml_record>
        <nml_record name="decomposition">
-                <nml_option name="config_block_decomp_file_prefix" type="character" default_value="'graph.info.part.'" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_block_decomp_file_prefix" type="character" default_value="'graph.info.part.'" units="unitless"
+                 description="Defines the prefix for the block decomposition file. Can include a path. The number of blocks is appended to the end of the prefix at run-time."
+                                        possible_values="Any path/prefix to a block decomposition file."
                />
-                <nml_option name="config_number_of_blocks" type="integer" default_value="0" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_number_of_blocks" type="integer" default_value="0" units="unitless"
+                 description="Determines the number of blocks a simulation should be run with. If it is set to 0, the number of blocks is the same as the number of MPI tasks at run-time."
+                                        possible_values="Any integer $>=$ 0."
                />
-                <nml_option name="config_explicit_proc_decomp" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_explicit_proc_decomp" type="logical" default_value=".false." units="unitless"
+                 description="Determines if an explicit processor decomposition should be used. This is only useful if multiple blocks per processor are used."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_proc_decomp_file_prefix" type="character" default_value="'graph.info.part.'" units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_proc_decomp_file_prefix" type="character" default_value="'graph.info.part.'" units="unitless"
+                 description="Defines the prefix for the processor decomposition file. This file is only read if config_explicit_proc_decomp is .true. The number of processors is appended to the end of the prefix at run-time."
+                                        possible_values="Any path/prefix to a processor decomposition file."
                />
        </nml_record>
        <nml_record name="hmix">
@@ -477,85 +477,85 @@
                />
        </nml_record>
        <nml_record name="debug">
-                <nml_option name="config_check_zlevel_consistency" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_check_zlevel_consistency" type="logical" default_value=".false." units="unitless"
+                 description="Enables a run-time check for consistency for a zlevel grid. Ensures relevant variables correctly define the bottom of the ocean."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_filter_btr_mode" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_filter_btr_mode" type="logical" default_value=".false." units="unitless"
+                 description="Enables filtering of the barotropic mode."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_prescribe_velocity" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_prescribe_velocity" type="logical" default_value=".false." units="unitless"
+                 description="Enables a prescribed velocity field. This velocity field is read on input, and remains constant through a simulation."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_prescribe_thickness" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_prescribe_thickness" type="logical" default_value=".false." units="unitless"
+                 description="Enables a prescribed thickness field. This thickness field is read on input, and remains constant through a simulation."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_include_KE_vertex" type="logical" default_value=".false." units=""
+                <nml_option name="config_include_KE_vertex" type="logical" default_value=".false." units="unitless"
                 description=""
-                 possible_values=""
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_check_tracer_monotonicity" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_check_tracer_monotonicity" type="logical" default_value=".false." units="unitless"
+                 description="Enables a change on tracer monotonicity at the end of the monotonic advection routine. Only used if config_monotonic is set to .true."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_h_all_tend" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_h_all_tend" type="logical" default_value=".false." units="unitless"
+                 description="Disables all tendencies on the thickness field."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_h_hadv" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_h_hadv" type="logical" default_value=".false." units="unitless"
+                 description="Disable tendencies on the thickness field from horizontal advection."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_h_vadv" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_h_vadv" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on the thickness field from vertical advection."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_u_all_tend" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_u_all_tend" type="logical" default_value=".false." units="unitless"
+                 description="Disables all tendencies on the velocity field."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_u_coriolis" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_u_coriolis" type="logical" default_value=".false." units="unitless"
+                 description="Diables tendencies on the velocity field from the Coriolis force."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_u_pgrad" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_u_pgrad" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on the velocity field from the horizontal pressure gradient."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_u_hmix" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_u_hmix" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on the velocity field from horizontal mixing."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_u_windstress" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_u_windstress" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on the velocity field from horizontal wind stress."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_u_vmix" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_u_vmix" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on the velocity field from vertical mixing."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_u_vadv" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_u_vadv" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on the velocity field from vertical advection."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_tr_all_tend" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_tr_all_tend" type="logical" default_value=".false." units="unitless"
+                 description="Disables all tendencies on tracer fields."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_tr_adv" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_tr_adv" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on tracer fields from advection, both horizontal and vertical."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_tr_hmix" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_tr_hmix" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on tracer fields from horizontal mixing."
+                 possible_values=".true. or .false."
                />
-                <nml_option name="config_disable_tr_vmix" type="logical" default_value=".false." units=""
-                 description=""
-                 possible_values=""
+                <nml_option name="config_disable_tr_vmix" type="logical" default_value=".false." units="unitless"
+                 description="Disables tendencies on tracer fields from vertical mixing."
+                 possible_values=".true. or .false."
                />
        </nml_record>
        <var_struct name="state" time_levs="2">
</font>
</pre>