Changeset 9393 for branches/2017/dev_merge_2017/DOC/tex_sub/chap_misc.tex

Timestamp:

2018-03-13T15:00:56+01:00 (6 years ago)

Author:

nicolasmartin

Message:

Cleaning of section headings, reinstating the index by mixing \np and \forcode macros, continued conversion of source code inclusions

File:

• branches/2017/dev_merge_2017/DOC/tex_sub/chap_misc.tex (modified) (11 diffs)

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

@@ -14 +14 @@
 % Representation of Unresolved Straits
 % ================================================================
-\section{Representation of Unresolved Straits}
+\section{Representation of unresolved straits}
 \label{MISC_strait}
 
@@ -89 +89 @@
 % Sub-Domain Functionality 
 % ================================================================
-\section{Sub-Domain Functionality}
+\section{Sub-domain functionality}
 \label{MISC_zoom}
 
-\subsection{Simple subsetting of input files via netCDF attributes}
+\subsection{Simple subsetting of input files via NetCDF attributes}
 
 The extended grids for use with the under-shelf ice cavities will result in redundant rows
@@ -100 +100 @@
 existing 'zoom' options are overly complex for this task and marked for deletion anyway.
 This alternative subsetting operates for the j-direction only and works by optionally
-looking for and using a global file attribute (named: \np{open_ocean_jstart}) to
+looking for and using a global file attribute (named: \np{open\_ocean\_jstart}) to
 determine the starting j-row for input. The use of this option is best explained with an
 example: Consider an ORCA1 configuration using the extended grid bathymetry and coordinate
@@ -109 +109 @@
 \noindent These files define a horizontal domain of 362x332. Assuming the first row with
 open ocean wet points in the non-isf bathymetry for this set is row 42 (Fortran indexing)
-then the formally correct setting for \np{open_ocean_jstart} is 41. Using this value as the
+then the formally correct setting for \np{open\_ocean\_jstart} is 41. Using this value as the
 first row to be read will result in a 362x292 domain which is the same size as the original
 ORCA1 domain. Thus the extended coordinates and bathymetry files can be used with all the
@@ -128 +128 @@
 
 \noindent Note the j-size of the global domain is the (extended j-size minus
-\np{open_ocean_jstart} + 1 ) and this must match the size of all datasets other than
+\np{open\_ocean\_jstart} + 1 ) and this must match the size of all datasets other than
 bathymetry and coordinates currently. However the option can be extended to any global, 2D
 and 3D, netcdf, input field by adding the:
@@ -135 +135 @@
 lrowattr=ln_use_jattr
 \end{forlines}
-optional argument to the appropriate \np{iom_get} call and the \np{open_ocean_jstart} attribute to the corresponding input files. It remains the users responsibility to set \np{jpjdta} and \np{jpjglo} values in the \np{namelist_cfg} file according to their needs.
+optional argument to the appropriate \np{iom\_get} call and the \np{open\_ocean\_jstart} attribute to the corresponding input files. It remains the users responsibility to set \np{jpjdta} and \np{jpjglo} values in the \np{namelist\_cfg} file according to their needs.
 
 %>>>>>>>>>>>>>>>>>>>>>>>>>>>>
@@ -149 +149 @@
 % Accuracy and Reproducibility
 % ================================================================
-\section{Accuracy and Reproducibility (\protect\mdl{lib\_fortran})}
+\section{Accuracy and reproducibility (\protect\mdl{lib\_fortran})}
 \label{MISC_fortran}
 
@@ -223 +223 @@
 required by each individual for the fold operation. This alternative method should give identical
 results to the default \textsc{ALLGATHER} method and is recommended for large values of \np{jpni}.
-The new method is activated by setting \np{ln_nnogather} to be true ({\bf nammpp}). The
+The new method is activated by setting \np{ln\_nnogather} to be true ({\bf nammpp}). The
 reproducibility of results using the two methods should be confirmed for each new, non-reference
 configuration.
@@ -230 +230 @@
 % Model optimisation, Control Print and Benchmark
 % ================================================================
-\section{Model Optimisation, Control Print and Benchmark}
+\section{Model optimisation, control print and benchmark}
 \label{MISC_opt}
 %--------------------------------------------namctl-------------------------------------------------------
@@ -251 +251 @@
 $\bullet$ Control print %: describe here 4 things:
 
-1- \np{ln_ctl} : compute and print the trends averaged over the interior domain 
+1- \np{ln\_ctl} : compute and print the trends averaged over the interior domain 
 in all TRA, DYN, LDF and ZDF modules. This option is very helpful when 
 diagnosing the origin of an undesired change in model results. 
 
-2- also \np{ln_ctl} but using the nictl and njctl namelist parameters to check 
+2- also \np{ln\_ctl} but using the nictl and njctl namelist parameters to check 
 the source of differences between mono and multi processor runs.
 
 %%gm   to be removed both here and in the code
-3- last digit comparison (\np{nn_bit_cmp}). In an MPP simulation, the computation of 
+3- last digit comparison (\np{nn\_bit\_cmp}). In an MPP simulation, the computation of 
 a sum over the whole domain is performed as the summation over all processors of 
 each of their sums over their interior domains. This double sum never gives exactly 
@@ -269 +269 @@
 %%gm end
 
-$\bullet$  Benchmark (\np{nn_bench}). This option defines a benchmark run based on 
+$\bullet$  Benchmark (\np{nn\_bench}). This option defines a benchmark run based on 
 a GYRE configuration (see \S\ref{CFG_gyre}) in which the resolution remains the same 
 whatever the domain size. This allows a very large model domain to be used, just by