Xcos help: simplify the HTML characters
[scilab.git] / scilab / modules / xcos / help / en_US / batch_functions / steadycos.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * See the file ./license.txt
23  -->
24 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="steadycos">
25     <refnamediv>
26         <refname>steadycos</refname>
27         <refpurpose>Finds an equilibrium state of a general dynamical system described by a xcos diagram</refpurpose>
28     </refnamediv>
29     <refsynopsisdiv>
30         <title>Calling Sequence</title>
31         <synopsis>[X,U,Y,XP]=steadycos(scs_m,X,U,Y,Indx,Indu,Indy [,Indxp [,param ] ])</synopsis>
32     </refsynopsisdiv>
33     <refsection id="Module_steadycos">
34         <title>Module</title>
35         <itemizedlist>
36             <listitem>
37                 <para>
38                     <link linkend="xcos">xcos</link>
39                 </para>
40             </listitem>
41         </itemizedlist>
42     </refsection>
43     <refsection id="Description_steadycos">
44         <title>Description</title>
45         <para>
46             This function finds the steady state for a given system described by a xcos diagram or <link linkend="SUPER_f">sub-diagram</link>. The diagram should have <link linkend="IN_f">inputs</link> and <link linkend="OUT_f">outputs</link>.The steady state concern only the continuous-time dynamics.
47         </para>
48     </refsection>
49     <refsection>
50         <title>Examples</title>
51         <programlisting role="example"><![CDATA[
52 // loading data
53 exec("SCI/modules/xcos/tests/unit_tests/PENDULUM_ANIM.sci");
54 exec("SCI/modules/xcos/tests/unit_tests/anim_pen.sci");
55 importXcosDiagram("SCI/modules/xcos/tests/unit_tests/pendulum_anim45.zcos");
56
57 // configure the context
58 M  = 10;
59 m  = 3;
60 l  = 3;
61 ph = 0.1;
62 z0 = -4;
63 th0 = .02;
64
65 // look for the specific sub-diagram to work on
66 for i=1:length(scs_m.objs)
67     if typeof(scs_m.objs(i))=="Block" & scs_m.objs(i).gui=="SUPER_f" then
68         scs_m = scs_m.objs(i).model.rpar;
69         break;
70     end
71 end
72
73 [X,U,Y,XP] = steadycos(scs_m,[],[],[],[],1,1:$);
74  ]]></programlisting>
75     </refsection>
76     <refsection id="Parameters_steadycos">
77         <title>Arguments</title>
78         <itemizedlist>
79             <listitem>
80                 <para>
81                     <emphasis role="bold">scs_m :</emphasis> a xcos data structure
82                 </para>
83             </listitem>
84             <listitem>
85                 <para>
86                     <emphasis role="bold">X:</emphasis> column vector. Continuous state. Can be set to [] if zero.
87                 </para>
88             </listitem>
89             <listitem>
90                 <para>
91                     <emphasis role="bold">U:</emphasis> column vector. Input. Can be set to [] if zero.
92                 </para>
93             </listitem>
94             <listitem>
95                 <para>
96                     <emphasis role="bold">Y:</emphasis> column vector. Output. Can be set to [] if zero.
97                 </para>
98             </listitem>
99             <listitem>
100                 <para>
101                     <emphasis role="bold">Indx :</emphasis> index of entries of X that are not fixed. If all can vary, set to 1:$
102                 </para>
103             </listitem>
104             <listitem>
105                 <para>
106                     <emphasis role="bold">Indu :</emphasis> index of entries of U that are not fixed. If all can vary, set to 1:$
107                 </para>
108             </listitem>
109             <listitem>
110                 <para>
111                     <emphasis role="bold">Indy :</emphasis> index of entries of Y that are not fixed. If all can vary, set to 1:$
112                 </para>
113             </listitem>
114             <listitem>
115                 <para>
116                     <emphasis role="bold">Indxp :</emphasis> index of entries of XP (derivative of x) that need not be zero. If all can vary, set to 1:$. Default [].
117                 </para>
118             </listitem>
119             <listitem>
120                 <para>
121                     <emphasis role="bold">param :</emphasis> list with two elements (default list(1.d-6,0)). param(1): scalar. Perturbation level for linearization; the following variation is used del([x;u])_i = param(1)+param(1)*1d-4*abs([x;u])_i. param(2): scalar. Time t.
122                 </para>
123             </listitem>
124             <listitem>
125                 <para>
126                     <emphasis role="bold">X:</emphasis> steady state X
127                 </para>
128             </listitem>
129             <listitem>
130                 <para>
131                     <emphasis role="bold">U:</emphasis> stationary input U
132                 </para>
133             </listitem>
134             <listitem>
135                 <para>
136                     <emphasis role="bold">Y:</emphasis> output corresponding to steady state found
137                 </para>
138             </listitem>
139             <listitem>
140                 <para>
141                     <emphasis role="bold">XP :</emphasis> derivative of the state corresponding to steady state found
142                 </para>
143             </listitem>
144         </itemizedlist>
145     </refsection>
146     <refsection id="Filecontent_steadycos">
147         <title>File content</title>
148         <itemizedlist>
149             <listitem>
150                 <para> SCI/modules/scicos/macros/scicos_auto/steadycos.sci</para>
151             </listitem>
152         </itemizedlist>
153     </refsection>
154     <refsection id="SeeAlso_steadycos">
155         <title>See Also</title>
156         <itemizedlist>
157             <listitem>
158                 <para>
159                     <link linkend="lincos">lincos - Constructs by linearization a linear state-space model from a general dynamical system described by a xcos diagram (Scilab Function)</link>
160                 </para>
161             </listitem>
162             <listitem>
163                 <para>
164                     <link linkend="scicos_simulate">scicos_simulate - Function for running xcos simulation in batch mode (Scilab Function)</link>
165                 </para>
166             </listitem>
167             <listitem>
168                 <para>
169                     <link linkend="xcos">xcos - Block diagram editor and GUI for the hybrid simulator (Scilab Function)</link>
170                 </para>
171             </listitem>
172         </itemizedlist>
173     </refsection>
174 </refentry>