ESMF_CalendarDestroy Subroutine

public subroutine ESMF_CalendarDestroy(calendar, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Calendar), intent(inout) :: calendar
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Calls

proc~~esmf_calendardestroy~~CallsGraph proc~esmf_calendardestroy ESMF_CalendarDestroy c_esmc_calendardestroy c_esmc_calendardestroy proc~esmf_calendardestroy->c_esmc_calendardestroy proc~esmf_calendargetinit ESMF_CalendarGetInit proc~esmf_calendardestroy->proc~esmf_calendargetinit proc~esmf_imerr ESMF_IMErr proc~esmf_calendardestroy->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_calendardestroy->proc~esmf_logfounderror 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_calendardestroy~~CalledByGraph proc~esmf_calendardestroy ESMF_CalendarDestroy program~concurrentcomponent ConcurrentComponent program~concurrentcomponent->proc~esmf_calendardestroy program~esmf_alarmtest ESMF_AlarmTest program~esmf_alarmtest->proc~esmf_calendardestroy program~esmf_appmainex ESMF_AppMainEx program~esmf_appmainex->proc~esmf_calendardestroy program~esmf_appmainex~2 ESMF_AppMainEx program~esmf_appmainex~2->proc~esmf_calendardestroy program~esmf_appmainex~3 ESMF_AppMainEx program~esmf_appmainex~3->proc~esmf_calendardestroy program~esmf_calendarex ESMF_CalendarEx program~esmf_calendarex->proc~esmf_calendardestroy program~esmf_calendarutest ESMF_CalendarUTest program~esmf_calendarutest->proc~esmf_calendardestroy program~esmf_clocktest ESMF_ClockTest program~esmf_clocktest->proc~esmf_calendardestroy program~esmf_concurrentensemblestest ESMF_ConcurrentEnsembleSTest program~esmf_concurrentensemblestest->proc~esmf_calendardestroy program~esmf_fieldbundlelsredistarb2arbstest ESMF_FieldBundleLSRedistArb2ArbSTest program~esmf_fieldbundlelsredistarb2arbstest->proc~esmf_calendardestroy program~esmf_fieldbundlelsredistarb2arbungrddimstest ESMF_FieldBundleLSRedistArb2ArbUngrdDimSTest program~esmf_fieldbundlelsredistarb2arbungrddimstest->proc~esmf_calendardestroy program~esmf_fieldlsredistarb2arbstest ESMF_FieldLSRedistArb2ArbSTest program~esmf_fieldlsredistarb2arbstest->proc~esmf_calendardestroy program~esmf_fieldlsredistarb2arbungrddimstest ESMF_FieldLSRedistArb2ArbUngrdDimSTest program~esmf_fieldlsredistarb2arbungrddimstest->proc~esmf_calendardestroy program~esmf_fieldlssmmstest ESMF_FieldLSSMMSTest program~esmf_fieldlssmmstest->proc~esmf_calendardestroy program~esmf_fieldmeshsmmstest ESMF_FieldMeshSMMSTest program~esmf_fieldmeshsmmstest->proc~esmf_calendardestroy program~esmf_fieldregridlsstest ESMF_FieldRegridLSSTest program~esmf_fieldregridlsstest->proc~esmf_calendardestroy program~esmf_fieldregridmeshstest ESMF_FieldRegridMeshSTest program~esmf_fieldregridmeshstest->proc~esmf_calendardestroy program~esmf_fieldregridmeshtomeshstest ESMF_FieldRegridMeshToMeshSTest program~esmf_fieldregridmeshtomeshstest->proc~esmf_calendardestroy program~esmf_fieldregridpatchdisjointstest ESMF_FieldRegridPatchDisjointSTest program~esmf_fieldregridpatchdisjointstest->proc~esmf_calendardestroy program~esmf_fieldregridstest ESMF_FieldRegridSTest program~esmf_fieldregridstest->proc~esmf_calendardestroy program~esmf_fieldregridstest~2 ESMF_FieldRegridSTest program~esmf_fieldregridstest~2->proc~esmf_calendardestroy program~esmf_fieldregridstest~3 ESMF_FieldRegridSTest program~esmf_fieldregridstest~3->proc~esmf_calendardestroy program~esmf_sequentialensemblestest ESMF_SequentialEnsembleSTest program~esmf_sequentialensemblestest->proc~esmf_calendardestroy program~esmf_timeutest ESMF_TimeUTest program~esmf_timeutest->proc~esmf_calendardestroy program~fieldconcurrentcomponent FieldConcurrentComponent program~fieldconcurrentcomponent->proc~esmf_calendardestroy program~fieldregridconserv FieldRegridConserv program~fieldregridconserv->proc~esmf_calendardestroy program~fieldregridmulti FieldRegridMulti program~fieldregridmulti->proc~esmf_calendardestroy program~fieldregridorder FieldRegridOrder program~fieldregridorder->proc~esmf_calendardestroy program~mappersimpletwoconcurrentcomps MapperSimpleTwoConcurrentComps program~mappersimpletwoconcurrentcomps->proc~esmf_calendardestroy program~mappertwoconcurrentcomps MapperTwoConcurrentComps program~mappertwoconcurrentcomps->proc~esmf_calendardestroy

Source Code

      subroutine ESMF_CalendarDestroy(calendar, keywordEnforcer, rc)
!
! !ARGUMENTS:
      type(ESMF_Calendar), intent(inout)          :: calendar
      type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
      integer,             intent(out),  optional :: rc
!
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
!     Releases resources associated with this {\tt ESMF\_Calendar}.
!
!     The arguments are:
!     \begin{description}
!     \item[calendar]
!       Release resources associated with this {\tt ESMF\_Calendar} and mark the
!       object as invalid.  It is an error to pass this object into any other
!       routines after being destroyed.
!     \item[[rc]]
!       Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOP
      integer :: localrc                        ! local return code

      ! Assume failure until success
      if (present(rc)) rc = ESMF_RC_NOT_IMPL
      localrc = ESMF_RC_NOT_IMPL

      ! check input
      ESMF_INIT_CHECK_DEEP(ESMF_CalendarGetInit,calendar,rc)

      ! invoke C to C++ entry point
      call c_ESMC_CalendarDestroy(calendar, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return

      ! mark output as successfully deleted
      ESMF_INIT_SET_DELETED(calendar)

      ! Return success
      if (present(rc)) rc = ESMF_SUCCESS
      end subroutine ESMF_CalendarDestroy