[Getfem-commits] [getfem-commits] branch fixmisspell updated: :wrench: cpp:function warning from sphinx

[Tetsuo Koyama]

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

tkoyama010 pushed a commit to branch fixmisspell
in repository getfem.

The following commit(s) were added to refs/heads/fixmisspell by this push:
     new e47d909  :wrench: cpp:function warning from sphinx
e47d909 is described below

commit e47d909a659b11059a3ca8276c9217427c642001
Author: Tetsuo Koyama <address@hidden>
AuthorDate: Fri Mar 27 18:09:42 2020 +0000

    :wrench: cpp:function warning from sphinx
---
 doc/sphinx/source/project/femdesc.rst       |  2 +-
 doc/sphinx/source/project/libdesc_event.rst |  8 +--
 doc/sphinx/source/userdoc/bfem.rst          | 42 ++++++-------
 doc/sphinx/source/userdoc/bmesh.rst         | 94 ++++++++++++++---------------
 doc/sphinx/source/userdoc/export.rst        |  2 +-
 doc/sphinx/source/userdoc/model_object.rst  | 38 ++++++------
 6 files changed, 92 insertions(+), 94 deletions(-)

diff --git a/doc/sphinx/source/project/femdesc.rst 
b/doc/sphinx/source/project/femdesc.rst
index 441c3e1..bdb28f7 100644
--- a/doc/sphinx/source/project/femdesc.rst
+++ b/doc/sphinx/source/project/femdesc.rst
@@ -42,7 +42,7 @@ elements:
 
    description of a parallelepiped of dimension ``d``.
 
-.. cpp:function:: bgeot::convex_product_structure(bgeot::pconvex_structure p1, 
bgeot::pconv$
+.. cpp:function:: bgeot::convex_product_structure(bgeot::pconvex_structure p1, 
pconvex_structure p2)
 
    description of the direct product of ``p1`` and ``p2``.
 
diff --git a/doc/sphinx/source/project/libdesc_event.rst 
b/doc/sphinx/source/project/libdesc_event.rst
index 7e3cb01..4dd0127 100644
--- a/doc/sphinx/source/project/libdesc_event.rst
+++ b/doc/sphinx/source/project/libdesc_event.rst
@@ -36,23 +36,23 @@ order to deal with the dependencies of an object, the object
 ``context_dependencies`` needs to be a parent class of this object. It adds the
 following methods to the object:
 
-.. cpp:function:: add_dependency(ct)
+.. cpp:function:: getfem::context_dependencies::add_dependency(ct)
 
    Add an object (which has to have ``context_dependencies`` as a parent class)
    to the list of objects from which the current object depend.
 
-.. cpp:function:: touch()
+.. cpp:function:: getfem::context_dependencies::touch()
 
    Indicates to the dependent objects that something has change in the object.
 
-.. cpp:function:: context_check()
+.. cpp:function:: getfem::context_dependencies::context_check()
 
    Check if the object has to be updated. if it is the case it makes first a
    check to the dependency list and call the update function of the object. 
(the
    update function of the dependencies are called before the update function of
    the current object).
 
-.. cpp:function:: context_valid()
+.. cpp:function:: getfem::context_dependencies::context_valid()
 
    Says if the object has still a valid context, i.e. if the object in the
    dependency list still exist.
diff --git a/doc/sphinx/source/userdoc/bfem.rst 
b/doc/sphinx/source/userdoc/bfem.rst
index 751fba0..0cbe5ef 100644
--- a/doc/sphinx/source/userdoc/bfem.rst
+++ b/doc/sphinx/source/userdoc/bfem.rst
@@ -137,20 +137,20 @@ The |mf| can call directly these functions via::
 
 Some other methods:
 
-.. function:: mf.convex_index()
+.. cpp:function:: getfem::mesh_fem::convex_index()
 
    Set of indexes (a |dal_bv|) on which a finite element method is defined.
 
-.. function:: mf.linked_mesh()
+.. cpp:function:: getfem::mesh_fem::linked_mesh()
 
    gives a reference to the linked mesh.
 
-.. function:: mf.fem_of_element(i)
+.. cpp:function:: getfem::mesh_fem::fem_of_element(i)
 
    gives a descriptor on the finite element method defined on element of index
    ``i`` (does not take into account the qdim nor the optional reduction).
 
-.. function:: mf.clear()
+.. cpp:function:: getfem::mesh_fem::clear()
 
    Clears the structure, no finite element method is still defined.
 
@@ -209,50 +209,50 @@ respectively for a tensor field of order two, four and 
arbitrary (but limited to
 At this level are defined the basic degrees of freedom. Some methods of the
 |gf_mf| allows to obtain information on the basic dofs:
 
-.. function:: mf.nb_basic_dof_of_element(i)
+.. cpp:function:: getfem::mesh_fem::nb_basic_dof_of_element(i)
 
    gives the number of basic degrees of freedom on the element of index ``i``.
 
-.. function:: mf.ind_basic_dof_of_element(i)
+.. cpp:function:: getfem::mesh_fem::ind_basic_dof_of_element(i)
 
    gives a container (an array) with all the global indexes of the basic 
degrees
    of freedom of element of index ``i``.
 
-.. function:: mf.point_of_basic_dof(i, j)
+.. cpp:function:: getfem::mesh_fem::point_of_basic_dof(i, j)
 
    gives a ``bgeot::base_node`` which represents the point associated with the
    basic dof of local index ``j`` on element of index ``i``.
 
-.. function:: mf.point_of_basic_dof(j)
+.. cpp:function:: getfem::mesh_fem::point_of_basic_dof(j)
 
    gives a ``bgeot::base_node`` which represents the point associated with the
    basic dof of global index ``j``.
 
-.. function:: mf.reference_point_of_basic_dof(i, j)
+.. cpp:function:: getfem::mesh_fem::reference_point_of_basic_dof(i, j)
 
    gives a ``bgeot::base_node`` which represents the point associated with the
    basic dof of local index ``j`` on element of index ``i`` in the coordinates 
of
    the reference element.
 
-.. function:: mf.first_convex_of_basic_dof(j)
+.. cpp:function:: getfem::mesh_fem::first_convex_of_basic_dof(j)
 
    gives the index of the first element on which the basic degree of freedom of
    global index ``j`` is defined.
 
-.. function:: mf.nb_basic_dof()
+.. cpp:function:: getfem::mesh_fem::nb_basic_dof()
 
    gives the total number of different basic degrees of freedom.
 
-.. function:: mf.get_qdim()
+.. cpp:function:: getfem::mesh_fem::get_qdim()
 
    gives the target dimension ``Q``.
 
-.. function:: mf.basic_dof_on_region(i)
+.. cpp:function:: getfem::mesh_fem::basic_dof_on_region(i)
 
    Return a |dal_bv| which represents the indices of basic dof which are in the
    set of convexes or the set of faces of index ``i`` (see the |gf_m| object).
 
-.. function:: mf.dof_on_region(i)
+.. cpp:function:: getfem::mesh_fem::dof_on_region(i)
 
    Return a |dal_bv| which represents the indices of dof which are in the set 
of
    convexes or the set of faces of index ``i`` (see the |gf_m| object). For a
@@ -275,36 +275,36 @@ sparse. Otherwise, each assembled matrix will be plain !
 
 A natural condition is that :math:`RE = I` where :math:`I` is the identity 
matrix.
 
-.. function:: mf.nb_dof()
+.. cpp:function:: getfem::mesh_fem::nb_dof()
 
    gives the total number of different degrees of freedom. If the optional
    reduction is used, this will be the number of columns of the reduction 
matrix.
    Otherwise it will return the number of basic degrees of freedom.
 
-.. function:: mf.is_reduced()
+.. cpp:function:: getfem::mesh_fem::is_reduced()
 
    return a boolean. True if the reduction is used.
 
-.. function:: mf.reduction_matrix()
+.. cpp:function:: getfem::mesh_fem::reduction_matrix()
 
    return a const reference to the reduction matrix :math:`R`.
 
-.. function:: mf.extension_matrix()
+.. cpp:function:: getfem::mesh_fem::extension_matrix()
 
    return a const reference to the extension matrix :math:`E`.
 
-.. function:: mf.set_reduction_matrices(R, E)
+.. cpp:function:: getfem::mesh_fem::set_reduction_matrices(R, E)
 
    Set the reduction and extension matrices to ``R`` and ``E`` and validate 
their
    use.
 
-.. function:: mf.set_reduction(b)
+.. cpp:function:: getfem::mesh_fem::set_reduction(b)
 
    Where :math:`b` is a boolean. Cancel the reduction if :math:`b` is false and
    validate it if ``b`` is true. If ``b`` is true, the extension and reduction
    matrices have to be set previously.
 
-.. function:: mf.reduce_to_basic_dof(idof)
+.. cpp:function:: getfem::mesh_fem::reduce_to_basic_dof(idof)
 
    Set the reduction and extension matrices corresponding to keep only the 
basic
    dofs present in ``idof``. The parameter ``idof`` is either a |dal_bv| or a
diff --git a/doc/sphinx/source/userdoc/bmesh.rst 
b/doc/sphinx/source/userdoc/bmesh.rst
index dfa4166..304b780 100644
--- a/doc/sphinx/source/userdoc/bmesh.rst
+++ b/doc/sphinx/source/userdoc/bmesh.rst
@@ -210,107 +210,105 @@ Methods of the |gf_m| object
 
 The list is not exhaustive.
 
-.. function:: mymesh.dim()
+.. cpp:function:: getfem::mesh::dim()
 
    main dimension of the mesh.
 
-.. function:: mymesh.points_index()
+.. cpp:function:: getfem::mesh::points_index()
 
    gives a ``dal::bit_vector`` object which represents all the indexes
    of valid points of a mesh (see below).
 
-.. function:: mymesh.points()[i]
+.. cpp:function:: getfem::mesh::points()
 
-   gives the point of index ``i`` (a ``bgeot::base_node``).
+   gives the point of each index (a ``bgeot::base_node``).
 
-.. function:: mymesh.convex_index()
+.. cpp:function:: getfem::mesh::convex_index()
 
    gives a ``dal::bit_vector`` object which represents all the indexes
    of valid elements of a mesh (see below).
 
-.. function:: mymesh.structure_of_convex(i)
+.. cpp:function:: bgeot::mesh_structure::structure_of_convex(i)
 
    gives the description of the structure of element of index ``i``. The 
function
    return a |bg_pcs|.
 
-.. function:: mymesh.structure_of_convex(i)->nb_faces()
+.. cpp:function:: bgeot::convex_structure::nb_faces()
 
-   number of faces of element of index ``i``.
+   number of faces of |bg_pcs|.
 
-.. function:: mymesh.structure_of_convex(i)->nb_points()
+.. cpp:function:: bgeot::convex_structure::nb_points()
 
-   number of vertices of element of index ``i``.
+   number of vertices of |bg_pcs|.
 
-.. function:: mymesh.structure_of_convex(i)->dim()
+.. cpp:function:: bgeot::convex_structure::dim()
 
-   intrinsic dimension of element of index ``i``.
+   intrinsic dimension of |bg_pcs|.
 
 
-.. function:: mymesh.structure_of_convex(i)->nb_points_of_face(f)
+.. cpp:function:: bgeot::convex_structure::nb_points_of_face(f)
 
-   number of vertices of the face of local index ``f`` of element
-   of index ``i``.
+   number of vertices of the face of local index ``f`` of |bg_pcs|.
 
-.. function:: mymesh.structure_of_convex(i)->ind_points_of_face(f)
+.. cpp:function:: bgeot::convex_structure::ind_points_of_face(f)
 
    return a container with the local indexes of all vertices of the
-   face of local index ``f`` of element of index ``i``. For instance
+   face of local index ``f`` of |bg_pcs|. For instance
    ``mesh.structure_of_convex(i)->ind_points_of_face(f)[0]`` is the
    local index of the first vertex.
 
-.. function:: mymesh.structure_of_convex(i)->face_structure(f)
+.. cpp:function:: bgeot::convex_structure::face_structure(f)
 
    gives the structure (a |bg_pcs|) of local index ``f``
-   of element of index ``i``.
+   of |bg_pcs|.
 
-.. function:: mymesh.ind_points_of_convex(i)
+.. cpp:function:: getfem::mesh::ind_points_of_convex(i)
 
-   gives a container with the global indexes of vertices of element of
-   index ``i``.
+   gives a container with the global indexes of vertices of |bg_pcs|.
 
-.. function:: mymesh.points_of_convex(i)
+.. cpp:function:: getfem::mesh::points_of_convex(i)
 
-   gives a container with the vertices of element of index ``i``. This
+   gives a container with the vertices of |bg_pcs|. This
    is an array of ``bgeot::base_node``.
 
-.. function:: mymesh.convex_to_point(ipt)
+.. cpp:function:: getfem::mesh::convex_to_point(ipt)
 
    gives a container with the indexes of all elements attached to the
    point of global index ``ipt``.
 
-.. function:: mymesh.neighbours_of_convex(ic, f)
+.. cpp:function:: getfem::mesh::neighbours_of_convex(ic, f)
 
    gives a container with the indexes of all elements in ``mesh`` having
    the common face of local index ``f`` of element ``ic`` except element
    ``ic``.
 
-.. function:: mymesh.neighbour_of_convex(ic, f)
+.. cpp:function:: getfem::mesh::neighbour_of_convex(ic, f)
 
    gives the index of the first elements in ``mesh`` having the common
    face of local index ``f`` of element ``ic`` except element ``ic``.
    return size_type(-1) if none is found.
 
-.. function:: mymesh.is_convex_having_neighbour(ic, f)
+.. cpp:function:: getfem::mesh::is_convex_having_neighbour(ic, f)
 
    return whether or not the element ``ic`` has a neighbour with respect
    to its face of local index ``f``.
 
-.. function:: mymesh.clear()
+.. cpp:function:: getfem::mesh::clear()
 
    delete all elements and points from the mesh.
 
 
-.. function:: mymesh.optimize_structure()
+.. cpp:function:: getfem::mesh::optimize_structure()
 
    compact the structure (renumbers points and convexes such that there
    is no hole in their numbering).
 
-.. function:: mymesh.trans_of_convex(i)
+.. cpp:function:: getfem::mesh::trans_of_convex(i)
 
    return the geometric transformation of the element of index ``i`` (in
    a |bg_pgt|). See :ref:`dp` for more details about geometric transformations.
 
-.. function:: mymesh.normal_of_face_of_convex(ic, f, pt)
+.. cpp:function:: getfem::mesh::normal_of_face_of_convex(ic, f, pt)
 
    gives a ``bgeot::base_small_vector`` representing an outward normal
    to the element at the face of local index ``f`` at the point of local
@@ -320,56 +318,56 @@ The list is not exhaustive.
    is the ratio between the surface of the face of the reference
    element and the surface of the face of the real element.
 
-.. function:: mymesh.convex_area_estimate(ic)
+.. cpp:function:: getfem::mesh::convex_area_estimate(ic)
 
    gives an estimate of the area of convex ``ic``.
 
-.. function:: mymesh.convex_quality_estimate(ic)
+.. cpp:function:: getfem::mesh::convex_quality_estimate(ic)
 
    gives a rough estimate of the quality of element ``ic``.
 
-.. function:: mymesh.convex_radius_estimate(ic)
+.. cpp:function:: getfem::mesh::convex_radius_estimate(ic)
 
    gives an estimate of the radius of element ``ic``.
 
-.. function:: mymesh.region(irg)
+.. cpp:function:: getfem::mesh::region(irg)
 
    return a |gf_mr|. The region is stored in the mesh, and can
    contain a set of convex numbers and or convex faces.
 
-.. function:: mymesh.has_region(irg)
+.. cpp:function:: getfem::mesh::has_region(irg)
 
    returns true if the region of index ``irg`` has been created.
 
 The methods of the convexes/convex faces container ``getfem::mesh_region`` are:
 
-.. function:: add(ic)
+.. cpp:function:: getfem::mesh_region::add(ic)
 
    add the convex of index ``ic`` to the region.
 
-.. function:: add(ic,f)
+.. cpp:function:: getfem::mesh_region::add(ic,f)
 
    add the face number ``f`` of the convex ``ic``.
 
-.. function:: sup(ic)
-              sup(ic,f)
+.. cpp:function:: getfem::mesh_region::sup(ic)
+                  getfem::mesh_region::sup(ic,f)
 
    remove the convex or the convex face from the region.
 
-.. function:: is_in(ic)
-              is_in(ic,f)
+.. cpp:function:: getfem::mesh_region::is_in(ic)
+                  getfem::mesh_region::is_in(ic,f)
 
    return true if the convex (or convex face) is in the region.
 
-.. function:: is_only_faces()
+.. cpp:function:: getfem::mesh_region::is_only_faces()
 
    return true if the region does not contain any convex.
 
-.. function:: is_only_convexes()
+.. cpp:function:: getfem::mesh_region::is_only_convexes()
 
    return true if the region does not contain any convex face.
 
-.. function:: index()
+.. cpp:function:: getfem::mesh_region::index()
 
    return a ``dal::bit_vector`` containing the list of convexes
    which are stored (or whose faces are stored) in the region.
@@ -438,11 +436,11 @@ From |gf| file format
 In :file:`getfem/getfem_mesh.h`, two methods are defined to load meshes from 
file
 and write meshes to a file.
 
-.. function:: mymesh.write_to_file(const std::string &name)
+.. cpp:function:: getfem::mesh::write_to_file(const std::string &name)
 
    save the mesh into a file.
 
-.. function:: mymesh.read_from_file(const std::string &name)
+.. cpp:function:: getfem::mesh::read_from_file(const std::string &name)
 
    load the mesh from a file.
 
diff --git a/doc/sphinx/source/userdoc/export.rst 
b/doc/sphinx/source/userdoc/export.rst
index b22ffa7..b67bf42 100644
--- a/doc/sphinx/source/userdoc/export.rst
+++ b/doc/sphinx/source/userdoc/export.rst
@@ -74,7 +74,7 @@ reference to a |mf| ``mf`` and a field ``U`` on this |mf|).
 
    empty slicer.
 
-.. cpp:function:: getfem::slicer_boundary(const mesh &m, \ldots)
+.. cpp:function:: getfem::slicer_boundary(const mesh &m, ldots)
 
    extract the boundary of a mesh.
 
diff --git a/doc/sphinx/source/userdoc/model_object.rst 
b/doc/sphinx/source/userdoc/model_object.rst
index c129c53..fcf1d65 100644
--- a/doc/sphinx/source/userdoc/model_object.rst
+++ b/doc/sphinx/source/userdoc/model_object.rst
@@ -58,49 +58,49 @@ different bricks added to the model.
 
 The main useful methods on a |mo| object are
 
-.. cpp:function:: m.is_complex()
+.. cpp:function:: getfem::model::is_complex()
 
    A boolean which says if the model deals with real or complex unknowns and 
data.
 
-.. cpp:function:: add_fixed_size_variable(name, size, niter=1)
+.. cpp:function:: getfem::model::add_fixed_size_variable(name, size, niter=1)
 
    Add a variable of fixed size. ``name`` is a string which designate the
    variable. ``niter`` is the number of copy of the variable.
 
-.. cpp:function:: add_fixed_size_variable(name, sizes, niter=1)
+.. cpp:function:: getfem::model::add_fixed_size_variable(name, sizes, niter=1)
 
    Add a variable of fixed size. ``name`` is a string which designate the
    variable. ``sizes`` is a vector of dimension for matrix or tensor fixed
    size variables. ``niter`` is the number of copy of the variable.
 
-.. cpp:function:: add_fixed_size_data(name, size, niter=1)
+.. cpp:function:: getfem::model::add_fixed_size_data(name, size, niter=1)
 
    Add a data of fixed size. ``name`` is a string which designate the data.
    ``niter`` is the number of copy of the data.
 
-.. cpp:function:: add_fixed_size_data(name, sizes, niter=1)
+.. cpp:function:: getfem::model::add_fixed_size_data(name, sizes, niter=1)
 
    Add a data of fixed size. ``name`` is a string which designate the data.
    ``sizes`` is a vector of dimension for matrix or tensor fixed
    size variables. ``niter`` is the number of copy of the data.
 
-.. cpp:function:: add_initialized_fixed_size_data(name, V)
+.. cpp:function:: getfem::model::add_initialized_fixed_size_data(name, V)
 
    Add a data of fixed size initialized with the given vector ``V``. ``name`` 
is a
    string which designate the data.
 
-.. cpp:function:: add_initialized_scalar_data(name, e)
+.. cpp:function:: getfem::model::add_initialized_scalar_data(name, e)
 
    Add a data of size 1 initialized with the given scalar value ``e``. 
``name`` is
    a string which designate the data.
 
-.. cpp:function:: add_fem_variable(name, mf, niter=1)
+.. cpp:function:: getfem::model::add_fem_variable(name, mf, niter=1)
 
    Add a variable being the dofs of a finite element method ``mf``. ``name`` 
is a
    string which designate the variable. ``niter`` is the number of copy of the
    variable.
 
-.. cpp:function:: add_filtered_fem_variable(name, mf, region)
+.. cpp:function:: getfem::model::add_filtered_fem_variable(name, mf, region)
 
    Add a variable being the dofs of a finite element method ``mf`` only
    specific to a given region.
@@ -111,18 +111,18 @@ The main useful methods on a |mo| object are
    object will be used. The method ``mesh_fem_of_variable('name')`` allows to
    access to the ``partial_mesh_fem`` built. 
 
-.. cpp:function:: add_fem_data(name, mf, niter=1)
+.. cpp:function:: getfem::model::add_fem_data(name, mf, niter=1)
 
    Add a data being the dofs of a finite element method ``mf``. ``name`` is a
    string which designate the data. ``niter`` is the number of copy of the 
data.
 
-.. cpp:function:: add_initialized_fem_data(name, mf, V, niter=1)
+.. cpp:function:: getfem::model::add_initialized_fem_data(name, mf, V, niter=1)
 
    Add a data being the dofs of a finite element method ``mf`` initialized with
    the given vector ``V``. ``name`` is a string which designate the data.
    ``niter`` is the number of copy of the data.
 
-.. cpp:function:: add_multiplier(name, mf, primal_name, niter=1)
+.. cpp:function:: getfem::model::add_multiplier(name, mf, primal_name, niter=1)
 
    Add a special variable linked to the finite element method ``mf`` and being 
a
    multiplier for certain constraints (Dirichlet condition for instance) on a
@@ -136,35 +136,35 @@ 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.
 
-.. cpp:function:: real_variable(name, niter=1)
+.. cpp:function:: getfem::model::real_variable(name, niter=1)
 
    Gives the access to the vector value of a variable or data. Real version.
 
-.. cpp:function:: complex_variable(name, niter=1)
+.. cpp:function:: getfem::model::complex_variable(name, niter=1)
 
    Gives the access to the vector value of a variable or data. Complex version.
 
-.. cpp:function:: mesh_fem_of_variable(name)
+.. cpp:function:: getfem::model::mesh_fem_of_variable(name)
 
    Gives a reference on the |mf| on which the variable is defined. Throw an
    exception if this is not a fem variable.
 
-.. cpp:function:: real_tangent_matrix()
+.. cpp:function:: getfem::model::real_tangent_matrix()
 
    Gives the access to tangent matrix. Real version. A computation of the 
tangent
    system have to be done first.
 
-.. cpp:function:: complex_tangent_matrix()
+.. cpp:function:: getfem::model::complex_tangent_matrix()
 
    Gives the access to tangent matrix. Complex version. A computation of the
    tangent system have to be done first.
 
-.. cpp:function:: real_rhs()
+.. cpp:function:: getfem::model::real_rhs()
 
    Gives the access to right hand side vector of the linear system. real 
version.
    A computation of the tangent system have to be done first.
 
-.. cpp:function:: complex_rhs()
+.. cpp:function:: getfem::model::complex_rhs()
 
    Gives the access to right hand side vector of the linear system. Complex
    version. A computation of the tangent system have to be done first.