[Dart-dev] DART/branches Revision: 13035

[dart at ucar.edu]

thoar at ucar.edu
2019-03-20 10:41:05 -0600 (Wed, 20 Mar 2019)
259
Added documentation for get_maxdist() and revamped sections
on get_close_init(), removed references to get_close_obs_init, etc.
This documentation is still out-of-date, but since we are moving to
a doxygen-like system, updating this seems to be inefficient.




Modified: DART/branches/recam/assimilation_code/location/threed_sphere/location_mod.f90
===================================================================
--- DART/branches/recam/assimilation_code/location/threed_sphere/location_mod.f90	2019-03-19 23:21:12 UTC (rev 13034)
+++ DART/branches/recam/assimilation_code/location/threed_sphere/location_mod.f90	2019-03-20 16:41:05 UTC (rev 13035)
@@ -2010,6 +2010,9 @@
 end function find_del_lon
 
 !---------------------------------------------------------------------------
+!> returns the maximum distance for the cutoff specified for the 
+!> observation type of interest.
+!> May be useful in custom 'get_close' applications.
 
 function get_maxdist(gc, obs_type)
 type(get_close_type), intent(in) :: gc

Modified: DART/branches/recam/assimilation_code/location/threed_sphere/location_mod.html
===================================================================
--- DART/branches/recam/assimilation_code/location/threed_sphere/location_mod.html	2019-03-19 23:21:12 UTC (rev 13034)
+++ DART/branches/recam/assimilation_code/location/threed_sphere/location_mod.html	2019-03-20 16:41:05 UTC (rev 13035)
@@ -41,7 +41,7 @@
 <P>
 The DART framework needs to be able to compute distances
 between locations, to pass location information to and from the
-model interface code (model_mod.f90), and to be able to
+model interface code (<em class=file>model_mod.f90</em>), and to be able to
 read and write location information to files.
 DART isolates all this location information into separate modules 
 so that the main algorithms can operate with the same code independent
@@ -73,7 +73,7 @@
 The location routines are general purpose code that can be used
 for a variety of utilities.  The following discussion is specifically
 restricted to how the location namelist settings affect the
-execution of the <em class=file>filter</em> assimilation program.
+execution of the <em class=program>filter</em> assimilation program.
 </P>
 
 <P>
@@ -89,7 +89,7 @@
 
 <P>
 Issues related to changing the results of an assimilation based on 
-code in the model-specific <em class=code>model_mod.f90</em> module:<br />
+code in the model-specific <em class=file>model_mod.f90</em> module:<br />
 <UL>
 <LI>Whether the model-specific code needs to convert vertical coordinates.</LI>
 <LI>Whether the model-specific code alters the distances in some other way.</LI>
@@ -169,7 +169,7 @@
 If the model supports either a different vertical coordinate than
 the vertical coordinate of the observations, or if the user wants to
 localize in a different vertical coordinate than the observations
-or state vector items, the model-specific <em class=code>model_mod.f90</em> 
+or state vector items, the model-specific <em class=file>model_mod.f90</em> 
 code will have to provide a conversion between different vertical coordinates.
 This cannot be done by the location module since most vertical
 conversions require additional model-specific information such
@@ -197,7 +197,7 @@
 <P>
 The calls to routines that collect the distances between locations
 for the assimilation code pass through
-the model-specific <em class=code>model_mod.f90</em> code.  This allows
+the model-specific <em class=file>model_mod.f90</em> code.  This allows
 the code to alter the actual distances to either increase or decrease the
 effect of an observation on the state or on other observations.
 </P>
@@ -257,7 +257,7 @@
 <P>
 Q: Why is the cutoff specified as half the distance to where
 the impact goes to 0, and why is it called 'cutoff'?<br />
-A: Because the original paper by Gaspari & Cohn used that
+A: Because the original paper by Gaspari & Cohn used that
 definition in this paper which our localization function is 
 based on.<br />
 Gaspari, G. and Cohn, S. E. (1999), Construction of correlation 
@@ -295,9 +295,9 @@
 the state is not the same as the desired vertical localization type,
 they must also be converted using a convert_vertical_state() routine.
 </P>
+<br />
+<P><!-- space so the 'top' aligns correctly --></P>
 
-<br /><br />
-
 <!--=====================================================================-->
 <!--===================== DESCRIPTION OF A NAMELIST =====================-->
 <!--=====================================================================-->
@@ -472,10 +472,8 @@
 </TABLE>
 </div>
 
-<br />
-<br />
+<P><!-- space so the 'top' aligns correctly --></P>
 
-
 <!--=====================================================================-->
 <!--===================== DISCUSSION ====================================-->
 <!--=====================================================================-->
@@ -535,25 +533,24 @@
 </P>
 <pre>
 <em class=code>