diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 4738348083649526c3c397d51b2e2fc4a114453d..3c8f2f974928ebde638946e822026b6c20747657 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 @@ -262,10 +268,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 @@ -540,6 +551,16 @@ * \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 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/assembly/fclocalassembler.hh b/dumux/assembly/fclocalassembler.hh index 8a90e9e941ea51840445467a55723ee730159d60..ad8f2a29142f3e095d90ecc1d7647452c4436ec7 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 f9c4a2854e24eb75d24081e0b97bab8171fbb255..5d4ff9051f0b1c0ecef361758c9d0173f897f39a 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/assembly/initialsolution.hh b/dumux/assembly/initialsolution.hh index 4054253e0c3f29af95e895b3a407f9cd75053ad8..9b2442d237762c73b47dc01928332ca7de54b296 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/enumerate.hh b/dumux/common/enumerate.hh index d501cde0ab3c1044cd4367c2783f6900126a2d3b..abca6a8f6ec339315d248f075fd6a0d59a238b2b 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/common/fvporousmediumspatialparams.hh b/dumux/common/fvporousmediumspatialparams.hh index a53eac9bba5b2946889bc5e50c55c386906ed94d..b4e15ea9ba0a7dcfa0282b3568cd1751f0133b10 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 95b07f4554d6e5012b7cd6d6fcb78efb3d6d5cea..2d1bf10dcc188eae7d8d5fb0a6d371e992f98c4c 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/random.hh b/dumux/common/random.hh index 23a3ccb0630d642438c5302fabf2ac634ced1548..b6f0af9bb5f843fd93695bbf32512d67a881bd35 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/common/typetraits/problem.hh b/dumux/common/typetraits/problem.hh index 64570dea8df19811f2e425faf554f5eae50ef4d9..fb7eca44026fdc1b1bbaf5d2bc451b07b5ee208b 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/common/typetraits/typetraits.hh b/dumux/common/typetraits/typetraits.hh index b73817186174a9bb268dbb47b92400740382e625..fcc459a358b74cd04819a0847406c8c55c563ff0 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 35ce8eb32a69bb0eb1f9acbcd01dc281b29f3e2e..0c627be0a28276d8e33d5485c8e0e5d42e72c191 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/consistentlyorientedgrid.hh b/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh index 6bef417d11fbf582feff24e768b285afd45f5c10..f399cb950822ea948edafce03386abf9621d621f 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 708db54a407498dee9356c0db86be2d84dda7a97..d611580dcc7a7b051f9de6cfe8311870ce0850e7 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 357cdd273da04a3cee8bd98277a3ce197007040b..fcb365c8e94f303d86a7cf8988d81d8b4b04e847 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 875343e64d9e0a14655fbd612df56d20b0a6ce6d..a508b8d7957b3a9b3d20588fa5793b6424d8980d 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; }; - +/*! + * \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 e5029bfbebf1e91ffe1cd7e57231fa83dba7c170..16dab13ac871c511f57e0b165b7744b3ac449443 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/compositional/zeroeqncmodel.hh b/dumux/freeflow/compositional/zeroeqncmodel.hh index d4d0875d52b68a7093c3e818aee52ee5724acd26..5a69774bb09b42ce73d04f39c1a71d2822672ac8 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/indices.hh b/dumux/freeflow/navierstokes/energy/indices.hh index b148b04e1d41df654ffc9cbb2a9b1ff457dd101b..a7c905e90f2756c6311c16741f55f5cb5c5f3b61 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 202e3ddb9b3ab8453c1176ee1da34192b1a0192c..b27ebf57be0b6a56230266352fad2f55a5a336b5 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/freeflow/navierstokes/energy/volumevariables.hh b/dumux/freeflow/navierstokes/energy/volumevariables.hh index 829105f8fa2c1b410197c9f40096b09106261f51..f8be029dc6f91c2dbbd66de5dd699f3eabfba112 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/scalarfluxhelper.hh b/dumux/freeflow/navierstokes/scalarfluxhelper.hh index 9e35c8b5f5fc34d004d7a69f5e2ce79529e91eb8..4c3e2def54a047119bed5460941f039ee9901357 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/freeflow/navierstokes/scalarfluxvariablescachefiller.hh b/dumux/freeflow/navierstokes/scalarfluxvariablescachefiller.hh index 8689633c5969468b9c59e6dce3a7a2a7ef6fadb5..433da79050699be8dae5adaecafa5ea32dac3c95 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 6634756ec24688bb2a053a61e51c6c1b322f7448..3a5c4e891fab07afc64611b5008239dbf3f6f305 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 0288f6f256573bcd86e3446c7a7aa0ab21571b64..5d9fbdde883c93c56e0a4fe3ea345b6a38645133 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/rans/twoeq/sst/volumevariables.hh b/dumux/freeflow/rans/twoeq/sst/volumevariables.hh index 9b10edfe0723ca6e8eb1346cda548832e998c758..831c15e3afa4fb2ab17bebc253099a79261926a0 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 diff --git a/dumux/freeflow/shallowwater/volumevariables.hh b/dumux/freeflow/shallowwater/volumevariables.hh index 6cf905fa083ecf4b09ee4badf1aeaf04c62c9fea..52450b5d743302787e428e4afef617837532118d 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/geomechanics/spatialparamstraits_.hh b/dumux/geomechanics/spatialparamstraits_.hh index 9f50cff096acf2875a7b7e004045a52b8086ad1f..a6de661f72e454b89f16fc71088f1fc7c573021e 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 f4e74a2f957871a541a6a4fef5b016435daaa0fd..26d6b20b25dde9da746b580c7abd166c41e48ec8 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/linear/linearsolverparameters.hh b/dumux/linear/linearsolverparameters.hh index b222c9dc71e7dc6ee2bb506513b65a831dc85965..e588fb414cf3fc022b81502718e8888d263ee88a 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 146e63b40c12484f80ea3de5e37e287056311ff6..638d080c9d29c96ce414e365b50dad4dc54604d8 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; diff --git a/dumux/material/constraintsolvers/compositionalflash.hh b/dumux/material/constraintsolvers/compositionalflash.hh index ad96a4e9db05545ff4d8d393e0286f2416672119..3184ae385ecca5fd50c15b8cf95c0acb30c4ab0b 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/pore/2p/localrulesforplatonicbody.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/localrulesforplatonicbody.hh index b5d011dc597d55efae76da007ad9768bc3d5c07d..2b71c403afb1d13b5db07120650157b4821292da 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 14c56e3d995476f0538264a7a8786aa65043e244..a52f0f052d6317648d4e039b46432cc11390be7d 100644 --- a/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh +++ b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/multishapelocalrules.hh @@ -18,9 +18,9 @@ *****************************************************************************/ /*! * \file - * + * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels * \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 +30,11 @@ #include "localrulesforplatonicbody.hh" namespace Dumux::PoreNetwork::FluidMatrix { - +/*! + * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels + * \brief LocalRulesTraits for implementation of capillary pressure curves for multiple pore body geometries + */ template struct LocalRulesTraits { @@ -41,6 +45,11 @@ struct LocalRulesTraits using Dodecahedron = TwoPLocalRulesPlatonicBodyDefault; }; +/*! + * \ingroup Fluidmatrixinteractions + * \ingroup PoreNetworkModels + * \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/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh b/dumux/material/fluidmatrixinteractions/porenetwork/pore/2p/singleshapelocalrules.hh index 0feaca369b6eceb5365e8041d2c9378d0b33679b..c594969c4a275a41f27b246b5ab3268d3e95dbfd 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/multidomain/boundary/freeflowporenetwork/couplingconditions.hh b/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh index ced482214d98cae62d422ff5eb7a345a40194cb0..24dfd86bbf78cb70c48b281d85619fb13725e611 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 46cfe7de46d2e2256c5a38dd72e06cd355e4e2f1..7e4e29e5e2c547e78af7b83aa0a1131d57b905c2 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 diff --git a/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh b/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh index 681ae23197deec357dea8804bb1fe13d184f2b48..4ac719bb81cee79b15b99e33bfb3598829185b81 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 diff --git a/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh b/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh index 376125a5c0ca55ced894cb69879ba5562c55c4b6..53906c32e8fb84ec9c664541cd79bfb4a28fe363 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 e8156b97747aff358f6f33891fcb029db0f2380d..0a54d2657d842955d3084d8166ab2f12441251f4 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 f957e9f65f15d9c92dac5e867681b8f63f7d14f3..aa4e7267f99d21f9d361453eec4ca2b3aea6d7f0 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 d3c229d77a85ad9bad97091ef2d7e517f06279ff..2548a6cf21ac565b597afcd39d973a93c54ae91e 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? */ diff --git a/dumux/multidomain/boundary/stokesdarcy/couplingdata.hh b/dumux/multidomain/boundary/stokesdarcy/couplingdata.hh index 25f6a562a4047df4a4fd14fb59ec438b849802a4..d5e1776373a723a324a18e78f81c28e3d9f3dfdc 100644 --- a/dumux/multidomain/boundary/stokesdarcy/couplingdata.hh +++ b/dumux/multidomain/boundary/stokesdarcy/couplingdata.hh @@ -206,7 +206,7 @@ template& 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/newtonconvergencewriter.hh b/dumux/multidomain/newtonconvergencewriter.hh index 2e388284573dcb64ef7db3546842dd90954a992a..9ae83463ee557e70df21b00b955db37bf2425cfc 100644 --- a/dumux/multidomain/newtonconvergencewriter.hh +++ b/dumux/multidomain/newtonconvergencewriter.hh @@ -18,6 +18,7 @@ *****************************************************************************/ /*! * \file + * \ingroup MultiDomain * \ingroup Nonlinear * \brief This class provides the infrastructure to write the * convergence behaviour of the Newton method for @@ -33,6 +34,7 @@ namespace Dumux { /*! + * \ingroup MultiDomain * \ingroup Nonlinear * \brief Writes the intermediate solutions for every Newton iteration * \note To use this create a shared_ptr to an instance of this class in the main file diff --git a/dumux/multidomain/staggeredcouplingmanager.hh b/dumux/multidomain/staggeredcouplingmanager.hh index 3bb5fefddee8cb7ee5300a8a334da78b9078b4e4..bcc133c9001e3b96f9b7f527aeb32e688999ae5f 100644 --- a/dumux/multidomain/staggeredcouplingmanager.hh +++ b/dumux/multidomain/staggeredcouplingmanager.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup MultiDomain + * \ingroup StaggeredDiscretization * \brief The interface of the coupling manager for multi domain problems */ @@ -157,6 +158,7 @@ public: /*! * \ingroup MultiDomain + * \ingroup StaggeredDiscretization * \brief evaluates the face residual of a coupled face of domain i which depends on the variables * at the degree of freedom with index dofIdxGlobalJ of domain j * diff --git a/dumux/multidomain/staggeredfreeflow/couplingmanager.hh b/dumux/multidomain/staggeredfreeflow/couplingmanager.hh index 2685c5c403705fcf695f97076e2ede2df980aa5f..4db220b1ca8614132befa684f80d2b52c56c1620 100644 --- a/dumux/multidomain/staggeredfreeflow/couplingmanager.hh +++ b/dumux/multidomain/staggeredfreeflow/couplingmanager.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup MultiDomain + * \ingroup StaggeredDiscretization * \brief The interface of the coupling manager for multi domain problems */ @@ -41,8 +42,8 @@ namespace Dumux { /*! - * \file * \ingroup MultiDomain + * \ingroup StaggeredDiscretization * \brief The interface of the coupling manager for free flow systems */ template @@ -156,6 +157,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 +411,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 96ef1b3ca1457a4b2ae4fd26febf9287371a2fb9..a19a763f17453238c19d1b55c7940fef3cef0bf2 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 406e7b506ae99d075a89d13d5bc796e755a6ee5b..6b05046147a06a0e4b20da6b8c99f84475c67977 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 5d99c297f54a74fb141504e397697ef09a8fdd72..e3f7536cab0cf57aacb6daa4247675ffdc1c1304 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 c3a96de2872c64f231332ad118e4d9753840e6d0..75df575ab24e697ccc2ce8a05f62cfb3c1037d18 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 0b5badee7fa4af2e3edab7ac4632f0738c68c98c..0067c69cd2dfe20d449d4c1d039dc7afc52f7d30 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 4291442641c79f189968ac3450c372ace45b4a6b..0de060b1b3b152079661f8da3ecb511f33e92b40 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 fb1940837821d449787aee543b49cf543e2f6039..b0dd0f1949907101ccd21f3ca03f01684644f2d6 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 245bf11a9c3afb68a0482cbc9cb84fb8664c40ad..7b369fade43d305c692ea3fa991475f4daa57a17 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