diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 5f3a6f54eff887a56c6599f5a02f20414a736d18..053abe0624cfb34adc63616af398ae128c2c7f94 100644 --- a/doc/doxygen/modules.txt +++ b/doc/doxygen/modules.txt @@ -213,24 +213,24 @@ * \defgroup TwoEqModel 2-Eq. Models * \brief Two-equation turbulence models */ - /*! - * \ingroup TwoEqModel - * \defgroup KEpsilonModel K-epsilon model - * \brief K-epsilon model - * For a detailed model decription see freeflow/rans/twoeq/kepsilon/model.hh - */ - /*! - * \ingroup TwoEqModel - * \defgroup KOmegaModel K-omega model - * \brief K-omega model - * For a detailed model decription see freeflow/rans/twoeq/komega/model.hh - */ - /*! - * \ingroup TwoEqModel - * \defgroup LowReKEpsilonModel Low-Re k-epsilon model - * \brief Low-Re k-epsilon model - * For a detailed model decription see freeflow/rans/twoeq/lowrekepsilon/model.hh - */ + /*! + * \ingroup TwoEqModel + * \defgroup KEpsilonModel K-epsilon model + * \brief K-epsilon model + * For a detailed model decription see freeflow/rans/twoeq/kepsilon/model.hh + */ + /*! + * \ingroup TwoEqModel + * \defgroup KOmegaModel K-omega model + * \brief K-omega model + * For a detailed model decription see freeflow/rans/twoeq/komega/model.hh + */ + /*! + * \ingroup TwoEqModel + * \defgroup LowReKEpsilonModel Low-Re k-epsilon model + * \brief Low-Re k-epsilon model + * For a detailed model decription see freeflow/rans/twoeq/lowrekepsilon/model.hh + */ /*! * \ingroup FreeflowModels * \defgroup FreeflowNCModel Compositional @@ -351,6 +351,11 @@ * \defgroup RichardsNCTests Richards multi-component benchmarks and tests * \brief A multi-component transport problem in the unsaturated zone using the RichardsNCModel. The files are listed below. */ + /*! + * \ingroup SolidEnergyTests + * \defgroup SolidEnergyTests Solid energy tests + * \brief Tests for the solid energy model. + */ /*! * \ingroup PorousmediumflowTests * \defgroup TracerTests Tracer benchmarks and tests @@ -464,7 +469,7 @@ */ /*! * \ingroup Flux - * \defgroup BoxFlux Flux related to the Box scheme + * \defgroup BoxFlux Flux related to the box scheme * \brief Flux related to the box scheme */ /*! @@ -654,27 +659,26 @@ * \defgroup AssemblyAndSolvers Assembly and Solvers * \brief Assembling matrices and vectors, solvers for linear and nonlinear equations */ - -/* ***************** Assembly ******************/ -/*! - * \ingroup AssemblyAndSolvers - * \defgroup Assembly Assembly - * \brief Assembly of linear systems (Jacobian and residual) - */ - -/* ***************** Linear ******************/ -/*! - * \ingroup AssemblyAndSolvers - * \defgroup Linear Linear - * \brief Linear solvers and helpers - */ - -/* ***************** Nonlinear ******************/ -/*! - * \ingroup AssemblyAndSolvers - * \defgroup Nonlinear Nonlinear - * \brief Nonlinear solvers: Newton method - */ + /*! + * \ingroup AssemblyAndSolvers + * \defgroup Assembly Assembly + * \brief Assembly of linear systems (Jacobian and residual) + */ + /*! + * \ingroup AssemblyAndSolvers + * \defgroup Linear Linear + * \brief Linear solvers and helpers + */ + /*! + * \ingroup AssemblyAndSolvers + * \defgroup Nonlinear Nonlinear + * \brief Nonlinear solvers: Newton method + */ + /*! + * \ingroup AssemblyAndSolvers + * \defgroup Parallel Parallel + * \brief Files for communication of parallel solvers + */ /* ***************** Common ******************/ /*! diff --git a/dumux/common/boundaryflag.hh b/dumux/common/boundaryflag.hh index 49b7770b134ded64641aa2e0efbc2c6b4b516c2c..8429f47ee15decc509d4b01b91659e54cdafc05f 100644 --- a/dumux/common/boundaryflag.hh +++ b/dumux/common/boundaryflag.hh @@ -30,7 +30,7 @@ namespace Dumux { /*! - * \ingroup InputOutput + * \ingroup Common * \brief Class for accessing boundary flags * \note this works for all grid managers with gmsh meshes. */ diff --git a/dumux/common/doubleexpintegrationconstants.hh b/dumux/common/doubleexpintegrationconstants.hh index 9c5fdaee4d6795bfe8ffd1b473970bff24fd3969..be4b5f8f582253d8ba416880beacaf50e5296638 100644 --- a/dumux/common/doubleexpintegrationconstants.hh +++ b/dumux/common/doubleexpintegrationconstants.hh @@ -48,7 +48,11 @@ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * * *****************************************************************************/ - +/*! + * \file + * \ingroup Common + * \brief Exponential integration abcissas + */ #ifndef DUMUX_COMMON_DOUBLEEXP_INTEGRATION_CONSTANTS_HH #define DUMUX_COMMON_DOUBLEEXP_INTEGRATION_CONSTANTS_HH diff --git a/dumux/common/doubleexpintegrator.hh b/dumux/common/doubleexpintegrator.hh index 0b4ba4c848a64bb2be2f243dd8ac7b1b09801d87..3591e82a01e9f538b0a1456af617dbb178489acf 100644 --- a/dumux/common/doubleexpintegrator.hh +++ b/dumux/common/doubleexpintegrator.hh @@ -48,7 +48,11 @@ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * * *****************************************************************************/ - +/*! + * \file + * \ingroup Common + * \brief A double exponential integrator + */ #ifndef DUMUX_COMMON_DOUBLEEXP_INTEGRATOR_HH #define DUMUX_COMMON_DOUBLEEXP_INTEGRATOR_HH diff --git a/dumux/common/staggeredfvproblem.hh b/dumux/common/staggeredfvproblem.hh index a0ffc55ed33b3950870b9aee6ac15b29c8e21ca1..c74db38cfa03121be5c8a1a4966721fa97ae036b 100644 --- a/dumux/common/staggeredfvproblem.hh +++ b/dumux/common/staggeredfvproblem.hh @@ -19,6 +19,7 @@ /*! * \file * \ingroup Common + * \ingroup StaggeredDiscretization * \brief Base class for all staggered fv problems */ #ifndef DUMUX_STAGGERD_FV_PROBLEM_HH @@ -33,6 +34,7 @@ namespace Dumux { /*! * \ingroup Common + * \ingroup StaggeredDiscretization * \brief Base class for all staggered finite-volume problems * * \note All quantities (regarding the units) are specified assuming a diff --git a/dumux/flux/box/fourierslawnonequilibrium.hh b/dumux/flux/box/fourierslawnonequilibrium.hh index ce617390579306eebd7eea05d0ecd9f840ecdd09..8add74d1306948685fbff064b5c7f2c98fcca85e 100644 --- a/dumux/flux/box/fourierslawnonequilibrium.hh +++ b/dumux/flux/box/fourierslawnonequilibrium.hh @@ -41,7 +41,7 @@ template <class TypeTag, DiscretizationMethod discMethod> class FouriersLawNonEquilibriumImplementation; /*! - * \ingroup BoxFouriersLaw + * \ingroup BoxFlux * \brief Specialization of Fourier's Law for the box method for thermal nonequilibrium models. */ template <class TypeTag> diff --git a/dumux/flux/fluxvariablescaching.hh b/dumux/flux/fluxvariablescaching.hh index 680b3ce2ab572c556a7d4561c22160ff72ef6714..1c63433b154b336cfc02fbc88079e3b2c5c63333 100644 --- a/dumux/flux/fluxvariablescaching.hh +++ b/dumux/flux/fluxvariablescaching.hh @@ -57,7 +57,7 @@ struct _EmptyCache #endif // DOXYGEN /*! - * \ingroup Discretization + * \ingroup Flux * \brief Empty caches to use in a constitutive flux law/process, e.g. Darcy's law */ struct EmptyAdvectionCache : public _EmptyCache {}; diff --git a/dumux/freeflow/compositional/zeroeqncmodel.hh b/dumux/freeflow/compositional/zeroeqncmodel.hh index da41a68fd9852a20eefb43958986ef3744484f93..8d0ee38b41fc7d0f30860f72e81a38095c07490b 100644 --- a/dumux/freeflow/compositional/zeroeqncmodel.hh +++ b/dumux/freeflow/compositional/zeroeqncmodel.hh @@ -57,6 +57,7 @@ struct ZeroEqNC { using InheritsFrom = std::tuple<NavierStokesNC>; }; /////////////////////////////////////////////////////////////////////////// /*! + * \ingroup FreeflowNCModel * \ingroup ZeroEqModel * \brief Traits for the Reynolds-averaged Navier-Stokes 0-Eq. model */ diff --git a/dumux/freeflow/rans/twoeq/indices.hh b/dumux/freeflow/rans/twoeq/indices.hh index 3ce7ab167f04909bd52690eb7aee4f1c8d4be838..484830c58c351e8e23b9feca44e542a480f08fc6 100644 --- a/dumux/freeflow/rans/twoeq/indices.hh +++ b/dumux/freeflow/rans/twoeq/indices.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup RANSModel + * \ingroup TwoEqModel * \copydoc Dumux::RANSTwoEqIndices */ #ifndef DUMUX_RANS_TWO_EQ_INDICES_HH @@ -30,7 +30,7 @@ namespace Dumux { // \{ /*! - * \ingroup RANSModel + * \ingroup TwoEqModel * \brief The common indices for isothermal two-equation RANS models. * * \tparam dimension The dimension of the problem diff --git a/dumux/freeflow/staggeredupwindmethods.hh b/dumux/freeflow/staggeredupwindmethods.hh index 28ff9e223ff24cef88463f2af2fe12f29e4532ac..bc1d6065683de804d2a5c7039726efcb8f69304c 100644 --- a/dumux/freeflow/staggeredupwindmethods.hh +++ b/dumux/freeflow/staggeredupwindmethods.hh @@ -16,9 +16,11 @@ * You should have received a copy of the GNU General Public License * * along with this program. If not, see <http://www.gnu.org/licenses/>. * *****************************************************************************/ -/** \file - * \brief This file contains different higher order methods for approximating the velocity. - */ +/*! + * \file + * \ingroup FreeflowModels + * \brief This file contains different higher order methods for approximating the velocity. + */ #ifndef DUMUX_UPWINDING_METHODS_HH #define DUMUX_UPWINDING_METHODS_HH @@ -33,21 +35,28 @@ namespace Dumux { -//! \brief Available Tvd approaches +/*! + * \ingroup FreeflowModels + * \brief Available Tvd approaches + */ enum class TvdApproach { none, uniform, li, hou }; -//! \brief Available differencing schemes +/*! + * \ingroup FreeflowModels + * \brief Available differencing schemes + */ enum class DifferencingScheme { none, vanleer, vanalbada, minmod, superbee, umist, mclimiter, wahyd }; -/** - * \brief This file contains different higher order methods for approximating the velocity. - */ +/*! + * \ingroup FreeflowModels + * \brief This file contains different higher order methods for approximating the velocity. + */ template<class Scalar, int upwindSchemeOrder> class StaggeredUpwindMethods { diff --git a/dumux/geomechanics/elastic/indices.hh b/dumux/geomechanics/elastic/indices.hh index be7411a149767ca7e35f7dd91edfb00625226644..892b21d155314d62e7228a3e37ccdce57e3fc46d 100644 --- a/dumux/geomechanics/elastic/indices.hh +++ b/dumux/geomechanics/elastic/indices.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup Elastic * \brief Defines the indices for the elastic model */ #ifndef DUMUX_ELASTIC_INDICES_HH @@ -27,7 +27,7 @@ namespace Dumux { /*! - * \ingroup Geomechanics + * \ingroup Elastic * \brief The indices for the linear elasticity model. */ struct ElasticIndices diff --git a/dumux/geomechanics/elastic/localresidual.hh b/dumux/geomechanics/elastic/localresidual.hh index 0c1a3eb6af6e639449b7e1cbb5e76c079449fabe..cf4bc3972c810ac88bb682d6b34aae1dfce835aa 100644 --- a/dumux/geomechanics/elastic/localresidual.hh +++ b/dumux/geomechanics/elastic/localresidual.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup Elastic * \brief Element-wise calculation of the local residual for problems * using the elastic model considering linear elasticity. */ @@ -32,7 +32,7 @@ namespace Dumux { /*! - * \ingroup Geomechanics + * \ingroup Elastic * \brief Element-wise calculation of the local residual for problems * using the elastic model considering linear elasticity. */ diff --git a/dumux/geomechanics/elastic/model.hh b/dumux/geomechanics/elastic/model.hh index 05c041dbf9a42a9f6714a05609a83b65382b99b3..82614c943f8ff39a015ecf7e49dd6a2987a83f91 100644 --- a/dumux/geomechanics/elastic/model.hh +++ b/dumux/geomechanics/elastic/model.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup Elastic * \brief Defines a type tag and some properties for the elastic geomechanical model */ #ifndef DUMUX_GEOMECHANICS_ELASTIC_MODEL_HH @@ -39,7 +39,7 @@ namespace Dumux { /*! - * \ingroup Geomechanics + * \ingroup Elastic * \brief Specifies a number properties of the elastic model */ template< int dim, int numSolidComp > @@ -61,7 +61,7 @@ struct ElasticModelTraits }; /*! - * \ingroup Geomechanics + * \ingroup Elastic * \brief Traits class for the volume variables of the elastic model. * * \tparam PV The type used for primary variables diff --git a/dumux/geomechanics/elastic/volumevariables.hh b/dumux/geomechanics/elastic/volumevariables.hh index fe8836e17a42e2b42c25d706f8cea8634671f13e..add72433a16da2ec191bb871753ee349e28bee76 100644 --- a/dumux/geomechanics/elastic/volumevariables.hh +++ b/dumux/geomechanics/elastic/volumevariables.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup Elastic * \brief Quantities required by the elastic model defined on a sub-control volume. */ #ifndef DUMUX_ELASTIC_VOLUME_VARIABLES_HH @@ -33,7 +33,7 @@ namespace Dumux { /*! - * \ingroup Geomechanics + * \ingroup Elastic * \brief Contains the quantities which are constant within a * finite volume in the elastic model. * diff --git a/dumux/geomechanics/poroelastic/couplingmanager.hh b/dumux/geomechanics/poroelastic/couplingmanager.hh index 498477afc2f7c633e76fcd98158e35ef85b681d4..a49e3e79e4d48cbaac9f8c4bf0aa9af72f30bdb3 100644 --- a/dumux/geomechanics/poroelastic/couplingmanager.hh +++ b/dumux/geomechanics/poroelastic/couplingmanager.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical problem */ @@ -37,7 +37,7 @@ namespace Dumux { /*! * \file - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical problem * * Coupling manager for porous medium flow problems coupled to a poro-mechanical diff --git a/dumux/geomechanics/poroelastic/iofields.hh b/dumux/geomechanics/poroelastic/iofields.hh index 3127c3a21f0f2c9fa40754cfd240673d41be2a3f..3d053899563f249b67f386d61c371fbe495a535e 100644 --- a/dumux/geomechanics/poroelastic/iofields.hh +++ b/dumux/geomechanics/poroelastic/iofields.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Adds I/O fields specific to the poro-elastic model */ #ifndef DUMUX_POROELASTIC_IO_FIELDS_HH @@ -29,7 +29,7 @@ namespace Dumux { /*! - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Adds I/O fields specific to the poro-elastic model */ class PoroElasticIOFields diff --git a/dumux/geomechanics/poroelastic/localresidual.hh b/dumux/geomechanics/poroelastic/localresidual.hh index 26f8f0c53a330a32927f5ef47ff2521764eff70f..9ee1188a70d8135bec27d4a4076d879c6e4071ef 100644 --- a/dumux/geomechanics/poroelastic/localresidual.hh +++ b/dumux/geomechanics/poroelastic/localresidual.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Element-wise calculation of the local residual * for problems using the poroelastic model. */ @@ -31,7 +31,7 @@ namespace Dumux { /*! - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Element-wise calculation of the local residual * for problems using the poroelastic model. */ diff --git a/dumux/geomechanics/poroelastic/model.hh b/dumux/geomechanics/poroelastic/model.hh index cea6945b1254d77fcc8b388b8137305be3a63896..68334dd6e781e40eababcfa2ef37bc3483dec67d 100644 --- a/dumux/geomechanics/poroelastic/model.hh +++ b/dumux/geomechanics/poroelastic/model.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Defines a type tag and some properties for the poroelastic geomechanical model */ #ifndef DUMUX_GEOMECHANICS_POROELASTIC_MODEL_HH @@ -40,7 +40,7 @@ namespace Dumux { /*! - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Specifies a number properties of the poroelastic model */ template< int dim, int numSC, int numFP, int numFC > diff --git a/dumux/geomechanics/poroelastic/volumevariables.hh b/dumux/geomechanics/poroelastic/volumevariables.hh index 3b94dd5ac7a560fbc33d523a1b6a21e3eae7565b..682e7fbf8b818a196679b84ec3be9a41293101f8 100644 --- a/dumux/geomechanics/poroelastic/volumevariables.hh +++ b/dumux/geomechanics/poroelastic/volumevariables.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Quantities required by the poroelastic model defined on a sub-control volume. */ #ifndef DUMUX_POROELASTIC_VOLUME_VARIABLES_HH @@ -29,7 +29,7 @@ namespace Dumux { /*! - * \ingroup Geomechanics + * \ingroup PoroElastic * \brief Contains the quantities which are constant within a * finite volume in the poroelastic model. * diff --git a/dumux/io/grid/gridmanager_alu.hh b/dumux/io/grid/gridmanager_alu.hh index cdf03c364e8babfa3cc909eda3e523b3bd5b1480..1a6906d9ac1f8c2763e29873aa3ab889a43ce77f 100644 --- a/dumux/io/grid/gridmanager_alu.hh +++ b/dumux/io/grid/gridmanager_alu.hh @@ -43,6 +43,7 @@ namespace Dumux { #if HAVE_DUNE_ALUGRID /*! + * \ingroup InputOutput * \brief Provides a grid manager for Dune ALUGrids * from information in the input file * @@ -231,6 +232,10 @@ public: } }; +/*! + * \ingroup InputOutput + * \brief Boundary flag + */ //! alu uses boundary id template<int dim, int dimworld, Dune::ALUGridElementType elType, Dune::ALUGridRefinementType refinementType> class BoundaryFlag<Dune::ALUGrid<dim, dimworld, elType, refinementType>> diff --git a/dumux/io/grid/gridmanager_base.hh b/dumux/io/grid/gridmanager_base.hh index c3ee66b62f2a20bed099e1b00f00b2453e126328..78f56e1c99a0eb2ff5ef058f2d2904d125d2624b 100644 --- a/dumux/io/grid/gridmanager_base.hh +++ b/dumux/io/grid/gridmanager_base.hh @@ -55,6 +55,7 @@ namespace Dumux { /*! + * \ingroup InputOutput * \brief The grid manager (this is the class used by the user) for all supported grid managers that constructs a grid * from information in the input file and handles the data. * \note This class is specialised below for all supported grid managers. It inherits the functionality of the base class Dumux::GridManagerBase. diff --git a/dumux/io/grid/gridmanager_foam.hh b/dumux/io/grid/gridmanager_foam.hh index b591c5be6c2f7ea6fd0076aa6abdbe9ca8e2e33c..8ca5a5633231cabb51701e5bf9532c98bc764da3 100644 --- a/dumux/io/grid/gridmanager_foam.hh +++ b/dumux/io/grid/gridmanager_foam.hh @@ -39,6 +39,7 @@ namespace Dumux { #if HAVE_DUNE_FOAMGRID /*! + * \ingroup InputOutput * \brief Provides a grid manager for FoamGrids * from information in the input file * @@ -95,6 +96,7 @@ public: }; /*! + * \ingroup InputOutput * \brief Provides a grid manager for FoamGrids of dim 1 * from information in the input file * diff --git a/dumux/io/grid/gridmanager_mmesh.hh b/dumux/io/grid/gridmanager_mmesh.hh index 2ef9d76547edd6daa856089e2aee3af672b3dd0b..fc69fcbe5912d1ae9799d9474249618fa24f4d3a 100644 --- a/dumux/io/grid/gridmanager_mmesh.hh +++ b/dumux/io/grid/gridmanager_mmesh.hh @@ -37,6 +37,7 @@ namespace Dumux { #if HAVE_DUNE_MMESH /*! + * \ingroup InputOutput * \brief Provides a grid manager for Dune MMesh * from information in the input file * diff --git a/dumux/io/grid/gridmanager_oned.hh b/dumux/io/grid/gridmanager_oned.hh index 0ae0026e9bc211a7958a768bd3362a446d0c603f..75cbdba920b9f55e430b5e9bfc7ff2b99f30cccf 100644 --- a/dumux/io/grid/gridmanager_oned.hh +++ b/dumux/io/grid/gridmanager_oned.hh @@ -34,6 +34,7 @@ namespace Dumux { /*! + * \ingroup InputOutput * \brief Provides a grid manager for OneDGrids * from information in the input file * diff --git a/dumux/io/grid/gridmanager_sp.hh b/dumux/io/grid/gridmanager_sp.hh index 95b132053cd36468c8e457b8914abd9997cbfe51..645f306b48e3e4590f5e4d27ccd0d80f8557b6a9 100644 --- a/dumux/io/grid/gridmanager_sp.hh +++ b/dumux/io/grid/gridmanager_sp.hh @@ -39,6 +39,7 @@ namespace Dumux { #if HAVE_DUNE_SPGRID /*! + * \ingroup InputOutput * \brief Provides a grid manager for SPGrid * * The following keys are recognized: diff --git a/dumux/io/grid/gridmanager_ug.hh b/dumux/io/grid/gridmanager_ug.hh index 6ede5af6bf05b813a71eea33d7064668505ba087..a112d97c533eab8442367d52830858f6e35296f2 100644 --- a/dumux/io/grid/gridmanager_ug.hh +++ b/dumux/io/grid/gridmanager_ug.hh @@ -38,6 +38,7 @@ namespace Dumux { #if HAVE_UG /*! + * \ingroup InputOutput * \brief Provides a grid manager for UGGrids * from information in the input file * diff --git a/dumux/io/grid/gridmanager_yasp.hh b/dumux/io/grid/gridmanager_yasp.hh index 2f5d6aae94b56085065b8ba8a10205186297809c..5ffbbbc4b3f3cb941c328552b3cbd8ff564ca9b8 100644 --- a/dumux/io/grid/gridmanager_yasp.hh +++ b/dumux/io/grid/gridmanager_yasp.hh @@ -34,6 +34,7 @@ namespace Dumux { /*! + * \ingroup InputOutput * \brief Provides a grid manager for YaspGrids * from information in the input file * @@ -173,6 +174,7 @@ private: }; /*! + * \ingroup InputOutput * \brief Provides a grid manager for YaspGrids with different zones and grading * * All keys are expected to be in group GridParameterGroup. diff --git a/dumux/material/components/ammonia.hh b/dumux/material/components/ammonia.hh index 22ab1ea141ebd6fe74e4bd10be8ca83071a6a33d..4f30f7a1659c7667a685dc532aeb404b7d022b81 100644 --- a/dumux/material/components/ammonia.hh +++ b/dumux/material/components/ammonia.hh @@ -29,6 +29,10 @@ namespace Dumux { namespace Components { +/*! + * \ingroup Components + * \brief A class for the Ammonia (NH3) component properties + */ template <class Scalar> class Ammonia : public Components::Base<Scalar, Ammonia<Scalar> > diff --git a/dumux/material/components/base.hh b/dumux/material/components/base.hh index 23e84bac9c8c73d866731c39001dbb65f446fe0b..14aa6e29a3aef9c6c5e3c5e607577338f782cfb4 100644 --- a/dumux/material/components/base.hh +++ b/dumux/material/components/base.hh @@ -39,9 +39,21 @@ namespace Dumux { namespace Components { +/*! + * \ingroup Components + * \brief IsAqueous struct + */ template <class Component> struct IsAqueous : public std::false_type {}; +/*! + * \ingroup Components + * \brief Base class for all components + * Components provide the thermodynamic relations for the liquid, + * gaseous and/or solid state of a single + * chemical species or a _fixed_ mixture of species. + * Fluid systems use components to compute thermodynamic quantities of phases. + */ template <class ScalarType, class Component> class Base { diff --git a/dumux/material/components/chlorideion.hh b/dumux/material/components/chlorideion.hh index 57ffb73fd71cb3657ecb541b67253b4b4e27bb2b..f4981b4f76d69e2c7e1cac2e4a676209eea318e0 100644 --- a/dumux/material/components/chlorideion.hh +++ b/dumux/material/components/chlorideion.hh @@ -30,6 +30,10 @@ namespace Dumux { namespace Components { +/*! + * \ingroup Components + * \brief A class for the Cl- (Chloride ion) component properties + */ template <class Scalar> class ChlorideIon : public Components::Base<Scalar, ChlorideIon<Scalar> > diff --git a/dumux/material/components/componenttraits.hh b/dumux/material/components/componenttraits.hh index dc6563fdcb18b51bd148c6b6ab8d62d94af8739e..70d515725f2338bac11dd3461557210cbc096136 100644 --- a/dumux/material/components/componenttraits.hh +++ b/dumux/material/components/componenttraits.hh @@ -34,6 +34,10 @@ namespace Dumux { +/*! + * \ingroup Components + * \brief Component traits, i.e. information extracted from components + */ template<class Component> struct ComponentTraits { diff --git a/dumux/material/components/glucose.hh b/dumux/material/components/glucose.hh index 4db90784ab7add77daa98ff2e1e218e612b997b1..17e304537eb894d84ac538b591f7a9944cfbae03 100644 --- a/dumux/material/components/glucose.hh +++ b/dumux/material/components/glucose.hh @@ -30,6 +30,10 @@ namespace Dumux { namespace Components { +/*! + * \ingroup Components + * \brief A class for the Glucose component properties + */ template <class Scalar> class Glucose : public Components::Base<Scalar, Glucose<Scalar> > diff --git a/dumux/material/components/n2.hh b/dumux/material/components/n2.hh index e4f248b40dd73f41ded6cceb4a46bbba6d2903e9..accec3a4dcde9733c41c70f12687d058340b0164 100644 --- a/dumux/material/components/n2.hh +++ b/dumux/material/components/n2.hh @@ -35,7 +35,7 @@ namespace Dumux { namespace Components { /*! - * \ingroup Componentss + * \ingroup Components * \brief Properties of pure molecular nitrogen \f$N_2\f$. * * \tparam Scalar The type used for scalar values diff --git a/dumux/material/components/sodiumion.hh b/dumux/material/components/sodiumion.hh index 4304df72038c97441cd89e9b8a6671b13beabb42..c5889924935ca39330fce2ff2a345bbf489b94d7 100644 --- a/dumux/material/components/sodiumion.hh +++ b/dumux/material/components/sodiumion.hh @@ -30,7 +30,10 @@ namespace Dumux { namespace Components { - +/*! + * \ingroup Components + * \brief A class for the Na+ (Sodium ion) component properties + */ template <class Scalar> class SodiumIon : public Components::Base<Scalar, SodiumIon<Scalar> > diff --git a/dumux/material/components/solid.hh b/dumux/material/components/solid.hh index 0581330f6b4faffe54ebad34aa32aac316942d78..4030fed68ace9c70e9f0a485c8923cd3c06da31b 100644 --- a/dumux/material/components/solid.hh +++ b/dumux/material/components/solid.hh @@ -32,6 +32,10 @@ namespace Dumux { namespace Components { +/*! + * \ingroup Components + * \brief Interface for components that have a solid state + */ template<class Scalar, class Component> class Solid { diff --git a/dumux/material/components/urea.hh b/dumux/material/components/urea.hh index 37d0787299fb1c78f2b49825e7cabd0b58f6011e..5f27451a383574c001578b6dba5b49acf01c9cb1 100644 --- a/dumux/material/components/urea.hh +++ b/dumux/material/components/urea.hh @@ -30,6 +30,9 @@ namespace Dumux { namespace Components { +/*! \ingroup Components + * \brief A class for the Urea component properties + */ template <class Scalar> class Urea : public Components::Base<Scalar, Urea<Scalar> > diff --git a/dumux/nonlinear/findscalarroot.hh b/dumux/nonlinear/findscalarroot.hh index 9eff421612f716515155b01d43fd514b705b7168..20bb5c65d1c148674a576fdf394e3a93d265bd03 100644 --- a/dumux/nonlinear/findscalarroot.hh +++ b/dumux/nonlinear/findscalarroot.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Common + * \ingroup Nonlinear * \brief Root finding algorithms for scalar functions */ #ifndef DUMUX_COMMON_SCALAR_ROOT_FINDING_HH @@ -35,7 +35,7 @@ namespace Dumux { /*! - * \ingroup Common + * \ingroup Nonlinear * \brief Newton's root finding algorithm for scalar functions (secant method) * \param xOld initial guess * \param residual Residual function @@ -76,7 +76,7 @@ Scalar findScalarRootNewton(Scalar xOld, const ResFunc& residual, const DerivFun } /*! - * \ingroup Common + * \ingroup Nonlinear * \brief Newton's root finding algorithm for scalar functions (secant method) * \note The derivative is numerically computed. If the derivative is know use signature with derivative function. * \param xOld initial guess @@ -95,7 +95,7 @@ Scalar findScalarRootNewton(Scalar xOld, const ResFunc& residual, } /*! - * \ingroup Common + * \ingroup Nonlinear * \brief Brent's root finding algorithm for scalar functions * \note Modified from pseudo-code on wikipedia: https://en.wikipedia.org/wiki/Brent%27s_method * \note See also R.P. Brent "An algorithm with guaranteed convergence for finding a zero of a function", The Computer Journal (1971). diff --git a/dumux/parallel/vectorcommdatahandle.hh b/dumux/parallel/vectorcommdatahandle.hh index e2bc4c4f34ce11ee71d5f173c1d8c44a3e9f55cf..74122a6ec7902060a5b86200954affe531558c5f 100644 --- a/dumux/parallel/vectorcommdatahandle.hh +++ b/dumux/parallel/vectorcommdatahandle.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Linear + * \ingroup Parallel * \brief Contains a class to exchange entries of a vector */ #ifndef DUMUX_VECTOR_COMM_DATA_HANDLE_HH @@ -69,7 +69,7 @@ namespace Detail { } // end namespace Detail /*! - * \ingroup Linear + * \ingroup Parallel * \brief A data handle class to exchange entries of a vector */ template<class Mapper, class Vector, int entityCodim, class ScatterOperator> diff --git a/dumux/parallel/vertexhandles.hh b/dumux/parallel/vertexhandles.hh index 0faa96649f2ff23e3c9b54c4ab236b2791b7933c..e6b014acca7d4e82567b580e55cdca3e1f57caca 100644 --- a/dumux/parallel/vertexhandles.hh +++ b/dumux/parallel/vertexhandles.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * \ingroup Assembly + * \ingroup Parallel * \brief Provides data handles for parallel communication which operate on vertices * \note This is useful for schemes with degrees of freedom on vertices (box scheme) */