Ignore:
Timestamp:
06/23/17 15:01:47 (7 years ago)
Author:
rlacroix
Message:

Update the documentation.

Document the "xios_field_is_active" function and the "check_if_active" field attribute.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • XIOS/trunk/doc/XIOS_reference_guide.lyx

    r1084 r1182  
    34373437 
    34383438\begin_layout Subsection* 
     3439check_if_active:  
     3440\emph on 
     3441bool 
     3442\end_layout 
     3443 
     3444\begin_layout Standard 
     3445Fortran: 
     3446\end_layout 
     3447 
     3448\begin_layout LyX-Code 
     3449LOGICAL :: check_if_active 
     3450\end_layout 
     3451 
     3452\begin_layout Standard 
     3453Define whether XIOS will automatically check if the field is active at current 
     3454 timestep when sending data from the model. 
     3455 Enabling this behavior can sometimes improve the performances by avoiding 
     3456 unneeded data processing. 
     3457 This attribute is optional, the default value is  
     3458\begin_inset Flex Strong 
     3459status collapsed 
     3460 
     3461\begin_layout Plain Layout 
     3462false 
     3463\end_layout 
     3464 
     3465\end_inset 
     3466 
     3467. 
     3468\end_layout 
     3469 
     3470\begin_layout Subsection* 
    34393471field_ref:  
    34403472\emph on 
Note: See TracChangeset for help on using the changeset viewer.