Commit 9c57b8b0 authored by Simon Scholz's avatar Simon Scholz
Browse files

[doxygen] cleanup freeflow ingroups

parent 547ccd7e
......@@ -27,9 +27,7 @@
#include <dumux/common/properties.hh>
#include <dumux/freeflow/compositional/staggered/fluxvariables.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
......
......@@ -29,8 +29,7 @@
#include <dumux/io/name.hh>
#include <dumux/freeflow/navierstokes/iofields.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup FreeflowNCModel
......
......@@ -29,8 +29,7 @@
#include <dumux/freeflow/navierstokes/localresidual.hh>
#include <dumux/freeflow/compositional/staggered/localresidual.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
......
......@@ -30,8 +30,7 @@
#include <dumux/discretization/method.hh>
#include <dumux/freeflow/navierstokes/fluxvariables.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
......@@ -61,8 +60,8 @@ public:
using MolecularDiffusionType = GetPropType<TypeTag, Properties::MolecularDiffusionType>;
/*!
* \brief Computes the flux for the cell center residual.
*/
* \brief Computes the flux for the cell center residual.
*/
template<class ElementVolumeVariables, class ElementFaceVariables, class FluxVariablesCache>
CellCenterPrimaryVariables computeMassFlux(const Problem& problem,
const Element& element,
......
......@@ -93,6 +93,6 @@ public:
return storage;
}
};
}
} // end namespace Dumux
#endif
......@@ -245,7 +245,7 @@ public:
return FluidSystem::molarMass(compIdx);
}
/*!
/*!
* \brief Returns the diffusion coefficient \f$\mathrm{[m^2/s]}\f$
*
* \param compIIdx the index of the component which diffusive
......@@ -258,7 +258,7 @@ public:
return diffCoefficient_[compIIdx][compJIdx];
}
/*!
/*!
* \brief Returns the effective diffusion coefficient \f$\mathrm{[m^2/s]}\f$
*
* \param compIIdx the index of the component which diffusive
......
......@@ -28,8 +28,7 @@
#include <dumux/discretization/method.hh>
#include <dumux/freeflow/navierstokes/staggered/fluxvariables.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
......
......@@ -27,8 +27,8 @@
#include <dumux/common/properties.hh>
#include <dumux/discretization/method.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
class FreeFlowFluxVariablesCacheImplementation
......
......@@ -29,8 +29,7 @@
#include <dumux/common/parameters.hh>
#include <dumux/io/name.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup NavierStokesModel
......
......@@ -28,8 +28,7 @@
#include <dumux/discretization/method.hh>
#include <dumux/freeflow/navierstokes/staggered/localresidual.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
......@@ -45,6 +44,6 @@ class NavierStokesResidualImpl;
template<class TypeTag>
using NavierStokesResidual = NavierStokesResidualImpl<TypeTag, GetPropType<TypeTag, Properties::FVGridGeometry>::discMethod>;
}
} // end namespace Dumux
#endif // DUMUX_NAVIERSTOKES_LOCAL_RESIDUAL_HH
......@@ -53,7 +53,7 @@ using NavierStokesParentProblem =
*
* This implements gravity (if desired) and a function returning the temperature.
* Includes a specialized method used only by the staggered grid discretization.
*
*
*/
template<class TypeTag>
class NavierStokesProblem : public NavierStokesParentProblem<TypeTag>
......
......@@ -86,13 +86,13 @@ public:
using HeatConductionType = GetPropType<TypeTag, Properties::HeatConductionType>;
/*!
* \brief Returns the advective flux over a sub control volume face.
* \param problem The object specifying the problem which ought to be simulated
* \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)
*/
* \brief Returns the advective flux over a sub control volume face.
* \param problem The object specifying the problem which ought to be simulated
* \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)
*/
template<class UpwindTerm>
static Scalar advectiveFluxForCellCenter(const Problem& problem,
const ElementVolumeVariables& elemVolVars,
......@@ -118,20 +118,20 @@ public:
}
/*!
* \brief Computes the flux for the cell center residual (mass balance).
*
* \verbatim
* scvf
* ----------------
* | # current scvf # scvf over which fluxes are calculated
* | #
* | x #~~~~> vel.Self x dof position
* | #
* scvf | # -- element
* ----------------
* scvf
* \endverbatim
*/
* \brief Computes the flux for the cell center residual (mass balance).
*
* \verbatim
* scvf
* ----------------
* | # current scvf # scvf over which fluxes are calculated
* | #
* | x #~~~~> vel.Self x dof position
* | #
* scvf | # -- element
* ----------------
* scvf
* \endverbatim
*/
CellCenterPrimaryVariables computeMassFlux(const Problem& problem,
const Element& element,
const FVElementGeometry& fvGeometry,
......@@ -151,8 +151,8 @@ public:
}
/*!
* \brief Returns the momentum flux over all staggered faces.
*/
* \brief Returns the momentum flux over all staggered faces.
*/
FacePrimaryVariables computeMomentumFlux(const Problem& problem,
const Element& element,
const SubControlVolumeFace& scvf,
......@@ -165,22 +165,22 @@ public:
}
/*!
* \brief Returns the frontal part of the momentum flux.
* This treats the flux over the staggered face at the center of an element,
* parallel to the current scvf where the velocity dof of interest lives.
*
* \verbatim
* scvf
* ---------======= == and # staggered half-control-volume
* | # | current scvf
* | # | # staggered face over which fluxes are calculated
* vel.Opp <~~| #~~> x~~~~> vel.Self
* | # | x dof position
* scvf | # |
* --------======== -- element
* scvf
* \endverbatim
*/
* \brief Returns the frontal part of the momentum flux.
* This treats the flux over the staggered face at the center of an element,
* parallel to the current scvf where the velocity dof of interest lives.
*
* \verbatim
* scvf
* ---------======= == and # staggered half-control-volume
* | # | current scvf
* | # | # staggered face over which fluxes are calculated
* vel.Opp <~~| #~~> x~~~~> vel.Self
* | # | x dof position
* scvf | # |
* --------======== -- element
* scvf
* \endverbatim
*/
FacePrimaryVariables computeFrontalMomentumFlux(const Problem& problem,
const Element& element,
const SubControlVolumeFace& scvf,
......@@ -258,22 +258,22 @@ public:
}
/*!
* \brief Returns the momentum flux over the staggered faces
* perpendicular to the scvf where the velocity dof of interest
* lives (coinciding with the element's scvfs).
*
* \verbatim
* scvf
* ---------####### || and # staggered half-control-volume
* | || | current scvf
* | || | # normal staggered sub faces over which fluxes are calculated
* | || x~~~~> vel.Self
* | || | x dof position
* scvf | || |
* --------######## -- element
* scvf
* \endverbatim
*/
* \brief Returns the momentum flux over the staggered faces
* perpendicular to the scvf where the velocity dof of interest
* lives (coinciding with the element's scvfs).
*
* \verbatim
* scvf
* ---------####### || and # staggered half-control-volume
* | || | current scvf
* | || | # normal staggered sub faces over which fluxes are calculated
* | || x~~~~> vel.Self
* | || | x dof position
* scvf | || |
* --------######## -- element
* scvf
* \endverbatim
*/
FacePrimaryVariables computeLateralMomentumFlux(const Problem& problem,
const Element& element,
const SubControlVolumeFace& scvf,
......@@ -349,26 +349,26 @@ public:
private:
/*!
* \brief Returns the advective momentum flux over the staggered face perpendicular to the scvf
* where the velocity dof of interest lives (coinciding with the element's scvfs).
*
* \verbatim
* ----------------
* | |
* | transp. |
* | vel. |~~~~> vel.Parallel
* | ^ |
* | | |
* scvf ---------####### || and # staggered half-control-volume
* | || | current scvf
* | || | # normal staggered faces over which fluxes are calculated
* | || x~~~~> vel.Self
* | || | x dof position
* scvf | || |
* ---------####### -- elements
* scvf
* \endverbatim
*/
* \brief Returns the advective momentum flux over the staggered face perpendicular to the scvf
* where the velocity dof of interest lives (coinciding with the element's scvfs).
*
* \verbatim
* ----------------
* | |
* | transp. |
* | vel. |~~~~> vel.Parallel
* | ^ |
* | | |
* scvf ---------####### || and # staggered half-control-volume
* | || | current scvf
* | || | # normal staggered faces over which fluxes are calculated
* | || x~~~~> vel.Self
* | || | x dof position
* scvf | || |
* ---------####### -- elements
* scvf
* \endverbatim
*/
FacePrimaryVariables computeAdvectivePartOfLateralMomentumFlux_(const Problem& problem,
const Element& element,
const SubControlVolumeFace& scvf,
......@@ -439,27 +439,27 @@ private:
}
/*!
* \brief Returns the diffusive momentum flux over the staggered face perpendicular to the scvf
* where the velocity dof of interest lives (coinciding with the element's scvfs).
*
* \verbatim
* ----------------
* | |vel.
* | in.norm. |Parallel
* | vel. |~~~~>
* | ^ | ^ out.norm.vel.
* | | | |
* scvf ---------#######::::::::: || and # staggered half-control-volume (own element)
* | || | curr. ::
* | || | scvf :: :: staggered half-control-volume (neighbor element)
* | || x~~~~> ::
* | || | vel. :: # normal staggered faces over which fluxes are calculated
* scvf | || | Self ::
* ---------#######::::::::: x dof position
* scvf
* -- elements
* \endverbatim
*/
* \brief Returns the diffusive momentum flux over the staggered face perpendicular to the scvf
* where the velocity dof of interest lives (coinciding with the element's scvfs).
*
* \verbatim
* ----------------
* | |vel.
* | in.norm. |Parallel
* | vel. |~~~~>
* | ^ | ^ out.norm.vel.
* | | | |
* scvf ---------#######::::::::: || and # staggered half-control-volume (own element)
* | || | curr. ::
* | || | scvf :: :: staggered half-control-volume (neighbor element)
* | || x~~~~> ::
* | || | vel. :: # normal staggered faces over which fluxes are calculated
* scvf | || | Self ::
* ---------#######::::::::: x dof position
* scvf
* -- elements
* \endverbatim
*/
FacePrimaryVariables computeDiffusivePartOfLateralMomentumFlux_(const Problem& problem,
const Element& element,
const SubControlVolumeFace& scvf,
......@@ -546,21 +546,21 @@ private:
}
/*!
* \brief Returns the momentum flux over an inflow or outflow boundary face.
*
* \verbatim
* scvf //
* ---------=======// == and # staggered half-control-volume
* | || #// current scvf
* | || #// # staggered boundary face over which fluxes are calculated
* | || x~~~~> vel.Self
* | || #// x dof position
* scvf | || #//
* --------========// -- element
* scvf //
* // boundary
* \endverbatim
*/
* \brief Returns the momentum flux over an inflow or outflow boundary face.
*
* \verbatim
* scvf //
* ---------=======// == and # staggered half-control-volume
* | || #// current scvf
* | || #// # staggered boundary face over which fluxes are calculated
* | || x~~~~> vel.Self
* | || #// x dof position
* scvf | || #//
* --------========// -- element
* scvf //
* // boundary
* \endverbatim
*/
FacePrimaryVariables inflowOutflowBoundaryFlux_(const Problem& problem,
const Element& element,
const SubControlVolumeFace& scvf,
......
......@@ -30,8 +30,7 @@
#include <dune/common/hybridutilities.hh>
#include <dumux/freeflow/nonisothermal/localresidual.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, DiscretizationMethod discMethod>
......@@ -187,7 +186,7 @@ public:
protected:
/*!
/*!
* \brief Evaluate boundary conditions for a cell center dof
*/
template<class ElementBoundaryTypes>
......@@ -242,7 +241,7 @@ protected:
}
}
/*!
/*!
* \brief Evaluate boundary conditions for a face dof
*/
template<class ElementBoundaryTypes>
......
......@@ -28,8 +28,7 @@
#include <dumux/io/name.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup FreeflowNIModel
......
......@@ -17,9 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup FreeflowModels
* \file
*
* \ingroup FreeflowModels
* \brief Defines a type tag and some properties for free flow models.
*/
......
......@@ -27,8 +27,7 @@
#include <dumux/freeflow/navierstokes/iofields.hh>
#include <dune/common/deprecated.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup RANSModel
......
......@@ -33,7 +33,6 @@
* \mu_\textrm{eff} = \mu + \mu_\textrm{t}
* \f].
*/
#ifndef DUMUX_RANS_MODEL_HH
#define DUMUX_RANS_MODEL_HH
......
......@@ -16,11 +16,11 @@
* 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 OneEqModel
* \copydoc Dumux::OneEqFluxVariables
*/
/*!
* \file
* \ingroup OneEqModel
* \copydoc Dumux::OneEqFluxVariables
*/
#ifndef DUMUX_ONEEQFLUXVARIABLES_HH
#define DUMUX_ONEEQFLUXVARIABLES_HH
......@@ -28,8 +28,7 @@
#include <dumux/freeflow/navierstokes/fluxvariables.hh>
#include <dumux/freeflow/rans/oneeq/staggered/fluxvariables.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseFluxVariables, DiscretizationMethod discMethod>
......
......@@ -26,8 +26,7 @@
#include <dumux/freeflow/rans/iofields.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup OneEqModel
......
......@@ -16,11 +16,11 @@
* 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 OneEqModel
* \copydoc Dumux::OneEqResidual
*/
/*!
* \file
* \ingroup OneEqModel
* \copydoc Dumux::OneEqResidual
*/
#ifndef DUMUX_ONEEQ_LOCAL_RESIDUAL_HH
#define DUMUX_ONEEQ_LOCAL_RESIDUAL_HH
......@@ -29,8 +29,7 @@
#include <dumux/freeflow/navierstokes/localresidual.hh>
#include <dumux/freeflow/rans/oneeq/staggered/localresidual.hh>
namespace Dumux
{
namespace Dumux {
// forward declaration
template<class TypeTag, class BaseLocalResidual, DiscretizationMethod discMethod>
......@@ -46,6 +45,6 @@ class OneEqResidualImpl;
template<class TypeTag, class BaseLocalResidual>
using OneEqResidual = OneEqResidualImpl<TypeTag, BaseLocalResidual, GetPropType<TypeTag, Properties::FVGridGeometry>::discMethod>;
}
} // end namespace Dumux
#endif
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment