--- manual/s_phys_pkgs/text/exf.tex 2005/07/15 20:08:42 1.3 +++ manual/s_phys_pkgs/text/exf.tex 2005/08/01 22:31:36 1.5 @@ -1,11 +1,12 @@ -\section{EXF: The external forcing package +\subsection{EXF: The external forcing package \label{sec:pkg:exf}} \begin{rawhtml} \end{rawhtml} +Authors: Patrick Heimbach and Dimitris Menemenlis -\subsection{Introduction +\subsubsection{Introduction \label{sec:pkg:exf:intro}} The external forcing package, in conjunction with the @@ -31,16 +32,27 @@ %---------------------------------------------------------------------- -\subsection{EXF configuration, compiling \& running} +\subsubsection{EXF configuration, compiling \& running} -\subsubsection{Compile-time options +\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 +% +\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. @@ -93,17 +105,25 @@ \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!] \label{tab:pkg:exf:runtime_flags} {\footnotesize @@ -137,7 +157,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. @@ -231,7 +252,7 @@ %---------------------------------------------------------------------- -\subsection{EXF input fields and units +\subsubsection{EXF input fields and units \label{sec:pkg:exf:fields_units}} The following list is taken from the header file \texttt{exf\_fields.h}. @@ -241,7 +262,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---------------------------------------------------------------------- @@ -360,12 +381,12 @@ %---------------------------------------------------------------------- -\subsection{Key subroutines +\subsubsection{Key subroutines \label{sec:pkg:exf:subroutines}} -\subsubsection{Top-level routine: \texttt{exf\_getforcing.F}} +Top-level routine: \texttt{exf\_getforcing.F} -{\scriptsize +{\footnotesize \begin{verbatim} C !CALLING SEQUENCE: @@ -445,17 +466,17 @@ \end{verbatim} } -\subsubsection{Bulk formula routine: \texttt{exf\_bulkformulae.F}} +Bulk formula routine: \texttt{exf\_bulkformulae.F} -\subsubsection{Generic I/O routine: \texttt{exf\_set\_gen.F}} +Generic I/O routine: \texttt{exf\_set\_gen.F} -\subsubsection{Interpolation routine: \texttt{exf\_interp.F}} +Interpolation routine: \texttt{exf\_interp.F} -\subsubsection{Header routines} +Header routines %---------------------------------------------------------------------- -\subsection{EXF diagnostics +\subsubsection{EXF diagnostics \label{sec:pkg:exf:diagnostics}} Diagnostics output is available via the diagnostics package @@ -490,12 +511,12 @@ %---------------------------------------------------------------------- -\subsection{Reference experiments} +\subsubsection{Reference experiments} -\subsubsection{global\_with\_exf} +global\_with\_exf: -\subsubsection{lab\_sea} +lab\_sea: %---------------------------------------------------------------------- -\subsection{References} +\subsubsection{References}