ESMF_CalendarSetDefaultKind Subroutine

private subroutine ESMF_CalendarSetDefaultKind(calkindflag, rc)

Arguments

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

Source Code

      subroutine ESMF_CalendarSetDefaultKind(calkindflag, rc)

! !ARGUMENTS:
      type(ESMF_CalKind_Flag), intent(in)            :: calkindflag
      integer,                 intent(out), optional :: rc

!
! !DESCRIPTION:
!     Sets the default {\tt calendar} to the given type.  Subsequent Time
!     Manager operations requiring a calendar where one isn't specified will
!     use the internal calendar of this type.
!
!     The arguments are:
!     \begin{description}
!     \item[calkindflag]
!          The calendar kind to be the default.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!    
!EOP
      integer :: localrc                        ! local return code

      ! Assume failure until success
      if (present(rc)) rc = ESMF_RC_NOT_IMPL
      localrc = ESMF_RC_NOT_IMPL
    
      ! invoke C to C++ entry point
      call c_ESMC_CalendarSetDefaultKind(calkindflag, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return

      ! Return success
      if (present(rc)) rc = ESMF_SUCCESS
      end subroutine ESMF_CalendarSetDefaultKind