shr_map_mod Module


Uses


Variables

Type Visibility Attributes Name Initial
character(len=SHR_KIND_CS), public, parameter :: shr_map_fs_name = 'name'
character(len=SHR_KIND_CS), public, parameter :: shr_map_fs_type = 'type'
character(len=SHR_KIND_CS), public, parameter :: shr_map_fs_algo = 'algo'
character(len=SHR_KIND_CS), public, parameter :: shr_map_fs_mask = 'mask'
character(len=SHR_KIND_CS), public, parameter :: shr_map_fs_vect = 'vect'
character(len=SHR_KIND_CS), public, parameter :: shr_map_fs_nwts = 'nwts'
character(len=SHR_KIND_CS), public, parameter :: shr_map_fs_nsrc = 'nsrc'
character(len=SHR_KIND_CS), public, parameter :: shr_map_fs_ndst = 'ndst'
character(len=*), public, parameter :: shr_map_fs_fill = 'fill    '
character(len=*), public, parameter :: shr_map_fs_cfill = 'cfill   '
character(len=*), public, parameter :: shr_map_fs_remap = 'remap   '
character(len=*), public, parameter :: shr_map_fs_copy = 'copy    '
character(len=*), public, parameter :: shr_map_fs_bilinear = 'bilinear'
character(len=*), public, parameter :: shr_map_fs_nn = 'nn      '
character(len=*), public, parameter :: shr_map_fs_nnoni = 'nnoni   '
character(len=*), public, parameter :: shr_map_fs_nnonj = 'nnonj   '
character(len=*), public, parameter :: shr_map_fs_spval = 'spval   '
character(len=*), public, parameter :: shr_map_fs_srcmask = 'srcmask '
character(len=*), public, parameter :: shr_map_fs_dstmask = 'dstmask '
character(len=*), public, parameter :: shr_map_fs_nomask = 'nomask  '
character(len=*), public, parameter :: shr_map_fs_bothmask = 'bothmask'
character(len=*), public, parameter :: shr_map_fs_scalar = 'scalar  '
character(len=*), public, parameter :: shr_map_fs_vector = 'vector  '
character(len=SHR_KIND_CS), public, parameter :: shr_map_setTru = 'TRUE map'
character(len=SHR_KIND_CS), public, parameter :: shr_map_setFal = 'FALSE m '
integer(kind=SHR_KIND_IN), public, parameter :: shr_map_ispval = -99
real(kind=SHR_KIND_R8), public, parameter :: shr_map_spval = shr_const_spval
integer(kind=SHR_KIND_IN), public, parameter :: shr_map_fs_ntype = 3
character(len=*), public, parameter :: shr_map_fs_types(shr_map_fs_ntype) = (/shr_map_fs_fill, shr_map_fs_cfill, shr_map_fs_remap/)
integer(kind=SHR_KIND_IN), public, parameter :: shr_map_fs_nalgo = 6
character(len=*), public, parameter :: shr_map_fs_algos(shr_map_fs_nalgo) = (/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(kind=SHR_KIND_IN), public, parameter :: shr_map_fs_nmask = 4
character(len=*), public, parameter :: shr_map_fs_masks(shr_map_fs_nmask) = (/shr_map_fs_srcmask, shr_map_fs_dstmask, shr_map_fs_nomask, shr_map_fs_bothmask/)
integer(kind=SHR_KIND_IN), public, parameter :: shr_map_fs_nvect = 2
character(len=*), public, parameter :: shr_map_fs_vects(shr_map_fs_nvect) = (/shr_map_fs_scalar, shr_map_fs_vector/)

Interfaces

public interface shr_map_put

  • private subroutine shr_map_putCS(map, fldStr, cval, verify)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(inout) :: map
    character(len=*), intent(in) :: fldStr
    character(len=*), intent(in) :: cval
    logical, intent(in), optional :: verify

  • private subroutine shr_map_putR8(map, fldStr, rval, verify)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(inout) :: map
    character(len=*), intent(in) :: fldStr
    real(kind=SHR_KIND_R8), intent(in) :: rval
    logical, intent(in), optional :: verify

  • private subroutine shr_map_putIN(map, fldStr, ival, verify)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(inout) :: map
    character(len=*), intent(in) :: fldStr
    integer(kind=SHR_KIND_IN), intent(in) :: ival
    logical, intent(in), optional :: verify

public interface shr_map_get

  • private subroutine shr_map_getCS(map, fldStr, cval)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(in) :: map
    character(len=*), intent(in) :: fldStr
    character(len=*), intent(out) :: cval

  • private subroutine shr_map_getR8(map, fldStr, rval)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(in) :: map
    character(len=*), intent(in) :: fldStr
    real(kind=SHR_KIND_R8), intent(out) :: rval

  • private subroutine shr_map_getIN(map, fldStr, ival)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(in) :: map
    character(len=*), intent(in) :: fldStr
    integer(kind=SHR_KIND_IN), intent(out) :: ival

  • private subroutine shr_map_getAR(map, isrc, idst, wgts)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(in) :: map
    integer(kind=SHR_KIND_IN), optional, pointer :: isrc(:)
    integer(kind=SHR_KIND_IN), optional, pointer :: idst(:)
    real(kind=SHR_KIND_R8), optional, pointer :: wgts(:)

public interface shr_map_mapSet

  • private subroutine shr_map_mapSet_global(map, Xsrc, Ysrc, Msrc, Xdst_in, Ydst, Mdst, name, type, algo, mask, vect, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(inout) :: map
    real(kind=SHR_KIND_R8), intent(in) :: Xsrc(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Ysrc(:,:)
    integer(kind=SHR_KIND_IN), intent(in) :: Msrc(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Xdst_in(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Ydst(:,:)
    integer(kind=SHR_KIND_IN), intent(in) :: Mdst(:,:)
    character(len=*), intent(in), optional :: name
    character(len=*), intent(in), optional :: type
    character(len=*), intent(in), optional :: algo
    character(len=*), intent(in), optional :: mask
    character(len=*), intent(in), optional :: vect
    integer(kind=SHR_KIND_IN), intent(out), optional :: rc

  • private subroutine shr_map_mapSet_dest(map, Xsrc, Ysrc, Msrc, Xdst_in, Ydst, Mdst, ndst, Idst, name, type, algo, mask, vect, rc)

    call shr_map_checkWgts_dest(Msrc,Mdst,map)

    Arguments

    Type IntentOptional Attributes Name
    type(shr_map_mapType), intent(inout) :: map
    real(kind=SHR_KIND_R8), intent(in) :: Xsrc(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Ysrc(:,:)
    integer(kind=SHR_KIND_IN), intent(in) :: Msrc(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Xdst_in(:)
    real(kind=SHR_KIND_R8), intent(in) :: Ydst(:)
    integer(kind=SHR_KIND_IN), intent(in) :: Mdst(:)
    integer(kind=SHR_KIND_IN), intent(in) :: ndst
    integer(kind=SHR_KIND_IN), intent(in) :: Idst(:)
    character(len=*), intent(in), optional :: name
    character(len=*), intent(in), optional :: type
    character(len=*), intent(in), optional :: algo
    character(len=*), intent(in), optional :: mask
    character(len=*), intent(in), optional :: vect
    integer(kind=SHR_KIND_IN), intent(out), optional :: rc

public interface shr_map_mapData

  • private subroutine shr_map_mapDatam(arrsrc, arrdst, map)

    Arguments

    Type IntentOptional Attributes Name
    real(kind=SHR_KIND_R8), intent(in) :: arrsrc(:,:)
    real(kind=SHR_KIND_R8), intent(out) :: arrdst(:,:)
    type(shr_map_mapType), intent(in) :: map

  • private subroutine shr_map_mapDatanm(arrsrc, arrdst, Xsrc, Ysrc, Msrc, Xdst, Ydst, Mdst, name, type, algo, mask, vect, rc)

    Arguments

    Type IntentOptional Attributes Name
    real(kind=SHR_KIND_R8), intent(in) :: arrsrc(:,:)
    real(kind=SHR_KIND_R8), intent(out) :: arrdst(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Xsrc(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Ysrc(:,:)
    integer(kind=SHR_KIND_IN), intent(in) :: Msrc(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Xdst(:,:)
    real(kind=SHR_KIND_R8), intent(in) :: Ydst(:,:)
    integer(kind=SHR_KIND_IN), intent(in) :: Mdst(:,:)
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: type
    character(len=*), intent(in) :: algo
    character(len=*), intent(in) :: mask
    character(len=*), intent(in), optional :: vect
    integer(kind=SHR_KIND_IN), intent(out), optional :: rc

Derived Types

type, public ::  shr_map_mapType


Functions

public function shr_map_checkInit(map)

Arguments

Type IntentOptional Attributes Name
type(shr_map_mapType), intent(in) :: map

Return Value logical

public function shr_map_checkFilled(map)

Arguments

Type IntentOptional Attributes Name
type(shr_map_mapType), intent(in) :: map

Return Value logical


Subroutines

public subroutine shr_map_print(map)

Arguments

Type IntentOptional Attributes Name
type(shr_map_mapType), intent(in) :: map

public subroutine shr_map_listValidOpts()

Arguments

None

public subroutine shr_map_clean(map)

Arguments

Type IntentOptional Attributes Name
type(shr_map_mapType), intent(inout) :: map

public subroutine shr_map_setAbort(flag)

Arguments

Type IntentOptional Attributes Name
logical, intent(in) :: flag

public subroutine shr_map_setDebug(iflag)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: iflag

public subroutine shr_map_setDopole(flag)

Arguments

Type IntentOptional Attributes Name
logical, intent(in) :: flag