core
/
eccodes
mirror of https://github.com/ecmwf/eccodes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GRIB-322 documentation: grib nearest units/formula

This commit is contained in:
Shahram Najm 2014-12-18 13:47:14 +00:00
parent 8892ba4491
commit f951032889
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
fortran/grib_f90_head.f90
View File

@ -73,7 +73,7 @@ module grib_api
!> The value in the nearest point (or the four nearest points) is returned as well as the
!> zero based index (which can be used in @ref grib_get_element)
!> and its distance from the given point using the following
!> formula (acos(sin(lat1)*sin(lat2)+cos(lat1)*cos(lat2)*cos(lon1-lon2))).
!> formula radius * acos( sin(lat1)*sin(lat2)+cos(lat1)*cos(lat2)*cos(lon1-lon2) ).
!>
!> If the is_lsm flag is .true. the input field gribid is considered as
!> a land sea mask and the nearest land point is returned.\n
@ -100,7 +100,7 @@ module grib_api
!> @param[in] inlon longitudes of the point in degrees
!> @param[out] outlat latitude of the nearest point in degrees
!> @param[out] outlon longitude of the nearest point in degrees
!> @param[out] distance distance between the given point and its nearest
!> @param[out] distance distance between the given point and its nearest (in km)
!> @param[out] index zero based index
!> @param[out] value value of the field in the nearest point
!> @param[out] status GRIB_SUCCESS if OK, integer value on error

4
src/grib_api.h
View File

@ -656,7 +656,8 @@ grib_nearest* grib_nearest_new (grib_handle* h, int* error);
* The flags are provided to speed up the process of searching. If you are
* sure that the point you are asking for is not changing from a call
* to another you can use GRIB_NEAREST_SAME_POINT. The same is valid for
* the grid. Flags can be used together doing an or.
* the grid. Flags can be used together doing a bitwise OR.
* The distances are given in kilometres.
*
* @param nearest : nearest structure
* @param h : handle from which geography and data values are taken
@ -693,6 +694,7 @@ int grib_nearest_delete (grib_nearest *nearest);
* If the flag is_lsm is 0 the nearest point is returned.
* values, distances, indexes (in the "values" array) for the nearest points (ilons,ilats)
* are returned.
* The distances are given in kilometres.
*
* @param h : handle from which geography and data values are taken
* @param is_lsm : lsm flag (1-> nearest land, 0-> nearest)