Changeset 10507 for NEMO/branches/2019/dev_r10503_XIOS_RW_doc/doc/latex/NEMO/subfiles/chap_DIA.tex

Timestamp:

2019-01-11T17:48:03+01:00 (5 years ago)

Author:

mathiot

Message:

update XIOS R/W doc using latex short cut + minor changes

File:

• NEMO/branches/2019/dev_r10503_XIOS_RW_doc/doc/latex/NEMO/subfiles/chap_DIA.tex (modified) (2 diffs)

NEMO/branches/2019/dev_r10503_XIOS_RW_doc/doc/latex/NEMO/subfiles/chap_DIA.tex

@@ -119 +119 @@
 
 XIOS may be used to read single file restart produced by NEMO. Currently only the variables written to 
-file \textit{numror} can be handled by XIOS. To activate restart reading using XIOS \textit{ln\_xios\_read} 
-must be set to \textit{.true.}. 
+file \forcode{numror} can be handled by XIOS. To activate restart reading using XIOS, set \np{ln\_xios\_read}\forcode{ = .true. }
 in \textit{namelist\_cfg}. This setting will be ignored when multiple restart files are present, and default NEMO 
 functionality will be used for reading. There is no need to change iodef.xml file to use XIOS to read 
@@ -126 +125 @@
 there may be a need to add the following line in iodef.xml (xios context):
 
-
-\textit{\textless variable id="recv\_field\_timeout"        type="double" \textgreater 1800\textless /variable\textgreater}. \\
+\begin{xmllines}
+<variable id="recv_field_timeout"        type="double">1800</variable>
+\end{xmllines}
+
 This variable sets timeout for reading. 
 
 If XIOS is to be used to read restart from file generated with an earlier NEMO version (3.6 for instance),
-dimension \textit{z} defined in restart file must be renamed to \textit{nav\_lev}.
-
-XIOS can also be used to write NEMO restart. A namelist parameter \textit{nn\_wxios} is used to determine the 
+dimension \forcode{z} defined in restart file must be renamed to \forcode{nav_lev}.\\
+
+XIOS can also be used to write NEMO restart. A namelist parameter \np{nn\_wxios} is used to determine the 
 type of restart NEMO will write. If it is set to 0, default NEMO functionality will be used - each 
 processor writes its own restart file; if it is set to 1 XIOS will write restart into a single file; 
-for \textit{nn\_wxios = 2} the restart will be written by XIOS into multiple files, one for each XIOS server. 
-Note, however, that \textbf{NEMO will not read restart generated by XIOS when \textit{nn\_wxios = 2}}. The restart will 
+for \np{nn\_wxios = 2} the restart will be written by XIOS into multiple files, one for each XIOS server. 
+Note, however, that \textbf{NEMO will not read restart generated by XIOS when \np{nn\_wxios = 2}}. The restart will 
 have to be rebuild before continuing the run. This option aims to reduce number of restart files generated by NEMO only, 
 and may be useful when there is a need to change number of processors used to run simulation. 
 
 If an additional variable must be written to a restart file, the following steps are needed:
-\begin{itemize}
-\item
-add variable name to a list of restart variables (in subroutine \textit{iom\_set\_rst\_vars}, iom.F90) and 
-define correct grid for the variable (grid\_N\_3D - 3D variable, grid\_N - 2D variable, grid\_vector - 
-1D variable, grid\_scalar - scalar),
-\item
-add variable to the list of fields written by restart.  This can be done either in subroutine 
-\textit{iom\_set\_rstw\_core} (iom.F90) or by calling  \textit{iom\_set\_rstw\_active} (iom.F90) with the name of a variable 
+\begin{description}
+   \item[step 1:] add variable name to a list of restart variables (in subroutine \rou{iom\_set\_rst\_vars}, \mdl{iom}) and 
+define correct grid for the variable (\forcode{grid_N_3D} - 3D variable, \forcode{grid_N} - 2D variable, \forcode{grid_vector} - 
+1D variable, \forcode{grid_scalar} - scalar),
+   \item[step 2:] add variable to the list of fields written by restart.  This can be done either in subroutine 
+\rou{iom\_set\_rstw\_core} (\mdl{iom}) or by calling  \rou{iom\_set\_rstw\_active} (\mdl{iom}) with the name of a variable 
 as an argument. This convention follows approach for writing restart using iom, where variables are 
-written either by \textit{rst\_write} or by calling \textit{iom\_rstput} from individual routines.
-\end{itemize}
+written either by \rou{rst\_write} or by calling \rou{iom\_rstput} from individual routines.
+\end{description}