ESMF_ClockIsStopTime Function

public function ESMF_ClockIsStopTime(clock, keywordEnforcer, rc)

Arguments

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

Return Value logical


Calls

proc~~esmf_clockisstoptime~~CallsGraph proc~esmf_clockisstoptime ESMF_ClockIsStopTime c_esmc_clockisstoptime c_esmc_clockisstoptime proc~esmf_clockisstoptime->c_esmc_clockisstoptime proc~esmf_clockgetinit ESMF_ClockGetInit proc~esmf_clockisstoptime->proc~esmf_clockgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_clockisstoptime->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_clockisstoptime->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_clockisstoptime~~CalledByGraph proc~esmf_clockisstoptime ESMF_ClockIsStopTime proc~get_sync_alarms get_sync_alarms proc~get_sync_alarms->proc~esmf_clockisstoptime proc~nuopc_runsequencectrl NUOPC_RunSequenceCtrl proc~nuopc_runsequencectrl->proc~esmf_clockisstoptime proc~nuopc_runsequencectrl->proc~nuopc_runsequencectrl proc~nuopc_runsequenceiterate NUOPC_RunSequenceIterate proc~nuopc_runsequenceiterate->proc~esmf_clockisstoptime proc~nuopc_runsequenceiterate->proc~nuopc_runsequencectrl proc~routine_run routine_Run proc~routine_run->proc~esmf_clockisstoptime program~concurrentcomponent ConcurrentComponent program~concurrentcomponent->proc~esmf_clockisstoptime program~esmf_alarmex ESMF_AlarmEx program~esmf_alarmex->proc~esmf_clockisstoptime program~esmf_appmainex ESMF_AppMainEx program~esmf_appmainex->proc~esmf_clockisstoptime program~esmf_appmainex~2 ESMF_AppMainEx program~esmf_appmainex~2->proc~esmf_clockisstoptime program~esmf_appmainex~3 ESMF_AppMainEx program~esmf_appmainex~3->proc~esmf_clockisstoptime program~esmf_clockex ESMF_ClockEx program~esmf_clockex->proc~esmf_clockisstoptime program~esmf_concurrentensemblestest ESMF_ConcurrentEnsembleSTest program~esmf_concurrentensemblestest->proc~esmf_clockisstoptime program~esmf_fieldbundlelsredistarb2arbstest ESMF_FieldBundleLSRedistArb2ArbSTest program~esmf_fieldbundlelsredistarb2arbstest->proc~esmf_clockisstoptime program~esmf_fieldbundlelsredistarb2arbungrddimstest ESMF_FieldBundleLSRedistArb2ArbUngrdDimSTest program~esmf_fieldbundlelsredistarb2arbungrddimstest->proc~esmf_clockisstoptime program~esmf_fieldlsredistarb2arbstest ESMF_FieldLSRedistArb2ArbSTest program~esmf_fieldlsredistarb2arbstest->proc~esmf_clockisstoptime program~esmf_fieldlsredistarb2arbungrddimstest ESMF_FieldLSRedistArb2ArbUngrdDimSTest program~esmf_fieldlsredistarb2arbungrddimstest->proc~esmf_clockisstoptime program~esmf_fieldlssmmstest ESMF_FieldLSSMMSTest program~esmf_fieldlssmmstest->proc~esmf_clockisstoptime program~esmf_fieldmeshsmmstest ESMF_FieldMeshSMMSTest program~esmf_fieldmeshsmmstest->proc~esmf_clockisstoptime program~esmf_fieldregridlsstest ESMF_FieldRegridLSSTest program~esmf_fieldregridlsstest->proc~esmf_clockisstoptime program~esmf_fieldregridstest ESMF_FieldRegridSTest program~esmf_fieldregridstest->proc~esmf_clockisstoptime program~esmf_fieldregridstest~2 ESMF_FieldRegridSTest program~esmf_fieldregridstest~2->proc~esmf_clockisstoptime program~esmf_fieldregridstest~3 ESMF_FieldRegridSTest program~esmf_fieldregridstest~3->proc~esmf_clockisstoptime program~esmf_sequentialensemblestest ESMF_SequentialEnsembleSTest program~esmf_sequentialensemblestest->proc~esmf_clockisstoptime program~fieldconcurrentcomponent FieldConcurrentComponent program~fieldconcurrentcomponent->proc~esmf_clockisstoptime program~fieldregridconserv FieldRegridConserv program~fieldregridconserv->proc~esmf_clockisstoptime program~fieldregridmulti FieldRegridMulti program~fieldregridmulti->proc~esmf_clockisstoptime program~fieldregridorder FieldRegridOrder program~fieldregridorder->proc~esmf_clockisstoptime program~mappersimpletwoconcurrentcomps MapperSimpleTwoConcurrentComps program~mappersimpletwoconcurrentcomps->proc~esmf_clockisstoptime program~mappertwoconcurrentcomps MapperTwoConcurrentComps program~mappertwoconcurrentcomps->proc~esmf_clockisstoptime program~mappertwoconcurrentcomps->proc~get_sync_alarms proc~executerunsequence ExecuteRunSequence proc~executerunsequence->proc~nuopc_runsequenceiterate

Source Code

      function ESMF_ClockIsStopTime(clock, keywordEnforcer, rc)
!
! !RETURN VALUE:
      logical :: ESMF_ClockIsStopTime

! !ARGUMENTS:
      type(ESMF_Clock), intent(in)            :: clock
      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:
!     Returns true if the {\tt clock} has reached or exceeded its stop time,
!     and false otherwise.
!
!     The arguments are:
!     \begin{description}
!     \item[clock]
!          The object instance to check.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!EOP
! !REQUIREMENTS:
!     TMG3.5.6
      integer :: localrc                        ! local return code

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

      ! Initialize output value in case of error
      ESMF_ClockIsStopTime = .false.

      ! check input
      ESMF_INIT_CHECK_DEEP(ESMF_ClockGetInit,clock,rc)

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

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