mfm_timemgr.tex

CCSM Research Tools: Community Atmosphere Model (CAM)

  \subsubsection{MFM\_TimeMgrAdvance}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeMgrAdvance(timeMgr, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_TimeMgr), intent(inout) :: timeMgr   ! time manager 
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Advances time manager by one time step.  Resets current date and
       previous date.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrSetStepSizeStd}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeMgrSetStepSizeStd(timeMgr, stepSize, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_TimeMgr), intent(inout) :: timeMgr   ! time manager
       type(MFM_Time), intent(in) :: stepSize        ! step size
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Resets the step size in the time manager to stepSize.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrSetStepSizeIS}


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


       Resets the step size in the time manager using {\tt days} and 
       {\tt seconds}.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetNStep}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrGetNStep(timeMgr, rc) 
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       integer :: MFM_TimeMgrGetNStep            ! returned number of time steps
 \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:\\ }


       Gets the number of time steps in the time manager.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrSetNStep}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeMgrSetNStep(timeMgr, nstep, rc) 
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_TimeMgr), intent(in) :: timeMgr  ! time manager 
       integer, intent(in) :: nstep              ! New nstep
       integer, intent(out), optional :: rc      ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets the number of time steps in the time manager.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetStepSizeIS}


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


       Returns the step size.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetStepSizeStd}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeMgrGetStepSizeStd(timeMgr, stepSize, rc)
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_TimeMgr), intent(in) :: timeMgr   ! time manager
       type(MFM_Time), intent(out) :: stepSize    ! step size
       integer, intent(out), optional :: rc       ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns the step size.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetStartDate}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrGetStartDate(timeMgr, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_TimeMgrGetStartDate   ! start date    
 \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 the start date.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetStopDate}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrGetStopDate(timeMgr, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_TimeMgrGetStopDate  ! stop date   
 \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 the stop date.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetBaseDate}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrGetBaseDate(timeMgr, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_TimeMgrGetBaseDate   ! base date
 \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 the base date.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetCurrDate}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrGetCurrDate(timeMgr, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_TimeMgrGetCurrDate   ! current date
 \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 the current date.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrSetCurrDateIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeMgrSetCurrDateIS(timeMgr, dateYYMMDD, tod, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim} \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_TimeMgr), intent(in) :: timeMgr    ! time manager
       integer, intent(in) :: dateYYMMDD ! date
       integer, intent(in) :: tod ! seconds into day
       integer, intent(out), optional :: rc        ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets the current date.  Also sets the previous date based on 
       the current date and the time step.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrGetPrevDate}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrGetPrevDate(timeMgr, rc)
 \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_Date) :: MFM_TimeMgrGetPrevDate    ! previous date
 \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 the previous timestep.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrRestartWriteIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_TimeMgrRestartWriteIS(timeMgr,
      &     type,
      &     nstep,
      &     stepDays, stepSec,
      &     startYYMMDD, startSec,
      &     stopYYMMDD, stopSec,
      &     baseYYMMDD, baseSec,
      &     currYYMMDD, currSec,
      &     rc)\end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_TimeMgr), intent(in) :: timeMgr ! time Manager
       integer, intent(out) :: type ! Calendar type
       integer, intent(out) :: nstep ! step number
       integer, intent(out) :: stepDays ! days in step size
       integer, intent(out) :: stepSec ! seconds in step size
       integer, intent(out) :: startYYMMDD ! start day
       integer, intent(out) :: startSec ! start time
       integer, intent(out) :: stopYYMMDD ! stop day
       integer, intent(out) :: stopSec ! stop time
       integer, intent(out) :: baseYYMMDD ! base day
       integer, intent(out) :: baseSec ! base time
       integer, intent(out) :: currYYMMDD ! curr day
       integer, intent(out) :: currSec ! curr time      
       integer, intent(out), optional :: rc ! return code\end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns all the data necessary to reconstruct an identical
       TimeMgr after a restart.
        
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_TimeMgrRestartReadIS}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_TimeMgrRestartReadIS(
      &     type,
      &     nstep,
      &     stepDays, stepSec,
      &     startYYMMDD, startSec,
      &     stopYYMMDD, stopSec,
      &     baseYYMMDD, baseSec,
      &     currYYMMDD, currSec,
      &     rc)\end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       type(MFM_TimeMgr) :: MFM_TimeMgrRestartReadIS ! previous date\end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       integer, intent(in) :: stepDays ! days in step
       integer, intent(in) :: type ! calendar type
       integer, intent(in) :: nstep ! step number
       integer, intent(in) :: stepSec ! seconds in step
       integer, intent(in) :: startYYMMDD ! start day
       integer, intent(in) :: startSec ! start time
       integer, intent(in) :: stopYYMMDD ! stop day
       integer, intent(in) :: stopSec ! stop time
       integer, intent(in) :: baseYYMMDD ! base day
       integer, intent(in) :: baseSec ! base time
       integer, intent(in) :: currYYMMDD ! curr day
       integer, intent(in) :: currSec ! curr time      
       integer, intent(out), optional :: rc ! return code\end{verbatim}
{\sf DESCRIPTION:\\ }


       Reconstructs a time manager based on the data given.  This data
       will typically come from a {\tt MFM\_TimeMgrRestartWrite}. 
       The value of {\tt nstep} may be set to any positive integer.
       
%...............................................................