corrected doku

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11534 2fb0f335-1f38-0410-981e-8018bf24f1b0

dumux/implicit/2p2c/2p2cfluxvariables.hh

@@ -20,7 +20,7 @@
  * \file
  * \brief   This file contains the data which is required to calculate
  *          all fluxes of components over a face of a finite volume for
- *          the two-phase, two-component model.
+ *          the two-phase two-component model.
  */
 #ifndef DUMUX_2P2C_FLUX_VARIABLES_HH
 #define DUMUX_2P2C_FLUX_VARIABLES_HH
@@ -38,7 +38,7 @@ namespace Dumux
  * \ingroup ImplicitFluxVariables
  * \brief This template class contains the data which is required to
  *        calculate all fluxes of components over a face of a finite
- *        volume for the two-phase, two-component model.
+ *        volume for the two-phase two-component model.
  *
  * This means pressure and concentration gradients, phase densities at
  * the integration point, etc.
@@ -77,9 +77,9 @@ class TwoPTwoCFluxVariables : public GET_PROP_TYPE(TypeTag, BaseFluxVariables)
      * \param problem The problem
      * \param element The finite element
      * \param fvGeometry The finite-volume geometry in the fully implicit scheme
-     * \param faceIdx The local index of the SCV (sub-control-volume) face
+     * \param faceIdx The local index of the sub-control-volume face
      * \param elemVolVars The volume variables of the current element
-     * \param onBoundary Distinguishes if we are on a SCV face or on a boundary face
+     * \param onBoundary Evaluate flux at inner sub-control-volume face or on a boundary face
      */
     TwoPTwoCFluxVariables(const Problem &problem,
                           const Element &element,

dumux/implicit/2p2c/2p2cindices.hh

@@ -49,7 +49,7 @@ struct TwoPTwoCFormulation
 /*!
  * \ingroup TwoPTwoCModel
  * \ingroup ImplicitIndices
- * \brief The indices for the isothermal TwoPTwoC model.
+ * \brief The indices for the isothermal 2p2c model.
  *
  * \tparam formulation The formulation, either pwsn or pnsw.
  * \tparam PVOffset The first index in a primary variable vector.
@@ -77,10 +77,10 @@ public:
 
     // Primary variable indices
     static const int pressureIdx = PVOffset + 0; //!< Index for wetting/non-wetting phase pressure (depending on formulation) in a solution vector
-    static const int switchIdx = PVOffset + 1; //!< Index of the either the saturation or the mass fraction of the non-wetting/wetting phase
+    static const int switchIdx = PVOffset + 1; //!< Index of either the saturation or the mass fraction of the non-wetting/wetting phase
 
     static const int pwIdx = pressureIdx; //!< Index for wetting phase pressure in a solution vector
-    static const int snOrXIdx = switchIdx; //!< Index of the either the saturation of the non-wetting phase or the mass fraction secondary component in the only phase
+    static const int snOrXIdx = switchIdx; //!< Index of either the saturation of the non-wetting phase or the mass fraction secondary component in the only phase
 
     DUNE_DEPRECATED_MSG("use snOrXIdx (uncapitalized 's') instead") 
     static const int SnOrXIdx = snOrXIdx; //!< \deprecated
@@ -94,7 +94,7 @@ public:
 /*!
  * \ingroup TwoPTwoCModel
  * \ingroup ImplicitIndices
- * \brief The indices for the isothermal TwoPTwoC model in the pn-sw
+ * \brief The indices for the isothermal 2p2c model in the pn-sw
  *        formulation.
  *
  * \tparam PVOffset The first index in a primary variable vector.
@@ -120,10 +120,10 @@ public:
 
     // Primary variable indices
     static const int pressureIdx = PVOffset + 0; //!< Index for wetting/non-wetting phase pressure (depending on formulation) in a solution vector
-    static const int switchIdx = PVOffset + 1; //!< Index of the either the saturation or the mass fraction of the non-wetting/wetting phase
+    static const int switchIdx = PVOffset + 1; //!< Index of either the saturation or the mass fraction of the non-wetting/wetting phase
 
     static const int pnIdx = pressureIdx; //!< Index for non-wetting phase pressure in a solution vector
-    static const int swOrXIdx = switchIdx; //!< Index of the either the saturation of the liquid phase or the mass fraction of the secondary component in the only phase
+    static const int swOrXIdx = switchIdx; //!< Index of either the saturation of the liquid phase or the mass fraction of the secondary component in the only phase
 
     DUNE_DEPRECATED_MSG("use swOrXIdx (uncapitalized 's') instead") 
     static const int SwOrXIdx = swOrXIdx; //!< \deprecated

dumux/implicit/2p2c/2p2clocalresidual.hh

@@ -36,7 +36,7 @@ namespace Dumux
  * \brief Element-wise calculation of the Jacobian matrix for problems
  *        using the two-phase two-component fully implicit model.
  *
- * This class is used to fill the gaps in BoxLocalResidual for the 2P-2C flow.
+ * This class is used to fill the gaps in BoxLocalResidual for the two-phase two-component flow.
  */
 template<class TypeTag>
 class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
@@ -117,14 +117,14 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
     }
 
     /*!
-     * \brief Evaluate the amount all conservation quantities
+     * \brief Evaluate the amount of all conservation quantities
      *        (e.g. phase mass) within a sub-control volume.
      *
      * The result should be averaged over the volume (e.g. phase mass
      * inside a sub-control volume divided by the volume)
      *
      *  \param storage The mass of the component within the sub-control volume
-     *  \param scvIdx The SCV (sub-control-volume) index
+     *  \param scvIdx The sub-control-volume index
      *  \param usePrevSol Evaluate function with solution of current or previous time step
      */
     void computeStorage(PrimaryVariables &storage, const int scvIdx, bool usePrevSol) const
@@ -133,7 +133,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
         // time step is used, otherwise the current solution is
         // used. The secondary variables are used accordingly.  This
         // is required to compute the derivative of the storage term
-        // using the implicit euler method.
+        // using the implicit Euler method.
         const ElementVolumeVariables &elemVolVars = usePrevSol ? this->prevVolVars_()
             : this->curVolVars_();
         const VolumeVariables &volVars = elemVolVars[scvIdx];
@@ -151,7 +151,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
 						* volVars.saturation(phaseIdx)
 						* volVars.fluidState().massFraction(phaseIdx, compIdx);
 				}
-				// this is only processed, if one component mass balance equation
+				// this is only processed if one component mass balance equation
 				// is replaced by the total mass balance equation
 				if (replaceCompEqIdx < numComponents)
 					storage[replaceCompEqIdx] +=
@@ -171,7 +171,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
 						* volVars.saturation(phaseIdx)
 						* volVars.fluidState().moleFraction(phaseIdx, compIdx);
 				 }
-				 // this is only processed, if one component mass balance equation
+				 // this is only processed if one component mass balance equation
 				 // is replaced by the total mass balance equation
 				 if (replaceCompEqIdx < numComponents)
 					 storage[replaceCompEqIdx] +=
@@ -186,9 +186,9 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
      * \brief Evaluates the total flux of all conservation quantities
      *        over a face of a sub-control volume.
      *
-     * \param flux The flux over the SCV (sub-control-volume) face for each component
-     * \param faceIdx The index of the SCV face
-     * \param onBoundary Evaluate flux at inner SCV face or on a boundary face
+     * \param flux The flux over the sub-control-volume face for each component
+     * \param faceIdx The index of the sub-control-volume face
+     * \param onBoundary Evaluate flux at inner sub-control-volume face or on a boundary face
      */
     void computeFlux(PrimaryVariables &flux, const int faceIdx, bool onBoundary=false) const
     {
@@ -211,7 +211,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
      *        a face of a sub-control volume.
      *
      * \param flux The advective flux over the sub-control-volume face for each component
-     * \param fluxVars The flux variables at the current SCV face
+     * \param fluxVars The flux variables at the current sub-control-volume face
      */
     void computeAdvectiveFlux(PrimaryVariables &flux, const FluxVariables &fluxVars) const
     {
@@ -223,7 +223,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
     	{
 			for (unsigned int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
 			{
-				// data attached to upstream and the downstream vertices
+				// data attached to upstream and downstream vertices
 				// of the current phase
 				const VolumeVariables &up =
 					this->curVolVars_(fluxVars.upstreamIdx(phaseIdx));
@@ -257,7 +257,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
 					Valgrind::CheckDefined(dn.fluidState().massFraction(phaseIdx, compIdx));
 				}
 				// flux of the total mass balance;
-				// this is only processed, if one component mass balance equation
+				// this is only processed if one component mass balance equation
 				// is replaced by a total mass balance equation
 				if (replaceCompEqIdx < numComponents)
 				{
@@ -319,7 +319,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
                     Valgrind::CheckDefined(dn.fluidState().moleFraction(phaseIdx, compIdx));
                 }
                 // flux of the total mass balance;
-                // this is only processed, if one component mass balance equation
+                // this is only processed if one component mass balance equation
                 // is replaced by a total mass balance equation
                 if (replaceCompEqIdx < numComponents)
                 {
@@ -350,7 +350,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
      *        a face of a sub-control volume.
      *
      * \param flux The diffusive flux over the sub-control-volume face for each component
-     * \param fluxVars The flux variables at the current sub control volume face
+     * \param fluxVars The flux variables at the current sub-control-volume face
      */
     void computeDiffusiveFlux(PrimaryVariables &flux, const FluxVariables &fluxVars) const
 
@@ -410,7 +410,7 @@ class TwoPTwoCLocalResidual: public GET_PROP_TYPE(TypeTag, BaseLocalResidual)
      *
      * \param source The source/sink in the sub-control volume for each component
      * \param scvIdx The index of the sub-control volume
-     * \be careful what you use! (mole or mass Fraction!) Think of the units!
+     * \be careful what you use! (mole or mass fraction!) Think of the units!
      */
     void computeSource(PrimaryVariables& source, const int scvIdx)
     {

dumux/implicit/2p2c/2p2cmodel.hh

@@ -46,9 +46,9 @@ namespace Dumux
  * By inserting this into the equations for the conservation of the
  * components, one gets one transport equation for each component
  * \f{eqnarray*}
- && \phi \frac{\partial (\sum_\alpha \varrho_\alpha X_\alpha^\kappa S_\alpha )}
+ && \phi \frac{\partial (\sum_\alpha \varrho_\alpha \frac{M^\kappa}{M_\alpha} x_\alpha^\kappa S_\alpha )}
  {\partial t}
- - \sum_\alpha  \text{div} \left\{ \varrho_\alpha X_\alpha^\kappa
+ - \sum_\alpha  \text{div} \left\{ \varrho_\alpha \frac{M^\kappa}{M_\alpha} x_\alpha^\kappa
  \frac{k_{r\alpha}}{\mu_\alpha} \mbox{\bf K}
  (\textbf{grad}\, p_\alpha - \varrho_{\alpha}  \mbox{\bf g}) \right\}
  \nonumber \\ \nonumber \\
@@ -64,7 +64,7 @@ namespace Dumux
  *
  * By using constitutive relations for the capillary pressure \f$p_c =
  * p_n - p_w\f$ and relative permeability \f$k_{r\alpha}\f$ and taking
- * advantage of the fact that \f$S_w + S_n = 1\f$ and \f$X^\kappa_w + X^\kappa_n = 1\f$, the number of
+ * advantage of the fact that \f$S_w + S_n = 1\f$ and \f$x^\kappa_w + x^\kappa_n = 1\f$, the number of
  * unknowns can be reduced to two.
  * The used primary variables are, like in the two-phase model, either \f$p_w\f$ and \f$S_n\f$
  * or \f$p_n\f$ and \f$S_w\f$. The formulation which ought to be used can be
@@ -80,10 +80,10 @@ namespace Dumux
  * <ul>
  *  <li> Both phases are present: The saturation is used (either \f$S_n\f$ or \f$S_w\f$, dependent on the chosen <tt>Formulation</tt>),
  *      as long as \f$ 0 < S_\alpha < 1\f$</li>.
- *  <li> Only wetting phase is present: The mass fraction of, e.g., air in the wetting phase \f$X^a_w\f$ is used,
- *      as long as the maximum mass/mole fraction is not exceeded \f$(X^a_w<X^a_{w,max})\f$</li>
- *  <li> Only non-wetting phase is present: The mass fraction of, e.g., water in the non-wetting phase, \f$X^w_n\f$, is used,
- *      as long as the maximum mass/mole fraction is not exceeded \f$(X^w_n<X^w_{n,max})\f$</li>
+ *  <li> Only wetting phase is present: The mole fraction of, e.g., air in the wetting phase \f$x^a_w\f$ is used,
+ *      as long as the maximum mole fraction is not exceeded \f$(x^a_w<x^a_{w,max})\f$</li>
+ *  <li> Only non-wetting phase is present: The mole fraction of, e.g., water in the non-wetting phase, \f$x^w_n\f$, is used,
+ *      as long as the maximum mole fraction is not exceeded \f$(x^w_n<x^w_{n,max})\f$</li>
  * </ul>
  */
 
@@ -224,7 +224,7 @@ public:
     }
 
     /*!
-     * \brief Called by the update() method if applying the newton
+     * \brief Called by the update() method if applying the Newton
      *         method was unsuccessful.
      */
     void updateFailed()
@@ -567,7 +567,7 @@ public:
     }
 
     /*!
-     * \brief Set whether there was a primary variable switch after in
+     * \brief Set whether there was a primary variable switch after
      *        the last timestep.
      */
     void setSwitched_(bool yesno)
@@ -599,7 +599,7 @@ public:
             if (staticDat_[globalIdx].wasSwitched)
                 xwMax *= 1.02;
 
-            // if the sum of the mole fractions would be larger than
+            // if the sum of the mole fractions is larger than
             // 100%, wetting phase appears
             if (xww + xwn > xwMax)
             {
@@ -627,7 +627,7 @@ public:
             if (staticDat_[globalIdx].wasSwitched)
                 xgMax *= 1.02;
 
-            // if the sum of the mole fractions would be larger than
+            // if the sum of the mole fractions is larger than
             // 100%, nonwetting phase appears
             if (xnw + xnn > xgMax)
             {

dumux/implicit/2p2c/2p2cnewtoncontroller.hh

@@ -21,7 +21,7 @@
  * \brief A 2p2c specific controller for the newton solver.
  *
  * This controller 'knows' what a 'physically meaningful' solution is
- * which allows the newton method to abort quicker if the solution is
+ * which allows the Newton method to abort quicker if the solution is
  * way out of bounds.
  */
 #ifndef DUMUX_2P2C_NEWTON_CONTROLLER_HH
@@ -36,10 +36,10 @@ namespace Dumux {
 /*!
  * \ingroup Newton
  * \ingroup TwoPTwoCModel
- * \brief A 2p2c specific controller for the newton solver.
+ * \brief A 2p2c specific controller for the Newton solver.
  *
  * This controller 'knows' what a 'physically meaningful' solution is
- * which allows the newton method to abort quicker if the solution is
+ * which allows the Newton method to abort quicker if the solution is
  * way out of bounds.
  */
 template <class TypeTag>
@@ -56,7 +56,7 @@ public:
 
     /*!
      * \brief
-     * Suggest a new time step size based either on the number of newton
+     * Suggest a new time step size based either on the number of Newton
      * iterations required or on the variable switch
      *
      * \param uCurrentIter The current global solution vector

dumux/implicit/2p2c/2p2cproperties.hh

@@ -55,7 +55,7 @@ NEW_PROP_TAG(NumComponents); //!< Number of fluid components in the system
 NEW_PROP_TAG(Indices); //!< Enumerations for the model
 NEW_PROP_TAG(Formulation);   //!< The formulation of the model
 NEW_PROP_TAG(SpatialParams); //!< The type of the spatial parameters
-NEW_PROP_TAG(FluidSystem); //!< Type of the multi-component relations
+NEW_PROP_TAG(FluidSystem); //!< The type of the multi-component relations
 
 NEW_PROP_TAG(MaterialLaw);   //!< The material law which ought to be used (extracted from the spatial parameters)
 NEW_PROP_TAG(MaterialLawParams); //!< The parameters of the material law (extracted from the spatial parameters)
@@ -66,7 +66,7 @@ NEW_PROP_TAG(UseMoles); //!Defines whether mole (true) or mass (false) fractions
 NEW_PROP_TAG(ImplicitMassUpwindWeight); //!< The value of the upwind weight for the mass conservation equations
 NEW_PROP_TAG(ImplicitMobilityUpwindWeight); //!< Weight for the upwind mobility in the velocity calculation
 NEW_PROP_TAG(ReplaceCompEqIdx); //!< The index of the total mass balance equation, if one component balance is replaced (ReplaceCompEqIdx < NumComponents)
-NEW_PROP_TAG(VtkAddVelocity); //!< Returns whether velocity vectors are written into the vtk output
+NEW_PROP_TAG(VtkAddVelocity); //!< Returns whether velocity vectors are written into the VTK output
 NEW_PROP_TAG(BaseFluxVariables); //! The base flux variables
 NEW_PROP_TAG(SpatialParamsForchCoeff); //!< Property for the forchheimer coefficient
 }

dumux/implicit/2p2c/2p2cpropertydefaults.hh

@@ -23,7 +23,7 @@
  * \file
  *
  * \brief Defines default values for most properties required by the
- *        2p2c fully implicit model.
+ *        two-phase two-component fully implicit model.
  */
 #ifndef DUMUX_2P2C_PROPERTY_DEFAULTS_HH
 #define DUMUX_2P2C_PROPERTY_DEFAULTS_HH
@@ -51,7 +51,7 @@ namespace Properties {
 /*!
  * \brief Set the property for the number of components.
  *
- * We just forward the number from the fluid system and use an static
+ * We just forward the number from the fluid system and use a static
  * assert to make sure it is 2.
  */
 SET_PROP(TwoPTwoC, NumComponents)
@@ -69,7 +69,7 @@ SET_PROP(TwoPTwoC, NumComponents)
 /*!
  * \brief Set the property for the number of fluid phases.
  *
- * We just forward the number from the fluid system and use an static
+ * We just forward the number from the fluid system and use a static
  * assert to make sure it is 2.
  */
 SET_PROP(TwoPTwoC, NumPhases)
@@ -106,12 +106,12 @@ SET_PROP(TwoPTwoC, MaterialLawParams)
     typedef typename MaterialLaw::Params type;
 };
 
-//! Use the 2p2c local jacobian operator for the 2p2c model
+//! Use the 2p2c local Jacobian operator for the 2p2c model
 SET_TYPE_PROP(TwoPTwoC,
               LocalResidual,
               TwoPTwoCLocalResidual<TypeTag>);
 
-//! Use the 2p2c specific newton controller for the 2p2c model
+//! Use the 2p2c specific Newton controller for the 2p2c model
 SET_TYPE_PROP(TwoPTwoC, NewtonController, TwoPTwoCNewtonController<TypeTag>);
 
 //! the Model property
@@ -161,7 +161,7 @@ SET_BOOL_PROP(TwoPTwoC, ProblemEnableGravity, true);
 SET_BOOL_PROP(TwoPTwoC, UseMoles, true); //!< Define that mole fractions are used in the balance equations per default
 
 
-//! default value for the forchheimer coefficient
+//! default value for the Forchheimer coefficient
 // Source: Ward, J.C. 1964 Turbulent flow in porous media. ASCE J. Hydraul. Div 90.
 //        Actually the Forchheimer coefficient is also a function of the dimensions of the
 //        porous medium. Taking it as a constant is only a first approximation

dumux/implicit/2p2c/2p2cvolumevariables.hh

@@ -20,7 +20,7 @@
  * \file
  *
  * \brief Contains the quantities which are constant within a
- *        finite volume in the two-phase, two-component model.
+ *        finite volume in the two-phase two-component model.
  */
 #ifndef DUMUX_2P2C_VOLUME_VARIABLES_HH
 #define DUMUX_2P2C_VOLUME_VARIABLES_HH
@@ -45,8 +45,8 @@ namespace Dumux
 /*!
  * \ingroup TwoPTwoCModel
  * \ingroup ImplicitVolumeVariables
- * \brief Contains the quantities which are are constant within a
- *        finite volume in the two-phase, two-component model.
+ * \brief Contains the quantities which are constant within a
+ *        finite volume in the two-phase two-component model.
  */
 template <class TypeTag>
 class TwoPTwoCVolumeVariables : public ImplicitVolumeVariables<TypeTag>
@@ -279,7 +279,7 @@ public:
                 fluidState.setMoleFraction(nPhaseIdx, nCompIdx, moleFractionN[nCompIdx]);
         	}
             // calculate the composition of the remaining phases (as
-            // well as the densities of all phases). this is the job
+            // well as the densities of all phases). This is the job
             // of the "ComputeFromReferencePhase" constraint solver
             ComputeFromReferencePhase::solve(fluidState,
                                              paramCache,
@@ -320,7 +320,7 @@ public:
                 fluidState.setMoleFraction(wPhaseIdx, nCompIdx, moleFractionW[nCompIdx]);
         	}
             // calculate the composition of the remaining phases (as
-            // well as the densities of all phases). this is the job
+            // well as the densities of all phases). This is the job
             // of the "ComputeFromReferencePhase" constraint solver
             ComputeFromReferencePhase::solve(fluidState,
                                              paramCache,
@@ -337,7 +337,7 @@ public:
     }
 
     /*!
-     * \brief Returns the phase state for the control-volume.
+     * \brief Returns the phase state for the control volume.
      */
     const FluidState &fluidState() const
     { return fluidState_; }