--- manual/s_phys_pkgs/text/exf.tex 2005/07/18 20:45:27 1.4 +++ manual/s_phys_pkgs/text/exf.tex 2005/10/03 18:12:27 1.7 @@ -4,6 +4,7 @@ \end{rawhtml} +Authors: Patrick Heimbach and Dimitris Menemenlis \subsubsection{Introduction \label{sec:pkg:exf:intro}} @@ -35,17 +36,34 @@ \paragraph{Compile-time options \label{sec:pkg:exf:config}} +~ As with all MITgcm packages, EXF can be turned on or off at compile time -using the \texttt{packages.conf} file or the \texttt{genmake2} -\texttt{-enable=exf} or \texttt{-disable=exf} switches. +% +\begin{itemize} +% +\item +using the \texttt{packages.conf} file by adding \texttt{exf} to it, +% +\item +or using \texttt{genmake2} adding +\texttt{-enable=exf} or \texttt{-disable=exf} switches +% +\item +\textit{required packages and CPP options}: \\ +EXF requires the calendar package \texttt{cal} to be enabled; +no additional CPP options are required. +% +\end{itemize} +(see Section \ref{sect:buildingCode}). -Parts of the exf code can be enabled or disabled at compile time +Parts of the EXF code can be enabled or disabled at compile time via CPP preprocessor flags. These options are set in either \texttt{EXF\_OPTIONS.h} or in \texttt{ECCO\_CPPOPTIONS.h}. Table \ref{tab:pkg:exf:cpp} summarizes these options. \begin{table}[b!] +\centering \label{tab:pkg:exf:cpp} {\footnotesize \begin{tabular}{|l|l|} @@ -93,18 +111,27 @@ \subsubsection{Run-time parameters \label{sec:pkg:exf:runtime}} -Run-time parameters are set in files \texttt{data.pkg}, -and \texttt{data.pkg\_clim} (for relaxation/climatological fields) +Run-time parameters are set in files +\texttt{data.pkg}, \texttt{data.exf}, and +\texttt{data.exf\_clim} (for relaxation/climatological fields) which are read in \texttt{exf\_readparms.F}. -Run-time parameters may be broken into 2 categories: -(i) general flags and parameters, and -(ii) attributes for each forcing and climatological field. - -\paragraph{General flags and parameters} +Run-time parameters may be broken into 3 categories: +(i) switching on/off the package at runtime, +(ii) general flags and parameters, and +(iii) attributes for each forcing and climatological field. -~ +\paragraph{Enabling the package} +~ \\ +% +A package is usually switched on/off at runtime by setting +(e.g. for EXF) \texttt{useEXF = .TRUE.} in \texttt{data.pkg}. +For EXF this flag is omitted, i.e. EXF is always ON if it is compiled. +\paragraph{General flags and parameters} +~ \\ +% \begin{table}[h!] +\centering \label{tab:pkg:exf:runtime_flags} {\footnotesize \begin{tabular}{|l|c|l|} @@ -137,7 +164,8 @@ \end{table} -\paragraph{Field attributes} ~ \\ +\paragraph{Field attributes} +~ \\ % All EXF fields are listed in Section \ref{sec:pkg:exf:fields_units}. Each field has a number of attributes which can be customized. @@ -156,6 +184,7 @@ % \begin{table}[h!] +\centering \label{tab:pkg:exf:runtime_attributes} {\footnotesize \begin{tabular}{|l|c|l|} @@ -241,7 +270,7 @@ \textbf{fu}, \textbf{fv}, \textbf{Qnet}, \textbf{Qsw}, \textbf{EmPmR}, and \textbf{pload}. They are defined in \texttt{FFIELDS.h}. -{\scriptsize +{\footnotesize \begin{verbatim} c---------------------------------------------------------------------- @@ -365,7 +394,7 @@ Top-level routine: \texttt{exf\_getforcing.F} -{\scriptsize +{\footnotesize \begin{verbatim} C !CALLING SEQUENCE: @@ -464,6 +493,7 @@ Table \ref{tab:pkg:exf:diagnostics}. \begin{table}[h!] +\centering \label{tab:pkg:exf:diagnostics} {\footnotesize \begin{verbatim}