[navierstokes][fluxvars] Improve docu

dumux/freeflow/navierstokes/fluxvariables.hh

@@ -18,13 +18,13 @@
  *****************************************************************************/
 /*!
  * \file
- * \brief Base class for the flux variables
+ * \ingroup NavierStokesModel
+ * \copydoc Dumux::NavierStokesFluxVariables
  */
 #ifndef DUMUX_FREELOW_IMPLICIT_FLUXVARIABLES_HH
 #define DUMUX_FREELOW_IMPLICIT_FLUXVARIABLES_HH
 
 #include <dumux/common/properties.hh>
-#include <dumux/discretization/fluxvariablesbase.hh>
 #include <dumux/discretization/methods.hh>
 
 #include <dumux/freeflow/navierstokes/staggered/fluxvariables.hh>
@@ -32,20 +32,15 @@
 namespace Dumux
 {
 
-namespace Properties
-{
-// forward declaration
-NEW_PROP_TAG(EnableInertiaTerms);
-}
-
 // forward declaration
 template<class TypeTag, DiscretizationMethods Method>
 class NavierStokesFluxVariablesImpl;
 
 /*!
- * \ingroup ImplicitModel
- * \brief The flux variables class
- *        specializations are provided for combinations of physical processes
+ * \ingroup NavierStokesModel
+ * \brief The flux variables class for the Navier-Stokes model.
+          This is a convenience alias for that actual,
+          discretization-specific flux variables.
  * \note  Not all specializations are currently implemented
  */
 template<class TypeTag>

dumux/freeflow/navierstokes/fluxvariablescache.hh

@@ -18,12 +18,12 @@
  *****************************************************************************/
 /*!
  * \file
- * \brief Base class for the flux variables
+ * \ingroup NavierStokesModel
+ * \copydoc Dumux::FreeFlowFluxVariablesCache
  */
 #ifndef DUMUX_FREEFLOW_IMPLICIT_FLUXVARIABLESCACHE_HH
 #define DUMUX_FREEFLOW_IMPLICIT_FLUXVARIABLESCACHE_HH
 
-#include <dune/localfunctions/lagrange/pqkfactory.hh>
 #include <dumux/common/properties.hh>
 #include <dumux/discretization/methods.hh>
 
@@ -35,29 +35,31 @@ class FreeFlowFluxVariablesCacheImplementation
 {};
 
 /*!
- * \ingroup ImplicitModel
- * \brief The flux variables cache classes for porous media.
+ * \ingroup NavierStokesModel
+ * \brief The flux variables cache classes for the Navier-Stokes model.
  *        Store flux stencils and data required for flux calculation
  */
 template<class TypeTag>
 using FreeFlowFluxVariablesCache = FreeFlowFluxVariablesCacheImplementation<TypeTag, GET_PROP_VALUE(TypeTag, DiscretizationMethod)>;
 
-// specialization for the cell centered tpfa method
+/*!
+ * \ingroup NavierStokesModel
+ * \brief The flux variables cache classes for the Navier-Stokes model.
+ *        Store flux stencils and data required for flux calculation. <BR>
+ *        Specialization for the staggered grid discretization.
+ */
 template<class TypeTag>
 class FreeFlowFluxVariablesCacheImplementation<TypeTag, DiscretizationMethods::Staggered>
 {
-    using Scalar = typename GET_PROP_TYPE(TypeTag, Scalar);
     using Problem = typename GET_PROP_TYPE(TypeTag, Problem);
     using GridView = typename GET_PROP_TYPE(TypeTag, GridView);
-    using FluxVariables = typename GET_PROP_TYPE(TypeTag, FluxVariables);
     using FVElementGeometry = typename GET_PROP_TYPE(TypeTag, FVElementGeometry);
     using ElementVolumeVariables = typename GET_PROP_TYPE(TypeTag, ElementVolumeVariables);
     using SubControlVolumeFace = typename GET_PROP_TYPE(TypeTag, SubControlVolumeFace);
     using Element = typename GridView::template Codim<0>::Entity;
-    using IndexType = typename GridView::IndexSet::IndexType;
-    using Stencil = std::vector<IndexType>;
 
 public:
+    //! Do nothing for the staggered grid specialization.
     void update(const Problem& problem,
                 const Element& element,
                 const FVElementGeometry& fvGeometry,

dumux/freeflow/navierstokes/staggered/fluxvariables.hh

@@ -18,7 +18,8 @@
  *****************************************************************************/
 /*!
  * \file
- * \brief Base class for the flux variables
+ * \ingroup NavierStokesModel
+ * \copydoc Dumux::NavierStokesFluxVariablesImpl
  */
 #ifndef DUMUX_NAVIERSTOKES_STAGGERED_FLUXVARIABLES_HH
 #define DUMUX_NAVIERSTOKES_STAGGERED_FLUXVARIABLES_HH
@@ -42,11 +43,9 @@ class NavierStokesFluxVariablesImpl;
 
 
 /*!
- * \ingroup Discretization
- * \brief Base class for the flux variables
- *        Actual flux variables inherit from this class
+ * \ingroup NavierStokesModel
+ * \brief The flux variables class for the Navier-Stokes model using the staggered grid discretization.
  */
-// specialization for immiscible, isothermal flow
 template<class TypeTag>
 class NavierStokesFluxVariablesImpl<TypeTag, DiscretizationMethods::Staggered>
 : public FluxVariablesBase<TypeTag>
@@ -86,6 +85,14 @@ class NavierStokesFluxVariablesImpl<TypeTag, DiscretizationMethods::Staggered>
 
 public:
 
+    /*!
+    * \brief Returns the advective flux over a sub control volume face
+    * \param elemVolVars All volume variables for the element
+    * \param elemFaceVars The face variables
+    * \param scvf The sub control volume face
+    * \param upwindTerm The uwind term (i.e. the advectively transported quantity)
+    * \param isOutflow Determines if we are on an outflow boundary
+    */
     template<class UpwindTerm>
     static Scalar advectiveFluxForCellCenter(const ElementVolumeVariables& elemVolVars,
                                              const ElementFaceVariables& elemFaceVars,
@@ -110,6 +117,9 @@ public:
         return flux;
     }
 
+    /*!
+    * \brief Computes the flux for the cell center residual.
+    */
     CellCenterPrimaryVariables computeFluxForCellCenter(const Problem& problem,
                                                         const Element &element,
                                                         const FVElementGeometry& fvGeometry,
@@ -188,10 +198,6 @@ public:
 
     /*!
     * \brief Returns the normal part of the momentum flux
-    * \param scvf The sub control volume face
-    * \param fvGeometry The finite-volume geometry
-    * \param elemVolVars All volume variables for the element
-    * \param elementFaceVars The face variables
     */
    FacePrimaryVariables computeNormalMomentumFlux(const Problem& problem,
                                                   const Element& element,
@@ -240,10 +246,6 @@ public:
 
    /*!
    * \brief Returns the tangential part of the momentum flux
-   * \param scvf The sub control volume face
-   * \param fvGeometry The finite-volume geometry
-   * \param elemVolVars All volume variables for the element
-   * \param elementFaceVars The face variables
    */
   FacePrimaryVariables computeTangetialMomentumFlux(const Problem& problem,
                                                     const Element& element,