s_examples/held_suarez_cs/inp_data.shap.templ


%\subsubsection{File {\it input/data.pkg}}
%\label{www:tutorials}

This file, reproduced completely below, specifies the parameters
that the model uses for the Shapiro filter package (\cite{Shapiro_70},
section \ref{sect:shapiro-filter}).
The parameters that are significant for this configuration are:

\begin{itemize}

\item Line PUT_LINE_NB:Shap_funct=,
\begin{verbatim} 
 Shap_funct=2,
\end{verbatim} 
This line selects the shapiro filter function
to use, here S2 in this experiment
(see section \ref{sect:shapiro-filter}).

\item Lines PUT_LINE_NB:nShapT= and PUT_LINE_NB:nShapUV=,
\begin{verbatim}
 nShapT=4,
 nShapUV=4,
\end{verbatim}
Those lines select the order of the shapiro filter
for active tracer ($\theta$ and $q$) and momentum respectively. 
This sets the integer parameter $n$ to 4, in the equations of 
section \ref{sect:shapiro-filter}, which implies a 8th order
filter.

\item Lines PUT_LINE_NB:nShapTrPhys= and PUT_LINE_NB:nShapUVPhys=,
\begin{verbatim}
 nShapTrPhys=0,
 nShapUVPhys=0,
\end{verbatim}
Those lines select the order of the physical space filter 
(filter function S2g, in section \ref{sect:shapiro-filter})
that applies to for $\theta$ and $q$ and for $u$ and $v$ respectively.
The difference $ nShapT - nShapTrPhys $ and $ nShapUV - nShapUVPhys $
correspond to the order of the computational filter
(filter function S2c, in section \ref{sect:shapiro-filter}).

\item Lines PUT_LINE_NB:Shap_Trtau= and PUT_LINE_NB:Shap_uvtau=,
\begin{verbatim}
 Shap_Trtau=5400.,
 Shap_uvtau=1800.,
\end{verbatim}
Thoses lines set the time scale of the filter (in seconds), 
for $\theta$ and $q$ and for $u$ and $v$ respectively,
to 5400 s (90 min) and 1800 s (30 min) respectively.
Note that a shorter time scale means a stronger filter, and
that the time scale cannot be smaller than the time-step $\Delta t$
of the model.

\end{itemize}

The entire file {\it input/data.shap} is reproduced here below:
1
2	%\subsubsection{File {\it input/data.pkg}}
3	%\label{www:tutorials}
4
5	This file, reproduced completely below, specifies the parameters
6	that the model uses for the Shapiro filter package (\cite{Shapiro_70},
7	section \ref{sect:shapiro-filter}).
8	The parameters that are significant for this configuration are:
9
10	\begin{itemize}
11
12	\item Line PUT_LINE_NB:Shap_funct=,
13	\begin{verbatim}
14	Shap_funct=2,
15	\end{verbatim}
16	This line selects the shapiro filter function
17	to use, here S2 in this experiment
18	(see section \ref{sect:shapiro-filter}).
19
20	\item Lines PUT_LINE_NB:nShapT= and PUT_LINE_NB:nShapUV=,
21	\begin{verbatim}
22	nShapT=4,
23	nShapUV=4,
24	\end{verbatim}
25	Those lines select the order of the shapiro filter
26	for active tracer ($\theta$ and $q$) and momentum respectively.
27	This sets the integer parameter $n$ to 4, in the equations of
28	section \ref{sect:shapiro-filter}, which implies a 8th order
29	filter.
30
31	\item Lines PUT_LINE_NB:nShapTrPhys= and PUT_LINE_NB:nShapUVPhys=,
32	\begin{verbatim}
33	nShapTrPhys=0,
34	nShapUVPhys=0,
35	\end{verbatim}
36	Those lines select the order of the physical space filter
37	(filter function S2g, in section \ref{sect:shapiro-filter})
38	that applies to for $\theta$ and $q$ and for $u$ and $v$ respectively.
39	The difference $ nShapT - nShapTrPhys $ and $ nShapUV - nShapUVPhys $
40	correspond to the order of the computational filter
41	(filter function S2c, in section \ref{sect:shapiro-filter}).
42
43	\item Lines PUT_LINE_NB:Shap_Trtau= and PUT_LINE_NB:Shap_uvtau=,
44	\begin{verbatim}
45	Shap_Trtau=5400.,
46	Shap_uvtau=1800.,
47	\end{verbatim}
48	Thoses lines set the time scale of the filter (in seconds),
49	for $\theta$ and $q$ and for $u$ and $v$ respectively,
50	to 5400 s (90 min) and 1800 s (30 min) respectively.
51	Note that a shorter time scale means a stronger filter, and
52	that the time scale cannot be smaller than the time-step $\Delta t$
53	of the model.
54
55	\end{itemize}
56
57	The entire file {\it input/data.shap} is reproduced here below: