Commit 86fdd52a authored by Sina Ackermann's avatar Sina Ackermann Committed by Simon Emmert

[doxygen] Adapt documentation for material tests

parent 3ae3bf32
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief Plot properties of components and fluids
* \ingroup MaterialTests
* \brief Plot properties of components and fluids.
*/
#include "config.h"
......@@ -71,9 +71,9 @@ struct DisableStaticAssert {};
*/
template<>
struct AlwaysFalse<DisableStaticAssert> : public std::true_type {};
}
} // end namespace Dumux
//! helper structs for detecting if a component has certain functions overloaded
//! Helper structs for detecting if a component has certain functions overloaded
struct checkLiqDen { template<class C> auto operator()(C&& c) -> decltype(C::template liquidDensity<DisableStaticAssert>(0.0, 0.0)) {} };
struct checkLiqEnth { template<class C> auto operator()(C&& c) -> decltype(C::template liquidEnthalpy<DisableStaticAssert>(0.0, 0.0)) {} };
struct checkLiqHeatCap { template<class C> auto operator()(C&& c) -> decltype(C::template liquidHeatCapacity<DisableStaticAssert>(0.0, 0.0)) {} };
......@@ -89,7 +89,7 @@ struct checkSolHeatCap { template<class C> auto operator()(C&& c) -> decltype(C:
struct checkSolThermCond { template<class C> auto operator()(C&& c) -> decltype(C::template solidThermalConductivity<DisableStaticAssert>(0.0, 0.0)) {} };
struct checkIonCharge { template<class C> auto operator()(C&& c) -> decltype(C::template charge<DisableStaticAssert>(0.0, 0.0)) {} };
//! plot given values
//! Plot given values
template<class Functor>
void plot(Functor&& f,
const vector<double>& T,
......@@ -287,7 +287,7 @@ template<class C, class hasNoChargeOverload = checkIonCharge>
auto plotIonCharge(const vector<double>& T, double p, bool openPlot)
-> typename std::enable_if_t<decltype(isValid(hasNoChargeOverload{})(declval<C>()))::value || !ComponentTraits<C>::isIon, void> {}
//! a number of properties of a component
//! A number of properties of a component
template<class Component>
void plotStuff(bool openPlotWindow)
{
......
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief Test the compoent traits
* \ingroup MaterialTests
* \brief Test the component traits.
*/
#include "config.h"
......
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
*
* \brief Test for the Johansen thermal conductivity law
* \ingroup MaterialTests
* \brief Test for the Johansen thermal conductivity law.
*/
#include <config.h>
#include <dumux/io/gnuplotinterface.hh>
......
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
*
* \brief Test for the Somerton thermal conductivity law
* \ingroup MaterialTests
* \brief Test for the Somerton thermal conductivity law.
*/
#include <config.h>
#include <dumux/io/gnuplotinterface.hh>
......
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
*
* \brief Test for the Millington and Quirk effective diffusivity model
* \ingroup MaterialTests
* \brief Test for the Millington and Quirk effective diffusivity model.
*/
#include <config.h>
#include <dumux/common/parameters.hh>
......
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
*
* \brief Test for the Millington and Quirk effective diffusivity model
* \ingroup MaterialTests
* \brief Test for the Millington and Quirk effective diffusivity model.
*/
#include <config.h>
#include <dumux/io/gnuplotinterface.hh>
......
......@@ -18,13 +18,13 @@
*****************************************************************************/
/*!
* \file
*
* \brief This file provides the actual code for the fluid systems
* test.
* \ingroup MaterialTests
* \brief This file provides the actual code for the fluid systems test.
*
* It is not directly in test_fluidsystems.cc so that external modules
* like dumux-devel can use it easily
* like dumux-devel can use it easily.
*/
#ifndef DUMUX_CHECK_FLUIDSYSTEM_HH
#define DUMUX_CHECK_FLUIDSYSTEM_HH
......@@ -62,14 +62,14 @@
namespace Dumux
{
/*! \brief This fluid state ensures that only the allowed quantities
* are accessed
/*!
* \brief This fluid state ensures that only the allowed quantities are accessed.
*/
template<class ScalarType, class FluidSystem, class BaseFluidState = CompositionalFluidState<ScalarType, FluidSystem> >
class HairSplittingFluidState: protected BaseFluidState
{
public:
//! export the type used for scalars
//! Export the type used for scalars
using typename BaseFluidState::Scalar;
static constexpr int numPhases = FluidSystem::numPhases;
......@@ -395,6 +395,7 @@ int checkFluidState(const BaseFluidState &fs)
/*!
* \brief This is a consistency check for FluidSystems.
*
* \param enablePhaseRestriction Parameter passed to the fluidState. If set to true,
* the fluidState will only allow calls to properties of the current phase.
* \note While this is very common, it is not necessarily the case for all FluidSystems.
......
......@@ -18,10 +18,11 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup MaterialTests
* \brief This test makes sure that the programming interface is
* observed by all fluid systems
* observed by all fluid systems.
*/
#include <config.h>
#include "checkfluidsystem.hh"
......
......@@ -18,14 +18,15 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup MaterialTests
* \brief This is a program to test the flash calculation which uses
* non-linear complementarity problems (NCP)
* non-linear complementarity problems (NCP).
*
* A flash calculation determines the pressures, saturations and
* composition of all phases given the total mass (or, as in this case
* the total number of moles) in a given amount of pore space.
*/
#include <config.h>
#include <dumux/material/constraintsolvers/misciblemultiphasecomposition.hh>
......
......@@ -18,14 +18,15 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup MaterialTests
* \brief This is a program to test the flash calculation which uses
* non-linear complementarity problems (NCP)
* non-linear complementarity problems (NCP).
*
* A flash calculation determines the pressures, saturations and
* composition of all phases given the total mass (or, as in this case
* the total number of moles) in a given amount of pore space.
*/
#include <config.h>
#include <dumux/material/constraintsolvers/misciblemultiphasecomposition.hh>
......
......@@ -18,10 +18,11 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup MaterialTests
* \brief This is test for the SPE5 fluid system (which uses the
* Peng-Robinson EOS) and the NCP flash solver.
*/
#include <config.h>
#include <iomanip>
......@@ -57,7 +58,7 @@ Scalar bringOilToSurface(FluidState &surfaceFluidState, Scalar alpha, const Flui
matParams.setPcMaxSat(phaseIdx, 0.0);
}
// retieve the global volumetric component molarities
// retrieve the global volumetric component molarities
surfaceFluidState.setTemperature(273.15 + 20);
ComponentVector molarities;
......@@ -84,7 +85,7 @@ Scalar bringOilToSurface(FluidState &surfaceFluidState, Scalar alpha, const Flui
paramCache.updateAll(surfaceFluidState);
// increase volume until we are at surface pressure. use the
// newton method for this
// Newton method for this
ComponentVector tmpMolarities;
for (int i = 0; ; ++i) {
if (i >= 20)
......
......@@ -18,13 +18,13 @@
*****************************************************************************/
/*!
* \file
*
* \brief This file provides the actual code for the solid systems
* test.
* \ingroup MaterialTests
* \brief This file provides the actual code for the solid systems test.
*
* It is not directly in test_solidsystems.cc so that external modules
* like dumux-devel can use it easily
*/
#ifndef DUMUX_CHECK_SOLIDSYSTEM_HH
#define DUMUX_CHECK_SOLIDSYSTEM_HH
......
......@@ -18,10 +18,11 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup MaterialTests
* \brief This test makes sure that the programming interface is
* observed by all solid systems
* observed by all solid systems.
*/
#include <config.h>
#include <iostream>
#include <vector>
......
......@@ -18,13 +18,14 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup MaterialTests
* \brief This is a program to test the tabulation class for of
* individual components.
*
* It either prints "success" or "error", it does not do anything
* else.
*/
#include <config.h>
#include <dumux/material/components/h2o.hh>
......
Markdown is supported
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