<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="gf_mdstate" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:xi="http://www.w3.org/2001/XInclude"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:html="http://www.w3.org/1999/xhtml"
          xmlns:db="http://docbook.org/ns/docbook">
  <refnamediv>
    <refname>gf_mdstate</refname>
    <refpurpose>  A model state is an object which store the state data for a chain of model
  bricks. This includes the global tangent matrix, the right hand side and
  the constraints.

  This object is now deprecated and replaced by the model object.

  There are two sorts of model states, the <literal>real</literal> and the <literal>complex</literal> models
  states.
</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>

    <synopsis>MDS = gf_mdstate('real')</synopsis>
    <synopsis>MDS = gf_mdstate('complex')</synopsis>
    <synopsis>MDS = gf_mdstate(mdbrick B)</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>
    <para>General constructor for mdstate objects.</para>

    <para>  A model state is an object which store the state data for a chain of model
  bricks. This includes the global tangent matrix, the right hand side and
  the constraints.

  This object is now deprecated and replaced by the model object.

  There are two sorts of model states, the <literal>real</literal> and the <literal>complex</literal> models
  states.
</para>
  </refsection>

  <refsection>
    <title>Command list</title>

    <itemizedlist>
    <listitem>
    <para><literal>MDS = gf_mdstate('real')</literal></para>

    <para>           Build a model state for real unknowns.
    </para>
    </listitem>

    <listitem>
    <para><literal>MDS = gf_mdstate('complex')</literal></para>

    <para>           Build a model state for complex unknowns.
    </para>
    </listitem>

    <listitem>
    <para><literal>MDS = gf_mdstate(mdbrick B)</literal></para>

    <para>         Build a modelstate for the brick <literal>B</literal>.

      Selects the real or complex state from the complexity of <literal>B</literal>.
    </para>
    </listitem>

    </itemizedlist>
  </refsection>

  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member><link linkend="getfem_types">getfem types</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Authors</title>
    <para>Y. Collette</para>
  </refsection>

</refentry>
