Changeset 10507


Ignore:
Timestamp:
2019-01-11T17:48:03+01:00 (15 months ago)
Author:
mathiot
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/branches/2019/dev_r10503_XIOS_RW_doc/doc/latex/NEMO/subfiles/chap_DIA.tex

    r10506 r10507  
    119119 
    120120XIOS may be used to read single file restart produced by NEMO. Currently only the variables written to  
    121 file \textit{numror} can be handled by XIOS. To activate restart reading using XIOS \textit{ln\_xios\_read}  
    122 must be set to \textit{.true.}.  
     121file \forcode{numror} can be handled by XIOS. To activate restart reading using XIOS, set \np{ln\_xios\_read}\forcode{ = .true. } 
    123122in \textit{namelist\_cfg}. This setting will be ignored when multiple restart files are present, and default NEMO  
    124123functionality will be used for reading. There is no need to change iodef.xml file to use XIOS to read  
     
    126125there may be a need to add the following line in iodef.xml (xios context): 
    127126 
    128  
    129 \textit{\textless variable id="recv\_field\_timeout"        type="double" \textgreater 1800\textless /variable\textgreater}. \\ 
     127\begin{xmllines} 
     128<variable id="recv_field_timeout"        type="double">1800</variable> 
     129\end{xmllines} 
     130 
    130131This variable sets timeout for reading.  
    131132 
    132133If XIOS is to be used to read restart from file generated with an earlier NEMO version (3.6 for instance), 
    133 dimension \textit{z} defined in restart file must be renamed to \textit{nav\_lev}. 
    134  
    135 XIOS can also be used to write NEMO restart. A namelist parameter \textit{nn\_wxios} is used to determine the  
     134dimension \forcode{z} defined in restart file must be renamed to \forcode{nav_lev}.\\ 
     135 
     136XIOS can also be used to write NEMO restart. A namelist parameter \np{nn\_wxios} is used to determine the  
    136137type of restart NEMO will write. If it is set to 0, default NEMO functionality will be used - each  
    137138processor writes its own restart file; if it is set to 1 XIOS will write restart into a single file;  
    138 for \textit{nn\_wxios = 2} the restart will be written by XIOS into multiple files, one for each XIOS server.  
    139 Note, however, that \textbf{NEMO will not read restart generated by XIOS when \textit{nn\_wxios = 2}}. The restart will  
     139for \np{nn\_wxios = 2} the restart will be written by XIOS into multiple files, one for each XIOS server.  
     140Note, however, that \textbf{NEMO will not read restart generated by XIOS when \np{nn\_wxios = 2}}. The restart will  
    140141have to be rebuild before continuing the run. This option aims to reduce number of restart files generated by NEMO only,  
    141142and may be useful when there is a need to change number of processors used to run simulation.  
    142143 
    143144If an additional variable must be written to a restart file, the following steps are needed: 
    144 \begin{itemize} 
    145 \item 
    146 add variable name to a list of restart variables (in subroutine \textit{iom\_set\_rst\_vars}, iom.F90) and  
    147 define correct grid for the variable (grid\_N\_3D - 3D variable, grid\_N - 2D variable, grid\_vector -  
    148 1D variable, grid\_scalar - scalar), 
    149 \item 
    150 add variable to the list of fields written by restart.  This can be done either in subroutine  
    151 \textit{iom\_set\_rstw\_core} (iom.F90) or by calling  \textit{iom\_set\_rstw\_active} (iom.F90) with the name of a variable  
     145\begin{description} 
     146   \item[step 1:] add variable name to a list of restart variables (in subroutine \rou{iom\_set\_rst\_vars}, \mdl{iom}) and  
     147define correct grid for the variable (\forcode{grid_N_3D} - 3D variable, \forcode{grid_N} - 2D variable, \forcode{grid_vector} -  
     1481D variable, \forcode{grid_scalar} - scalar), 
     149   \item[step 2:] add variable to the list of fields written by restart.  This can be done either in subroutine  
     150\rou{iom\_set\_rstw\_core} (\mdl{iom}) or by calling  \rou{iom\_set\_rstw\_active} (\mdl{iom}) with the name of a variable  
    152151as an argument. This convention follows approach for writing restart using iom, where variables are  
    153 written either by \textit{rst\_write} or by calling \textit{iom\_rstput} from individual routines. 
    154 \end{itemize} 
     152written either by \rou{rst\_write} or by calling \rou{iom\_rstput} from individual routines. 
     153\end{description} 
    155154 
    156155 
Note: See TracChangeset for help on using the changeset viewer.