[doxygen] Fix doxygen errors in multidomain folders

3ce10edb · Sina Ackermann · Simon Scholz · 1d3dc55f · 3ce10edb · 3ce10edb
Commit 3ce10edb authored Nov 28, 2018 by Sina Ackermann Committed by Simon Scholz Nov 30, 2018
--- a/dumux/multidomain/boundary/darcydarcy/couplingmanager.hh
+++ b/dumux/multidomain/boundary/darcydarcy/couplingmanager.hh
@@ -110,7 +110,7 @@ public:
     *        that couple with / influence the element residual of the given element of domain i
     *
     * \param domainI the domain index of domain i
-     * \param elementI the coupled element of domain í
+     * \param element the coupled element of domain í
     * \param domainJ the domain index of domain j
     */
    template<std::size_t i, std::size_t j>

--- a/dumux/multidomain/boundary/darcydarcy/couplingmapper.hh
+++ b/dumux/multidomain/boundary/darcydarcy/couplingmapper.hh
@@ -162,7 +162,7 @@ public:
     *        that couple with / influence the element residual of the given element of domain i
     *
     * \param domainI the domain index of domain i
-     * \param elementI the coupled element of domain í
+     * \param eIdxI the index of the coupled element of domain í
     * \param domainJ the domain index of domain j
     *
     * \note  The element residual definition depends on the discretization scheme of domain i

--- a/dumux/multidomain/embedded/couplingmanagerbase.hh
+++ b/dumux/multidomain/embedded/couplingmanagerbase.hh
@@ -160,7 +160,7 @@ public:
     *        that couple with / influence the element residual of the given element of domain i
     *
     * \param domainI the domain index of domain i
-     * \param elementI the coupled element of domain í
+     * \param element the coupled element of domain í
     * \param domainJ the domain index of domain j
     *
     * \note  The element residual definition depends on the discretization scheme of domain i

--- a/dumux/multidomain/facet/box/fvgridgeometry.hh
+++ b/dumux/multidomain/facet/box/fvgridgeometry.hh
@@ -154,7 +154,7 @@ public:
     * \param facetGridView The grid view of a (dim-1)-dimensional grid conforming
     *                      with the facets of this grid view, indicating on which facets
     *                      nodal dofs should be enriched.
-     * \param CodimOneGridAdapter Adapter class that allows access to information on the d-
+     * \param codimOneGridAdapter Adapter class that allows access to information on the d-
     *                            dimensional grid for entities of the (d-1)-dimensional grid
     * \param verbose Verbosity level for vertex enrichment
     */
@@ -409,7 +409,7 @@ public:
     * \param facetGridView The grid view of a (dim-1)-dimensional grid conforming
     *                      with the facets of this grid view, indicating on which facets
     *                      nodal dofs should be enriched.
-     * \param CodimOneGridAdapter Adapter class that allows access to information on the d-
+     * \param codimOneGridAdapter Adapter class that allows access to information on the d-
     *                            dimensional grid for entities of the (d-1)-dimensional grid
     * \param verbose Verbosity level
     */

--- a/dumux/multidomain/facet/couplingmanager.hh
+++ b/dumux/multidomain/facet/couplingmanager.hh
@@ -157,7 +157,7 @@ public:
     * \param facetProblem The problem to be solved on the (2d) facet domain
     * \param edgeProblem The problem to be solved on the (1d) edge domain
     * \param couplingMapper The mapper object containing the connectivity between the domains
-     * \tparam curSol The current solution
+     * \param curSol The current solution
     */
    void init(std::shared_ptr< Problem<bulkId> > bulkProblem,
              std::shared_ptr< Problem<facetId> > facetProblem,

--- a/dumux/multidomain/facet/couplingmapperbase.hh
+++ b/dumux/multidomain/facet/couplingmapperbase.hh
@@ -167,7 +167,7 @@ protected:
     * \param bulkFvGridGeometry The finite-volume grid geometry of the bulk grid
     * \param lowDimFvGridGeometry The finite-volume grid geometry of the lower-dimensional grid
     * \param embeddings Class that contains the embedments and allows obtaining entity insertion indices
-     * \param AddCouplingEntryPolicy Policy for adding coupling entries starting from a lower-dimensional
+     * \param addCouplingEntryPolicy Policy for adding coupling entries starting from a lower-dimensional
     *                               element and corresponding adjoined higher-dimensional entity indices
     */
    template< class Embeddings, typename AddCouplingEntryPolicy >

--- a/dumux/multidomain/facet/gmshreader.hh
+++ b/dumux/multidomain/facet/gmshreader.hh
@@ -17,7 +17,7 @@
 /*!
 * \file
 * \ingroup FacetCoupling
- * \copydoc Dumux::FacetCouplingGmshReader.
+ * \copydoc Dumux::FacetCouplingGmshReader
 */
 #ifndef DUMUX_FACETCOUPLING_GMSH_READER_HH
 #define DUMUX_FACETCOUPLING_GMSH_READER_HH

--- a/dumux/multidomain/newtonsolver.hh
+++ b/dumux/multidomain/newtonsolver.hh
@@ -129,7 +129,6 @@ public:
    /*!
     * \brief Indicates that one Newton iteration was finished.
     *
-     * \param assembler The jacobian assembler
     * \param uCurrentIter The solution after the current Newton iteration
     * \param uLastIter The solution at the beginning of the current Newton iteration
     */

--- a/dumux/multidomain/staggeredcouplingmanager.hh
+++ b/dumux/multidomain/staggeredcouplingmanager.hh
@@ -66,7 +66,7 @@ public:
    static constexpr auto faceIdx = Dune::index_constant<1>();

    /*!
-     * \copydoc CouplingManager::updateCouplingContext
+     * \copydoc Dumux::CouplingManager::updateCouplingContext()
     */
    template<std::size_t i, std::size_t j, class LocalAssemblerI, class PriVarsJ>
    void updateCouplingContext(Dune::index_constant<i> domainI,
@@ -144,7 +144,7 @@ public:
    }

    /*!
-     * \copydoc ParentType::evalCouplingResidual
+     * \copydoc Dumux::CouplingManager::evalCouplingResidual()
     *
     * \note this is a specialization for calculating the coupled residual for cellcentered dofs
     *       w.r.t. staggered face dof changes

--- a/dumux/multidomain/subdomainstaggeredlocalassembler.hh
+++ b/dumux/multidomain/subdomainstaggeredlocalassembler.hh
@@ -197,7 +197,7 @@ public:
     *        of the local residual for the current element.
     *
     * \param elemVolVars The element volume variables
-     * \param elemVolVars The element face variables
+     * \param elemFaceVars The element face variables
     */
    CellCenterResidualValue evalLocalFluxAndSourceResidualForCellCenter(const ElementVolumeVariables& elemVolVars, const ElementFaceVariables& elemFaceVars) const
    {

--- a/test/multidomain/boundary/darcydarcy/1p_1p/problem.hh
+++ b/test/multidomain/boundary/darcydarcy/1p_1p/problem.hh
@@ -132,7 +132,6 @@ public:
     * \brief Evaluate the boundary conditions for a dirichlet
     *        control volume.
     *
-     * \param values The dirichlet values for the primary variables
     * \param globalPos The center of the finite volume which ought to be set.
     *
     * For this method, the \a values parameter stores primary variables.

--- a/test/multidomain/boundary/darcydarcy/1p_2p/problem.hh
+++ b/test/multidomain/boundary/darcydarcy/1p_2p/problem.hh
@@ -127,7 +127,6 @@ public:
     * \brief Evaluate the boundary conditions for a dirichlet
     *        control volume.
     *
-     * \param values The dirichlet values for the primary variables
     * \param globalPos The center of the finite volume which ought to be set.
     *
     * For this method, the \a values parameter stores primary variables.

--- a/test/multidomain/boundary/darcydarcy/1p_2p/spatialparams.hh
+++ b/test/multidomain/boundary/darcydarcy/1p_2p/spatialparams.hh
@@ -85,11 +85,8 @@ public:

    /*!
     * \brief Returns the parameter object for the Brooks-Corey material law.
-     *        In this test, we use element-wise distributed material parameters.
     *
-     * \param element The current element
-     * \param scv The sub-control volume inside the element.
-     * \param elemSol The solution at the dofs connected to the element.
+     * In this test, we use element-wise distributed material parameters.
     * \return the material parameters object
     */
    const MaterialLawParams& materialLawParamsAtPos(const GlobalPosition& globalPos) const

--- a/test/multidomain/boundary/stokesdarcy/1p2c_1p2c/diffusionlawcomparison/problem_darcy.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p2c_1p2c/diffusionlawcomparison/problem_darcy.hh
@@ -190,7 +190,7 @@ public:
     * \brief Evaluate the boundary conditions for a Neumann control volume.
     *
     * \param element The element for which the Neumann boundary condition is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param scvf The boundary sub control volume face
     *
@@ -221,7 +221,7 @@ public:
     *        sub-control-volume.
     *
     * \param element The element for which the source term is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param scv The subcontrolvolume
     */

--- a/test/multidomain/boundary/stokesdarcy/1p2c_1p2c/diffusionlawcomparison/problem_stokes.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p2c_1p2c/diffusionlawcomparison/problem_stokes.hh
@@ -195,9 +195,6 @@ public:

    /*!
     * \brief Evaluate the boundary conditions for a Dirichlet control volume.
-     *
-     * \param element The element
-     * \param scvf The sub control volume face
     */
    PrimaryVariables dirichletAtPos(const GlobalPosition& globalPos) const
    {
@@ -215,7 +212,7 @@ public:
     * \brief Evaluate the boundary conditions for a Neumann control volume.
     *
     * \param element The element for which the Neumann boundary condition is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param elemFaceVars The element face variables
     * \param scvf The boundary sub control volume face

--- a/test/multidomain/boundary/stokesdarcy/1p2c_1p2c/problem_darcy.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p2c_1p2c/problem_darcy.hh
@@ -204,7 +204,7 @@ public:
     * \brief Evaluate the boundary conditions for a Neumann control volume.
     *
     * \param element The element for which the Neumann boundary condition is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param scvf The boundary sub control volume face
     *
@@ -235,7 +235,7 @@ public:
     *        sub-control-volume.
     *
     * \param element The element for which the source term is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param scv The subcontrolvolume
     */

--- a/test/multidomain/boundary/stokesdarcy/1p2c_1p2c/problem_stokes.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p2c_1p2c/problem_stokes.hh
@@ -218,9 +218,6 @@ public:

    /*!
     * \brief Evaluate the boundary conditions for a Dirichlet control volume.
-     *
-     * \param element The element
-     * \param scvf The sub control volume face
     */
    PrimaryVariables dirichletAtPos(const GlobalPosition& globalPos) const
    {
@@ -266,7 +263,7 @@ public:
     * \brief Evaluate the boundary conditions for a Neumann control volume.
     *
     * \param element The element for which the Neumann boundary condition is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param elemFaceVars The element face variables
     * \param scvf The boundary sub control volume face

--- a/test/multidomain/boundary/stokesdarcy/1p2c_2p2c/problem_darcy.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p2c_2p2c/problem_darcy.hh
@@ -247,7 +247,7 @@ public:
     *        control volume.
     *
     * \param element The element for which the Neumann boundary condition is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param scvf The boundary sub control volume face
     *
@@ -287,7 +287,7 @@ public:
     *        sub-control-volume.
     *
     * \param element The element for which the source term is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param scv The subcontrolvolume
     *

--- a/test/multidomain/boundary/stokesdarcy/1p2c_2p2c/problem_stokes.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p2c_2p2c/problem_stokes.hh
@@ -216,9 +216,6 @@ public:

    /*!
     * \brief Evaluate the boundary conditions for a Dirichlet control volume.
-     *
-     * \param element The element
-     * \param scvf The subcontrolvolume face
     */
    PrimaryVariables dirichletAtPos(const GlobalPosition& pos) const
    {
@@ -232,7 +229,7 @@ public:
     * \brief Evaluate the boundary conditions for a Neumann control volume.
     *
     * \param element The element for which the Neumann boundary condition is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param elemFaceVars The element face variables
     * \param scvf The boundary sub control volume face

--- a/test/multidomain/boundary/stokesdarcy/1p3c_1p3c/problem_darcy.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p3c_1p3c/problem_darcy.hh
@@ -186,7 +186,7 @@ public:
     * \brief Evaluate the boundary conditions for a Neumann control volume.
     *
     * \param element The element for which the Neumann boundary condition is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param scvf The boundary sub control volume face
     *
@@ -217,7 +217,7 @@ public:
     *        sub-control-volume.
     *
     * \param element The element for which the source term is set
-     * \param fvGeomentry The fvGeometry
+     * \param fvGeometry The fvGeometry
     * \param elemVolVars The element volume variables
     * \param scv The subcontrolvolume
     */
@@ -233,8 +233,6 @@ public:
    /*!
     * \brief Evaluate the initial value for a control volume.
     *
-     * \param element The element
-     *
     * For this method, the \a priVars parameter stores primary
     * variables.
     */