Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
dumux-repositories
dumux
Commits
86fdd52a
Commit
86fdd52a
authored
Dec 14, 2018
by
Sina Ackermann
Committed by
Simon Scholz
Dec 18, 2018
Browse files
[doxygen] Adapt documentation for material tests
parent
3ae3bf32
Changes
14
Hide whitespace changes
Inline
Side-by-side
test/material/components/plotproperties.cc
View file @
86fdd52a
...
...
@@ -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
//!
h
elper structs for detecting if a component has certain functions overloaded
//!
H
elper 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
))
{}
};
//!
p
lot given values
//!
P
lot 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
)
{
...
...
test/material/components/test_componenttraits.cc
View file @
86fdd52a
...
...
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief Test the compoent traits
*
\ingroup MaterialTests
* \brief Test the compo
n
ent traits
.
*/
#include
"config.h"
...
...
test/material/fluidmatrixinteractions/2p/test_thermalconductivityjohansen.cc
View file @
86fdd52a
...
...
@@ -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>
...
...
test/material/fluidmatrixinteractions/2p/test_thermalconductivitysomerton.cc
View file @
86fdd52a
...
...
@@ -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>
...
...
test/material/fluidmatrixinteractions/test_effectivediffusivityconstanttortuosity.cc
View file @
86fdd52a
...
...
@@ -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>
...
...
test/material/fluidmatrixinteractions/test_effectivediffusivitymillingtonquirk.cc
View file @
86fdd52a
...
...
@@ -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>
...
...
test/material/fluidsystems/checkfluidsystem.hh
View file @
86fdd52a
...
...
@@ -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:
//!
e
xport the type used for scalars
//!
E
xport 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.
...
...
test/material/fluidsystems/test_fluidsystems.cc
View file @
86fdd52a
...
...
@@ -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"
...
...
test/material/immiscibleflash/test_immiscibleflash.cc
View file @
86fdd52a
...
...
@@ -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>
...
...
test/material/ncpflash/test_ncpflash.cc
View file @
86fdd52a
...
...
@@ -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>
...
...
test/material/pengrobinson/test_pengrobinson.cc
View file @
86fdd52a
...
...
@@ -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
// ret
r
ieve 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
//
n
ewton method for this
//
N
ewton method for this
ComponentVector
tmpMolarities
;
for
(
int
i
=
0
;
;
++
i
)
{
if
(
i
>=
20
)
...
...
test/material/solidsystems/checksolidsystem.hh
View file @
86fdd52a
...
...
@@ -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
...
...
test/material/solidsystems/test_solidsystems.cc
View file @
86fdd52a
...
...
@@ -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>
...
...
test/material/tabulation/test_tabulation.cc
View file @
86fdd52a
...
...
@@ -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>
...
...
Timo Koch
@timok
mentioned in commit
6385c520
·
Dec 18, 2018
mentioned in commit
6385c520
mentioned in commit 6385c52008402fd062c91cc58dc339e0e9950e36
Toggle commit list
Timo Koch
@timok
mentioned in merge request
!1422 (merged)
·
Dec 18, 2018
mentioned in merge request
!1422 (merged)
mentioned in merge request !1422
Toggle commit list
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment