ESMF_ClockMod Module


Uses


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, 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
    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, 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
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, 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
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