mfm_alarm.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\_Alarm.F,  Date: Fri Jun  1 14:33:09 MDT 2001
}

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

  \subsubsection{MFM\_AlarmInitPeriodic}


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


       Returns a new alarm.  
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_AlarmInitMonthly}


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


       Returns a new alarm object.  
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_AlarmInitYearly}


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


       Returns a new alarm object.  
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_AlarmGetType}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_AlarmGetType(this, rc)
     \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       integer :: MFM_AlarmGetType                   ! returned type
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Alarm), intent(in) :: this           ! alarm object    
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns true if the alarm is on, false if not.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_AlarmIsOn}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       function MFM_AlarmIsOn(this, timeMgr, rc)
     \end{verbatim}{\sf RETURN VALUE:}
\begin{verbatim}       logical :: MFM_AlarmIsOn                      ! true if alarm is on
 \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Alarm), intent(in) :: this           ! alarm object    
       type(MFM_TimeMgr), intent(in) :: timeMgr      ! time manager
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Returns true if the alarm is on, false if not.
   
%/////////////////////////////////////////////////////////////
 
\mbox{}\hrulefill\ 
 

  \subsubsection{MFM\_AlarmSet}


  
\bigskip{\sf INTERFACE:}
\begin{verbatim}       subroutine MFM_AlarmSet(this, alarmOn, rc)
     \end{verbatim}{\sf PARAMETERS:}
\begin{verbatim}       type(MFM_Alarm), intent(inout) :: this        ! alarm object    
       logical, intent(in) :: alarmOn                ! true if alarm on
       integer, intent(out), optional :: rc          ! return code
 \end{verbatim}
{\sf DESCRIPTION:\\ }


       Sets whether the alarm is on.
  
%...............................................................