ESMF_AlarmCreateCopy Function

private function ESMF_AlarmCreateCopy(alarm, keywordEnforcer, rc)

Arguments

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

Return Value type(ESMF_Alarm)


Calls

proc~~esmf_alarmcreatecopy~~CallsGraph proc~esmf_alarmcreatecopy ESMF_AlarmCreateCopy c_esmc_alarmcreatecopy c_esmc_alarmcreatecopy proc~esmf_alarmcreatecopy->c_esmc_alarmcreatecopy proc~esmf_alarmgetinit ESMF_AlarmGetInit proc~esmf_alarmcreatecopy->proc~esmf_alarmgetinit proc~esmf_alarmsetinitcreated ESMF_AlarmSetInitCreated proc~esmf_alarmcreatecopy->proc~esmf_alarmsetinitcreated proc~esmf_imerr ESMF_IMErr proc~esmf_alarmcreatecopy->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_alarmcreatecopy->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_alarmcreatecopy~~CalledByGraph proc~esmf_alarmcreatecopy ESMF_AlarmCreateCopy interface~esmf_alarmcreate ESMF_AlarmCreate interface~esmf_alarmcreate->proc~esmf_alarmcreatecopy proc~get_sync_alarms get_sync_alarms proc~get_sync_alarms->interface~esmf_alarmcreate proc~nuopc_driveringestrunsequenceff NUOPC_DriverIngestRunSequenceFF proc~nuopc_driveringestrunsequenceff->interface~esmf_alarmcreate program~esmf_alarmex ESMF_AlarmEx program~esmf_alarmex->interface~esmf_alarmcreate program~esmf_alarmtest ESMF_AlarmTest program~esmf_alarmtest->interface~esmf_alarmcreate interface~nuopc_driveringestrunsequence NUOPC_DriverIngestRunSequence interface~nuopc_driveringestrunsequence->proc~nuopc_driveringestrunsequenceff program~mappertwoconcurrentcomps MapperTwoConcurrentComps program~mappertwoconcurrentcomps->proc~get_sync_alarms proc~nuopc_driveringestrunsequencehc NUOPC_DriverIngestRunSequenceHC proc~nuopc_driveringestrunsequencehc->interface~nuopc_driveringestrunsequence proc~setrunsequence SetRunSequence proc~setrunsequence->interface~nuopc_driveringestrunsequence program~esmf_nuopc_utest ESMF_NUOPC_UTest program~esmf_nuopc_utest->interface~nuopc_driveringestrunsequence

Source Code

      function ESMF_AlarmCreateCopy(alarm, keywordEnforcer, rc)

! !RETURN VALUE:
      type(ESMF_Alarm) :: ESMF_AlarmCreateCopy

! !ARGUMENTS:
      type(ESMF_Alarm), intent(in)            :: 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:
!     Creates a complete (deep) copy of a given {\tt ESMF\_Alarm}.
!     The returned {\tt ESMF\_Alarm} copy is associated with the same
!     {\tt ESMF\_Clock} as the original {\tt ESMF\_Alarm}.  If desired, use
!     {\tt ESMF\_AlarmSet(...clock=...)} to re-associate the
!     {\tt ESMF\_Alarm} copy with a different {\tt ESMF\_Clock}.
!
!     The arguments are:
!     \begin{description}
!     \item[alarm]
!        The {\tt ESMF\_Alarm} to copy.
!     \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 to copy alarm
      call c_ESMC_AlarmCreateCopy(ESMF_AlarmCreateCopy, alarm, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return

      ! mark output as successfully initialized
      call ESMF_AlarmSetInitCreated(ESMF_AlarmCreateCopy)

      ! Return success
      if (present(rc)) rc = ESMF_SUCCESS
      end function ESMF_AlarmCreateCopy