[Getfem-commits] [getfem-commits] branch devel-logari81-internal-variables updated: Mention internal variables in the model object documentation

[Konstantinos Poulios]

This is an automated email from the git hooks/post-receive script.

logari81 pushed a commit to branch devel-logari81-internal-variables
in repository getfem.

The following commit(s) were added to 
refs/heads/devel-logari81-internal-variables by this push:
     new 8c125e2  Mention internal variables in the model object documentation
8c125e2 is described below

commit 8c125e2fd8e04de85bfb2f785aafa223ace7b25a
Author: Konstantinos Poulios <address@hidden>
AuthorDate: Sat Feb 1 11:51:40 2020 +0100

    Mention internal variables in the model object documentation
---
 doc/sphinx/source/userdoc/model_object.rst | 23 +++++++++++++++++++++++
 src/getfem/getfem_models.h                 |  8 ++++----
 2 files changed, 27 insertions(+), 4 deletions(-)

diff --git a/doc/sphinx/source/userdoc/model_object.rst 
b/doc/sphinx/source/userdoc/model_object.rst
index 139fae0..c84d5ca 100644
--- a/doc/sphinx/source/userdoc/model_object.rst
+++ b/doc/sphinx/source/userdoc/model_object.rst
@@ -136,6 +136,29 @@ The main useful methods on a |mo| object are
    variable. Note that for complex terms, only
    the real part is considered to filter the multiplier.
 
+.. c:function:: add_im_variable(name, imd)
+
+   Add a variable defined on the integration points of the ``im_data`` object 
imd.
+   The variable can be scalar-valued, vector-valued or tensor-valued depending 
on
+   the dimension of imd.
+   It increases the model degrees of freedom by the number of integration 
points
+   time the size of the variable at one integration point.
+
+.. c:function:: add_internal_im_variable(name, imd)
+
+   Add a variable defined on the integration points of the ``im_data`` object
+   ``imd`` that will be statically condensed out during the linearization of 
the
+   problem. The variable can be scalar-valued, vector-valued or tensor-valued
+   depending on the dimension of imd.
+   It does not add degrees of freedom to the model.
+
+.. c:function:: add_im_data(name, imd)
+
+   Add a data object deignated with the string ``name``, defined at all
+   integration points of the ``im_data`` object ``imd``.
+   The data can be scalar-valued, vector-valued or tensor-valued depending on
+   the dimension of imd.
+
 .. c:function:: real_variable(name, niter=1)
 
    Gives the access to the vector value of a variable or data. Real version.
diff --git a/src/getfem/getfem_models.h b/src/getfem/getfem_models.h
index 813bb69..9e6c07f 100644
--- a/src/getfem/getfem_models.h
+++ b/src/getfem/getfem_models.h
@@ -786,13 +786,13 @@ namespace getfem {
 
 
     /** Add variable defined at integration points. */
-    void add_im_variable(const std::string &name, const im_data &im_data,
+    void add_im_variable(const std::string &name, const im_data &imd,
                          size_type niter = 1);
-    /** Add internal variable, defined at integration points and condensated. 
*/
+    /** Add internal variable, defined at integration points and condensed. */
     void add_internal_im_variable(const std::string &name,
-                                  const im_data &im_data);
+                                  const im_data &imd);
     /** Add data defined at integration points. */
-    void add_im_data(const std::string &name, const im_data &im_data,
+    void add_im_data(const std::string &name, const im_data &imd,
                      size_type niter = 1);
 
     /** Add a variable being the dofs of a finite element method to the model.