ESMF_AlarmMod Module


Uses


Variables

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

Interfaces

public interface ESMF_AlarmCreate

  • private function ESMF_AlarmCreateNew(clock, keywordEnforcer, ringTime, ringInterval, stopTime, ringDuration, ringTimeStepCount, refTime, enabled, sticky, name, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Clock), intent(in) :: clock
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_Time), intent(in), optional :: ringTime
    type(ESMF_TimeInterval), intent(in), optional :: ringInterval
    type(ESMF_Time), intent(in), optional :: stopTime
    type(ESMF_TimeInterval), intent(in), optional :: ringDuration
    integer, intent(in), optional :: ringTimeStepCount
    type(ESMF_Time), intent(in), optional :: refTime
    logical, intent(in), optional :: enabled
    logical, intent(in), optional :: sticky
    character(len=*), intent(in), optional :: name
    integer, intent(out), optional :: rc

    Return Value type(ESMF_Alarm)

  • 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)

public interface operator(/=)

  • private impure elemental function ESMF_AlarmNE(alarm1, alarm2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Alarm), intent(in) :: alarm1
    type(ESMF_Alarm), intent(in) :: alarm2

    Return Value logical

public interface operator(==)

  • private impure elemental function ESMF_AlarmEQ(alarm1, alarm2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Alarm), intent(in) :: alarm1
    type(ESMF_Alarm), intent(in) :: alarm2

    Return Value logical


Functions

private impure elemental function ESMF_AlarmEQ(alarm1, alarm2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Alarm), intent(in) :: alarm1
type(ESMF_Alarm), intent(in) :: alarm2

Return Value logical

public function ESMF_AlarmIsCreated(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 logical

public function ESMF_AlarmIsEnabled(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 logical

public function ESMF_AlarmIsRinging(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 logical

public function ESMF_AlarmIsSticky(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 logical

private impure elemental function ESMF_AlarmNE(alarm1, alarm2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Alarm), intent(in) :: alarm1
type(ESMF_Alarm), intent(in) :: alarm2

Return Value logical

public function ESMF_AlarmWasPrevRinging(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 logical

public function ESMF_AlarmWillRingNext(alarm, keywordEnforcer, timeStep, rc)

Arguments

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

Return Value logical

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)

private function ESMF_AlarmCreateNew(clock, keywordEnforcer, ringTime, ringInterval, stopTime, ringDuration, ringTimeStepCount, refTime, enabled, sticky, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Clock), intent(in) :: clock
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Time), intent(in), optional :: ringTime
type(ESMF_TimeInterval), intent(in), optional :: ringInterval
type(ESMF_Time), intent(in), optional :: stopTime
type(ESMF_TimeInterval), intent(in), optional :: ringDuration
integer, intent(in), optional :: ringTimeStepCount
type(ESMF_Time), intent(in), optional :: refTime
logical, intent(in), optional :: enabled
logical, intent(in), optional :: sticky
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_Alarm)

public function ESMF_AlarmReadRestart(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_Alarm)


Subroutines

public subroutine ESMF_AlarmDestroy(alarm, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_AlarmDisable(alarm, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_AlarmEnable(alarm, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_AlarmGet(alarm, keywordEnforcer, clock, ringTime, prevRingTime, ringInterval, stopTime, ringDuration, ringTimeStepCount, timeStepRingingCount, ringBegin, ringEnd, refTime, ringing, ringingOnPrevTimeStep, enabled, sticky, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Alarm), intent(in) :: alarm
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Clock), intent(out), optional :: clock
type(ESMF_Time), intent(out), optional :: ringTime
type(ESMF_Time), intent(out), optional :: prevRingTime
type(ESMF_TimeInterval), intent(out), optional :: ringInterval
type(ESMF_Time), intent(out), optional :: stopTime
type(ESMF_TimeInterval), intent(out), optional :: ringDuration
integer, intent(out), optional :: ringTimeStepCount
integer, intent(out), optional :: timeStepRingingCount
type(ESMF_Time), intent(out), optional :: ringBegin
type(ESMF_Time), intent(out), optional :: ringEnd
type(ESMF_Time), intent(out), optional :: refTime
logical, intent(out), optional :: ringing
logical, intent(out), optional :: ringingOnPrevTimeStep
logical, intent(out), optional :: enabled
logical, intent(out), optional :: sticky
character(len=*), intent(out), optional :: name
integer, intent(out), optional :: rc

public subroutine ESMF_AlarmNotSticky(alarm, keywordEnforcer, ringDuration, ringTimeStepCount, rc)

Arguments

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

public subroutine ESMF_AlarmPrint(alarm, options, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Alarm), intent(in) :: alarm
character(len=*), intent(in), optional :: options
integer, intent(out), optional :: rc

public subroutine ESMF_AlarmRingerOff(alarm, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_AlarmRingerOn(alarm, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_AlarmSet(alarm, keywordEnforcer, clock, ringTime, ringInterval, stopTime, ringDuration, ringTimeStepCount, refTime, ringing, enabled, sticky, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Alarm), intent(inout) :: alarm
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Clock), intent(in), optional :: clock
type(ESMF_Time), intent(in), optional :: ringTime
type(ESMF_TimeInterval), intent(in), optional :: ringInterval
type(ESMF_Time), intent(in), optional :: stopTime
type(ESMF_TimeInterval), intent(in), optional :: ringDuration
integer, intent(in), optional :: ringTimeStepCount
type(ESMF_Time), intent(in), optional :: refTime
logical, intent(in), optional :: ringing
logical, intent(in), optional :: enabled
logical, intent(in), optional :: sticky
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

public subroutine ESMF_AlarmSticky(alarm, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_AlarmValidate(alarm, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_AlarmWriteRestart(alarm, keywordEnforcer, rc)

Arguments

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