mfm_date.tex

CCSM Research Tools: Community Atmosphere Model (CAM)

%                **** IMPORTANT NOTICE *****
% This LaTeX file has been automatically produced by ProTeX v. 1.1
% Any changes made to this file will likely be lost next time
% this file is regenerated from its source. Send questions 
% to Arlindo da Silva, [e-mail]
 
\parskip        0pt
\parindent      0pt
\baselineskip  11pt
 
%--------------------- SHORT-HAND MACROS ----------------------
\def\bv{\begin{verbatim}}
\def\ev{\end{verbatim}}
\def\be{\begin{equation}}
\def\ee{\end{equation}}
\def\bea{\begin{eqnarray}}
\def\eea{\end{eqnarray}}
\def\bi{\begin{itemize}}
\def\ei{\end{itemize}}
\def\bn{\begin{enumerate}}
\def\en{\end{enumerate}}
\def\bd{\begin{description}}
\def\ed{\end{description}}
\def\({\left (}
\def\){\right )}
\def\[{\left [}
\def\]{\right ]}
\def\<{\left  \langle}
\def\>{\right \rangle}
\def\cI{{\cal I}}
\def\diag{\mathop{\rm diag}}
\def\tr{\mathop{\rm tr}}
%-------------------------------------------------------------

\markboth{Left}{Source File: MFM\_DateOverload.F,  Date: Thu Nov  1 11:31:23 MST 2001
}

 
%/////////////////////////////////////////////////////////////

  \subsubsection{MFM\_DateInit}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_DateInit
         module procedure MFM_DateInitIS,
      &                   MFM_DateInitUndefined,
      &                   MFM_DateCopyInit
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Initializes a {\tt MFM\_Date} object. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_DateInitIS}          & initializes a date based on integer seconds \\ 
       {\tt MFM\_DateInitUndefined}   & initializes a date with undefined contents \\
       {\tt MFM\_DateCopyInit}        & initializes a date based on another date \\
       \end{tabular}  
  
   SEE ALSO:
     {\tt MFM\_DateInitIS, MFM\_DateInitUndefined, MFM\_DateCopyInit}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateSet}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_DateSet
         module procedure MFM_DateSetIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets the attributes of a {\tt MFM\_Date} object. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_DateSetIS}  & sets a date based on integer seconds \\ 
       \end{tabular}  
  
   SEE ALSO:
     {\tt MFM\_DateSetIS}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateGet}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_DateGet
         module procedure MFM_DateGetIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Gets the attributes of a {\tt MFM\_Date} object. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_DateGetIS} & gets the value of a date based on integer seconds \\
       \end{tabular}  
  
   SEE ALSO:
     {\tt MFM\_DateGetIS}
  
\markboth{Left}{Source File: MFM\_Date.F,  Date: Thu Nov  1 11:31:23 MST 2001
}

 
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateInitIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateInitIS(type, yearmmdd, tod, rc)
     \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_DateInitIS            ! returned date object
     \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       integer, intent(in) :: type                 ! MFM_GREGORIAN or MFM_NO_LEAP
       integer, intent(in) :: yearmmdd             ! calendar date
       integer, intent(in) :: tod                  ! time of day in seconds
       integer, intent(out), optional :: rc        ! return code 
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Initializes a {\tt MFM\_Date} object.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateInitUndefined}


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


       Initializes a {\tt MFM\_Date} object wih undefined contents.  The
       values of internal attributes are set to {\tt MFM\_TIME\_UNDEFINED}.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateCopyInit}


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


       Initializes a new date object to the contents of another date.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateSetIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_DateSetIS(date, type, yearmmdd, tod, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(out) :: date           ! date object
       integer, intent(in) :: type                   ! MFM_GREGORIAN or MFM_NO_LEAP
       integer, intent(in) :: yearmmdd               ! calendar date
       integer, intent(in) :: tod                    ! time of day
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets the attributes of a date object.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateGetIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_DateGetIS(date, yearmmdd, tod, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Date), intent(in) :: date            ! date object
       integer, intent(out) :: yearmmdd              ! calendar date
       integer, intent(out) :: tod                   ! time of day
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns the attributes of a {\tt date}.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_DateGetDayOfYear}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_DateGetDayOfYear(date, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       integer :: MFM_DateGetDayOfYear               ! returned day of year
 \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 day of the year corresponding to {\tt date}.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

   \subsubsection{MFM\_DateGetFltDayOfYear}


  
\bigskip{\sf INTERFACE:}