timemgmt_refdoc.tex

CCSM Research Tools: Community Atmosphere Model (CAM)

% $Id: TimeMgmt_refdoc.tex,v 1.1.6.1 2002/04/24 03:25:49 erik Exp $

\documentclass[]{article}

\usepackage{epsf}
\usepackage{html}
\usepackage[T1]{fontenc}

\textwidth 6.5in
\textheight 8.5in
\addtolength{\oddsidemargin}{-.75in}

\begin{document}

\bodytext{BGCOLOR=white LINK=#083194 VLINK=#21004A}

\begin{titlepage}

\begin{center}
{\Large Earth System Modeling Framework } \\
\vspace{.25in}
{\Large {\bf Time Management Library F90 Reference}} \\
\vspace{.25in}
{\large {\it Brian Eaton, Cecelia DeLuca, David Neckels, Noel Jorden}}
\vspace{.5in}
\end{center}

\begin{latexonly}
\vspace{5.5in}
\begin{tabular}{p{5in}p{.9in}}
\hrulefill \\
\noindent {\bf NASA High Performance Computing and Communications Program} \\
\noindent Earth and Space Sciences Project \\
\noindent CAN 00-OES-01 \\
\noindent http://www.esmf.ucar.edu \\
\end{tabular}
\end{latexonly}

\end{titlepage}

\tableofcontents

\newpage
%\section{Synopsis}
\input{TimeMgmt_syn}

The design of this Time Management Library is based on the time management 
utilities in the \htmladdnormallink{Flexible Modeling System}{http://www.gfdl.gov/~fms} (FMS) from the 
\htmladdnormallink{NOAA Geophysical Fluid Dynamics Laboratory}{http://www.gfdl.gov}.

It is built on infrastructure derived from the \htmladdnormallink{Portable Extensible 
Toolkit for Scientific Computation}{http://www-fp.mcs.anl.gov/petsc/} (PETSc) 
from \htmladdnormallink{Argonne National Laboratory}{http://www-fp.mcs.anl.gov}.

\section{Installation and General Usage}
See the \htmladdnormallink{ESMF User's Guide}{http://www.esmf.ucar.edu/esmf_docs/ESMF_usrdoc/} for installation instructions and a discussion of overall 
usage of the ESMF libraries.

%\section{Architecture}
%\input{TimeMgmt_arch}

\newpage
\section{Time Class}

\subsection{Description}
\input{Time_desc}

\subsection{Restrictions}
\input{Time_rest}

\subsection{Use and Examples}
\input{Time_fex}

\newpage
\section{Date Class}

\subsection{Description}
\input{Date_desc}

\subsection{Restrictions}
\input{Date_rest}

\subsection{Future Plans}
\input{Date_fut}

\subsection{Use and Examples}
\input{Date_fex}

\newpage
\section{TimeMgr Class}

\subsection{Description}
\input{TimeMgr_desc}

\subsection{Use and Examples}
\input{TimeMgr_fex}

\newpage
\section{Alarm Class}

\subsection{Description}
\input{Alarm_desc}

\subsection{Use and Examples}
\input{Alarm_fex}

%\section{Glossary}
\input{TimeMgmt_glos}

%\section{Bibliography}
%\bibliography{comp} 
%\bibliographystyle{plain}
%\addcontentsline{toc}{section}{Bibliography}

\newpage
\setcounter{section}{1}
\renewcommand{\thesection}{\Alph{section}}
\renewcommand{\thesubsection}{\thesection\arabic{subsection}}

\section*{Appendix A:  Fortran Interface}
\addcontentsline{toc}{section}{Appendix A:  Fortran Interface}

\input{ESMF_TimeMod}

\input{ESMF_DateMod}

\input{ESMF_TimeMgrMod}

\input{ESMF_AlarmMod}

\newpage
\setcounter{section}{2}
\renewcommand{\thesection}{\Alph{section}}
\renewcommand{\thesubsection}{\thesection\arabic{subsection}}

\section*{Appendix B:  Class Implementations}
\addcontentsline{toc}{section}{Appendix B:  Class Implementations}

\subsection{Public Classes}

\input{ESMC_Time}

\input{ESMC_Date}

\input{ESMC_TimeMgr}

\input{ESMC_Alarm}

\subsection{Private Classes}

\input{ESMC_Calendar}

\input{ESMC_TOD}

\end{document}