Commit a8229e1d authored by Melanie Lipp's avatar Melanie Lipp
Browse files

[doxygen] Add some new ingroups in modules.txt and use them in the files.

parent 3f005a8d
Pipeline #3753 waiting for manual action with stages
...@@ -305,6 +305,11 @@ ...@@ -305,6 +305,11 @@
* \defgroup FEMDiscretization Finite element method * \defgroup FEMDiscretization Finite element method
* \brief The finite element method * \brief The finite element method
*/ */
/*!
* \ingroup Discretization
* \defgroup PoreNetworkDiscretization Pore network model discretization
* \brief The pore-network model discretization.
*/
/* ***************** Flux ******************/ /* ***************** Flux ******************/
/*! /*!
* \defgroup Flux Flux * \defgroup Flux Flux
...@@ -330,6 +335,11 @@ ...@@ -330,6 +335,11 @@
* \defgroup CCMpfaFlux Flux related to the cell-centered multi-point flux approximation schemes * \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 * \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 * \ingroup Flux
* \defgroup StaggeredFlux Flux related to the staggered scheme * \defgroup StaggeredFlux Flux related to the staggered scheme
...@@ -602,3 +612,9 @@ ...@@ -602,3 +612,9 @@
* \brief Two-phase (immiscible) flow * \brief Two-phase (immiscible) flow
* For a detailed model description see porenetwork/2p/model.hh * For a detailed model description see porenetwork/2p/model.hh
*/ */
/* ***************** TimeStepping ******************/
/*!
* \defgroup TimeStepping Time stepping
* \brief The time stepping
*/
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief Base class for the local geometry for porenetworks * \brief Base class for the local geometry for porenetworks
*/ */
#ifndef DUMUX_DISCRETIZATION_PNM_FV_ELEMENT_GEOMETRY_HH #ifndef DUMUX_DISCRETIZATION_PNM_FV_ELEMENT_GEOMETRY_HH
...@@ -31,7 +31,7 @@ ...@@ -31,7 +31,7 @@
namespace Dumux::PoreNetwork { namespace Dumux::PoreNetwork {
/*! /*!
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief Base class for the local geometry for porenetworks * \brief Base class for the local geometry for porenetworks
* \tparam GG the finite volume grid geometry type * \tparam GG the finite volume grid geometry type
* \tparam enableFVGridGeometryCache if the grid geometry is cached or not * \tparam enableFVGridGeometryCache if the grid geometry is cached or not
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief Base class for the finite volume geometry for porenetwork models * \brief Base class for the finite volume geometry for porenetwork models
*/ */
#ifndef DUMUX_DISCRETIZATION_PNM_GRID_GEOMETRY_HH #ifndef DUMUX_DISCRETIZATION_PNM_GRID_GEOMETRY_HH
...@@ -459,7 +459,7 @@ private: ...@@ -459,7 +459,7 @@ private:
}; };
/*! /*!
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief The default traits * \brief The default traits
* \tparam the grid view type * \tparam the grid view type
*/ */
...@@ -669,7 +669,7 @@ private: ...@@ -669,7 +669,7 @@ private:
}; };
/*! /*!
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief Base class for the finite volume geometry for porenetwork models * \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 * \note For caching disabled we store only some essential index maps to build up local systems on-demand in
* the corresponding FVElementGeometry * the corresponding FVElementGeometry
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief the sub control volume for pore networks * \brief the sub control volume for pore networks
*/ */
#ifndef DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUME_HH #ifndef DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUME_HH
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
namespace Dumux::PoreNetwork { namespace Dumux::PoreNetwork {
/*! /*!
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief Default traits class * \brief Default traits class
* \tparam GV the type of the grid view * \tparam GV the type of the grid view
*/ */
...@@ -53,7 +53,7 @@ struct PNMDefaultScvGeometryTraits ...@@ -53,7 +53,7 @@ struct PNMDefaultScvGeometryTraits
}; };
/*! /*!
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief the sub control volume for porenetworks * \brief the sub control volume for porenetworks
* \tparam GV the type of the grid view * \tparam GV the type of the grid view
* \tparam T the scv geometry traits * \tparam T the scv geometry traits
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief Base class for a sub control volume face * \brief Base class for a sub control volume face
*/ */
#ifndef DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUMEFACE_HH #ifndef DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUMEFACE_HH
...@@ -30,7 +30,7 @@ ...@@ -30,7 +30,7 @@
namespace Dumux::PoreNetwork { namespace Dumux::PoreNetwork {
/*! /*!
* \ingroup PoreNetworkModels * \ingroup PoreNetworkDiscretization
* \brief Default traits class * \brief Default traits class
* \tparam GV the type of the grid view * \tparam GV the type of the grid view
*/ */
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup PoreNetworkModels * \ingroup PoreNetworkFlux
* \brief This file contains the data which is required to calculate * \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. * the fluxes of the pore network model over a face of a finite volume.
*/ */
...@@ -39,7 +39,7 @@ namespace Dumux::PoreNetwork { ...@@ -39,7 +39,7 @@ namespace Dumux::PoreNetwork {
/*! /*!
* \file * \file
* \ingroup PoreNetworkModels * \ingroup PoreNetworkFlux
* \brief Hagen–Poiseuille-type flux law to describe the advective flux for pore-network models. * \brief Hagen–Poiseuille-type flux law to describe the advective flux for pore-network models.
*/ */
template<class ScalarT, class... TransmissibilityLawTypes> template<class ScalarT, class... TransmissibilityLawTypes>
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup PoreNetworkModels * \ingroup PoreNetworkFlux
* \brief This file contains the data which is required to calculate * \brief This file contains the data which is required to calculate
* diffusive mass fluxes due to molecular diffusion with Fick's law. * diffusive mass fluxes due to molecular diffusion with Fick's law.
*/ */
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
namespace Dumux::PoreNetwork { namespace Dumux::PoreNetwork {
/*! /*!
* \ingroup PoreNetworkModels * \ingroup PoreNetworkFlux
* \brief Specialization of Fick's Law for the pore-network model. * \brief Specialization of Fick's Law for the pore-network model.
*/ */
template<class Scalar, int numPhases, int numComponents, template<class Scalar, int numPhases, int numComponents,
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup PoreNetworkModels * \ingroup PoreNetworkFlux
* \brief This file contains the data which is required to calculate * \brief This file contains the data which is required to calculate
* diffusive heat fluxes with Fourier's law. * diffusive heat fluxes with Fourier's law.
*/ */
...@@ -38,7 +38,7 @@ struct NoDiffusionType {}; ...@@ -38,7 +38,7 @@ struct NoDiffusionType {};
} // end namespace Detail } // end namespace Detail
/*! /*!
* \ingroup PoreNetworkModels * \ingroup PoreNetworkFlux
* \brief Specialization of Fourier's Law for the pore-network model. * \brief Specialization of Fourier's Law for the pore-network model.
*/ */
template<class MolecularDiffusionType = Detail::NoDiffusionType> template<class MolecularDiffusionType = Detail::NoDiffusionType>
......
...@@ -18,6 +18,7 @@ ...@@ -18,6 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup TimeStepping
* \brief Parameters for different multistage time stepping methods * \brief Parameters for different multistage time stepping methods
* \note See e.g. https://en.wikipedia.org/wiki/List_of_Runge%E2%80%93Kutta_methods * \note See e.g. https://en.wikipedia.org/wiki/List_of_Runge%E2%80%93Kutta_methods
*/ */
......
...@@ -18,6 +18,7 @@ ...@@ -18,6 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup TimeStepping
* \brief A time stepper performing a single time step of a transient simulation * \brief A time stepper performing a single time step of a transient simulation
*/ */
#ifndef DUMUX_TIMESTEPPING_MULTISTAGE_TIMESTEPPER_HH #ifndef DUMUX_TIMESTEPPING_MULTISTAGE_TIMESTEPPER_HH
......
...@@ -18,6 +18,7 @@ ...@@ -18,6 +18,7 @@
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \file * \file
* \ingroup TimeStepping
* \brief Class that represents a time level during time integration. * \brief Class that represents a time level during time integration.
*/ */
#ifndef DUMUX_TIMESTEPPING_TIME_LEVEL_HH #ifndef DUMUX_TIMESTEPPING_TIME_LEVEL_HH
......
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