ESMF_CalendarMod Module

Uses

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Variables

Type	Visibility	Attributes		Name		Initial
character(len=*),	private,	parameter	::	version	=	'$Id$'
type(ESMF_CalKind_Flag),	public,	parameter	::	ESMF_CALKIND_360DAY	=	ESMF_CalKind_Flag(6)
type(ESMF_CalKind_Flag),	public,	parameter	::	ESMF_CALKIND_CUSTOM	=	ESMF_CalKind_Flag(7)
type(ESMF_CalKind_Flag),	public,	parameter	::	ESMF_CALKIND_GREGORIAN	=	ESMF_CalKind_Flag(1)
type(ESMF_CalKind_Flag),	public,	parameter	::	ESMF_CALKIND_JULIAN	=	ESMF_CalKind_Flag(2)
type(ESMF_CalKind_Flag),	public,	parameter	::	ESMF_CALKIND_JULIANDAY	=	ESMF_CalKind_Flag(3)
type(ESMF_CalKind_Flag),	public,	parameter	::	ESMF_CALKIND_MODJULIANDAY	=	ESMF_CalKind_Flag(4)
type(ESMF_CalKind_Flag),	public,	parameter	::	ESMF_CALKIND_NOCALENDAR	=	ESMF_CalKind_Flag(8)
type(ESMF_CalKind_Flag),	public,	parameter	::	ESMF_CALKIND_NOLEAP	=	ESMF_CalKind_Flag(5)

Interfaces

public interface ESMF_CalendarCreate

private function ESMF_CalendarCreateBuiltIn(calkindflag, keywordEnforcer, name, rc)

Arguments

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

Return Value type(ESMF_Calendar)

private function ESMF_CalendarCreateCopy(calendar, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Calendar)

private function ESMF_CalendarCreateCustom(keywordEnforcer, daysPerMonth, secondsPerDay, daysPerYear, daysPerYearDn, daysPerYearDd, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(in),	optional		::	daysPerMonth(:)
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	secondsPerDay
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYear
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYearDn
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYearDd
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Calendar)

public interface ESMF_CalendarIsLeapYear

private function ESMF_CalendarIsLeapYearI4(calendar, yy, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
integer(kind=ESMF_KIND_I4),	intent(in)			::	yy
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value logical

private function ESMF_CalendarIsLeapYearI8(calendar, yy, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
integer(kind=ESMF_KIND_I8),	intent(in)			::	yy
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value logical

public interface ESMF_CalendarSet

private subroutine ESMF_CalendarSetBuiltIn(calendar, calkindflag, keywordEnforcer, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(inout)			::	calendar
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

private subroutine ESMF_CalendarSetCustom(calendar, keywordEnforcer, daysPerMonth, secondsPerDay, daysPerYear, daysPerYearDn, daysPerYearDd, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(inout)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(in),	optional		::	daysPerMonth(:)
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	secondsPerDay
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYear
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYearDn
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYearDd
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

public interface ESMF_CalendarSetDefault

private subroutine ESMF_CalendarSetDefaultKind(calkindflag, rc)

Arguments

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

private subroutine ESMF_CalendarSetDefaultCal(calendar, rc)

Arguments

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

private interface assignment (=)

private subroutine ESMF_CalKindToInt(lhsInt, rhsCalKind)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(out)			::	lhsInt
type(ESMF_CalKind_Flag),	intent(in)			::	rhsCalKind

private subroutine ESMF_IntToCalKind(lhsCalKind, rhsInt)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(out)			::	lhsCalKind
integer,	intent(in)			::	rhsInt

public interface operator(/=)

private impure elemental function ESMF_CalendarNE(calendar1, calendar2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar1
type(ESMF_Calendar),	intent(in)			::	calendar2

Return Value logical

private impure elemental function ESMF_CalendarKindNE(calkindflag1, calkindflag2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag1
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag2

Return Value logical

private impure elemental function ESMF_CalendarCalAndKindNE(calendar, calkindflag)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag

Return Value logical

private impure elemental function ESMF_CalendarKindAndCalNE(calkindflag, calendar)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag
type(ESMF_Calendar),	intent(in)			::	calendar

Return Value logical

public interface operator(==)

private impure elemental function ESMF_CalendarEQ(calendar1, calendar2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar1
type(ESMF_Calendar),	intent(in)			::	calendar2

Return Value logical

private impure elemental function ESMF_CalendarKindEQ(calkindflag1, calkindflag2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag1
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag2

Return Value logical

private impure elemental function ESMF_CalendarCalAndKindEQ(calendar, calkindflag)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag

Return Value logical

private impure elemental function ESMF_CalendarKindAndCalEQ(calkindflag, calendar)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag
type(ESMF_Calendar),	intent(in)			::	calendar

Return Value logical

Derived Types

type, public, sequence :: ESMF_CalKind_Flag

Components

Type	Visibility	Attributes		Name		Initial
integer,	private		::	calkindflag

type, public, sequence :: ESMF_Calendar

Components

Type	Visibility	Attributes		Name		Initial
integer(kind=ESMF_KIND_I8),	private		::	isInit	=	76838410
type(ESMF_Pointer),	private		::	this

Functions

public function ESMF_CalendarGetInit(d)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in),	optional		::	d

Return Value integer(kind=ESMF_KIND_I8)

private impure elemental function ESMF_CalendarCalAndKindEQ(calendar, calkindflag)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag

Return Value logical

private impure elemental function ESMF_CalendarCalAndKindNE(calendar, calkindflag)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag

Return Value logical

private impure elemental function ESMF_CalendarEQ(calendar1, calendar2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar1
type(ESMF_Calendar),	intent(in)			::	calendar2

Return Value logical

public function ESMF_CalendarIsCreated(calendar, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value logical

private function ESMF_CalendarIsLeapYearI4(calendar, yy, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
integer(kind=ESMF_KIND_I4),	intent(in)			::	yy
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value logical

private function ESMF_CalendarIsLeapYearI8(calendar, yy, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
integer(kind=ESMF_KIND_I8),	intent(in)			::	yy
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value logical

private impure elemental function ESMF_CalendarKindAndCalEQ(calkindflag, calendar)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag
type(ESMF_Calendar),	intent(in)			::	calendar

Return Value logical

private impure elemental function ESMF_CalendarKindAndCalNE(calkindflag, calendar)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag
type(ESMF_Calendar),	intent(in)			::	calendar

Return Value logical

private impure elemental function ESMF_CalendarKindEQ(calkindflag1, calkindflag2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag1
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag2

Return Value logical

private impure elemental function ESMF_CalendarKindNE(calkindflag1, calkindflag2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag1
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag2

Return Value logical

private impure elemental function ESMF_CalendarNE(calendar1, calendar2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar1
type(ESMF_Calendar),	intent(in)			::	calendar2

Return Value logical

private function ESMF_CalendarCreateBuiltIn(calkindflag, keywordEnforcer, name, rc)

Arguments

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

Return Value type(ESMF_Calendar)

private function ESMF_CalendarCreateCopy(calendar, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Calendar)

private function ESMF_CalendarCreateCustom(keywordEnforcer, daysPerMonth, secondsPerDay, daysPerYear, daysPerYearDn, daysPerYearDd, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(in),	optional		::	daysPerMonth(:)
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	secondsPerDay
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYear
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYearDn
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYearDd
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Calendar)

public function ESMF_CalendarReadRestart(name, keywordEnforcer, rc)

Arguments

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

Return Value type(ESMF_Calendar)

Subroutines

private subroutine ESMF_CalKindToInt(lhsInt, rhsCalKind)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(out)			::	lhsInt
type(ESMF_CalKind_Flag),	intent(in)			::	rhsCalKind

public subroutine ESMF_CalendarDestroy(calendar, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(inout)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

public subroutine ESMF_CalendarFinalize(keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

public subroutine ESMF_CalendarGet(calendar, keywordEnforcer, name, calkindflag, daysPerMonth, monthsPerYear, secondsPerDay, secondsPerYear, daysPerYear, daysPerYearDn, daysPerYearDd, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
character(len=*),	intent(out),	optional		::	name
type(ESMF_CalKind_Flag),	intent(out),	optional		::	calkindflag
integer,	intent(out),	optional		::	daysPerMonth(:)
integer,	intent(out),	optional		::	monthsPerYear
integer(kind=ESMF_KIND_I4),	intent(out),	optional		::	secondsPerDay
integer(kind=ESMF_KIND_I4),	intent(out),	optional		::	secondsPerYear
integer(kind=ESMF_KIND_I4),	intent(out),	optional		::	daysPerYear
integer(kind=ESMF_KIND_I4),	intent(out),	optional		::	daysPerYearDn
integer(kind=ESMF_KIND_I4),	intent(out),	optional		::	daysPerYearDd
integer,	intent(out),	optional		::	rc

public subroutine ESMF_CalendarInitialize(keywordEnforcer, calkindflag, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_CalKind_Flag),	intent(in),	optional		::	calkindflag
integer,	intent(out),	optional		::	rc

public subroutine ESMF_CalendarPrint(calendar, options, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
character(len=*),	intent(in),	optional		::	options
integer,	intent(out),	optional		::	rc

private subroutine ESMF_CalendarSetBuiltIn(calendar, calkindflag, keywordEnforcer, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(inout)			::	calendar
type(ESMF_CalKind_Flag),	intent(in)			::	calkindflag
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

private subroutine ESMF_CalendarSetCustom(calendar, keywordEnforcer, daysPerMonth, secondsPerDay, daysPerYear, daysPerYearDn, daysPerYearDd, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(inout)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(in),	optional		::	daysPerMonth(:)
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	secondsPerDay
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYear
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYearDn
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	daysPerYearDd
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

private subroutine ESMF_CalendarSetDefaultCal(calendar, rc)

Arguments

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

private subroutine ESMF_CalendarSetDefaultKind(calkindflag, rc)

Arguments

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

public subroutine ESMF_CalendarSetInitCreated(c, rc)

Arguments

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

public subroutine ESMF_CalendarValidate(calendar, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

public subroutine ESMF_CalendarWriteRestart(calendar, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Calendar),	intent(in)			::	calendar
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

private subroutine ESMF_IntToCalKind(lhsCalKind, rhsInt)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_CalKind_Flag),	intent(out)			::	lhsCalKind
integer,	intent(in)			::	rhsInt