ESMF_AlarmSetThis Subroutine

public subroutine ESMF_AlarmSetThis(alarm, this, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Alarm), intent(inout) :: alarm
type(ESMF_Pointer), intent(in) :: this
integer, intent(out), optional :: rc

Called by

proc~~esmf_alarmsetthis~~CalledByGraph proc~esmf_alarmsetthis ESMF_AlarmSetThis proc~esmf_clockadvance ESMF_ClockAdvance proc~esmf_clockadvance->proc~esmf_alarmsetthis proc~esmf_clockgetalarmlist ESMF_ClockGetAlarmList proc~esmf_clockgetalarmlist->proc~esmf_alarmsetthis proc~get_sync_alarms get_sync_alarms proc~get_sync_alarms->proc~esmf_clockadvance proc~nuopc_runsequencectrl NUOPC_RunSequenceCtrl proc~nuopc_runsequencectrl->proc~esmf_clockadvance proc~nuopc_runsequencectrl->proc~nuopc_runsequencectrl proc~nuopc_runsequenceiterate NUOPC_RunSequenceIterate proc~nuopc_runsequenceiterate->proc~esmf_clockadvance proc~nuopc_runsequenceiterate->proc~nuopc_runsequencectrl proc~routine_run routine_Run proc~routine_run->proc~esmf_clockadvance program~concurrentcomponent ConcurrentComponent program~concurrentcomponent->proc~esmf_clockadvance program~esmf_alarmex ESMF_AlarmEx program~esmf_alarmex->proc~esmf_clockadvance program~esmf_appmainex ESMF_AppMainEx program~esmf_appmainex->proc~esmf_clockadvance program~esmf_appmainex~2 ESMF_AppMainEx program~esmf_appmainex~2->proc~esmf_clockadvance program~esmf_appmainex~3 ESMF_AppMainEx program~esmf_appmainex~3->proc~esmf_clockadvance program~esmf_clockex ESMF_ClockEx program~esmf_clockex->proc~esmf_clockadvance program~esmf_concurrentensemblestest ESMF_ConcurrentEnsembleSTest program~esmf_concurrentensemblestest->proc~esmf_clockadvance program~esmf_fieldbundlelsredistarb2arbstest ESMF_FieldBundleLSRedistArb2ArbSTest program~esmf_fieldbundlelsredistarb2arbstest->proc~esmf_clockadvance program~esmf_fieldbundlelsredistarb2arbungrddimstest ESMF_FieldBundleLSRedistArb2ArbUngrdDimSTest program~esmf_fieldbundlelsredistarb2arbungrddimstest->proc~esmf_clockadvance program~esmf_fieldlsredistarb2arbstest ESMF_FieldLSRedistArb2ArbSTest program~esmf_fieldlsredistarb2arbstest->proc~esmf_clockadvance program~esmf_fieldlsredistarb2arbungrddimstest ESMF_FieldLSRedistArb2ArbUngrdDimSTest program~esmf_fieldlsredistarb2arbungrddimstest->proc~esmf_clockadvance program~esmf_fieldlssmmstest ESMF_FieldLSSMMSTest program~esmf_fieldlssmmstest->proc~esmf_clockadvance program~esmf_fieldmeshsmmstest ESMF_FieldMeshSMMSTest program~esmf_fieldmeshsmmstest->proc~esmf_clockadvance program~esmf_fieldregridlsstest ESMF_FieldRegridLSSTest program~esmf_fieldregridlsstest->proc~esmf_clockadvance program~esmf_fieldregridstest ESMF_FieldRegridSTest program~esmf_fieldregridstest->proc~esmf_clockadvance program~esmf_fieldregridstest~2 ESMF_FieldRegridSTest program~esmf_fieldregridstest~2->proc~esmf_clockadvance program~esmf_fieldregridstest~3 ESMF_FieldRegridSTest program~esmf_fieldregridstest~3->proc~esmf_clockadvance program~esmf_sequentialensemblestest ESMF_SequentialEnsembleSTest program~esmf_sequentialensemblestest->proc~esmf_clockadvance program~fieldconcurrentcomponent FieldConcurrentComponent program~fieldconcurrentcomponent->proc~esmf_clockadvance program~fieldregridconserv FieldRegridConserv program~fieldregridconserv->proc~esmf_clockadvance program~fieldregridmulti FieldRegridMulti program~fieldregridmulti->proc~esmf_clockadvance program~fieldregridorder FieldRegridOrder program~fieldregridorder->proc~esmf_clockadvance program~mappersimpletwoconcurrentcomps MapperSimpleTwoConcurrentComps program~mappersimpletwoconcurrentcomps->proc~esmf_clockadvance program~mappertwoconcurrentcomps MapperTwoConcurrentComps program~mappertwoconcurrentcomps->proc~esmf_clockadvance program~mappertwoconcurrentcomps->proc~get_sync_alarms proc~executerunsequence ExecuteRunSequence proc~executerunsequence->proc~nuopc_runsequenceiterate

Source Code

      subroutine ESMF_AlarmSetThis(alarm, this, rc)
!
! !ARGUMENTS:
      type(ESMF_Alarm),   intent(inout)          :: alarm
      type(ESMF_Pointer), intent(in)             :: this
      integer,            intent(out), optional  :: rc
!
!
! !DESCRIPTION:
!     Set C++ pointer in Alarm.
!
!     The arguments are:
!     \begin{description}
!     \item[alarm]
!          Specified {\tt ESMF\_Alarm} object.
!     \item[this]
!          C++ pointer.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
!------------------------------------------------------------------------------

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

      ! Copy C++ pointer
      alarm%this = this

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

      end subroutine ESMF_AlarmSetThis