mfm_timemgmtoverload.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\_TimeMgmtOverload.F,  Date: Mon Jul 30 15:06:42 MDT 2001
}

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

  \subsubsection{MFM\_TimeMgrInit}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeMgrInit
         module procedure MFM_TimeMgrInitStd,
      &                   MFM_TimeMgrInitNoBaseStd,
      &                   MFM_TimeMgrInitIS,
      &                   MFM_TimeMgrInitNoBaseIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Initializes a new {\tt MFM\_TimeMgr} object. \\
       See the explicit interfaces: 
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeMgrInitStd}       & general interface to init a time manager \\
       {\tt MFM\_TimeMgrInitNoBaseStd} & general interface to init a time manager,
                                         with base date == start date \\
       {\tt MFM\_TimeMgrInitIS}        & init a time manager with integer second 
                                         discretization \\
       {\tt MFM\_TimeMgrInitNoBaseIS}  & init a time manager with integer second
                                         discretization, base date == start date \\
       \end{tabular}  
  
   SEE ALSO:
     {\tt MFM\_TimeMgrInitStd, MFM\_TimeMgrInitNoBaseStd, MFM\_TimeMgrInitIS, 
     MFM\_TimeMgrInitNoBaseIS}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetStepSize}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeMgrGetStepSize
         module procedure MFM_TimeMgrGetStepSizeStd,
      &                   MFM_TimeMgrGetStepSizeIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Gets a step size. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeMgrGetStepSizeStd} & get step size as time type \\
       {\tt MFM\_TimeMgrGetStepSizeIS}  & get step size as days and seconds \\
       \end{tabular}  
  
   SEE ALSO:
     MFM\_TimeMgrGetStepSizeStd, MFM\_TimeMgrGetStepSizeIS
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrSetStepSize}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeMgrSetStepSize
         module procedure MFM_TimeMgrSetStepSizeStd,
      &                   MFM_TimeMgrSetStepSizeIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets a step size. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeMgrSetStepSizeStd}  & set step size with time type \\
       {\tt MFM\_TimeMgrSetStepSizeIS}   & set step size with days and seconds \\
       \end{tabular}  
  
   SEE ALSO:
     {\tt MFM\_TimeMgrSetStepSizeStd, MFM\_TimeMgrSetStepSizeIS}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrRestartWrite}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeMgrRestartWrite
         module procedure MFM_TimeMgrRestartWriteIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns the data needed for a restart. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeMgrRestartWriteIS}   & return restart data \\
       \end{tabular}  
  
   SEE ALSO:
     {\tt MFM\_TimeMgrRestartWrite}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrRestartRead}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeMgrRestartRead
         module procedure MFM_TimeMgrRestartReadIS
       end interface
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Retrieves the restart data and returns a TimeMgr. \\
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeMgrRestartReadIS}   & constructs restart TimeMgr (int) seconds  \\
       \end{tabular}  
  
   SEE ALSO:
     {\tt MFM\_TimeMgrRestartRead}
  
  =============================================================================== 
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrSetCurrDate}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       interface MFM_TimeMgrSetCurrDate
         module procedure MFM_TimeMgrSetCurrDateIS
       end interface\end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets the current date (updates prev date).
       See the explicit interfaces:
  
       \begin{tabular}{p{2in}p{3.5in}}
       {\tt MFM\_TimeMgrSetCurrDateIS}   & set curr date \\
       \end{tabular}  
  
   SEE ALSO:
     {\tt MFM\_TimeMgrGetCurrDate}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \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}
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \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}
  
%...............................................................