<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 * ...
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="dassl" xml:lang="ru">
    <refnamediv>
        <refname>dassl</refname>
        <refpurpose>дифференциальное алгебраическое уравнение</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>[r [,hd]] = dassl(x0,t0,t [,atol,[rtol]],res [,jac] [,info] [,hd])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>x0</term>
                <listitem>
                    <para>
                        представляет собой либо <literal>y0</literal> (<literal>ydot0</literal>
                        оценён с помощью <literal>dassl</literal> с нулём в качестве первой оценки),
                        либо матрицу <literal>[y0 ydot0]</literal>. <literal>g(t,y0,ydot0)</literal>
                        должна быть равной нулю. Если известна только оценка <literal>ydot0</literal>,
                        то установите <literal>info(7)=1</literal>.
                    </para>
                    <variablelist>
                        <varlistentry>
                            <term>y0</term>
                            <listitem>
                                <para>вещественный вектор-столбец исходных условий.</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>ydot0</term>
                            <listitem>
                                <para>
                                    вещественный вектор-столбец производной <literal>y</literal> по
                                    времени в момент <literal>t0</literal> (может быть оценкой).
                                </para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>t0</term>
                <listitem>
                    <para>вещественное число, начальный момент времени.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>t</term>
                <listitem>
                    <para>
                        вещественный скаляр или вектор. Указывает моменты времени для которых
                        необходимо найти решение. Заметьте, что вы можете получить решение в
                        каждой точке шага dassl установкой <literal>info(2)=1</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>atol, rtol</term>
                <listitem>
                    <para>
                        вещественные скаляры или вектор-столбцы того же размера, что и
                        <literal>y</literal>. <literal>atol, rtol</literal> указывают допуски
                        абсолютной и относительной ошибок решения, соответственно. Если это
                        векторы, то допуски определены для каждого элемента <literal>y</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>res</term>
                <listitem>
                    <para>
                        <link linkend="external">внешняя</link> функция, список или строка.
                        Вычисляет значение <literal>g(t,y,ydot)</literal>. Это может быть:
                    </para>
                    <itemizedlist>
                        <listitem>
                            <para>Функция Scilab.</para>
                            <para>
                                Её последовательность вызова должна быть
                                <literal>[r,ires]=res(t,y,ydot)</literal> и
                                <literal>res</literal> должна возвращать остаток
                                <literal>r=g(t,y,ydot)</literal> и флаг ошибки
                                <literal>ires</literal>. <literal>ires = 0</literal>, если
                                <literal>res</literal> удалось вычислить <literal>r</literal>;
                                <literal>=-1</literal>, если остаток локально не определён для
                                <literal>(t,y,ydot)</literal>; <literal>=-2</literal>, если
                                параметры находятся вне допустимого диапазона.
                            </para>
                        </listitem>
                        <listitem>
                            <para>Список.</para>
                            <para>
                                Эта форма позволяет передавать функции параметры, отличные от <literal>t</literal>,
                                <literal>y</literal>, <literal>ydot</literal>. Это выполняется следующим способом:
                            </para>
                            <screen><![CDATA[
list(res,x1,x2,...)
]]></screen>
                            <para>
                                где последовательность вызова функции <literal>res</literal>
                                теперь имеет вид:
                            </para>
                            <screen><![CDATA[
r = res(t,y,ydot,x1,x2,...)
]]></screen>
                            <para>
                                <literal>res</literal> по-прежнему возвращает
                                <literal>r=g(t,y,ydot</literal> как функцию от
                                <literal>(t,y,ydot,x1,x2,...)</literal>.
                            </para>
                        </listitem>
                        <listitem>
                            <para>Строка.</para>
                            <para>
                                Она должна ссылаться на имя подпрограммы на языке C или Fortran, связанной с Scilab'ом.
                            </para>
                            <para>
                                Последовательность вызова на языке C должна быть:
                            </para>
                            <screen><![CDATA[
void res(double *t, double y[], double yd[], double r[],
         int *ires, double rpar[], int ipar[])
]]></screen>
                            <para>На языке Fortran она должна быть:</para>
                            <screen><![CDATA[
subroutine res(t,y,yd,r,ires,rpar,ipar)
double precision t, y(*),yd(*),r(*),rpar(*)
integer ires,ipar(*)
]]></screen>
                            <para>
                                Массивы <literal>rpar</literal> и <literal>ipar</literal> должны быть,
                                но не должны использоваться.
                            </para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>jac</term>
                <listitem>
                    <para>
                        <link linkend="external">внешняя</link> функция, список или строка.
                        Вычисляет значение <literal>dg/dy+cj*dg/dydot</literal> для заданной
                        величины параметра <literal>cj</literal>.
                    </para>
                    <itemizedlist>
                        <listitem>
                            <para>Функция Scilab.</para>
                            <para>
                                Её последовательность вызова должна быть
                                <literal>r=jac(t,y,ydot,cj)</literal> и
                                <literal>jac</literal> должна возвращать
                                <literal>r=dg(t,y,ydot)/dy+cj*dg(t,y,ydot)/dydot</literal>, где
                                <literal>cj</literal> -- вещественный скаляр.
                            </para>
                        </listitem>
                        <listitem>
                            <para>Список.</para>
                            <para>Он должен иметь следующий вид:</para>
                            <screen><![CDATA[
list(jac,x1,x2,...)
]]></screen>
                            <para>где последовательность вызова функции
                                <literal>jac</literal> теперь имеет вид:
                            </para>
                            <screen><![CDATA[
r = jac(t,y,ydot,cj,x1,x2,...)
]]></screen>
                            <para>
                                <literal>jac</literal> по-прежнему возвращает
                                <literal>dg/dy+cj*dg/dydot</literal> в виде функции от
                                <literal>(t,y,ydot,cj,x1,x2,...)</literal>.
                            </para>
                        </listitem>
                        <listitem>
                            <para>Символьная строка.</para>
                            <para>Она должна ссылаться на имя подпрограммы на языке C или Fortran, связанной с Scilab.
                            </para>
                            <para>В C последовательность вызова должна быть следующего вида:</para>
                            <screen><![CDATA[
void jac(double *t, double y[], double yd[], double pd[],
         double *cj, double rpar[], int ipar[])
]]></screen>
                            <para>В Fortran она должна быть:</para>
                            <screen><![CDATA[
subroutine jac(t,y,yd,pd,cj,rpar,ipar)
double precision t, y(*),yd(*),pd(*),cj,rpar(*)
integer ipar(*)
]]></screen>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>info</term>
                <listitem>
                    <para>
                        необязательный список, содержащий <literal>7</literal> элементов.
                        Значение по умолчанию равно <literal>list([],0,[],[],[],0,0)</literal>.
                    </para>
                    <variablelist>
                        <varlistentry>
                            <term>info(1)</term>
                            <listitem>
                                <para>
                                    вещественный скаляр, который указывает максимальное время, для которого
                                    <literal>g</literal> может выполняться, либо пустая матрица
                                    <literal>[]</literal>, если время не ограничено.
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>info(2)</term>
                            <listitem>
                                <para>
                                    флаг, который указывает возвращать ли <literal>dassl</literal> её
                                    вычисленные промежуточные  значения (<literal>flag=1</literal>) или только
                                    пользователь определяет значения моментов времени
                                    (<literal>flag=0</literal>).
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>info(3)</term>
                            <listitem>
                                <para>
                                    двухэлементный вектор, который указывает определение <literal>[ml,mu]</literal>
                                    матрицы пределов, вычисленной с помощью <literal>jac</literal>;
                                    <literal>r(i - j + ml + mu + 1,j) =  "dg(i)/dy(j)+cj*dg(i)/dydot(j)"</literal>.
                                    Если <literal>jac</literal> возвращает полную матрицу, то
                                    <literal>info(3)=[]</literal>.
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>info(4)</term>
                            <listitem>
                                <para>
                                    вещественный скаляр, который указывает максимальный размер шага. Установите
                                    <literal>info(4)=[]</literal>, если ограничений нет.
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>info(5)</term>
                            <listitem>
                                <para>
                                    вещественный скаляр, который указывает исходный размер шага.
                                    Установите <literal>info(5)=[]</literal>, если он не определён.
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>info(6)</term>
                            <listitem>
                                <para>
                                    <literal>info(6)=1</literal>, если известно, что решение отрицательное, в
                                    противном случае установите <literal>info(6)=0</literal>.
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>info(7)</term>
                            <listitem>
                                <para>
                                    <literal>info(7)=1</literal>, если <literal>ydot0</literal> является
                                    просто оценкой; <literal>info(7)=0</literal>, если
                                    <literal>g(t0,y0,ydot0)=0</literal>.
                                </para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>hd</term>
                <listitem>
                    <para>
                        вещественный вектор, который позволяет хранить контекст
                        <literal>dassl</literal> и продолжать интегрирование.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>r</term>
                <listitem>
                    <para>
                        вещественная матрица. Каждый столбец является вектором <literal>[t;x(t);xdot(t)]</literal>,
                        где <literal>t</literal> -- индекс времени для которого требуется найти решение.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            Функция <literal>dassl</literal> интегрирует дифференциальное алгебраическое уравнение и возвращает изменение <literal>y</literal> в заданные моменты времени.
        </para>
        <screen><![CDATA[
g(t,y,ydot) = 0
y(t0) = y0  and   ydot(t0) = ydot0
 ]]></screen>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
function [r,ires] = chemres(t,y,yd)
   r=[-0.04*y(1)+1d4*y(2)*y(3)-yd(1)
       0.04*y(1)-1d4*y(2)*y(3)-3d7*y(2)*y(2)-yd(2)
       y(1)+y(2)+y(3)-1];
   ires=0
endfunction

function pd = chemjac(x,y,yd,cj)
    pd=[-0.04-cj , 1d4*y(3)               , 1d4*y(2);
         0.04    ,-1d4*y(3)-2*3d7*y(2)-cj ,-1d4*y(2);
         1       , 1                      , 1       ]
endfunction

y0 = [1;0;0];
yd0 = [-0.04;0.04;0];
t = [1.d-5:0.02:.4,0.41:.1:4,40,400,4000,40000,4d5,4d6,4d7,4d8,4d9,4d10];

y = dassl([y0,yd0],0,t,chemres);

info = list([],0,[],[],[],0,0);
info(2) = 1;
y1 = dassl([y0,yd0],0,4d10,chemres,info);
y2 = dassl([y0,yd0],0,4d10,chemres,chemjac,info);

//Использование дополнительного аргумента для параметров
//-----------------------------------
function [r,ires] = chemres(t,y,yd ,a,b,c)
   r=[-a*y(1)+b*y(2)*y(3)-yd(1)
       a*y(1)-b*y(2)*y(3)-c*y(2)*y(2)-yd(2)
       y(1)+y(2)+y(3)-1];
   ires = 0
endfunction

function pd = chemjac(x,y,yd,cj, a,b,c)
    pd=[-a-cj , b*y(3)             , b*y(2);
         a    ,-b*y(3)-2*c*y(2)-cj ,-b*y(2);
         1    , 1                  , 1       ]
endfunction

y3 = dassl([y0,yd0],0,t,list(chemres,0.04,1d4,3d7),list(chemjac,0.04,1d4,3d7));

//использование C-кода
//------------
// - создаём C-код
cd TMPDIR
rescode=['void chemres(double *t, double y[], double yd[], double r[], int *ires, double rpar[], int ipar[])'
         ' {'
         '   r[0] = -0.04*y[0]+1.0e4*y[1]*y[2]                -yd[0];'
         '   r[1] =  0.04*y[0]-1.0e4*y[1]*y[2]-3.0e7*y[1]*y[1]-yd[1];'
         '   r[2] =       y[0]+y[1]+y[2]-1;'
         '   *ires = 0;'
         ' }'];

jaccode=['void chemjac(double *t, double y[], double yd[], double pd[], double *cj, double rpar[], int ipar[])'
         ' {'
         '   /* first column*/'
         '   pd[0] = -0.04-*cj;'
         '   pd[1] =  0.04;'
         '   pd[2] =  1.0;'
         '    /* second column*/'
         '   pd[3] =  1.0e4*y[2];'
         '   pd[4] = -1.0e4*y[2]-2*3.0e7*y[1]-*cj;'
         '   pd[5] =  1.0;'
         '    /* third column*/'
         '   pd[6] =  1.0e4*y[1];'
         '   pd[7] = -1.0e4*y[1];'
         '   pd[8] =  1.0;'
         ' }'];
mputl([rescode;jaccode], 'mycode.c') //создаём C-файл в директории TMPDIR

// - компилируем
ilib_for_link(['chemres','chemjac'],'mycode.c',[],'c','','loader.sce');

// - связываем его с Scilab'ом
exec('loader.sce')

// - вызов dassl
y4 = dassl([y0,yd0], 0, t, 'chemres', 'chemjac');
     ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="ode">ode</link>
            </member>
            <member>
                <link linkend="dasrt">dasrt</link>
            </member>
            <member>
                <link linkend="impl">impl</link>
            </member>
            <member>
                <link linkend="call">call</link>
            </member>
            <member>
                <link linkend="link">link</link>
            </member>
            <member>
                <link linkend="external">external</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
