diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/capillarydiffusion.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/capillarydiffusion.hh
index 3c559a60d0cd201ebb7800fc861ebbd7d21d55a2..bade953df2cab7c659819d1f1f0ad012d67ba81a 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/capillarydiffusion.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/capillarydiffusion.hh
@@ -16,19 +16,22 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Class for defining the diffusive capillary pressure term of a 2p saturation equation
+ */
#ifndef DUMUX_CAPILLARYDIFFUSION_HH
#define DUMUX_CAPILLARYDIFFUSION_HH
#include <dumux/porousmediumflow/2p/sequential/transport/cellcentered/diffusivepart.hh>
#include "properties.hh"
-/**
- * @file
- * @brief Class for defining the diffusive capillary pressure term of a 2p saturation equation
- */
+
namespace Dumux
{
-/*!\ingroup FVSaturation2p
+/*!
* \brief Class for defining the diffusive capillary pressure term of a saturation equation
+ * \ingroup SequentialTwoPModel
*
* Defines the diffusive capillary pressure term of the form
*
@@ -80,8 +83,9 @@ private:
public:
- //! Returns capillary diffusion term
- /*! Returns capillary diffusion term for current element face
+ /*!
+ * \brief Returns capillary diffusion term for current element face
+ *
* \param flux Flux vector (gets the flux from the function)
* \param intersection Intersection of two grid elements/global boundary
* \param satI saturation of current element
@@ -222,7 +226,8 @@ public:
flux *= mobBar;
}
- /*! \brief Constructs a CapillaryDiffusion object
+ /*!
+ * \brief Constructs a CapillaryDiffusion object
*
* \param problem A problem class object
*/
diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/convectivepart.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/convectivepart.hh
index 905ee661c459085ecaa59513336f75f058e992bf..bb19e0f238299847dbbda0bd8d0d9741e458aee8 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/convectivepart.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/convectivepart.hh
@@ -16,21 +16,22 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Base class for defining a convective part of the saturation transport equation
+ */
#ifndef DUMUX_CONVECTIVEPART_HH
#define DUMUX_CONVECTIVEPART_HH
#include <dumux/porousmediumflow/2p/sequential/properties.hh>
-/**
- * \file
- * \brief Base class for defining a convective part of the saturation transport equation
- */
-
namespace Dumux
{
-/*!\ingroup FVSaturation2p
+/*!
* \brief Base class for defining a convective part of the saturation transport equation
+ * \ingroup SequentialTwoPModel
*
* \tparam TypeTag The problem TypeTag
*/
@@ -51,7 +52,8 @@ public:
void initialize()
{}
- /*! \brief Returns convective term for current element face
+ /*!
+ * \brief Returns convective term for current element face
* \param intersection Intersection of two grid elements/global boundary
* \param sat Saturation of current element
* \return Convective flux
@@ -61,7 +63,8 @@ public:
return 0.0;
}
- /*! \brief Returns convective term for current intersection
+ /*!
+ * \brief Returns convective term for current intersection
*
* \param flux Flux vector (gets the flux from the function)
* \param intersection Intersection of two grid elements/global boundary
@@ -71,7 +74,8 @@ public:
void getFlux(DimVector& flux, const Intersection& intersection, const Scalar satI, const Scalar satJ) const
{}
- /*! Constructs a ConvectivePart object
+ /*!
+ * \brief Constructs a ConvectivePart object
*
* \param problem A problem class object
*/
diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/diffusivepart.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/diffusivepart.hh
index ed431955b72b815f311c8220ef57cfdbc3590d35..3e768d3e84b2a564ef3528119cc9e39f690e8e9a 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/diffusivepart.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/diffusivepart.hh
@@ -16,19 +16,21 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Base class for defining a diffusive part of the saturation transport equation
+ */
#ifndef DUMUX_DIFFUSIVEPART_HH
#define DUMUX_DIFFUSIVEPART_HH
#include <dumux/porousmediumflow/2p/sequential/transport/properties.hh>
-/**
- * \file
- * \brief Base class for defining a diffusive part of the saturation transport equation
- */
namespace Dumux
{
-/*!\ingroup FVSaturation2p
+/*!
* \brief Base class for defining the diffusive part of the saturation transport equation
+ * \ingroup SequentialTwoPModel
*
* \tparam TypeTag The problem TypeTag
*/
@@ -50,7 +52,8 @@ public:
void initialize()
{}
- /*! \brief Returns diffusive term for current element face
+ /*!
+ * \brief Returns diffusive term for current element face
*
* \param flux Flux vector (gets the flux from the function)
* \param intersection Intersection of two grid elements/global boundary
@@ -61,7 +64,8 @@ public:
void getFlux(DimVector& flux, const Intersection& intersection, Scalar satI, Scalar satJ, const DimVector& pcGradient) const
{}
- /*! \brief Returns diffusive term for current element face
+ /*!
+ * \brief Returns diffusive term for current element face
*
* \param flux Flux vector (gets the flux from the function)
* \param intersection Intersection of two grid elements/global boundary
@@ -73,7 +77,8 @@ public:
const Scalar satIntersection, const DimVector& satGradient, const Scalar time) const
{}
- /*! \brief Returns diffusive term for current element face
+ /*!
+ * \brief Returns diffusive term for current element face
*
* \param flux Flux vector (gets the flux from the function)
* \param intersection Intersection of two grid elements/global boundary
@@ -88,7 +93,8 @@ public:
Scalar satI, Scalar satJ) const
{}
- /*! Constructs a DiffusivePart object
+ /*!
+ * \brief Constructs a DiffusivePart object
*
* \param problem problem class object
*/
diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflflux.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflflux.hh
index 3794a7cef185885e0c03f77e39625a7fc9a43993..efd865c3b8b9567d929c016bffbe22df62cf756d 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflflux.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflflux.hh
@@ -16,20 +16,21 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Base class for implementations of different kinds of fluxes to evaluate a CFL-Condition
+ */
#ifndef DUMUX_EVALCFLFLUX_HH
#define DUMUX_EVALCFLFLUX_HH
#include <dumux/porousmediumflow/2p/sequential/properties.hh>
-/**
- * @file
- * @brief Base class for implementations of different kinds of fluxes to evaluate a CFL-Condition
- */
namespace Dumux
{
-/*!\ingroup IMPES
- * \ingroup Saturation2p
- * @brief Base class for implementations of different kinds of fluxes to evaluate a CFL-Condition
+/*!
+ * \brief Base class for implementations of different kinds of fluxes to evaluate a CFL-Condition
+ * \ingroup SequentialTwoPModel
*
* Base class for implementations of different kinds of fluxes to evaluate a CFL-Condition of the form
*
@@ -62,7 +63,8 @@ public:
void initialize()
{}
- /*! \brief adds a flux to the cfl-criterion evaluation
+ /*!
+ * \brief adds a flux to the cfl-criterion evaluation
*
* \param lambdaW wetting phase mobility
* \param lambdaNw non-wetting phase mobility
@@ -76,7 +78,8 @@ public:
const Intersection& intersection, int phaseIdx)
{}
- /*! \brief adds a flux to the cfl-criterion evaluation
+ /*!
+ * \brief adds a flux to the cfl-criterion evaluation
*
* \param lambdaW wetting phase mobility
* \param lambdaNw non-wetting phase mobility
@@ -90,7 +93,8 @@ public:
const Element& element, int phaseIdx)
{}
- /*! \brief Returns the CFL flux-function
+ /*!
+ * \brief Returns the CFL flux-function
*
* \param element element on which the CFL-criterion is evaluated
* \return fluxFunction for the calculation of the CFL time-step (\f$ 1/F_i \f$)
@@ -100,7 +104,8 @@ public:
return 0.0;
}
- /*! \brief Returns the CFL time-step
+ /*!
+ * \brief Returns the CFL time-step
*
* \param element element on which the CFL-criterion is evaluated
* \return CFL time-step
@@ -114,7 +119,7 @@ public:
void reset()
{}
- /*! @brief Constructs a EvalCflFlux instance */
+ /*! \brief Constructs a EvalCflFlux instance */
EvalCflFlux ()
{}
};
diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflfluxcoats.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflfluxcoats.hh
index 8534a19d6b8708eed7a0bb485a87d629947d8e1c..5ccd3bf428ba65cb523d1139adfe4467a2e83d03 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflfluxcoats.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflfluxcoats.hh
@@ -16,22 +16,23 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Cfl-flux-function to evaluate a Cfl-Condition after Coats 2003
+ */
#ifndef DUMUX_EVALCFLFLUX_COATS_HH
#define DUMUX_EVALCFLFLUX_COATS_HH
-/**
- * @file
- * @brief Cfl-flux-function to evaluate a Cfl-Condition after Coats 2003
- */
-
#include <dune/common/float_cmp.hh>
#include <dumux/porousmediumflow/sequential/impetproperties.hh>
#include "evalcflflux.hh"
namespace Dumux
{
-/*!\ingroup IMPES
- * @brief Cfl-flux-function to evaluate a Cfl-Condition after Coats 2003
+/*!
+ * \brief Cfl-flux-function to evaluate a Cfl-Condition after Coats 2003
+ * \ingroup SequentialTwoPModel
*
* tparam TypeTag The problem TypeTag
*/
@@ -98,7 +99,8 @@ public:
density_[nPhaseIdx] = FluidSystem::density(fluidState, nPhaseIdx);
}
- /*! \brief adds a flux to the cfl-criterion evaluation
+ /*!
+ * \brief adds a flux to the cfl-criterion evaluation
*
* \copydetails EvalCflFlux::addFlux(Scalar&,Scalar&,Scalar&,Scalar&,Scalar,const Element&,int)
*/
@@ -108,7 +110,8 @@ public:
addDefaultFlux(flux, phaseIdx);
}
- /*! \brief adds a flux to the cfl-criterion evaluation
+ /*!
+ * \brief adds a flux to the cfl-criterion evaluation
*
* \copydetails EvalCflFlux::addFlux(Scalar&,Scalar&,Scalar&,Scalar&,Scalar,const Intersection&,int)
*/
@@ -119,7 +122,8 @@ public:
addCoatsFlux(lambdaW, lambdaNw, viscosityW, viscosityNw, flux, intersection, phaseIdx);
}
- /*! \brief Returns the Cfl flux-function
+ /*!
+ * \brief Returns the Cfl flux-function
*
* \copydetails EvalCflFlux::getCflFluxFunction(const Element&)
*/
@@ -152,7 +156,8 @@ public:
}
}
- /*! \brief Returns the Cfl time-step
+ /*!
+ * \brief Returns the Cfl time-step
*
* \copydetails EvalCflFlux::getDt(const Element&)
*/
@@ -175,7 +180,8 @@ public:
fluxOut_ = 0;
}
- /*! \brief Constructs an EvalCflFluxDefault object
+ /*!
+ * \brief Constructs an EvalCflFluxDefault object
*
* \param problem A problem type object
*/
@@ -308,7 +314,8 @@ void EvalCflFluxCoats<TypeTag>::addDefaultFlux(Scalar flux, int phaseIdx)
}
}
-/*! \brief adds a flux to the cfl-criterion evaluation
+/*!
+ * \brief adds a flux to the cfl-criterion evaluation
*
* \copydetails EvalCflFlux::addFlux(Scalar&,Scalar&,Scalar&,Scalar&,Scalar,const Intersection&,int)
*/
diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflfluxdefault.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflfluxdefault.hh
index 45dd9a2685475552ee9005666ccc8c4d70d46b50..6c4f9f83f4540edd6346cff292c17d2cd4ca4e2a 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflfluxdefault.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflfluxdefault.hh
@@ -16,21 +16,22 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Fluxes to evaluate a CFL-Condition
+ */
#ifndef DUMUX_EVALCFLFLUX_DEFAULT_HH
#define DUMUX_EVALCFLFLUX_DEFAULT_HH
-/**
- * @file
- * @brief Fluxes to evaluate a CFL-Condition
- */
-
#include <dumux/porousmediumflow/sequential/impetproperties.hh>
#include "evalcflflux.hh"
namespace Dumux
{
-/*!\ingroup IMPES
- * @brief Default implementation of cfl-fluxes to evaluate a CFL-Condition
+/*!
+ * \brief Default implementation of cfl-fluxes to evaluate a CFL-Condition
+ * \ingroup SequentialTwoPModel
*
* Compares the maximum of inflow and outflow to the element volume weighted by relative permeability and viscosity ratios.
*
@@ -61,7 +62,8 @@ private:
public:
- /*! \brief adds a flux to the cfl-criterion evaluation
+ /*!
+ * \brief adds a flux to the cfl-criterion evaluation
*
* \copydetails EvalCflFlux::addFlux(Scalar&,Scalar&,Scalar&,Scalar&,Scalar,const Element&,int)
*/
@@ -71,7 +73,8 @@ public:
addFlux(lambdaW, lambdaNw, viscosityW, viscosityNw, flux, phaseIdx);
}
- /*! \brief adds a flux to the cfl-criterion evaluation
+ /*!
+ * \brief adds a flux to the cfl-criterion evaluation
*
* \copydetails EvalCflFlux::addFlux(Scalar&,Scalar&,Scalar&,Scalar&,Scalar,const Intersection&,int)
*/
@@ -81,13 +84,15 @@ public:
addFlux(lambdaW, lambdaNw, viscosityW, viscosityNw, flux, phaseIdx);
}
- /*! \brief Returns the CFL flux-function
+ /*!
+ * \brief Returns the CFL flux-function
*
* \copydetails EvalCflFlux::getCflFluxFunction(const Element&)
*/
Scalar getCflFluxFunction(const Element& element);
- /*! \brief Returns the CFL time-step
+ /*!
+ * \brief Returns the CFL time-step
*
* \copydetails EvalCflFlux::getDt(const Element&)
*/
@@ -108,7 +113,8 @@ public:
fluxOut_ = 0;
}
- /*! \brief Constructs an EvalCflFluxDefault object
+ /*!
+ * \brief Constructs an EvalCflFluxDefault object
*
* \param problem A problem type object
*/
@@ -120,7 +126,7 @@ public:
}
private:
-
+ // TODO doc me!
void addFlux(Scalar& lambdaW, Scalar& lambdaNw, Scalar& viscosityW, Scalar& viscosityNw, Scalar flux, int phaseIdx = -1)
{
using std::abs;
@@ -175,6 +181,7 @@ private:
}
}
+ // TODO doc me!
Scalar getCFLFluxIn(int phaseIdx = 0)
{
using std::isnan;
@@ -187,6 +194,7 @@ private:
return fluxIn_;
}
+ // TODO doc me!
Scalar getCFLFluxOut(int phaseIdx = 0)
{
using std::isnan;
@@ -223,7 +231,7 @@ private:
static const int saturationType_ = GET_PROP_VALUE(TypeTag, SaturationFormulation);
};
-// Returns the CFL flux-function
+//! Returns the CFL flux-function
template<class TypeTag>
typename EvalCflFluxDefault<TypeTag>::Scalar EvalCflFluxDefault<TypeTag>::getCflFluxFunction(const Element& element)
{
diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/gravitypart.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/gravitypart.hh
index bc9b75577736ee16db658e7e7af7af17337ccbf2..ff6cb7d01505d438fce71999f331a94c1ab730a0 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/gravitypart.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/gravitypart.hh
@@ -16,21 +16,22 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Class for defining the gravity term of a two-phase flow saturation equation
+ */
#ifndef DUMUX_GRAVITYPART_HH
#define DUMUX_GRAVITYPART_HH
#include <dumux/porousmediumflow/2p/sequential/transport/cellcentered/convectivepart.hh>
#include "properties.hh"
-/**
- * @file
- * @brief Class for defining the gravity term of a two-phase flow saturation equation
- */
-
namespace Dumux
{
-/*!\ingroup FVSaturation2p
+/*!
* \brief Class for defining the gravity term of a two-phase flow saturation equation
+ * \ingroup SequentialTwoPModel
*
* Defines the gravity term of the form
*
@@ -77,7 +78,8 @@ private:
public:
- /*! \brief Returns convective term for current element face
+ /*!
+ * \brief Returns convective term for current element face
*
* \param flux Flux vector (gets the flux from the function)
* \param intersection Intersection of two grid elements/global boundary
@@ -192,7 +194,9 @@ public:
// set result to f_w*lambda_n*K*grad(pc)
flux *= lambdaW*lambdaNw/(lambdaW+lambdaNw) * scalarPerm * (density_[wPhaseIdx] - density_[nPhaseIdx]) * scalarGravity * areaScaling;
}
- /*! \brief Constructs a GravityPart object
+
+ /*!
+ * \brief Constructs a GravityPart object
*
* \param problem A problem class object
*/
diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/properties.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/properties.hh
index 5afdb6cbb8559bd884892d4b7886c9d5a5bb70be..c7043c9fc59c82ac30a1efa6c68a29f2c12fd68d 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/properties.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/properties.hh
@@ -16,19 +16,16 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Specifies the properties for immiscible 2p transport
+ */
#ifndef DUMUX_FV_TRANSPORT_PROPERTIES_2P_HH
#define DUMUX_FV_TRANSPORT_PROPERTIES_2P_HH
#include <dumux/porousmediumflow/2p/sequential/transport/properties.hh>
-/*!
- * \ingroup FVSaturation2p
- * \ingroup IMPETProperties
- */
-/*!
- * \file
- * \brief Specifies the properties for immiscible 2p transport
- */
namespace Dumux
{
namespace Properties
@@ -66,7 +63,7 @@ SET_TYPE_PROP(FVTransportTwoP, EvalCflFluxFunction, EvalCflFluxDefault<TypeTag>)
SET_TYPE_PROP(FVTransportTwoP, CapillaryFlux, DiffusivePart<TypeTag>);
//! Set the default implementation of an additional convective flux -> additional convective flux dissabled
SET_TYPE_PROP(FVTransportTwoP, GravityFlux, ConvectivePart<TypeTag>);
-//! \brief Set PrecomputedConstRels flag <tt>true</tt> as default
+//! Set PrecomputedConstRels flag <tt>true</tt> as default
SET_BOOL_PROP( FVTransportTwoP, PrecomputedConstRels, true);
//! Set finite volume implementation of the two-phase saturation equation as default saturation model
SET_TYPE_PROP(FVTransportTwoP, TransportModel, FVSaturation2P<TypeTag>);
diff --git a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/saturation.hh b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/saturation.hh
index 643e507a0fe9a1f7404c3b9d1be8d1e06822da4e..f9d40c0ac234140e3e3624443670cebb26ac0296 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/cellcentered/saturation.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/cellcentered/saturation.hh
@@ -16,22 +16,24 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Finite Volume discretization of a saturation transport equation
+ */
#ifndef DUMUX_FVSATURATION2P_HH
#define DUMUX_FVSATURATION2P_HH
#include <dumux/porousmediumflow/2p/sequential/transport/properties.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/transport.hh>
-/**
- * \file
- * \brief Finite Volume discretization of a saturation transport equation
- */
-
namespace Dumux
{
-//! \ingroup FVSaturation2p
-//! \brief The finite volume discretization of a saturation transport equation
-/*! This model solves equations of the form
+/*!
+ * \brief The finite volume discretization of a saturation transport equation
+ * \ingroup SequentialTwoPModel
+ *
+ * This model solves equations of the form
*
* \f[
* \phi \frac{\partial (\varrho_\alpha S_\alpha)}{\partial t} + \text{div}\, (\varrho_\alpha \boldsymbol{v_\alpha}) = q_\alpha,
@@ -164,27 +166,27 @@ public:
return *velocity_;
}
- // Function which calculates the flux update
+ //! Function which calculates the flux update
void getFlux(Scalar& update, const Intersection& intersection, CellData& cellDataI);
- // Function which calculates the boundary flux update
+ //! Function which calculates the boundary flux update
void getFluxOnBoundary(Scalar& update, const Intersection& intersection, CellData& cellDataI);
- // Function which calculates the source update
+ //! Function which calculates the source update
void getSource(Scalar& update, const Element& element, CellData& cellDataI);
- // Sets the initial solution
+ //! Sets the initial solution
void initialize();
- // Update the values of the material laws and constitutive relations.
+ //! Update the values of the material laws and constitutive relations.
void updateMaterialLaws();
- /* \brief Writes the current values of the primary transport variable
+ /*!
+ * \brief Writes the current values of the primary transport variable
* \into the <tt>transportedQuantity</tt>-vector (comes as function argument)
*
* \copydetails FVTransport::getTransportedQuantity(TransportSolutionType&)
- *
*/
void getTransportedQuantity(TransportSolutionType& transportedQuantity)
{
@@ -208,7 +210,8 @@ public:
}
}
- /* \brief Writes the current values of the primary transport variable into the variable container
+ /*!
+ * \brief Writes the current values of the primary transport variable into the variable container
*
* \copydetails FVTransport::setTransportedQuantity(TransportSolutionType&)
*
@@ -241,11 +244,11 @@ public:
}
}
- /*! \brief Check if saturation is in physical range.
+ /*!
+ * \brief Check if saturation is in physical range.
*
* \tparam DataEntry Data class
* \param entry Entry which is checked
- *
*/
template<class DataEntry>
bool inPhysicalRange(DataEntry& entry)
@@ -253,7 +256,8 @@ public:
return (entry > -1e-6 && entry < 1.0 + 1e-6);
}
- /*! \brief Updates the primary transport variable.
+ /*!
+ * \brief Updates the primary transport variable.
*
* \copydetails FVTransport::updateTransportedQuantity(TransportSolutionType&)
*/
@@ -265,18 +269,19 @@ public:
asImp_().updateSaturationSolution(updateVec);
}
- /*! \brief Updates the primary transport variable.
+ /*!
+ * \brief Updates the primary transport variable.
*
* \param updateVec Vector containing the global update
* \param dt time step for update
- *
*/
void updateTransportedQuantity(TransportSolutionType& updateVec, Scalar dt)
{
asImp_().updateSaturationSolution(updateVec, dt);
}
- /*! \brief Globally updates the saturation solution
+ /*!
+ * \brief Globally updates the saturation solution
*
* \param updateVec Vector containing the global update.
*/
@@ -290,7 +295,8 @@ public:
}
}
- /*! \brief Globally updates the saturation solution
+ /*!
+ * \brief Globally updates the saturation solution
*
* \param updateVec Vector containing the global update.
* \param dt time step for update
@@ -304,7 +310,8 @@ public:
}
}
- /*! \brief Updates the saturation solution of a cell
+ /*!
+ * \brief Updates the saturation solution of a cell
*
* Calculates secondary saturation variables and stores saturations.
*
@@ -337,7 +344,8 @@ public:
}
}
- /*! \brief Adds saturation output to the output file
+ /*!
+ * \brief Adds saturation output to the output file
*
* Adds the phase saturation to the output.
* If the velocity is calculated in the transport model it is also added to the output.
@@ -347,7 +355,6 @@ public:
*
* \tparam MultiWriter Class defining the output writer
* \param writer The output writer (usually a <tt>VTKMultiWriter</tt> object)
- *
*/
template<class MultiWriter>
void addOutputVtkFields(MultiWriter &writer)
@@ -406,10 +413,10 @@ public:
return;
}
- /*! \brief Function for serialization of the primary transport variable.
+ /*!
+ * \brief Function for serialization of the primary transport variable.
*
*\copydetails FVTransport::serializeEntity(std::ostream&,const Element&)
- *
*/
void serializeEntity(std::ostream &outstream, const Element &element)
{
@@ -429,10 +436,10 @@ public:
outstream << sat;
}
- /*! \brief Function for deserialization of the primary transport variable.
+ /*!
+ * \brief Function for deserialization of the primary transport variable.
*
*\copydetails FVTransport::deserializeEntity(std::istream&,const Element&)
- *
*/
void deserializeEntity(std::istream &instream, const Element &element)
{
@@ -455,7 +462,8 @@ public:
}
- /*! \brief Constructs a FVSaturation2P object
+ /*!
+ * \brief Constructs a FVSaturation2P object
*
* \param problem A problem class object
*/
@@ -518,7 +526,8 @@ private:
const bool switchNormals_;
};
-/*! \brief Function which calculates the flux update
+/*!
+ * \brief Function which calculates the flux update
*
* \copydetails FVTransport::getFlux(Scalar&,const Intersection&,CellData&)
*
@@ -713,7 +722,8 @@ void FVSaturation2P<TypeTag>::getFlux(Scalar& update, const Intersection& inters
}
}
-/*! \brief Function which calculates the boundary flux update
+/*!
+ * \brief Function which calculates the boundary flux update
*
* \copydetails FVTransport::getFluxOnBoundary(Scalar&,const Intersection&,CellData&)
*
@@ -1024,7 +1034,8 @@ void FVSaturation2P<TypeTag>::getFluxOnBoundary(Scalar& update, const Intersecti
}
}
-/*! \brief Function which calculates the source update
+/*!
+ * \brief Function which calculates the source update
*
*\copydetails FVTransport::getSource(Scalar&,const Element&,CellData&)
*
@@ -1167,10 +1178,10 @@ void FVSaturation2P<TypeTag>::initialize()
return;
}
-/*! \brief Updates constitutive relations and stores them in the variable class
+/*!
+ * \brief Updates constitutive relations and stores them in the variable class
*
* Stores mobility, fractional flow function and capillary pressure for all grid cells.
- *
*/
template<class TypeTag>
void FVSaturation2P<TypeTag>::updateMaterialLaws()
diff --git a/dumux/porousmediumflow/2p/sequential/transport/problem.hh b/dumux/porousmediumflow/2p/sequential/transport/problem.hh
index 7dba83eb952aa94169e44debe2889ad49fa00667..ac4e0e7068df56298c8e1043a88a4213f4a47600 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/problem.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/problem.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup SequentialTwoPModel
* \brief Base class for two-phase transport problems
*/
#ifndef DUMUX_TRANSPORTPROBLEM_2P_HH
@@ -41,9 +42,8 @@ SET_TYPE_PROP(TransportTwoP, Velocity, FVVelocityDefault<TypeTag>);
}
/*!
- * \ingroup Saturation2p
- * \ingroup IMPETproblems
* \brief Base class for a sequential two-phase transport problem
+ * \ingroup SequentialTwoPModel
*
* \tparam TypeTag The problem Type Tag
*/
diff --git a/dumux/porousmediumflow/2p/sequential/transport/properties.hh b/dumux/porousmediumflow/2p/sequential/transport/properties.hh
index 5cc855d271a3ea2a26249526bb7c4ba4ca399496..3c8cc2f0d711a688e5913d67f21df35782f57b40 100644
--- a/dumux/porousmediumflow/2p/sequential/transport/properties.hh
+++ b/dumux/porousmediumflow/2p/sequential/transport/properties.hh
@@ -16,20 +16,17 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup SequentialTwoPModel
+ * \brief Specifies the properties for immiscible 2p transport
+ */
#ifndef DUMUX_TRANSPORT_PROPERTIES_2P_HH
#define DUMUX_TRANSPORT_PROPERTIES_2P_HH
#include <dumux/porousmediumflow/sequential/transportproperties.hh>
#include <dumux/porousmediumflow/2p/sequential/properties.hh>
-/*!
- * \ingroup Saturation2p
- * \ingroup IMPETProperties
- */
-/*!
- * \file
- * \brief Specifies the properties for immiscible 2p transport
- */
namespace Dumux
{
namespace Properties