Changeset 1911


Ignore:
Timestamp:
06/25/20 19:02:03 (6 weeks ago)
Author:
ymipsl
Message:

Update of the reference guide.

YM

Location:
XIOS/trunk/doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • XIOS/trunk/doc/XIOS_reference_guide.lyx

    r1740 r1911  
    1 #LyX 2.2 created this file. For more info see http://www.lyx.org/ 
    2 \lyxformat 508 
     1#LyX 2.3 created this file. For more info see http://www.lyx.org/ 
     2\lyxformat 544 
    33\begin_document 
    44\begin_header 
     
    2525\font_sf_scale 100 100 
    2626\font_tt_scale 100 100 
     27\use_microtype false 
     28\use_dash_ligatures false 
    2729\graphics default 
    2830\default_output_format default 
     
    5456\justification true 
    5557\use_refstyle 0 
     58\use_minted 0 
    5659\index Index 
    5760\shortcut idx 
     
    6265\paragraph_separation indent 
    6366\paragraph_indentation default 
    64 \quotes_language english 
     67\is_math_indent 0 
     68\math_numbering_side default 
     69\quotes_style english 
     70\dynamic_quotes 0 
    6571\papercolumns 1 
    6672\papersides 1 
     
    77217727 
    77227728\begin_layout Subsection* 
    7723 file (optional):  
    7724 \emph on 
    7725 string 
    7726 \end_layout 
    7727  
    7728 \begin_layout Standard 
    7729 Fortran: 
    7730 \end_layout 
    7731  
    7732 \begin_layout LyX-Code 
    7733 CHARACTER(LEN=*) :: type 
    7734 \end_layout 
    7735  
    7736 \begin_layout Standard 
    7737 Define a file which contains the weight values for interpolation from domain 
    7738  source to domain destination. 
    7739  If not specified, the internal interpolation module will be used to compte 
    7740  the weights. 
    7741 \end_layout 
    7742  
    7743 \begin_layout Subsection* 
    77447729order (optional):  
    77457730\emph on 
     
    77607745 Currently, only first order and second order are available for conservative 
    77617746 interpolations. 
    7762  The default value is 2. 
     7747 The default value is  
     7748\begin_inset Flex Code 
     7749status open 
     7750 
     7751\begin_layout Plain Layout 
     77522 
     7753\end_layout 
     7754 
     7755\end_inset 
     7756 
     7757. 
     7758\end_layout 
     7759 
     7760\begin_layout Subsection* 
     7761renormalize (optional):  
     7762\emph on 
     7763bool 
     7764\end_layout 
     7765 
     7766\begin_layout Standard 
     7767Fortran:  
     7768\end_layout 
     7769 
     7770\begin_layout LyX-Code 
     7771LOGICAL :: renormalize 
     7772\end_layout 
     7773 
     7774\begin_layout Standard 
     7775This flag is usefull only when targeted cells intersect masked source cells. 
     7776 In case a field corresponding to a flux value, the result of the interpolation 
     7777 remain correct. 
     7778 Otherwise for intensive field, the computed value need to be renormalize 
     7779 prorate of the non masked intersected area to remain correct. 
     7780 This flag activate these functionnality. 
     7781 Default value is  
     7782\begin_inset Flex Code 
     7783status open 
     7784 
     7785\begin_layout Plain Layout 
     7786false 
     7787\end_layout 
     7788 
     7789\end_inset 
     7790 
     7791. 
     7792\end_layout 
     7793 
     7794\begin_layout Subsection* 
     7795quantitity (optional):  
     7796\emph on 
     7797bool 
     7798\end_layout 
     7799 
     7800\begin_layout Standard 
     7801Fortran:  
     7802\end_layout 
     7803 
     7804\begin_layout LyX-Code 
     7805LOGICAL :: quantity 
     7806\end_layout 
     7807 
     7808\begin_layout Standard 
     7809If this flag is set, the interpolation will preserve extensive property 
     7810 of the field. 
     7811 Default value is  
     7812\begin_inset Flex Code 
     7813status open 
     7814 
     7815\begin_layout Plain Layout 
     7816false 
     7817\end_layout 
     7818 
     7819\end_inset 
     7820 
     7821. 
     7822\end_layout 
     7823 
     7824\begin_layout Subsection* 
     7825use_area (optional):  
     7826\emph on 
     7827bool 
     7828\end_layout 
     7829 
     7830\begin_layout Standard 
     7831Fortran:  
     7832\end_layout 
     7833 
     7834\begin_layout LyX-Code 
     7835LOGICAL :: use_area 
     7836\end_layout 
     7837 
     7838\begin_layout Standard 
     7839If this flag is set, given area for source and target domain (if any) will 
     7840 be used to renormalize compute weight by the ratio given area / computed 
     7841 area. 
     7842 Default value is  
     7843\begin_inset Flex Code 
     7844status open 
     7845 
     7846\begin_layout Plain Layout 
     7847false 
     7848\end_layout 
     7849 
     7850\end_inset 
     7851 
     7852. 
     7853\end_layout 
     7854 
     7855\begin_layout Subsection* 
     7856detect_missing_value (optional):  
     7857\emph on 
     7858bool 
     7859\end_layout 
     7860 
     7861\begin_layout Standard 
     7862Fortran:  
     7863\end_layout 
     7864 
     7865\begin_layout LyX-Code 
     7866LOGICAL :: detect_missing_value 
     7867\end_layout 
     7868 
     7869\begin_layout Standard 
     7870If flag is set to true, input data of the field to be interpolated are analyzed 
     7871 to detect missing values. 
     7872 Detected cells are considered as masked and will be taking into account 
     7873 for interpolation in a similar way than the domain mask. 
     7874 Default value is  
     7875\begin_inset Flex Code 
     7876status open 
     7877 
     7878\begin_layout Plain Layout 
     7879false 
     7880\end_layout 
     7881 
     7882\end_inset 
     7883 
     7884. 
     7885\end_layout 
     7886 
     7887\begin_layout Subsection* 
     7888mode (optionnal):  
     7889\emph on 
     7890enumeration {compute, read, read_or_compute} 
     7891\end_layout 
     7892 
     7893\begin_layout Standard 
     7894Fortran: 
     7895\end_layout 
     7896 
     7897\begin_layout LyX-Code 
     7898CHARACTER(LEN=*) :: mode 
     7899\end_layout 
     7900 
     7901\begin_layout Standard 
     7902Define if interpolation must be computed (compute), read from file (read), 
     7903 or if find file weight, read otherwise compute (read_or_compute). 
     7904 Default value is  
     7905\begin_inset Flex Code 
     7906status open 
     7907 
     7908\begin_layout Plain Layout 
     7909compute 
     7910\end_layout 
     7911 
     7912\end_inset 
     7913 
     7914. 
     7915\end_layout 
     7916 
     7917\begin_layout Subsection* 
     7918write_weight (optional):  
     7919\emph on 
     7920bool 
     7921\end_layout 
     7922 
     7923\begin_layout Standard 
     7924Fortran:  
     7925\end_layout 
     7926 
     7927\begin_layout LyX-Code 
     7928LOGICAL :: write_weight 
     7929\end_layout 
     7930 
     7931\begin_layout Standard 
     7932If this flag is set, the computed weights will be written in file. 
     7933 If weights are already read from a file, nothing will happen. 
     7934 Default value is  
     7935\begin_inset Flex Code 
     7936status open 
     7937 
     7938\begin_layout Plain Layout 
     7939false 
     7940\end_layout 
     7941 
     7942\end_inset 
     7943 
     7944. 
     7945\end_layout 
     7946 
     7947\begin_layout Subsection* 
     7948weight_filename (optional):  
     7949\emph on 
     7950string 
     7951\end_layout 
     7952 
     7953\begin_layout Standard 
     7954Fortran: 
     7955\end_layout 
     7956 
     7957\begin_layout LyX-Code 
     7958CHARACTER(LEN=*) :: weight_filename 
     7959\end_layout 
     7960 
     7961\begin_layout Standard 
     7962Define the file name where the weights will be written or read. 
     7963 If not specified when trying to read or write, a name will be automatically 
     7964 generated. 
     7965  
     7966\end_layout 
     7967 
     7968\begin_layout Subsection* 
     7969read_write_convention (optionnal):  
     7970\emph on 
     7971enumeration {c, fortran} 
     7972\end_layout 
     7973 
     7974\begin_layout Standard 
     7975Fortran: 
     7976\end_layout 
     7977 
     7978\begin_layout LyX-Code 
     7979CHARACTER(LEN=*) :: read_write_convention 
     7980\end_layout 
     7981 
     7982\begin_layout Standard 
     7983Define the convention for pair of global index source and destination for 
     7984 wich a weight is defined. 
     7985 For C convention, index will begin to 0, for fortran, index will begin 
     7986 to 1. 
     7987 Usefull only for read ar write weights from/to a file. 
     7988 Default value is corresponding to C convention. 
    77637989\end_layout 
    77647990 
Note: See TracChangeset for help on using the changeset viewer.