--- manual/s_phys_pkgs/text/exf.tex 2006/06/27 20:00:18 1.8 +++ manual/s_phys_pkgs/text/exf.tex 2011/06/22 02:06:29 1.15 @@ -22,13 +22,13 @@ CPP options enable or disable different aspects of the package (Section \ref{sec:pkg:exf:config}). Runtime options, flags, filenames and field-related dates/times are -set in \texttt{data.exf} and \texttt{data.exf\_clim} +set in \texttt{data.exf} (Section \ref{sec:pkg:exf:runtime}). A description of key subroutines is given in Section \ref{sec:pkg:exf:subroutines}. Input fields, units and sign conventions are summarized in Section \ref{sec:pkg:exf:fields_units}, and available diagnostics -output is listed in Section \ref{sec:pkg:exf:fields_diagnostics}. +output is listed in Section \ref{sec:pkg:exf:diagnostics}. %---------------------------------------------------------------------- @@ -55,7 +55,7 @@ no additional CPP options are required. % \end{itemize} -(see Section \ref{sect:buildingCode}). +(see Section \ref{sec:buildingCode}). Parts of the EXF code can be enabled or disabled at compile time via CPP preprocessor flags. These options are set in either @@ -63,8 +63,7 @@ Table \ref{tab:pkg:exf:cpp} summarizes these options. \begin{table}[b!] -\centering - \label{tab:pkg:exf:cpp} + \centering {\footnotesize \begin{tabular}{|l|l|} \hline @@ -99,6 +98,7 @@ \end{tabular} } \caption{~} + \label{tab:pkg:exf:cpp} \end{table} @@ -119,16 +119,14 @@ \paragraph{Enabling the package} ~ \\ % -A package is usually switched on/off at runtime by setting +A package is 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} +\begin{table}[!ht] + \centering {\footnotesize \begin{tabular}{|l|c|l|} \hline @@ -149,6 +147,73 @@ max. allowed wind stress $N/m^2$ \\ exf\_albedo & \texttt{0.1} & surface albedo used to compute downward vs. net radiative fluxes \\ + climtempfreeze & \texttt{-1.9} & + ??? \\ + ocean\_emissivity & \texttt{} & + longwave ocean-surface emissivity \\ + ice\_emissivity & \texttt{} & + longwave seaice emissivity \\ + snow\_emissivity & \texttt{} & + longwave snow emissivity \\ + exf\_iceCd & \texttt{1.63E-3} & + drag coefficient over sea-ice \\ + exf\_iceCe & \texttt{1.63E-3} & + evaporation transfer coeff. over sea-ice \\ + exf\_iceCh & \texttt{1.63E-3} & + sensible heat transfer coeff. over sea-ice \\ + exf\_scal\_BulkCdn & \texttt{1.} & + overall scaling of neutral drag coeff. \\ + useStabilityFct\_overIce & \texttt{.FALSE.} & + compute turbulent transfer coeff. over sea-ice \\ + readStressOnAgrid & \texttt{.FALSE.} & + read wind-streess located on model-grid, A-grid point \\ + readStressOnCgrid & \texttt{.FALSE.} & + read wind-streess located on model-grid, C-grid point \\ + useRelativeWind & \texttt{.FALSE.} & + subtract [U/V]VEL or [U/VICE from U/V]WIND before \\ + ~ & ~ & computing [U/V]STRESS \\ + zref & \texttt{10.} & + reference height \\ + hu & \texttt{10.} & + height of mean wind \\ + ht & \texttt{2.} & + height of mean temperature and rel. humidity \\ + umin & \texttt{0.5} & + minimum absolute wind speed for computing Cd \\ + atmrho & \texttt{1.2} & + mean atmospheric density [kg/m\^3] \\ + atmcp & \texttt{1005.} & + mean atmospheric specific heat [J/kg/K] \\ + cdrag\_[n] & \texttt{???} & + n = 1,2,3; parameters for drag coeff. function \\ + cstanton\_[n] & \texttt{???} & + n = 1,2; parameters for Stanton number function \\ + cdalton & \texttt{???} & + parameter for Dalton number function \\ + flamb & \texttt{2500000.} & + latent heat of evaporation [J/kg] \\ + flami & \texttt{334000.} & + latent heat of melting of pure ice [J/kg] \\ + zolmin & \texttt{-100.} & + minimum stability parameter \\ + cvapor\_fac & \texttt{640380.} & + ~ \\ + cvapor\_exp & \texttt{5107.4} & + ~ \\ + cvapor\_fac\_ice & \texttt{11637800.} & + ~ \\ + cvapor\_fac\_ice & \texttt{5897.8} & + ~ \\ + humid\_fac & \texttt{0.606} & + parameter for virtual temperature calculation \\ + gamma\_blk & \texttt{0.010} & + adiabatic lapse rate \\ + saltsat & \texttt{0.980} & + reduction of saturation vapor pressure over salt-water \\ + psim\_fac & \texttt{5.} & + ~ \\ + exf\_monFreq & \texttt{monitorFreq} & + output frequency [s] \\ exf\_iprec & \texttt{32} & precision of input fields (32-bit or 64-bit) \\ exf\_yftype & \texttt{'RL'} & @@ -157,6 +222,7 @@ \end{tabular} } \caption{~} + \label{tab:pkg:exf:runtime_flags} \end{table} @@ -179,9 +245,8 @@ \end{eqnarray*} % -\begin{table}[h!] -\centering - \label{tab:pkg:exf:runtime_attributes} +\begin{table}[!ht] + \centering {\footnotesize \begin{tabular}{|l|c|l|} \hline @@ -207,11 +272,11 @@ \multicolumn{3}{|c|}{\textit{used in conjunction with} \texttt{EXF\_USE\_INTERPOLATION}} \\ \hline - \textit{field}\texttt{\_lon0} & $thetaMin+delX/2$ & + \textit{field}\texttt{\_lon0} & $xgOrigin+delX/2$ & starting longitude of input \\ \textit{field}\texttt{\_lon\_inc} & $delX$ & increment in longitude of input \\ - \textit{field}\texttt{\_lat0} & $phiMin+delY/2$ & + \textit{field}\texttt{\_lat0} & $ygOrigin+delY/2$ & starting latitude of input \\ \textit{field}\texttt{\_lat\_inc} & $delY$ & increment in latitude of input \\ @@ -222,15 +287,16 @@ \hline \end{tabular} } - \caption{\newline - Note one exception for the default of - \texttt{atempconst} = celsius2K = 273.16} + \caption{\newline + Note one exception for the default of + \texttt{atempconst} = celsius2K = 273.16} + \label{tab:pkg:exf:runtime_attributes} \end{table} \paragraph{Example configuration} ~ \\ % The following block is taken from the \texttt{data.exf} file -of the veification experiment \texttt{global\_with\_exf/}. +of the verification experiment \texttt{global\_with\_exf/}. It defines attributes for the heat flux variable \texttt{hflux}: \begin{verbatim} @@ -247,8 +313,16 @@ \end{verbatim} EXF will read a file of name 'ncep\_qnet.bin'. -Its first record represents January 1st, 1991 at 00:00 UTC. +Its first record represents January 1st, 1992 at 00:00 UTC. Next record is 2592000 seconds (or 30 days) later. +Note that the first record read and used by the EXF package corresponds to the +value 'startDate1' set in data.cal. Therefore if you want to start the EXF +forcing from later in the 'ncep\_qnet.bin' file, it suffices to specify +startDate1 in data.cal as a date later than 19920101 (for example, startDate1 += 19940101, for starting January 1st, 1994). For this to work, +'ncep\_qnet.bin' must have at least 2 years of data because in this +configuration EXF will read 2 years into the file to find the 1994 starting +value. Interpolation on-the-fly is used (in the present case trivially on the same grid, but included nevertheless for illustration), and input field grid starting coordinates and increments are @@ -256,6 +330,13 @@ %---------------------------------------------------------------------- +\subsubsection{EXF bulk formulae +\label{sec:pkg:exf:bulk_formulae}} + +T.B.D. (cross-ref. to parameter list table) + +%---------------------------------------------------------------------- + \subsubsection{EXF input fields and units \label{sec:pkg:exf:fields_units}} @@ -495,14 +576,13 @@ Available output fields are summarized in Table \ref{tab:pkg:exf:diagnostics}. -\begin{table}[h!] +\begin{table}[!ht] \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 @@ -525,15 +605,18 @@ \end{verbatim} } \caption{~} +\label{tab:pkg:exf:diagnostics} \end{table} %---------------------------------------------------------------------- -\subsubsection{Reference experiments} - -global\_with\_exf: +\subsubsection{Experiments and tutorials that use exf} +\label{sec:pkg:exf:experiments} -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} %----------------------------------------------------------------------