diff --git a/dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh b/dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh index 37afabd016f576c779179ea80485e2aefb179f8a..6e2295d2c979b1d5415640825b2efae12d6bcddf 100644 --- a/dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh +++ b/dumux/boxmodels/2p2cni/2p2cnivolumevariables.hh @@ -39,6 +39,7 @@ namespace Dumux template <class TypeTag> class TwoPTwoCNIVolumeVariables : public TwoPTwoCVolumeVariables<TypeTag> { + //! \cond 0 typedef TwoPTwoCVolumeVariables<TypeTag> ParentType; typedef typename GET_PROP_TYPE(TypeTag, PTAG(Scalar)) Scalar; @@ -59,11 +60,11 @@ class TwoPTwoCNIVolumeVariables : public TwoPTwoCVolumeVariables<TypeTag> enum { numComponents = GET_PROP_VALUE(TypeTag, PTAG(NumComponents)) }; enum { temperatureIdx = Indices::temperatureIdx }; - typedef typename GET_PROP(TypeTag, PTAG(ReferenceElements))::Container ReferenceElements; typedef typename GET_PROP_TYPE(TypeTag, PTAG(PrimaryVariables)) PrimaryVariables; typedef Dune::FieldVector<Scalar, numPhases> PhasesVector; + //! \endcond public: /*! diff --git a/dumux/boxmodels/common/boxlocalresidual.hh b/dumux/boxmodels/common/boxlocalresidual.hh index 641ff71369c308babe86cf072556e70b52ee9768..89db341bd2063d3784f730f00193ca66510430df 100644 --- a/dumux/boxmodels/common/boxlocalresidual.hh +++ b/dumux/boxmodels/common/boxlocalresidual.hh @@ -98,7 +98,16 @@ public: ~BoxLocalResidual() { } - + + /*! + * \brief Initialize the local residual. + * + * This assumes that all objects of the simulation have been fully + * allocated but not necessarrily initialized completely. + * + * \param prob The representation of the physical problem to be + * solved. + */ void init(Problem &prob) { problemPtr_ = &prob; } @@ -199,8 +208,12 @@ public: * \param element The DUNE Codim<0> entity for which the residual * ought to be calculated * \param fvGeom The finite-volume geometry of the element + * \param prevVolVars The volume averaged variables for all + * sub-contol volumes of the element at the previous + * time level * \param curVolVars The volume averaged variables for all - * sub-contol volumes of the element + * sub-contol volumes of the element at the current + * time level * \param bcTypes The types of the boundary conditions for all * vertices of the element */ diff --git a/dumux/boxmodels/richards/richardsfluxvariables.hh b/dumux/boxmodels/richards/richardsfluxvariables.hh index 7917be9b21cd44e48a24965c7e59944a34eb4f84..cb4948e8345dc22d1e049577308954dc8b70e3d9 100644 --- a/dumux/boxmodels/richards/richardsfluxvariables.hh +++ b/dumux/boxmodels/richards/richardsfluxvariables.hh @@ -76,11 +76,11 @@ public: RichardsFluxVariables(const Problem &problem, const Element &element, const FVElementGeometry &fvElemGeom, - int scfvIdx, + int scvfIdx, const ElementVolumeVariables &elemVolVars) : fvElemGeom_(fvElemGeom) { - scvfIdx_ = scfvIdx; + scvfIdx_ = scvfIdx; calculateGradients_(problem, element, elemVolVars); calculateK_(problem, element, elemVolVars); diff --git a/dumux/boxmodels/richards/richardslocalresidual.hh b/dumux/boxmodels/richards/richardslocalresidual.hh index d4c84f7dbc37a931eeb2a66ef27c83af9578813d..9016f2f9287378cf7f34458d2aed746ad1690a56 100644 --- a/dumux/boxmodels/richards/richardslocalresidual.hh +++ b/dumux/boxmodels/richards/richardslocalresidual.hh @@ -139,10 +139,10 @@ public: /*! * \brief Calculate the source term of the equation * - * \param flux Stores the average source term of all phases inside a - * sub-control volume of the current element [kg/(m^3 s)] + * \param q Stores the average source term of all phases inside a + * sub-control volume of the current element [kg/(m^3 s)] * \param scvIdx The sub control volume index inside the current - * element + * element */ void computeSource(PrimaryVariables &q, int scvIdx) { diff --git a/dumux/boxmodels/richards/richardsvolumevariables.hh b/dumux/boxmodels/richards/richardsvolumevariables.hh index 50c925feff7f9fb8344894dc4aa3246a844f459c..5b92ee4eb297a240126899647e9ed054e9dfc589 100644 --- a/dumux/boxmodels/richards/richardsvolumevariables.hh +++ b/dumux/boxmodels/richards/richardsvolumevariables.hh @@ -73,6 +73,7 @@ public: * \param problem The physical problem which needs to be solved. * \param element The DUNE Codim<0> enitity which intersects * the control volume of the box method + * \param elemGeom The element's finite volume geometry * \param scvIdx The local index of the sub control volume inside the element * \param isOldSol Specifies whether the solution is from * the previous time step or from the current one diff --git a/dumux/common/spline.hh b/dumux/common/spline.hh index 8d431e032d5ef5422976a361cb6788fc9a2365b0..e162accdb3060a8c67096c18221536df0763b4b8 100644 --- a/dumux/common/spline.hh +++ b/dumux/common/spline.hh @@ -95,7 +95,7 @@ public: /*! * \brief Convenience constructor for a full spline * - * \param tuples An array of \f$(x,y)\f$ tuples of the spline's sampling points + * \param points An array of \f$(x,y)\f$ tuples of the spline's sampling points * \param m0 The slope of the spline at \f$x_0\f$ * \param m1 The slope of the spline at \f$x_n\f$ */ @@ -203,7 +203,7 @@ public: * \brief Convenience constructor for a full spline * * \param nSamples The number of sampling points (must be >= 2) - * \param tuples An array of \f$(x,y)\f$ tuples of the spline's sampling points + * \param points An array of \f$(x,y)\f$ tuples of the spline's sampling points * \param m0 The slope of the spline at \f$x_0\f$ * \param m1 The slope of the spline at \f$x_n\f$ */ @@ -232,7 +232,7 @@ public: /*! * \brief Convenience constructor for a full spline * - * \param tuples An array of \f$(x,y)\f$ tuples of the spline's sampling points (must have a size() method) + * \param points An array of \f$(x,y)\f$ tuples of the spline's sampling points (must have a size() method) * \param m0 The slope of the spline at \f$x_0\f$ * \param m1 The slope of the spline at \f$x_n\f$ */ @@ -294,7 +294,7 @@ public: /*! * \brief Convenience constructor for a full spline * - * \param tuples An array of \f$(x,y)\f$ tuples of the spline's sampling points + * \param points An array of \f$(x,y)\f$ tuples of the spline's sampling points * \param m0 The slope of the spline at \f$x_0\f$ * \param m1 The slope of the spline at \f$x_n\f$ */ diff --git a/dumux/common/timemanager.hh b/dumux/common/timemanager.hh index b8571c0179b96b6e062494653d2c93a3cc0011c4..52c4148ee51b883ca6797179f7fc144868a8f1d4 100644 --- a/dumux/common/timemanager.hh +++ b/dumux/common/timemanager.hh @@ -93,6 +93,8 @@ public: * \param tStart The start time [s] of the simulation (typically 0) * \param dtInitial The initial time step size [s] * \param tEnd The time at which the simulation is finished [s] + * \param writeInitialSol Specifies whether the initial condition + * should be written to disk */ void init(Problem &problem, Scalar tStart,