Merge branch 'feature/doxygen-warnings-part-1' into 'master'

[doxygen] remove all sources of warnings, if easily possible

See merge request !1721

doc/doxygen/modules.txt

@@ -112,7 +112,7 @@
     /*!
      * \ingroup PorousmediumflowModels
      * \defgroup BoxDFMModel boxdfm
-     * \brief \todo
+     * \brief Vertex-centered, continuous-pressure, conforming lower-dimensional discrete-fracture model
      * \copydetails ./porousmediumflow/boxdfm/model.hh
      */
     /*!
@@ -182,7 +182,7 @@
 /* ***************** FreeflowModels ******************/
 /*!
  * \defgroup FreeflowModels Free Flow Models
- * \brief Single-phase models basing on the Navier-Stokes equation
+ * \brief Single-phase models based on the Navier-Stokes equation
  */
     /*!
      * \ingroup FreeflowModels
@@ -251,7 +251,7 @@
      */
 /*!
  * \defgroup Geomechanics Geomechanics Models
- * \brief Models for taking into account solid deformation
+ * \brief Models taking into account solid deformation
  */
     /*!
      * \ingroup Geomechanics
@@ -460,7 +460,7 @@
 /* ***************** Flux ******************/
 /*!
  * \defgroup Flux Flux
- * \brief All flux related things available in DuMu<sup>x</sup>
+ * \brief Everything flux related in DuMu<sup>x</sup>
  */
     /*!
      * \ingroup Flux
@@ -495,7 +495,7 @@
 /* ***************** Material ******************/
 /*!
  * \defgroup Material Material and Fluid Framework
- * \brief The DuMu<sup>x</sup> material and fluid framework with constitutive laws and physics
+ * \brief The material and fluid framework with constitutive laws and mixture physics
  * \par
  * Short description of the most important concepts of the material and fluid framework:
  *
@@ -700,15 +700,15 @@
 /* ***************** InputOutput ******************/
 /*!
  * \defgroup InputOutput Input Output
- * \brief Classes and functions dealing with input and output of data and grids
+ * \brief Input and output of data and grids
  */
 
 /* ***************** MultiDomain ******************/
 /*!
  * \defgroup MultiDomain Multidomain simulations
- * \brief Classes to run problems with multiple domains
+ * \brief Coupling of several regular DuMu<sup>x</sup> problems
  *
- * The multi domain module allows to couple regular DuMu<sup>x</sup> problems.
+ * The multi domain module allows coupling regular DuMu<sup>x</sup> problems.
  * Several coupling modes are currently available.
  */
     /*!

dumux/common/geometry/geometryintersection.hh

@@ -1008,7 +1008,7 @@ public:
      *  \note Algorithm based on the one from "Real-Time Collision Detection" by Christer Ericson,
      *        published by Morgan Kaufmann Publishers, (c) 2005 Elsevier Inc. (Chapter 5.3.6)
      * \param geo1/geo2 The geometries to intersect
-     * \param is If the geometries collide, is holds the corner points of
+     * \param intersection If the geometries collide, is holds the corner points of
      *        the intersection object in global coordinates.
      * \note This overload is used when point-like intersections are seeked
      */
@@ -1080,9 +1080,10 @@ public:
      *  \brief Colliding segment and convex polyhedron
      *  \note Algorithm based on the one from "Real-Time Collision Detection" by Christer Ericson,
      *        published by Morgan Kaufmann Publishers, (c) 2005 Elsevier Inc. (Chapter 5.3.6)
-     * \param geo1/geo2 The geometries to intersect
      * \param is If the geometries collide, is holds the corner points of
      *        the intersection object in global coordinates.
+     * \param a/b/c Points of triangle
+     * \param p/q Points of segment
      * \note This overload is used when point-like intersections are seeked
      */
     template<class P = Policy, std::enable_if_t<P::dimIntersection == 0, int> = 0>

dumux/common/integrate.hh

@@ -97,7 +97,7 @@ using FieldType = typename FieldTypeImpl<T>::type;
 /*!
  * \brief Integrate a grid function over a grid view
  * \param gg the grid geometry
- * \param f the grid function
+ * \param sol the solution vector
  * \param order the order of the quadrature rule
  */
 template<class GridGeometry, class SolutionVector,
@@ -127,9 +127,9 @@ auto integrateGridFunction(const GridGeometry& gg,
 
 /*!
  * \brief Integrate a function over a grid view
- * \param gv the grid view
- * \param f the first function
- * \param g the second function
+ * \param gg the grid geometry
+ * \param sol1 the first function
+ * \param sol2 the second function
  * \param order the order of the quadrature rule
  * \note dune functions currently doesn't support composing two functions
  */

dumux/discretization/evalgradients.hh

@@ -45,6 +45,7 @@ namespace Dumux {
  * \param fvGridGeometry The finite volume grid geometry
  * \param elemSol The primary variables at the dofs of the element
  * \param globalPos The global position
+ * \param ignoreState If true, the state of primary variables is ignored
  *
  * \return Dune::FieldVector with as many entries as dimension of
  *         the PrimaryVariables object (i.e. numEq). Each entry is

dumux/discretization/projection/projector.hh

@@ -125,6 +125,7 @@ public:
     /*!
      * \brief Project a solution u into up
      * \param u The solution living on the domain space
+     * \param params Optional parameters for mass matrix solve
      * \return The projection of u into the target space
      */
     template< class BlockType, std::enable_if_t<std::is_convertible<BlockType, ScalarType>::value, int> = 0 >
@@ -162,6 +163,7 @@ public:
     /*!
      * \brief Project a solution u into up
      * \param u The solution living on the domain space
+     * \param params Optional parameters for mass matrix solve
      * \return The projection of u into the target space
      */
     template< class BlockType, std::enable_if_t<!std::is_convertible<BlockType, ScalarType>::value, int> = 0 >

dumux/freeflow/navierstokes/staggered/staggeredupwindfluxvariables.hh

@@ -19,7 +19,7 @@
 /*!
  * \file
  * \ingroup NavierStokesModel
- * \copydoc Dumux::NavierStokesUpwindVariables
+ * \copydoc Dumux::StaggeredUpwindFluxVariables
  */
 #ifndef DUMUX_NAVIERSTOKES_STAGGERED_UPWINDVARIABLES_HH
 #define DUMUX_NAVIERSTOKES_STAGGERED_UPWINDVARIABLES_HH

dumux/freeflow/rans/oneeq/problem.hh

@@ -19,7 +19,7 @@
 /*!
  * \file
  * \ingroup OneEqModel
- * \copydoc Dumux::OneEqProblem
+ * \brief One-equation turbulence problem base class.
  */
 #ifndef DUMUX_ONEEQ_PROBLEM_HH
 #define DUMUX_ONEEQ_PROBLEM_HH

dumux/freeflow/rans/problem.hh

@@ -500,7 +500,7 @@ public:
     const Scalar karmanConstant() const
     { return 0.41; }
 
-    //! \brief Returns the \$f \beta_{\omega} \$f constant
+    //! \brief Returns the \f$ \beta_{\omega} \f$ constant
     const Scalar betaOmega() const
     {
         return 0.0708;

dumux/freeflow/rans/twoeq/kepsilon/problem.hh

@@ -19,7 +19,7 @@
 /*!
  * \file
  * \ingroup KEpsilonModel
- * \copydoc Dumux::KEpsilonProblem
+ * \brief K-epsilon turbulence problem base class.
  */
 #ifndef DUMUX_KEPSILON_PROBLEM_HH
 #define DUMUX_KEPSILON_PROBLEM_HH

dumux/freeflow/rans/twoeq/komega/problem.hh

@@ -19,7 +19,7 @@
 /*!
  * \file
  * \ingroup KOmegaModel
- * \copydoc Dumux::KOmegaProblem
+ * \brief K-Omega turbulence model problem base class.
  */
 #ifndef DUMUX_KOMEGA_PROBLEM_HH
 #define DUMUX_KOMEGA_PROBLEM_HH

dumux/freeflow/rans/twoeq/lowrekepsilon/problem.hh

@@ -19,7 +19,7 @@
 /*!
  * \file
  * \ingroup LowReKEpsilonModel
- * \copydoc Dumux::LowReKEpsilonProblem
+ * \brief Low-Re k-epsilon turbulence problem base class.
  */
 #ifndef DUMUX_LOWREKEPSILON_PROBLEM_HH
 #define DUMUX_LOWREKEPSILON_PROBLEM_HH

dumux/freeflow/rans/zeroeq/problem.hh

@@ -19,7 +19,7 @@
 /*!
  * \file
  * \ingroup ZeroEqModel
- * \copydoc Dumux::ZeroEqProblem
+ * \brief Zero-equation turbulence problem base class.
  */
 #ifndef DUMUX_ZEROEQ_PROBLEM_HH
 #define DUMUX_ZEROEQ_PROBLEM_HH

dumux/freeflow/staggeredupwindmethods.hh

@@ -38,7 +38,7 @@ enum class TvdApproach
     none, uniform, li, hou
 };
 
-//! \biraf Available differencing schemes
+//! \brief Available differencing schemes
 enum class DifferencingScheme
 {
     none, vanleer, vanalbada, minmod, superbee, umist, mclimiter, wahyd

dumux/io/container.hh

@@ -40,6 +40,7 @@ namespace Dumux {
  * \brief Writes a container to file
  * \param v The container, requires begin() and end() method
  * \param filename The filename to write to
+ * \param floatPrecision The total number of digits stored, including decimal
  *
  * usage: std::vector<double> v(5, 0.0); writeContainerToFile(v, "myvector.txt");
  */

dumux/io/vtk/vtkreader.hh

@@ -117,6 +117,7 @@ public:
      * \brief Read a grid from a vtk/vtu/vtp file, ignoring cell and point data
      * \note use this signature if the factory might be needed outside to interpret the data via the factory's insertion indices
      * \param verbose if the output should be verbose
+     * \param factory the (emtpy) grid factory
      */
     template<class Grid>
     std::unique_ptr<Grid> readGrid(Dune::GridFactory<Grid>& factory, bool verbose = false) const

dumux/material/components/simpleh2o.hh

@@ -308,11 +308,8 @@ public:
 
     /*!
      * \brief Specific isobaric heat capacity of the component \f$\mathrm{[J/(kg*K)]}\f$ as a liquid.
-     *
-     *        \param temperature temperature of component in \f$\mathrm{[K]}\f$
-     *        \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
-     *        source: http://webbook.nist.gov/cgi/fluid.cgi?ID=C7732185&Action=Page
-     *        @ T= 281.15K (8°C) , p=0.1MPa)
+     * source: http://webbook.nist.gov/cgi/fluid.cgi?ID=C7732185&Action=Page
+     * @ T= 281.15K (8°C) , p=0.1MPa)
      * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
      * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
      */

dumux/material/fluidsystems/brineair.hh

@@ -336,6 +336,7 @@ public:
             H2O::init(tempMin, tempMax, nTemp, pressMin, pressMax, nPress);
     }
 
+    using Base::density;
     /*!
      * \brief Given a phase's composition, temperature, pressure, and
      *        the partial pressures of all components, return its
@@ -349,7 +350,6 @@ public:
      * - cited by: Bachu & Adams (2002)
      *   "Equations of State for basin geofluids" \cite adams2002
      */
-    using Base::density;
     template <class FluidState>
     static Scalar density(const FluidState &fluidState, int phaseIdx)
     {
@@ -386,6 +386,7 @@ public:
             DUNE_THROW(Dune::InvalidStateException, "Invalid phase index " << phaseIdx);
     }
 
+    using Base::molarDensity;
     /*!
      * \brief The molar density \f$\rho_{mol,\alpha}\f$
      *   of a fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
@@ -395,7 +396,6 @@ public:
      *
      * \f[\rho_{mol,\alpha} = \frac{\rho_\alpha}{\overline M_\alpha} \;.\f]
      */
-    using Base::molarDensity;
     template <class FluidState>
     static Scalar molarDensity(const FluidState& fluidState, int phaseIdx)
     {
@@ -418,6 +418,7 @@ public:
             DUNE_THROW(Dune::InvalidStateException, "Invalid phase index " << phaseIdx);
     }
 
+    using Base::viscosity;
     /*!
      * \brief Calculate the dynamic viscosity of a fluid phase \f$\mathrm{[Pa*s]}\f$
      *
@@ -428,7 +429,6 @@ public:
      *       component is neglected. This contribution is probably not big, but somebody
      *       would have to find out its influence.
      */
-    using Base::viscosity;
     template <class FluidState>
     static Scalar viscosity(const FluidState& fluidState, int phaseIdx)
     {
@@ -440,6 +440,7 @@ public:
             return Air::gasViscosity(fluidState.temperature(phaseIdx), fluidState.pressure(phaseIdx));
     }
 
+    using Base::fugacityCoefficient;
     /*!
      * \brief Returns the fugacity coefficient \f$\mathrm{[-]}\f$ of a component in a
      *        phase.
@@ -461,7 +462,6 @@ public:
      * Henry constant for the solutes and the saturated vapor pressure
      * both divided by phase pressure.
      */
-    using Base::fugacityCoefficient;
     template <class FluidState>
     static Scalar fugacityCoefficient(const FluidState& fluidState, int phaseIdx, int compIdx)
     {
@@ -505,6 +505,7 @@ public:
         DUNE_THROW(Dune::NotImplemented, "Diffusion coefficients");
     }
 
+    using Base::binaryDiffusionCoefficient;
     /*!
      * \brief Given a phase's composition, temperature and pressure,
      *        return the binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for components
@@ -515,7 +516,6 @@ public:
      * \param compIIdx The index of the first component to consider
      * \param compJIdx The index of the second component to consider
      */
-    using Base::binaryDiffusionCoefficient;
     template <class FluidState>
     static Scalar binaryDiffusionCoefficient(const FluidState& fluidState,
                                              int phaseIdx,
@@ -563,6 +563,7 @@ public:
         DUNE_THROW(Dune::InvalidStateException, "Invalid phase index " << phaseIdx);
     }
 
+    using Base::enthalpy;
     /*!
      * \brief Given a phase's composition, temperature and pressure,
      *        return its specific enthalpy \f$\mathrm{[J/kg]}\f$.
@@ -582,7 +583,6 @@ public:
      *       is neglected. This contribution is probably not big. Somebody would have to
      *       find out the enthalpy of solution for this system. ...
      */
-    using Base::enthalpy;
     template <class FluidState>
     static Scalar enthalpy(const FluidState& fluidState, int phaseIdx)
     {
@@ -637,6 +637,7 @@ public:
         DUNE_THROW(Dune::InvalidStateException, "Invalid phase index " << phaseIdx);
     }
 
+    using Base::thermalConductivity;
     /*!
      * \brief Thermal conductivity of a fluid phase \f$\mathrm{[W/(m K)]}\f$.
      * \param fluidState An abitrary fluid state
@@ -646,7 +647,6 @@ public:
      *       components is neglected. This contribution is probably not big, but somebody
      *       would have to find out its influence.
      */
-    using Base::thermalConductivity;
     template <class FluidState>
     static Scalar thermalConductivity(const FluidState& fluidState, int phaseIdx)
     {

dumux/multidomain/facet/gridmanager.hh

@@ -245,8 +245,8 @@ public:
      * \param gridFactoryPtr shared pointer to this (id-th) grid factory
      * \param embeddedEntityMap map containing the lower-dimensional entities for this grid's elements
      * \param adjoinedEntityMap map containing the (d+1)-dimensional elements in which this grid's elements are embedded in
-     * \param lowDimGridVertexIndices the hierachy's insertion indices that make up this grid
-     *                                (only necessary for lower-dimensional grids)
+     * \param gridVertexIndices The hierachy's insertion indices that make up this grid
+     * \param numVerticesInHierarchy Total number of vertices in entire grid hierarchy
      */
     template<std::size_t id>
     void setData( std::shared_ptr<Grid<id>> gridPtr,

dumux/nonlinear/newtonconvergencewriter.hh

@@ -62,9 +62,8 @@ class NewtonConvergenceWriter : public ConvergenceWriterInterface<SolutionVector
 public:
     /*!
      * \brief Constructor
-     * \param gridView the grid view we are solving on
-     * \param size the size of the solution data
-     * \param name base name of the vtk output
+     * \param fvGridGeometry The finite-volume grid geometry
+     * \param name Base name of the vtk output
      */
     NewtonConvergenceWriter(const FVGridGeometry& fvGridGeometry,
                             const std::string& name = "newton_convergence")

dumux/porousmediumflow/2p2c/sequential/fvpressure.hh

@@ -897,7 +897,7 @@ void FVPressure2P2C<TypeTag>::getFluxOnBoundary(Dune::FieldVector<Scalar, 2>& en
  * primary variables. In case the method is called after the Transport,
  * i.e. at the end / post time step, CellData2p2c.reset() resets the volume
  * derivatives for the next time step.
- * \param elementI The element
+ * \param element The element
  * \param postTimeStep Flag indicating if we have just completed a time step
  */
 template<class TypeTag>