ESMF_ClockMod Module


Uses

  • module~~esmf_clockmod~~UsesGraph module~esmf_clockmod ESMF_ClockMod module~esmf_alarmtypemod ESMF_AlarmTypeMod module~esmf_clockmod->module~esmf_alarmtypemod module~esmf_basemod ESMF_BaseMod module~esmf_clockmod->module~esmf_basemod module~esmf_calendarmod ESMF_CalendarMod module~esmf_clockmod->module~esmf_calendarmod module~esmf_clocktypemod ESMF_ClockTypeMod module~esmf_clockmod->module~esmf_clocktypemod module~esmf_initmacrosmod ESMF_InitMacrosMod module~esmf_clockmod->module~esmf_initmacrosmod module~esmf_ioutilmod ESMF_IOUtilMod module~esmf_clockmod->module~esmf_ioutilmod module~esmf_logerrmod ESMF_LogErrMod module~esmf_clockmod->module~esmf_logerrmod module~esmf_timeintervalmod ESMF_TimeIntervalMod module~esmf_clockmod->module~esmf_timeintervalmod module~esmf_timeintervaltypemod ESMF_TimeIntervalTypeMod module~esmf_clockmod->module~esmf_timeintervaltypemod module~esmf_timemod ESMF_TimeMod module~esmf_clockmod->module~esmf_timemod module~esmf_timetypemod ESMF_TimeTypeMod module~esmf_clockmod->module~esmf_timetypemod module~esmf_utiltypesmod ESMF_UtilTypesMod module~esmf_clockmod->module~esmf_utiltypesmod module~esmf_alarmtypemod->module~esmf_basemod module~esmf_alarmtypemod->module~esmf_utiltypesmod module~esmf_basemod->module~esmf_initmacrosmod module~esmf_basemod->module~esmf_ioutilmod module~esmf_basemod->module~esmf_logerrmod module~esmf_basemod->module~esmf_utiltypesmod iso_c_binding iso_c_binding module~esmf_basemod->iso_c_binding module~esmf_vmmod ESMF_VMMod module~esmf_basemod->module~esmf_vmmod module~esmf_calendarmod->module~esmf_basemod module~esmf_calendarmod->module~esmf_initmacrosmod module~esmf_calendarmod->module~esmf_ioutilmod module~esmf_calendarmod->module~esmf_logerrmod module~esmf_calendarmod->module~esmf_utiltypesmod module~esmf_clocktypemod->module~esmf_basemod module~esmf_clocktypemod->module~esmf_utiltypesmod module~esmf_initmacrosmod->module~esmf_logerrmod module~esmf_initmacrosmod->module~esmf_utiltypesmod module~esmf_ioutilmod->module~esmf_utiltypesmod module~esmf_logerrmod->module~esmf_ioutilmod module~esmf_logerrmod->module~esmf_utiltypesmod module~esmf_utilstringmod ESMF_UtilStringMod module~esmf_logerrmod->module~esmf_utilstringmod module~esmf_timeintervalmod->module~esmf_basemod module~esmf_timeintervalmod->module~esmf_calendarmod module~esmf_timeintervalmod->module~esmf_initmacrosmod module~esmf_timeintervalmod->module~esmf_ioutilmod module~esmf_timeintervalmod->module~esmf_logerrmod module~esmf_timeintervalmod->module~esmf_timeintervaltypemod module~esmf_timeintervalmod->module~esmf_timetypemod module~esmf_timeintervalmod->module~esmf_utiltypesmod module~esmf_fractionmod ESMF_FractionMod module~esmf_timeintervalmod->module~esmf_fractionmod module~esmf_timeintervaltypemod->module~esmf_basemod module~esmf_timeintervaltypemod->module~esmf_utiltypesmod module~esmf_timemod->module~esmf_basemod module~esmf_timemod->module~esmf_calendarmod module~esmf_timemod->module~esmf_initmacrosmod module~esmf_timemod->module~esmf_ioutilmod module~esmf_timemod->module~esmf_logerrmod module~esmf_timemod->module~esmf_timeintervaltypemod module~esmf_timemod->module~esmf_timetypemod module~esmf_timemod->module~esmf_utiltypesmod module~esmf_timetypemod->module~esmf_basemod module~esmf_timetypemod->module~esmf_utiltypesmod module~esmf_utiltypesmod->iso_c_binding module~esmf_fractionmod->module~esmf_initmacrosmod module~esmf_fractionmod->module~esmf_utiltypesmod module~esmf_vmmod->module~esmf_initmacrosmod module~esmf_vmmod->module~esmf_ioutilmod module~esmf_vmmod->module~esmf_logerrmod module~esmf_vmmod->module~esmf_utiltypesmod module~esmf_vmmod->iso_c_binding module~esmf_f90interfacemod ESMF_F90InterfaceMod module~esmf_vmmod->module~esmf_f90interfacemod module~esmf_f90interfacemod->module~esmf_logerrmod module~esmf_f90interfacemod->module~esmf_utiltypesmod

Used by

  • module~~esmf_clockmod~~UsedByGraph module~esmf_clockmod ESMF_ClockMod module~esmf ESMF module~esmf->module~esmf_clockmod module~esmf_compmod ESMF_CompMod module~esmf_compmod->module~esmf_clockmod module~esmf_cplcompmod ESMF_CplCompMod module~esmf_cplcompmod->module~esmf_clockmod module~esmf_gridcompmod ESMF_GridCompMod module~esmf_gridcompmod->module~esmf_clockmod module~esmf_traceapimod ESMF_TraceAPIMod module~esmf_traceapimod->module~esmf_clockmod module~esmf_webservmod ESMF_WebServMod module~esmf_webservmod->module~esmf_clockmod module~esmfiomod ESMFIOMod module~esmfiomod->module~esmf_clockmod proc~f_esmf_compexecute f_esmf_compexecute proc~f_esmf_compexecute->module~esmf_clockmod proc~f_esmf_cplcompcreate f_esmf_cplcompcreate proc~f_esmf_cplcompcreate->module~esmf_clockmod proc~f_esmf_cplcompfinalize f_esmf_cplcompfinalize proc~f_esmf_cplcompfinalize->module~esmf_clockmod proc~f_esmf_cplcompinitialize f_esmf_cplcompinitialize proc~f_esmf_cplcompinitialize->module~esmf_clockmod proc~f_esmf_cplcompprocessfinal f_esmf_cplcompprocessfinal proc~f_esmf_cplcompprocessfinal->module~esmf_clockmod proc~f_esmf_cplcompprocessinit f_esmf_cplcompprocessinit proc~f_esmf_cplcompprocessinit->module~esmf_clockmod proc~f_esmf_cplcompprocessrun f_esmf_cplcompprocessrun proc~f_esmf_cplcompprocessrun->module~esmf_clockmod proc~f_esmf_cplcomprun f_esmf_cplcomprun proc~f_esmf_cplcomprun->module~esmf_clockmod proc~f_esmf_gridcompcreate f_esmf_gridcompcreate proc~f_esmf_gridcompcreate->module~esmf_clockmod proc~f_esmf_gridcompfinalize f_esmf_gridcompfinalize proc~f_esmf_gridcompfinalize->module~esmf_clockmod proc~f_esmf_gridcompinitialize f_esmf_gridcompinitialize proc~f_esmf_gridcompinitialize->module~esmf_clockmod proc~f_esmf_gridcomprun f_esmf_gridcomprun proc~f_esmf_gridcomprun->module~esmf_clockmod proc~f_esmf_processfinal f_esmf_processfinal proc~f_esmf_processfinal->module~esmf_clockmod proc~f_esmf_processinit f_esmf_processinit proc~f_esmf_processinit->module~esmf_clockmod proc~f_esmf_processrun f_esmf_processrun proc~f_esmf_processrun->module~esmf_clockmod

Variables

Type Visibility Attributes Name Initial
character(len=*), private, parameter :: version = '$Id$'

Interfaces

public interface ESMF_ClockCreate

  • private function ESMF_ClockCreateNew(timeStep, startTime, keywordEnforcer, stopTime, runDuration, runTimeStepCount, refTime, repeatDuration, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_TimeInterval), intent(in) :: timeStep
    type(ESMF_Time), intent(in) :: startTime
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_Time), intent(in), optional :: stopTime
    type(ESMF_TimeInterval), intent(in), optional :: runDuration
    integer, intent(in), optional :: runTimeStepCount
    type(ESMF_Time), intent(in), optional :: refTime
    type(ESMF_TimeInterval), intent(in), optional :: repeatDuration
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_Clock)

  • private function ESMF_ClockCreateCopy(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 type(ESMF_Clock)

public interface operator(/=)

  • private impure elemental function ESMF_ClockNE(clock1, clock2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Clock), intent(in) :: clock1
    type(ESMF_Clock), intent(in) :: clock2

    Return Value logical

public interface operator(==)

  • private impure elemental function ESMF_ClockEQ(clock1, clock2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Clock), intent(in) :: clock1
    type(ESMF_Clock), intent(in) :: clock2

    Return Value logical


Functions

private impure elemental function ESMF_ClockEQ(clock1, clock2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(in) :: clock1
type(ESMF_Clock), intent(in) :: clock2

Return Value logical

public function ESMF_ClockIsCreated(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

public function ESMF_ClockIsDone(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

public function ESMF_ClockIsReverse(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

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

public function ESMF_ClockIsStopTimeEnabled(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

private impure elemental function ESMF_ClockNE(clock1, clock2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(in) :: clock1
type(ESMF_Clock), intent(in) :: clock2

Return Value logical

private function ESMF_ClockCreateCopy(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 type(ESMF_Clock)

private function ESMF_ClockCreateNew(timeStep, startTime, keywordEnforcer, stopTime, runDuration, runTimeStepCount, refTime, repeatDuration, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_TimeInterval), intent(in) :: timeStep
type(ESMF_Time), intent(in) :: startTime
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Time), intent(in), optional :: stopTime
type(ESMF_TimeInterval), intent(in), optional :: runDuration
integer, intent(in), optional :: runTimeStepCount
type(ESMF_Time), intent(in), optional :: refTime
type(ESMF_TimeInterval), intent(in), optional :: repeatDuration
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_Clock)

public function ESMF_ClockReadRestart(name, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: name
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Return Value type(ESMF_Clock)


Subroutines

public subroutine ESMF_ClockAdvance(clock, keywordEnforcer, timeStep, ringingAlarmList, ringingAlarmCount, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(inout) :: clock
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_TimeInterval), intent(in), optional :: timeStep
type(ESMF_Alarm), intent(out), optional :: ringingAlarmList(:)
integer, intent(out), optional :: ringingAlarmCount
integer, intent(out), optional :: rc

public subroutine ESMF_ClockDestroy(clock, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_ClockGet(clock, keywordEnforcer, timeStep, startTime, stopTime, runDuration, runTimeStepCount, refTime, currTime, prevTime, currSimTime, prevSimTime, calendar, calkindflag, timeZone, advanceCount, alarmCount, direction, repeatDuration, repeatCount, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(in) :: clock
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_TimeInterval), intent(out), optional :: timeStep
type(ESMF_Time), intent(out), optional :: startTime
type(ESMF_Time), intent(out), optional :: stopTime
type(ESMF_TimeInterval), intent(out), optional :: runDuration
real(kind=ESMF_KIND_R8), intent(out), optional :: runTimeStepCount
type(ESMF_Time), intent(out), optional :: refTime
type(ESMF_Time), intent(out), optional :: currTime
type(ESMF_Time), intent(out), optional :: prevTime
type(ESMF_TimeInterval), intent(out), optional :: currSimTime
type(ESMF_TimeInterval), intent(out), optional :: prevSimTime
type(ESMF_Calendar), intent(out), optional :: calendar
type(ESMF_CalKind_Flag), intent(out), optional :: calkindflag
integer, intent(out), optional :: timeZone
integer(kind=ESMF_KIND_I8), intent(out), optional :: advanceCount
integer, intent(out), optional :: alarmCount
type(ESMF_Direction_Flag), intent(out), optional :: direction
type(ESMF_TimeInterval), intent(out), optional :: repeatDuration
integer(kind=ESMF_KIND_I8), intent(out), optional :: repeatCount
character(len=*), intent(out), optional :: name
integer, intent(out), optional :: rc

public subroutine ESMF_ClockGetAlarm(clock, alarmname, alarm, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(in) :: clock
character(len=*), intent(in) :: alarmname
type(ESMF_Alarm), intent(out) :: alarm
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

public subroutine ESMF_ClockGetAlarmList(clock, alarmlistflag, keywordEnforcer, timeStep, alarmList, alarmCount, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(in) :: clock
type(ESMF_AlarmList_Flag), intent(in) :: alarmlistflag
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_TimeInterval), intent(in), optional :: timeStep
type(ESMF_Alarm), intent(out), optional :: alarmList(:)
integer, intent(out), optional :: alarmCount
integer, intent(out), optional :: rc

public subroutine ESMF_ClockGetNextTime(clock, nextTime, keywordEnforcer, timeStep, rc)

Arguments

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

public subroutine ESMF_ClockPrint(clock, keywordEnforcer, options, preString, unit, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(in) :: clock
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: options
character(len=*), intent(in), optional :: preString
character(len=*), intent(out), optional :: unit
integer, intent(out), optional :: rc

public subroutine ESMF_ClockSet(clock, keywordEnforcer, timeStep, startTime, stopTime, runDuration, runTimeStepCount, refTime, currTime, advanceCount, direction, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(inout) :: clock
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_TimeInterval), intent(in), optional :: timeStep
type(ESMF_Time), intent(in), optional :: startTime
type(ESMF_Time), intent(in), optional :: stopTime
type(ESMF_TimeInterval), intent(in), optional :: runDuration
integer, intent(in), optional :: runTimeStepCount
type(ESMF_Time), intent(in), optional :: refTime
type(ESMF_Time), intent(in), optional :: currTime
integer(kind=ESMF_KIND_I8), intent(in), optional :: advanceCount
type(ESMF_Direction_Flag), intent(in), optional :: direction
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

public subroutine ESMF_ClockStopTimeDisable(clock, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_ClockStopTimeEnable(clock, keywordEnforcer, stopTime, rc)

Arguments

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

public subroutine ESMF_ClockSyncToRealTime(clock, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_ClockValidate(clock, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_ClockWriteRestart(clock, keywordEnforcer, rc)

Arguments

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