22 |
CPP options enable or disable different aspects of the package |
CPP options enable or disable different aspects of the package |
23 |
(Section \ref{sec:pkg:exf:config}). |
(Section \ref{sec:pkg:exf:config}). |
24 |
Runtime options, flags, filenames and field-related dates/times are |
Runtime options, flags, filenames and field-related dates/times are |
25 |
set in \texttt{data.exf} and \texttt{data.exf\_clim} |
set in \texttt{data.exf} |
26 |
(Section \ref{sec:pkg:exf:runtime}). |
(Section \ref{sec:pkg:exf:runtime}). |
27 |
A description of key subroutines is given in Section |
A description of key subroutines is given in Section |
28 |
\ref{sec:pkg:exf:subroutines}. |
\ref{sec:pkg:exf:subroutines}. |
29 |
Input fields, units and sign conventions are summarized in |
Input fields, units and sign conventions are summarized in |
30 |
Section \ref{sec:pkg:exf:fields_units}, and available diagnostics |
Section \ref{sec:pkg:exf:fields_units}, and available diagnostics |
31 |
output is listed in Section \ref{sec:pkg:exf:fields_diagnostics}. |
output is listed in Section \ref{sec:pkg:exf:diagnostics}. |
32 |
|
|
33 |
%---------------------------------------------------------------------- |
%---------------------------------------------------------------------- |
34 |
|
|
55 |
no additional CPP options are required. |
no additional CPP options are required. |
56 |
% |
% |
57 |
\end{itemize} |
\end{itemize} |
58 |
(see Section \ref{sect:buildingCode}). |
(see Section \ref{sec:buildingCode}). |
59 |
|
|
60 |
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 |
61 |
via CPP preprocessor flags. These options are set in either |
via CPP preprocessor flags. These options are set in either |
63 |
Table \ref{tab:pkg:exf:cpp} summarizes these options. |
Table \ref{tab:pkg:exf:cpp} summarizes these options. |
64 |
|
|
65 |
\begin{table}[b!] |
\begin{table}[b!] |
66 |
\centering |
\centering |
|
\label{tab:pkg:exf:cpp} |
|
67 |
{\footnotesize |
{\footnotesize |
68 |
\begin{tabular}{|l|l|} |
\begin{tabular}{|l|l|} |
69 |
\hline |
\hline |
98 |
\end{tabular} |
\end{tabular} |
99 |
} |
} |
100 |
\caption{~} |
\caption{~} |
101 |
|
\label{tab:pkg:exf:cpp} |
102 |
\end{table} |
\end{table} |
103 |
|
|
104 |
|
|
119 |
\paragraph{Enabling the package} |
\paragraph{Enabling the package} |
120 |
~ \\ |
~ \\ |
121 |
% |
% |
122 |
A package is usually switched on/off at runtime by setting |
A package is switched on/off at runtime by setting |
123 |
(e.g. for EXF) \texttt{useEXF = .TRUE.} in \texttt{data.pkg}. |
(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. |
|
124 |
|
|
125 |
\paragraph{General flags and parameters} |
\paragraph{General flags and parameters} |
126 |
~ \\ |
~ \\ |
127 |
% |
% |
128 |
\begin{table}[h!] |
\begin{table}[!ht] |
129 |
\centering |
\centering |
|
\label{tab:pkg:exf:runtime_flags} |
|
130 |
{\footnotesize |
{\footnotesize |
131 |
\begin{tabular}{|l|c|l|} |
\begin{tabular}{|l|c|l|} |
132 |
\hline |
\hline |
147 |
max. allowed wind stress $N/m^2$ \\ |
max. allowed wind stress $N/m^2$ \\ |
148 |
exf\_albedo & \texttt{0.1} & |
exf\_albedo & \texttt{0.1} & |
149 |
surface albedo used to compute downward vs. net radiative fluxes \\ |
surface albedo used to compute downward vs. net radiative fluxes \\ |
150 |
|
climtempfreeze & \texttt{-1.9} & |
151 |
|
??? \\ |
152 |
|
ocean\_emissivity & \texttt{} & |
153 |
|
longwave ocean-surface emissivity \\ |
154 |
|
ice\_emissivity & \texttt{} & |
155 |
|
longwave seaice emissivity \\ |
156 |
|
snow\_emissivity & \texttt{} & |
157 |
|
longwave snow emissivity \\ |
158 |
|
exf\_iceCd & \texttt{1.63E-3} & |
159 |
|
drag coefficient over sea-ice \\ |
160 |
|
exf\_iceCe & \texttt{1.63E-3} & |
161 |
|
evaporation transfer coeff. over sea-ice \\ |
162 |
|
exf\_iceCh & \texttt{1.63E-3} & |
163 |
|
sensible heat transfer coeff. over sea-ice \\ |
164 |
|
exf\_scal\_BulkCdn & \texttt{1.} & |
165 |
|
overall scaling of neutral drag coeff. \\ |
166 |
|
useStabilityFct\_overIce & \texttt{.FALSE.} & |
167 |
|
compute turbulent transfer coeff. over sea-ice \\ |
168 |
|
readStressOnAgrid & \texttt{.FALSE.} & |
169 |
|
read wind-streess located on model-grid, A-grid point \\ |
170 |
|
readStressOnCgrid & \texttt{.FALSE.} & |
171 |
|
read wind-streess located on model-grid, C-grid point \\ |
172 |
|
useRelativeWind & \texttt{.FALSE.} & |
173 |
|
subtract [U/V]VEL or [U/VICE from U/V]WIND before \\ |
174 |
|
~ & ~ & computing [U/V]STRESS \\ |
175 |
|
zref & \texttt{10.} & |
176 |
|
reference height \\ |
177 |
|
hu & \texttt{10.} & |
178 |
|
height of mean wind \\ |
179 |
|
ht & \texttt{2.} & |
180 |
|
height of mean temperature and rel. humidity \\ |
181 |
|
umin & \texttt{0.5} & |
182 |
|
minimum absolute wind speed for computing Cd \\ |
183 |
|
atmrho & \texttt{1.2} & |
184 |
|
mean atmospheric density [kg/m\^3] \\ |
185 |
|
atmcp & \texttt{1005.} & |
186 |
|
mean atmospheric specific heat [J/kg/K] \\ |
187 |
|
cdrag\_[n] & \texttt{???} & |
188 |
|
n = 1,2,3; parameters for drag coeff. function \\ |
189 |
|
cstanton\_[n] & \texttt{???} & |
190 |
|
n = 1,2; parameters for Stanton number function \\ |
191 |
|
cdalton & \texttt{???} & |
192 |
|
parameter for Dalton number function \\ |
193 |
|
flamb & \texttt{2500000.} & |
194 |
|
latent heat of evaporation [J/kg] \\ |
195 |
|
flami & \texttt{334000.} & |
196 |
|
latent heat of melting of pure ice [J/kg] \\ |
197 |
|
zolmin & \texttt{-100.} & |
198 |
|
minimum stability parameter \\ |
199 |
|
cvapor\_fac & \texttt{640380.} & |
200 |
|
~ \\ |
201 |
|
cvapor\_exp & \texttt{5107.4} & |
202 |
|
~ \\ |
203 |
|
cvapor\_fac\_ice & \texttt{11637800.} & |
204 |
|
~ \\ |
205 |
|
cvapor\_fac\_ice & \texttt{5897.8} & |
206 |
|
~ \\ |
207 |
|
humid\_fac & \texttt{0.606} & |
208 |
|
parameter for virtual temperature calculation \\ |
209 |
|
gamma\_blk & \texttt{0.010} & |
210 |
|
adiabatic lapse rate \\ |
211 |
|
saltsat & \texttt{0.980} & |
212 |
|
reduction of saturation vapor pressure over salt-water \\ |
213 |
|
psim\_fac & \texttt{5.} & |
214 |
|
~ \\ |
215 |
|
exf\_monFreq & \texttt{monitorFreq} & |
216 |
|
output frequency [s] \\ |
217 |
exf\_iprec & \texttt{32} & |
exf\_iprec & \texttt{32} & |
218 |
precision of input fields (32-bit or 64-bit) \\ |
precision of input fields (32-bit or 64-bit) \\ |
219 |
exf\_yftype & \texttt{'RL'} & |
exf\_yftype & \texttt{'RL'} & |
222 |
\end{tabular} |
\end{tabular} |
223 |
} |
} |
224 |
\caption{~} |
\caption{~} |
225 |
|
\label{tab:pkg:exf:runtime_flags} |
226 |
\end{table} |
\end{table} |
227 |
|
|
228 |
|
|
245 |
\end{eqnarray*} |
\end{eqnarray*} |
246 |
% |
% |
247 |
|
|
248 |
\begin{table}[h!] |
\begin{table}[!ht] |
249 |
\centering |
\centering |
|
\label{tab:pkg:exf:runtime_attributes} |
|
250 |
{\footnotesize |
{\footnotesize |
251 |
\begin{tabular}{|l|c|l|} |
\begin{tabular}{|l|c|l|} |
252 |
\hline |
\hline |
272 |
\multicolumn{3}{|c|}{\textit{used in conjunction with} |
\multicolumn{3}{|c|}{\textit{used in conjunction with} |
273 |
\texttt{EXF\_USE\_INTERPOLATION}} \\ |
\texttt{EXF\_USE\_INTERPOLATION}} \\ |
274 |
\hline |
\hline |
275 |
\textit{field}\texttt{\_lon0} & $thetaMin+delX/2$ & |
\textit{field}\texttt{\_lon0} & $xgOrigin+delX/2$ & |
276 |
starting longitude of input \\ |
starting longitude of input \\ |
277 |
\textit{field}\texttt{\_lon\_inc} & $delX$ & |
\textit{field}\texttt{\_lon\_inc} & $delX$ & |
278 |
increment in longitude of input \\ |
increment in longitude of input \\ |
279 |
\textit{field}\texttt{\_lat0} & $phiMin+delY/2$ & |
\textit{field}\texttt{\_lat0} & $ygOrigin+delY/2$ & |
280 |
starting latitude of input \\ |
starting latitude of input \\ |
281 |
\textit{field}\texttt{\_lat\_inc} & $delY$ & |
\textit{field}\texttt{\_lat\_inc} & $delY$ & |
282 |
increment in latitude of input \\ |
increment in latitude of input \\ |
287 |
\hline |
\hline |
288 |
\end{tabular} |
\end{tabular} |
289 |
} |
} |
290 |
\caption{\newline |
\caption{\newline |
291 |
Note one exception for the default of |
Note one exception for the default of |
292 |
\texttt{atempconst} = celsius2K = 273.16} |
\texttt{atempconst} = celsius2K = 273.16} |
293 |
|
\label{tab:pkg:exf:runtime_attributes} |
294 |
\end{table} |
\end{table} |
295 |
|
|
296 |
\paragraph{Example configuration} ~ \\ |
\paragraph{Example configuration} ~ \\ |
322 |
|
|
323 |
%---------------------------------------------------------------------- |
%---------------------------------------------------------------------- |
324 |
|
|
325 |
|
\subsubsection{EXF bulk formulae |
326 |
|
\label{sec:pkg:exf:bulk_formulae}} |
327 |
|
|
328 |
|
T.B.D. (cross-ref. to parameter list table) |
329 |
|
|
330 |
|
%---------------------------------------------------------------------- |
331 |
|
|
332 |
\subsubsection{EXF input fields and units |
\subsubsection{EXF input fields and units |
333 |
\label{sec:pkg:exf:fields_units}} |
\label{sec:pkg:exf:fields_units}} |
334 |
|
|
568 |
Available output fields are summarized in |
Available output fields are summarized in |
569 |
Table \ref{tab:pkg:exf:diagnostics}. |
Table \ref{tab:pkg:exf:diagnostics}. |
570 |
|
|
571 |
\begin{table}[h!] |
\begin{table}[!ht] |
572 |
\centering |
\centering |
|
\label{tab:pkg:exf:diagnostics} |
|
573 |
{\footnotesize |
{\footnotesize |
574 |
\begin{verbatim} |
\begin{verbatim} |
575 |
------------------------------------------------------ |
---------+----+----+----------------+----------------- |
576 |
<-Name->|Levs|grid|<-- Units -->|<- Tile (max=80c) |
<-Name->|Levs|grid|<-- Units -->|<- Tile (max=80c) |
577 |
------------------------------------------------------ |
---------+----+----+----------------+----------------- |
578 |
EXFhs | 1 | SM | W/m^2 | Sensible heat flux into ocean, >0 increases theta |
EXFhs | 1 | SM | W/m^2 | Sensible heat flux into ocean, >0 increases theta |
579 |
EXFhl | 1 | SM | W/m^2 | Latent heat flux into ocean, >0 increases theta |
EXFhl | 1 | SM | W/m^2 | Latent heat flux into ocean, >0 increases theta |
580 |
EXFlwnet| 1 | SM | W/m^2 | Net upward longwave radiation, >0 decreases theta |
EXFlwnet| 1 | SM | W/m^2 | Net upward longwave radiation, >0 decreases theta |
597 |
\end{verbatim} |
\end{verbatim} |
598 |
} |
} |
599 |
\caption{~} |
\caption{~} |
600 |
|
\label{tab:pkg:exf:diagnostics} |
601 |
\end{table} |
\end{table} |
602 |
|
|
603 |
%---------------------------------------------------------------------- |
%---------------------------------------------------------------------- |
604 |
|
|
605 |
\subsubsection{Reference experiments} |
\subsubsection{Experiments and tutorials that use exf} |
606 |
|
\label{sec:pkg:exf:experiments} |
|
global\_with\_exf: |
|
607 |
|
|
608 |
lab\_sea: |
\begin{itemize} |
609 |
|
\item{Global Ocean experiment, in global\_with\_exf verification directory } |
610 |
|
\item{Labrador Sea experiment, in lab\_sea verification directory } |
611 |
|
\end{itemize} |
612 |
|
|
613 |
%---------------------------------------------------------------------- |
%---------------------------------------------------------------------- |
614 |
|
|