<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2008 - INRIA
* Copyright (C) 2012 - Scilab Enterprises - Adeline CARNIS
* ...
*
 * 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="ode_root" xml:lang="ru">
    <refnamediv>
        <refname>ode_root</refname>
        <refpurpose>
            программа решения обыкновенных дифференциальных уравнений с поиском корней
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>[y, rd, w, iw] = ode("root", y0, t0, t [,rtol [,atol]], f [,jac], ng, g [,w, iw])</synopsis>
    </refsynopsisdiv>
    <refsection role="parameters">
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>y0</term>
                <listitem>
                    <para>вектор или матрица вещественных значений (начальные условия).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>t0</term>
                <listitem>
                    <para>вещественный скаляр (начальное время).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>t</term>
                <listitem>
                    <para>вектор вещественных значений (моменты времени, для которых вычисляется решение).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>f</term>
                <listitem>
                    <para>внешняя функция, символьная строка или список.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>rtol, atol</term>
                <listitem>
                    <para>
                        вещественные константы или векторы того же размера, что и <literal>y</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>jac</term>
                <listitem>
                    <para>внешняя функция, символьная строка или список.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ng</term>
                <listitem>
                    <para>целое число.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>g</term>
                <listitem>
                    <para>внешняя функция, символьная строка или список.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>вещественный вектор или матрица (ВЫХОДНАЯ).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>rd</term>
                <listitem>
                    <para>вещественный вектор (ВЫХОДНОЙ).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>w, iw</term>
                <listitem>
                    <para>
                        векторы вещественных значений.
                        See <link linkend="ode_optional_output">ode() optional output</link>
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection role="description">
        <title>Описание</title>
        <para>
            С таким синтаксисом (первый аргумент равен <literal>"root"</literal>) <literal>ode</literal> вычисляет решение дифференциального уравнения  <literal>dy/dt=f(t,y)</literal> до тех пор, пока состояние <literal>y(t)</literal> не пересечёт поверхность <literal>g(t,y)=0</literal>.
        </para>
        <para>
            <literal>g</literal> должно задавать уравнение поверхности. Это внешняя функция, то есть функция с определённым синтаксисом или имя процедуры Fortran или функции C (символьная строка) с определённой последовательностью вызова или список.
        </para>
        <para>
            Если <literal>g</literal> является функцией, то её синтаксис должен быть следующим:
        </para>
        <screen><![CDATA[
z = g(t,y)
]]></screen>
        <para>
            где <literal>t</literal> -- вещественный скаляр (время) и <literal>y</literal> -- вещественный вектор (состояние). Она возвращает вектор размером       <literal>ng</literal>, который соответствует <literal>ng</literal> ограничениям. Если <literal>g</literal> -- символьная строка, то она ссылается на имя процедуры Fortran или функции C со следующей последовательностью вызова: <literal>g(n,t,y,ng,gout)</literal>, где <literal>ng</literal> --  количество ограничений, а <literal>gout</literal> -- значение  <literal>g</literal> (на выходе программы). Если <literal>g</literal> является списком, то применяются те же договорённости, что и для <literal>f</literal> (см. справку <link linkend="ode">ode</link>).
        </para>
        <para>
            Выходное значение <literal>rd</literal> -- это вектор размером <literal>1 x k</literal>.
            Первый элемент хранит время остановки. Остальные элементы указывают какие элементы <literal>g</literal> сменили знак. <literal>k</literal> больше 2 указывает, что одновременно было пересечено более одной поверхности (<literal>(k-1)</literal> поверхностей).
        </para>
        <para>
            Другие аргументы и другие опции те же самые, что и для <literal>ode</literal>, см. справку по <link linkend="ode">ode</link>.
        </para>
    </refsection>
    <refsection role="examples">
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
// Интегрирование дифференциального уравнения
// dy/dt=y , y(0)=1, и поиск такого минимального времени t, что y(t)=2
deff("ydot = f(t,y)", "ydot = y")
deff("z = g(t,y)", "z = y-2")
y0 = 1;  ng = 1;
[y, rd] = ode("root", y0, 0, 2, f, ng, g)

deff("z = g(t,y)", "z = y-[2;2;33]")
[y, rd] = ode("root", 1, 0, 2, f, 3, g)
        ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="ode">ode</link>
            </member>
            <member>
                <link linkend="ode_optional_output">ode_optional_output</link>
            </member>
            <member>
                <link linkend="ode_discrete">ode_discrete</link>
            </member>
            <member>
                <link linkend="dae">dae</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
