ESMF_AlarmDestroy Subroutine

public subroutine ESMF_AlarmDestroy(alarm, keywordEnforcer, rc)

Arguments

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

Calls

proc~~esmf_alarmdestroy~~CallsGraph proc~esmf_alarmdestroy ESMF_AlarmDestroy c_esmc_alarmdestroy c_esmc_alarmdestroy proc~esmf_alarmdestroy->c_esmc_alarmdestroy proc~esmf_alarmgetinit ESMF_AlarmGetInit proc~esmf_alarmdestroy->proc~esmf_alarmgetinit proc~esmf_alarmsetinitdeleted ESMF_AlarmSetInitDeleted proc~esmf_alarmdestroy->proc~esmf_alarmsetinitdeleted proc~esmf_imerr ESMF_IMErr proc~esmf_alarmdestroy->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_alarmdestroy->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_alarmdestroy~~CalledByGraph proc~esmf_alarmdestroy ESMF_AlarmDestroy program~esmf_alarmex ESMF_AlarmEx program~esmf_alarmex->proc~esmf_alarmdestroy program~esmf_alarmtest ESMF_AlarmTest program~esmf_alarmtest->proc~esmf_alarmdestroy

Source Code

      subroutine ESMF_AlarmDestroy(alarm, keywordEnforcer, rc)
!
! !ARGUMENTS:
      type(ESMF_Alarm), intent(inout)          :: alarm
      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:
!     \begin{sloppypar}
!     Releases resources associated with this {\tt ESMF\_Alarm}.  Also
!     removes this {\tt ESMF\_Alarm} from its associated {\tt ESMF\_Clock}'s
!     list of {\tt ESMF\_Alarm}s (removes the {\tt ESMF\_Alarm} pointer from
!     the list).
!     \end{sloppypar}
!
!     The arguments are:
!     \begin{description}
!     \item[alarm]
!       Release resources associated with this {\tt ESMF\_Alarm} 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
! !REQUIREMENTS:
      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_AlarmGetInit,alarm,rc)

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

      ! mark output as successfully deleted
      call ESMF_AlarmSetInitDeleted(alarm)

      if (present(rc)) rc = ESMF_SUCCESS
      end subroutine ESMF_AlarmDestroy