ESMF_RouteHandleWrite Subroutine

public subroutine ESMF_RouteHandleWrite(routehandle, fileName, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_RouteHandle), intent(inout) :: routehandle
character(len=*), intent(in) :: fileName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Calls

proc~~esmf_routehandlewrite~~CallsGraph proc~esmf_routehandlewrite ESMF_RouteHandleWrite c_esmc_routehandlewrite c_esmc_routehandlewrite proc~esmf_routehandlewrite->c_esmc_routehandlewrite proc~esmf_imerr ESMF_IMErr proc~esmf_routehandlewrite->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_routehandlewrite->proc~esmf_logfounderror proc~esmf_routehandlegetinit ESMF_RouteHandleGetInit proc~esmf_routehandlewrite->proc~esmf_routehandlegetinit proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep 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 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_routehandlewrite~~CalledByGraph proc~esmf_routehandlewrite ESMF_RouteHandleWrite program~esmf_arraybundleredistutest ESMF_ArrayBundleRedistUTest program~esmf_arraybundleredistutest->proc~esmf_routehandlewrite program~esmf_rhandlefromfileex ESMF_RHandleFromFileEx program~esmf_rhandlefromfileex->proc~esmf_routehandlewrite program~esmf_routehandleadvancedutest ESMF_RouteHandleAdvancedUTest program~esmf_routehandleadvancedutest->proc~esmf_routehandlewrite program~esmf_routehandleutest ESMF_RouteHandleUTest program~esmf_routehandleutest->proc~esmf_routehandlewrite

Source Code

  subroutine ESMF_RouteHandleWrite(routehandle, fileName, keywordEnforcer, rc)
!
! !ARGUMENTS:
    type(ESMF_RouteHandle), intent(inout)         :: routehandle
    character(*),           intent(in)            :: fileName
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,                intent(out), optional :: rc
!
! !DESCRIPTION:
!   Write the RouteHandle to file. The generated file can then be used to
!   re-create the same RouteHandle, on the same number of PETs, using the
!   {\tt ESMF\_RouteHandleCreate(fileName=...)} method.
!
!   The arguments are:
!   \begin{description}
!   \item[routehandle]
!     The {\tt ESMF\_RouteHandle} to be written.
!   \item[fileName]
!     The name of the output file to which the RouteHandle is written.
!   \item[{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ESMF_INIT_CHECK_DEEP(ESMF_RouteHandleGetInit,routehandle,rc)

    call c_ESMC_RouteHandleWrite(routehandle, fileName, localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! Set return values
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_RouteHandleWrite