[Dart-dev] [4337] DART/trunk/location: Add units to the location_mod doc for threed-sphere saying that maxdist
nancy at ucar.edu
nancy at ucar.edu
Fri Apr 2 15:06:27 MDT 2010
Revision: 4337
Author: nancy
Date: 2010-04-02 15:06:26 -0600 (Fri, 02 Apr 2010)
Log Message:
-----------
Add units to the location_mod doc for threed-sphere saying that maxdist
and the return from get_dist() are in radians. (it never said what
the units were anywhere). also change spelling in prompts from
'co-ordinates' to 'coordinates' in location_mod interactive routines.
Modified Paths:
--------------
DART/trunk/location/annulus/location_mod.f90
DART/trunk/location/column/location_mod.f90
DART/trunk/location/threed_sphere/location_mod.f90
DART/trunk/location/threed_sphere/location_mod.html
-------------- next part --------------
Modified: DART/trunk/location/annulus/location_mod.f90
===================================================================
--- DART/trunk/location/annulus/location_mod.f90 2010-04-02 15:00:43 UTC (rev 4336)
+++ DART/trunk/location/annulus/location_mod.f90 2010-04-02 21:06:26 UTC (rev 4337)
@@ -458,22 +458,22 @@
endif
endif
-write(*, *)'Vertical co-ordinate options'
+write(*, *)'Vertical coordinate options'
write(*, *)'-1 -> surface, 1 -> model level, 3 -> depth'
100 read(*, *) location%which_vert
if(location%which_vert == VERTISLEVEL ) then
- write(*, *) 'Vertical co-ordinate model level'
+ write(*, *) 'Vertical coordinate model level'
read(*, *) location%vloc
else if(location%which_vert == VERTISHEIGHT ) then
- write(*, *) 'Vertical co-ordinate depth (in negative m)'
+ write(*, *) 'Vertical coordinate depth (in negative m)'
read(*, *) location%vloc
do while (location%vloc > 0)
write(*, *) 'Depth must be negative (zero at top of fluid), please try again'
read(*, *) location%vloc
end do
else if(location%which_vert == VERTISSURFACE ) then
- write(*, *) 'Vertical co-ordinate surface pressure (in hPa)'
+ write(*, *) 'Vertical coordinate surface pressure (in hPa)'
read(*, *) location%vloc
location%vloc = 100.0 * location%vloc
else
Modified: DART/trunk/location/column/location_mod.f90
===================================================================
--- DART/trunk/location/column/location_mod.f90 2010-04-02 15:00:43 UTC (rev 4336)
+++ DART/trunk/location/column/location_mod.f90 2010-04-02 21:06:26 UTC (rev 4337)
@@ -387,7 +387,7 @@
endif
endif
-write(*, *)'Vertical co-ordinate options'
+write(*, *)'Vertical coordinate options'
write(*, *)VERTISUNDEF,' --> vertical coordinate undefined'
write(*, *)VERTISSURFACE,' --> surface'
write(*, *)VERTISLEVEL,' --> model level'
@@ -396,17 +396,17 @@
100 read(*, *) location%which_vert
if(location%which_vert == VERTISLEVEL ) then
- write(*, *) 'Vertical co-ordinate model level'
+ write(*, *) 'Vertical coordinate model level'
read(*, *) location%vloc
else if(location%which_vert == VERTISPRESSURE ) then
- write(*, *) 'Vertical co-ordinate Pressure (in hPa)'
+ write(*, *) 'Vertical coordinate Pressure (in hPa)'
read(*, *) location%vloc
location%vloc = 100.0_r8 * location%vloc
else if(location%which_vert == VERTISHEIGHT ) then
- write(*, *) 'Vertical co-ordinate height (in gpm)'
+ write(*, *) 'Vertical coordinate height (in gpm)'
read(*, *) location%vloc
else if(location%which_vert == VERTISSURFACE ) then
- write(*, *) 'Vertical co-ordinate surface height'
+ write(*, *) 'Vertical coordinate surface height'
read(*, *) location%vloc
else if(location%which_vert == VERTISUNDEF ) then
location%vloc = 0.0_r8
Modified: DART/trunk/location/threed_sphere/location_mod.f90
===================================================================
--- DART/trunk/location/threed_sphere/location_mod.f90 2010-04-02 15:00:43 UTC (rev 4336)
+++ DART/trunk/location/threed_sphere/location_mod.f90 2010-04-02 21:06:26 UTC (rev 4337)
@@ -229,7 +229,9 @@
function get_dist(loc1, loc2, kind1, kind2, no_vert)
-! Distance depends on only horizontal distance or both horizontal and vertical distance.
+! returns the distance between 2 locations in units of radians.
+! Distance depends on only horizontal distance or both horizontal and
+! vertical distance.
! The choice is determined by horiz_dist_only and the which_vert of loc1.
! May want to allow return of some joint distance in the long run?
! Or just a distance that is a function of all 3 things.
@@ -237,8 +239,8 @@
! However, this behavior can be over-ridden by the no_vert optional argument.
! If set to false, this will always do full 3d distance if possible. If set to
! true it will never do the full 3d distance. At present asking to do a vertical
-! distance computation for incompatible vertical location types results in a fatal
-! error.
+! distance computation for incompatible vertical location types results
+! in a fatal error.
! The kinds are available if a more sophisticated distance computation is required.
! This generic code does not use the kinds, but several model_mods intercept this
@@ -693,7 +695,7 @@
endif
endif
-write(*, *)'Vertical co-ordinate options'
+write(*, *)'Vertical coordinate options'
write(*, *)VERTISUNDEF,' --> vertical coordinate undefined'
write(*, *)VERTISSURFACE,' --> surface'
write(*, *)VERTISLEVEL,' --> model level'
@@ -702,21 +704,21 @@
100 read(*, *) location%which_vert
if(location%which_vert == VERTISLEVEL ) then
- write(*, *) 'Vertical co-ordinate model level'
+ write(*, *) 'Vertical coordinate model level'
read(*, *) location%vloc
else if(location%which_vert == VERTISPRESSURE ) then
- write(*, *) 'Vertical co-ordinate Pressure (in hPa)'
+ write(*, *) 'Vertical coordinate Pressure (in hPa)'
read(*, *) location%vloc
location%vloc = 100.0 * location%vloc
else if(location%which_vert == VERTISHEIGHT ) then
- write(*, *) 'Vertical co-ordinate height (in gpm)'
+ write(*, *) 'Vertical coordinate height (in gpm)'
read(*, *) location%vloc
else if(location%which_vert == VERTISSURFACE ) then
! most 3d sphere users want height in meters, not pressure.
! original code asked for pressure:
- !write(*, *) 'Vertical co-ordinate surface pressure (in hPa)'
+ !write(*, *) 'Vertical coordinate surface pressure (in hPa)'
!location%vloc = 100.0 * location%vloc ! only applies to pressure
- write(*, *) 'Vertical co-ordinate height'
+ write(*, *) 'Vertical coordinate height'
read(*, *) location%vloc
else if(location%which_vert == VERTISUNDEF ) then
! a valid floating point value, but should be unused.
Modified: DART/trunk/location/threed_sphere/location_mod.html
===================================================================
--- DART/trunk/location/threed_sphere/location_mod.html 2010-04-02 15:00:43 UTC (rev 4336)
+++ DART/trunk/location/threed_sphere/location_mod.html 2010-04-02 21:06:26 UTC (rev 4337)
@@ -505,11 +505,13 @@
<!-- Description -->
<P>
-Sets the threshhold distance.
+Sets the threshhold distance. <em class=code>maxdist</em> is in
+units of radians.
Anything closer than this is deemed to be close.
This routine must be called first, before the other
<em class=code>get_close</em> routines.
-It allocates space so it is necessary to call <em class=code>get_close_obs_destroy</em>
+It allocates space so it is necessary to call
+<em class=code>get_close_obs_destroy</em>
when completely done with getting distances between locations.
</P>
@@ -517,7 +519,7 @@
<TR><TD valign=top><em class=code>gc</em></TD>
<TD>Data for efficiently finding close locations.</TD></TR>
<TR><TD valign=top><em class=code>maxdist</em></TD>
- <TD>Anything closer than this distance is a close location.</TD></TR>
+ <TD>Anything closer than this number of radians is a close location.</TD></TR>
</TABLE>
</div>
@@ -676,7 +678,8 @@
<!-- Description -->
<P>
-Returns the distance between two locations. If <em class=code>horiz_dist_only</em>
+Returns the distance between two locations in radians.
+If <em class=code>horiz_dist_only</em>
is set to .TRUE. in the locations namelist, it computes great circle
distance on sphere.
If <em class=code>horiz_dist_only</em> is false, then it
More information about the Dart-dev
mailing list