Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
dumux-repositories
dumux
Commits
a8229e1d
Commit
a8229e1d
authored
May 04, 2021
by
Melanie Lipp
Browse files
[doxygen] Add some new ingroups in modules.txt and use them in the files.
parent
3f005a8d
Changes
11
Hide whitespace changes
Inline
Side-by-side
doc/doxygen/modules.txt
View file @
a8229e1d
...
...
@@ -305,6 +305,11 @@
* \defgroup FEMDiscretization Finite element method
* \brief The finite element method
*/
/*!
* \ingroup Discretization
* \defgroup PoreNetworkDiscretization Pore network model discretization
* \brief The pore-network model discretization.
*/
/* ***************** Flux ******************/
/*!
* \defgroup Flux Flux
...
...
@@ -330,6 +335,11 @@
* \defgroup CCMpfaFlux Flux related to the cell-centered multi-point flux approximation schemes
* \brief Flux related to the cell-centered multi-point flux approximation schemes
*/
/*!
* \ingroup Flux
* \defgroup PoreNetworkFlux Flux related to the pore network models
* \brief Flux related to the pore newtwork models
*/
/*!
* \ingroup Flux
* \defgroup StaggeredFlux Flux related to the staggered scheme
...
...
@@ -602,3 +612,9 @@
* \brief Two-phase (immiscible) flow
* For a detailed model description see porenetwork/2p/model.hh
*/
/* ***************** TimeStepping ******************/
/*!
* \defgroup TimeStepping Time stepping
* \brief The time stepping
*/
dumux/discretization/porenetwork/fvelementgeometry.hh
View file @
a8229e1d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief Base class for the local geometry for porenetworks
*/
#ifndef DUMUX_DISCRETIZATION_PNM_FV_ELEMENT_GEOMETRY_HH
...
...
@@ -31,7 +31,7 @@
namespace
Dumux
::
PoreNetwork
{
/*!
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief Base class for the local geometry for porenetworks
* \tparam GG the finite volume grid geometry type
* \tparam enableFVGridGeometryCache if the grid geometry is cached or not
...
...
dumux/discretization/porenetwork/gridgeometry.hh
View file @
a8229e1d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief Base class for the finite volume geometry for porenetwork models
*/
#ifndef DUMUX_DISCRETIZATION_PNM_GRID_GEOMETRY_HH
...
...
@@ -459,7 +459,7 @@ private:
};
/*!
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief The default traits
* \tparam the grid view type
*/
...
...
@@ -669,7 +669,7 @@ private:
};
/*!
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief Base class for the finite volume geometry for porenetwork models
* \note For caching disabled we store only some essential index maps to build up local systems on-demand in
* the corresponding FVElementGeometry
...
...
dumux/discretization/porenetwork/subcontrolvolume.hh
View file @
a8229e1d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief the sub control volume for pore networks
*/
#ifndef DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUME_HH
...
...
@@ -32,7 +32,7 @@
namespace
Dumux
::
PoreNetwork
{
/*!
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief Default traits class
* \tparam GV the type of the grid view
*/
...
...
@@ -53,7 +53,7 @@ struct PNMDefaultScvGeometryTraits
};
/*!
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief the sub control volume for porenetworks
* \tparam GV the type of the grid view
* \tparam T the scv geometry traits
...
...
dumux/discretization/porenetwork/subcontrolvolumeface.hh
View file @
a8229e1d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief Base class for a sub control volume face
*/
#ifndef DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUMEFACE_HH
...
...
@@ -30,7 +30,7 @@
namespace
Dumux
::
PoreNetwork
{
/*!
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Discretization
* \brief Default traits class
* \tparam GV the type of the grid view
*/
...
...
dumux/flux/porenetwork/advection.hh
View file @
a8229e1d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Flux
* \brief This file contains the data which is required to calculate
* the fluxes of the pore network model over a face of a finite volume.
*/
...
...
@@ -39,7 +39,7 @@ namespace Dumux::PoreNetwork {
/*!
* \file
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Flux
* \brief Hagen–Poiseuille-type flux law to describe the advective flux for pore-network models.
*/
template
<
class
ScalarT
,
class
...
TransmissibilityLawTypes
>
...
...
dumux/flux/porenetwork/fickslaw.hh
View file @
a8229e1d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Flux
* \brief This file contains the data which is required to calculate
* diffusive mass fluxes due to molecular diffusion with Fick's law.
*/
...
...
@@ -33,7 +33,7 @@
namespace
Dumux
::
PoreNetwork
{
/*!
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Flux
* \brief Specialization of Fick's Law for the pore-network model.
*/
template
<
class
Scalar
,
int
numPhases
,
int
numComponents
,
...
...
dumux/flux/porenetwork/fourierslaw.hh
View file @
a8229e1d
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Flux
* \brief This file contains the data which is required to calculate
* diffusive heat fluxes with Fourier's law.
*/
...
...
@@ -38,7 +38,7 @@ struct NoDiffusionType {};
}
// end namespace Detail
/*!
* \ingroup PoreNetwork
Models
* \ingroup PoreNetwork
Flux
* \brief Specialization of Fourier's Law for the pore-network model.
*/
template
<
class
MolecularDiffusionType
=
Detail
::
NoDiffusionType
>
...
...
dumux/timestepping/multistagemethods.hh
View file @
a8229e1d
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup TimeStepping
* \brief Parameters for different multistage time stepping methods
* \note See e.g. https://en.wikipedia.org/wiki/List_of_Runge%E2%80%93Kutta_methods
*/
...
...
dumux/timestepping/multistagetimestepper.hh
View file @
a8229e1d
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup TimeStepping
* \brief A time stepper performing a single time step of a transient simulation
*/
#ifndef DUMUX_TIMESTEPPING_MULTISTAGE_TIMESTEPPER_HH
...
...
dumux/timestepping/timelevel.hh
View file @
a8229e1d
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup TimeStepping
* \brief Class that represents a time level during time integration.
*/
#ifndef DUMUX_TIMESTEPPING_TIME_LEVEL_HH
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment