Commit f3b086d4 authored by Sina Ackermann's avatar Sina Ackermann Committed by Simon Emmert

[doxygen] Fix more typos, blank spaces, etc. in tests folders

parent 86fdd52a
......@@ -107,7 +107,7 @@ int main(int argc, char** argv) try
auto gridVariables = std::make_shared<GridVariables>(problem, fvGridGeometry);
gridVariables->init(x);
// intialize the vtk output module
// initialize the vtk output module
StaggeredVtkOutputModule<GridVariables, SolutionVector> vtkWriter(*gridVariables, x, problem->name());
using IOFields = GetPropType<TypeTag, Properties::IOFields>;
IOFields::initOutputModule(vtkWriter); //!< Add model specific output fields
......
......@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup NavierStokesTests
* \brief Test for the staggered grid (Navier-)Stokes model with analytical solution (Donea et al., 2003)
* \brief Test for the staggered grid (Navier-)Stokes model with analytical solution (Donea 2003, \cite Donea2003).
*/
#ifndef DUMUX_DONEA_TEST_PROBLEM_HH
#define DUMUX_DONEA_TEST_PROBLEM_HH
......@@ -79,8 +79,11 @@ struct EnableGridFaceVariablesCache<TypeTag, TTag::DoneaTest> { static constexpr
/*!
* \ingroup NavierStokesTests
* \brief Test problem for the staggered grid (Donea et al., 2003)
* \todo doc me!
* \brief Test problem for the staggered grid (Donea 2003, \cite Donea2003).
*
* A two-dimensional Stokes flow in a square domain is considered.
* With the source terms as given in Donea 2003 \cite Donea2003, an analytical solution
* is available and can be compared to the numerical solution.
*/
template <class TypeTag>
class DoneaTestProblem : public NavierStokesProblem<TypeTag>
......@@ -244,7 +247,7 @@ public:
// \{
/*!
* \brief Evaluate the initial value for a control volume.
* \brief Evaluates the initial value for a control volume.
*
* \param globalPos The global position
*/
......@@ -327,6 +330,6 @@ private:
std::vector<VelocityVector> analyticalVelocity_;
std::vector<VelocityVector> analyticalVelocityOnFace_;
};
} //end namespace
} // end namespace Dumux
#endif
......@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup NavierStokesTests
* \brief Test for the staggered grid Navier-Stokes model with analytical solution (Kovasznay 1947).
* \brief Test for the staggered grid Navier-Stokes model with analytical solution (Kovasznay 1948, \cite Kovasznay1948)
*/
#ifndef DUMUX_KOVASZNAY_TEST_PROBLEM_HH
......@@ -72,8 +72,11 @@ struct EnableGridVolumeVariablesCache<TypeTag, TTag::KovasznayTest> { static con
/*!
* \ingroup NavierStokesTests
* \brief Test problem for the staggered grid (Kovasznay 1947)
* \todo doc me!
* \brief Test problem for the staggered grid (Kovasznay 1948, \cite Kovasznay1948)
*
* A two-dimensional Navier-Stokes flow with a periodicity in one direction
* is considered. The set-up represents a wake behind a two-dimensional grid
* and is chosen in a way such that an exact solution is available.
*/
template <class TypeTag>
class KovasznayTestProblem : public NavierStokesProblem<TypeTag>
......
......@@ -97,8 +97,12 @@ struct UseMoles<TypeTag, TTag::ChannelNCTest> { static constexpr bool value = tr
/*!
* \ingroup NavierStokesNCTests
* \brief Test problem for the one-phase model.
* \todo doc me!
* \brief Test problem for the one-phase (Navier-)Stokes model.
*
* Flow from left to right in a channel is considered. A parabolic velocity
* profile is set at the left boundary, while the pressure is set to
* a fixed value on the right boundary. The top and bottom boundaries
* represent solid walls with no-slip/no-flow conditions.
*/
template <class TypeTag>
class ChannelNCTestProblem : public NavierStokesProblem<TypeTag>
......
......@@ -87,7 +87,7 @@ struct UseMoles<TypeTag, TTag::DensityDrivenFlow> { static constexpr bool value
* Here, a quadratic two-dimensional domain with closed and non-moving walls at
* all sides is considered. Initially, the domain is filled with pure water.
* At the top, a fixed concentration of the air component is set.
* The air slowly dissolves in the water which leads to an local increase of density.
* The air slowly dissolves in the water which leads to a local increase of density.
* Due to the influence of gravity and
* small numerical instabilities, fingers of denser water will form and sink downwards.
*/
......
......@@ -196,7 +196,7 @@ public:
template<class TypeTag>
struct FluidSystem<TypeTag, TTag::MaxwellStefanNCTest> { using type = MaxwellStefanFluidSystem<TypeTag>; };
} //end namespace Properties
} // end namespace Properties
/*!
* \ingroup NavierStokesNCTests
......
......@@ -33,7 +33,11 @@ namespace Dumux {
/*!
* \ingroup OnePTests
* \brief Multidomain test problem for the incompressible one-phase model
* \todo doc me!
*
* The circular model domain consists of two subdomains:
* an inner circle and an outer ring.
* Methane is injected in the center and spreads over the
* coupling boundary into the outer domain.
*/
template<class TypeTag, std::size_t tag>
class OnePTestProblem
......
......@@ -283,8 +283,8 @@ public:
*/
// \{
/*!
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
* \brief Evaluates the source term for all phases within a given
* sub control volume.
*
* \param element The element for which the source term is set
* \param fvGeometry The fvGeometry
......
......@@ -200,8 +200,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a Neumann
* control volume.
* \brief Evaluates the boundary conditions for a Neumann control volume.
*
* \param element The element for which the Neumann boundary condition is set
* \param fvGeometry The fvGeometry
......
......@@ -162,7 +162,7 @@ public:
Scalar extrusionFactorAtPos(const GlobalPosition& globalPos) const
{ return aperture_; }
//! evaluate the initial conditions
//! Evaluates the initial conditions.
PrimaryVariables initialAtPos(const GlobalPosition& globalPos) const
{ return PrimaryVariables(1.0); }
......
......@@ -149,7 +149,7 @@ public:
const SubControlVolumeFace& scvf) const
{ return NumEqVector(0.0); }
//! evaluate the initial conditions
//! Evaluates the initial conditions.
PrimaryVariables initialAtPos(const GlobalPosition& globalPos) const
{
const auto g = this->gravityAtPos(globalPos)[dimWorld-1];
......
......@@ -149,7 +149,7 @@ public:
Scalar extrusionFactorAtPos(const GlobalPosition& globalPos) const
{ return aperture_; }
//! evaluate the initial conditions
//! Evaluates the initial conditions.
PrimaryVariables initialAtPos(const GlobalPosition& globalPos) const
{ return PrimaryVariables(1.0e5); }
......
......@@ -66,7 +66,7 @@ public:
* \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$.
*
* \param element The element
* \param scv The sub control volume
* \param scv The sub-control volume
* \param elemSol The element solution vector
* \return The intrinsic permeability
*/
......
......@@ -66,7 +66,7 @@ public:
* \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$.
*
* \param element The element
* \param scv The sub control volume
* \param scv The sub-control volume
* \param elemSol The element solution vector
* \return The intrinsic permeability
*/
......
......@@ -229,6 +229,6 @@ private:
std::string name_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -68,7 +68,7 @@ public:
* \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$.
*
* \param element The element
* \param scv The sub control volume
* \param scv The sub-control volume
* \param elemSol The element solution vector
* \return The intrinsic permeability
*/
......
......@@ -233,6 +233,6 @@ private:
static constexpr Scalar eps_ = 1.0e-6;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -81,7 +81,7 @@ public:
* \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$.
*
* \param element The element
* \param scv The sub control volume
* \param scv The sub-control volume
* \param elemSol The element solution vector
* \return The intrinsic permeability
*/
......
......@@ -246,7 +246,7 @@ public:
/*!
* \brief Evaluates the source term for all phases within a given
* sub-control-volume.
* sub-control volume.
*
* This is the method for the case where the source term is
* potentially solution dependent and requires some quantities that
......@@ -255,10 +255,10 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
* \param scv The sub control volume
* \param scv The sub-control volume
*
* For this method, the \a values parameter stores the conserved quantity rate
* generated or annihilate per volume unit. Positive values mean
* generated or annihilated per volume unit. Positive values mean
* that the conserved quantity is created, negative ones mean that it vanishes.
* E.g. for the mass balance that would be a mass rate in \f$ [ kg / (m^3 \cdot s)] \f$.
*/
......@@ -356,6 +356,6 @@ private:
typename Dune::PQkLocalFiniteElementCache<Scalar, Scalar, dim, 1> feCache_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -67,7 +67,7 @@ public:
* \brief Returns the radius of the circular pipe for the current
* sub-control volume in [m].
*
* \param scv The sub control volume
* \param scv The sub-control volume
*/
Scalar radius(const SubControlVolume &scv) const
{
......@@ -81,7 +81,7 @@ public:
* \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$.
*
* \param element The element
* \param scv The sub control volume
* \param scv The sub-control volume
* \param elemSol The element solution vector
* \return The intrinsic permeability
*/
......
......@@ -286,6 +286,6 @@ private:
std::vector<Scalar> temperatureExact_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif // DUMUX_1PNI_CONDUCTION_PROBLEM_HH
......@@ -333,6 +333,6 @@ private:
std::vector<Scalar> temperatureExact_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif // DUMUX_1PNI_CONVECTION_PROBLEM_HH
......@@ -67,7 +67,7 @@ public:
* \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$.
*
* \param element The element
* \param scv The sub control volume
* \param scv The sub-control volume
* \param elemSol The element solution vector
* \return the intrinsic permeability
*/
......
......@@ -64,7 +64,7 @@ public:
* \brief Returns the intrinsic permeability for the current sub-control volume in [m^2].
*
* \param element The element
* \param scv The sub control volume
* \param scv The sub-control volume
* \param elemSol The element solution vector
* \return the intrinsic permeability
*/
......
......@@ -124,6 +124,6 @@ private:
Scalar time_ = 0.0;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -215,6 +215,6 @@ private:
std::string name_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -241,7 +241,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
* \param scvf The sub control volume face
* \param scvf The sub-control volume face
*
* For this method, the \a values parameter stores the flux
* in normal direction of each phase. Negative values mean influx.
......@@ -330,20 +330,20 @@ public:
/*!
* \brief Evaluates the source term for all phases within a given
* sub control volume.
* sub-control volume.
*
* For this method, the \a priVars parameter stores the rate mass
* of a component is generated or annihilated per volume
* unit. Positive values mean that mass is created, negative ones
* mean that it vanishes.
*
* The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s))
* The units must be according to either using mole or mass fractions (mole/(m^3*s) or kg/(m^3*s)).
*/
NumEqVector sourceAtPos(const GlobalPosition &globalPos) const
{ return NumEqVector(0.0); }
/*!
* \brief Evaluate the initial value for a control volume.
* \brief Evaluates the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
*
......@@ -368,6 +368,6 @@ private:
bool useNitscheTypeBc_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -191,6 +191,6 @@ private:
static constexpr Scalar eps_ = 1e-6;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -289,14 +289,14 @@ public:
/*!
* \brief Evaluates the source term for all phases within a given
* sub control volume.
* sub-control volume.
*
* For this method, the \a priVars parameter stores the rate mass
* of a component is generated or annihilated per volume
* unit. Positive values mean that mass is created, negative ones
* mean that it vanishes.
*
* The units must be according to either using mole or mass fractions. (mole/(m^3*s) or kg/(m^3*s))
* The units must be according to either using mole or mass fractions (mole/(m^3*s) or kg/(m^3*s)).
*/
NumEqVector sourceAtPos(const GlobalPosition &globalPos) const
{ return NumEqVector(0.0); }
......@@ -329,6 +329,6 @@ private:
std::vector<Scalar> temperatureExact_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -287,7 +287,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* This is the method for the case where the Neumann condition is
* potentially solution dependent and requires some quantities that
......@@ -296,7 +296,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
* \param scvf The sub control volume face
* \param scvf The sub-control volume face
*
* For this method, the \a values parameter stores the flux
* in normal direction of each phase. Negative values mean influx.
......@@ -332,7 +332,7 @@ public:
/*!
* \brief Evaluates the source term for all phases within a given
* sub control volume.
* sub-control volume.
*
* For this method, the \a priVars parameter stores the rate mass
* of a component is generated or annihilated per volume
......@@ -377,6 +377,6 @@ private:
std::vector<Scalar> temperatureExact_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -255,7 +255,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
* \param scvf The sub control volume face
* \param scvf The sub-control volume face
*
* For this method, the \a values parameter stores the flux
* in normal direction of each phase. Negative values mean influx.
......@@ -278,7 +278,7 @@ public:
/*!
* \brief Evaluates the source term for all phases within a given
* sub control volume.
* sub-control volume.
*
* For this method, the \a priVars parameter stores the rate mass
* of a component is generated or annihilated per volume
......@@ -336,6 +336,6 @@ private:
Scalar time_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -223,7 +223,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
* \param scvf The sub control volume face
* \param scvf The sub-control volume face
*
* For this method, the \a values parameter stores the flux
* in normal direction of each phase. Negative values mean influx.
......@@ -258,7 +258,7 @@ public:
/*!
* \brief Evaluates the source term for all phases within a given
* sub control volume.
* sub-control volume.
*
* For this method, the \a priVars parameter stores the rate mass
* of a component is generated or annihilated per volume
......@@ -299,6 +299,6 @@ private:
Scalar darcyVelocity_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -29,8 +29,7 @@
#include <dumux/material/components/cao.hh>
namespace Dumux
{
namespace Dumux {
namespace Components {
/*!
* \ingroup OnePNCMinTests
......@@ -55,7 +54,7 @@ public:
}
};
} //end namespace components
} // end namespace
} // end namespace Components
} // end namespace Dumux
#endif
......@@ -411,6 +411,6 @@ private:
Scalar timeStepSize_;
};
} //end namespace
} // end namespace Dumux
#endif
......@@ -83,6 +83,6 @@ private:
Scalar eps_;
};
}//end namespace
} // end namespace Dumux
#endif
......@@ -64,6 +64,6 @@ public:
}
};
} //end namespace
} // end namespace Dumux
#endif
......@@ -92,6 +92,6 @@ private:
std::vector<PrimaryVariables> initialValues_;
};
} //end namespace
} // end namespace Dumux
#endif
......@@ -197,7 +197,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* \param globalPos The position of the integration point of the boundary segment.
*
......
......@@ -131,7 +131,7 @@ public:
* used for which equation on a given boundary segment.
*
* \param element The finite element
* \param scvf The sub control volume face
* \param scvf The sub-control volume face
*/
BoundaryTypes boundaryTypes(const Element &element,
const SubControlVolumeFace &scvf) const
......@@ -163,7 +163,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* \param values Stores the Neumann values for the conservation equations in
* \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
......
......@@ -203,7 +203,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* \param globalPos The position of the integration point of the boundary segment.
*
......@@ -245,6 +245,6 @@ private:
std::string name_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -178,7 +178,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* \param globalPos The position of the integration point of the boundary segment.
*
......
......@@ -306,6 +306,6 @@ private:
std::string name_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -185,7 +185,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
* \param scvf The sub control volume face
* \param scvf The sub-control volume face
*
* For this method, the \a values parameter stores the flux
* in normal direction of each phase. Negative values mean influx.
......@@ -241,6 +241,6 @@ private:
static constexpr Scalar eps_ = 1e-6;
};
} //end namespace
} // end namespace Dumux
#endif
......@@ -275,7 +275,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite volume geometry of the element
* \param elemVolVars All volume variables for the element
* \param scvf The sub control volume face
* \param scvf The sub-control volume face
*
* This method is used for cases, when the Neumann condition depends on the
* solution and requires some quantities that are specific to the fully-implicit method.
......
......@@ -23,6 +23,7 @@
*
* This test compares a mpnc problem with a 2p2c problem.
*/
#ifndef DUMUX_TWOPTWOC_MPNC_PROBLEM_HH
#define DUMUX_TWOPTWOC_MPNC_PROBLEM_HH
......@@ -258,6 +259,6 @@ private:
static constexpr Scalar eps_ = 1e-6;
std::string name_;
};
} //end namespace
} // end namespace Dumux
#endif
......@@ -22,6 +22,7 @@
* \brief Non-isothermal gas injection problem where a gas (e.g. air)
* is injected into a fully water saturated medium.
*/
#ifndef DUMUX_WATER_AIR_PROBLEM_HH
#define DUMUX_WATER_AIR_PROBLEM_HH
......@@ -324,6 +325,6 @@ private:
bool useDirichlet_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -199,7 +199,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* For this method, the \a priVars parameter stores the mass flux
* in normal direction of each component. Negative values mean influx.
......@@ -259,6 +259,6 @@ private:
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -124,6 +124,6 @@ private:
MaterialLawParams materialParams_;
};
}//end namespace
} // end namespace Dumux
#endif
......@@ -21,6 +21,7 @@
* \ingroup TwoPNCTests
* \brief Definition of a problem for water management in PEM fuel cells.
*/
#ifndef DUMUX_FUELCELL_PROBLEM_HH