DEADBAND US help
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Continuous_pal / INTEGRAL_m.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <refentry version="5.0-subset Scilab" xml:id="INTEGRAL_m"
25           xmlns="http://docbook.org/ns/docbook"
26           xmlns:xlink="http://www.w3.org/1999/xlink"
27           xmlns:svg="http://www.w3.org/2000/svg"
28           xmlns:ns5="http://www.w3.org/1999/xhtml"
29           xmlns:mml="http://www.w3.org/1998/Math/MathML"
30           xmlns:db="http://docbook.org/ns/docbook">
31   <refnamediv>
32     <refname>INTEGRAL_m</refname>
33
34     <refpurpose>Integration</refpurpose>
35   </refnamediv>
36
37   <refsection>
38     <title>Block Screenshot</title>
39
40     <para><inlinemediaobject>
41         <imageobject>
42           <imagedata align="center"
43                      fileref="../../../../images/palettes/INTEGRAL_m.png"
44                      valign="middle" />
45         </imageobject>
46       </inlinemediaobject></para>
47   </refsection>
48
49   <refsection id="Contents_INTEGRAL_m">
50     <title>Contents</title>
51
52     <itemizedlist>
53       <listitem>
54         <para><link linkend="INTEGRAL_m">Integration</link></para>
55       </listitem>
56
57       <listitem>
58         <itemizedlist>
59           <listitem>
60             <para><xref linkend="Palette_INTEGRAL_m">Palette</xref></para>
61           </listitem>
62
63           <listitem>
64             <para><xref
65             linkend="Description_INTEGRAL_m">Description</xref></para>
66           </listitem>
67
68           <listitem>
69             <para><xref linkend="Dialogbox_INTEGRAL_m">Dialog
70             box</xref></para>
71           </listitem>
72
73           <listitem>
74             <para><xref linkend="Defaultproperties_INTEGRAL_m">Default
75             properties</xref></para>
76           </listitem>
77
78           <listitem>
79             <para><xref linkend="Interfacingfunction_INTEGRAL_m">Interfacing
80             function</xref></para>
81           </listitem>
82
83           <listitem>
84             <para><xref
85             linkend="Computationalfunction_INTEGRAL_m">Computational
86             function</xref></para>
87           </listitem>
88
89           <listitem>
90             <para><xref linkend="Authors_INTEGRAL_m">Authors</xref></para>
91           </listitem>
92         </itemizedlist>
93       </listitem>
94     </itemizedlist>
95   </refsection>
96
97   <refsection id="Palette_INTEGRAL_m">
98     <title>Palette</title>
99
100     <itemizedlist>
101       <listitem>
102         <para><link linkend="Continuous_pal">Continuous time systems
103         palette</link></para>
104       </listitem>
105     </itemizedlist>
106   </refsection>
107
108   <refsection id="Description_INTEGRAL_m">
109      
110
111     <title>Description</title>
112
113      
114
115     <para>This block is an integrator. The output y is the integral of the
116     input u at the current time step t.</para>
117
118      
119
120     <informalequation>
121       <mediaobject>
122         <imageobject>
123           <imagedata align="center" fileref="../../../mml/integral_m.mml" />
124         </imageobject>
125       </mediaobject>
126     </informalequation>
127
128      Where y0 is an initial condition and t0 is its corresponding time. 
129   </refsection>
130
131   <refsection id="Dialogbox_INTEGRAL_m">
132     <title>Dialog box</title>
133
134     <para>The parameter dialog box allows you to define:</para>
135
136     <itemizedlist>
137       <listitem>
138         <para>The initial condition with or without saturation limit.</para>
139       </listitem>
140     </itemizedlist>
141
142     <itemizedlist>
143       <listitem>
144         <para>The upper and lower limits on the integral.</para>
145       </listitem>
146     </itemizedlist>
147
148     <para>It allows you also to add an event port to the block in order to
149     reset its sate to the specified initial condition.</para>
150
151     <para>In this case, the value of the reset signal depends on an external
152     signal.</para>
153
154     <para></para>
155
156     <para><inlinemediaobject>
157         <imageobject>
158           <imagedata align="center"
159                      fileref="../../../../images/gui/INTEGRAL_m_gui.gif"
160                      valign="middle" />
161         </imageobject>
162       </inlinemediaobject></para>
163
164     <para></para>
165
166     <itemizedlist>
167       <listitem>
168         <para>
169           <emphasis role="bold">Initial Condition</emphasis>
170         </para>
171
172         <para>A vector/scalar initial conditions.</para>
173
174         <para>With that parameter, one can define the datatype of the
175         input/output. It can be a real or a complex type.</para>
176
177         <para>Properties : Type 'mat' of size [-1,-1].</para>
178       </listitem>
179
180       <listitem>
181         <para>
182           <emphasis role="bold">With re-initialization</emphasis>
183         </para>
184
185         <para>To reset its state to the specified initial condition based on
186         an external signal select<emphasis role="bold">1</emphasis> .</para>
187
188         <para>Properties : Type 'vec' of size 1.</para>
189       </listitem>
190
191       <listitem>
192         <para>
193           <emphasis role="bold">With saturation</emphasis>
194         </para>
195
196         <para>If selected, limits the states to a value between the Lower
197         saturation limit and Upper saturation limit parameters.</para>
198
199         <para>Properties : Type 'vec' of size 1.</para>
200       </listitem>
201
202       <listitem>
203         <para>
204           <emphasis role="bold">Upper limit</emphasis>
205         </para>
206
207         <para>The upper limit for the integral.</para>
208
209         <para>Properties : Type 'mat' of size [-1,-1].</para>
210       </listitem>
211
212       <listitem>
213         <para>
214           <emphasis role="bold">Lower limit</emphasis>
215         </para>
216
217         <para>The lower limit for the integral.</para>
218
219         <para>Properties : Type 'mat' of size [-1,-1].</para>
220
221         <para />
222       </listitem>
223
224       <para>This sample model demonstrates how to use the integrator's state
225       port.</para>
226
227       <para>
228         <inlinemediaobject>
229           <imageobject>
230             <imagedata align="center"
231                        fileref="../../../examples/INTEGRAL_m.png"
232                        valign="middle" />
233           </imageobject>
234         </inlinemediaobject>
235       </para>
236     </itemizedlist>
237   </refsection>
238
239   <refsection id="Defaultproperties_INTEGRAL_m">
240     <title>Default properties</title>
241
242     <itemizedlist>
243       <listitem>
244         <para><emphasis role="bold">always active:</emphasis> yes</para>
245       </listitem>
246
247       <listitem>
248         <para><emphasis role="bold">direct-feedthrough:</emphasis> no</para>
249       </listitem>
250
251       <listitem>
252         <para><emphasis role="bold">zero-crossing:</emphasis> no</para>
253       </listitem>
254
255       <listitem>
256         <para><emphasis role="bold">mode:</emphasis> no</para>
257       </listitem>
258
259       <listitem>
260         <para><emphasis role="bold">regular inputs:</emphasis></para>
261
262         <para><emphasis role="bold">- port 1 : size [1,1] / type
263         1</emphasis></para>
264       </listitem>
265
266       <listitem>
267         <para><emphasis role="bold">regular outputs:</emphasis></para>
268
269         <para><emphasis role="bold">- port 1 : size [1,1] / type
270         1</emphasis></para>
271       </listitem>
272
273       <listitem>
274         <para><emphasis role="bold">number/sizes of activation
275         inputs:</emphasis> 0</para>
276       </listitem>
277
278       <listitem>
279         <para><emphasis role="bold">number/sizes of activation
280         outputs:</emphasis> 0</para>
281       </listitem>
282
283       <listitem>
284         <para><emphasis role="bold">continuous-time state:</emphasis>
285         yes</para>
286       </listitem>
287
288       <listitem>
289         <para><emphasis role="bold">discrete-time state:</emphasis> no</para>
290       </listitem>
291
292       <listitem>
293         <para><emphasis role="bold">object discrete-time state:</emphasis>
294         no</para>
295       </listitem>
296
297       <listitem>
298         <para><emphasis role="bold">name of computational function:</emphasis>
299         <emphasis role="italic">integral_func</emphasis></para>
300       </listitem>
301     </itemizedlist>
302   </refsection>
303
304   <refsection id="Interfacingfunction_INTEGRAL_m">
305     <title>Interfacing function</title>
306
307     <itemizedlist>
308       <listitem>
309         <para>SCI/modules/scicos_blocks/macros/Linear/INTEGRAL_m.sci</para>
310       </listitem>
311     </itemizedlist>
312   </refsection>
313
314   <refsection id="Computationalfunction_INTEGRAL_m">
315     <title>Computational function</title>
316
317     <itemizedlist>
318       <listitem>
319         <para>SCI/modules/scicos_blocks/src/c/integral_func.c</para>
320       </listitem>
321
322       <listitem>
323         <para>SCI/modules/scicos_blocks/src/c/integralz_func.c</para>
324       </listitem>
325     </itemizedlist>
326   </refsection>
327
328   <refsection id="Authors_INTEGRAL_m">
329     <title>Authors</title>
330
331     <para><emphasis role="bold"></emphasis></para>
332
333     <itemizedlist>
334       <listitem>
335         <para><emphasis role="bold">Fady NASSIF</emphasis> INRIA</para>
336       </listitem>
337
338       <listitem>
339         <para><emphasis role="bold">Alan Layec</emphasis> INRIA</para>
340       </listitem>
341
342       <listitem>
343         <para><emphasis role="bold">Ramine Nikoukhah</emphasis> INRIA</para>
344       </listitem>
345       <listitem>
346         <para><emphasis role="bold">Zhour Madini-Zouine</emphasis> DIGITEO</para>
347       </listitem>
348           
349     </itemizedlist>
350   </refsection>
351 </refentry>