/[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.9 by molod,
Wed Jun 28 15:35:07 2006 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
+ %
+ \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|}
-Line 68 
 Table \ref{tab:pkg:exf:cpp} summarizes t
+Line 86 
 Table \ref{tab:pkg:exf:cpp} summarizes t
        \hline
           \multicolumn{2}{|c|}{\textit{used in conjunction with relaxation to prescribed (climatological) fields}} \\
           \hline
-         \texttt{ALLOW\_CLIMTEMP\_RELAXATION} &
-           relaxation to 3-D temperature climatology \\
-         \texttt{ALLOW\_CLIMSALT\_RELAXATION} &
-           relaxation to 3-D salinity climatology \\
          \texttt{ALLOW\_CLIMSST\_RELAXATION} &
            relaxation to 2-D SST climatology \\
          \texttt{ALLOW\_CLIMSSS\_RELAXATION} &
-Line 93 
 Table \ref{tab:pkg:exf:cpp} summarizes t
+Line 107 
 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!]
+ \centering
    \label{tab:pkg:exf:runtime_flags}
    {\footnotesize
      \begin{tabular}{|l|c|l|}
-Line 137 
 Run-time parameters may be broken into 2
+Line 160 
 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 156 
 prepend the field name to the listed att
+Line 180 
 prepend the field name to the listed att
  %
  \begin{table}[h!]
+ \centering
    \label{tab:pkg:exf:runtime_attributes}
    {\footnotesize
      \begin{tabular}{|l|c|l|}
-Line 231 
 supplied as well.
+Line 256 
 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 266 
 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 263 
 c               |  Typical range: -0.5 <
+Line 288 
 c               |  Typical range: -0.5 <
  c               |  Southwest C-grid V point
  c               |  Input field
  c----------------------------------------------------------------------
+ c     hs        :: sensible heat flux into ocean in W/m^2
+ c               |  > 0 for increase in theta (ocean warming)
+ c----------------------------------------------------------------------
+ c     hl        :: latent   heat flux into ocean in W/m^2
+ c               |  > 0 for increase in theta (ocean warming)
+ c----------------------------------------------------------------------
  c     hflux     :: Net upward surface heat flux in W/m^2
  c               |  excluding shortwave (on input)
  c               |  hflux = latent + sensible + lwflux
-Line 299 
 c               |  Typical range: -10 <
+Line 330 
 c               |  Typical range: -10 <
  c               |  Southwest C-grid V point
  c               |  Input or input/output field
  c----------------------------------------------------------------------
+ c     wspeed    :: Surface (10-m) wind speed in m/s
+ c               |  >= 0 sqrt(u^2+v^2)
+ c               |  Typical range: 0 < wspeed < 10
+ c               |  Input or input/output field
+ c----------------------------------------------------------------------
  c     atemp     :: Surface (2-m) air temperature in deg K
  c               |  Typical range: 200 < atemp < 300
  c               |  Southwest C-grid tracer point
-Line 328 
 c               |  Typical range: 0 < pr
+Line 364 
 c               |  Typical range: 0 < pr
  c               |  Southwest C-grid tracer point
  c               |  Input or input/output field
  c----------------------------------------------------------------------
+ c    snowprecip :: snow in m/s
+ c               |  > 0 for decrease in salt (ocean salinity)
+ c               |  Typical range: 0 < precip < 5e-7
+ c               |  Input or input/output field
+ c----------------------------------------------------------------------
  c     runoff    :: River and glacier runoff in m/s
  c               |  > 0 for decrease in salt (ocean salinity)
  c               |  Typical range: 0 < runoff < ????
-Line 360 
 c---------------------------------------
+Line 401 
 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 373 
 c ...
+Line 414 
 c ...
  c  exf_getforcing (TOP LEVEL ROUTINE)
  c  |
  c  |-- exf_getclim (get climatological fields used e.g. for relax.)
- c  |   |--- exf_set_climtemp (relax. to 3-D temperature field)
- c  |   |--- exf_set_climsalt (relax. to 3-D salinity field)
  c  |   |--- exf_set_climsst  (relax. to 2-D SST field)
  c  |   |--- exf_set_climsss  (relax. to 2-D SSS field)
  c  |   o
-Line 385 
 c  |   |      depending on CPP options (
+Line 424 
 c  |   |      depending on CPP options (
  c  |   |      consecutive in time are read in and interpolated onto
  c  |   |      current time step).
  c  |   |   2. If forcing is atmos. state and control is atmos. state,
- c  |   |      then the control variable anomalies are read here
+ c  |   |      then the control variable anomalies are read here via ctrl_get_gen
- c  |   |          * ctrl_getatemp
+ c  |   |      (atemp, aqh, precip, swflux, swdown, uwind, vwind).
- c  |   |          * ctrl_getaqh
- c  |   |          * ctrl_getuwind
- c  |   |          * ctrl_getvwind
  c  |   |      If forcing and control are fluxes, then
  c  |   |      controls are added later.
  c  |   o
  c  |
- c  |-- exf_check_range
+ c  |-- exf_radiation
- c  |   |   1. Check whether read fields are within assumed range
+ c  |   |    Compute net or downwelling radiative fluxes via
- c  |   |      (may capture mismatches in units)
+ c  |   |    Stefan-Boltzmann law in case only one is known.
+ c  |   o
+ c  |-- exf_wind
+ c  |   |   Computes wind speed and stresses, if required.
  c  |   o
  c  |
  c  |-- exf_bulkformulae
- c  |   |   1. Compute net or downwelling radiative fluxes via
+ c  |   |   Compute air-sea buoyancy fluxes from
- c  |   |      Stefan-Boltzmann law in case only one is known.
+ c  |   |   atmospheric state following Large and Pond, JPO, 1981/82
- c  |   |   2. Compute air-sea momentum and buoyancy fluxes from
- c  |   |      atmospheric state following Large and Pond, JPO, 1981/82
  c  |   o
  c  |
- c  |-- < add time-mean river runoff here, if available >
+ c  |-- < hflux is sum of sensible, latent, longwave rad. >
+ c  |-- < sflux is sum of evap. minus precip. minus runoff  >
+ c  |
+ c  |-- exf_getsurfacefluxes
+ c  |   If forcing and control is flux, then the
+ c  |   control vector anomalies are read here via ctrl_get_gen
+ c  |   (hflux, sflux, ustress, vstress)
  c  |
  c  |-- < update tile edges here >
  c  |
- c  |-- exf_getsurfacefluxes
+ c  |-- exf_check_range
- c  |   |   1. If forcing and control are fluxes, then
+ c  |   |   Check whether read fields are within assumed range
- c  |   |      controls are added here.
+ c  |   |   (may capture mismatches in units)
  c  |   o
  c  |
- c  |-- < treatment of hflux w.r.t. swflux >
+ c  |-- < add shortwave to hflux for diagnostics >
  c  |
  c  |-- exf_diagnostics_fill
- c  |   |   1. Do EXF-related diagnostics output here.
+ c  |   |   Do EXF-related diagnostics output here.
  c  |   o
  c  |
  c  |-- exf_mapfields
- c  |   |   1. Map the EXF variables onto the core MITgcm
+ c  |   |   Forcing fields from exf package are mapped onto
- c  |   |      forcing fields.
+ c  |   |   mitgcm forcing arrays.
+ c  |   |   Mapping enables a runtime rescaling of fields
  c  |   o
- c  |
+ C  o
- c  |-- exf_bulkformulae
- c  |   If ALLOW_BULKFORMULAE, compute fluxes via bulkformulae
- c  |
- c  |-- exf_getsurfacefluxes
- c  |   If forcing and control is flux, then the
- c  |   control vector anomalies are read here
- c  |      * ctrl_getheatflux
- c  |      * ctrl_getsaltflux
- c  |      * ctrl_getzonstress
- c  |      * call ctrl_getmerstress
- c  |
- c  |-- exf_mapfields
- c  |   Forcing fields from exf package are mapped onto
- c  |   mitgcm forcing arrays.
- c  |   Mapping enables a runtime rescaling of fields
  \end{verbatim}
  }
- \subsubsection{Bulk formula routine: \texttt{exf\_bulkformulae.F}}
+ Radiation calculation: \texttt{exf\_radiation.F}
+ Wind speed and stress calculation: \texttt{exf\_wind.F}
- \subsubsection{Generic I/O routine: \texttt{exf\_set\_gen.F}}
+ Bulk formula: \texttt{exf\_bulkformulae.F}
- \subsubsection{Interpolation routine: \texttt{exf\_interp.F}}
+ Generic I/O: \texttt{exf\_set\_gen.F}
- \subsubsection{Header routines}
+ Interpolation: \texttt{exf\_interp.F}
+ Header routines
  %----------------------------------------------------------------------
- \subsection{EXF diagnostics
+ \subsubsection{EXF diagnostics
  \label{sec:pkg:exf:diagnostics}}
  Diagnostics output is available via the diagnostics package
-Line 464 
 Available output fields are summarized i
+Line 496 
 Available output fields are summarized i
  Table \ref{tab:pkg:exf:diagnostics}.
  \begin{table}[h!]
+ \centering
  \label{tab:pkg:exf:diagnostics}
  {\footnotesize
  \begin{verbatim}
  ------------------------------------------------------
   <-Name->|Levs|grid|<--  Units   -->|<- Tile (max=80c)
  ------------------------------------------------------
+  EXFhs   |  1 | SM | W/m^2          | Sensible heat flux into ocean, >0 increases theta
+  EXFhl   |  1 | SM | W/m^2          | Latent heat flux into ocean, >0 increases theta
+  EXFlwnet|  1 | SM | W/m^2          | Net upward longwave radiation, >0 decreases theta
+  EXFswnet|  1 | SM | W/m^2          | Net upward shortwave radiation, >0 decreases theta
   EXFlwdn |  1 | SM | W/m^2          | Downward longwave radiation, >0 increases theta
   EXFswdn |  1 | SM | W/m^2          | Downward shortwave radiation, >0 increases theta
   EXFqnet |  1 | SM | W/m^2          | Net upward heat flux (turb+rad), >0 decreases theta
-Line 477 
 Table \ref{tab:pkg:exf:diagnostics}.
+Line 514 
 Table \ref{tab:pkg:exf:diagnostics}.
   EXFtauy |  1 | SV | N/m^2          | meridional surface wind stress, >0 increases vVel
   EXFuwind|  1 | SM | m/s            | zonal 10-m wind speed, >0 increases uVel
   EXFvwind|  1 | SM | m/s            | meridional 10-m wind speed, >0 increases uVel
+  EXFwspee|  1 | SM | m/s            | 10-m wind speed modulus ( >= 0 )
   EXFatemp|  1 | SM | degK           | surface (2-m) air temperature
   EXFaqh  |  1 | SM | kg/kg          | surface (2-m) specific humidity
   EXFevap |  1 | SM | m/s            | evaporation, > 0 increases salinity
   EXFpreci|  1 | SM | m/s            | evaporation, > 0 decreases salinity
+  EXFsnow |  1 | SM | m/s            | snow precipitation, > 0 decreases salinity
   EXFempmr|  1 | SM | m/s            | net upward freshwater flux, > 0 increases salinity
   EXFpress|  1 | SM | N/m^2          | atmospheric pressure field
  \end{verbatim}
-Line 490 
 Table \ref{tab:pkg:exf:diagnostics}.
+Line 529 
 Table \ref{tab:pkg:exf:diagnostics}.
  %----------------------------------------------------------------------
- \subsection{Reference experiments}
+ \subsubsection{Experiments and tutorials that use exf}
+ \label{sec:pkg:exf:experiments}
- \subsubsection{global\_with\_exf}
- \subsubsection{lab\_sea}
+ \begin{itemize}
+ \item{Global Ocean experiment, in global\_with\_exf verification directory }
+ \item{Labrador Sea experiment, in lab\_sea verification directory }
+ \end{itemize}
  %----------------------------------------------------------------------
- \subsection{References}
+ \subsubsection{References}

 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.9
 Legend:



Removed from v.1.3
 


changed lines


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

	ViewVC Help
Powered by ViewVC 1.1.22