summaryrefslogtreecommitdiff
path: root/modules/cacsd/help/en_US/lin.xml
blob: 64557ed856d8ef071a9c6e401b275a19f94de68a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - 
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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:lang="en" xml:id="lin">
    <refnamediv>
        <refname>lin</refname>
        <refpurpose>linearization</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>[A,B,C,D]=lin(sim,x0,u0)
            [sl]=lin(sim,x0,u0)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>sim</term>
                <listitem>
                    <para>function</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>x0, u0</term>
                <listitem>
                    <para>vectors of compatible dimensions</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>A,B,C,D</term>
                <listitem>
                    <para>real matrices</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>sl</term>
                <listitem>
                    <para>
                        <literal>syslin</literal> list
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            linearization of the non-linear system <literal>[y,xdot]=sim(x,u)</literal>
            around <literal>x0,u0</literal>.
        </para>
        <para>
            <literal>sim</literal> is a function which computes <literal>y</literal> and <literal>xdot</literal>.
        </para>
        <para>
            The output is a linear system (<literal>syslin</literal> list) <literal>sl</literal> or the 
            four matrices <literal>(A,B,C,D)</literal>
        </para>
        <para>
            For example, if <literal>ftz</literal> is the function passed to ode e.g.
        </para>
        <programlisting role=""><![CDATA[ 
[zd]=ftz(t,z,u)
 ]]></programlisting>
        <para>
            and if we assume that <literal>y=x</literal>
        </para>
        <para>
            <literal>[z]=ode(x0,t0,tf,list(ftz,u)</literal> compute <literal>x(tf)</literal>.
        </para>
        <para>
            If <literal>simula</literal> is the following function:
        </para>
        <programlisting role=""><![CDATA[ 
deff('[y,xd]=simula(x,u)','xd=ftz(tf,x,u); y=x;');
 ]]></programlisting>
        <para>
            the tangent linear system <literal>sl</literal> can be obtained by:
        </para>
        <programlisting role=""><![CDATA[ 
[A,B,C,D]=lin(simula,z,u)
sl = syslin('c',A,B,C,D,x0)
 ]]></programlisting>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
deff('[y,xdot]=sim(x,u)','xdot=[u*sin(x);-u*x^2];y=xdot(1)+xdot(2)')
sl=lin(sim,1,2);
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="external">external</link>
            </member>
            <member>
                <link linkend="derivat">derivat</link>
            </member>
        </simplelist>
    </refsection>
</refentry>