mfm_date.f

CCSM Research Tools: Community Atmosphere Model (CAM)

      end subroutine MFM_DateCopy

!===============================================================================
!BOP
!
! !IROUTINE:  MFM_DateDiff
!
! !INTERFACE:
      subroutine MFM_DateDiff(earlyDate, lateDate, diff, isLater, rc)

! !PARAMETERS:
      type(MFM_Date), intent(in) :: earlyDate      ! earlier date
      type(MFM_Date), intent(in) :: lateDate       ! later date
      type(MFM_Time), intent(out) :: diff          ! time difference between dates
      logical, intent(out) :: isLater              ! true if late date is 
                                                   !   actually later
      integer, intent(out), optional :: rc         ! return code

! !DESCRIPTION:
!     Determines the time difference between two dates and returns a 
!     logical indicator as to which date is later.
!
!EOP
!-------------------------------------------------------------------------------

      integer stub;

      call MF_DateDiff(earlyDate, lateDate, diff, isLater, stub)
      if (present(rc)) rc = stub

      end subroutine MFM_DateDiff

!===============================================================================
!BOP
!
! !IROUTINE:  MFM_DateIsLater
!
! !INTERFACE:
       subroutine MFM_DateIsLater(earlyDate, lateDate, isLater, rc)
    
! !PARAMETERS:                              
       type(MFM_Date), intent(in) :: earlyDate      ! earlier date
       type(MFM_Date), intent(in) :: lateDate       ! later date
       logical, intent(out) :: isLater              ! true if late date is
                                                    !   actually later
      integer, intent(out), optional :: rc          ! return code

! !DESCRIPTION:
!      Returns true if {\tt lateDate} is later than {\tt earlyDate}.
!
!EOP
!-------------------------------------------------------------------------------

       integer stub

       call MF_DateIsLater(earlyDate, lateDate, isLater, stub)
       if (present(rc)) rc = stub

       end subroutine MFM_DateIsLater

!===============================================================================
!BOP
!
! !IROUTINE:  MFM_DateIncrement
!
! !INTERFACE:  
      function MFM_DateIncrement(date, time, rc)

! !RETURN VALUE:
      type(MFM_Date) :: MFM_DateIncrement           ! returns incremented date

! !PARAMETERS:
      type(MFM_Date), intent(in) :: date            ! original date     
      type(MFM_Time), intent(in) :: time            ! time increment
      integer, intent(out), optional :: rc          ! return code

! !DESCRIPTION:
!     Increments {\tt date} by {\tt time} and returns the result.
!
!EOP
!-------------------------------------------------------------------------------

      integer stub

      call MF_DateInitUndefined(MFM_DateIncrement, stub)
      if (stub == MFM_SUCCESS) then
        call MF_DateIncrement(date, MFM_DateIncrement, time, stub)
      end if
      if (present(rc)) rc = stub

      end function MFM_DateIncrement

!===============================================================================
!BOP
! 
! !IROUTINE:  MFM_DateIncrementSec
!
! !INTERFACE:
      function MFM_DateIncrementSec(date, nsecs, rc)

! !RETURN VALUE:
      type(MFM_Date) :: MFM_DateIncrementSec        ! returns incremented date

! !PARAMETERS:
      type(MFM_Date), intent(in) :: date            ! original date
      integer, intent(in) :: nsecs                  ! time increment in seconds
      integer, intent(out), optional :: rc          ! return code

! !DESCRIPTION:
!     Increments {\tt date} by {\tt nsecs} seconds and returns
!     the result.
!
!EOP
!-------------------------------------------------------------------------------

      integer stub

      call MF_DateInitUndefined(MFM_DateIncrementSec, stub)
      if (stub == MFM_SUCCESS) then
        call MF_DateIncrementSec(date, MFM_DateIncrementSec, nsecs, 
     &    stub)
      end if
      if (present(rc)) rc = stub

      end function MFM_DateIncrementSec

!===============================================================================
!BOP
! 
! !IROUTINE:  MFM_DateIncrementDay
!
! !INTERFACE:
      function MFM_DateIncrementDay(date, ndays, rc)

! !RETURN VALUE:
      type(MFM_Date) :: MFM_DateIncrementDay     ! returns incremented date

! !PARAMETERS:
      type(MFM_Date), intent(in) :: date         ! original date
      integer, intent(in) :: ndays               ! time increment in days
      integer, intent(out), optional :: rc       ! return code

! !DESCRIPTION:
!     Increments {\tt date} by {\tt ndays} days and returns
!     the result.
!
!EOP
!-------------------------------------------------------------------------------

      integer stub

      call MF_DateInitUndefined(MFM_DateIncrementDay, stub)
      if (stub == MFM_SUCCESS) then
        call MF_DateIncrementDay(date, MFM_DateIncrementDay, ndays, 
     &    stub)
      end if
      if (present(rc)) rc = stub

      end function MFM_DateIncrementDay

!===============================================================================
!BOP
! 
! !IROUTINE:  MFM_DateIncrementMonth
!
! !INTERFACE:
      function MFM_DateIncrementMonth(date, nmonths, rc)

! !RETURN VALUE:
      type(MFM_Date) :: MFM_DateIncrementMonth   ! returns incremented date

! !PARAMETERS:
      type(MFM_Date), intent(in) :: date         ! original date
      integer, intent(in) :: nmonths             ! time increment in months
      integer, intent(out), optional :: rc       ! return code

! !DESCRIPTION:
!     Increments {\tt date} by {\tt nmonths} months and returns
!     the result.
!
!EOP
!-------------------------------------------------------------------------------

      integer stub

      call MF_DateInitUndefined(MFM_DateIncrementMonth, stub)
      if (stub == MFM_SUCCESS) then
        call MF_DateIncrementMonth(date, MFM_DateIncrementMonth, 
     &    nmonths, stub)
      end if
      if (present(rc)) rc = stub

      end function MFM_DateIncrementMonth

!===============================================================================
!BOP
! 
! !IROUTINE:  MFM_DateIncrementYear
!
! !INTERFACE:
      function MFM_DateIncrementYear(date, nyears, rc)

! !RETURN VALUE:
      type(MFM_Date) :: MFM_DateIncrementYear    ! returns incremented date

! !PARAMETERS:
      type(MFM_Date), intent(in) :: date         ! original date
      integer, intent(in) :: nyears              ! time increment in years
      integer, intent(out), optional :: rc       ! return code

! !DESCRIPTION:
!     Increments {\tt date} by {\tt nyears} years and returns
!     the result.
!
!EOP
!-------------------------------------------------------------------------------

      integer stub

      call MF_DateInitUndefined(MFM_DateIncrementYear, stub)
      if (stub == MFM_SUCCESS) then
        call MF_DateIncrementYear(date, MFM_DateIncrementYear, nyears, 
     &    stub)
      end if
      if (present(rc)) rc = stub

      end function MFM_DateIncrementYear

!===============================================================================
!BOP
!
! !IROUTINE:  MFM_DateDecrement
!
! !INTERFACE:  
      function MFM_DateDecrement(date, time, rc)

! !RETURN VALUE:
      type(MFM_Date) :: MFM_DateDecrement         ! returns decremented date

! !PARAMETERS:
      type(MFM_Date), intent(in) :: date          ! original date     
      type(MFM_Time), intent(in) :: time          ! time increment
      integer, intent(out), optional :: rc        ! return code

! !DESCRIPTION:
!     Decrements {\tt date} by {\tt time} and returns the result.
!
!EOP
!-------------------------------------------------------------------------------

      integer stub

      call MF_DateInitUndefined(MFM_DateDecrement, stub)
      if (stub == MFM_SUCCESS) then
        call MF_DateDecrement(date, MFM_DateDecrement, time, stub)
      end if
      if (present(rc)) rc = stub

      end function MFM_DateDecrement

!===============================================================================
!BOP
! 
! !IROUTINE:  MFM_DatePrint
!
! !INTERFACE:
      subroutine MFM_DatePrint(date, rc)

! !PARAMETERS:
      type(MFM_Date), intent(in) :: date            ! date
      integer, intent(out), optional :: rc          ! return code

! !DESCRIPTION:
!     Prints the contents of {\tt date}.
!
!EOP
!-------------------------------------------------------------------------------

      integer stub

      call MF_DatePrint(date, stub)
      if (present(rc)) rc = stub

      end subroutine MFM_DatePrint


!===============================================================================