<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="gf_mesh_im_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_mesh_im_get</refname>
    <refpurpose>  General function extracting information from mesh_im objects.
  </refpurpose>
  </refnamediv>

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

    <synopsis>{I, CV2I} = gf_mesh_im_get(mesh_im MI, 'integ'[, mat CVids])</synopsis>
    <synopsis>CVids = gf_mesh_im_get(mesh_im MI, 'convex_index')</synopsis>
    <synopsis>M = gf_mesh_im_get(mesh_im MI, 'eltm', eltm em, int cv [, int f])</synopsis>
    <synopsis>Ip = gf_mesh_im_get(mesh_im MI, 'im_nodes'[, mat CVids])</synopsis>
    <synopsis>gf_mesh_im_get(mesh_im MI, 'save',string filename[, 'with mesh'])</synopsis>
    <synopsis>gf_mesh_im_get(mesh_im MI, 'char'[,'with mesh'])</synopsis>
    <synopsis>gf_mesh_im_get(mesh_im MI, 'display')</synopsis>
    <synopsis>m = gf_mesh_im_get(mesh_im MI, 'linked mesh')</synopsis>
    <synopsis>z = gf_mesh_im_get(mesh_im MI, 'memsize')</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>
    <para>  General function extracting information from mesh_im objects.
  </para>
  </refsection>

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

    <itemizedlist>
    <listitem>
    <para><literal>{I, CV2I} = gf_mesh_im_get(mesh_im MI, 'integ'[, mat CVids])</literal></para>

    <para>       Return a list of integration methods used by the mesh_im.

    <literal>I</literal> is an array of all integ objects found in the convexes
    given in <literal>CVids</literal>. If <literal>CV2I</literal> was supplied as an output argument, it
    contains, for each convex listed in <literal>CVids</literal>, the index of its
    correspounding integration method in <literal>I</literal>.

    Convexes which are not part of the mesh, or convexes which do
    not have any integration method have their correspounding entry
    in <literal>CV2I</literal> set to -1.
    

    </para>
    </listitem>

    <listitem>
    <para><literal>CVids = gf_mesh_im_get(mesh_im MI, 'convex_index')</literal></para>

    <para>       Return the list of convexes who have a integration method.

    Convexes who have the dummy IM_NONE method are not listed.
    </para>
    </listitem>

    <listitem>
    <para><literal>M = gf_mesh_im_get(mesh_im MI, 'eltm', eltm em, int cv [, int f])</literal></para>

    <para>       Return the elementary matrix (or tensor) integrated on the convex <literal>cv</literal>.

    **WARNING**

    Be sure that the fem used for the construction of <literal>em</literal> is compatible
    with the fem assigned to element <literal>cv</literal> ! This is not checked by the
    function ! If the argument <literal>f</literal> is given, then the elementary tensor
    is integrated on the face <literal>f</literal> of <literal>cv</literal> instead of the whole convex.
    </para>
    </listitem>

    <listitem>
    <para><literal>Ip = gf_mesh_im_get(mesh_im MI, 'im_nodes'[, mat CVids])</literal></para>

    <para>       Return the coordinates of the integration points, with their weights.

    <literal>CVids</literal> may be a list of convexes, or a list of convex faces, such
    as returned by gf_mesh_get(mesh M, 'region')

    **WARNING**

    Convexes which are not part of the mesh, or convexes which
    do not have an approximate integration method don't have
    their correspounding entry (this has no meaning for exact
    integration methods!).
    </para>
    </listitem>

    <listitem>
    <para><literal>gf_mesh_im_get(mesh_im MI, 'save',string filename[, 'with mesh'])</literal></para>

    <para>         Saves a mesh_im in a text file (and optionaly its linked mesh object).
    </para>
    </listitem>

    <listitem>
    <para><literal>gf_mesh_im_get(mesh_im MI, 'char'[,'with mesh'])</literal></para>

    <para>         Output a string description of the mesh_im.
      
      By default, it does not include the description of the linked
      mesh object.
    </para>
    </listitem>

    <listitem>
    <para><literal>gf_mesh_im_get(mesh_im MI, 'display')</literal></para>

    <para>         displays a short summary for a mesh_im object.
    </para>
    </listitem>

    <listitem>
    <para><literal>m = gf_mesh_im_get(mesh_im MI, 'linked mesh')</literal></para>

    <para>       Returns a reference to the mesh object linked to <literal>mim</literal>.
    </para>
    </listitem>

    <listitem>
    <para><literal>z = gf_mesh_im_get(mesh_im MI, 'memsize')</literal></para>

    <para>       Return the amount of memory (in bytes) used by the mesh_im object.

    The result does not take into account the linked mesh object.
    </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>
