fimex2d.F90 File Reference

Fimex F90 interface for 2-dimensional fields. More...

Data Types
interface	fimex2d::FI_READ_DIMENSION
	Read all dimension values from a dimension. More...
interface	fimex2d::FI_GET_DIMENSIONS
	Get dimensions of a variable. More...
interface	fimex2d::FI_READ_FIELD
	Read a 2-dimensional x,y field for any other given dimension(s) More...
interface	fimex2d::FI_WRITE_FIELD
	Write a 2-dimensional x,y field for any other given dimension(s). The file must be pre-generated with the proper dimensions. More...
interface	fimex2d::EPOCH2DTG
	Convert an epoch time to a DTG (YYYYMMDDHH) More...
interface	fimex2d::FI_ERROR
	Print an error string and abort. More...

Modules
module	fimex2d
	Fimex Fortran90 interface for 2-dimensional fields.

Functions/Subroutines
integer(kind=ikind) function	epoch2dtg (EPOCH)
subroutine	fi_error (ERROR_STRING)
subroutine	fi_read_dimension (FIO, DIMSIZE, DIMNAME, DIMVALUES, CUNIT)
subroutine	fi_get_dimensions (FIO, VARNAME, NX, NY, NZ, NREL, NTIMES, X_GEO, Y_GEO, DIMNAME_X, DIMNAME_Y, DIMNAME_Z, DIMNAME_T, DIMNAME_R, BASETIME, VERBOSITY)
subroutine	fi_read_field (FIO, VARNAME, NX, NY, FIELD, STEP, REL, LEVEL, TIME, BASETIME, CUNIT, LCONT_ON_ERROR, VERBOSITY)
subroutine	fi_write_field (FIO, VARNAME, NX, NY, OUTFIELD, STEP, REL, LEVEL, CUNIT, VERBOSITY)

Variables
integer, parameter	fimex2d::rkind =8
integer, parameter	fimex2d::ikind =4
real(kind=rkind), parameter	fimex2d::xundef =1e20

Detailed Description

Fimex F90 interface for 2-dimensional fields.

Function/Subroutine Documentation

integer(kind=ikind) function epoch2dtg

(

real(kind=rkind), intent(in)

EPOCH

)

References fimex2d::ikind, and fimex2d::rkind.

Referenced by fi_read_field(), and fimex2d_example().

subroutine fi_error

(

character(*), intent(in)

ERROR_STRING

)

Referenced by fi_get_dimensions(), fi_read_dimension(), fi_read_field(), fi_write_field(), and fimex2d_example().

subroutine fi_get_dimensions	(	type(fimexio), intent(inout)	FIO,
		character(len=*), intent(in)	VARNAME,
		integer(kind=ikind), intent(out), optional	NX,
		integer(kind=ikind), intent(out), optional	NY,
		integer(kind=ikind), intent(out), optional	NZ,
		integer(kind=ikind), intent(out), optional	NREL,
		integer(kind=ikind), intent(out), optional	NTIMES,
		logical, intent(out), optional	X_GEO,
		logical, intent(out), optional	Y_GEO,
		character(len=*), intent(out), optional	DIMNAME_X,
		character(len=*), intent(out), optional	DIMNAME_Y,
		character(len=*), intent(out), optional	DIMNAME_Z,
		character(len=*), intent(out), optional	DIMNAME_T,
		character(len=*), intent(out), optional	DIMNAME_R,
		real(kind=rkind), intent(out), optional	BASETIME,
		integer(kind=ikind), intent(in), optional	VERBOSITY
	)

References fi_error(), fimex2d::ikind, and fimex2d::rkind.

Referenced by fi_read_field(), fi_write_field(), and fimex2d_example().

subroutine fi_read_dimension	(	type(fimexio), intent(inout)	FIO,
		integer, intent(in)	DIMSIZE,
		character(len=*), intent(in)	DIMNAME,
		real(kind=rkind), dimension(:), intent(out)	DIMVALUES,
		character(len=*), intent(in), optional	CUNIT
	)

References fi_error(), fimex2d::ikind, and fimex2d::rkind.

Referenced by fimex2d_example().

subroutine fi_read_field	(	type(fimexio), intent(inout)	FIO,
		character(len=*), intent(in)	VARNAME,
		integer(kind=ikind), intent(in)	NX,
		integer(kind=ikind), intent(in)	NY,
		real(kind=rkind), dimension(nx,ny), intent(out)	FIELD,
		integer(kind=ikind), intent(in), optional	STEP,
		integer(kind=ikind), intent(in), optional	REL,
		integer(kind=ikind), intent(in), optional	LEVEL,
		real(kind=rkind), intent(out), optional	TIME,
		real(kind=rkind), intent(out), optional	BASETIME,
		character(len=*), intent(in), optional	CUNIT,
		logical, intent(inout), optional	LCONT_ON_ERROR,
		integer(kind=ikind), intent(in), optional	VERBOSITY
	)

References epoch2dtg(), fi_error(), fi_get_dimensions(), fimex2d::ikind, fimex2d::rkind, and fimex2d::xundef.

Referenced by fimex2d_example().

subroutine fi_write_field	(	type(fimexio), intent(inout)	FIO,
		character(len=*), intent(in)	VARNAME,
		integer(kind=ikind), intent(in)	NX,
		integer(kind=ikind), intent(in)	NY,
		real(kind=rkind), dimension(nx,ny), intent(in)	OUTFIELD,
		integer(kind=ikind), intent(in), optional	STEP,
		integer(kind=ikind), intent(in), optional	REL,
		integer(kind=ikind), intent(in), optional	LEVEL,
		character(len=*), intent(in), optional	CUNIT,
		integer(kind=ikind), intent(in), optional	VERBOSITY
	)

References fi_error(), fi_get_dimensions(), fimex2d::ikind, and fimex2d::rkind.

Referenced by fimex2d_example().