! Copyright 2005-2007 ECMWF
!
! Licensed under the GNU Lesser General Public License which
! incorporates the terms and conditions of version 3 of the GNU
! General Public License.
! See LICENSE and gpl-3.0.txt for details.
!
!
!> Module grib_api
!>
!> The grib_api module provides the Fortran 90 interface of the GRIB API.
module grib_api
implicit none
include "grib_kinds.h"
include "grib_api_constants.h"
include "grib_api_externals.h"
include "grib_api_visibility.h"
!> Get the distinct values of the key in argument contained in the index. The key must belong to the index.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key for wich the values are returned
!> @param values array of values. The array must be allocated before entering this function and its size must be enough to contain all the values.
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_index_get
module procedure grib_index_get_int, &
grib_index_get_long, &
grib_index_get_string, &
grib_index_get_real8
end interface grib_index_get
!> Get the number of distinct values of the key in argument contained in the index. The key must belong to the index.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key for which the number of values is computed
!> @param size number of distinct values of the key in the index
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_index_get_size
module procedure grib_index_get_size_int, &
grib_index_get_size_long
end interface grib_index_get_size
!> Select the message subset with key==value.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key to be selected
!> @param value value of the key to select
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_index_select
module procedure grib_index_select_int, &
grib_index_select_long, &
grib_index_select_string, &
grib_index_select_real8
end interface grib_index_select
!> Create a new message in memory from an integer or character array containting the coded message.
!>
!> The message can be accessed through its gribid and it will be available\n
!> until @ref grib_release is called. A reference to the original coded\n
!> message is kept in the new message structure.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> \b Examples: \ref copy_message.f90 "copy_message.f90"
!>
!> @param gribid id of the grib loaded in memory
!> @param message array containing the coded message
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_new_from_message
module procedure grib_new_from_message_int4
module procedure grib_new_from_message_char
end interface grib_new_from_message
!> Reads a message in the buffer array from the file opened with grib_open_file.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_read_from_file
module procedure grib_read_from_file_int4
module procedure grib_read_from_file_char
end interface grib_read_from_file
!> Reads nbytes bytes into the buffer from a file opened with grib_open_file.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_read_bytes
module procedure grib_read_bytes_int4
module procedure grib_read_bytes_char
module procedure grib_read_bytes_real8
module procedure grib_read_bytes_real4
end interface grib_read_bytes
!> Write nbytes bytes from the buffer in a file opened with grib_open_file.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be written
!> @param nbytes number of bytes to be written
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_write_bytes
module procedure grib_write_bytes_int4
module procedure grib_write_bytes_char
module procedure grib_write_bytes_real8
module procedure grib_write_bytes_real4
end interface grib_write_bytes
!> Get the value for a key from a grib message.
!>
!> Given a \em gribid and \em key as input a \em value for the \em key is returned.
!> In some cases the \em value can be an array rather than a scalar.
!> As examples of array keys we have "values","pl", "pv" respectively the data values,
!> the list of number of points for each latitude in a reduced grid and the list of
!> vertical levels. In these cases the \em value array must be allocated by the caller
!> and their required dimension can be obtained with \ref grib_get_size. \n
!> The \em value can be integer(4), real(4), real(8), character.
!> Although each key has its own native type, a key of type integer
!> can be retrieved (with \ref grib_get) as real(4), real(8) or character.
!> Analogous conversions are always provided when possible.
!> Illegal conversions are real to integer and character to any other type.
!>
!> The \em gribid references to a grib message loaded in memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref get.f90 "get.f90", \ref print_data.f90 "print_data.f90"
!>
!> @see grib_new_from_file, grib_release, grib_set
!>
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8),character
!> @param[out] status GRIB_SUCCESS if OK, integer value on error
interface grib_get
module procedure grib_get_int, &
grib_get_long, &
grib_get_real4, &
grib_get_real8, &
grib_get_string, &
grib_get_int_array, &
grib_get_real4_array, &
grib_get_real8_array
end interface grib_get
!> Get the size of an array key.
!>
!> To get the size of a key representing an array.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key name of the key
!> @param size size of the array key
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_get_size
module procedure grib_get_size_int, &
grib_get_size_long
end interface grib_get_size
!> Set the value for a key in a grib message.
!>
!> The given \em value is set for the \em key in the \em gribid message.
!> In some cases the \em value can be an array rather than a scalar.
!> As examples of array keys we have "values","pl", "pv" respectively the data values,
!> the list of number of points for each latitude in a reduced grid and the list of
!> vertical levels. In these cases the \em value array must be allocated by the caller
!> and their required dimension can be obtained with \ref grib_get_size. \n
!> The gribid references to a grib message loaded in memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref set.f90 "set.f90"
!>
!> @see grib_new_from_file, grib_release, grib_get
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8)
!> @param[out] status GRIB_SUCCESS if OK, integer value on error
interface grib_set
module procedure grib_set_int, &
grib_set_long, &
grib_set_real4, &
grib_set_real8, &
grib_set_string, &
grib_set_int_array, &
grib_set_long_array, &
grib_set_real4_array, &
grib_set_real8_array
end interface grib_set
!> Get a value of specified index from an array key.
!>
!> Given a gribid and key name as input a value corresponding to the given index
!> is returned. The index is zero based i.e. the first element has
!> zero index, the second element index one and so on.
!> If the parameter index is an array all the values correspondig to the indexes
!> list is returned.
!> The gribid references to a grib message loaded in memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref nearest.f90 "nearest.f90"
!>
!> @see grib_new_from_file, grib_release, grib_get
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[in] index index can be a scalar or array of integer(4)
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8)
!> @param[out] status GRIB_SUCCESS if OK, integer value on error
interface grib_get_element
module procedure grib_get_real4_element, &
grib_get_real8_element, &
grib_get_real4_elements, &
grib_get_real8_elements
end interface grib_get_element
!> Find the nearest point/points of a given latitude/longitude point.
!>
!> 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))).
!>
!> 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
!> The nearest land point among the four neighbours is:
!> - the nearest point with land sea mask value >= 0.5
!> - the nearest without any other condition if all the four have land sea mask value <0.5.
!>
!> Arrays (real(8)) of latitude/longitude can be provided to find with one call
!> the values,indexes and distances for all the lat/lon points listed in the arrays.
!>
!> If a single latitude/longitude point is provided and outlat,outlon,value,distance,index
!> are defined as arrays with four elements the lat/lon coordinates and values, distances
!> and indexes of the four nearest points are returned.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref nearest.f90 "nearest.f90"
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] is_lsm .true. if the nearest land point is required otherwise .false.
!> @param[in] inlat latitude of the point in degrees
!> @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] 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
interface grib_find_nearest
module procedure grib_find_nearest_single, &
grib_find_nearest_four_single, &
grib_find_nearest_multiple
end interface grib_find_nearest
!> Get latitude/longitude and data values.
!>
!> Latitudes, longitudes, data values arrays are returned.
!> They must be properly allocated by the caller and their required
!> dimension can be obtained with \ref grib_get_size or by getting (with \ref grib_get)
!> the value of the integer key "numberOfPoints".
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref get_data.f90 "get_data.f90"
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[out] lats latitudes array with dimension "size"
!> @param[out] lons longitudes array with dimension "size"
!> @param[out] values data values array with dimension "size"
!> @param[out] status GRIB_SUCCESS if OK, integer value on error
interface grib_get_data
module procedure grib_get_data_real4, &
grib_get_data_real8
end interface grib_get_data
contains
!> Set as missing the value for a key in a grib message.
!>
!> It can be used to set a missing value in the grib header but not in \n
!> the data values. To set missing data values see the bitmap examples.\n
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref set_missing.f90 "set_missing.f90"
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_missing ( gribid, key, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_set_missing ( gribid, key )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set_missing','('//key//')')
endif
end subroutine grib_set_missing
!> Create a new index form a file. The file is indexed with the keys in argument.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of the newly created index
!> @param filename name of the file of messages to be indexed
!> @param keys : comma separated list of keys for the index. The type of the key can be explicitly declared appending :l for long, :d for double, :s for string to the key name. If the type is not declared explicitly, the native type is assumed.
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_create ( indexid, filename, keys, status )
integer(kind=kindOfInt), intent(inout) :: indexid
character(len=*), intent(in) :: filename
character(len=*), intent(in) :: keys
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_new_from_file(filename,keys,indexid)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_create_index','('//filename//')')
endif
end subroutine grib_index_create
!> Add a file to an index.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of the index I want to add a file to
!> @param filename name of the file I want to add to the index
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_add_file ( indexid, filename, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: filename
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_add_file(indexid,filename)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_add_file','('//filename//')')
endif
end subroutine grib_index_add_file
!> Get the number of distinct values of the key in argument contained in the index. The key must belong to the index.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key for which the number of values is computed
!> @param size number of distinct values of the key in the index
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_get_size_long( indexid, key, size, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
integer(kind=kindOfLong), intent(out) :: size
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_get_size_long(indexid,key,size)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_get_size','('//key//')')
endif
end subroutine grib_index_get_size_long
!> Get the number of distinct values of the key in argument contained in the index. The key must belong to the index.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key for which the number of values is computed
!> @param size number of distinct values of the key in the index
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_get_size_int( indexid, key, size, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), intent(out) :: size
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_get_size_int(indexid,key,size)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_get_size','('//key//')')
endif
end subroutine grib_index_get_size_int
!> Get the distinct values of the key in argument contained in the index. The key must belong to the index. This function is used when the type of the key was explicitly defined as long or when the native type of the key is long.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key for wich the values are returned
!> @param values array of values. The array must be allocated before entering this function and its size must be enough to contain all the values.
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_get_int( indexid, key, values, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), dimension(:), intent(out) :: values
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(values)
iret=grib_f_index_get_int ( indexid, key, values , nb_values )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_get','('//key//')')
endif
end subroutine grib_index_get_int
!> Get the distinct values of the key in argument contained in the index. The key must belong to the index. This function is used when the type of the key was explicitly defined as long or when the native type of the key is long.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key for wich the values are returned
!> @param values array of values. The array must be allocated before entering this function and its size must be enough to contain all the values.
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_get_long( indexid, key, values, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
integer(kind=kindOfLong), dimension(:), intent(out) :: values
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(values)
iret=grib_f_index_get_long ( indexid, key, values , nb_values )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_get','('//key//')')
endif
end subroutine grib_index_get_long
!> Get the distinct values of the key in argument contained in the index. The key must belong to the index. This function is used when the type of the key was explicitly defined as long or when the native type of the key is long.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key for wich the values are returned
!> @param values array of values. The array must be allocated before entering this function and its size must be enough to contain all the values.
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_get_real8( indexid, key, values, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
real(kind=kindOfDouble), dimension(:), intent(out) :: values
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(values)
iret=grib_f_index_get_real8 ( indexid, key, values , nb_values )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_get','('//key//')')
endif
end subroutine grib_index_get_real8
!> Get the distinct values of the key in argument contained in the index.
!> The key must belong to the index.
!> This function is used when the type of the key was explicitly defined as string or when the native type of the key is string.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key for wich the values are returned
!> @param values array of values. The array must be allocated before entering this function and its size must be enough to contain all the values.
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_get_string( indexid, key, values, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
character(len=*), dimension(:), intent(out) :: values
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
integer(kind=kindOfInt) :: size_value
size_value = len(values(1))
nb_values = size(values)
iret=grib_f_index_get_string ( indexid, key, values , size_value,nb_values )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_get','('//key//')')
endif
end subroutine grib_index_get_string
!> Select the message subset with key==value. The value is a integer.
!> The key must have been created with string type or have string as native type if the type was not explicitly defined in the index creation.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key to be selected
!> @param value value of the key to select
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_select_string( indexid, key, value, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
character(len=*), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_select_string ( indexid, key, value )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_select','('//key//')')
endif
end subroutine grib_index_select_string
!> Select the message subset with key==value. The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key to be selected
!> @param value value of the key to select
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_select_int( indexid, key, value, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_select_int ( indexid, key, value )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_select','('//key//')')
endif
end subroutine grib_index_select_int
!> Select the message subset with key==value. The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key to be selected
!> @param value value of the key to select
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_select_long( indexid, key, value, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
integer(kind=kindOfLong), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_select_long ( indexid, key, value )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_select','('//key//')')
endif
end subroutine grib_index_select_long
!> Select the message subset with key==value. The value is a real. The key must have been created with real type or have real as native type if the type was not explicitly defined in the index creation.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file. The index must have been created with the key in argument.
!> @param key key to be selected
!> @param value value of the key to select
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_select_real8( indexid, key, value, status )
integer(kind=kindOfInt), intent(in) :: indexid
character(len=*), intent(in) :: key
real(kind=kindOfDouble), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_select_real8 ( indexid, key, value )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_select','('//key//')')
endif
end subroutine grib_index_select_real8
!> Create a new handle from an index after having selected the key values.
!> All the keys belonging to the index must be selected before calling this function. Successive calls to this function will return all the handles compatible with the constraints defined selecting the values of the index keys.
!> When no more handles are available from the index a NULL pointer is returned and the err variable is set to GRIB_END_OF_INDEX.
!>
!> The message can be accessed through its gribid and it will be available\n
!> until @ref grib_release is called.\n
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of an index created from a file.
!> @param gribid id of the grib loaded in memory
!> @param status GRIB_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code
subroutine grib_new_from_index ( indexid, gribid , status)
integer(kind=kindOfInt),intent(in) :: indexid
integer(kind=kindOfInt),intent(out) :: gribid
integer(kind=kindOfInt),optional,intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_new_from_index( indexid, gribid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_new_from_index','')
endif
end subroutine grib_new_from_index
!> Load an index file previously created with @ref grib_index_write.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of loaded index
!> @param filename name of the index file to load
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_read ( indexid, filename, status )
integer(kind=kindOfInt), intent(inout) :: indexid
character(len=*), intent(in) :: filename
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_read(filename,indexid)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_read','('//filename//')')
endif
end subroutine grib_index_read
!> Saves an index to a file for later reuse. Index files can be read with
!> @ref grib_index_read.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref index.f90 "index.f90"
!>
!> @param indexid id of the index to save to file
!> @param filename name of file to save the index to
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_write ( indexid, filename, status )
integer(kind=kindOfInt), intent(inout) :: indexid
character(len=*), intent(in) :: filename
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_write(indexid,filename)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_write','('//filename//')')
endif
end subroutine grib_index_write
!> Delete the index.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param indexid id of an index created from a file.
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_index_release ( indexid, status )
integer(kind=kindOfInt), intent(in) :: indexid
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_index_release ( indexid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_index_release','')
endif
end subroutine grib_index_release
!> Open a file according to a mode.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref get.f90 "get.f90"
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param filename name of the file to be open
!> @param mode open mode can be 'r' (read only) or 'w' (write only)
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_open_file ( ifile, filename, mode, status )
integer(kind=kindOfInt),intent(out) :: ifile
character(len=*), intent(in) :: filename
character(LEN=*), intent(in) :: mode
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_open_file(ifile, filename, mode )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_open_file','('//filename//')')
endif
end subroutine grib_open_file
!> Reads nbytes bytes into the buffer from a file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer binary buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_read_bytes_char ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
character(len=1),dimension(:), intent(out) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_read_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_read_bytes','')
endif
end subroutine grib_read_bytes_char
!> Reads nbytes bytes into the buffer from a file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_read_bytes_int4 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=4),dimension(:), intent(out) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_read_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_read_bytes','')
endif
end subroutine grib_read_bytes_int4
!> Reads nbytes bytes into the buffer from a file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_read_bytes_real4 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
real(kind=4),dimension(:), intent(out) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_read_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_read_bytes','')
endif
end subroutine grib_read_bytes_real4
!> Reads nbytes bytes into the buffer from a file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_read_bytes_real8 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
real(kind=8),dimension(:), intent(out) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_read_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_read_bytes','')
endif
end subroutine grib_read_bytes_real8
!> Reads a message in the buffer array from the file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer binary buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_read_from_file_int4 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=4),dimension(:), intent(out) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_read_any_from_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_read_from_file','')
endif
end subroutine grib_read_from_file_int4
!> Reads a message in the buffer array from the file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer binary buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_read_from_file_real4 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
real(kind=4),dimension(:), intent(out) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_read_any_from_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_read_from_file','')
endif
end subroutine grib_read_from_file_real4
!> Reads a message in the buffer array from the file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer binary buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_read_from_file_real8 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
real(kind=8),dimension(:), intent(out) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_read_any_from_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_read_from_file','')
endif
end subroutine grib_read_from_file_real8
!> Reads a message in the buffer array from the file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_read_from_file_char ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
character(len=1),dimension(:), intent(out) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_read_any_from_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_read_from_file','')
endif
end subroutine grib_read_from_file_char
!> Write nbytes bytes from the buffer in a file opened with grib_open_file.
!>
!> Write nbytes bytes from the buffer in a file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be written
!> @param nbytes number of bytes to be written
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_write_bytes_char ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
character(len=1), dimension(:),intent(in) :: buffer
integer(kind=kindOfInt), intent(in) :: nbytes
integer(kind=kindOfInt),optional,intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_write_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_write_bytes','')
endif
end subroutine grib_write_bytes_char
!> Write nbytes bytes from the buffer in a file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be written
!> @param nbytes number of bytes to be written
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_write_bytes_int4 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=4), dimension(:),intent(in) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional,intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_write_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_write_bytes','')
endif
end subroutine grib_write_bytes_int4
!> Write nbytes bytes from the buffer in a file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be written
!> @param nbytes number of bytes to be written
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_write_bytes_real4 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
real(kind=4), dimension(:),intent(in) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional,intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_write_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_write_bytes','')
endif
end subroutine grib_write_bytes_real4
!> Write nbytes bytes from the buffer in a file opened with grib_open_file.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be written
!> @param nbytes number of bytes to be written
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_write_bytes_real8 ( ifile, buffer, nbytes, status )
integer(kind=kindOfInt),intent(in) :: ifile
real(kind=8), dimension(:),intent(in) :: buffer
integer(kind=kindOfInt), intent(inout) :: nbytes
integer(kind=kindOfInt),optional,intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_write_file(ifile,buffer,nbytes)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_write_bytes','')
endif
end subroutine grib_write_bytes_real8
!> Close a file.
!>
!> If the \em fileid does not refer to an opened file an error code
!> is returned in status.\n
!>
!> \b Examples: \ref get.f90 "get.f90"
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param ifile is the id of the file to be closed.
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_close_file ( ifile , status )
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_close_file(ifile)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_close_file','')
endif
end subroutine grib_close_file
!> Counts the messages in a file
!>
!> \b Examples: \ref count_messages.f90 "count_messages.f90"
!>
!> @param ifile id of the file opened with @ref grib_open_file
!> @param n number of messages in the file
!> @param status GRIB_SUCCESS if OK or error code
subroutine grib_count_in_file ( ifile, n , status)
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=kindOfInt),intent(out) :: n
integer(kind=kindOfInt),optional,intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_count_in_file( ifile, n )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_count_in_file','')
endif
end subroutine grib_count_in_file
!> Load in memory only the headers of a grib message from a file.
!>
!> The message can be accessed through its gribid and it will be available\n
!> until @ref grib_release is called.\n
!>
!> \b Examples: \ref get.f90 "get.f90"
!>
!> @param ifile id of the file opened with @ref grib_open_file
!> @param gribid id of the grib loaded in memory
!> @param status GRIB_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code
subroutine grib_headers_only_new_from_file ( ifile, gribid , status)
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=kindOfInt),intent(out) :: gribid
integer(kind=kindOfInt),optional,intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_headers_only_new_from_file( ifile, gribid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_new_from_file','')
endif
end subroutine grib_headers_only_new_from_file
!> Load in memory a grib message from a file.
!>
!> The message can be accessed through its gribid and it will be available\n
!> until @ref grib_release is called.\n
!>
!> \b Examples: \ref get.f90 "get.f90"
!>
!> @param ifile id of the file opened with @ref grib_open_file
!> @param gribid id of the grib loaded in memory
!> @param status GRIB_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code
subroutine grib_new_from_file ( ifile, gribid , status)
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=kindOfInt),intent(out) :: gribid
integer(kind=kindOfInt),optional,intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_new_from_file( ifile, gribid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_new_from_file','')
endif
end subroutine grib_new_from_file
!> Create a new message in memory from a character array containting the coded message.
!>
!> The message can be accessed through its gribid and it will be available\n
!> until @ref grib_release is called. A reference to the original coded\n
!> message is kept in the new message structure.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> \b Examples: \ref copy_message.f90 "copy_message.f90"
!>
!> @param gribid id of the grib loaded in memory
!> @param message character array containing the coded message
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_new_from_message_char( gribid, message, status )
integer(kind=kindOfInt),intent(out) :: gribid
character(len=1), dimension(:),intent(in) :: message
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfSize_t) :: size_bytes
integer(kind=kindOfInt) :: iret
size_bytes=size(message,dim=1)
iret = grib_f_new_from_message ( gribid, message, size_bytes )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_new_from_message','')
endif
end subroutine grib_new_from_message_char
!> Create a new message in memory from an integer array containting the coded message.
!>
!> The message can be accessed through its gribid and it will be available\n
!> until @ref grib_release is called. A reference to the original coded\n
!> message is kept in the new message structure.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> \b Examples: \ref copy_message.f90 "copy_message.f90"
!>
!> @param gribid id of the grib loaded in memory
!> @param message integer array containing the coded message
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_new_from_message_int4 ( gribid, message, status )
integer(kind=kindOfInt),intent(out) :: gribid
integer(kind=4), dimension(:),intent(in) :: message
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfSize_t) :: size_bytes
integer(kind=kindOfInt) :: iret
size_bytes=size(message,dim=1)*sizeOfInteger4
iret = grib_f_new_from_message ( gribid, message, size_bytes )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_new_from_message','')
endif
end subroutine grib_new_from_message_int4
!> Create a new valid gribid from a sample contained in a samples directory pointed
!> by the environment variable GRIB_SAMPLES_PATH.
!> To know where the samples directory is run the grib_info tool.\n
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> \b Examples: \ref samples.f90 "samples.f90"
!>
!> @param gribid id of the grib loaded in memory
!> @param samplename name of the sample to be used
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_new_from_samples ( gribid, samplename, status )
integer(kind=kindOfInt), intent(out) :: gribid
character(len=*), intent(in) :: samplename
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_new_from_samples ( gribid, samplename )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_new_from_samples','('//samplename//')')
endif
end subroutine grib_new_from_samples
!> THIS FUNCTION IS DEPRECATED AND IT WILL DISAPPEAR FROM THE VERSION 2.0
!> Create a new valid gribid from a template.
!>
!> Valid templates are stored in the directory pointed by the\n
!> environment variable GRIB_TEMPLATES_PATH or in a templates\n
!> default directory if this variable is not defined.\n
!> To know where the templates directory is run the grib_info tool.\n
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> \b Examples: \ref template.f90 "template.f90"
!>
!> @param gribid id of the grib loaded in memory
!> @param templatename name of the template to be used
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_new_from_template ( gribid, templatename, status )
integer(kind=kindOfInt), intent(out) :: gribid
character(len=*), intent(in) :: templatename
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_new_from_template ( gribid, templatename )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_new_from_template','('//templatename//')')
endif
end subroutine grib_new_from_template
!> Free the memory for the message referred as gribid.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> \b Examples: \ref get.f90 "get.f90"
!>
!> @param gribid id of the grib loaded in memory
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_release ( gribid, status )
integer(kind=kindOfInt), intent(in) :: gribid
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_release ( gribid )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_release','')
endif
end subroutine grib_release
!> Create a copy of a message.
!>
!> Create a copy of a given message (\em gribid_src) giving a new\n
!> message in memory (\em gribid_dest) exactly identical to the original one.\n
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!> \b Examples: \ref clone.f90 "clone.f90"
!>
!> @param gribid_src grib to be cloned
!> @param gribid_dest new grib returned
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_clone ( gribid_src, gribid_dest, status )
integer(kind=kindOfInt), intent(in) :: gribid_src
integer(kind=kindOfInt), intent(out) :: gribid_dest
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_clone(gribid_src,gribid_dest)
if (iret /= 0) then
call grib_f_write_on_fail(gribid_src)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_clone','')
endif
end subroutine grib_clone
subroutine grib_util_sections_copy ( gribid_from, gribid_to, what, gribid_out,status )
integer(kind=kindOfInt), intent(in) :: gribid_from
integer(kind=kindOfInt), intent(in) :: gribid_to
integer(kind=kindOfInt), intent(out) :: gribid_out
integer(kind=kindOfInt), intent(in) :: what
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_util_sections_copy(gribid_from,gribid_to,what,gribid_out)
if (iret /= 0) then
call grib_f_write_on_fail(gribid_from)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_util_sections_copy','')
endif
end subroutine grib_util_sections_copy
!> Copy the value of all the keys belonging to a namespace from the source message
!> to the destination message
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!>
!>
!> @param gribid_src source message
!> @param gribid_dest destination message
!> @param namespace namespace to be copied
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_copy_namespace ( gribid_src, namespace, gribid_dest, status )
integer(kind=kindOfInt), intent(in) :: gribid_src
integer(kind=kindOfInt), intent(in) :: gribid_dest
character(LEN=*), intent(in) :: namespace
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_copy_namespace(gribid_src,namespace,gribid_dest)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_copy_namespace','('//namespace//')')
endif
end subroutine grib_copy_namespace
!> Check the status returned by a subroutine.
!>
!> In case of error it stops the program, returns the error code to the shell
!> and prints the error message.\n
!>
!> @param status the status to be checked
!> @param caller name of the caller soubroutine
!> @param string a string variable from the caller routine (e.g. key,filename)
subroutine grib_check ( status,caller,string )
integer, intent(in) :: status
character(len=*), intent(in) :: caller
character(len=*), intent(in) :: string
call grib_f_check( status,caller,string )
end subroutine grib_check
!> Get latitudes/longitudes/data values (real(4)).
!>
!> Latitudes, longitudes, data values arrays are returned.
!> They must be properly allocated by the caller and their required
!> dimension can be obtained with \ref grib_get_size or by getting (with \ref grib_get)
!> the value of the integer key "numberOfPoints".
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param lats latitudes array with dimension "size"
!> @param lons longitudes array with dimension "size"
!> @param values data values array with dimension "size"
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_data_real4 ( gribid, lats, lons, values, status )
integer(kind=kindOfInt), intent(in) :: gribid
real ( kind = kindOfFloat ), dimension(:),intent(out) :: lats, lons
real ( kind = kindOfFloat ), dimension(:),intent(out) :: values
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfSize_t) :: npoints
npoints=size(lats)
iret = grib_f_get_data_real4 ( gribid, lats, lons, values,npoints )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get_data','')
endif
end subroutine grib_get_data_real4
!> Get latitudes/longitudes/data values (real(8)).
!>
!> Latitudes, longitudes, data values arrays are returned.
!> They must be properly allocated by the calling program/function.
!> Their required dimension can be obtained by getting (with \ref grib_get)
!> the value of the integer key "numberOfPoints".
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param lats latitudes array
!> @param lons longitudes array
!> @param values data values array
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_data_real8 ( gribid, lats, lons, values, status )
integer(kind=kindOfInt), intent(in) :: gribid
real ( kind = kindOfDouble ), dimension(:),intent(out) :: lats, lons
real ( kind = kindOfDouble ), dimension(:),intent(out) :: values
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfSize_t) :: npoints
npoints=size(lats)
iret = grib_f_get_data_real8 ( gribid, lats, lons, values,npoints )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get_data','')
endif
end subroutine grib_get_data_real8
!> Create a new iterator on the keys.
!>
!> The keys iterator can be navigated to give all the key names which
!> can then be used to get or set the key values with \ref grib_get or
!> \ref grib_set.
!> The set of keys returned can be controlled with the input variable
!> namespace or using the functions
!> \ref grib_skip_read_only, \ref grib_skip_duplicates,
!> \ref grib_skip_coded,\ref grib_skip_computed.
!> If namespace is a non empty string only the keys belonging to
!> that namespace are returned. Available namespaces are "ls" (to get the same
!> default keys as the grib_ls and "mars" to get the keys used by mars.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param iterid keys iterator id to be used in the keys iterator functions
!> @param namespace the namespace of the keys to search for (all the keys if empty)
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_keys_iterator_new ( gribid, iterid, namespace, status )
integer(kind=kindOfInt), intent(in) :: gribid
integer(kind=kindOfInt), intent(inout) :: iterid
character(LEN=*), intent(in) :: namespace
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_keys_iterator_new ( gribid, iterid, namespace )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_keys_iterator_new',namespace)
endif
end subroutine grib_keys_iterator_new
!> Advance to the next keys iterator value.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param iterid keys iterator id created with @ref grib_keys_iterator_new
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_keys_iterator_next ( iterid , status)
integer(kind=kindOfInt), intent(in) :: iterid
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_keys_iterator_next ( iterid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_keys_iterator_next','')
endif
end subroutine grib_keys_iterator_next
!> Delete a keys iterator and free memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param iterid keys iterator id created with @ref grib_keys_iterator_new
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_keys_iterator_delete ( iterid , status)
integer(kind=kindOfInt), intent(in) :: iterid
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_keys_iterator_delete ( iterid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_keys_iterator_delete','')
endif
end subroutine grib_keys_iterator_delete
!> Get the name of a key from a keys iterator.
!>
!> If the status parameter (optional) is not given the program will exit with an error message\n
!> otherwise the error message can be gathered with @ref grib_get_error_string.\n
!>
!> @param iterid keys iterator id created with @ref grib_keys_iterator_new
!> @param name key name to be retrieved
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_keys_iterator_get_name ( iterid, name, status )
integer(kind=kindOfInt), intent(in) :: iterid
character(LEN=*), intent(out) :: name
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_keys_iterator_get_name ( iterid, name )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_keys_iterator_get_name',name)
endif
end subroutine grib_keys_iterator_get_name
!> Rewind a keys iterator.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param iterid keys iterator id created with @ref grib_keys_iterator_new
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_keys_iterator_rewind ( iterid, status )
integer(kind=kindOfInt), intent(in) :: iterid
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_keys_iterator_rewind ( iterid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_keys_iterator_rewind','')
endif
end subroutine grib_keys_iterator_rewind
!> Dump the content of a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_dump ( gribid , status)
integer(kind=kindOfInt), intent(in) :: gribid
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_dump ( gribid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_dump','')
endif
end subroutine grib_dump
!> Get the error message given an error code
!>
!> @param error error code
!> @param error_message error message
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_error_string ( error, error_message, status )
integer(kind=kindOfInt), intent(in) :: error
character(len=*), intent(out) :: error_message
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_error_string ( error, error_message )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get_error_string','')
endif
end subroutine grib_get_error_string
!> Get the size of an array key.
!>
!> To get the size of a key representing an array.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key name of the key
!> @param size size of the array key
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_size_int ( gribid, key, size , status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), intent(out) :: size
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_size_int ( gribid, key, size )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get_size',key)
endif
end subroutine grib_get_size_int
!> Get the size of an array key.
!>
!> To get the size of a key representing an array.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key name of the key
!> @param size size of the array key
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_size_long ( gribid, key, size , status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfLong), intent(out) :: size
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_size_long ( gribid, key, size )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get_size',key)
endif
end subroutine grib_get_size_long
!> Get the integer value of a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value the integer(4) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_int(gribid,key,value,status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind = kindOfInt), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_int ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_int
!> Get the integer value of a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value the integer(4) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_long(gribid,key,value,status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind = kindOfLong), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_long ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_long
!> Check if the value of a key is MISSING.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param is_missing 0->not missing, 1->missing
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_is_missing(gribid,key,is_missing,status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind = kindOfInt), intent(out) :: is_missing
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_is_missing ( gribid, key, is_missing )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_is_missing',key)
endif
end subroutine grib_is_missing
!> Get the real(4) value of a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value the real(4) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_real4 ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
real(kind = kindOfFloat), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_real4 ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_real4
!> Get the real(8) value of a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value the real(8) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_real8 ( gribid, key, value , status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
real(kind = kindOfDouble), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_real8 ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_real8
!> Get the character value of a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value the real(8) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_string ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
character(len=*), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_string ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_string
!> Get the integer array of values for a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value integer(4) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_int_array ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), dimension(:), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(value)
iret=grib_f_get_int_array ( gribid, key, value , nb_values )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_int_array
!> Get the integer array of values for a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value integer(4) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_long_array ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfLong), dimension(:), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(value)
iret=grib_f_get_long_array ( gribid, key, value , nb_values )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_long_array
!> Get the real(4) array of values for a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value real(4) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_real4_array ( gribid, key, value, status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
real(kind = kindOfFloat), dimension(:), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(value)
iret=grib_f_get_real4_array ( gribid, key, value , nb_values )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_real4_array
!> Get the real(8) array of values for a key from a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value real(8) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_real8_array ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
real(kind = kindOfDouble), dimension(:), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(value)
iret=grib_f_get_real8_array ( gribid, key, value, nb_values )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_real8_array
!> Get a real(4) value of specified index from an array key.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param index integer(4) index
!> @param value real(4) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_real4_element ( gribid, key, index,value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), intent(in) :: index
real(kind = kindOfFloat), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_real4_element ( gribid, key, index,value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_real4_element
!> Get a real(8) value of specified index from an array key.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param index integer(4) index
!> @param value real(8) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_real8_element ( gribid, key, index,value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), intent(in) :: index
real(kind = kindOfDouble), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_real8_element ( gribid, key, index,value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_real8_element
!> Get the real(4) values whose indexes are stored in the array "index" from an array key.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param index integer(4) array indexes
!> @param value real(4) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_real4_elements ( gribid, key, index,value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt),dimension(:), intent(in) :: index
real(kind = kindOfFloat), dimension(:), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) ::npoints
npoints=size(value)
iret=grib_f_get_real4_elements ( gribid, key, index,value,npoints )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_real4_elements
!> Get the real(8) values whose indexes are stored in the array "index" from an array key.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param index integer(4) array index
!> @param value real(8) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_real8_elements ( gribid, key, index,value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt),dimension(:), intent(in) :: index
real(kind = kindOfDouble), dimension(:), intent(out) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: npoints
npoints=size(value)
iret=grib_f_get_real8_elements ( gribid, key, index,value,npoints )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get',key)
endif
end subroutine grib_get_real8_elements
!> Set the integer value for a key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value integer(4) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_int ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_set_int ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_int
!> Set the integer value for a key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value integer(4) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_long ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfLong), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_set_long ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_long
!> Set the real(4) value for a key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value real(4) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_real4 ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
real(kind = kindOfFloat), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_set_real4 ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_real4
!> Set the real(8) value for a key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value real(8) value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_real8 ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
real(kind = kindOfDouble), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_set_real8 ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_real8
!> Set the integers values for an array key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value integer(4) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_int_array ( gribid, key, value, status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfInt), dimension(:), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(value)
iret=grib_f_set_int_array ( gribid, key, value, nb_values )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_int_array
!> Set the integers values for an array key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value integer(4) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_long_array ( gribid, key, value, status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
integer(kind=kindOfLong), dimension(:), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(value)
iret=grib_f_set_long_array ( gribid, key, value, nb_values )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_long_array
!> Set the real(4) values for an array key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value real(4) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_real4_array ( gribid, key, value, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
real(kind = kindOfFloat), dimension(:), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(value)
iret=grib_f_set_real4_array ( gribid, key, value, nb_values )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_real4_array
!> Set the real(8) values for an array key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value real(8) array value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_real8_array ( gribid, key, value, status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
real(kind = kindOfDouble), dimension(:), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: nb_values
nb_values = size(value)
iret=grib_f_set_real8_array ( gribid, key, value, nb_values )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_real8_array
!> Set the character value for a string key in a grib message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key key name
!> @param value character value
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_set_string ( gribid, key, value , status)
integer(kind=kindOfInt), intent(in) :: gribid
character(len=*), intent(in) :: key
character(len=*), intent(in) :: value
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_set_string ( gribid, key, value )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_set',key)
endif
end subroutine grib_set_string
!> Get the size of a coded message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param byte_size size in bytes of the message
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_get_message_size ( gribid, byte_size , status)
integer(kind=kindOfInt), intent(in) :: gribid
integer(kind=kindOfSize_t), intent(out) :: byte_size
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_get_message_size ( gribid, byte_size )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_get_message_size','')
endif
end subroutine grib_get_message_size
!> Copy the coded message into an integer array.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param message integer array containing the coded message to be copied
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_copy_message ( gribid, message, status )
integer(kind=kindOfInt), intent(in) :: gribid
character(len=1), dimension(:), intent(out) :: message
integer(kind=kindOfInt),optional, intent(out) :: status
integer :: iret
integer(kind=kindOfSize_t) :: size_bytes
size_bytes = size(message,dim=1)
iret=grib_f_copy_message ( gribid, message, size_bytes )
if (iret /= 0) then
call grib_f_write_on_fail(gribid)
endif
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_copy_message','')
endif
end subroutine grib_copy_message
!> Write the coded message to a file.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param ifile file id of a file opened with \ref grib_open_file
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_write ( gribid, ifile , status)
integer(kind=kindOfInt), intent(in) :: gribid
integer(kind=kindOfInt), intent(in) :: ifile
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_write( gribid, ifile )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_write','')
endif
end subroutine grib_write
!> Write a multi field message to a file.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param multigribid id of the multi field grib loaded in memory
!> @param ifile file id of a file opened with \ref grib_open_file
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_multi_write ( multigribid, ifile , status)
integer(kind=kindOfInt), intent(in) :: multigribid
integer(kind=kindOfInt), intent(in) :: ifile
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_multi_write( multigribid, ifile )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_multi_write','')
endif
end subroutine grib_multi_write
!> Append a single field grib message to a multi field grib message.
!> Only the sections with section number greather or equal "startsection" are copied from the input single message to the multi field output grib.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param ingribid id of the input single grib
!> @param startsection starting from startsection (included) all the sections are copied from the input single grib to the output multi grib
!> @param multigribid id of the output multi filed grib
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_multi_append ( ingribid, startsection, multigribid , status)
integer(kind=kindOfInt), intent(in) :: ingribid
integer(kind=kindOfInt), intent(in) :: startsection
integer(kind=kindOfInt), intent(out) :: multigribid
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_multi_append( ingribid, startsection, multigribid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_multi_append','')
endif
end subroutine grib_multi_append
!> Find the nearest point of a given latitude/longitude point.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param is_lsm .true. if the nearest land point is required otherwise .false.
!> @param inlats input real(8) array of the latitudes of the points
!> @param inlons input real(8) array of the longitudes of the points
!> @param outlats output real(8) array of the latitudes of the nearest points
!> @param outlons output real(8) array of the longitudes of the nearest points
!> @param distances output real(8) array of the distances
!> @param indexes output integer(4) array of the zero based indexes
!> @param values output real(8) array of the values
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_find_nearest_multiple(gribid,is_lsm, &
inlats,inlons,outlats,outlons, &
values,distances, indexes,status)
integer(kind=kindOfInt), intent(in) :: gribid
logical, intent(in) :: is_lsm
real(kind = kindOfDouble), dimension(:), intent(in) :: inlats
real(kind = kindOfDouble), dimension(:), intent(in) :: inlons
real(kind = kindOfDouble), dimension(:), intent(out) :: outlats
real(kind = kindOfDouble), dimension(:), intent(out) :: outlons
real(kind = kindOfDouble), dimension(:), intent(out) :: distances
real(kind = kindOfDouble), dimension(:), intent(out) :: values
integer(kind = kindOfInt), dimension(:), intent(out) :: indexes
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: npoints
integer(kind=kindOfInt) :: intis_lsm
intis_lsm = 0
if (is_lsm) intis_lsm=1
npoints=size(inlats)
iret=grib_f_find_nearest_multiple(gribid,intis_lsm,inlats,inlons,outlats,outlons, &
values,distances,indexes,npoints)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_find_nearest','')
endif
end subroutine grib_find_nearest_multiple
!> Find the nearest point of a given latitude/longitude point.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param is_lsm .true. if the nearest land point is required otherwise .false.
!> @param inlat latitude of the point
!> @param inlon longitudes of the point
!> @param outlat latitude of the nearest point
!> @param outlon longitude of the nearest point
!> @param distance distance between the given point and its nearest
!> @param index zero based index
!> @param value value of the field in the nearest point
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_find_nearest_single(gribid,is_lsm, &
inlat,inlon,outlat,outlon, &
value,distance, index,status)
integer(kind=kindOfInt), intent(in) :: gribid
logical, intent(in) :: is_lsm
real(kind = kindOfDouble), intent(in) :: inlat
real(kind = kindOfDouble), intent(in) :: inlon
real(kind = kindOfDouble), intent(out) :: outlat
real(kind = kindOfDouble), intent(out) :: outlon
real(kind = kindOfDouble), intent(out) :: distance
real(kind = kindOfDouble), intent(out) :: value
integer(kind = kindOfInt), intent(out) :: index
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: intis_lsm =0
if (is_lsm) intis_lsm=1
iret=grib_f_find_nearest_single(gribid,intis_lsm,inlat,inlon,outlat,outlon, &
value,distance,index)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_find_nearest','')
endif
end subroutine grib_find_nearest_single
!> Find the nearest point of a given latitude/longitude point.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param is_lsm .true. if the nearest land point is required otherwise .false.
!> @param inlat latitude of the point
!> @param inlon longitudes of the point
!> @param outlat latitude of the nearest point
!> @param outlon longitude of the nearest point
!> @param distance distance between the given point and its nearest
!> @param index zero based index
!> @param value value of the field in the nearest point
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_find_nearest_four_single(gribid,is_lsm, &
inlat,inlon,outlat,outlon, &
value,distance, index,status)
integer(kind=kindOfInt), intent(in) :: gribid
logical, intent(in) :: is_lsm
real(kind = kindOfDouble), intent(in) :: inlat
real(kind = kindOfDouble), intent(in) :: inlon
real(kind = kindOfDouble), dimension(4), intent(out) :: outlat
real(kind = kindOfDouble), dimension(4), intent(out) :: outlon
real(kind = kindOfDouble), dimension(4), intent(out) :: distance
real(kind = kindOfDouble), dimension(4), intent(out) :: value
integer(kind = kindOfInt), dimension(4), intent(out) :: index
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
integer(kind=kindOfInt) :: intis_lsm =0
if (is_lsm) intis_lsm=1
iret=grib_f_find_nearest_four_single(gribid,intis_lsm,inlat,inlon,outlat,outlon, &
value,distance,index)
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_find_nearest','')
endif
end subroutine grib_find_nearest_four_single
!> Turn on the support for multiple fields in a single message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_multi_support_on (status )
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_multi_support_on ( )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_multi_support_on','')
endif
end subroutine grib_multi_support_on
!> Turn off the support for multiple fields in a single message.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_multi_support_off ( status )
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret = grib_f_multi_support_off ( )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_multi_support_off','')
endif
end subroutine grib_multi_support_off
!> Turn on the compatibility mode with gribex.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_gribex_mode_on (status )
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_gribex_mode_on()
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_gribex_mode_on','')
endif
end subroutine grib_gribex_mode_on
!> Turn off the compatibility mode with gribex.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_gribex_mode_off (status )
integer(kind=kindOfInt),optional, intent(out) :: status
integer(kind=kindOfInt) :: iret
iret=grib_f_gribex_mode_off()
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_gribex_mode_off','')
endif
end subroutine grib_gribex_mode_off
!> Skip the computed keys in a keys iterator.
!>
!> The computed keys are not coded in the message they are computed
!> from other keys.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @see grib_keys_iterator_new,grib_keys_iterator_next,grib_keys_iterator_release
!>
!> @param iterid keys iterator id
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_skip_computed ( iterid , status)
integer(kind=kindOfInt), intent(in) :: iterid
integer(kind=kindOfInt),optional, intent(out) :: status
integer :: iret
iret = grib_f_skip_computed ( iterid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_skip_computed','')
endif
end subroutine grib_skip_computed
!> Skip the coded keys in a keys iterator.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> The coded keys are actually coded in the message.
!>
!> @see grib_keys_iterator_new,grib_keys_iterator_next,grib_keys_iterator_release
!>
!> @param iterid keys iterator id
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_skip_coded ( iterid, status )
integer(kind=kindOfInt), intent(in) :: iterid
integer(kind=kindOfInt),optional, intent(out) :: status
integer :: iret
iret = grib_f_skip_coded ( iterid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_skip_coded','')
endif
end subroutine grib_skip_coded
!> Skip the duplicated keys in a keys iterator.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @see grib_keys_iterator_new,grib_keys_iterator_next,grib_keys_iterator_release
!>
!> @param iterid keys iterator id
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_skip_duplicates ( iterid, status )
integer(kind=kindOfInt), intent(in) :: iterid
integer(kind=kindOfInt),optional, intent(out) :: status
integer :: iret
iret = grib_f_skip_duplicates ( iterid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_skip_duplicates','')
endif
end subroutine grib_skip_duplicates
!> Skip the read_only keys in a keys iterator.
!>
!> Read only keys cannot be set.
!>
!> @see grib_keys_iterator_new,grib_keys_iterator_next,grib_keys_iterator_release
!>
!> @param iterid keys iterator id
!> @param status GRIB_SUCCESS if OK, integer value on error
subroutine grib_skip_read_only ( iterid, status )
integer(kind=kindOfInt), intent(in) :: iterid
integer(kind=kindOfInt),optional, intent(out) :: status
integer :: iret
iret = grib_f_skip_read_only ( iterid )
if (present(status)) then
status = iret
else
call grib_check(iret,'grib_skip_read_only','')
endif
end subroutine grib_skip_read_only
end module grib_api