MAPL_LocStreamMod Module

MODULE: MAPL_LocStreamMod

Author: GMAO SI-Team

The module MAPL_LocStreamMod manipulates location streams.


Uses

  • module~~mapl_locstreammod~~UsesGraph module~mapl_locstreammod MAPL_LocStreamMod ESMF ESMF module~mapl_locstreammod->ESMF iso_fortran_env iso_fortran_env module~mapl_locstreammod->iso_fortran_env module~esmfl_mod ESMFL_MOD module~mapl_locstreammod->module~esmfl_mod module~mapl_basemod MAPL_BaseMod module~mapl_locstreammod->module~mapl_basemod module~mapl_commsmod MAPL_CommsMod module~mapl_locstreammod->module~mapl_commsmod module~mapl_constants MAPL_Constants module~mapl_locstreammod->module~mapl_constants module~mapl_exceptionhandling MAPL_ExceptionHandling module~mapl_locstreammod->module~mapl_exceptionhandling module~mapl_hashmod MAPL_HashMod module~mapl_locstreammod->module~mapl_hashmod module~mapl_iomod MAPL_IOMod module~mapl_locstreammod->module~mapl_iomod module~mapl_shmemmod MAPL_ShmemMod module~mapl_locstreammod->module~mapl_shmemmod mpi mpi module~mapl_locstreammod->mpi module~esmfl_mod->ESMF module~esmfl_mod->iso_fortran_env module~esmfl_mod->module~mapl_basemod module~esmfl_mod->module~mapl_commsmod module~esmfl_mod->module~mapl_constants module~esmfl_mod->module~mapl_exceptionhandling module~mapl_basemod->module~mapl_constants module~mapl_base MAPL_Base module~mapl_basemod->module~mapl_base module~mapl_maplgrid mapl_MaplGrid module~mapl_basemod->module~mapl_maplgrid module~mapl_rangemod MAPL_RangeMod module~mapl_basemod->module~mapl_rangemod module~mapl_commsmod->ESMF module~mapl_commsmod->module~mapl_basemod module~mapl_commsmod->module~mapl_constants module~mapl_commsmod->module~mapl_exceptionhandling module~mapl_commsmod->module~mapl_shmemmod module~mapl_commsmod->mpi module~mapl_constants->iso_fortran_env module~mapl_internalconstantsmod MAPL_InternalConstantsMod module~mapl_constants->module~mapl_internalconstantsmod module~mapl_mathconstantsmod MAPL_MathConstantsMod module~mapl_constants->module~mapl_mathconstantsmod module~mapl_physicalconstantsmod MAPL_PhysicalConstantsMod module~mapl_constants->module~mapl_physicalconstantsmod module~mapl_errorhandlingmod MAPL_ErrorHandlingMod module~mapl_exceptionhandling->module~mapl_errorhandlingmod module~mapl_throwmod MAPL_ThrowMod module~mapl_exceptionhandling->module~mapl_throwmod module~mapl_hashmod->module~mapl_exceptionhandling module~biniomod BinIOMod module~mapl_iomod->module~biniomod module~fileiosharedmod FileIOSharedMod module~mapl_iomod->module~fileiosharedmod module~nciomod NCIOMod module~mapl_iomod->module~nciomod module~mapl_shmem MAPL_Shmem module~mapl_shmemmod->module~mapl_shmem

Used by

  • module~~mapl_locstreammod~~UsedByGraph module~mapl_locstreammod MAPL_LocStreamMod module~mapl_capgridcompmod MAPL_CapGridCompMod module~mapl_capgridcompmod->module~mapl_locstreammod module~mapl_genericmod MAPL_GenericMod module~mapl_capgridcompmod->module~mapl_genericmod module~mapl_historygridcompmod MAPL_HistoryGridCompMod module~mapl_capgridcompmod->module~mapl_historygridcompmod module~mapl_genericmod->module~mapl_locstreammod module~mapl_historygridcompmod->module~mapl_locstreammod module~mapl_historygridcompmod->module~mapl_genericmod module~maplbase_mod MAPLBase_Mod module~maplbase_mod->module~mapl_locstreammod module~extdata_drivergridcompmod ExtData_DriverGridCompMod module~extdata_drivergridcompmod->module~mapl_historygridcompmod module~historytrajectorymod HistoryTrajectoryMod module~historytrajectorymod->module~mapl_genericmod module~mapl MAPL module~mapl->module~mapl_genericmod module~mapl->module~maplbase_mod module~mapl_capmod MAPL_CapMod module~mapl_capmod->module~mapl_capgridcompmod module~mapl_extdatagridcomp2g MAPL_ExtDataGridComp2G module~mapl_extdatagridcomp2g->module~mapl_genericmod module~mapl_extdatagridcompmod MAPL_ExtDataGridCompMod module~mapl_extdatagridcompmod->module~mapl_genericmod module~mapl_nuopcwrappermod MAPL_NUOPCWrapperMod module~mapl_nuopcwrappermod->module~maplbase_mod module~mapl_orbgridcompmod MAPL_OrbGridCompMod module~mapl_orbgridcompmod->module~mapl_genericmod module~masksamplergeosatmod MaskSamplerGeosatMod module~masksamplergeosatmod->module~mapl_genericmod module~rutmod RUTMod module~rutmod->module~maplbase_mod module~stationsamplermod StationSamplerMod module~stationsamplermod->module~mapl_genericmod module~test_cfio_bundle Test_CFIO_Bundle module~test_cfio_bundle->module~maplbase_mod program~comp_testing_driver comp_testing_driver program~comp_testing_driver->module~mapl_capgridcompmod program~comp_testing_driver->module~mapl_genericmod program~tstqsat tstqsat program~tstqsat->module~maplbase_mod program~ut_extdata ut_ExtData program~ut_extdata->module~maplbase_mod program~utcfio~2 utCFIO program~utcfio~2->module~maplbase_mod

Interfaces

public interface MAPL_LocStreamCreate

  • private subroutine MAPL_LocStreamCreateFromFile(LocStream, LAYOUT, FILENAME, NAME, MASK, GRID, NewGridNames, use_pfaf, RC)

    Creates a location stream from a file. This does not decompose the location stream; so the global stream is described in each processor. The stream can be decomposed later in various ways. Currently we only decompose it by “attaching” it to a decomposed grid.

    Arguments

    Type IntentOptional Attributes Name
    type(MAPL_LocStream), intent(out) :: LocStream
    type(ESMF_DELayout), intent(in) :: LAYOUT
    character(len=*), intent(in) :: FILENAME
    character(len=*), intent(in) :: NAME
    integer, intent(in), optional :: MASK(:)
    type(ESMF_Grid), intent(inout), optional :: GRID
    logical, intent(in), optional :: NewGridNames
    logical, intent(in), optional :: use_pfaf
    integer, intent(out), optional :: RC

  • private subroutine MAPL_LocStreamCreateFromStream(LocStreamOut, LocStreamIn, NAME, MASK, RC)

    Creates a location stream as a subset of another according to mask.

    Arguments

    Type IntentOptional Attributes Name
    type(MAPL_LocStream), intent(out) :: LocStreamOut
    type(MAPL_LocStream), intent(in) :: LocStreamIn
    character(len=*), intent(in) :: NAME
    integer, intent(in), optional :: MASK(:)
    integer, intent(out), optional :: RC

public interface MAPL_LocStreamTransform

  • private subroutine MAPL_LocStreamTransformField(LocStream, OUTPUT, INPUT, MASK, GRID_ID, GLOBAL, ISMINE, INTERP, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(MAPL_LocStream), intent(in) :: LocStream
    type(ESMF_Field), intent(out) :: OUTPUT
    type(ESMF_Field), intent(inout) :: INPUT
    integer, intent(in), optional :: MASK(:)
    integer, intent(in), optional :: GRID_ID
    logical, intent(in), optional :: GLOBAL
    logical, intent(in), optional :: ISMINE(:)
    logical, intent(in), optional :: INTERP
    integer, intent(out), optional :: RC

  • private subroutine MAPL_LocStreamTransformT2G(LocStream, OUTPUT, INPUT, MASK, SAMPLE, TRANSPOSE, variance, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(MAPL_LocStream), intent(in) :: LocStream
    real, intent(inout) :: OUTPUT(:,:)
    real, intent(inout) :: INPUT(:)
    logical, intent(in), optional :: MASK(:)
    logical, intent(in), optional :: SAMPLE
    logical, intent(in), optional :: TRANSPOSE
    logical, intent(in), optional :: variance
    integer, intent(out), optional :: RC

  • private subroutine MAPL_LocStreamTransformG2T(LocStream, OUTPUT, INPUT, MASK, GRID_ID, GLOBAL, ISMINE, INTERP, TRANSPOSE, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(MAPL_LocStream), intent(in) :: LocStream
    real, intent(inout) :: OUTPUT(:)
    real, intent(inout) :: INPUT(:,:)
    logical, intent(in), optional :: MASK(:)
    integer, intent(in), optional :: GRID_ID
    logical, intent(in), optional :: GLOBAL
    logical, intent(in), optional :: ISMINE(:)
    logical, intent(in), optional :: INTERP
    logical, intent(in), optional :: TRANSPOSE
    integer, intent(out), optional :: RC

  • private subroutine MAPL_LocStreamTransformT2T(OUTPUT, XFORM, INPUT, RC)

    Arguments

    Type IntentOptional Attributes Name
    real, intent(out) :: OUTPUT(:)
    type(MAPL_LocStreamXform), intent(in) :: XFORM
    real, intent(in) :: INPUT(:)
    integer, intent(out), optional :: RC

  • private subroutine MAPL_LocStreamTransformT2TR4R8(OUTPUT, XFORM, INPUT, RC)

    Arguments

    Type IntentOptional Attributes Name
    real(kind=ESMF_KIND_R8), intent(out) :: OUTPUT(:)
    type(MAPL_LocStreamXform), intent(in) :: XFORM
    real, intent(in) :: INPUT(:)
    integer, intent(out), optional :: RC

  • private subroutine MAPL_LocStreamTransformT2TR8R4(OUTPUT, XFORM, INPUT, RC)

    Arguments

    Type IntentOptional Attributes Name
    real, intent(out) :: OUTPUT(:)
    type(MAPL_LocStreamXform), intent(in) :: XFORM
    real(kind=ESMF_KIND_R8), intent(in) :: INPUT(:)
    integer, intent(out), optional :: RC

Derived Types

type, public ::  MAPL_LocStream

type, public ::  MAPL_LocStreamXform


Functions

public function MAPL_LocStreamIsAssociated(LocStream, RC)

Arguments

Type IntentOptional Attributes Name
type(MAPL_LocStream), intent(in) :: LocStream
integer, intent(out), optional :: RC

Return Value logical

public function MAPL_LocStreamXformIsAssociated(Xform, RC)

Arguments

Type IntentOptional Attributes Name
type(MAPL_LocStreamXform), intent(in) :: Xform
integer, intent(out), optional :: RC

Return Value logical


Subroutines

public subroutine MAPL_GridCoordAdjust(Grid, Locstream, RC)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Grid), intent(inout) :: Grid
type(MAPL_LocStream), intent(in) :: Locstream
integer, intent(out), optional :: RC

public subroutine MAPL_LocStreamAdjustNsubtiles(LocStream, NSUBTILES, RC)

Arguments

Type IntentOptional Attributes Name
type(MAPL_LocStream), intent(inout) :: LocStream
integer, intent(in) :: NSUBTILES
integer, intent(out), optional :: RC

public subroutine MAPL_LocStreamCreateXform(Xform, LocStreamOut, LocStreamIn, NAME, MASK_OUT, UseFCollect, RC)

Arguments

Type IntentOptional Attributes Name
type(MAPL_LocStreamXform), intent(out) :: Xform
type(MAPL_LocStream), intent(in) :: LocStreamOut
type(MAPL_LocStream), intent(in) :: LocStreamIn
character(len=*), intent(in) :: NAME
logical, intent(in), optional :: MASK_OUT(:)
logical, intent(in), optional :: UseFCollect
integer, intent(out), optional :: RC

public subroutine MAPL_LocStreamFracArea(LocStream, TYPE, AREA, RC)

Arguments

Type IntentOptional Attributes Name
type(MAPL_LocStream), intent(in) :: LocStream
integer, intent(in) :: TYPE
real, intent(out) :: AREA(:,:)
integer, intent(out), optional :: RC

public subroutine MAPL_LocStreamGet(LocStream, NT_LOCAL, nt_global, TILETYPE, TILEKIND, TILELONS, TILELATS, TILEAREA, TILEGRID, GRIDIM, GRIDJM, GRIDNAMES, ATTACHEDGRID, LOCAL_ID, local_i, local_j, RC)

Arguments

Type IntentOptional Attributes Name
type(MAPL_LocStream), intent(in) :: LocStream
integer, intent(out), optional :: NT_LOCAL
integer, intent(out), optional :: nt_global
integer, optional, pointer :: TILETYPE(:)
integer, optional, pointer :: TILEKIND(:)
real, optional, pointer :: TILELONS(:)
real, optional, pointer :: TILELATS(:)
real, optional, pointer :: TILEAREA(:)
type(ESMF_Grid), intent(out), optional :: TILEGRID
integer, optional, pointer :: GRIDIM(:)
integer, optional, pointer :: GRIDJM(:)
character(len=*), optional, pointer :: GRIDNAMES(:)
type(ESMF_Grid), intent(out), optional :: ATTACHEDGRID
integer, optional, pointer :: LOCAL_ID(:)
integer, intent(out), optional, pointer :: local_i(:)
integer, intent(out), optional, pointer :: local_j(:)
integer, intent(out), optional :: RC

public subroutine MAPL_LocStreamTileWeight(LocStream, OUTPUT, INPUT, RC)

Arguments

Type IntentOptional Attributes Name
type(MAPL_LocStream), intent(in) :: LocStream
real, intent(out) :: OUTPUT(:)
real, intent(in) :: INPUT(:,:)
integer, intent(out), optional :: RC