diff --git a/test/boxmodels/2p2c/injectionspatialparameters.hh b/test/boxmodels/2p2c/injectionspatialparameters.hh index 12dcc5323b456442d6e73aaa7a40b69428eff331..2e1ff7875356a06fffaad158544d6158ea9ec83d 100644 --- a/test/boxmodels/2p2c/injectionspatialparameters.hh +++ b/test/boxmodels/2p2c/injectionspatialparameters.hh @@ -14,6 +14,12 @@ * * * This program is distributed WITHOUT ANY WARRANTY. * *****************************************************************************/ +/*! + * \file + * + * \brief Definition of the spatial parameters for the injection problem + */ + #ifndef DUMUX_INJECTION_SPATIAL_PARAMETERS_HH #define DUMUX_INJECTION_SPATIAL_PARAMETERS_HH @@ -25,7 +31,9 @@ namespace Dumux { -/** +/*! + * \ingroup SpatialParameters + * * \brief Definition of the spatial parameters for the injection problem * */ @@ -68,6 +76,11 @@ public: typedef EffToAbsLaw<EffMaterialLaw> MaterialLaw; typedef typename MaterialLaw::Params MaterialLawParams; + /*! + * \brief The constructor + * + * \param gv The grid view + */ InjectionSpatialParameters(const GridView &gv) : ParentType(gv) { @@ -102,7 +115,7 @@ public: * \brief Update the spatial parameters with the flow solution * after a timestep. * - * \TODO call interface + * \param globalSolution The global solution vector */ void update(const SolutionVector &globalSolution) { @@ -147,7 +160,14 @@ public: } - // return the brooks-corey context depending on the position + /*! + * \brief return the brooks-corey context depending on the position + * + * \param element The current finite element + * \param fvElemGeom The current finite volume geometry of the element + * \param scvfIdx The index sub-control volume face where the + * intrinsic velocity ought to be calculated. + */ const MaterialLawParams& materialLawParams(const Element &element, const FVElementGeometry &fvElemGeom, int scvIdx) const @@ -184,7 +204,9 @@ public: * * This is only required for non-isothermal models. * - * \param heatFlux The result vector + * \param heatFlux The resulting heat flux vector + * \param fluxDat The flux variables + * \param vDat The volume variables * \param tempGrad The temperature gradient * \param element The current finite element * \param fvElemGeom The finite volume geometry of the current element diff --git a/test/boxmodels/2p2cni/waterairspatialparameters.hh b/test/boxmodels/2p2cni/waterairspatialparameters.hh index 9dabf9a155ef1e3fb72e2f1c7a1d1dbf4814f856..61ca1d03245925026c66b3477a299c16334180a8 100644 --- a/test/boxmodels/2p2cni/waterairspatialparameters.hh +++ b/test/boxmodels/2p2cni/waterairspatialparameters.hh @@ -14,6 +14,12 @@ * * * This program is distributed WITHOUT ANY WARRANTY. * *****************************************************************************/ + +/*! + * \file + * + * \brief Definition of the spatial parameters for the water-air problem. + */ #ifndef DUMUX_WATER_AIR_SPATIAL_PARAMETERS_HH #define DUMUX_WATER_AIR_SPATIAL_PARAMETERS_HH @@ -25,7 +31,9 @@ namespace Dumux { -/** +/*! +* \ingroup SpatialParameters +* * \brief Definition of the spatial parameters for the water-air problem * */ @@ -70,6 +78,11 @@ public: typedef EffToAbsLaw<EffMaterialLaw> MaterialLaw; typedef typename MaterialLaw::Params MaterialLawParams; + /*! + * \brief The constructor + * + * \param gv The grid view + */ WaterAirSpatialParameters(const GridView &gv) : ParentType(gv) { @@ -104,7 +117,7 @@ public: * \brief Update the spatial parameters with the flow solution * after a timestep. * - * \TODO call parameters + * \param globalSolution The global solution vector */ void update(const SolutionVector &globalSolution) { @@ -150,7 +163,14 @@ public: } - // return the brooks-corey context depending on the position + /*! + * \brief return the brooks-corey context depending on the position + * + * \param element The current finite element + * \param fvElemGeom The current finite volume geometry of the element + * \param scvfIdx The index sub-control volume face where the + * intrinsic velocity ought to be calculated. + */ const MaterialLawParams& materialLawParams(const Element &element, const FVElementGeometry &fvElemGeom, int scvIdx) const @@ -188,7 +208,9 @@ public: * * This is only required for non-isothermal models. * - * \param heatFlux The result vector + * \param heatFlux The resulting heat flux vector + * \param fluxDat The flux variables + * \param vDat The volume variables * \param tempGrad The temperature gradient * \param element The current finite element * \param fvElemGeom The finite volume geometry of the current element