From c4241c42f71ea17634390bdcac4208aadb2efbc8 Mon Sep 17 00:00:00 2001 From: melaniel Date: Wed, 23 Feb 2022 15:09:42 +0100 Subject: [PATCH 1/9] [doc][doxygen] Introduce group FaceCenteredStaggeredDiscretization in modules.txt. This group has been used already before, although it did not exist. Additionally, use it more consistently throughout the folder dumux/discretization/facecentered. --- doc/doxygen/modules.txt | 7 ++++++- .../facecentered/staggered/consistentlyorientedgrid.hh | 2 +- .../facecentered/staggered/elementfluxvariablescache.hh | 2 +- .../facecentered/staggered/fvelementgeometry.hh | 2 +- .../facecentered/staggered/fvgridgeometry.hh | 4 ++-- .../facecentered/staggered/gridsupportsconcavecorners.hh | 2 +- 6 files changed, 12 insertions(+), 7 deletions(-) diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 4738348083..098156abd5 100644 --- a/doc/doxygen/modules.txt +++ b/doc/doxygen/modules.txt @@ -262,10 +262,15 @@ * \defgroup CCMpfaDiscretization Multi-point flux approximation (Mpfa) * \brief A cell-centered finite volume scheme with multi-point flux approximation. */ + /*! + * \ingroup Discretization + * \defgroup FaceCenteredStaggeredDiscretization Face-centered staggered FV scheme + * \brief A staggered finite volume scheme with degrees of freedom at cell-centers and facets. In this implementation, momentum control volumes exist. + */ /*! * \ingroup Discretization * \defgroup StaggeredDiscretization Staggered FV scheme - * \brief A staggered finite volume scheme with degrees of freedom at cell-centers and facets. + * \brief A staggered finite volume scheme with degrees of freedom at cell-centers and facets. In this implementation, momentum control volumes do not explicitly exist, but the implementation uses workarounds. */ /*! * \ingroup Discretization diff --git a/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh b/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh index 6bef417d11..f399cb9508 100644 --- a/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh +++ b/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Typetraits + * \ingroup FaceCenteredStaggeredDiscretization * \copydoc Dumux::ConsistentlyOrientedGrid */ #ifndef DUMUX_DISCRETIZATION_FACECENTERED_STAGGERED_CONSISTENTLY_ORIENTED_GRID_HH diff --git a/dumux/discretization/facecentered/staggered/elementfluxvariablescache.hh b/dumux/discretization/facecentered/staggered/elementfluxvariablescache.hh index 708db54a40..d611580dcc 100644 --- a/dumux/discretization/facecentered/staggered/elementfluxvariablescache.hh +++ b/dumux/discretization/facecentered/staggered/elementfluxvariablescache.hh @@ -143,7 +143,7 @@ private: }; /*! - * \ingroup BoxDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief The flux variables caches for an element with caching disabled */ template diff --git a/dumux/discretization/facecentered/staggered/fvelementgeometry.hh b/dumux/discretization/facecentered/staggered/fvelementgeometry.hh index 357cdd273d..fcb365c8e9 100644 --- a/dumux/discretization/facecentered/staggered/fvelementgeometry.hh +++ b/dumux/discretization/facecentered/staggered/fvelementgeometry.hh @@ -218,7 +218,7 @@ private: }; /*! - * \ingroup StaggeredDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief Stencil-local finite volume geometry (scvs and scvfs) for face-centered staggered models * Specialization for grid caching disabled */ diff --git a/dumux/discretization/facecentered/staggered/fvgridgeometry.hh b/dumux/discretization/facecentered/staggered/fvgridgeometry.hh index 875343e64d..a508b8d795 100644 --- a/dumux/discretization/facecentered/staggered/fvgridgeometry.hh +++ b/dumux/discretization/facecentered/staggered/fvgridgeometry.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup FaceCenteredStaggeredFVElementGeometry + * \ingroup FaceCenteredStaggeredDiscretization * \copydoc Dumux::FaceCenteredStaggeredFVGridGeometry */ #ifndef DUMUX_DISCRETIZATION_FACECENTERED_STAGGERED_FV_GRID_GEOMETRY @@ -97,7 +97,7 @@ template Date: Wed, 23 Feb 2022 15:20:19 +0100 Subject: [PATCH 2/9] [doc][doxygen] Introduce group SSTModel in modules.txt. This group has been used already before, although it did not exist. Additionally, use it more consistently throughout the folder dumux/freeflow/rans/twoeq/sst. --- doc/doxygen/modules.txt | 6 ++++++ dumux/freeflow/rans/twoeq/sst/volumevariables.hh | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 098156abd5..003e507041 100644 --- a/doc/doxygen/modules.txt +++ b/doc/doxygen/modules.txt @@ -198,6 +198,12 @@ * \brief Low-Re k-epsilon model * For a detailed model description see freeflow/rans/twoeq/lowrekepsilon/model.hh */ + /*! + * \ingroup TwoEqModel + * \defgroup SSTModel SST model + * \brief SST model + * For a detailed model description see freeflow/rans/twoeq/sst/model.hh + */ /*! * \ingroup FreeflowModels * \defgroup FreeflowNCModel Compositional diff --git a/dumux/freeflow/rans/twoeq/sst/volumevariables.hh b/dumux/freeflow/rans/twoeq/sst/volumevariables.hh index 9b10edfe07..831c15e3af 100644 --- a/dumux/freeflow/rans/twoeq/sst/volumevariables.hh +++ b/dumux/freeflow/rans/twoeq/sst/volumevariables.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup SSTEqModel + * \ingroup SSTModel * * \copydoc Dumux::SSTVolumeVariables */ @@ -33,7 +33,7 @@ namespace Dumux { /*! - * \ingroup SSTEqModel + * \ingroup SSTModel * \brief Volume variables for the isothermal single-phase SST 2-Eq model. */ template -- GitLab From 8ac62dad9e3a28eb3911cb6b897811344d49a61e Mon Sep 17 00:00:00 2001 From: melaniel Date: Wed, 23 Feb 2022 15:38:33 +0100 Subject: [PATCH 3/9] [doc][doxygen] Introduce group FreeFlowPoreNetworkCoupling in modules.txt. This group has been used already before, although it did not exist. Additionally, use it more consistently throughout the folder dumux/multidomain/boundary/freeflowporenetwork. --- doc/doxygen/modules.txt | 5 +++++ .../boundary/freeflowporenetwork/couplingconditions.hh | 2 +- .../boundary/freeflowporenetwork/couplingmanager.hh | 4 ++-- .../freeflowporenetwork/ffmassporenetwork/couplingmanager.hh | 2 +- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 003e507041..49b4e926f1 100644 --- a/doc/doxygen/modules.txt +++ b/doc/doxygen/modules.txt @@ -551,6 +551,11 @@ * \defgroup DarcyDarcyCoupling Darcy-Darcy domain coupling * \brief Couples domains with equal-dimension multi-physics problems in a Darcy-Darcy coupling. */ + /*! + * \ingroup BoundaryCoupling + * \defgroup FreeFlowPoreNetworkCoupling Free flow-Pore network domain coupling + * \brief Couples domains with equal-dimension multi-physics problems in a Free flow-Pore network coupling. + */ /*! * \ingroup BoundaryCoupling * \defgroup StokesDarcyCoupling Stokes-Darcy domain coupling diff --git a/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh b/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh index ced482214d..24dfd86bbf 100644 --- a/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh +++ b/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh @@ -43,7 +43,7 @@ template diff --git a/dumux/multidomain/boundary/freeflowporenetwork/ffmassporenetwork/couplingmanager.hh b/dumux/multidomain/boundary/freeflowporenetwork/ffmassporenetwork/couplingmanager.hh index 46cfe7de46..7e4e29e5e2 100644 --- a/dumux/multidomain/boundary/freeflowporenetwork/ffmassporenetwork/couplingmanager.hh +++ b/dumux/multidomain/boundary/freeflowporenetwork/ffmassporenetwork/couplingmanager.hh @@ -38,7 +38,7 @@ namespace Dumux { /*! - * \ingroup StokesDarcyCoupling + * \ingroup FreeFlowPoreNetworkCoupling * \brief Coupling manager for free-flow mass and pore-network models. */ template -- GitLab From 27e252769a67cc5c137a6398e2ea4d53a0a127ab Mon Sep 17 00:00:00 2001 From: melaniel Date: Wed, 23 Feb 2022 15:52:13 +0100 Subject: [PATCH 4/9] [doc][doxygen] Introduce group FreeFlowPorousMediumCoupling in modules.txt. This group has been used already before, although it did not exist. Additionally, use it more consistently throughout the folder dumux/multidomain/boundary/freeflowporousmedium. --- doc/doxygen/modules.txt | 5 +++++ .../boundary/freeflowporousmedium/couplingconditions.hh | 2 +- .../boundary/freeflowporousmedium/couplingmanager.hh | 4 ++-- .../freeflowporousmedium/ffmasspm/couplingmanager.hh | 2 +- .../freeflowporousmedium/ffmomentumpm/couplingmanager.hh | 2 +- .../freeflowporousmedium/ffmomentumpm/couplingmapper.hh | 4 ++-- 6 files changed, 12 insertions(+), 7 deletions(-) diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 49b4e926f1..3c8f2f9749 100644 --- a/doc/doxygen/modules.txt +++ b/doc/doxygen/modules.txt @@ -556,6 +556,11 @@ * \defgroup FreeFlowPoreNetworkCoupling Free flow-Pore network domain coupling * \brief Couples domains with equal-dimension multi-physics problems in a Free flow-Pore network coupling. */ + /*! + * \ingroup BoundaryCoupling + * \defgroup FreeFlowPorousMediumCoupling Free flow-Porous medium domain coupling + * \brief Couples domains with equal-dimension multi-physics problems in a Free flow-Porous medium coupling. + */ /*! * \ingroup BoundaryCoupling * \defgroup StokesDarcyCoupling Stokes-Darcy domain coupling diff --git a/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh b/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh index 376125a5c0..53906c32e8 100644 --- a/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh +++ b/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh @@ -84,7 +84,7 @@ template diff --git a/dumux/multidomain/boundary/freeflowporousmedium/ffmasspm/couplingmanager.hh b/dumux/multidomain/boundary/freeflowporousmedium/ffmasspm/couplingmanager.hh index e8156b9774..0a54d2657d 100644 --- a/dumux/multidomain/boundary/freeflowporousmedium/ffmasspm/couplingmanager.hh +++ b/dumux/multidomain/boundary/freeflowporousmedium/ffmasspm/couplingmanager.hh @@ -38,7 +38,7 @@ namespace Dumux { /*! - * \ingroup StokesDarcyCoupling + * \ingroup FreeFlowPorousMediumCoupling * \brief Coupling manager for Stokes and Darcy domains with equal dimension. */ template diff --git a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmanager.hh b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmanager.hh index f957e9f65f..aa4e7267f9 100644 --- a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmanager.hh +++ b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmanager.hh @@ -39,7 +39,7 @@ namespace Dumux { /*! - * \ingroup StokesDarcyCoupling + * \ingroup FreeFlowPorousMediumCoupling * \brief Coupling manager for Stokes and Darcy domains with equal dimension. */ template diff --git a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh index d3c229d77a..2548a6cf21 100644 --- a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh +++ b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup DarcyDarcyCoupling + * \ingroup FreeFlowPorousMediumCoupling * \copydoc Dumux::FreeFlowMomentumPorousMediumCouplingMapper */ @@ -40,7 +40,7 @@ namespace Dumux { /*! - * \ingroup DarcyDarcyCoupling + * \ingroup FreeFlowPorousMediumCoupling * \brief the default mapper for conforming equal dimension boundary coupling between two domains (box or cc) * \todo how to extend to arbitrary number of domains? */ -- GitLab From 9baae347618025a866d98183a2e09f70d8d82e60 Mon Sep 17 00:00:00 2001 From: melaniel Date: Wed, 23 Feb 2022 18:44:51 +0100 Subject: [PATCH 5/9] [doc][doxygen] Improve some ingroups. --- dumux/assembly/fclocalassembler.hh | 14 +++++++------- dumux/assembly/fclocalresidual.hh | 4 ++-- dumux/common/fvporousmediumspatialparams.hh | 2 ++ dumux/common/fvspatialparams.hh | 1 + dumux/common/typetraits/problem.hh | 2 +- dumux/freeflow/compositional/zeroeqncmodel.hh | 1 + .../navierstokes/energy/volumevariables.hh | 4 ++-- .../navierstokes/scalarfluxvariablescachefiller.hh | 4 ++-- dumux/freeflow/navierstokes/velocityoutput.hh | 4 ++-- .../rans/twoeq/kepsilon/staggered/localresidual.hh | 2 +- .../freeflow/rans/twoeq/komega/volumevariables.hh | 4 ++-- dumux/freeflow/shallowwater/volumevariables.hh | 2 +- .../constraintsolvers/compositionalflash.hh | 2 +- .../porenetwork/throat/emptycache.hh | 2 +- .../throat/thresholdcapillarypressures.hh | 2 +- .../porenetwork/throat/transmissibility1p.hh | 6 +++--- .../porenetwork/throat/transmissibility2p.hh | 2 +- dumux/material/fluidsystems/h2oair.hh | 2 +- .../boundary/stokesdarcy/couplingdata.hh | 2 +- dumux/multidomain/newtonconvergencewriter.hh | 2 ++ dumux/multidomain/staggeredcouplingmanager.hh | 2 ++ .../staggeredfreeflow/couplingmanager.hh | 4 ++++ dumux/porenetwork/1p/spatialparams.hh | 5 ++--- dumux/porenetwork/2p/gridfluxvariablescache.hh | 6 +++--- dumux/porenetwork/2p/spatialparams.hh | 7 +++---- dumux/porousmediumflow/boxdfm/fvgridgeometry.hh | 2 +- .../boxdfm/subcontrolvolumeface.hh | 2 +- .../porousmediumflow/fvspatialparams1pconstant.hh | 3 ++- dumux/porousmediumflow/mpnc/model.hh | 3 ++- dumux/porousmediumflow/richards/velocityoutput.hh | 4 ++-- dumux/python/porousmediumflow/problem.hh | 2 +- 31 files changed, 58 insertions(+), 46 deletions(-) diff --git a/dumux/assembly/fclocalassembler.hh b/dumux/assembly/fclocalassembler.hh index 8a90e9e941..ad8f2a2914 100644 --- a/dumux/assembly/fclocalassembler.hh +++ b/dumux/assembly/fclocalassembler.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup Assembly - * \ingroup StaggeredDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief An assembler for Jacobian and residual contribution per element (face-centered staggered methods) */ #ifndef DUMUX_FC_LOCAL_ASSEMBLER_HH @@ -54,7 +54,7 @@ using NonVoidOrDefault_t = std::conditional_t, T, Defau /*! * \ingroup Assembly - * \ingroup StaggeredDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief A base class for all local cell-centered assemblers * \tparam TypeTag The TypeTag * \tparam Assembler The assembler type @@ -285,7 +285,7 @@ public: /*! * \ingroup Assembly - * \ingroup StaggeredDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief An assembler for Jacobian and residual contribution per element (Face-centered methods) * \tparam TypeTag The TypeTag * \tparam diffMethod The differentiation method to residual compute derivatives @@ -296,7 +296,7 @@ class FaceCenteredLocalAssembler; /*! * \ingroup Assembly - * \ingroup StaggeredDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief Face-centered scheme local assembler using numeric differentiation and implicit time discretization */ template @@ -508,7 +508,7 @@ public: /*! * \ingroup Assembly - * \ingroup StaggeredDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief TODO docme */ template @@ -619,7 +619,7 @@ public: /*! * \ingroup Assembly - * \ingroup StaggeredDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief TODO docme */ template @@ -739,7 +739,7 @@ public: /*! * \ingroup Assembly - * \ingroup StaggeredDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief TODO docme */ template diff --git a/dumux/assembly/fclocalresidual.hh b/dumux/assembly/fclocalresidual.hh index f9c4a2854e..5d4ff9051f 100644 --- a/dumux/assembly/fclocalresidual.hh +++ b/dumux/assembly/fclocalresidual.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup Assembly - * \ingroup BoxDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief Calculates the element-wise residual for the box scheme */ #ifndef DUMUX_FACECENTERED_LOCAL_RESIDUAL_HH @@ -37,7 +37,7 @@ namespace Dumux { /*! * \ingroup Assembly - * \ingroup BoxDiscretization + * \ingroup FaceCenteredStaggeredDiscretization * \brief The element-wise residual for the box scheme * \tparam TypeTag the TypeTag */ diff --git a/dumux/common/fvporousmediumspatialparams.hh b/dumux/common/fvporousmediumspatialparams.hh index a53eac9bba..b4e15ea9ba 100644 --- a/dumux/common/fvporousmediumspatialparams.hh +++ b/dumux/common/fvporousmediumspatialparams.hh @@ -18,6 +18,7 @@ *****************************************************************************/ /*! * \file + * \ingroup Common * \ingroup SpatialParameters * \brief The base class for spatial parameters in porous medium problems. */ @@ -52,6 +53,7 @@ struct hasPorosityAtPos #endif /*! + * \ingroup Common * \ingroup SpatialParameters * \brief The base class for spatial parameters of porous-medium problems. */ diff --git a/dumux/common/fvspatialparams.hh b/dumux/common/fvspatialparams.hh index 95b07f4554..2d1bf10dcc 100644 --- a/dumux/common/fvspatialparams.hh +++ b/dumux/common/fvspatialparams.hh @@ -35,6 +35,7 @@ namespace Dumux { /*! + * \ingroup Common * \ingroup SpatialParameters * \brief The base class for spatial parameters used with finite-volume schemes. */ diff --git a/dumux/common/typetraits/problem.hh b/dumux/common/typetraits/problem.hh index 64570dea8d..fb7eca4402 100644 --- a/dumux/common/typetraits/problem.hh +++ b/dumux/common/typetraits/problem.hh @@ -36,7 +36,7 @@ struct ProblemTraits; } // end namespace Detail /*! - * \ingroup Common + * \ingroup Typetraits * \brief Type traits for problem classes. */ template diff --git a/dumux/freeflow/compositional/zeroeqncmodel.hh b/dumux/freeflow/compositional/zeroeqncmodel.hh index d4d0875d52..5a69774bb0 100644 --- a/dumux/freeflow/compositional/zeroeqncmodel.hh +++ b/dumux/freeflow/compositional/zeroeqncmodel.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup FreeflowNCModel + * \ingroup ZeroEqModel * * \brief A single-phase, multi-component Reynolds-Averaged Navier-Stokes 0-Eq. model * diff --git a/dumux/freeflow/navierstokes/energy/volumevariables.hh b/dumux/freeflow/navierstokes/energy/volumevariables.hh index 829105f8fa..f8be029dc6 100644 --- a/dumux/freeflow/navierstokes/energy/volumevariables.hh +++ b/dumux/freeflow/navierstokes/energy/volumevariables.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup NIModel + * \ingroup FreeflowNIModel * \brief Base class for the model specific class which provides * access to all volume averaged quantities. */ @@ -51,7 +51,7 @@ struct FreeFlowHeatCondType } // end namespace Detail /*! - * \ingroup NIModel + * \ingroup FreeflowNIModel * \brief The isothermal base class */ template diff --git a/dumux/freeflow/navierstokes/scalarfluxvariablescachefiller.hh b/dumux/freeflow/navierstokes/scalarfluxvariablescachefiller.hh index 8689633c59..433da79050 100644 --- a/dumux/freeflow/navierstokes/scalarfluxvariablescachefiller.hh +++ b/dumux/freeflow/navierstokes/scalarfluxvariablescachefiller.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup FreeflowModels + * \ingroup NavierStokesModel * \brief A helper class to fill the flux variables cache */ #ifndef DUMUX_FREEFLOW_SCALAR_FLUXVARIABLESCACHE_FILLER_HH @@ -39,7 +39,7 @@ template diff --git a/dumux/freeflow/rans/twoeq/kepsilon/staggered/localresidual.hh b/dumux/freeflow/rans/twoeq/kepsilon/staggered/localresidual.hh index 6634756ec2..3a5c4e891f 100644 --- a/dumux/freeflow/rans/twoeq/kepsilon/staggered/localresidual.hh +++ b/dumux/freeflow/rans/twoeq/kepsilon/staggered/localresidual.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup KepsilonModel + * \ingroup KEpsilonModel * \copydoc Dumux::KEpsilonResidualImpl */ #ifndef DUMUX_STAGGERED_KEPSILON_LOCAL_RESIDUAL_HH diff --git a/dumux/freeflow/rans/twoeq/komega/volumevariables.hh b/dumux/freeflow/rans/twoeq/komega/volumevariables.hh index 0288f6f256..5d9fbdde88 100644 --- a/dumux/freeflow/rans/twoeq/komega/volumevariables.hh +++ b/dumux/freeflow/rans/twoeq/komega/volumevariables.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup KOmegaEqModel + * \ingroup KOmegaModel * * \copydoc Dumux::KOmegaVolumeVariables */ @@ -32,7 +32,7 @@ namespace Dumux { /*! - * \ingroup KOmegaEqModel + * \ingroup KOmegaModel * \brief Volume variables for the isothermal single-phase k-omega 2-Eq model. */ template diff --git a/dumux/freeflow/shallowwater/volumevariables.hh b/dumux/freeflow/shallowwater/volumevariables.hh index 6cf905fa08..52450b5d74 100644 --- a/dumux/freeflow/shallowwater/volumevariables.hh +++ b/dumux/freeflow/shallowwater/volumevariables.hh @@ -27,7 +27,7 @@ namespace Dumux { /*! - * \ingroup Shallow water model + * \ingroup ShallowWaterModel * \brief Volume variables for the shallow water equations model. */ template diff --git a/dumux/material/constraintsolvers/compositionalflash.hh b/dumux/material/constraintsolvers/compositionalflash.hh index ad96a4e9db..3184ae385e 100644 --- a/dumux/material/constraintsolvers/compositionalflash.hh +++ b/dumux/material/constraintsolvers/compositionalflash.hh @@ -32,7 +32,7 @@ namespace Dumux { /*! - * \ingroup ConstraintSolver + * \ingroup ConstraintSolvers * \brief Flash calculation routines for compositional sequential models * * Routines for isothermal and isobaric 2p2c and 1p2c flash, assuming an ideal mixture. diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/emptycache.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/emptycache.hh index c28cba5ac2..a87273b886 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/emptycache.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/emptycache.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup PoreNetworkModels + * \ingroup Fluidmatrixinteractions * \brief An empty cache for transmissibility laws using only standard quantities */ #ifndef DUMUX_PNM_EMPTY_CACHE_HH diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/thresholdcapillarypressures.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/thresholdcapillarypressures.hh index a79caf04c9..de80e70503 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/thresholdcapillarypressures.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/thresholdcapillarypressures.hh @@ -19,7 +19,7 @@ /*! * \file - * \ingroup PoreNetworkModels + * \ingroup Fluidmatrixinteractions * \brief Specification of threshold capillary pressures for the PNM. */ #ifndef DUMUX_PNM_THRESHOLD_CAPILLARY_PRESSURES_HH diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility1p.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility1p.hh index 3cd789181b..0492929834 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility1p.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility1p.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup PoreNetworkModels + * \ingroup Fluidmatrixinteractions * \brief Implementation of the single-phase transmissibility laws for throats */ #ifndef DUMUX_PNM_THROAT_TRANSMISSIBILITY_1P_HH @@ -31,7 +31,7 @@ namespace Dumux::PoreNetwork { /*! - * \ingroup PoreNetworkModels + * \ingroup Fluidmatrixinteractions * \brief Collection of single-phase flow throat transmissibilities based on * Bruus, H. (2011). Acoustofluidics 1: Governing equations in microfluidics. Lab on a Chip, 11(22), 3742-3751. * https://backend.orbit.dtu.dk/ws/portalfiles/portal/5900070/rsc%5B1%5D.pdf @@ -115,7 +115,7 @@ protected: }; /*! - * \ingroup PoreNetworkModels + * \ingroup Fluidmatrixinteractions * \brief Single-phase flow throat transmissibility based on Patzek & Silin (2001) https://doi.org/10.1006/jcis.2000.7413 */ template diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh index 9a589a285f..547aaf74bd 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup PoreNetworkModels + * \ingroup Fluidmatrixinteractions * \brief Implementation of the transmissibility laws for throats */ #ifndef DUMUX_PNM_THROAT_TRANSMISSIBILITY_2P_HH diff --git a/dumux/material/fluidsystems/h2oair.hh b/dumux/material/fluidsystems/h2oair.hh index c343f18267..f528e49835 100644 --- a/dumux/material/fluidsystems/h2oair.hh +++ b/dumux/material/fluidsystems/h2oair.hh @@ -43,7 +43,7 @@ namespace Dumux { namespace FluidSystems { /*! - * \ingroup Fluidsytems + * \ingroup Fluidsystems * \brief Policy for the H2O-air fluid system */ template diff --git a/dumux/multidomain/boundary/stokesdarcy/couplingdata.hh b/dumux/multidomain/boundary/stokesdarcy/couplingdata.hh index 25f6a562a4..d5e1776373 100644 --- a/dumux/multidomain/boundary/stokesdarcy/couplingdata.hh +++ b/dumux/multidomain/boundary/stokesdarcy/couplingdata.hh @@ -206,7 +206,7 @@ template @@ -156,6 +158,7 @@ public: /*! * \ingroup MultiDomain + * \ingroup StaggeredDiscretization * \brief evaluates the element residual of a coupled element of domain i which depends on the variables * at the degree of freedom with index dofIdxGlobalJ of domain j * @@ -409,6 +412,7 @@ public: /*! * \ingroup MultiDomain + * \ingroup StaggeredDiscretization * \brief updates all data and variables that are necessary to evaluate the residual of the element of domain i * this is called whenever one of the primary variables that the element residual depends on changes in domain j * diff --git a/dumux/porenetwork/1p/spatialparams.hh b/dumux/porenetwork/1p/spatialparams.hh index 96ef1b3ca1..a19a763f17 100644 --- a/dumux/porenetwork/1p/spatialparams.hh +++ b/dumux/porenetwork/1p/spatialparams.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup PoreNetworkModels + * \ingroup PNMOnePModel * \ingroup SpatialParameters * \brief The spatial parameters for single-phase pore-network models. */ @@ -30,7 +30,6 @@ namespace Dumux::PoreNetwork { /*! - * \ingroup PoreNetworkModels * \ingroup SpatialParameters * \ingroup PNMOnePModel * \brief The base class for spatial parameters for single-phase pore-network models. @@ -45,7 +44,7 @@ public: }; /*! - * \ingroup PoreNetworkModels + * \ingroup PNMOnePModel * \ingroup SpatialParameters * \brief The default class for spatial parameters for single-phase pore-network models. * \note We have this layer for consistency with the two-phase pore-network models. Also, we diff --git a/dumux/porenetwork/2p/gridfluxvariablescache.hh b/dumux/porenetwork/2p/gridfluxvariablescache.hh index 406e7b506a..6b05046147 100644 --- a/dumux/porenetwork/2p/gridfluxvariablescache.hh +++ b/dumux/porenetwork/2p/gridfluxvariablescache.hh @@ -48,7 +48,7 @@ struct PNMTwoPDefaultGridFVCTraits }; /*! - * \ingroup PoreNetworkDiscretization + * \ingroup PNMTwoPModel * \brief Flux variable caches on a gridview * \note The class is specialized for a version with and without grid caching */ @@ -59,7 +59,7 @@ template @@ -229,7 +228,7 @@ private: }; /*! - * \ingroup PoreNetworkModels + * \ingroup PNMTwoPModel * \ingroup SpatialParameters * \brief The default class for spatial parameters for two-phase pore-network models. */ diff --git a/dumux/porousmediumflow/boxdfm/fvgridgeometry.hh b/dumux/porousmediumflow/boxdfm/fvgridgeometry.hh index 5d99c297f5..e3f7536cab 100644 --- a/dumux/porousmediumflow/boxdfm/fvgridgeometry.hh +++ b/dumux/porousmediumflow/boxdfm/fvgridgeometry.hh @@ -425,7 +425,7 @@ private: }; /*! - * \ingroup BoxDiscretization + * \ingroup BoxDFMModel * \brief Base class for the finite volume geometry vector for box schemes * This builds up the sub control volumes and sub control volume faces * \note For caching disabled we store only some essential index maps to build up local systems on-demand in diff --git a/dumux/porousmediumflow/boxdfm/subcontrolvolumeface.hh b/dumux/porousmediumflow/boxdfm/subcontrolvolumeface.hh index c3a96de287..75df575ab2 100644 --- a/dumux/porousmediumflow/boxdfm/subcontrolvolumeface.hh +++ b/dumux/porousmediumflow/boxdfm/subcontrolvolumeface.hh @@ -86,7 +86,7 @@ struct BoxDfmDefaultScvfGeometryTraits }; /*! - * \ingroup BoxDiscretization + * \ingroup BoxDFMModel * \brief Class for a sub control volume face in the box discrete fracture method, i.e a * part of the boundary of a sub control volume we compute fluxes on. * \tparam GV the type of the grid view diff --git a/dumux/porousmediumflow/fvspatialparams1pconstant.hh b/dumux/porousmediumflow/fvspatialparams1pconstant.hh index 0b5badee7f..0067c69cd2 100644 --- a/dumux/porousmediumflow/fvspatialparams1pconstant.hh +++ b/dumux/porousmediumflow/fvspatialparams1pconstant.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup PorousMediumFlow + * \ingroup PorousmediumflowModels * \ingroup SpatialParameters * \brief A spatial params implementation for 1p problem with constant properties */ @@ -31,6 +31,7 @@ namespace Dumux { /*! + * \ingroup PorousmediumflowModels * \ingroup SpatialParameters * \brief A spatial params implementation for 1p problem with constant properties */ diff --git a/dumux/porousmediumflow/mpnc/model.hh b/dumux/porousmediumflow/mpnc/model.hh index 4291442641..0de060b1b3 100644 --- a/dumux/porousmediumflow/mpnc/model.hh +++ b/dumux/porousmediumflow/mpnc/model.hh @@ -154,7 +154,8 @@ struct MPNCModelTraits }; /*! - * \ingroup PorousmediumNonEquilibriumModel + * \ingroup MPNCModel + * \ingroup NonEquilibriumModel * \brief Specifies a number properties of the m-phase n-component model * in conjunction with non-equilibrium. This is necessary because * the mpnc indices are affected by the non-equilibrium which can diff --git a/dumux/porousmediumflow/richards/velocityoutput.hh b/dumux/porousmediumflow/richards/velocityoutput.hh index fb19408378..b0dd0f1949 100644 --- a/dumux/porousmediumflow/richards/velocityoutput.hh +++ b/dumux/porousmediumflow/richards/velocityoutput.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup PorousmediumflowModels + * \ingroup RichardsModel * \brief Velocity output for the Richards model. */ @@ -30,7 +30,7 @@ namespace Dumux { /*! - * \ingroup PorousmediumflowModels + * \ingroup RichardsModel * \brief Velocity output policy for the Richards model. */ template diff --git a/dumux/python/porousmediumflow/problem.hh b/dumux/python/porousmediumflow/problem.hh index 245bf11a9c..7b369fade4 100644 --- a/dumux/python/porousmediumflow/problem.hh +++ b/dumux/python/porousmediumflow/problem.hh @@ -32,7 +32,7 @@ namespace Dumux::Python { /*! - * \ingroup Common + * \ingroup PorousmediumflowModels * \brief A C++ wrapper for a Python PorousMediumFlow problem */ template Date: Mon, 28 Feb 2022 14:57:08 +0100 Subject: [PATCH 6/9] [doc][doxygen] Add some missing documentation. --- dumux/common/enumerate.hh | 1 + .../freeflow/navierstokes/scalarfluxhelper.hh | 10 ++++++++- dumux/geomechanics/spatialparamstraits_.hh | 5 +++++ dumux/io/vtk/intersectionwriter.hh | 21 ++++++++++++++++--- .../pore/2p/multishapelocalrules.hh | 12 ++++++++--- .../freeflowporenetwork/snappygridmanager.hh | 10 ++++++--- 6 files changed, 49 insertions(+), 10 deletions(-) diff --git a/dumux/common/enumerate.hh b/dumux/common/enumerate.hh index d501cde0ab..abca6a8f6e 100644 --- a/dumux/common/enumerate.hh +++ b/dumux/common/enumerate.hh @@ -18,6 +18,7 @@ *****************************************************************************/ /*! * \file + * \ingroup Common * \brief A Python-like enumerate function */ diff --git a/dumux/freeflow/navierstokes/scalarfluxhelper.hh b/dumux/freeflow/navierstokes/scalarfluxhelper.hh index 9e35c8b5f5..4c3e2def54 100644 --- a/dumux/freeflow/navierstokes/scalarfluxhelper.hh +++ b/dumux/freeflow/navierstokes/scalarfluxhelper.hh @@ -16,7 +16,11 @@ * You should have received a copy of the GNU General Public License * * along with this program. If not, see . * *****************************************************************************/ - +/*! + * \file + * \ingroup NavierStokesModel + * \brief Navier Stokes scalar boundary flux helper + */ #ifndef DUMUX_NAVIERSTOKES_SCALAR_BOUNDARY_FLUXHELPER_HH #define DUMUX_NAVIERSTOKES_SCALAR_BOUNDARY_FLUXHELPER_HH @@ -41,6 +45,10 @@ static constexpr bool isNonIsothermal() } // end namespace Detail #endif +/*! + * \ingroup NavierStokesModel + * \brief Navier Stokes scalar boundary flux helper + */ template struct NavierStokesScalarBoundaryFluxHelper { diff --git a/dumux/geomechanics/spatialparamstraits_.hh b/dumux/geomechanics/spatialparamstraits_.hh index 9f50cff096..a6de661f72 100644 --- a/dumux/geomechanics/spatialparamstraits_.hh +++ b/dumux/geomechanics/spatialparamstraits_.hh @@ -16,6 +16,11 @@ * You should have received a copy of the GNU General Public License * * along with this program. If not, see . * *****************************************************************************/ +/*! + * \file + * \ingroup Geomechanics + * \brief helper struct detecting if the user-defined spatial params class has a lameParamsAtPos function + */ #ifndef DUMUX_GEOMECHANICS_SPATIAL_PARAMS_TRAITS__HH #define DUMUX_GEOMECHANICS_SPATIAL_PARAMS_TRAITS__HH #ifndef DOXYGEN diff --git a/dumux/io/vtk/intersectionwriter.hh b/dumux/io/vtk/intersectionwriter.hh index f4e74a2f95..26d6b20b25 100644 --- a/dumux/io/vtk/intersectionwriter.hh +++ b/dumux/io/vtk/intersectionwriter.hh @@ -16,7 +16,11 @@ * You should have received a copy of the GNU General Public License * * along with this program. If not, see . * *****************************************************************************/ - +/*! + * \file + * \ingroup InputOutput + * \brief Intersection writer + */ #ifndef DUMUX_IO_VTK_INTERSECTIONWRITER_HH #define DUMUX_IO_VTK_INTERSECTIONWRITER_HH @@ -32,6 +36,7 @@ namespace Dumux::Detail { /*! + * \ingroup InputOutput * \brief Iterate over the GridViews boundary intersections * This will visit all intersections for which boundary() is true and * neighbor() is false. @@ -118,6 +123,10 @@ private: mutable Intersection intersection_; }; +/*! + * \ingroup InputOutput + * \brief Non conforming intersection iterator factory + */ template class NonConformingIntersectionIteratorFactory { @@ -163,7 +172,10 @@ private: GridView gridView_; }; - +/*! + * \ingroup InputOutput + * \brief Skeleton function for intersection writer + */ template class SkeletonFunction { @@ -247,7 +259,10 @@ private: } // end namespace Dumux::Detail namespace Dumux { - +/*! + * \ingroup InputOutput + * \brief Conforming intersection writer + */ template class ConformingIntersectionWriter : public Detail::NonConformingIntersectionIteratorFactory diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh index 14c56e3d99..54426d3c27 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh @@ -18,9 +18,8 @@ *****************************************************************************/ /*! * \file - * + * \ingroup Fluidmatrixinteractions * \brief Implementation of capillary pressure curves for multiple pore body geometries - * */ #ifndef DUMUX_PNM_2P_LOCAL_RULES_HH #define DUMUX_PNM_2P_LOCAL_RULES_HH @@ -30,7 +29,10 @@ #include "localrulesforplatonicbody.hh" namespace Dumux::PoreNetwork::FluidMatrix { - +/*! + * \ingroup Fluidmatrixinteractions + * \brief LocalRulesTraits for implementation of capillary pressure curves for multiple pore body geometries + */ template struct LocalRulesTraits { @@ -41,6 +43,10 @@ struct LocalRulesTraits using Dodecahedron = TwoPLocalRulesPlatonicBodyDefault; }; +/*! + * \ingroup Fluidmatrixinteractions + * \brief Implementation of capillary pressure curves for multiple pore body geometries + */ template class MultiShapeTwoPLocalRules : public Dumux::FluidMatrix::Adapter, Dumux::FluidMatrix::PcKrSw> { diff --git a/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh b/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh index 681ae23197..4ac719bb81 100644 --- a/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh +++ b/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh @@ -18,8 +18,8 @@ *****************************************************************************/ /*! * \file - * - * A grid creator that matches a free-flow grid to a PNM grid. + * \ingroup FreeFlowPoreNetworkCoupling + * \brief A grid creator that matches a free-flow grid to a PNM grid. */ #ifndef DUMUX_MULTIDOMAIN_BOUNDARY_FREEFLOW_PORENETWORK_SNAPPY_GRID_MANAGER_HH #define DUMUX_MULTIDOMAIN_BOUNDARY_FREEFLOW_PORENETWORK_SNAPPY_GRID_MANAGER_HH @@ -34,7 +34,10 @@ namespace Dumux::PoreNetwork { namespace Detail { - +/*! + * \ingroup FreeFlowPoreNetworkCoupling + * \brief A helper for the grid creator that matches a free-flow grid to a PNM grid. + */ template class SnappyGridManagerHelper { @@ -284,6 +287,7 @@ public: } // end namespace Detail /*! + * \ingroup FreeFlowPoreNetworkCoupling * \brief A grid creator that matches a free-flow grid to a PNM grid. */ template -- GitLab From 94483b578773f210c4d3337063e89ef6c036d277 Mon Sep 17 00:00:00 2001 From: melaniel Date: Mon, 28 Feb 2022 16:23:22 +0100 Subject: [PATCH 7/9] [doc][doxygen] Remove wrong \file. --- dumux/assembly/initialsolution.hh | 2 -- dumux/common/random.hh | 3 --- dumux/multidomain/couplingmanager.hh | 1 - dumux/multidomain/staggeredfreeflow/couplingmanager.hh | 1 - 4 files changed, 7 deletions(-) diff --git a/dumux/assembly/initialsolution.hh b/dumux/assembly/initialsolution.hh index 4054253e0c..9b2442d237 100644 --- a/dumux/assembly/initialsolution.hh +++ b/dumux/assembly/initialsolution.hh @@ -32,7 +32,6 @@ namespace Dumux { /*! - * \file * \ingroup Assembly * \brief Set a solution vector to the initial solution provided by the problem */ @@ -94,7 +93,6 @@ void assembleInitialSolution(SolutionVector& sol, const Problem& problem) } /*! - * \file * \ingroup Assembly * \brief Create a solution vector filled with the initial solution provided by the problem */ diff --git a/dumux/common/random.hh b/dumux/common/random.hh index 23a3ccb063..b6f0af9bb5 100644 --- a/dumux/common/random.hh +++ b/dumux/common/random.hh @@ -31,7 +31,6 @@ namespace Dumux { /*! - * \file * \brief A simple uniform distribution * based on a biased uniform number generator * \note Use this if you need a fast library implementation independent generator @@ -91,7 +90,6 @@ private: }; /*! - * \file * \brief A simple normal distribution * based on a biased uniform number generator and the Box-Mueller transform * \note Use this if you need a fast library implementation independent generator @@ -187,7 +185,6 @@ private: }; /*! - * \file * \brief A simple log-normal distribution * \note Use this if you need a fast library implementation independent generator * without strict requirements about the bias diff --git a/dumux/multidomain/couplingmanager.hh b/dumux/multidomain/couplingmanager.hh index a436852437..890b4f7a32 100644 --- a/dumux/multidomain/couplingmanager.hh +++ b/dumux/multidomain/couplingmanager.hh @@ -49,7 +49,6 @@ auto toRef(const std::tuple& v, std::index_sequence indices) } // end namespace Detail /*! - * \file * \ingroup MultiDomain * \brief The interface of the coupling manager for multi domain problems */ diff --git a/dumux/multidomain/staggeredfreeflow/couplingmanager.hh b/dumux/multidomain/staggeredfreeflow/couplingmanager.hh index cce1114088..4db220b1ca 100644 --- a/dumux/multidomain/staggeredfreeflow/couplingmanager.hh +++ b/dumux/multidomain/staggeredfreeflow/couplingmanager.hh @@ -42,7 +42,6 @@ namespace Dumux { /*! - * \file * \ingroup MultiDomain * \ingroup StaggeredDiscretization * \brief The interface of the coupling manager for free flow systems -- GitLab From c7daa7edb98c2286aecd5dce86b946e1ab04a384 Mon Sep 17 00:00:00 2001 From: melaniel Date: Mon, 28 Feb 2022 17:12:35 +0100 Subject: [PATCH 8/9] [doc][doxygen] Correct and add some documentation. --- dumux/common/typetraits/typetraits.hh | 1 + .../discretization/cellcentered/mpfa/gridvolumevariables.hh | 4 ++++ .../facecentered/staggered/subcontrolvolume.hh | 5 ++++- .../facecentered/staggered/subcontrolvolumeface.hh | 6 +++++- dumux/freeflow/navierstokes/energy/indices.hh | 2 +- dumux/freeflow/navierstokes/energy/iofields.hh | 2 +- dumux/linear/linearsolverparameters.hh | 5 ++++- dumux/linear/linearsolvertraits.hh | 5 ++++- 8 files changed, 24 insertions(+), 6 deletions(-) diff --git a/dumux/common/typetraits/typetraits.hh b/dumux/common/typetraits/typetraits.hh index b738171861..fcc459a358 100644 --- a/dumux/common/typetraits/typetraits.hh +++ b/dumux/common/typetraits/typetraits.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup TypeTraits + * \brief Type traits. */ #ifndef DUMUX_TYPE_TRAITS_HH #define DUMUX_TYPE_TRAITS_HH diff --git a/dumux/discretization/cellcentered/mpfa/gridvolumevariables.hh b/dumux/discretization/cellcentered/mpfa/gridvolumevariables.hh index 35ce8eb32a..0c627be0a2 100644 --- a/dumux/discretization/cellcentered/mpfa/gridvolumevariables.hh +++ b/dumux/discretization/cellcentered/mpfa/gridvolumevariables.hh @@ -29,6 +29,10 @@ namespace Dumux { +/*! + * \ingroup CCMpfaDiscretization + * \brief Traits for the base class for the grid volume variables + */ template struct CCMpfaDefaultGridVolumeVariablesTraits { diff --git a/dumux/discretization/facecentered/staggered/subcontrolvolume.hh b/dumux/discretization/facecentered/staggered/subcontrolvolume.hh index 35b749c884..7299db33ef 100644 --- a/dumux/discretization/facecentered/staggered/subcontrolvolume.hh +++ b/dumux/discretization/facecentered/staggered/subcontrolvolume.hh @@ -55,7 +55,10 @@ struct FaceCenteredDefaultScvGeometryTraits using Geometry = Dune::AxisAlignedCubeGeometry; }; - +/*! + * \ingroup FaceCenteredStaggeredDiscretization + * \brief Face centered staggered sub control volume + */ template> class FaceCenteredStaggeredSubControlVolume { diff --git a/dumux/discretization/facecentered/staggered/subcontrolvolumeface.hh b/dumux/discretization/facecentered/staggered/subcontrolvolumeface.hh index e5029bfbeb..16dab13ac8 100644 --- a/dumux/discretization/facecentered/staggered/subcontrolvolumeface.hh +++ b/dumux/discretization/facecentered/staggered/subcontrolvolumeface.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup FaceCenteredStaggeredDiscretization - * \copydoc Dumux::FreeFlowStaggeredSubControlVolumeFace + * \copydoc Dumux::FaceCenteredStaggeredSubControlVolumeFace */ #ifndef DUMUX_DISCRETIZATION_FACECENTERED_STAGGERED_SUBCONTROLVOLUMEFACE_HH #define DUMUX_DISCRETIZATION_FACECENTERED_STAGGERED_SUBCONTROLVOLUMEFACE_HH @@ -58,6 +58,10 @@ struct FaceCenteredDefaultScvfGeometryTraits using Geometry = Dune::AxisAlignedCubeGeometry; }; +/*! + * \ingroup FaceCenteredStaggeredDiscretization + * \brief Face centered staggered sub control volume face + */ template> class FaceCenteredStaggeredSubControlVolumeFace { diff --git a/dumux/freeflow/navierstokes/energy/indices.hh b/dumux/freeflow/navierstokes/energy/indices.hh index b148b04e1d..a7c905e90f 100644 --- a/dumux/freeflow/navierstokes/energy/indices.hh +++ b/dumux/freeflow/navierstokes/energy/indices.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup FreeflowNIModel - * \copydoc Dumux::FreeflowNonIsothermalIndices + * \copydoc Dumux::NavierStokesEnergyIndices */ #ifndef DUMUX_FREEFLOW_NAVIER_STOKES_ENERGY_INDICES_HH #define DUMUX_FREEFLOW_NAVIER_STOKES_ENERGY_INDICES_HH diff --git a/dumux/freeflow/navierstokes/energy/iofields.hh b/dumux/freeflow/navierstokes/energy/iofields.hh index 202e3ddb9b..b27ebf57be 100644 --- a/dumux/freeflow/navierstokes/energy/iofields.hh +++ b/dumux/freeflow/navierstokes/energy/iofields.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup FreeflowNIModel - * \copydoc Dumux::FreeflowNonIsothermalIOFields + * \copydoc Dumux::NavierStokesEnergyIOFields */ #ifndef DUMUX_FREEFLOW_NAVIERSTOKES_ENERGY_IO_FIELDS_HH #define DUMUX_FREEFLOW_NAVIERSTOKES_ENERGY_IO_FIELDS_HH diff --git a/dumux/linear/linearsolverparameters.hh b/dumux/linear/linearsolverparameters.hh index b222c9dc71..e588fb414c 100644 --- a/dumux/linear/linearsolverparameters.hh +++ b/dumux/linear/linearsolverparameters.hh @@ -33,7 +33,10 @@ #include namespace Dumux { - +/*! + * \ingroup Linear + * \brief Generates a parameter tree required for the linear solvers and precondioners of the Dune ISTL + */ template class LinearSolverParameters { diff --git a/dumux/linear/linearsolvertraits.hh b/dumux/linear/linearsolvertraits.hh index 146e63b40c..638d080c9d 100644 --- a/dumux/linear/linearsolvertraits.hh +++ b/dumux/linear/linearsolvertraits.hh @@ -40,7 +40,10 @@ namespace Dumux { template struct LinearSolverTraitsImpl; -//! The type traits required for using the IstlFactoryBackend +/*! + * \file + * \brief The type traits required for using the IstlFactoryBackend + */ template using LinearSolverTraits = LinearSolverTraitsImpl; -- GitLab From 5c1c57465a755121234fdde528e63f55364d9012 Mon Sep 17 00:00:00 2001 From: melaniel Date: Tue, 1 Mar 2022 10:12:22 +0100 Subject: [PATCH 9/9] [doc][doxygen] Add group PoreNetworkModels in dumux/material/fluidmatrixinteractions/porenetwork. --- .../porenetwork/pore/2p/localrulesforplatonicbody.hh | 4 ++++ .../porenetwork/pore/2p/multishapelocalrules.hh | 3 +++ .../porenetwork/pore/2p/singleshapelocalrules.hh | 2 ++ .../fluidmatrixinteractions/porenetwork/throat/emptycache.hh | 1 + .../porenetwork/throat/thresholdcapillarypressures.hh | 1 + .../porenetwork/throat/transmissibility1p.hh | 3 +++ .../porenetwork/throat/transmissibility2p.hh | 1 + 7 files changed, 15 insertions(+) diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh index b5d011dc59..2b71c403af 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief Pore-local pc-Sw curves for for platonic bodies * (tetrahedron, cube, octahedron, dodecahedron, icosahedron). */ @@ -94,6 +95,7 @@ private: /*! * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief Implementation of the simplified pore-local capillary pressure-saturation curve * for platonic bodies (tetrahedron, cube, octahedron, dodecahedron, icosahedron). * @@ -581,6 +583,7 @@ private: /*! * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief A default configuration for using the VanGenuchten material law */ template @@ -591,6 +594,7 @@ using TwoPLocalRulesPlatonicBodyDefault = SingleShapeTwoPLocalRules diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh index 54426d3c27..a52f0f052d 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief Implementation of capillary pressure curves for multiple pore body geometries */ #ifndef DUMUX_PNM_2P_LOCAL_RULES_HH @@ -31,6 +32,7 @@ namespace Dumux::PoreNetwork::FluidMatrix { /*! * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief LocalRulesTraits for implementation of capillary pressure curves for multiple pore body geometries */ template @@ -45,6 +47,7 @@ struct LocalRulesTraits /*! * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief Implementation of capillary pressure curves for multiple pore body geometries */ template diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh index 0feaca369b..c594969c4a 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief Base classes for standard pore-local pc-Sw curves. */ #ifndef DUMUX_PNM_2P_SINGLE_SHAPE_LOCAL_RULES_HH @@ -33,6 +34,7 @@ namespace Dumux::PoreNetwork::FluidMatrix { /*! * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief Base class for all standard pore-local pc-Sw curves. */ template diff --git a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh index 547aaf74bd..df931fa59c 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/throat/transmissibility2p.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \brief Implementation of the transmissibility laws for throats */ #ifndef DUMUX_PNM_THROAT_TRANSMISSIBILITY_2P_HH -- GitLab