ESMF_TimeMod Module



Variables

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

Interfaces

public interface ESMF_TimeSet

  • private subroutine ESMF_TimeSetDefault(time, keywordEnforcer, yy, yy_i8, mm, dd, d, d_i8, h, m, s, s_i8, ms, us, ns, d_r8, h_r8, m_r8, s_r8, ms_r8, us_r8, ns_r8, sN, sN_i8, sD, sD_i8, calendar, calkindflag, timeZone, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Time), intent(inout) :: time
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer(kind=ESMF_KIND_I4), intent(in), optional :: yy
    integer(kind=ESMF_KIND_I8), intent(in), optional :: yy_i8
    integer, intent(in), optional :: mm
    integer, intent(in), optional :: dd
    integer(kind=ESMF_KIND_I4), intent(in), optional :: d
    integer(kind=ESMF_KIND_I8), intent(in), optional :: d_i8
    integer(kind=ESMF_KIND_I4), intent(in), optional :: h
    integer(kind=ESMF_KIND_I4), intent(in), optional :: m
    integer(kind=ESMF_KIND_I4), intent(in), optional :: s
    integer(kind=ESMF_KIND_I8), intent(in), optional :: s_i8
    integer(kind=ESMF_KIND_I4), intent(in), optional :: ms
    integer(kind=ESMF_KIND_I4), intent(in), optional :: us
    integer(kind=ESMF_KIND_I4), intent(in), optional :: ns
    real(kind=ESMF_KIND_R8), intent(in), optional :: d_r8
    real(kind=ESMF_KIND_R8), intent(in), optional :: h_r8
    real(kind=ESMF_KIND_R8), intent(in), optional :: m_r8
    real(kind=ESMF_KIND_R8), intent(in), optional :: s_r8
    real(kind=ESMF_KIND_R8), intent(in), optional :: ms_r8
    real(kind=ESMF_KIND_R8), intent(in), optional :: us_r8
    real(kind=ESMF_KIND_R8), intent(in), optional :: ns_r8
    integer(kind=ESMF_KIND_I4), intent(in), optional :: sN
    integer(kind=ESMF_KIND_I8), intent(in), optional :: sN_i8
    integer(kind=ESMF_KIND_I4), intent(in), optional :: sD
    integer(kind=ESMF_KIND_I8), intent(in), optional :: sD_i8
    type(ESMF_Calendar), intent(in), optional :: calendar
    type(ESMF_CalKind_Flag), intent(in), optional :: calkindflag
    integer, intent(in), optional :: timeZone
    integer, intent(out), optional :: rc
  • private subroutine ESMF_TimeSetString(time, timeString, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Time), intent(inout) :: time
    character(len=*), intent(in) :: timeString
    integer, intent(out), optional :: rc

public interface operator(+)

public interface operator(-)

public interface operator(/=)

  • private impure elemental function ESMF_TimeNE(time1, time2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Time), intent(in) :: time1
    type(ESMF_Time), intent(in) :: time2

    Return Value logical

public interface operator(<)

  • private function ESMF_TimeLT(time1, time2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Time), intent(in) :: time1
    type(ESMF_Time), intent(in) :: time2

    Return Value logical

public interface operator(<=)

  • private function ESMF_TimeLE(time1, time2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Time), intent(in) :: time1
    type(ESMF_Time), intent(in) :: time2

    Return Value logical

public interface operator(==)

  • private impure elemental function ESMF_TimeEQ(time1, time2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Time), intent(in) :: time1
    type(ESMF_Time), intent(in) :: time2

    Return Value logical

public interface operator(>)

  • private function ESMF_TimeGT(time1, time2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Time), intent(in) :: time1
    type(ESMF_Time), intent(in) :: time2

    Return Value logical

public interface operator(>=)

  • private function ESMF_TimeGE(time1, time2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Time), intent(in) :: time1
    type(ESMF_Time), intent(in) :: time2

    Return Value logical


Functions

private impure elemental function ESMF_TimeEQ(time1, time2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time1
type(ESMF_Time), intent(in) :: time2

Return Value logical

private function ESMF_TimeGE(time1, time2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time1
type(ESMF_Time), intent(in) :: time2

Return Value logical

private function ESMF_TimeGT(time1, time2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time1
type(ESMF_Time), intent(in) :: time2

Return Value logical

public function ESMF_TimeIsLeapYear(time, keywordEnforcer, rc)

Arguments

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

Return Value logical

public function ESMF_TimeIsSameCalendar(time1, time2, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time1
type(ESMF_Time), intent(in) :: time2
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Return Value logical

private function ESMF_TimeLE(time1, time2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time1
type(ESMF_Time), intent(in) :: time2

Return Value logical

private function ESMF_TimeLT(time1, time2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time1
type(ESMF_Time), intent(in) :: time2

Return Value logical

private impure elemental function ESMF_TimeNE(time1, time2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time1
type(ESMF_Time), intent(in) :: time2

Return Value logical

private function ESMF_TimeDec(time, timeinterval)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time
type(ESMF_TimeInterval), intent(in) :: timeinterval

Return Value type(ESMF_Time)

private function ESMF_TimeInc(time, timeinterval)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time
type(ESMF_TimeInterval), intent(in) :: timeinterval

Return Value type(ESMF_Time)

private function ESMF_TimeDiff(time1, time2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time1
type(ESMF_Time), intent(in) :: time2

Return Value type(ESMF_TimeInterval)


Subroutines

public subroutine ESMF_TimeGet(time, keywordEnforcer, yy, yy_i8, mm, dd, d, d_i8, h, m, s, s_i8, ms, us, ns, d_r8, h_r8, m_r8, s_r8, ms_r8, us_r8, ns_r8, sN, sN_i8, sD, sD_i8, calendar, calkindflag, timeZone, timeString, timeStringISOFrac, dayOfWeek, midMonth, dayOfYear, dayOfYear_r8, dayOfYear_intvl, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer(kind=ESMF_KIND_I4), intent(out), optional :: yy
integer(kind=ESMF_KIND_I8), intent(out), optional :: yy_i8
integer, intent(out), optional :: mm
integer, intent(out), optional :: dd
integer(kind=ESMF_KIND_I4), intent(out), optional :: d
integer(kind=ESMF_KIND_I8), intent(out), optional :: d_i8
integer(kind=ESMF_KIND_I4), intent(out), optional :: h
integer(kind=ESMF_KIND_I4), intent(out), optional :: m
integer(kind=ESMF_KIND_I4), intent(out), optional :: s
integer(kind=ESMF_KIND_I8), intent(out), optional :: s_i8
integer(kind=ESMF_KIND_I4), intent(out), optional :: ms
integer(kind=ESMF_KIND_I4), intent(out), optional :: us
integer(kind=ESMF_KIND_I4), intent(out), optional :: ns
real(kind=ESMF_KIND_R8), intent(out), optional :: d_r8
real(kind=ESMF_KIND_R8), intent(out), optional :: h_r8
real(kind=ESMF_KIND_R8), intent(out), optional :: m_r8
real(kind=ESMF_KIND_R8), intent(out), optional :: s_r8
real(kind=ESMF_KIND_R8), intent(out), optional :: ms_r8
real(kind=ESMF_KIND_R8), intent(out), optional :: us_r8
real(kind=ESMF_KIND_R8), intent(out), optional :: ns_r8
integer(kind=ESMF_KIND_I4), intent(out), optional :: sN
integer(kind=ESMF_KIND_I8), intent(out), optional :: sN_i8
integer(kind=ESMF_KIND_I4), intent(out), optional :: sD
integer(kind=ESMF_KIND_I8), intent(out), optional :: sD_i8
type(ESMF_Calendar), intent(out), optional :: calendar
type(ESMF_CalKind_Flag), intent(out), optional :: calkindflag
integer, intent(out), optional :: timeZone
character(len=*), intent(out), optional :: timeString
character(len=*), intent(out), optional :: timeStringISOFrac
integer, intent(out), optional :: dayOfWeek
type(ESMF_Time), intent(out), optional :: midMonth
integer(kind=ESMF_KIND_I4), intent(out), optional :: dayOfYear
real(kind=ESMF_KIND_R8), intent(out), optional :: dayOfYear_r8
type(ESMF_TimeInterval), intent(out), optional :: dayOfYear_intvl
integer, intent(out), optional :: rc

public subroutine ESMF_TimePrint(time, keywordEnforcer, options, preString, unit, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(in) :: time
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_TimeReadRestart(time, name, keywordEnforcer, rc)

Arguments

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

private subroutine ESMF_TimeSetDefault(time, keywordEnforcer, yy, yy_i8, mm, dd, d, d_i8, h, m, s, s_i8, ms, us, ns, d_r8, h_r8, m_r8, s_r8, ms_r8, us_r8, ns_r8, sN, sN_i8, sD, sD_i8, calendar, calkindflag, timeZone, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(inout) :: time
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer(kind=ESMF_KIND_I4), intent(in), optional :: yy
integer(kind=ESMF_KIND_I8), intent(in), optional :: yy_i8
integer, intent(in), optional :: mm
integer, intent(in), optional :: dd
integer(kind=ESMF_KIND_I4), intent(in), optional :: d
integer(kind=ESMF_KIND_I8), intent(in), optional :: d_i8
integer(kind=ESMF_KIND_I4), intent(in), optional :: h
integer(kind=ESMF_KIND_I4), intent(in), optional :: m
integer(kind=ESMF_KIND_I4), intent(in), optional :: s
integer(kind=ESMF_KIND_I8), intent(in), optional :: s_i8
integer(kind=ESMF_KIND_I4), intent(in), optional :: ms
integer(kind=ESMF_KIND_I4), intent(in), optional :: us
integer(kind=ESMF_KIND_I4), intent(in), optional :: ns
real(kind=ESMF_KIND_R8), intent(in), optional :: d_r8
real(kind=ESMF_KIND_R8), intent(in), optional :: h_r8
real(kind=ESMF_KIND_R8), intent(in), optional :: m_r8
real(kind=ESMF_KIND_R8), intent(in), optional :: s_r8
real(kind=ESMF_KIND_R8), intent(in), optional :: ms_r8
real(kind=ESMF_KIND_R8), intent(in), optional :: us_r8
real(kind=ESMF_KIND_R8), intent(in), optional :: ns_r8
integer(kind=ESMF_KIND_I4), intent(in), optional :: sN
integer(kind=ESMF_KIND_I8), intent(in), optional :: sN_i8
integer(kind=ESMF_KIND_I4), intent(in), optional :: sD
integer(kind=ESMF_KIND_I8), intent(in), optional :: sD_i8
type(ESMF_Calendar), intent(in), optional :: calendar
type(ESMF_CalKind_Flag), intent(in), optional :: calkindflag
integer, intent(in), optional :: timeZone
integer, intent(out), optional :: rc

private subroutine ESMF_TimeSetString(time, timeString, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Time), intent(inout) :: time
character(len=*), intent(in) :: timeString
integer, intent(out), optional :: rc

public subroutine ESMF_TimeSyncToRealTime(time, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_TimeValidate(time, options, rc)

Arguments

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

public subroutine ESMF_TimeWriteRestart(time, keywordEnforcer, rc)

Arguments

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