Changeset 916


Ignore:
Timestamp:
08/04/16 14:09:24 (4 years ago)
Author:
rlacroix
Message:

User guide: Document the buffer size related options.

Location:
XIOS/trunk/doc
Files:
2 edited

Legend:

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

    r684 r916  
    47994799\end_layout 
    48004800 
     4801\begin_layout Chapter 
     4802XIOS options 
     4803\end_layout 
     4804 
     4805\begin_layout Standard 
     4806Some of XIOS behaviors can be configured using options. 
     4807 Those options must be expressed as variables in a specific context whose 
     4808  
     4809\series bold 
     4810id 
     4811\series default 
     4812 must be  
     4813\series bold 
     4814\emph on 
     4815 
     4816\begin_inset Quotes eld 
     4817\end_inset 
     4818 
     4819xios 
     4820\begin_inset Quotes erd 
     4821\end_inset 
     4822 
     4823 
     4824\series default 
     4825\emph default 
     4826 as shown below. 
     4827\end_layout 
     4828 
     4829\begin_layout Standard 
     4830\begin_inset listings 
     4831lstparams "breaklines=true,frame=tb,language=XML,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}},tabsize=2" 
     4832inline false 
     4833status open 
     4834 
     4835\begin_layout Plain Layout 
     4836 
     4837<?xml version="1.0"?> 
     4838\end_layout 
     4839 
     4840\begin_layout Plain Layout 
     4841 
     4842<simulation> 
     4843\end_layout 
     4844 
     4845\begin_layout Plain Layout 
     4846 
     4847        <!-- Actual context(s) used by the simulation ommited --> 
     4848\end_layout 
     4849 
     4850\begin_layout Plain Layout 
     4851 
     4852\end_layout 
     4853 
     4854\begin_layout Plain Layout 
     4855 
     4856        <context id="xios"> 
     4857\end_layout 
     4858 
     4859\begin_layout Plain Layout 
     4860 
     4861                <variable_definition> 
     4862\end_layout 
     4863 
     4864\begin_layout Plain Layout 
     4865 
     4866                        <variable id="option_name" type="option_type">option_value</variable> 
     4867\end_layout 
     4868 
     4869\begin_layout Plain Layout 
     4870 
     4871                </variable_definition> 
     4872\end_layout 
     4873 
     4874\begin_layout Plain Layout 
     4875 
     4876        </context> 
     4877\end_layout 
     4878 
     4879\begin_layout Plain Layout 
     4880 
     4881</simulation> 
     4882\end_layout 
     4883 
     4884\end_inset 
     4885 
     4886 
     4887\end_layout 
     4888 
     4889\begin_layout Section 
     4890Buffer related options 
     4891\end_layout 
     4892 
     4893\begin_layout Standard 
     4894By default, XIOS tries to guess the required buffers sizes to ensure efficient 
     4895 client-server communications. 
     4896 However it might sometimes be useful to tweak the buffers sizes so XIOS 
     4897 provides the following options: 
     4898\end_layout 
     4899 
     4900\begin_layout Itemize 
     4901 
     4902\series bold 
     4903optimal_buffer_size 
     4904\series default 
     4905 (type:  
     4906\series bold 
     4907string 
     4908\series default 
     4909) can be either  
     4910\series bold 
     4911\emph on 
     4912 
     4913\begin_inset Quotes eld 
     4914\end_inset 
     4915 
     4916memory 
     4917\begin_inset Quotes erd 
     4918\end_inset 
     4919 
     4920 
     4921\series default 
     4922\emph default 
     4923 or  
     4924\series bold 
     4925\emph on 
     4926 
     4927\begin_inset Quotes erd 
     4928\end_inset 
     4929 
     4930performance 
     4931\begin_inset Quotes erd 
     4932\end_inset 
     4933 
     4934 
     4935\series default 
     4936\emph default 
     4937. 
     4938 When using the  
     4939\series bold 
     4940\emph on 
     4941 
     4942\begin_inset Quotes eld 
     4943\end_inset 
     4944 
     4945memory 
     4946\begin_inset Quotes erd 
     4947\end_inset 
     4948 
     4949 
     4950\series default 
     4951\emph default 
     4952 mode, XIOS will try to use buffers as small as possible while still ensuring 
     4953 that the bigger message will fit. 
     4954 When using the  
     4955\series bold 
     4956\emph on 
     4957 
     4958\begin_inset Quotes erd 
     4959\end_inset 
     4960 
     4961performance 
     4962\begin_inset Quotes erd 
     4963\end_inset 
     4964 
     4965 
     4966\series default 
     4967\emph default 
     4968 mode, XIOS will ensure that all active fields can be buffered without having 
     4969 to flush the buffers. 
     4970 This mode is used by default since it allows more asynchronism and thus 
     4971 better performance at the cost of being quite memory hungry. 
     4972\end_layout 
     4973 
     4974\begin_layout Itemize 
     4975 
     4976\series bold 
     4977minimum_buffer_size 
     4978\series default 
     4979 (type:  
     4980\series bold 
     4981int 
     4982\series default 
     4983) defines the mimimum buffer size in bytes (8192 by default). 
     4984 This value will be used by XIOS only for buffers whose detected size is 
     4985 smaller than the user defined mimimum size. 
     4986\end_layout 
     4987 
     4988\begin_layout Itemize 
     4989 
     4990\series bold 
     4991buffer_size_factor  
     4992\series default 
     4993(type:  
     4994\series bold 
     4995int 
     4996\series default 
     4997) allows to modify the buffers sizes by multiplying the detected sizes by 
     4998 an user defined factor ( 
     4999\begin_inset Formula $1.0$ 
     5000\end_inset 
     5001 
     5002 by default). 
     5003 For each allocated buffers, the used size is defined as  
     5004\begin_inset Formula  
     5005\[ 
     5006{\scriptstyle used\_size\;=\;\min\left(minimum\_buffer\_size,\; detected\_size\;\times\; buffer\_size\_factor\right)} 
     5007\] 
     5008 
     5009\end_inset 
     5010 
     5011 
     5012\end_layout 
     5013 
    48015014\end_body 
    48025015\end_document 
Note: See TracChangeset for help on using the changeset viewer.