ESMF_RouteHandleCreateFile Function

private function ESMF_RouteHandleCreateFile(fileName, keywordEnforcer, rc)

Arguments

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

Return Value type(ESMF_RouteHandle)


Calls

proc~~esmf_routehandlecreatefile~~CallsGraph proc~esmf_routehandlecreatefile ESMF_RouteHandleCreateFile c_esmc_routehandlecreatefile c_esmc_routehandlecreatefile proc~esmf_routehandlecreatefile->c_esmc_routehandlecreatefile proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_routehandlecreatefile->proc~esmf_logfounderror 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_routehandlecreatefile~~CalledByGraph proc~esmf_routehandlecreatefile ESMF_RouteHandleCreateFile interface~esmf_routehandlecreate ESMF_RouteHandleCreate interface~esmf_routehandlecreate->proc~esmf_routehandlecreatefile proc~fieldbundlecplstore FieldBundleCplStore proc~fieldbundlecplstore->interface~esmf_routehandlecreate program~esmf_arraybundleredistutest ESMF_ArrayBundleRedistUTest program~esmf_arraybundleredistutest->interface~esmf_routehandlecreate program~esmf_infosyncutest ESMF_InfoSyncUTest program~esmf_infosyncutest->interface~esmf_routehandlecreate program~esmf_rhandlefromfileex ESMF_RHandleFromFileEx program~esmf_rhandlefromfileex->interface~esmf_routehandlecreate program~esmf_rhandlefromrhandleex ESMF_RHandleFromRHandleEx program~esmf_rhandlefromrhandleex->interface~esmf_routehandlecreate program~esmf_routehandleadvancedutest ESMF_RouteHandleAdvancedUTest program~esmf_routehandleadvancedutest->interface~esmf_routehandlecreate program~esmf_routehandleutest ESMF_RouteHandleUTest program~esmf_routehandleutest->interface~esmf_routehandlecreate proc~initializeipdv05p6b InitializeIPDv05p6b proc~initializeipdv05p6b->proc~fieldbundlecplstore proc~initializeipdv00p2b InitializeIPDv00p2b proc~initializeipdv00p2b->proc~initializeipdv05p6b

Source Code

  function ESMF_RouteHandleCreateFile(fileName, keywordEnforcer, rc)
!
! !RETURN VALUE:
    type(ESMF_RouteHandle) :: ESMF_RouteHandleCreateFile
!
! !ARGUMENTS:
    character(*),           intent(in)            :: fileName
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,                intent(out), optional :: rc
!
! !DESCRIPTION:
!   Create a new {\tt ESMF\_RouteHandle} object from a file. This method must
!   be called from a VM context that holds exactly as many PETs as were used
!   when generating the file.
!
!   The arguments are:
!   \begin{description}
!   \item[fileName]
!     The name of the RouteHandle file to be read in.
!   \item[{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code
    type(ESMF_RouteHandle)  :: rhandle

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    rhandle%this = ESMF_NULL_POINTER
    ESMF_RouteHandleCreateFile = rhandle

    ! Call C++ create code
    call c_ESMC_RouteHandleCreateFile(rhandle, fileName, localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! Set return values
    ESMF_RouteHandleCreateFile = rhandle

    ! Set init code
    ESMF_INIT_SET_CREATED(ESMF_RouteHandleCreateFile)

    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end function ESMF_RouteHandleCreateFile