<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="gf_levelset_get" 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_levelset_get</refname>
    <refpurpose>    General function for querying information about LEVELSET objects.
</refpurpose>
  </refnamediv>

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

    <synopsis>V = gf_levelset_get(levelset LS, 'values', int nls)</synopsis>
    <synopsis>d = gf_levelset_get(levelset LS, 'degree')</synopsis>
    <synopsis>mf = gf_levelset_get(levelset LS, 'mf')</synopsis>
    <synopsis>z = gf_levelset_get(levelset LS, 'memsize')</synopsis>
    <synopsis>s = gf_levelset_get(levelset LS, 'char')</synopsis>
    <synopsis>gf_levelset_get(levelset LS, 'display')</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>
    <para>    General function for querying information about LEVELSET objects.
</para>
  </refsection>

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

    <itemizedlist>
    <listitem>
    <para><literal>V = gf_levelset_get(levelset LS, 'values', int nls)</literal></para>

    <para>       Return the vector of dof for <literal>nls</literal> funtion.

    If <literal>nls</literal> is 0, the method return the vector of dof for the primary
    level-set funtion. If <literal>nls</literal> is 1, the method return the vector of
    dof for the secondary level-set function (if any).
    </para>
    </listitem>

    <listitem>
    <para><literal>d = gf_levelset_get(levelset LS, 'degree')</literal></para>

    <para>         Return the degree of lagrange representation.
    </para>
    </listitem>

    <listitem>
    <para><literal>mf = gf_levelset_get(levelset LS, 'mf')</literal></para>

    <para>       Return a reference on the mesh_fem object.
    </para>
    </listitem>

    <listitem>
    <para><literal>z = gf_levelset_get(levelset LS, 'memsize')</literal></para>

    <para>         Return the amount of memory (in bytes) used by the level-set.
    </para>
    </listitem>

    <listitem>
    <para><literal>s = gf_levelset_get(levelset LS, 'char')</literal></para>

    <para>         Output a (unique) string representation of the levelset.

      This can be used to perform comparisons between two
      different levelset objects.
      This function is to be completed.
      
    </para>
    </listitem>

    <listitem>
    <para><literal>gf_levelset_get(levelset LS, 'display')</literal></para>

    <para>         displays a short summary for a levelset.
    </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>
