Abstract grid that holds fields and methods common to all grids. More...

Inheritance diagram for ip_grid_mod::ip_grid:

Public Member Functions
procedure	field_pos (self, i, j)
	Field position for a given grid point.

generic	init init_grib1
	Init subprogram.

generic	init init_grib2
	Init subprogram.

Data Fields
class(ip_grid_descriptor), allocatable	descriptor
	Descriptor.

real	eccen_squared
	Eccentricity of the Earth squared (e^2).

integer	im
	Number of x points.

integer	iwrap
	x wraparound increment (0 if no wraparound).

integer	jm
	Number of y points.

integer	jwrap1
	y wraparound lower pivot point (0 if no wraparound).

integer	jwrap2
	y wraparound upper pivot point (0 if no wraparound).

integer	kscan
	Mass/wind flag for staggered diagonal (0 if mass; 1 if wind).

integer	nm
	Total number of points.

integer	nscan

integer	nscan_field_pos
	nscan for field_pos routine.

real	rerth
	Radius of the Earth.

Detailed Description

Abstract grid that holds fields and methods common to all grids.

ip_grid is meant to be subclassed when implementing a new grid.

There are three methods that must be implemented:

init_grib1()
init_grib2()
gdswzd()

The init methods are responsible for setting up the grid using GRIB1/GRIB2 descriptors.

gdswzd() performs transformations to and from Earth coordinates and grid coordinates.

A good reference for all the map projection equations used by NCEPLIBS-ip can be found here: https://doi.org/10.3133/pp1395.

Author: Kyle Gerheiser

Date: July 2021

Definition at line 59 of file ip_grid_mod.F90.

Member Function/Subroutine Documentation

◆ field_pos()

procedure ip_grid_mod::ip_grid::field_pos	(	class(ip_grid), intent(in)	self,
		integer, intent(in)	i,
		integer, intent(in)	j )

Field position for a given grid point.

Returns: Integer position in grib field to locate grid point. Returns the field position for a given grid point.

Parameters

[in]	self
[in]	i
[in]	j

Returns: Integer position in grib field to locate grid point.

Author: Mark Iredell, George Gayno, Kyle Gerheiser

Date: April 1996

Definition at line 92 of file ip_grid_mod.F90.

◆ init() [1/2]

generic ip_grid_mod::ip_grid::init

Init subprogram.

Returns: N/A

Definition at line 94 of file ip_grid_mod.F90.

◆ init() [2/2]

generic ip_grid_mod::ip_grid::init

Init subprogram.

Returns: N/A

Definition at line 94 of file ip_grid_mod.F90.

Field Documentation

◆ descriptor

class(ip_grid_descriptor), allocatable ip_grid_mod::ip_grid::descriptor

Descriptor.

Definition at line 60 of file ip_grid_mod.F90.

◆ eccen_squared

real ip_grid_mod::ip_grid::eccen_squared

Eccentricity of the Earth squared (e^2).

Definition at line 79 of file ip_grid_mod.F90.

◆ im

integer ip_grid_mod::ip_grid::im

Number of x points.

Definition at line 62 of file ip_grid_mod.F90.

◆ iwrap

integer ip_grid_mod::ip_grid::iwrap

x wraparound increment (0 if no wraparound).

Definition at line 75 of file ip_grid_mod.F90.

◆ jm

integer ip_grid_mod::ip_grid::jm

Number of y points.

Definition at line 63 of file ip_grid_mod.F90.

◆ jwrap1

integer ip_grid_mod::ip_grid::jwrap1

y wraparound lower pivot point (0 if no wraparound).

Definition at line 76 of file ip_grid_mod.F90.

◆ jwrap2

integer ip_grid_mod::ip_grid::jwrap2

y wraparound upper pivot point (0 if no wraparound).

Definition at line 77 of file ip_grid_mod.F90.

◆ kscan

integer ip_grid_mod::ip_grid::kscan

Mass/wind flag for staggered diagonal (0 if mass; 1 if wind).

Definition at line 71 of file ip_grid_mod.F90.

◆ nm

integer ip_grid_mod::ip_grid::nm

Total number of points.

Definition at line 64 of file ip_grid_mod.F90.

◆ nscan

integer ip_grid_mod::ip_grid::nscan

Parameters

Scanning

mode.

0 if x first then y;
1 if y first then x;
3 if staggered diagonal like projection 203.

Definition at line 70 of file ip_grid_mod.F90.

◆ nscan_field_pos

integer ip_grid_mod::ip_grid::nscan_field_pos

nscan for field_pos routine.

Can be different than nscan due to differences in grib/grib2.

Definition at line 73 of file ip_grid_mod.F90.

◆ rerth

real ip_grid_mod::ip_grid::rerth

Radius of the Earth.

Definition at line 78 of file ip_grid_mod.F90.

The documentation for this type was generated from the following file:

ip_grid_mod.F90

Public Member Functions

Data Fields