mfm_time.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\_TimeOverload.F,  Date: Thu Nov  1 11:31:23 MST 2001
}

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

  \subsubsection{MFM\_TimeInit}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeInit
         module procedure MFM_TimeInitIS,
      &                   MFM_TimeInitUndefined,
      &                   MFM_TimeCopyInit
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Initializes a {\tt MFM\_Time} object. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeInitIS}        & initializes a time with days and seconds \\
       {\tt MFM\_TimeInitUndefined} & initializes a time with undefined contents \\
       {\tt MFM\_TimeCopyInit}      & initializes a time based on another time \\
       \end{tabular}
    
   SEE ALSO:
     {\tt MFM\_TimeInitIS, MFM\_TimeInitUndefined, MFM\_TimeCopyInit}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeSet}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeSet
         module procedure MFM_TimeSetIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets the value of a {\tt MFM\_Time} object. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeSetIS} & sets a time with days and seconds \\
       \end{tabular}
    
   SEE ALSO:
     {\tt MFM\_TimeSetIS}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeGet}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeGet
         module procedure MFM_TimeGetIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Gets the value of a {\tt MFM\_Time} object. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeGetIS} & gets a time of the form days and seconds \\
       \end{tabular}
    
   SEE ALSO:
     {\tt MFM\_TimeGetIS}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeIncrement}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeIncrement
         module procedure MFM_TimeIncrementIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Increments the value of a {\tt MFM\_Time} object. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeIncrementIS} & increments a time of the form days and seconds \\
       \end{tabular} 
    
   SEE ALSO:
     {\tt MFM\_TimeIncrementIS}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeDecrement}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeDecrement
         module procedure MFM_TimeDecrementIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Decrements the value of a {\tt MFM\_Time} object. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeDecrementIS} & decrements a time of the form days and seconds \\
       \end{tabular}
    
   SEE ALSO:
     {\tt MFM\_TimeDecrementIS}
  
\markboth{Left}{Source File: MFM\_Time.F,  Date: Thu Nov  1 11:31:23 MST 2001
}

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

  \subsubsection{MFM\_TimeInitIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeInitIS(days, seconds, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time) :: MFM_TimeInitIS        ! returned time object
     
       integer, intent(in) :: days             ! days in time
       integer, intent(in) :: seconds          ! seconds in time
       integer, intent(out), optional :: rc    ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Initializes a time object that is based on integer seconds.  
       Acceptable values for days and seconds are non-negative values 
       and the value {\tt MFM\_TIME\_UNDEFINED}.  
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeInitUndefined}


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


       Initializes a new time object with undefined contents.  The value of 
       internal attributes is set to {\tt MFM\_TIME\_UNDEFINED}.  
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeCopyInit}


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


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

  \subsubsection{MFM\_TimeSetIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeSetIS(time, days, seconds, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time), intent(out) :: time      ! time
       integer, intent(in) :: days              ! days
       integer, intent(in) :: seconds           ! seconds
       integer, intent(out), optional :: rc     ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets (or resets) the attributes of {\tt time} to {\tt days} and 
       {\tt seconds}.  Non-negative values of {\tt days} and {\tt seconds} 
       are valid; the value {\tt MFM\_TIME\_UNDEFINED} is not.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeGetIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeGetIS(time, days, seconds, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time), intent(in) :: time    ! time
       integer, intent(out) :: days          ! returned days
       integer, intent(out) :: seconds       ! returned seconds
       integer, intent(out), optional :: rc  ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns {\tt time} in the form of integer {\tt days} and {\tt seconds}.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeGetDays}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeGetDays(time, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       real(8) :: MFM_TimeGetDays                ! returned time value
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time), intent(in) :: time        ! time
       integer, intent(out), optional :: rc      ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns {\tt time} in the form of real {\tt days}.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeIncrementIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeIncrementIS(time, days, seconds, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Time) :: MFM_TimeIncrementIS      ! returned incremented time
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time), intent(in) :: time         ! time
       integer, intent(in) :: days                ! day increment
       integer, intent(in) :: seconds             ! second increment
       integer, intent(out), optional :: rc       ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Increments {\tt time} by {\tt days} and {\tt seconds}.  Non-negative
       values of {\tt days} and {\tt seconds} are valid.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeCopy}


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


       Copies the time {\tt orig} into {\tt time}.  Both times must be
       initialized.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeDiff}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeDiff(earlyTime, lateTime, diff, isLater, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time), intent(in) :: earlyTime    ! earlier time
       type(MFM_Time), intent(in) :: lateTime     ! later time
       type(MFM_Time), intent(out) :: diff        ! difference between earlier
                                                  !   and later times
       logical, intent(out) :: isLater            ! true if later date is in
                                                  !   fact later
       integer, intent(out), optional :: rc       ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Takes the difference between two times and returns the difference 
       in {\tt diff}.  The returned value {\tt isLater} is true if 
       {\tt lateTime} represents a time quantity greater than or equal to 
       {\tt earlyTime}.
       
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeDecrementIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeDecrementIS(time, days, seconds, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Time) :: MFM_TimeDecrementIS     ! returned decremented time
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time), intent(in) :: time        ! time
       integer, intent(in) :: days               ! days
       integer, intent(in) :: seconds            ! seconds
       integer, intent(out), optional :: rc      ! return code 
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Decrements {\tt time} by {\tt days} and {\tt seconds}.  Non-negative
       values of {\tt days} and {\tt seconds} are valid.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimePrint}


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


       Prints the attributes of {\tt time} to stdout.
  
%...............................................................