/[MITgcm]/manual/s_phys_pkgs/text/exf.tex

Diff of /manual/s_phys_pkgs/text/exf.tex

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.3 by heimbach,
Fri Jul 15 20:08:42 2005 UTC
+revision 1.5 by heimbach,
Mon Aug  1 22:31:36 2005 UTC
 Line 1
- \section{EXF: The external forcing package
+ \subsection{EXF: The external forcing package
  \label{sec:pkg:exf}}
  \begin{rawhtml}
  <!-- CMIREDIR:sectionexf: -->
  \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
-Line 31 
 output is listed in Section \ref{sec:pkg
+Line 32 
 output is listed in Section \ref{sec:pkg
  %----------------------------------------------------------------------
- \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.
-Line 93 
 Table \ref{tab:pkg:exf:cpp} summarizes t
+Line 105 
 Table \ref{tab:pkg:exf:cpp} summarizes t
  \subsubsection{Run-time parameters
  \label{sec:pkg:exf:runtime}}
- Run-time parameters are set in files \texttt{data.pkg},
+ Run-time parameters are set in files
- and \texttt{data.pkg\_clim} (for relaxation/climatological fields)
+ \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:
+ Run-time parameters may be broken into 3 categories:
- (i) general flags and parameters, and
+ (i) switching on/off the package at runtime,
- (ii) attributes for each forcing and climatological field.
+ (ii) general flags and parameters, and
+ (iii) attributes for each forcing and climatological field.
- \paragraph{General flags and parameters}
- ~
+ \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
-Line 137 
 Run-time parameters may be broken into 2
+Line 157 
 Run-time parameters may be broken into 2
  \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.
-Line 231 
 supplied as well.
+Line 252 
 supplied as well.
  %----------------------------------------------------------------------
- \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}.
-Line 241 
 Output fields which EXF provides to the
+Line 262 
 Output fields which EXF provides to the
  \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----------------------------------------------------------------------
-Line 360 
 c---------------------------------------
+Line 381 
 c---------------------------------------
  %----------------------------------------------------------------------
- \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:
-Line 445 
 c  |   Mapping enables a runtime rescali
+Line 466 
 c  |   Mapping enables a runtime rescali
  \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
-Line 490 
 Table \ref{tab:pkg:exf:diagnostics}.
+Line 511 
 Table \ref{tab:pkg:exf:diagnostics}.
  %----------------------------------------------------------------------
- \subsection{Reference experiments}
+ \subsubsection{Reference experiments}
- \subsubsection{global\_with\_exf}
+ global\_with\_exf:
- \subsubsection{lab\_sea}
+ lab\_sea:
  %----------------------------------------------------------------------
- \subsection{References}
+ \subsubsection{References}

 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.5
 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.5
-Removed from v.1.3
+Added in v.1.5

	ViewVC Help
Powered by ViewVC 1.1.22