mfm_date.tex

CCSM Research Tools: Community Atmosphere Model (CAM)

\begin{verbatim}       function MFM_DateGetFltDayOfYear(date, rc)\end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       real(8) :: MFM_DateGetFltDayOfYear ! Returns calendar day as intdays.seconds\end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date            ! date
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns the calendar day as a float.  The day of year is returned as
       the integer part and the seconds/milliseconds are returned in the 
       fractional part.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateGetCalendarType}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateGetCalendarType(date, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       integer :: MFM_DateGetCalendarType            ! returned calendar type
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date            ! date object
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns the calendar type of {\tt date}.  Valid values are:
       MFM\_CALENDAR\_TYPE\_UNDEFINED = 0, MFM\_NO\_LEAP = 1, 
       MFM\_GREGORIAN = 2, MFM\_360\_DAY = 3
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateCopy}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_DateCopy(date, orig, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(out) :: date           ! copy of original date
       type(MFM_Date), intent(in) :: orig            ! original date
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Copies the date {\tt orig} to {\tt date}.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateDiff}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_DateDiff(earlyDate, lateDate, diff, isLater, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       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
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Determines the time difference between two dates and returns a 
       logical indicator as to which date is later.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateIsLater}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}        subroutine MFM_DateIsLater(earlyDate, lateDate, isLater, rc)
     \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}        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
 \end{verbatim}
{\sf DESCRIPTION:\\ }


        Returns true if {\tt lateDate} is later than {\tt earlyDate}.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateIncrement}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateIncrement(date, time, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_DateIncrement           ! returns incremented date
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date            ! original date     
       type(MFM_Time), intent(in) :: time            ! time increment
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Increments {\tt date} by {\tt time} and returns the result.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

   \subsubsection{MFM\_DateIncrementSec}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateIncrementSec(date, nsecs, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_DateIncrementSec        ! returns incremented date
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date            ! original date
       integer, intent(in) :: nsecs                  ! time increment in seconds
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Increments {\tt date} by {\tt nsecs} seconds and returns
       the result.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

   \subsubsection{MFM\_DateIncrementDay}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateIncrementDay(date, ndays, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_DateIncrementDay     ! returns incremented date
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date         ! original date
       integer, intent(in) :: ndays               ! time increment in days
       integer, intent(out), optional :: rc       ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Increments {\tt date} by {\tt ndays} days and returns
       the result.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

   \subsubsection{MFM\_DateIncrementMonth}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateIncrementMonth(date, nmonths, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_DateIncrementMonth   ! returns incremented date
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date         ! original date
       integer, intent(in) :: nmonths             ! time increment in months
       integer, intent(out), optional :: rc       ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Increments {\tt date} by {\tt nmonths} months and returns
       the result.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

   \subsubsection{MFM\_DateIncrementYear}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateIncrementYear(date, nyears, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_DateIncrementYear    ! returns incremented date
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date         ! original date
       integer, intent(in) :: nyears              ! time increment in years
       integer, intent(out), optional :: rc       ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Increments {\tt date} by {\tt nyears} years and returns
       the result.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateDecrement}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateDecrement(date, time, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_DateDecrement         ! returns decremented date
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date          ! original date     
       type(MFM_Time), intent(in) :: time          ! time increment
       integer, intent(out), optional :: rc        ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Decrements {\tt date} by {\tt time} and returns the result.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

   \subsubsection{MFM\_DatePrint}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_DatePrint(date, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date            ! date
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Prints the contents of {\tt date}.
  
%...............................................................