<p><b>dwj07@fsu.edu</b> 2013-03-20 15:31:24 -0600 (Wed, 20 Mar 2013)</p><p><br>
        -- BRANCH COMMIT --<br>
<br>
        Adding documentation of variables to XML registry.<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-20 21:03:40 UTC (rev 2636)
+++ branches/xml_registry/src/core_ocean/Registry.xml        2013-03-20 21:31:24 UTC (rev 2637)
@@ -785,251 +785,251 @@
                />
        </var_struct>
        <var_struct name="mesh" time_levs="0">
-                <var name="latCell" type="real" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="latCell" type="real" dimensions="nCells" streams="iro" units="radians"
+                         description="Latitude location of cell centers in radians."
                />
-                <var name="lonCell" type="real" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="lonCell" type="real" dimensions="nCells" streams="iro" units="radians"
+                 description="Longitude location of cell centers in radians."
                />
-                <var name="xCell" type="real" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="xCell" type="real" dimensions="nCells" streams="iro" units="unitless"
+                 description="X Coordinate in cartesian space of cell centers."
                />
-                <var name="yCell" type="real" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="yCell" type="real" dimensions="nCells" streams="iro" units="unitless"
+                 description="Y Coordinate in cartesian space of cell centers."
                />
-                <var name="zCell" type="real" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="zCell" type="real" dimensions="nCells" streams="iro" units="unitless"
+                 description="Z Coordinate in cartesian space of cell centers."
                />
-                <var name="indexToCellID" type="integer" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="indexToCellID" type="integer" dimensions="nCells" streams="iro" units="unitless"
+                 description="List of global cell IDs."
                />
-                <var name="latEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="latEdge" type="real" dimensions="nEdges" streams="iro" units="radians"
+                 description="Latitude location of edge midpoints in radians."
                />
-                <var name="lonEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="lonEdge" type="real" dimensions="nEdges" streams="iro" units="radians"
+                 description="Longitude location of edge midpoints in radians."
                />
-                <var name="xEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="xEdge" type="real" dimensions="nEdges" streams="iro" units="unitless"
+                 description="X Coordinate in cartesian space of edge midpoints."
                />
-                <var name="yEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="yEdge" type="real" dimensions="nEdges" streams="iro" units="unitless"
+                 description="Y Coordinate in cartesian space of edge midpoints."
                />
-                <var name="zEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="zEdge" type="real" dimensions="nEdges" streams="iro" units="unitless"
+                 description="Z Coordinate in cartesian space of edge midpoints."
                />
-                <var name="indexToEdgeID" type="integer" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="indexToEdgeID" type="integer" dimensions="nEdges" streams="iro" units="unitless"
+                 description="List of global edge IDs."
                />
-                <var name="latVertex" type="real" dimensions="nVertices" streams="iro" units=""
-                 description=""
+                <var name="latVertex" type="real" dimensions="nVertices" streams="iro" units="radians"
+                 description="Latitude location of vertices in radians."
                />
-                <var name="lonVertex" type="real" dimensions="nVertices" streams="iro" units=""
-                 description=""
+                <var name="lonVertex" type="real" dimensions="nVertices" streams="iro" units="radians"
+                 description="Longitude location of vertices in radians."
                />
-                <var name="xVertex" type="real" dimensions="nVertices" streams="iro" units=""
-                 description=""
+                <var name="xVertex" type="real" dimensions="nVertices" streams="iro" units="unitless"
+                 description="X Coordinate in cartesian space of vertices."
                />
-                <var name="yVertex" type="real" dimensions="nVertices" streams="iro" units=""
-                 description=""
+                <var name="yVertex" type="real" dimensions="nVertices" streams="iro" units="unitless"
+                 description="Y Coordinate in cartesian space of vertices."
                />
-                <var name="zVertex" type="real" dimensions="nVertices" streams="iro" units=""
-                 description=""
+                <var name="zVertex" type="real" dimensions="nVertices" streams="iro" units="unitless"
+                 description="Z Coordinate in cartesian space of vertices."
                />
-                <var name="indexToVertexID" type="integer" dimensions="nVertices" streams="iro" units=""
-                 description=""
+                <var name="indexToVertexID" type="integer" dimensions="nVertices" streams="iro" units="unitless"
+                 description="List of global vertex IDs."
                />
-                <var name="meshDensity" type="real" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="meshDensity" type="real" dimensions="nCells" streams="iro" units="unitless"
+                 description="Value of density function used to generate a particular mesh at cell centers."
                />
-                <var name="meshScalingDel2" type="real" dimensions="nEdges" streams="ro" units=""
+                <var name="meshScalingDel2" type="real" dimensions="nEdges" streams="ro" units="unitless"
                 description=""
                />
-                <var name="meshScalingDel4" type="real" dimensions="nEdges" streams="ro" units=""
+                <var name="meshScalingDel4" type="real" dimensions="nEdges" streams="ro" units="unitless"
                 description=""
                />
-                <var name="meshScaling" type="real" dimensions="nEdges" streams="ro" units=""
+                <var name="meshScaling" type="real" dimensions="nEdges" streams="ro" units="unitless"
                 description=""
                />
-                <var name="cellsOnEdge" type="integer" dimensions="TWO nEdges" streams="iro" units=""
-                 description=""
+                <var name="cellsOnEdge" type="integer" dimensions="TWO nEdges" streams="iro" units="unitless"
+                 description="List of cells that straddle each edge."
                />
-                <var name="nEdgesOnCell" type="integer" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="nEdgesOnCell" type="integer" dimensions="nCells" streams="iro" units="unitless"
+                 description="Number of edges that border each cell."
                />
-                <var name="nEdgesOnEdge" type="integer" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="nEdgesOnEdge" type="integer" dimensions="nEdges" streams="iro" units="unitless"
+                 description="Number of edges that surround each of the cells that straddle each edge. These edges are used to reconstruct the tangential velocities."
                />
-                <var name="edgesOnCell" type="integer" dimensions="maxEdges nCells" streams="iro" units=""
-                 description=""
+                <var name="edgesOnCell" type="integer" dimensions="maxEdges nCells" streams="iro" units="unitless"
+                 description="List of edges that border each cell."
                />
-                <var name="edgesOnEdge" type="integer" dimensions="maxEdges2 nEdges" streams="iro" units=""
-                 description=""
+                <var name="edgesOnEdge" type="integer" dimensions="maxEdges2 nEdges" streams="iro" units="unitless"
+                 description="List of edges that border each of the cells that straddle each edge."
                />
-                <var name="weightsOnEdge" type="real" dimensions="maxEdges2 nEdges" streams="iro" units=""
-                 description=""
+                <var name="weightsOnEdge" type="real" dimensions="maxEdges2 nEdges" streams="iro" units="unitless"
+                 description="Reconstruction weights associated with each of the edgesOnEdge."
                />
-                <var name="dvEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="dvEdge" type="real" dimensions="nEdges" streams="iro" units="m"
+                 description="Length of each edge, computed as the distance between verticesOnEdge."
                />
-                <var name="dcEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="dcEdge" type="real" dimensions="nEdges" streams="iro" units="m"
+                 description="Length of each edge, computed as the distance between cellsOnEdge."
                />
-                <var name="angleEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="angleEdge" type="real" dimensions="nEdges" streams="iro" units="radians"
+                 description="Angle the edge normal makes with local eastward direction."
                />
-                <var name="areaCell" type="real" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="areaCell" type="real" dimensions="nCells" streams="iro" units="m^2"
+                 description="Area of each cell in the primary grid."
                />
-                <var name="areaTriangle" type="real" dimensions="nVertices" streams="iro" units=""
-                 description=""
+                <var name="areaTriangle" type="real" dimensions="nVertices" streams="iro" units="m^2"
+                 description="Area of each cell (triangle) in the dual grid."
                />
-                <var name="edgeNormalVectors" type="real" dimensions="R3 nEdges" streams="o" units=""
-                 description=""
+                <var name="edgeNormalVectors" type="real" dimensions="R3 nEdges" streams="o" units="unitless"
+                 description="Normal vector defined at an edge."
                />
-                <var name="localVerticalUnitVectors" type="real" dimensions="R3 nCells" streams="o" units=""
-                 description=""
+                <var name="localVerticalUnitVectors" type="real" dimensions="R3 nCells" streams="o" units="unitless"
+                 description="Unit surface normal vectors defined at cell centers."
                />
-                <var name="cellTangentPlane" type="real" dimensions="R3 TWO nCells" streams="o" units=""
-                 description=""
+                <var name="cellTangentPlane" type="real" dimensions="R3 TWO nCells" streams="o" units="unitless"
+                 description="The two vectors that define a tangent plane at a cell center."
                />
-                <var name="cellsOnCell" type="integer" dimensions="maxEdges nCells" streams="iro" units=""
-                 description=""
+                <var name="cellsOnCell" type="integer" dimensions="maxEdges nCells" streams="iro" units="unitless"
+                 description="List of cells that neighbor each cell."
                />
-                <var name="verticesOnCell" type="integer" dimensions="maxEdges nCells" streams="iro" units=""
-                 description=""
+                <var name="verticesOnCell" type="integer" dimensions="maxEdges nCells" streams="iro" units="unitless"
+                 description="List of vertices that border each cell."
                />
-                <var name="verticesOnEdge" type="integer" dimensions="TWO nEdges" streams="iro" units=""
-                 description=""
+                <var name="verticesOnEdge" type="integer" dimensions="TWO nEdges" streams="iro" units="unitless"
+                 description="List of vertices that straddle each edge."
                />
-                <var name="edgesOnVertex" type="integer" dimensions="vertexDegree nVertices" streams="iro" units=""
-                 description=""
+                <var name="edgesOnVertex" type="integer" dimensions="vertexDegree nVertices" streams="iro" units="unitless"
+                 description="List of edges that share a vertex as an endpoint."
                />
-                <var name="cellsOnVertex" type="integer" dimensions="vertexDegree nVertices" streams="iro" units=""
-                 description=""
+                <var name="cellsOnVertex" type="integer" dimensions="vertexDegree nVertices" streams="iro" units="unitless"
+                 description="List of cells that share a vertex."
                />
-                <var name="kiteAreasOnVertex" type="real" dimensions="vertexDegree nVertices" streams="iro" units=""
-                 description=""
+                <var name="kiteAreasOnVertex" type="real" dimensions="vertexDegree nVertices" streams="iro" units="m^2"
+                 description="Area of the portions of each dual cell that are part of each cellsOnVertex."
                />
-                <var name="fEdge" type="real" dimensions="nEdges" streams="iro" units=""
-                 description=""
+                <var name="fEdge" type="real" dimensions="nEdges" streams="iro" units="s^{-1}"
+                 description="Coriolis parameter at edges."
                />
-                <var name="fVertex" type="real" dimensions="nVertices" streams="iro" units=""
-                 description=""
+                <var name="fVertex" type="real" dimensions="nVertices" streams="iro" units="s^{-1}"
+                 description="Coriolis parameter at vertices."
                />
-                <var name="bottomDepth" type="real" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="bottomDepth" type="real" dimensions="nCells" streams="iro" units="m"
+                 description="Depth of the bottom of the ocean. Given as a positive distance from sea level."
                />
                <var name="deriv_two" type="real" dimensions="maxEdges2 TWO nEdges" units=""
-                 description=""
+                 description="Value of the second derivative of the polynomial used for reconstruction of cell center quantities at edges."
                />
                <var name="adv_coefs" type="real" dimensions="nAdvectionCells nEdges" units=""
-                 description=""
+                 description="Weighting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines."
                />
                <var name="adv_coefs_2nd" type="real" dimensions="nAdvectionCells nEdges" units=""
-                 description=""
+                 description="Weighting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines."
                />
                <var name="adv_coefs_3rd" type="real" dimensions="nAdvectionCells nEdges" units=""
-                 description=""
+                        description="Wegihting coefficients used for reconstruction of cell center quantities at edges. Used in advection routines."
                />
-                <var name="advCellsForEdge" type="integer" dimensions="nAdvectionCells nEdges" units=""
-                 description=""
+                <var name="advCellsForEdge" type="integer" dimensions="nAdvectionCells nEdges" units="unitless"
+                 description="List of cells used to reconstruct a cell quantity at an edge. Used in advection routines."
                />
-                <var name="nAdvCellsForEdge" type="integer" dimensions="nEdges" units=""
-                 description=""
+                <var name="nAdvCellsForEdge" type="integer" dimensions="nEdges" units="unitless"
+                 description="Number of cells used in reconstruction of cell center quantities at an edge. Used in advection routines."
                />
-                <var name="highOrderAdvectionMask" type="integer" dimensions="nVertLevels nEdges" units=""
-                 description=""
+                <var name="highOrderAdvectionMask" type="integer" dimensions="nVertLevels nEdges" units="unitless"
+                 description="Mask for high order advection. Values are 1 if high order is used, and 0 if not."
                />
-                <var name="lowOrderAdvectionMask" type="integer" dimensions="nVertLevels nEdges" units=""
-                 description=""
+                <var name="lowOrderAdvectionMask" type="integer" dimensions="nVertLevels nEdges" units="unitless"
+                 description="Mask for low order advection. Values are 1 if low order is used, and 0 if not."
                />
                <var name="defc_a" type="real" dimensions="maxEdges nCells" units=""
-                 description=""
+                 description="Variable used with advection setup to compute advection coefficients. Deformation weight coefficients."
                />
                <var name="defc_b" type="real" dimensions="maxEdges nCells" units=""
-                 description=""
+                 description="Variable used with advection setup to compute advection coefficients. Deformation weight coefficients."
                />
                <var name="kdiff" type="real" dimensions="nVertLevels nCells Time" units=""
-                 description=""
+                         description="{\color{red} TO BE REMOVED}"
                />
                <var name="coeffs_reconstruct" type="real" dimensions="R3 maxEdges nCells" units=""
-                 description=""
+                         description="{\color{red} TO BE REMOVED}"
                />
-                <var name="maxLevelCell" type="integer" dimensions="nCells" streams="iro" units=""
-                 description=""
+                <var name="maxLevelCell" type="integer" dimensions="nCells" streams="iro" units="unitless"
+                 description="Index to the last active ocean cell in each column."
                />
-                <var name="maxLevelEdgeTop" type="integer" dimensions="nEdges" units=""
-                 description=""
+                <var name="maxLevelEdgeTop" type="integer" dimensions="nEdges" units="unitless"
+                 description="Index to the last edge in a column with active ocean cells on both sides of it."
                />
-                <var name="maxLevelEdgeBot" type="integer" dimensions="nEdges" units=""
-                 description=""
+                <var name="maxLevelEdgeBot" type="integer" dimensions="nEdges" units="unitless"
+                 description="Index to the last edge in a column with at least one active ocean cell on either side of it."
                />
-                <var name="maxLevelVertexTop" type="integer" dimensions="nVertices" units=""
-                 description=""
+                <var name="maxLevelVertexTop" type="integer" dimensions="nVertices" units="unitless"
+                 description="Index to the last vertex in a column with all active cells around it."
                />
-                <var name="maxLevelVertexBot" type="integer" dimensions="nVertices" units=""
-                 description=""
+                <var name="maxLevelVertexBot" type="integer" dimensions="nVertices" units="unitless"
+                 description="Index to the last vertex in a column with at least one active ocean cell around it."
                />
-                <var name="refBottomDepth" type="real" dimensions="nVertLevels" streams="iro" units=""
-                 description=""
+                <var name="refBottomDepth" type="real" dimensions="nVertLevels" streams="iro" units="m"
+                 description="Reference depth of ocean for each vertical level. Used in 'z-level' type runs."
                />
-                <var name="refBottomDepthTopOfCell" type="real" dimensions="nVertLevelsP1" units=""
-                 description=""
+                <var name="refBottomDepthTopOfCell" type="real" dimensions="nVertLevelsP1" units="m"
+                 description="Reference depth of ocean for each vertical interface. Used in 'z-level' type runs."
                />
-                <var name="hZLevel" type="real" dimensions="nVertLevels" streams="iro" units=""
-                 description=""
+                <var name="hZLevel" type="real" dimensions="nVertLevels" streams="iro" units="m"
+                        description="{\color{red} TO BE REMOVED}"
                />
-                <var name="vertCoordMovementWeights" type="real" dimensions="nVertLevels" streams="iro" units=""
-                 description=""
+                <var name="vertCoordMovementWeights" type="real" dimensions="nVertLevels" streams="iro" units="unitless"
+                 description="Weights used for distribution of sea surface heigh purturbations through multiple vertical levels."
                />
-                <var name="boundaryEdge" type="integer" dimensions="nVertLevels nEdges" units=""
-                 description=""
+                <var name="boundaryEdge" type="integer" dimensions="nVertLevels nEdges" units="unitless"
+                 description="Mask for determining boundary edges. A boundary edge has only one active ocean cell neighboring it."
                />
-                <var name="boundaryVertex" type="integer" dimensions="nVertLevels nVertices" units=""
-                 description=""
+                <var name="boundaryVertex" type="integer" dimensions="nVertLevels nVertices" units="unitless"
+                 description="Mask for determining boundary vertices. A boundary vertex has at least one inactive cell neighboring it."
                />
-                <var name="boundaryCell" type="integer" dimensions="nVertLevels nCells" units=""
-                 description=""
+                <var name="boundaryCell" type="integer" dimensions="nVertLevels nCells" units="unitless"
+                 description="Mask for determining boundary cells. A boundary cell has at least one inactive cell neighboring it."
                />
-                <var name="edgeMask" type="integer" dimensions="nVertLevels nEdges" streams="o" units=""
-                 description=""
+                <var name="edgeMask" type="integer" dimensions="nVertLevels nEdges" streams="o" units="unitless"
+                 description="Mask on edges that determines if computations should be done on edge."
                />
-                <var name="vertexMask" type="integer" dimensions="nVertLevels nVertices" streams="o" units=""
-                 description=""
+                <var name="vertexMask" type="integer" dimensions="nVertLevels nVertices" streams="o" units="unitless"
+                 description="Mask on vertices that determines if computations should be done on vertice."
                />
-                <var name="cellMask" type="integer" dimensions="nVertLevels nCells" streams="o" units=""
-                 description=""
+                <var name="cellMask" type="integer" dimensions="nVertLevels nCells" streams="o" units="unitless"
+                 description="Mask on cells that determines if computations should be done on cell."
                />
-                <var name="u_src" type="real" dimensions="nVertLevels nEdges" streams="ir" units=""
-                 description=""
+                <var name="u_src" type="real" dimensions="nVertLevels nEdges" streams="ir" units="N m^{-2}"
+                 description="Velocity forcing field. Defines a forcing at an edge."
                />
-                <var name="temperatureRestore" type="real" dimensions="nCells" streams="ir" units=""
-                 description=""
+                <var name="temperatureRestore" type="real" dimensions="nCells" streams="ir" units="^\circ C"
+                 description="Temperature restoring field, for restoring temperature at the surface."
                />
-                <var name="salinityRestore" type="real" dimensions="nCells" streams="ir" units=""
-                 description=""
+                <var name="salinityRestore" type="real" dimensions="nCells" streams="ir" units="PSU"
+                 description="Salinity restoring field, for restoring salinity at the surface."
                />
-                <var name="windStressMonthly" type="real" dimensions="nMonths nEdges" streams="ir" units=""
-                 description=""
+                <var name="windStressMonthly" type="real" dimensions="nMonths nEdges" streams="ir" units="N m^{-2}"
+                 description="Monthly wind stress field, defined at the surface for use in monthly forcing."
                />
-                <var name="temperatureRestoreMonthly" type="real" dimensions="nMonths nCells" streams="ir" units=""
-                 description=""
+                <var name="temperatureRestoreMonthly" type="real" dimensions="nMonths nCells" streams="ir" units="^\circ C"
+                 description="Monthly temperature restorying field, defined at the surface for use in monthly forcing."
                />
-                <var name="salinityRestoreMonthly" type="real" dimensions="nMonths nCells" streams="ir" units=""
-                 description=""
+                <var name="salinityRestoreMonthly" type="real" dimensions="nMonths nCells" streams="ir" units="PSU"
+                 description="Monthly salinity resotring field, defined at the surface, for use in monthly forcing."
                />
-                <var name="edgeSignOnCell" type="integer" dimensions="maxEdges nCells" units=""
-                 description=""
+                <var name="edgeSignOnCell" type="integer" dimensions="maxEdges nCells" units="unitless"
+                 description="Sign of edge contributions to a cell for each edge on cell. Used for bit-reproducible loops. Represents directionality of vector connecting cells."
                />
-                <var name="edgeSignOnVertex" type="integer" dimensions="maxEdges nVertices" units=""
-                 description=""
+                <var name="edgeSignOnVertex" type="integer" dimensions="maxEdges nVertices" units="unitless"
+                 description="Sign of edge contributions to a vertex for each edge on vertex. Used for bit-reproducible loops. Represents directionality of vector connecting vertices."
                />
-                <var name="kiteIndexOnCell" type="integer" dimensions="maxEdges nCells" units=""
-                 description=""
+                <var name="kiteIndexOnCell" type="integer" dimensions="maxEdges nCells" units="unitless"
+                 description="Index of kite in dual grid, based on verticesOnCell."
                />
-                <var name="seaSurfacePressure" type="real" dimensions="nCells Time" streams="ir" units=""
-                 description=""
+                <var name="seaSurfacePressure" type="real" dimensions="nCells Time" streams="ir" units="Pa"
+                 description="Pressure defined at the sea surface."
                />
        </var_struct>
        <var_struct name="tend" time_levs="1">
</font>
</pre>