w3ai08.f File Reference

Unpack grib field to grib grid. More...

Go to the source code of this file.

Functions/Subroutines
subroutine	ai081 (msga, kptr, kpds, kret)
	Find 'grib; characters and set pointers to the next byte following 'grib'.
subroutine	ai082 (msga, kptr, kpds, kret)
	Extract information from the product description sec, and generate label information to permit storage in office note 84 format.
subroutine	ai082a (msga, kptr, kpds, kret)
	Extract information from the product description section (version 1).
subroutine	ai083 (msga, kptr, kpds, kgds, kret)
	Extract information on unlisted grid to allow conversion to office note 84 format.
subroutine	ai084 (msga, kptr, kpds, kgds, kbms, kret)
	If bit map sec is available in grib message,extract for program use, otherwise generate an appropriate bit map.
subroutine	ai085 (msga, kptr, kpds, kbms, data, kret)
	Extract grib data and place into output arry in proper position.
subroutine	ai085a (msga, kptr, kpds, kbms, data, kret)
	Extract grib data (version 1) and place into proper position in output array.
subroutine	ai087 (, j, kpds, kgds, kret)
	To test when gds is available to see if size mismatch on existing grids (by center) is indicated.
subroutine	w3ai08 (msga, kpds, kgds, kbms, data, kptr, kret)
	Unpack a grib field to the exact grid specified in the message, isolate the bit map and make the values of the product description sec (pds) and the grid description sec (gds) available in return arrays.

Detailed Description

Unpack grib field to grib grid.

Author

Bill Cavanaugh

Date

1988-01-20

Definition in file w3ai08.f.

Function/Subroutine Documentation

ai081()

subroutine ai081	(	character*1, dimension(*)	msga,
		integer, dimension(*)	kptr,
		integer, dimension(*)	kpds,
		integer	kret
	)

Find 'grib; characters and set pointers to the next byte following 'grib'.

If they exist extract counts from gds and bms. Extract count from bds. determine if sum of counts actually places terminator '7777' at the correct location.

Program history log:

• Bill Cavanaugh 1988-01-20
• Ralph Jones 1990-09-01 Change's for ansi fortran.
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.

Parameters

[in]	msga	grib field - "grib" thru "7777".``
[in,out]	kptr	array containing storage for following parameters. 1: Unused. 2: Unused. 3: Length of pds. 4: Length of gds. 5: Length of bms. 6: Length of bds. 7: Value of current byte. 8: Unused. 9: Grib start byte. 10: Grib/grid element count.
[out]	kpds	- array containing pds elements.. 1: Id of center. 2: Model identification. 3: Grid identification. 4: Gds/bms flag. 5: Indicator of parameter. 6: Type of level. 7: Height/pressure , etc of level. 8: Year of century. 9: Month of year. 10: Day of month. 11: Hour of day. 12: Minute of hour. 13: Indicator of forecast time unit. 14: Time range 1. 15: Time range 2. 16: Time range flag. 17: Number included in average. 18: Version nr of grib specification.
[out]	kret	Error return.

Note

Error returns.

• kret = 1: No 'grib'.
• kret = 2: No '7777' or mislocated (by counts).

Author

Bill Cavanaugh

Date

1988-01-20

Definition at line 568 of file w3ai08.f.

ai082()

subroutine ai082	(	character*1, dimension(*)	msga,
		integer, dimension(*)	kptr,
		integer, dimension(*)	kpds,
		integer	kret
	)

Extract information from the product description sec, and generate label information to permit storage in office note 84 format.

Program history log:

• Bill Cavanaugh 1988-01-20
• Ralph Jones 1990-09-01 Change's for ansi fortran.
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.
• Ralph Jones 1990-12-05 Change's for grib nov. 21,1990.

Parameters

[in]	msga	Array containing grib message.
[in,out]	kptr	Array containing storage for following parameters. 1: Unused. 2: Unused. 3: Length of pds. 4: Length of gds. 5: Length of bms. 6: Length of pds. 7: Value of current byte. 8: Unused. 9: Grib start byte nr. 10: Grib/grid element count.
[out]	kpds	Array containing pds elements. 1: Id of center. 2: Model identification. 3: Grid identification. 4: Gds/bms flag. 5: Indicator of parameter. 6: Type of level. 7: Height/pressure, etc of level. 8: Year of century. 9: Month of year. 10: Day of month. 11: Hour of day. 12: Minute of hour. 13: Indicator of forecast time unit. 14: Time range 1. 15: Time range 2. 16: Time range flag. 17: Number included in average. 18: Version number of grib spefication. 19: Version nr of parameter table. 20: Total length of grib message (including section 0).
[out]	kret	error return.

Note

error return:

• = 0 - no errors
• = 8 - temp gds indicated, but no gds

Author

Bill Cavanaugh

Date

1988-01-20

Definition at line 748 of file w3ai08.f.

ai082a()

subroutine ai082a	(	character*1, dimension(*)	msga,
		integer, dimension(*)	kptr,
		integer, dimension(*)	kpds,
		integer	kret
	)

Extract information from the product description section (version 1).

Program history log:

• Bill Cavanaugh 1989-11-20
• Ralph Jones 1990-09-01 Change's for ansi fortran.
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.
• Ralph Jones 1990-12-05 Change's for grib nov. 21,1990.

Parameters

[in]	MSGA	Array containing grib message.
[in,out]	KPTR	Array containing storage for following parameters. 1: Unused. 2: Unused. 3: Length of pds. 4: Length of gds. 5: Length of bms. 6: Length of pds. 7: Value of current byte. 8: Unused. 9: Grib start byte nr. 10: Grib/grid element count.
[out]	KPDS	Array containing pds elements. 1: Id of center 2: Model identi.fication 3: Grid identification. 4: Gds/bms flag. 5: Indicator of. parameter 6: Type of level. 7: Height/pressu.re , etc of level 8: Year (including century). 9: Month of year. 10: Day of month.. 11: Hour of day. 12: Minute of hour. 13: Indicator of forecast time unit. 14: Time range 1. 15: Time range 2. 16: Time range flag. 17: Number included in average. 18: Version nr of grib specification. 19: Version nr of parameter table. 20: Total byte count for source message.
[out]	KRET	Error return.

Note

Source pds structure (version 1).

• 1-3: Length of pds section in bytes.
• 4: Parameter table version no. for international exchange (crrently no. 1).
• 5: Center id.
• 6: Model id.
• 7: Grid id.
• 8: Flag for gds/bms.
• 9: Indicator for parameter.
• 10: Indicator for type of level.
• 11-12: Height, pressure of level.
• 13: Year of century.
• 14: Month.
• 15: Day.
• 16: Hour.
• 17: Minute.
• 18: Forecast time unit.
• 19: P1 - pd of time.
• 20: P2 - pd of time.
• 21: Time range indicator.
• 22-23: Number in average.
• 24: Number misg from averages.
• 25: Century.
• 26: Indicator of parameter in locally re-defined parameter table..
• 27-28: Units decimal scale factor (d).
• 29-40: Reserved: need not be present.
• 41-NN: National use.
• Error return:
  • = 0 - No errors.
  • = 8 - Temp gds indicated, but no gds.

Author

Bill Cavanaugh

Date

1988-01-20

Definition at line 934 of file w3ai08.f.

ai083()

subroutine ai083	(	character*1, dimension(*)	msga,
		integer, dimension(*)	kptr,
		integer, dimension(*)	kpds,
		integer, dimension(*)	kgds,
		integer	kret
	)

Extract information on unlisted grid to allow conversion to office note 84 format.

Program history log:

• Bill Cavanaugh 1988-01-20
• Bill Cavanaugh 1989-03-16 Added mercator & lambert conformal processing.
• Bill Cavanaugh 1989-07-12 Corrected change entered 89-03-16 reordering processing for lambert conformal and mercator grids.
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.

Parameters

[in]	MSGA	Array containing grib message.
[in,out]	KPTR	Array containing storage for following parameters. 1): Unused. 2): Unused. 3): Length of pds. 4): Length of gds. 5): Length of bms. 6): Length of bds. 7): Value of current byte. 8): Unused. 9): Grib start byte nr. 0): Grib/grid element count.
[in]	KPDS	Array containing pds elements. 1): Id of center. 2): Model identification. 3): Grid identification. 4): Gds/bms flag. 5): Indicator of parameter. 6): Type of level. 7): Height/pressure , etc of level. 8): Year of century. 9): Month of year. 10: Day of month. 11: Hour of day. 12: Minute of hour. 13: Indicator of forecast time unit. 14: Time range 1. 15: Time range 2. 16: Time range flag. 17: Number included in average. 18: Version nr of grib specification.
[out]	KGDS	Array containing gds elements.. 1): Data representation type. Latitude/Longitude grids 2): N(i) nr points on latitude circle. 3): N(j) nr points on longitude meridian. 4): La(1) latitude of origin. 5): Lo(1) longitude of origin. 6): Resolution flag. 7): La(2) latitude of extreme point. 8): Lo(2) longitude of extreme point. 9): Di longitudinal direction of increment. 10: Dj latitudinal direction of increment. 11: Scanning mode flag. Polar stereographic grids. 2): N(i) nr points along lat circle. 3): N(j) nr points along lon circle. 4): La(1) latitude of origin. 5): Lo(1) longitude of origin. 6): Reserved. 7): Lov grid orientation. 8): Dx - x direction increment. 9): Dy - y direction increment. 10: Projection center flag. 11: Scanning mode. Spherical harmonic coefficients. 2): J pentagonal resolution parameter. 3): K pentagonal resolution parameter. 4): M pentagonal resolution parameter. 5): Representation type. 6): Coefficient storage mode. Mercator grids. 2): N(i) nr points on latitude circle. 3): N(j) nr points on longitude meridian. 4): La(1) latitude of origin. 5): Lo(1) longitude of origin. 6): Resolution flag. 7): La(2) latitude of last grid point. 8): Lo(2) longitude of last grid point. 9): Longit dir increment. 10: Latit dir increment. 11: Scanning mode flag. 12: Latitude intersection. Lambert conformal grids. 2): Nx nr points along x-axis. 3): Ny nr points along y-axis. 4): La1 lat of origin (lower left). 5): Lo1 lon of origin (lower left). 6): Reserved. 7): Lov - orientation of grid. 8): Dx - x-dir increment. 9): Dy - y-dir increment. 10: Projection center flag. 11: Scanning mode flag. 12: Latin 1 - first lat from pole of secant cone inter. 13: Latin 2 - second lat from pole of secant cone inter.
[out]	KRET	Error return.

Note

KRET

• = 0
• = 4 - DATA REPRESENTATION TYPE NOT CURRENTLY ACCEPTABLE

Author

Bill Cavanaugh

Date

1988-01-20

Definition at line 1157 of file w3ai08.f.

ai084()

subroutine ai084	(	character*1, dimension(*)	msga,
		integer, dimension(10)	kptr,
		integer, dimension(20)	kpds,
		integer, dimension(13)	kgds,
		logical, dimension(*)	kbms,
		integer	kret
	)

If bit map sec is available in grib message,extract for program use, otherwise generate an appropriate bit map.

Program history log:

• Bill Cavanaugh 1988-01-20
• Bill Cavanaugh 1989-02-24 Increment of position in bit map when bit map was included was handled improperly. corrected this data.
• Bill Cavanaugh 1989-07-12 Altered method of calculating nr of bits in a bit map contained in grib message.
• Bill Cavanaugh 1990-05-07 Brings all u.s. grids to revised values as of dec 89.
• William Bostelman 1990-07-15 Modiifed to test the grib bds byte size to determine what ecmwf grid array size is to be specified.
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.
• Ralph Jones 1990-12-05 Change's for grib nov. 21,1990.

Parameters

[in]	MSGA	BUFR message.
[in,out]	KPTR	Array containing storage for following parameters. 1: Unused. 2: Unused. 3: Length of pds. 4: Length of gds. 5: Length of bms. 6: Length of bds. 7: Value of current byte. 8: Unused. 9: Grib start byte nr. 10: Grib/grid element count.
[in]	KPDS	ARRAY CONTAINING PDS ELEMENTS. 1: Id of center. 2: Model identification. 3: Grid identification. 4: Gds/bms flag. 5: Indicator of parameter. 6: Type of level. 7: Height/pressure , etc of level. 8: Year of century. 9: Month of year. 10: Day of month. 11: Hour of day. 12: Minute of hour. 13: Indicator of forecast time unit. 14: Time range 1. 15: Time range 2. 16: Time range flag. 17: Number included in average. 18: Version nr of grib specification.
[out]	kgds	array containing gds elements. 1: data representation type Latitude/longitude grids 2: n(i) nr points on latitude circle 3: n(j) nr points on longitude meridian 4: la(1) latitude of origin 5: lo(1) longitude of origin 6: resolution flag 7: la(2) latitude of extreme point 8: lo(2) longitude of extreme point 9: di longitudinal direction of increment 10: dj latitundinal direction of increment 11: scanning mode flag Polar stereographic grids 2: n(i) nr points along lat circle 3: n(j) nr points along lon circle 4: la(1) latitude of origin 5: lo(1) longitude of origin 6: reserved 7: lov grid orientation 8: dx - x direction increment 9: dy - y direction increment 10: projection center flag 11: scanning mode Spherical harmonic coefficients 2: j pentagonal resolution parameter 3: k pentagonal resolution parameter 4: m pentagonal resolution parameter 5: representation type 6: coefficient storage mode Mercator grids 2: n(i) nr points on latitude circle 3: n(j) nr points on longitude meridian 4: la(1) latitude of origin 5: lo(1) longitude of origin 6: resolution flag 7: la(2) latitude of last grid point 8: lo(2) longitude of last grid point 9: longit dir increment 10: latit dir increment 11: scanning mode flag 12: latitude intersection Lambert conformal grids 2: nx nr points along x-axis 3: ny nr points along y-axis 4: la1 lat of origin (lower left) 5: lo1 lon of origin (lower left) 6: reserved 7: lov - orientation of grid 8: dx - x-dir increment 9: dy - y-dir increment 10: projection center flag 11: scanning mode flag 12: latin 1 - first lat from pole of secant cone inter 13: latin 2 - second lat from pole of secant cone inter
[out]	KBMS	Bitmap describing location of output elements..
[out]	KRET	Error return.

Note

KRET

• = 0 - No error.
• = 5 - Grid not avail for center indicated.
• = 10 - Incorrect center indicator.

Author

Bill Cavanaugh

Date

1988-01-20

Definition at line 1614 of file w3ai08.f.

ai085()

subroutine ai085	(	character*1, dimension(*)	msga,
		integer, dimension(*)	kptr,
		integer, dimension(*)	kpds,
		logical, dimension(*)	kbms,
		real, dimension(*)	data,
			kret
	)

Extract grib data and place into output arry in proper position.

Program history log:

• Bill Cavanaugh 1988-01-20
• Ralph Jones 1990-09-01 Change's for ansi fortran.
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.
• Ralph Jones 1990-12-05 Change's for grib nov. 21,1990.

Parameters

[in]	MSGA	Array containing grib message.
[in,out]	KPTR	Array containing storage for following parameters. 1: Unused. 2: Unused. 3: Length of pds. 4: Length of gds. 5: Length of bms. 6: Length of bds. 7: Value of current byte. 8: Unused. 9: Grib start byte nr. 10: Grib/grid element count.
[in]	KPDS	Array containing pds elements. 1: Id of center. 2: Model identification. 3: Grid identification. 4: Gds/bms flag. 5: Indicator of parameter. 6: Type of level. 7: Height/pressure , etc of level. 8: Year of century. 9: Month of year. 10: Day of month. 11: Hour of day. 12: Minute of hour. 13: Indicator of forecast time unit. 14: Time range 1. 15: Time range 2. 16: Time range flag. 17: Number included in average. 18: Version nr of grib specification.
[in]	KBMS	Bitmap describing location of output elements.
[out]	DATA	Real array of gridded elements in grib message.
[out]	KRET	Error return.

Note

Error return.

• 3 = Unpacked field is larger than 32768.
• 6 = Does not match nr of entries for this grib/grid.
• 7 = Number of bits in fill too large.

Author

Bill Cavanaugh

Date

1988-01-20

Definition at line 2066 of file w3ai08.f.

ai085a()

subroutine ai085a	(	character*1, dimension(*)	msga,
		integer, dimension(*)	kptr,
		integer, dimension(*)	kpds,
		logical, dimension(*)	kbms,
		real, dimension(*)	data,
			kret
	)

Extract grib data (version 1) and place into proper position in output array.

Program history log:

• Bill Cavanaugh 1989-11-20
• Ralph Jones 1990-09-01 Change's for ansi fortran.
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.
• Ralph Jones 1990-12-05 Change's for grib nov. 21,1990.

Parameters

[in]	MSGA	Array containing grib message.
[in,out]	KPTR	Array containing storage for following parameters. 1:Unused. 2:Unused. 3:Length of pds. 4:Length of gds. 5:Length of bms. 6:Length of bds. 7:Value of current byte. 8:Unused. 9:Grib start byte nr. 10:Grib/grid element count.
[in]	KPDS	Array containing pds elements. (version 1) 1: Id of center. 2: Model identification. 3: Grid identification. 4: Gds/bms flag. 5: Indicator of parameter. 6: Type of level. 7: Height/pressure , etc of level. 8: Year including century. 9: Month of year. 10: Day of month. 11: Hour of day. 12: Minute of hour. 13: Indicator of forecast time unit. 14: Time range 1. 15: Time range 2. 16: Time range flag. 17: Number included in average. 18: Version nr of grib specification. 19: Version nr of parameter table. 20: Total length of grib message (including section 0).
[in]	KBMS	Bitmap describing location of output elements.
[out]	DATA	Real array of gridded elements in grib message.
[out]	KRET	Error return.

Note

Structure of binary data section (version 1)

• 1-3: LENGTH OF SECTION
• 4: PACKING FLAGS
• 5-6: SCALE FACTOR
• 7-10: REFERENCE VALUE
• 11: NUMBER OF BIT FOR EACH VALUE
• 12s-N: DATA

Error return:

• 3 = Unpacked field is larger than 32768.
• 6 = Does not match nr of entries for this grib/grid.
• 7 = Number of bits in fill too large.

Author

Bill Cavanaugh

Date

1989-11-20

Definition at line 2361 of file w3ai08.f.

ai087()

subroutine ai087	(	integer	j,
		integer, dimension(20)	kpds,
		integer, dimension(13)	kgds,
			kret
	)

To test when gds is available to see if size mismatch on existing grids (by center) is indicated.

Program history log:

• Bill Cavanaugh 1988-02-08
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.
• Ralph Jones 1990-12-05 Change's for grib nov. 21,1990.

Parameters

[in]	J	Size for indicated grid.
[in]	KPDS
[in]	KGDS
[out]	KRET	Error return.

Note

KRET = 9 - GDS indicates size mismatch with std grid.

Author

Bill Cavanaugh

Date

1988-02-08

Definition at line 2629 of file w3ai08.f.

w3ai08()

subroutine w3ai08	(	character*1, dimension(*)	msga,
		integer, dimension(*)	kpds,
		integer, dimension(*)	kgds,
		logical, dimension(*)	kbms,
		real, dimension(*)	data,
		integer, dimension(*)	kptr,
			kret
	)

Unpack a grib field to the exact grid specified in the message, isolate the bit map and make the values of the product description sec (pds) and the grid description sec (gds) available in return arrays.

Program history log:

• Bill Cavanaugh 1988-01-20
• Bill Cavanaugh 1990-05-11 To assure that all u.s. grids in the grib decoder comply with size changes in the december 1989 revisions.
• Bill Cavanaugh 1990-05-24 Corrects searching an improper location for grib version number in grib messages.
• William Bostelman 1990-07-15 Modiifed sub. ai084 so that it will test the grib bds byte size to determine what ecmwf grid array size is to be specified.
• Ralph Jones 1990-09-14 Change's for ansi fortran, and pds version 1.
• Ralph Jones 1990-09-23 Change's for cray cft77 fortran.
• Ralph Jones 1990-12-05 Change's for grib nov. 21,1990.
• Boi Vuong 2002-10-15 Replaced function ichar with mova2i.

Parameters

[in]	msga	grib field - "grib" thru "7777" char*1
[out]	data	array containing data elements

Note

(version 0):

• 1: id of center
• 2: model identification
• 3: grid identification
• 4: gds/bms flag
• 5: indicator of parameter
• 6: type of level
• 7: height/pressure , etc of level
• 8: year including century
• 9: month of year
• 10: day of month
• 11: hour of day
• 12: minute of hour
• 13: indicator of forecast time unit
• 14: time range 1
• 15: time range 2
• 16: time range flag
• 17: number included in average
• 18: grib specification edition number

Parameters

[out]	kpds	array containing pds elements. (version 1) 1: id of center 2: model identification 3: grid identification 4: gds/bms flag 5: indicator of parameter 6: type of level 7: height/pressure , etc of level 8: year including century 9: month of year 10: day of month 11: hour of day 12: minute of hour 13: indicator of forecast time unit 14: time range 1 15: time range 2 16: time range flag 17: number included in average 18: version nr of grib specification 19: version nr of parameter table 20: total length of grib message (including section 0)
[out]	kgds	array containing gds elements. 1: data representation type Latitude/longitude grids 2: n(i) nr points on latitude circle 3: n(j) nr points on longitude meridian 4: la(1) latitude of origin 5: lo(1) longitude of origin 6: resolution flag 7: la(2) latitude of extreme point 8: lo(2) longitude of extreme point 9: di longitudinal direction of increment 10: dj latitundinal direction of increment 11: scanning mode flag Polar stereographic grids 2: n(i) nr points along lat circle 3: n(j) nr points along lon circle 4: la(1) latitude of origin 5: lo(1) longitude of origin 6: reserved 7: lov grid orientation 8: dx - x direction increment 9: dy - y direction increment 10: projection center flag 11: scanning mode Spherical harmonic coefficients 2: j pentagonal resolution parameter 3: k pentagonal resolution parameter 4: m pentagonal resolution parameter 5: representation type 6: coefficient storage mode Mercator grids 2: n(i) nr points on latitude circle 3: n(j) nr points on longitude meridian 4: la(1) latitude of origin 5: lo(1) longitude of origin 6: resolution flag 7: la(2) latitude of last grid point 8: lo(2) longitude of last grid point 9: longit dir increment 10: latit dir increment 11: scanning mode flag 12: latitude intersection Lambert conformal grids 2: nx nr points along x-axis 3: ny nr points along y-axis 4: la1 lat of origin (lower left) 5: lo1 lon of origin (lower left) 6: reserved 7: lov - orientation of grid 8: dx - x-dir increment 9: dy - y-dir increment 10: projection center flag 11: scanning mode flag 12: latin 1 - first lat from pole of secant cone inter 13: latin 2 - second lat from pole of secant cone inter
[out]	kbms	- bitmap describing location of output elements.
[out]	kptr	- array containing storage for following parameters 1: unused 2: unused 3: length of pds 4: length of gds 5: length of bms 6: length of bds 7: value of current byte 8: unused 9: grib start byte nr 10: grib/grid element count
[out]	kret	flag indicating quality of completion

Note

values for return flag (kret)

• kret = 0 - normal return, no errors
  • = 1 - 'grib' not found in first 100 chars
  • = 2 - '7777' not in correct location
  • = 3 - unpacked field is larger than 32768
  • = 4 - gds/ grid not one of currently accepted values
  • = 5 - grid not currently avail for center indicated
  • = 8 - temp gds indicated, but gds flag is off
  • = 9 - gds indicates size mismatch with std grid
  • = 10 - incorrect center indicator

Author

Bill Cavanaugh

Date

1988-01-20

Definition at line 147 of file w3ai08.f.