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

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

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

revision 1.10 by heimbach, Tue Jan 15 21:37:14 2008 UTC revision 1.14 by dimitri, Tue Jun 21 19:07:20 2011 UTC
# Line 22  forcing fields an arbitrary grid onto th Line 22  forcing fields an arbitrary grid onto th
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    
# Line 55  EXF requires the calendar package \textt Line 55  EXF requires the calendar package \textt
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
# Line 63  via CPP preprocessor flags. These option Line 63  via CPP preprocessor flags. These option
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
# Line 99  Table \ref{tab:pkg:exf:cpp} summarizes t Line 98  Table \ref{tab:pkg:exf:cpp} summarizes t
98      \end{tabular}      \end{tabular}
99    }    }
100    \caption{~}    \caption{~}
101      \label{tab:pkg:exf:cpp}
102  \end{table}  \end{table}
103    
104    
# Line 119  Run-time parameters may be broken into 3 Line 119  Run-time parameters may be broken into 3
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
# Line 224  For EXF this flag is omitted, i.e. EXF i Line 222  For EXF this flag is omitted, i.e. EXF i
222      \end{tabular}      \end{tabular}
223    }    }
224    \caption{~}    \caption{~}
225      \label{tab:pkg:exf:runtime_flags}
226  \end{table}  \end{table}
227    
228    
# Line 246  prepend the field name to the listed att Line 245  prepend the field name to the listed att
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
# Line 274  prepend the field name to the listed att Line 272  prepend the field name to the listed att
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 \\
# Line 289  prepend the field name to the listed att Line 287  prepend the field name to the listed att
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} ~ \\
# Line 314  It defines attributes for the heat flux Line 313  It defines attributes for the heat flux
313  \end{verbatim}  \end{verbatim}
314    
315  EXF will read a file of name 'ncep\_qnet.bin'.  EXF will read a file of name 'ncep\_qnet.bin'.
316  Its first record represents January 1st, 1991 at 00:00 UTC.  Its first record represents January 1st, 1992 at 00:00 UTC.
317  Next record is 2592000 seconds (or 30 days) later.  Next record is 2592000 seconds (or 30 days) later.
318    Note that the first record read and used by the EXF package corresponds to the
319    value 'startDate1' set in data.cal.  Therefore if you want to start the EXF
320    forcing from later in the 'ncep_qnet.bin' file, it suffices to specify
321    startDate1 in data.cal as a date later than 19920101 (for example, startDate1
322    = 19940101, for starting January 1st, 1994).  For this to work,
323    'ncep_qnet.bin' must have at least 2 years of data because in this
324    configuration EXF will read 2 years into the file to find the 1994 starting
325    value.
326  Interpolation on-the-fly is used (in the present case trivially  Interpolation on-the-fly is used (in the present case trivially
327  on the same grid, but included nevertheless for illustration),  on the same grid, but included nevertheless for illustration),
328  and input field grid starting coordinates and increments are  and input field grid starting coordinates and increments are
# Line 569  Diagnostics output is available via the Line 576  Diagnostics output is available via the
576  Available output fields are summarized in  Available output fields are summarized in
577  Table \ref{tab:pkg:exf:diagnostics}.  Table \ref{tab:pkg:exf:diagnostics}.
578    
579  \begin{table}[h!]  \begin{table}[!ht]
580  \centering  \centering
 \label{tab:pkg:exf:diagnostics}  
581  {\footnotesize  {\footnotesize
582  \begin{verbatim}  \begin{verbatim}
583  ------------------------------------------------------  ---------+----+----+----------------+-----------------
584   <-Name->|Levs|grid|<--  Units   -->|<- Tile (max=80c)   <-Name->|Levs|grid|<--  Units   -->|<- Tile (max=80c)
585  ------------------------------------------------------  ---------+----+----+----------------+-----------------
586   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
587   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
588   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
# Line 599  Table \ref{tab:pkg:exf:diagnostics}. Line 605  Table \ref{tab:pkg:exf:diagnostics}.
605  \end{verbatim}  \end{verbatim}
606  }  }
607  \caption{~}  \caption{~}
608    \label{tab:pkg:exf:diagnostics}
609  \end{table}  \end{table}
610    
611  %----------------------------------------------------------------------  %----------------------------------------------------------------------
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.14
  ViewVC Help
Powered by ViewVC 1.1.22