shr_map_mod Module Reference

Data Types
type	shr_map_mapType
Functions/Subroutines
logical	shr_map_checkInit (map)
logical	shr_map_checkFilled (map)
logical	shr_map_checkFldStr (fldStr)
logical	shr_map_checkFldStrOpt (fldStr, cval)
subroutine	shr_map_getCS (map, fldStr, cval)
subroutine	shr_map_getIN (map, fldStr, ival)
subroutine	shr_map_getR8 (map, fldStr, rval)
subroutine	shr_map_getAR (map, isrc, idst, wgts)
subroutine	shr_map_putCS (map, fldStr, cval, verify)
subroutine	shr_map_putIN (map, fldStr, ival, verify)
subroutine	shr_map_putR8 (map, fldStr, rval, verify)
subroutine	shr_map_print (map)
subroutine	shr_map_listValidOpts ()
subroutine	shr_map_clean (map)
subroutine	shr_map_mapSet_global (map, Xsrc, Ysrc, Msrc, Xdst_in, Ydst, Mdst, name, type, algo, mask, vect, rc)
subroutine	shr_map_mapSet_dest (map, Xsrc, Ysrc, Msrc, Xdst_in, Ydst, Mdst, ndst, Idst, name, type, algo, mask, vect, rc)
subroutine	shr_map_mapDatam (arrsrc, arrdst, map)
subroutine	shr_map_mapDatanm (arrsrc, arrdst, Xsrc, Ysrc, Msrc, Xdst, Ydst, Mdst, name, type, algo, mask, vect, rc)
subroutine	shr_map_setAbort (flag)
subroutine	shr_map_setDebug (iflag)
subroutine	shr_map_setDopole (flag)
subroutine	shr_map_abort (string)
subroutine	shr_map_checkGrids_global (Xsrc, Ysrc, Msrc, Xdst, Ydst, Mdst, map, rc)
subroutine	shr_map_checkGrids_dest (Xsrc, Ysrc, Msrc, Xdst, Ydst, Mdst, map, rc)
subroutine	shr_map_checkWgts_global (Msrc, Mdst, map)
subroutine	shr_map_getWts (Xdst, Ydst, Xsrc, Ysrc, pti, ptj, ptw, pnum, units)
subroutine	shr_map_find4corners (Xdst, Ydst, Xsrc, Ysrc, il, ir, jl, ju)
subroutine	shr_map_findnn (Xdst, Ydst, Xsrc, Ysrc, Msrc, inn, jnn)
subroutine	shr_map_findnnon (dir, Xdst, Ydst, Xsrc, Ysrc, Msrc, inn, jnn)
real(SHR_KIND_R8)	shr_map_finddist (Xdst, Ydst, Xsrc, Ysrc)
logical	shr_map_checkRad (Grid)
subroutine	shr_map_1dto2d (gid, ni, nj, i, j)
subroutine	shr_map_2dto1d (gid, ni, nj, i, j)
Variables
character(SHR_KIND_CS), parameter	shr_map_fs_name
character(SHR_KIND_CS), parameter	shr_map_fs_type
character(SHR_KIND_CS), parameter	shr_map_fs_algo
character(SHR_KIND_CS), parameter	shr_map_fs_mask
character(SHR_KIND_CS), parameter	shr_map_fs_vect
character(SHR_KIND_CS), parameter	shr_map_fs_nwts
character(SHR_KIND_CS), parameter	shr_map_fs_nsrc
character(SHR_KIND_CS), parameter	shr_map_fs_ndst
character(len=*), paramete	shr_map_fs_fill )
character(len=*), paramete	shr_map_fs_cfill )
character(len=*), paramete	shr_map_fs_remap )
character(len=*), paramete	shr_map_fs_copy )
character(len=*), paramete	shr_map_fs_bilinear )
character(len=*), paramete	shr_map_fs_nn )
character(len=*), paramete	shr_map_fs_nnoni )
character(len=*), paramete	shr_map_fs_nnonj )
character(len=*), paramete	shr_map_fs_spval )
character(len=*), paramete	shr_map_fs_srcmask )
character(len=*), paramete	shr_map_fs_dstmask )
character(len=*), paramete	shr_map_fs_nomask )
character(len=*), paramete	shr_map_fs_bothmask )
character(len=*), paramete	shr_map_fs_scalar )
character(len=*), paramete	shr_map_fs_vector )
character(SHR_KIND_CS), parameter	shr_map_setTru
character(SHR_KIND_CS), parameter	shr_map_setFal
integer(SHR_KIND_IN), parameter	shr_map_ispval = -99
real(SHR_KIND_R8), parameter	shr_map_spval = shr_const_spval
integer(SHR_KIND_IN), parameter	shr_map_fs_ntype = 3
character(len=*), dimension(shr_map_fs_ntype), paramete	shr_map_fs_types ) = (/shr_map_fs_fill, shr_map_fs_cfill, shr_map_fs_remap /)
integer(SHR_KIND_IN), parameter	shr_map_fs_nalgo = 6
character(len=*), dimension(shr_map_fs_nalgo), paramete	shr_map_fs_algos ) = (/shr_map_fs_copy, shr_map_fs_bilinear, shr_map_fs_nn, shr_map_fs_nnoni, shr_map_fs_nnonj, shr_map_fs_spval /)
integer(SHR_KIND_IN), parameter	shr_map_fs_nmask = 4
character(len=*), dimension(shr_map_fs_nmask), paramete	shr_map_fs_masks ) = (/shr_map_fs_srcmask, shr_map_fs_dstmask, shr_map_fs_nomask , shr_map_fs_bothmask /)
integer(SHR_KIND_IN), parameter	shr_map_fs_nvect = 2
character(len=*), dimension(shr_map_fs_nvect), paramete	shr_map_fs_vects ) = (/shr_map_fs_scalar, shr_map_fs_vector /)
logical, save	doabort = .true.
logical, save	dopole = .true.
integer(SHR_KIND_IN), save	debug = 0
character(SHR_KIND_CS), parameter	fillstring
character(SHR_KIND_CS), parameter	inispval
character(SHR_KIND_CS), parameter	initcopy
real(SHR_KIND_R8), parameter	c0 = 0._SHR_KIND_R8
real(SHR_KIND_R8), parameter	c1 = 1._SHR_KIND_R8
real(SHR_KIND_R8), parameter	c2 = 2._SHR_KIND_R8
real(SHR_KIND_R8), parameter	eps = 1.0e-12_SHR_KIND_R8
real(SHR_KIND_R8), parameter	pi = shr_const_pi

Function/Subroutine Documentation

subroutine shr_map_mod::shr_map_1dto2d	(	integer(SHR_KIND_IN),intent(in)	gid,
		integer(SHR_KIND_IN),intent(in)	ni,
		integer(SHR_KIND_IN),intent(in)	nj,
		integer(SHR_KIND_IN),intent(out)	i,
		integer(SHR_KIND_IN),intent(out)	j
	)			`[private]`

Definition at line 3337 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_2dto1d	(	integer(SHR_KIND_IN),intent(out)	gid,
		integer(SHR_KIND_IN),intent(in)	ni,
		integer(SHR_KIND_IN),intent(in)	nj,
		integer(SHR_KIND_IN),intent(in)	i,
		integer(SHR_KIND_IN),intent(in)	j
	)			`[private]`

Definition at line 3361 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_abort ( character(*),intent(in),optional string ) [private]

Definition at line 2303 of file shr_map_mod.F90.

logical shr_map_mod::shr_map_checkFilled ( type(shr_map_mapType),intent(in) map )

Definition at line 297 of file shr_map_mod.F90.

logical shr_map_mod::shr_map_checkFldStr ( character(*) fldStr ) [private]

Definition at line 342 of file shr_map_mod.F90.

logical shr_map_mod::shr_map_checkFldStrOpt	(	character(*),intent(in)	fldStr,
		character(*),intent(in)	cval
	)			`[private]`

Definition at line 390 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_checkGrids_dest	(	real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Msrc,
		real(SHR_KIND_R8),dimension(:),intent(in)	Xdst,
		real(SHR_KIND_R8),dimension(:),intent(in)	Ydst,
		integer(SHR_KIND_IN),dimension(:),intent(in)	Mdst,
		type(shr_map_mapType),intent(in)	map,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)			`[private]`

Definition at line 2538 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_checkGrids_global	(	real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Msrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xdst,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ydst,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Mdst,
		type(shr_map_mapType),intent(in)	map,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)			`[private]`

Definition at line 2348 of file shr_map_mod.F90.

logical shr_map_mod::shr_map_checkInit ( type(shr_map_mapType),intent(in) map )

Definition at line 252 of file shr_map_mod.F90.

logical shr_map_mod::shr_map_checkRad ( real(SHR_KIND_R8),dimension(:,:),intent(in) Grid ) [private]

Definition at line 3317 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_checkWgts_global	(	integer(SHR_KIND_IN),dimension(:,:),intent(in)	Msrc,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Mdst,
		type(shr_map_mapType),intent(in)	map
	)			`[private]`

Definition at line 2719 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_clean ( type(shr_map_mapType),intent(inout) map )

Definition at line 943 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_find4corners	(	real(SHR_KIND_R8),intent(in)	Xdst,
		real(SHR_KIND_R8),intent(in)	Ydst,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),intent(out)	il,
		integer(SHR_KIND_IN),intent(out)	ir,
		integer(SHR_KIND_IN),intent(out)	jl,
		integer(SHR_KIND_IN),intent(out)	ju
	)			`[private]`

Definition at line 3075 of file shr_map_mod.F90.

real(SHR_KIND_R8) shr_map_mod::shr_map_finddist	(	real(SHR_KIND_R8),intent(in)	Xdst,
		real(SHR_KIND_R8),intent(in)	Ydst,
		real(SHR_KIND_R8),intent(in)	Xsrc,
		real(SHR_KIND_R8),intent(in)	Ysrc
	)			`[private]`

Definition at line 3301 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_findnn	(	real(SHR_KIND_R8),intent(in)	Xdst,
		real(SHR_KIND_R8),intent(in)	Ydst,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Msrc,
		integer(SHR_KIND_IN),intent(out)	inn,
		integer(SHR_KIND_IN),intent(out)	jnn
	)			`[private]`

Definition at line 3142 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_findnnon	(	character(*),intent(in)	dir,
		real(SHR_KIND_R8),intent(in)	Xdst,
		real(SHR_KIND_R8),intent(in)	Ydst,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Msrc,
		integer(SHR_KIND_IN),intent(out)	inn,
		integer(SHR_KIND_IN),intent(out)	jnn
	)			`[private]`

Definition at line 3190 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_getAR	(	type(shr_map_mapType),intent(in)	map,
		integer(SHR_KIND_IN),dimension(:),optional,pointer	isrc,
		integer(SHR_KIND_IN),dimension(:),optional,pointer	idst,
		real (SHR_KIND_R8),dimension(:),optional,pointer	wgts
	)			`[private]`

Definition at line 604 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_getCS	(	type(shr_map_mapType),intent(in)	map,
		character(*),intent(in)	fldStr,
		character(*),intent(out)	cval
	)			`[private]`

Definition at line 451 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_getIN	(	type(shr_map_mapType),intent(in)	map,
		character(*),intent(in)	fldStr,
		integer(SHR_KIND_IN),intent(out)	ival
	)			`[private]`

Definition at line 508 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_getR8	(	type(shr_map_mapType),intent(in)	map,
		character(*),intent(in)	fldStr,
		real(SHR_KIND_R8),intent(out)	rval
	)			`[private]`

Definition at line 559 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_getWts	(	real(SHR_KIND_R8),intent(in)	Xdst,
		real(SHR_KIND_R8),intent(in)	Ydst,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),dimension(:),intent(out)	pti,
		integer(SHR_KIND_IN),dimension(:),intent(out)	ptj,
		real(SHR_KIND_R8),dimension(:),intent(out)	ptw,
		integer(SHR_KIND_IN),intent(out)	pnum,
		character(len=*),intent(in),optional	units
	)			`[private]`

Definition at line 2875 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_listValidOpts ( )

Definition at line 891 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_mapDatam	(	real(SHR_KIND_R8),dimension(:,:),intent(in)	arrsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(out)	arrdst,
		type(shr_map_mapType),intent(in)	map
	)			`[private]`

Definition at line 1956 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_mapDatanm	(	real(SHR_KIND_R8),dimension(:,:),intent(in)	arrsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(out)	arrdst,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Msrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xdst,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ydst,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Mdst,
		character(*),intent(in)	name,
		character(*),intent(in)	type,
		character(*),intent(in)	algo,
		character(*),intent(in)	mask,
		character(*),intent(in),optional	vect,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)			`[private]`

Definition at line 2123 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_mapSet_dest	(	type(shr_map_mapType),intent(inout)	map,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Msrc,
		real(SHR_KIND_R8),dimension(:),intent(in)	Xdst_in,
		real(SHR_KIND_R8),dimension(:),intent(in)	Ydst,
		integer(SHR_KIND_IN),dimension(:),intent(in)	Mdst,
		integer(SHR_KIND_IN),intent(in)	ndst,
		integer(SHR_KIND_IN),dimension(:),intent(in)	Idst,
		character(*),intent(in),optional	name,
		character(*),intent(in),optional	type,
		character(*),intent(in),optional	algo,
		character(*),intent(in),optional	mask,
		character(*),intent(in),optional	vect,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)			`[private]`

Definition at line 1507 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_mapSet_global	(	type(shr_map_mapType),intent(inout)	map,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xsrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ysrc,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Msrc,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Xdst_in,
		real(SHR_KIND_R8),dimension(:,:),intent(in)	Ydst,
		integer(SHR_KIND_IN),dimension(:,:),intent(in)	Mdst,
		character(*),intent(in),optional	name,
		character(*),intent(in),optional	type,
		character(*),intent(in),optional	algo,
		character(*),intent(in),optional	mask,
		character(*),intent(in),optional	vect,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)			`[private]`

Definition at line 1027 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_print ( type(shr_map_mapType),intent(in) map )

Definition at line 834 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_putCS	(	type(shr_map_mapType),intent(inout)	map,
		character(*),intent(in)	fldStr,
		character(*),intent(in)	cval,
		logical,intent(in),optional	verify
	)			`[private]`

Definition at line 668 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_putIN	(	type(shr_map_mapType),intent(inout)	map,
		character(*),intent(in)	fldStr,
		integer(SHR_KIND_IN),intent(in)	ival,
		logical,intent(in),optional	verify
	)			`[private]`

Definition at line 730 of file shr_map_mod.F90.

subroutine shr_map_mod::shr_map_putR8	(	type(shr_map_mapType),intent(inout)	map,
		character(*),intent(in)	fldStr,
		real(SHR_KIND_R8),intent(in)	rval,
		logical,intent(in),optional	verify
	)			`[private]`