Changeset 9392 for branches/2017/dev_merge_2017/DOC/tex_sub/chap_OBS.tex

Timestamp:

2018-03-09T16:57:00+01:00 (6 years ago)

Author:

nicolasmartin

Message:

Global replacement of patterns \np{id}=value by \forcode{id = value} for integer and booleans

File:

• branches/2017/dev_merge_2017/DOC/tex_sub/chap_OBS.tex (modified) (7 diffs)

branches/2017/dev_merge_2017/DOC/tex_sub/chap_OBS.tex

@@ -24 +24 @@
 The OBS code is called from \mdl{nemogcm} for model initialisation and to calculate the model
 equivalent values for observations on the 0th timestep. The code is then called again after
-each timestep from \mdl{step}. The code is only activated if the namelist logical \np{ln\_diaobs}
+each timestep from \mdl{step}. The code is only activated if the namelist logical \np{ln_diaobs}
 is set to true.
 
@@ -34 +34 @@
 Some profile observation types (e.g. tropical moored buoys) are made available as daily averaged quantities.
 The observation operator code can be set-up to calculate the equivalent daily average model temperature fields
-using the \np{nn\_profdavtypes} namelist array. Some SST observations are equivalent to a night-time
+using the \np{nn_profdavtypes} namelist array. Some SST observations are equivalent to a night-time
 average value and the observation operator code can calculate equivalent night-time average model SST fields by
-setting the namelist value \np{ln\_sstnight} to true. Otherwise the model value from the nearest timestep to the
+setting the namelist value \np{ln_sstnight} to true. Otherwise the model value from the nearest timestep to the
 observation time is used.
 
@@ -88 +88 @@
 
 Options are defined through the  \ngn{namobs} namelist variables.
-The options \np{ln\_t3d} and \np{ln\_s3d} switch on the temperature and salinity
+The options \np{ln_t3d} and \np{ln_s3d} switch on the temperature and salinity
 profile observation operator code. The filename or array of filenames are
-specified using the \np{cn\_profbfiles} variable. The model grid points for a
+specified using the \np{cn_profbfiles} variable. The model grid points for a
 particular  observation latitude and longitude are found using the grid
 searching part of the code. This can be expensive, particularly for large
-numbers of observations, setting \np{ln\_grid\_search\_lookup} allows the use of
+numbers of observations, setting \np{ln_grid_search_lookup} allows the use of
 a lookup table which is saved into an ``xypos`` file (or files). This will need
 to be generated the first time if it does not exist in the run directory.
 However, once produced it will significantly speed up future grid searches.
-Setting \np{ln\_grid\_global} means that the code distributes the observations
+Setting \np{ln_grid_global} means that the code distributes the observations
 evenly between processors. Alternatively each processor will work with
 observations located within the model subdomain (see section~\ref{OBS_parallel}).
@@ -406 +406 @@
 The mean dynamic
 topography (MDT) must be provided in a separate file defined on the model grid
- called {\it slaReferenceLevel.nc}. The MDT is required in
+ called \ifile{slaReferenceLevel}. The MDT is required in
 order to produce the model equivalent sea level anomaly from the model sea
 surface height. Below is an example header for this file (on the ORCA025 grid).
@@ -556 +556 @@
 NEMO therefore has the capability to specify either an interpolation or an averaging (for surface observation types only). 
 
-The main namelist option associated with the interpolation/averaging is \np{nn\_2dint}. This default option can be set to values from 0 to 6. 
+The main namelist option associated with the interpolation/averaging is \np{nn_2dint}. This default option can be set to values from 0 to 6. 
 Values between 0 to 4 are associated with interpolation while values 5 or 6 are associated with averaging.
 \begin{itemize}
-\item \np{nn\_2dint}=0: Distance-weighted interpolation
-\item \np{nn\_2dint}=1: Distance-weighted interpolation (small angle)
-\item \np{nn\_2dint}=2: Bilinear interpolation (geographical grid)
-\item \np{nn\_2dint}=3: Bilinear remapping interpolation (general grid)
-\item \np{nn\_2dint}=4: Polynomial interpolation
-\item \np{nn\_2dint}=5: Radial footprint averaging with diameter specified in the namelist as \np{rn\_???\_avglamscl} in degrees or metres (set using \np{ln\_???\_fp\_indegs})
-\item \np{nn\_2dint}=6: Rectangular footprint averaging with E/W and N/S size specified in the namelist as \np{rn\_???\_avglamscl} and \np{rn\_???\_avgphiscl} in degrees or metres (set using \np{ln\_???\_fp\_indegs})
+\item \forcode{nn_2dint = 0}: Distance-weighted interpolation
+\item \forcode{nn_2dint = 1}: Distance-weighted interpolation (small angle)
+\item \forcode{nn_2dint = 2}: Bilinear interpolation (geographical grid)
+\item \forcode{nn_2dint = 3}: Bilinear remapping interpolation (general grid)
+\item \forcode{nn_2dint = 4}: Polynomial interpolation
+\item \forcode{nn_2dint = 5}: Radial footprint averaging with diameter specified in the namelist as \np{rn\_???\_avglamscl} in degrees or metres (set using \np{ln\_???\_fp\_indegs})
+\item \forcode{nn_2dint = 6}: Rectangular footprint averaging with E/W and N/S size specified in the namelist as \np{rn\_???\_avglamscl} and \np{rn\_???\_avgphiscl} in degrees or metres (set using \np{ln\_???\_fp\_indegs})
 \end{itemize}
 The ??? in the last two options indicate these options should be specified for each observation type for which the averaging is to be performed (see namelist example above).
-The \np{nn\_2dint} default option can be overridden for surface observation types using namelist values \np{nn\_2dint\_???} where ??? is one of sla,sst,sss,sic.
+The \np{nn_2dint} default option can be overridden for surface observation types using namelist values \np{nn\_2dint\_???} where ??? is one of sla,sst,sss,sic.
 
 Below is some more detail on the various options for interpolation and averaging available in NEMO.
@@ -956 +956 @@
 
 The above namelist will result in feedback files whose first 12 hours contain
-the first field of foo.nc and the second 12 hours contain the second field.
+the first field of \ifile{foo} and the second 12 hours contain the second field.
 
 %\begin{framed}
@@ -998 +998 @@
 \noindent
 \linebreak
-\textbf{\$\{prefix\}\_\$\{yyyymmdd\}\_\$\{sys\}\_\$\{cfg\}\_\$\{vn\}\_\$\{kind\}\_\$\{nproc\}.nc}
+\ifile{\textbf{\$\{prefix\}\_\$\{yyyymmdd\}\_\$\{sys\}\_\$\{cfg\}\_\$\{vn\}\_\$\{kind\}\_\$\{nproc\}}}
 
 \noindent