ESMF_LocStreamMod Module


Uses


Variables

Type Visibility Attributes Name Initial
character(len=*), private, parameter :: version = '$Id$'

Interfaces

public interface ESMF_LocStreamAddKey

  • private subroutine ESMF_LocStreamAddKeyAlloc(locstream, keyName, keywordEnforcer, keyTypeKind, keyUnits, keyLongName, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_TypeKind_Flag), intent(in), optional :: keyTypeKind
    character(len=*), intent(in), optional :: keyUnits
    character(len=*), intent(in), optional :: keyLongName
    integer, intent(out), optional :: rc

  • private subroutine ESMF_LocStreamAddKeyArray(locstream, keyName, keyArray, keywordEnforcer, destroyKey, keyUnits, keyLongName, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    type(ESMF_Array), intent(in) :: keyArray
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    logical, intent(in), optional :: destroyKey
    character(len=*), intent(in), optional :: keyUnits
    character(len=*), intent(in), optional :: keyLongName
    integer, intent(out), optional :: rc

  • private subroutine ESMF_LocStreamAddKeyI4(locstream, keyName, farray, keywordEnforcer, datacopyflag, keyUnits, keyLongName, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    integer(kind=ESMF_KIND_I4), intent(in), dimension(:) :: farray
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
    character(len=*), intent(in), optional :: keyUnits
    character(len=*), intent(in), optional :: keyLongName
    integer, intent(out), optional :: rc

  • private subroutine ESMF_LocStreamAddKeyR4(locstream, keyName, farray, keywordEnforcer, datacopyflag, keyUnits, keyLongName, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    real(kind=ESMF_KIND_R4), intent(in), dimension(:) :: farray
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
    character(len=*), intent(in), optional :: keyUnits
    character(len=*), intent(in), optional :: keyLongName
    integer, intent(out), optional :: rc

  • private subroutine ESMF_LocStreamAddKeyR8(locstream, keyName, farray, keywordEnforcer, datacopyflag, keyUnits, keyLongName, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    real(kind=ESMF_KIND_R8), intent(in), dimension(:) :: farray
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
    character(len=*), intent(in), optional :: keyUnits
    character(len=*), intent(in), optional :: keyLongName
    integer, intent(out), optional :: rc

public interface ESMF_LocStreamCreate

  • private function ESMF_LocStreamCreateFromDG(distgrid, keywordEnforcer, indexflag, coordSys, name, vm, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DistGrid), intent(in) :: distgrid
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_Index_Flag), intent(in), optional :: indexflag
    type(ESMF_CoordSys_Flag), intent(in), optional :: coordSys
    character(len=*), intent(in), optional :: name
    type(ESMF_VM), intent(in), optional :: vm
    integer, intent(out), optional :: rc

    Return Value type(ESMF_LocStream)

  • private function ESMF_LocStreamCreateFromLocal(localCount, keywordEnforcer, indexflag, coordSys, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: localCount
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_Index_Flag), intent(in), optional :: indexflag
    type(ESMF_CoordSys_Flag), intent(in), optional :: coordSys
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_LocStream)

  • private function ESMF_LocStreamCreateFromNewDG(locstream, distgrid, keywordEnforcer, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    type(ESMF_DistGrid), intent(in) :: distgrid
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_LocStream)

  • private function ESMF_LocStreamCreateReg(regDecomp, decompflag, minIndex, maxIndex, keywordEnforcer, coordSys, indexflag, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in), optional :: regDecomp
    type(ESMF_Decomp_Flag), intent(in), optional :: decompflag
    integer, intent(in), optional :: minIndex
    integer, intent(in) :: maxIndex
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_CoordSys_Flag), intent(in), optional :: coordSys
    type(ESMF_Index_Flag), intent(in), optional :: indexflag
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_LocStream)

  • private function ESMF_LocStreamCreateIrreg(minIndex, countsPerDE, keywordEnforcer, indexflag, coordSys, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in), optional :: minIndex
    integer, intent(in) :: countsPerDE(:)
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_Index_Flag), intent(in), optional :: indexflag
    type(ESMF_CoordSys_Flag), intent(in), optional :: coordSys
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_LocStream)

  • private function ESMF_LocStreamCreateByBkgMesh(locstream, background, keywordEnforcer, unmappedaction, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    type(ESMF_Mesh), intent(in) :: background
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_UnmappedAction_Flag), intent(in), optional :: unmappedaction
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_LocStream)

  • private function ESMF_LocStreamCreateByBkgGrid(locstream, background, keywordEnforcer, maskValues, unmappedaction, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    type(ESMF_Grid), intent(in) :: background
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer(kind=ESMF_KIND_I4), intent(in), optional :: maskValues(:)
    type(ESMF_UnmappedAction_Flag), intent(in), optional :: unmappedaction
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_LocStream)

  • private function ESMF_LocStreamCreateFromFile(filename, keywordEnforcer, fileformat, varname, indexflag, centerflag, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    character(len=*), intent(in) :: filename
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_FileFormat_Flag), intent(in), optional :: fileformat
    character(len=*), intent(in), optional :: varname
    type(ESMF_Index_Flag), intent(in), optional :: indexflag
    logical, intent(in), optional :: centerflag
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_LocStream)

public interface ESMF_LocStreamGetKey

  • private subroutine ESMF_LocStreamGetKeyI4(locstream, keyName, keywordEnforcer, localDE, exclusiveLBound, exclusiveUBound, exclusiveCount, computationalLBound, computationalUBound, computationalCount, totalLBound, totalUBound, totalCount, farray, datacopyflag, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer, intent(in), optional :: localDE
    integer, intent(out), optional :: exclusiveLBound
    integer, intent(out), optional :: exclusiveUBound
    integer, intent(out), optional :: exclusiveCount
    integer, intent(out), optional :: computationalLBound
    integer, intent(out), optional :: computationalUBound
    integer, intent(out), optional :: computationalCount
    integer, intent(out), optional :: totalLBound
    integer, intent(out), optional :: totalUBound
    integer, intent(out), optional :: totalCount
    integer(kind=ESMF_KIND_I4), pointer :: farray(:)
    type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
    integer, intent(out), optional :: rc

  • private subroutine ESMF_LocStreamGetKeyR4(locstream, keyName, keywordEnforcer, localDE, exclusiveLBound, exclusiveUBound, exclusiveCount, computationalLBound, computationalUBound, computationalCount, totalLBound, totalUBound, totalCount, farray, datacopyflag, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer, intent(in), optional :: localDE
    integer, intent(out), optional :: exclusiveLBound
    integer, intent(out), optional :: exclusiveUBound
    integer, intent(out), optional :: exclusiveCount
    integer, intent(out), optional :: computationalLBound
    integer, intent(out), optional :: computationalUBound
    integer, intent(out), optional :: computationalCount
    integer, intent(out), optional :: totalLBound
    integer, intent(out), optional :: totalUBound
    integer, intent(out), optional :: totalCount
    real(kind=ESMF_KIND_R4), pointer :: farray(:)
    type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
    integer, intent(out), optional :: rc

  • private subroutine ESMF_LocStreamGetKeyR8(locstream, keyName, keywordEnforcer, localDE, exclusiveLBound, exclusiveUBound, exclusiveCount, computationalLBound, computationalUBound, computationalCount, totalLBound, totalUBound, totalCount, farray, datacopyflag, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer, intent(in), optional :: localDE
    integer, intent(out), optional :: exclusiveLBound
    integer, intent(out), optional :: exclusiveUBound
    integer, intent(out), optional :: exclusiveCount
    integer, intent(out), optional :: computationalLBound
    integer, intent(out), optional :: computationalUBound
    integer, intent(out), optional :: computationalCount
    integer, intent(out), optional :: totalLBound
    integer, intent(out), optional :: totalUBound
    integer, intent(out), optional :: totalCount
    real(kind=ESMF_KIND_R8), pointer :: farray(:)
    type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
    integer, intent(out), optional :: rc

  • private subroutine ESMF_LocStreamGetKeyArray(locstream, keyName, keyArray, keywordEnforcer, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    type(ESMF_Array), intent(out) :: keyArray
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer, intent(out), optional :: rc

  • private subroutine ESMF_LocStreamGetKeyInfo(locstream, keyName, keywordEnforcer, keyUnits, keyLongName, typekind, isPresent, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream
    character(len=*), intent(in) :: keyName
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    character(len=*), intent(out), optional :: keyUnits
    character(len=*), intent(out), optional :: keyLongName
    type(ESMF_TypeKind_Flag), intent(out), optional :: typekind
    logical, intent(out), optional :: isPresent
    integer, intent(out), optional :: rc

public interface operator(/=)

  • private impure elemental function ESMF_LocStreamNE(locstream1, locstream2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream1
    type(ESMF_LocStream), intent(in) :: locstream2

    Return Value logical

public interface operator(==)

  • private impure elemental function ESMF_LocStreamEQ(locstream1, locstream2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_LocStream), intent(in) :: locstream1
    type(ESMF_LocStream), intent(in) :: locstream2

    Return Value logical


Derived Types

type, public, sequence  ::  ESMF_LocStream

Components

Type Visibility Attributes Name Initial
integer(kind=ESMF_KIND_I8), public :: isInit = 76838410
type(ESMF_LocStreamType), public, pointer :: lstypep

type, public, sequence  ::  ESMF_LocStreamType

Components

Type Visibility Attributes Name Initial
character(len=ESMF_MAXSTR), public, pointer :: keyLongNames(:)
character(len=ESMF_MAXSTR), public, pointer :: keyNames(:)
character(len=ESMF_MAXSTR), public, pointer :: keyUnits(:)
integer(kind=ESMF_KIND_I8), public :: isInit = 76838410
integer, public :: keyCount
logical, public :: destroyDistgrid
logical, public, pointer :: destroyKeys(:)
type(ESMF_Array), public, pointer :: keys(:)
type(ESMF_Base), public :: base
type(ESMF_CoordSys_Flag), public :: coordSys
type(ESMF_DistGrid), public :: distgrid
type(ESMF_Index_Flag), public :: indexflag

Functions

public function ESMF_LocStreamGetInit(d)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in), optional :: d

Return Value integer(kind=ESMF_KIND_I8)

public function ESMF_LocStreamTypeGetInit(s)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStreamType), intent(in), optional :: s

Return Value integer(kind=ESMF_KIND_I8)

private impure elemental function ESMF_LocStreamEQ(locstream1, locstream2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream1
type(ESMF_LocStream), intent(in) :: locstream2

Return Value logical

public function ESMF_LocStreamIsCreated(locstream, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Return Value logical

public function ESMF_LocStreamMatch(locstream1, locstream2, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream1
type(ESMF_LocStream), intent(in) :: locstream2
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Return Value logical

private impure elemental function ESMF_LocStreamNE(locstream1, locstream2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream1
type(ESMF_LocStream), intent(in) :: locstream2

Return Value logical

private function ESMF_LocStreamCreateByBkgGrid(locstream, background, keywordEnforcer, maskValues, unmappedaction, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
type(ESMF_Grid), intent(in) :: background
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer(kind=ESMF_KIND_I4), intent(in), optional :: maskValues(:)
type(ESMF_UnmappedAction_Flag), intent(in), optional :: unmappedaction
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateByBkgMesh(locstream, background, keywordEnforcer, unmappedaction, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
type(ESMF_Mesh), intent(in) :: background
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_UnmappedAction_Flag), intent(in), optional :: unmappedaction
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateFromDG(distgrid, keywordEnforcer, indexflag, coordSys, name, vm, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_DistGrid), intent(in) :: distgrid
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Index_Flag), intent(in), optional :: indexflag
type(ESMF_CoordSys_Flag), intent(in), optional :: coordSys
character(len=*), intent(in), optional :: name
type(ESMF_VM), intent(in), optional :: vm
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateFromFile(filename, keywordEnforcer, fileformat, varname, indexflag, centerflag, name, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: filename
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_FileFormat_Flag), intent(in), optional :: fileformat
character(len=*), intent(in), optional :: varname
type(ESMF_Index_Flag), intent(in), optional :: indexflag
logical, intent(in), optional :: centerflag
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateFromLocal(localCount, keywordEnforcer, indexflag, coordSys, name, rc)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: localCount
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Index_Flag), intent(in), optional :: indexflag
type(ESMF_CoordSys_Flag), intent(in), optional :: coordSys
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateFromNewDG(locstream, distgrid, keywordEnforcer, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
type(ESMF_DistGrid), intent(in) :: distgrid
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateIrreg(minIndex, countsPerDE, keywordEnforcer, indexflag, coordSys, name, rc)

Arguments

Type IntentOptional Attributes Name
integer, intent(in), optional :: minIndex
integer, intent(in) :: countsPerDE(:)
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Index_Flag), intent(in), optional :: indexflag
type(ESMF_CoordSys_Flag), intent(in), optional :: coordSys
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreatePetList(locstream, name, petList, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in), optional :: name
integer, intent(in) :: petList(:)
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateReg(regDecomp, decompflag, minIndex, maxIndex, keywordEnforcer, coordSys, indexflag, name, rc)

Arguments

Type IntentOptional Attributes Name
integer, intent(in), optional :: regDecomp
type(ESMF_Decomp_Flag), intent(in), optional :: decompflag
integer, intent(in), optional :: minIndex
integer, intent(in) :: maxIndex
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_CoordSys_Flag), intent(in), optional :: coordSys
type(ESMF_Index_Flag), intent(in), optional :: indexflag
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)

public function ESMF_LocStreamDeserialize(buffer, offset, rc)

Arguments

Type IntentOptional Attributes Name
character(len=1), pointer, dimension(:) :: buffer
integer, intent(inout) :: offset
integer, intent(out), optional :: rc

Return Value type(ESMF_LocStream)


Subroutines

private subroutine ESMF_LocStreamAddKeyAlloc(locstream, keyName, keywordEnforcer, keyTypeKind, keyUnits, keyLongName, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_TypeKind_Flag), intent(in), optional :: keyTypeKind
character(len=*), intent(in), optional :: keyUnits
character(len=*), intent(in), optional :: keyLongName
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamAddKeyArray(locstream, keyName, keyArray, keywordEnforcer, destroyKey, keyUnits, keyLongName, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
type(ESMF_Array), intent(in) :: keyArray
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
logical, intent(in), optional :: destroyKey
character(len=*), intent(in), optional :: keyUnits
character(len=*), intent(in), optional :: keyLongName
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamAddKeyI4(locstream, keyName, farray, keywordEnforcer, datacopyflag, keyUnits, keyLongName, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
integer(kind=ESMF_KIND_I4), intent(in), dimension(:) :: farray
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
character(len=*), intent(in), optional :: keyUnits
character(len=*), intent(in), optional :: keyLongName
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamAddKeyR4(locstream, keyName, farray, keywordEnforcer, datacopyflag, keyUnits, keyLongName, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
real(kind=ESMF_KIND_R4), intent(in), dimension(:) :: farray
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
character(len=*), intent(in), optional :: keyUnits
character(len=*), intent(in), optional :: keyLongName
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamAddKeyR8(locstream, keyName, farray, keywordEnforcer, datacopyflag, keyUnits, keyLongName, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
real(kind=ESMF_KIND_R8), intent(in), dimension(:) :: farray
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
character(len=*), intent(in), optional :: keyUnits
character(len=*), intent(in), optional :: keyLongName
integer, intent(out), optional :: rc

public subroutine ESMF_LocStreamDestroy(locstream, keywordEnforcer, noGarbage, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(inout) :: locstream
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
logical, intent(in), optional :: noGarbage
integer, intent(out), optional :: rc

public subroutine ESMF_LocStreamDestruct(lstypep, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStreamType), pointer :: lstypep
integer, intent(out), optional :: rc

public subroutine ESMF_LocStreamGet(locstream, keywordEnforcer, distgrid, keyCount, keyNames, localDECount, indexflag, coordSys, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_DistGrid), intent(out), optional :: distgrid
integer, intent(out), optional :: keyCount
character(len=ESMF_MAXSTR), optional :: keyNames(:)
integer, intent(out), optional :: localDECount
type(ESMF_Index_Flag), intent(out), optional :: indexflag
type(ESMF_CoordSys_Flag), intent(out), optional :: coordSys
character(len=*), intent(out), optional :: name
integer, intent(out), optional :: rc

public subroutine ESMF_LocStreamGetBounds(locstream, keywordEnforcer, localDE, exclusiveLBound, exclusiveUBound, exclusiveCount, computationalLBound, computationalUBound, computationalCount, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: localDE
integer, intent(out), optional :: exclusiveLBound
integer, intent(out), optional :: exclusiveUBound
integer, intent(out), optional :: exclusiveCount
integer, intent(out), optional :: computationalLBound
integer, intent(out), optional :: computationalUBound
integer, intent(out), optional :: computationalCount
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamGetKeyArray(locstream, keyName, keyArray, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
type(ESMF_Array), intent(out) :: keyArray
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamGetKeyI4(locstream, keyName, keywordEnforcer, localDE, exclusiveLBound, exclusiveUBound, exclusiveCount, computationalLBound, computationalUBound, computationalCount, totalLBound, totalUBound, totalCount, farray, datacopyflag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: localDE
integer, intent(out), optional :: exclusiveLBound
integer, intent(out), optional :: exclusiveUBound
integer, intent(out), optional :: exclusiveCount
integer, intent(out), optional :: computationalLBound
integer, intent(out), optional :: computationalUBound
integer, intent(out), optional :: computationalCount
integer, intent(out), optional :: totalLBound
integer, intent(out), optional :: totalUBound
integer, intent(out), optional :: totalCount
integer(kind=ESMF_KIND_I4), pointer :: farray(:)
type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamGetKeyInfo(locstream, keyName, keywordEnforcer, keyUnits, keyLongName, typekind, isPresent, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(out), optional :: keyUnits
character(len=*), intent(out), optional :: keyLongName
type(ESMF_TypeKind_Flag), intent(out), optional :: typekind
logical, intent(out), optional :: isPresent
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamGetKeyR4(locstream, keyName, keywordEnforcer, localDE, exclusiveLBound, exclusiveUBound, exclusiveCount, computationalLBound, computationalUBound, computationalCount, totalLBound, totalUBound, totalCount, farray, datacopyflag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: localDE
integer, intent(out), optional :: exclusiveLBound
integer, intent(out), optional :: exclusiveUBound
integer, intent(out), optional :: exclusiveCount
integer, intent(out), optional :: computationalLBound
integer, intent(out), optional :: computationalUBound
integer, intent(out), optional :: computationalCount
integer, intent(out), optional :: totalLBound
integer, intent(out), optional :: totalUBound
integer, intent(out), optional :: totalCount
real(kind=ESMF_KIND_R4), pointer :: farray(:)
type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamGetKeyR8(locstream, keyName, keywordEnforcer, localDE, exclusiveLBound, exclusiveUBound, exclusiveCount, computationalLBound, computationalUBound, computationalCount, totalLBound, totalUBound, totalCount, farray, datacopyflag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: keyName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: localDE
integer, intent(out), optional :: exclusiveLBound
integer, intent(out), optional :: exclusiveUBound
integer, intent(out), optional :: exclusiveCount
integer, intent(out), optional :: computationalLBound
integer, intent(out), optional :: computationalUBound
integer, intent(out), optional :: computationalCount
integer, intent(out), optional :: totalLBound
integer, intent(out), optional :: totalUBound
integer, intent(out), optional :: totalCount
real(kind=ESMF_KIND_R8), pointer :: farray(:)
type(ESMF_DataCopy_Flag), intent(in), optional :: datacopyflag
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamGetNumLocal(locstream, localCount, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
integer, intent(out) :: localCount
integer, intent(out), optional :: rc

private subroutine ESMF_LocStreamGetPntList(locstream, coordKeyNames, pntDim, pntCount, pntList, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
character(len=*), intent(in) :: coordKeyNames
integer, intent(in) :: pntDim
integer, intent(in) :: pntCount
real(kind=ESMF_KIND_R8), intent(out), dimension(:) :: pntList
integer, intent(out), optional :: rc

public subroutine ESMF_LocStreamPrint(locstream, keywordEnforcer, options, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: options
integer, intent(out), optional :: rc

public subroutine ESMF_LocStreamSerialize(locstream, buffer, length, offset, inquireflag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(inout) :: locstream
character(len=1), pointer, dimension(:) :: buffer
integer, intent(inout) :: length
integer, intent(inout) :: offset
type(ESMF_InquireFlag), intent(in), optional :: inquireflag
integer, intent(out), optional :: rc

public subroutine ESMF_LocStreamTypeInit(s)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStreamType) :: s

public subroutine ESMF_LocStreamTypeValidate(s, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStreamType), intent(inout) :: s
integer, intent(out), optional :: rc

public subroutine ESMF_LocStreamValidate(locstream, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_LocStream), intent(in) :: locstream
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

private subroutine ESMF_StripKey(string, key)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(inout) :: string
character(len=*), intent(out) :: key