ESMF_ClockMod Module

Uses

Derived Types

type, public :: ESMF_ClockInt

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_TimeInterval),	public		::	TimeStep
type(ESMF_Time),	public		::	StartTime
type(ESMF_Time),	public		::	StopTime
type(ESMF_Time),	public		::	RefTime
type(ESMF_Time),	public		::	CurrTime
type(ESMF_Time),	public		::	PrevTime
integer(kind=ESMF_KIND_I8),	public		::	AdvanceCount
integer,	public		::	ClockMutex
integer,	public		::	NumAlarms
type(ESMF_Alarm),	public,	pointer, dimension(:)	::	AlarmList	=>	null()

type, public :: ESMF_Clock

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_ClockInt),	public,	pointer	::	clockint	=>	null()

Functions

public function ESMF_ClockCreate(name, TimeStep, StartTime, StopTime, RefTime, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in),	optional		::	name
type(ESMF_TimeInterval),	intent(in),	optional		::	TimeStep
type(ESMF_Time),	intent(in)			::	StartTime
type(ESMF_Time),	intent(in)			::	StopTime
type(ESMF_Time),	intent(in),	optional		::	RefTime
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Clock)

public function ESMF_ClockIsStopTime(clock, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(in)			::	clock
integer,	intent(out),	optional		::	rc

Return Value logical

Subroutines

public subroutine ESMF_ClockSet(clock, TimeStep, StartTime, StopTime, RefTime, CurrTime, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(inout)			::	clock
type(ESMF_TimeInterval),	intent(in),	optional		::	TimeStep
type(ESMF_Time),	intent(in),	optional		::	StartTime
type(ESMF_Time),	intent(in),	optional		::	StopTime
type(ESMF_Time),	intent(in),	optional		::	RefTime
type(ESMF_Time),	intent(in),	optional		::	CurrTime
integer,	intent(out),	optional		::	rc

public subroutine ESMF_ClockDestroy(clock, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(inout)			::	clock
integer,	intent(out),	optional		::	rc

public subroutine ESMF_ClockGet(clock, StartTime, CurrTime, AdvanceCount, StopTime, TimeStep, PrevTime, RefTime, AlarmCount, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(in)			::	clock
type(ESMF_Time),	intent(out),	optional		::	StartTime
type(ESMF_Time),	intent(out),	optional		::	CurrTime
integer(kind=ESMF_KIND_I8),	intent(out),	optional		::	AdvanceCount
type(ESMF_Time),	intent(out),	optional		::	StopTime
type(ESMF_TimeInterval),	intent(out),	optional		::	TimeStep
type(ESMF_Time),	intent(out),	optional		::	PrevTime
type(ESMF_Time),	intent(out),	optional		::	RefTime
integer,	intent(out),	optional		::	AlarmCount
integer,	intent(out),	optional		::	rc

public subroutine ESMF_ClockAddAlarm(clock, Alarm, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(inout)			::	clock
type(ESMF_Alarm),	intent(inout)			::	Alarm
integer,	intent(out),	optional		::	rc

public subroutine ESMF_ClockGetAlarmList(clock, AlarmList, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(in)			::	clock
type(ESMF_Alarm),			pointer	::	AlarmList(:)
integer,	intent(out),	optional		::	rc

public subroutine ESMF_ClockAdvance(clock, RingingAlarmList, NumRingingAlarms, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(inout)			::	clock
type(ESMF_Alarm),	intent(out),	optional,	dimension(MAX_ALARMS)	::	RingingAlarmList
integer,	intent(out),	optional		::	NumRingingAlarms
integer,	intent(out),	optional		::	rc

public subroutine ESMF_ClockStopTimeDisable(clock, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(in)			::	clock
integer,	intent(out),	optional		::	rc

public subroutine ESMF_ClockValidate(clock, opts, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(in)			::	clock
character(len=*),	intent(in),	optional		::	opts
integer,	intent(out),	optional		::	rc

public subroutine ESMF_ClockPrint(clock, opts, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(in)			::	clock
character(len=*),	intent(in),	optional		::	opts
integer,	intent(out),	optional		::	rc