ESMF_LocStreamAddKeyR8 Subroutine

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

Calls

proc~~esmf_locstreamaddkeyr8~~CallsGraph proc~esmf_locstreamaddkeyr8 ESMF_LocStreamAddKeyR8 esmf_arraycreate esmf_arraycreate proc~esmf_locstreamaddkeyr8->esmf_arraycreate proc~esmf_imerr ESMF_IMErr proc~esmf_locstreamaddkeyr8->proc~esmf_imerr proc~esmf_locstreamaddkeyarray ESMF_LocStreamAddKeyArray proc~esmf_locstreamaddkeyr8->proc~esmf_locstreamaddkeyarray proc~esmf_locstreamgetinit ESMF_LocStreamGetInit proc~esmf_locstreamaddkeyr8->proc~esmf_locstreamgetinit proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_locstreamaddkeyr8->proc~esmf_logfounderror proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep proc~esmf_locstreamaddkeyarray->proc~esmf_imerr proc~esmf_locstreamaddkeyarray->proc~esmf_locstreamgetinit proc~esmf_locstreamaddkeyarray->proc~esmf_logfounderror esmf_arraygetinit esmf_arraygetinit proc~esmf_locstreamaddkeyarray->esmf_arraygetinit proc~esmf_logfoundallocerror ESMF_LogFoundAllocError proc~esmf_locstreamaddkeyarray->proc~esmf_logfoundallocerror esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite proc~esmf_logfoundallocerror->esmf_breakpoint proc~esmf_logfoundallocerror->proc~esmf_logrc2msg proc~esmf_logfoundallocerror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget

Called by

proc~~esmf_locstreamaddkeyr8~~CalledByGraph proc~esmf_locstreamaddkeyr8 ESMF_LocStreamAddKeyR8 interface~esmf_locstreamaddkey ESMF_LocStreamAddKey interface~esmf_locstreamaddkey->proc~esmf_locstreamaddkeyr8 proc~esmf_locstreamcreatefromnewdg ESMF_LocStreamCreateFromNewDG proc~esmf_locstreamcreatefromnewdg->interface~esmf_locstreamaddkey proc~f_esmf_locstreamaddkeyalloc f_esmf_locstreamaddkeyalloc proc~f_esmf_locstreamaddkeyalloc->interface~esmf_locstreamaddkey proc~test_locstreambkg test_locstreambkg proc~test_locstreambkg->interface~esmf_locstreamaddkey proc~test_locstreambkgnda test_locstreambkgnda proc~test_locstreambkgnda->interface~esmf_locstreamaddkey proc~test_locstreambkgsph test_locstreambkgsph proc~test_locstreambkgsph->interface~esmf_locstreamaddkey proc~test_nearest2dcartlstols test_Nearest2DCartLSToLS proc~test_nearest2dcartlstols->interface~esmf_locstreamaddkey proc~test_nearest3dcartlstols test_Nearest3DCartLSToLS proc~test_nearest3dcartlstols->interface~esmf_locstreamaddkey proc~test_patchmeshtolocstreammask test_PatchMeshToLocStreamMask proc~test_patchmeshtolocstreammask->interface~esmf_locstreamaddkey proc~test_pointlist_from_locstream_nomask test_pointlist_from_locStream_nomask proc~test_pointlist_from_locstream_nomask->interface~esmf_locstreamaddkey proc~test_pointlist_from_locstream_wmask test_pointlist_from_locStream_wmask proc~test_pointlist_from_locstream_wmask->interface~esmf_locstreamaddkey proc~test_regridgridtogml test_regridGridToGML proc~test_regridgridtogml->interface~esmf_locstreamaddkey proc~test_regridgridtolocstream3d test_regridGridToLocStream3d proc~test_regridgridtolocstream3d->interface~esmf_locstreamaddkey proc~test_regridgridtolocstreamloccnt test_regridGridToLocStreamLocCnt proc~test_regridgridtolocstreamloccnt->interface~esmf_locstreamaddkey proc~test_regridgridtolocstreamregdist test_regridGridToLocStreamRegDist proc~test_regridgridtolocstreamregdist->interface~esmf_locstreamaddkey proc~test_regridmeshtolocstreammask test_regridMeshToLocStreamMask proc~test_regridmeshtolocstreammask->interface~esmf_locstreamaddkey proc~test_regridnearestlocstream_wclustertomesh test_regridNearestLocStream_wClusterToMesh proc~test_regridnearestlocstream_wclustertomesh->interface~esmf_locstreamaddkey proc~test_regridnearestlocstreamtogrid test_regridNearestLocStreamToGrid proc~test_regridnearestlocstreamtogrid->interface~esmf_locstreamaddkey proc~test_regridnearestlocstreamtolocstream test_regridNearestLocStreamToLocStream proc~test_regridnearestlocstreamtolocstream->interface~esmf_locstreamaddkey proc~user_init~23 user_init proc~user_init~23->interface~esmf_locstreamaddkey program~esmf_locstreamcreateutest ESMF_LocStreamCreateUTest program~esmf_locstreamcreateutest->interface~esmf_locstreamaddkey program~esmf_locstreamcreateutest->proc~test_locstreambkg program~esmf_locstreamcreateutest->proc~test_locstreambkgnda program~esmf_locstreamcreateutest->proc~test_locstreambkgsph program~esmf_locstreamex ESMF_LocStreamEx program~esmf_locstreamex->interface~esmf_locstreamaddkey interface~esmf_locstreamcreate ESMF_LocStreamCreate interface~esmf_locstreamcreate->proc~esmf_locstreamcreatefromnewdg proc~esmf_locstreamcreatepetlist ESMF_LocStreamCreatePetList proc~esmf_locstreamcreatepetlist->proc~esmf_locstreamcreatefromnewdg program~esmf_pointlistutest ESMF_PointListUTest program~esmf_pointlistutest->proc~test_pointlist_from_locstream_nomask program~esmf_pointlistutest->proc~test_pointlist_from_locstream_wmask

Source Code

  subroutine ESMF_LocStreamAddKeyR8(locstream, keyName, farray, keywordEnforcer, &
       datacopyflag, keyUnits, keyLongName, rc)
!
! !ARGUMENTS:
    type(ESMF_Locstream), intent(in)                   :: locstream
    character (len=*),   intent(in)                    :: keyName
    real(ESMF_KIND_R8),  dimension(:), intent(in)      :: farray
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    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
!
! !DESCRIPTION:
! Add a key to a locstream with a required keyName and a required 
! Fortran array.  The user is responsible for the creation of the 
! Fortran array that will hold the key values, including 
! the maintenance of any allocated memory.
!
! The arguments are:
! \begin{description}
! \item [locstream]
! The {\tt ESMF\_LocStream} object to add key to.
! \item [keyName]
! The name of the key to add. 
! \item[farray] 
! Valid native Fortran array, i.e. memory must be associated with the 
! actual argument. The type/kind/rank information of {\tt farray} will be 
! used to set the key Array's properties accordingly. 
! \item[{[datacopyflag]}] 
! Specifies whether the Array object will reference the memory allocation 
! provided by {\tt farray} directly or will copy the data from 
! {\tt farray} into a new memory allocation. Valid options are 
! {\tt ESMF\_DATACOPY\_REFERENCE} (default) or {\tt ESMF\_DATACOPY\_VALUE}. 
! Depending on the specific situation the {\tt ESMF\_DATACOPY\_REFERENCE} option 
! may be unsafe when specifying an array slice for {\tt farray}. 
! \item [{[keyUnits]}]
! The units of the key data. 
! If not specified, then the item remains blank.  
! \item [{[keyLongName]}]
! The long name of the key data. 
! If not specified, then the item remains blank.  
! \item [{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!EOPI
!------------------------------------------------------------------------------
    type(ESMF_LocStreamType), pointer :: lstypep
    type(ESMF_Array) :: array
    integer :: localrc

    ! Initialize
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ! check variables
    ESMF_INIT_CHECK_DEEP(ESMF_LocStreamGetInit,locstream,rc)

    ! get the pointer to the locstream
    lstypep => locstream%lstypep

   ! Create Array
   array=ESMF_ArrayCreate(lstypep%distgrid, farray, &
                           datacopyflag=datacopyflag, indexflag=lstypep%indexflag,  &
                           name=keyName, rc=localrc)
   if (ESMF_LogFoundError(localrc, &
         ESMF_ERR_PASSTHRU, &
         ESMF_CONTEXT, rcToReturn=rc)) return

   ! Add key to structure
   call ESMF_LocStreamAddKeyArray(locstream, keyName, keyArray=array, destroyKey=.true., &
               keyUnits=keyUnits, keyLongName=keyLongName, rc=localrc)
   if (ESMF_LogFoundError(localrc, &
         ESMF_ERR_PASSTHRU, &
         ESMF_CONTEXT, rcToReturn=rc)) return


   ! return success
   if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_LocStreamAddKeyR8