mfm_timemgr.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\_TimeMgrOverload.F,  Date: Thu Nov  1 11:31:23 MST 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}
  
\markboth{Left}{Source File: MFM\_TimeMgr.F,  Date: Thu Nov  1 11:31:23 MST 2001
}

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

  \subsubsection{MFM\_TimeMgrInitStd}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrInitStd(stepSize, startDate, 
      &                            stopDate, baseDate, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_TimeMgr) :: MFM_TimeMgrInitStd     ! return a new time manager
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time), intent(in) :: stepSize      ! step size   
       type(MFM_Date), intent(in) :: startDate     ! start date
       type(MFM_Date), intent(in) :: stopDate      ! stop date
       type(MFM_Date), intent(in) :: baseDate      ! base date
       integer, intent(out), optional :: rc        ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       General initialization for a new time manager object.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrInitIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrInitIS(stepDays, stepSecs, 
      &                           startCalendarDate, startTOD, 
      &                           stopCalendarDate, stopTOD, 
      &                           baseCalendarDate, baseTOD, 
      &                           type, rc)     
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_TimeMgr) :: MFM_TimeMgrInitIS     ! new time manager with 
 				                 !   integer second granularity
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       integer, intent(in) :: stepDays            ! days in time step   
       integer, intent(in) :: stepSecs            ! seconds in time step
       integer, intent(in) :: startCalendarDate   ! start date
       integer, intent(in) :: startTOD            ! start time of day
       integer, intent(in) :: stopCalendarDate    ! stop date
       integer, intent(in) :: stopTOD             ! stop time of day
       integer, intent(in) :: baseCalendarDate    ! base date
       integer, intent(in) :: baseTOD             ! base time of day
       integer, intent(in) :: type                ! calendar type
       integer, intent(out), optional :: rc       ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Initializes a new time manager for climate-type models with 
       integer second temporal discretization.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrInitNoBaseStd}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrInitNoBaseStd(stepSize, startDate, 
      &                                  stopDate, rc) 
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_TimeMgr) :: MFM_TimeMgrInitNoBaseStd  ! return a new time manager
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Time), intent(in) :: stepSize         ! step size   
       type(MFM_Date), intent(in) :: startDate        ! start date
       type(MFM_Date), intent(in) :: stopDate         ! stop date
       integer, intent(out), optional :: rc           ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       General initialization for a new time manager object.  No base
       date is supplied (it is set by default to the start date).
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrInitNoBaseIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrInitNoBaseIS(stepDays, stepSecs, 
      &                                 startCalendarDate, startTOD, 
      &                                 stopCalendarDate, stopTOD, 
      &                                 type, rc)     
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_TimeMgr) :: MFM_TimeMgrInitNoBaseIS  ! new time manager with 
 				                    !   integer second granularity
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       integer, intent(in) :: stepDays            ! days in time step   
       integer, intent(in) :: stepSecs            ! seconds in time step
       integer, intent(in) :: startCalendarDate   ! start date
       integer, intent(in) :: startTOD            ! start time of day
       integer, intent(in) :: stopCalendarDate    ! stop date
       integer, intent(in) :: stopTOD             ! stop time of day
       integer, intent(in) :: type                ! calendar type
       integer, intent(out), optional :: rc       ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Initializes a new time manager for climate-type models with 
       integer second discretization.  No base date is supplied (it is 
       set by default to the start date).
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrLastStep}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrLastStep(timeMgr, rc) 
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       logical      :: MFM_TimeMgrLastStep         ! return true if last step
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_TimeMgr), intent(in) :: timeMgr    ! time manager
       integer, intent(out), optional :: rc        ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns true if the time manager's current date plus time step 
       exceeds the stop date.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\