Commit 53a78a02 authored by Melanie Lipp's avatar Melanie Lipp
Browse files

[doc][doxygen] Reduce error log to what we had for release 3.3.

parent 6c561163
......@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup Common
* \copydoc Dumux::Variables
* \copydoc Dumux::Experimental::Variables
*/
#ifndef DUMUX_COMMON_VARIABLES_HH
#define DUMUX_COMMON_VARIABLES_HH
......
......@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup Flux
* \copydoc Dumux::ShallowWaterViscousMomentumFlux
* \copydoc Dumux::ShallowWaterViscousFlux
*/
#ifndef DUMUX_FLUX_SHALLOW_WATER_VISCOUS_FLUX_HH
#define DUMUX_FLUX_SHALLOW_WATER_VISCOUS_FLUX_HH
......
......@@ -954,6 +954,7 @@ namespace FluidSystems {
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of steam in a gas mixture.
*
* \param temperature temperature in \f$\mathrm{[K]}\f$
* \param pressure pressure
*
* We assume here that water is in mixture with other gaseous components.
* For pure water, use the gasViscosity function of Components::H2O.
......@@ -964,7 +965,7 @@ namespace FluidSystems {
* "Reid, R.C., Prausnitz, J.M., Poling, B.E.: The Properties of
* Gases and Liquids (1987)"
* Lucas corresponding states method
* https://www.osti.gov/scitech/biblio/6504847} \cite{reid1987}
* https://www.osti.gov/scitech/biblio/6504847} \cite reid1987
*
* For temperatures above 500 K see:
* Nagel, T. et al.: THC-Processes (2018)
......
......@@ -104,7 +104,7 @@ public:
* \brief Called before the Newton method is applied to an
* non-linear system of equations.
*
* \param u The initial solution
* \param vars The variables representing the initial solution
*/
void newtonBegin(Variables& vars) override
{
......
......@@ -334,6 +334,7 @@ public:
* Does time step control when the Newton fails to converge
* \param vars The variables object representing the current state of the
* numerical solution (primary and possibly secondary variables).
* \param timeLoop The time loop.
*/
void solve(Variables& vars, TimeLoop& timeLoop) override
{
......
......@@ -122,7 +122,7 @@ public:
/*!
* \brief Advance one time step of the given time loop
* \params vars The variables object at the current time level.
* \param vars The variables object at the current time level.
* \param t The current time level
* \param dt The time step size to be used
* \note We expect the time level in vars to correspond to the given time `t`
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment