NCEPLIBS-g2  3.5.0
grib_mod Module Reference

This Fortran module contains the declaration of derived type gribfield. More...

Data Types

type  gribfield
 

Variables

character(len=12) g2_version = "g2lib-3.5.0"
 Library version. More...
 

Detailed Description

This Fortran module contains the declaration of derived type gribfield.

Author
Stephen Gilbert
Date
2002-01-23

Data Type Documentation

◆ grib_mod::gribfield

type grib_mod::gribfield

Definition at line 14 of file gribmod.F90.

Data Fields
logical *1, dimension(:), pointer bmap Logical*1 array containing decoded bitmap, if ibmap equals 0 or 254 - otherwise null.

This element is actually a pointer to an array that holds the data.

real, dimension(:), pointer coord_list Real array containing floating point values intended to document the vertical discretisation associated to model data on hybrid coordinate vertical levels (part of Section 3 - the Grid Definition Section).

This element is actually a pointer to an array that holds the data.

integer discipline Message Discipline (see Code Table 0.0).
logical expanded Logical value indicating whether the data field was expanded to the grid in the case where a bit-map is present.

If true, the data points in fld match the grid points and zeros were inserted at grid points where data was bit-mapped out. If false, the data values in fld were not expanded to the grid and are just a consecutive array of data points corresponding to each value of "1" in bmap.

real, dimension(:), pointer fld Array of ndpts unpacked data points.

This element is actually a pointer to an array that holds the data.

integer griddef Source of grid definition (see Code Table 3.0)
  • 0 Specified in field igdtnum (as defined in Code table 3.1.
  • 1 Predetermined grid Defined by originating centre.
integer ibmap Bitmap indicator (see Code Table 6.0).
  • 0 bitmap applies and is included in Section 6.
  • 1-253 Predefined bitmap applies.
  • 254 Previously defined bitmap applies to this field.
  • 255 Bit map does not apply to this product.
integer idrtlen Number of elements in the Data Representation Template array specified by idrtnum.
integer, dimension(:), pointer idrtmpl Contains the data values for the Data Representation Template specified by idrtnum.

This element is actually a pointer to an array that holds the data.

integer idrtnum Data Representation Template Number (Code Table 5.0).
integer, dimension(:), pointer idsect Contains the entries in the Identification Section (Section 1).
  • idsect(1) Identification of originating Centre (see Common Code Table C-1) 7 US National Weather Service. (Table 0).
  • idsect(2) Identification of originating Sub-centre (Table C).
  • idsect(3) GRIB Master Tables Version Number. (Table 1.0) 0 Experimental; 1 Initial operational version number
  • idsect(4) GRIB Local Tables Version Number (Table 1.1).
    • 0 Local tables not used
    • 0 1-254 Number of local tables version used
  • idsect(5) Significance of Reference Time (Table 1.2).
    • 0 Analysis
    • 1 Start of forecast
    • 2 Verifying time of forecast
    • 3 Observation time
  • idsect(6) Year (4 digits)
  • idsect(7) Month
  • idsect(8) Day
  • idsect(9) Hour
  • idsect(10) Minute
  • idsect(11) Second
  • idsect(12) Production status of processed data (see Table 1.3)
    • 0 Operational products
    • 1 Operational test products
    • 2 Research products
    • 3 Re-analysis products
  • idsect(13) Type of processed data (Table 1.4)
    • 0 Analysis products
    • 1 Forecast products
    • 2 Analysis and forecast products
    • 3 Control forecast products
    • 4 Perturbed forecast products
    • 5 Control and perturbed forecast products
    • 6 Processed satellite observations
    • 7 Processed radar observations
integer idsectlen Number of elements in idsect (always 13).
integer ifldnum Field number within GRIB message.
integer igdtlen Number of elements in the Grid Defintion Template specified by igdtnum.
integer, dimension(:), pointer igdtmpl Contains the data values for the Grid Definition Template specified by igdtnum.

This element is actually a pointer to an array that holds the data.

integer igdtnum Grid Definition Template Number (Code Table 3.1).
integer interp_opt Interpretation of list of numbers at end of section 3 - the Grid Definiton Section.

(See Code Table 3.11).

integer ipdtlen Number of elements in the Product Defintion Template specified by ipdtnum.
integer, dimension(:), pointer ipdtmpl Contains the data values for the Product Definition Template specified by ipdtnum.

This element is actually a pointer to an array that holds the data.

integer ipdtnum Product Definition Template Number (Code Table 4.0).
integer, dimension(:), pointer list_opt (Used if numoct_opt .ne.

0.) This array contains the number of grid points contained in each row (or column) (part of Section 3), This element is actually a pointer to an array that holds the data. This pointer is null if numoct_opt equals 0.

character(len=1), dimension(:), pointer local Pointer to character array containing contents of Local Section 2, if included.
integer locallen Length of array local.
integer ndpts Number of data points unpacked and returned.

Note that this number may be different from the value of ngrdpts if a logical bitmap is in use with grid points that are being masked out.

integer ngrdpts Number of grid points in the defined grid.

Note that the number of actual data values returned from getgb2() (in ndpts) may be less than this value if a logical bitmap is in use with grid points that are being masked out.

integer num_coord Number of values in array coord_list.

This is part of Section 3 - the Grid Definition Section.

integer num_opt (Used if numoct_opt .ne.

0.) The number of entries in array ideflist. i.e. number of rows (or columns) for which optional grid points are defined. This value is set to zero, if umoct_opt = 0.

integer numoct_opt Number of octets needed for each additional grid points definition.

Used to define number of points in each row (or column) for non-regular grids. Equal to 0, if using regular grid.

logical unpacked Logical value indicating whether the bitmap and data values were unpacked.

If false, bmap and fld pointers are null.

integer version GRIB edition number (currently 2).

Variable Documentation

◆ g2_version

character(len = 12) grib_mod::g2_version = "g2lib-3.5.0"

Library version.

Definition at line 12 of file gribmod.F90.