diff --git a/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh b/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh index 295ef7d8d0ef2194e65d4e3ebc4e82eff33cfbee..6bef417d11fbf582feff24e768b285afd45f5c10 100644 --- a/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh +++ b/dumux/discretization/facecentered/staggered/consistentlyorientedgrid.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup Typetraits - * \copydoc Type trait to determine if a grid is oriented consistently + * \copydoc Dumux::ConsistentlyOrientedGrid */ #ifndef DUMUX_DISCRETIZATION_FACECENTERED_STAGGERED_CONSISTENTLY_ORIENTED_GRID_HH #define DUMUX_DISCRETIZATION_FACECENTERED_STAGGERED_CONSISTENTLY_ORIENTED_GRID_HH diff --git a/dumux/discretization/facecentered/staggered/gridsupportsconcavecorners.hh b/dumux/discretization/facecentered/staggered/gridsupportsconcavecorners.hh index 60584593dbdee4cfccd2d1df66767ff45d99babf..2b2a8845188596800ce3cb52474bc8b4860baea0 100644 --- a/dumux/discretization/facecentered/staggered/gridsupportsconcavecorners.hh +++ b/dumux/discretization/facecentered/staggered/gridsupportsconcavecorners.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup Typetraits - * \copydoc Type trait to determine if a grid supports concave corners (e.g. by cutting out a hole from the domain interior) + * \copydoc Dumux::GridSupportsConcaveCorners */ #ifndef DUMUX_DISCRETIZATION_FACECENTERED_STAGGERED_GRID_SUPPORTS_CONCAVE_CORNERS_HH #define DUMUX_DISCRETIZATION_FACECENTERED_STAGGERED_GRID_SUPPORTS_CONCAVE_CORNERS_HH diff --git a/dumux/freeflow/navierstokes/mass/1p/volumevariables.hh b/dumux/freeflow/navierstokes/mass/1p/volumevariables.hh index ed2a0c49d0db00b230cbe2c56ca00fdb2b7aa8a5..6541bb5d30d2c3b255f50529f9c33fef3b17f2bc 100644 --- a/dumux/freeflow/navierstokes/mass/1p/volumevariables.hh +++ b/dumux/freeflow/navierstokes/mass/1p/volumevariables.hh @@ -87,7 +87,6 @@ public: * \param element An element which contains part of the control volume * \param scv The sub-control volume * \param fluidState A container with the current (physical) state of the fluid - * \param solidState A container with the current (physical) state of the solid */ template void completeFluidState(const ElemSol& elemSol, diff --git a/dumux/freeflow/navierstokes/momentum/localresidual.hh b/dumux/freeflow/navierstokes/momentum/localresidual.hh index 6b50f1c3b5578f53403ae649479ac0c38a20d37c..dcff6dd43c755290fc65d02a8589c0762d6c7bba 100644 --- a/dumux/freeflow/navierstokes/momentum/localresidual.hh +++ b/dumux/freeflow/navierstokes/momentum/localresidual.hh @@ -91,6 +91,7 @@ public: * \param problem The problem to solve * \param scv The sub-control volume over which we integrate the storage term * \param volVars The volume variables associated with the scv + * \param isPreviousStorage Bool transferring the information if the storage term is computed at the current or previous time step * \note has to be implemented by the model specific residual class * */ @@ -157,6 +158,7 @@ public: * \param elemVolVars The volume variables for all flux stencil elements * \param scvf The sub control volume face to compute the flux on * \param elemFluxVarsCache The cache related to flux computation + * \param elemBcTypes The element boundary condition types */ NumEqVector computeFlux(const Problem& problem, const Element& element, diff --git a/dumux/freeflow/navierstokes/problem.hh b/dumux/freeflow/navierstokes/problem.hh index 76e4201200940503a0dca8abe888b4381fa5d102..0381b2ee6a24b49cdcfbaace461f47087ab3204a 100644 --- a/dumux/freeflow/navierstokes/problem.hh +++ b/dumux/freeflow/navierstokes/problem.hh @@ -628,6 +628,7 @@ public: * calls temperature(). * * \param globalPos The position in global coordinates where the temperature should be specified. + * \param deprecationHelper The deprecation helper */ [[deprecated("temperature should now be defined in the spatial params with temperature(globalPos)")]] Scalar temperatureAtPos(const GlobalPosition& globalPos, int deprecationHelper = 0) const @@ -728,6 +729,7 @@ public: * calls temperature(). * * \param globalPos The position in global coordinates where the temperature should be specified. + * \param deprecationHelper The deprecation helper */ [[deprecated("temperature should now be defined in the spatial params with temperature(globalPos)")]] Scalar temperatureAtPos(const GlobalPosition &globalPos, int deprecationHelper = 0) const diff --git a/dumux/geometry/distancefield.hh b/dumux/geometry/distancefield.hh index 1cc1cf014b56468b01b1057b30aba6ef85555582..eca596c6a9ddc25c69b9014bff745c91ade0d090 100644 --- a/dumux/geometry/distancefield.hh +++ b/dumux/geometry/distancefield.hh @@ -68,7 +68,7 @@ class AABBDistanceField public: /*! * \brief The constructor. - * \param geometryObjects A vector of geometries describing the boundaries of the spatial domain. + * \param geometries A vector of geometries describing the boundaries of the spatial domain. */ AABBDistanceField(const std::vector& geometries) : tree_(std::make_unique(std::make_shared(geometries))) diff --git a/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh b/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh index 7edf3e6fdeabe23a5b3dc24a6557cb71980b5e19..ced482214d98cae62d422ff5eb7a345a40194cb0 100644 --- a/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh +++ b/dumux/multidomain/boundary/freeflowporenetwork/couplingconditions.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup FreeFlowPoreNetworkCoupling - * \copydoc Dumux::FreeFlowPoreNetworkCouplingData + * \copydoc Dumux::FreeFlowPoreNetworkCouplingConditions */ #ifndef DUMUX_MD_FREEFLOW_PORENETWORK_COUPLINGCONDITIONS_HH diff --git a/dumux/multidomain/boundary/freeflowporenetwork/couplingmanager.hh b/dumux/multidomain/boundary/freeflowporenetwork/couplingmanager.hh index 9f134a7abbb0962250f8d88271e4c0ed1822ead5..372f751298b029d8e081901236980a1b2b12503d 100644 --- a/dumux/multidomain/boundary/freeflowporenetwork/couplingmanager.hh +++ b/dumux/multidomain/boundary/freeflowporenetwork/couplingmanager.hh @@ -440,7 +440,8 @@ public: /*! * \brief If the boundary entity is on a coupling boundary - * \param domainI the domain index for which to compute the flux + * \param domainI the domain index of domain i for which to compute the flux + * \param domainJ the domain index of domain j for which to compute the flux * \param scv the sub control volume */ template diff --git a/dumux/multidomain/boundary/freeflowporenetwork/couplingmapper.hh b/dumux/multidomain/boundary/freeflowporenetwork/couplingmapper.hh index dd1bf510705e04149ceb098334223fb0beef07a6..b721a49bb6c00741cc7be4095133bcadc55ad7a1 100644 --- a/dumux/multidomain/boundary/freeflowporenetwork/couplingmapper.hh +++ b/dumux/multidomain/boundary/freeflowporenetwork/couplingmapper.hh @@ -203,7 +203,7 @@ public: /*! * \brief returns an iteratable container of all indices of degrees of freedom of domain j * that couple with / influence the element residual of the given element of domain i - * \param eIdxI the index of the coupled element of domain í + * \param eIdxI the index of the coupled element of domain i */ const std::vector& freeFlowMassToPoreNetworkCouplingStencil(const std::size_t eIdxI) const { @@ -216,7 +216,7 @@ public: /*! * \brief returns an iteratable container of all indices of degrees of freedom of domain j * that couple with / influence the element residual of the given element of domain i - * \param eIdxI the index of the coupled element of domain í + * \param dofIndex the degree of freedom index */ const std::vector& freeFlowMomentumToPoreNetworkCouplingStencil(const std::size_t dofIndex) const { diff --git a/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh b/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh index 933b5fa2e6cc7f7ee7ed5a67aafd6a22ad9b0b8a..681ae23197deec357dea8804bb1fe13d184f2b48 100644 --- a/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh +++ b/dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh @@ -19,7 +19,7 @@ /*! * \file * - * \copydoc Dumux::SnappyGridManager + * 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 @@ -133,10 +133,11 @@ public: /*! * \brief Returns the lowDim positions intersecting with a given line. * + * \param bulkGridLowerLeft The lower left position of the bulk grid + * \param bulkGridUpperRight The upper right position of the bulk grid + * \param couplingPlaneNormal The normal vector of the coupling plane * \param lowDimGridView The lowDim gridView * \param lowDimGridData The lowDim grid data - * \param couplingPlaneNormal The normal vector of the coupling plane - * \param line The line to check for intersections * \param modelParamGroup The bulk model parameter group */ template @@ -202,10 +203,11 @@ public: /*! * \brief Returns the lowDim positions intersecting with a given line. * + * \param bulkGridLowerLeft The lower left position of the bulk grid + * \param bulkGridUpperRight The upper right position of the bulk grid + * \param couplingPlaneNormal The normal vector of the coupling plane * \param lowDimGridView The lowDim gridView * \param lowDimGridData The lowDim grid data - * \param couplingPlaneNormal The normal vector of the coupling plane - * \param line The line to check for intersections * \param modelParamGroup The bulk model parameter group */ template @@ -220,6 +222,7 @@ public: const auto axisParallelLines = makeAxisParallelLinesFromCouplingPlane(bulkGridLowerLeft, bulkGridUpperRight, couplingPlaneNormal, modelParamGroup); + //The line to check for intersections const auto line = [&]() { for (const auto& l : axisParallelLines) diff --git a/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh b/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh index f32a99a3b89047af3dfae1c15fe872af4d64d798..376125a5c0ca55ced894cb69879ba5562c55c4b6 100644 --- a/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh +++ b/dumux/multidomain/boundary/freeflowporousmedium/couplingconditions.hh @@ -19,7 +19,7 @@ /*! * \file * \ingroup FreeFlowPorousMediumCoupling - * \copydoc Dumux::FreeFlowPorousMediumCouplingData + * \copydoc Dumux::FreeFlowPorousMediumCouplingConditions */ #ifndef DUMUX_MD_FREEFLOW_POROUSMEDIUM_COUPLINGCONDITIONS_HH diff --git a/dumux/multidomain/boundary/freeflowporousmedium/couplingmanager.hh b/dumux/multidomain/boundary/freeflowporousmedium/couplingmanager.hh index cb3b2b57ade83aa1c4952885cf3f9b9d1ad79bec..4a053e637b81ddf23de2c6665dcdd2cb5c192c8d 100644 --- a/dumux/multidomain/boundary/freeflowporousmedium/couplingmanager.hh +++ b/dumux/multidomain/boundary/freeflowporousmedium/couplingmanager.hh @@ -423,7 +423,8 @@ public: /*! * \brief If the boundary entity is on a coupling boundary - * \param domainI the domain index for which to compute the flux + * \param domainI the domain index of domain i for which to compute the flux + * \param domainJ the domain index of domain j for which to compute the flux * \param scv the sub control volume */ template diff --git a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh index 8a5643e919919c53a687aab298e023f61869cac1..d3c229d77a85ad9bad97091ef2d7e517f06279ff 100644 --- a/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh +++ b/dumux/multidomain/boundary/freeflowporousmedium/ffmomentumpm/couplingmapper.hh @@ -230,7 +230,8 @@ public: * that couple with / influence the element residual of the given element of domain i * * \param domainI the domain index of domain i - * \param eIdxI the index of the coupled element of domain í + * \param elementI the coupled element of domain i + * \param scvI the coupled sub control volume of domain i * \param domainJ the domain index of domain j * * \note The element residual definition depends on the discretization scheme of domain i diff --git a/dumux/multidomain/fvgridgeometry.hh b/dumux/multidomain/fvgridgeometry.hh index f9e3e7573f7138ed2c84829003d14c7e51e5121a..3edfde3dbccac207c4aec68713cdb11d3c507f63 100644 --- a/dumux/multidomain/fvgridgeometry.hh +++ b/dumux/multidomain/fvgridgeometry.hh @@ -125,7 +125,7 @@ public: * * The number of arguments has to match the number of subdomains. * In case a constructor needs multiple arguments, they have to be wrapped in a std::tuple. - * Use std::make_tuple and possible wrap arguments using std::ref/std::cref or use std::forward_as_tuple. + * Use std::make_tuple and possible wrap arguments using std::ref / std::cref or use std::forward_as_tuple. * If an argument is a tuple, it will be unpacked and its members will be passed to the constructor. * In the corner case where you need to pass a tuple to the constructor, * you therefore need to additionally wrap the tuple in a tuple before passing. @@ -171,7 +171,7 @@ public: * * The number of arguments has to match the number of subdomains. * In case the update function needs multiple arguments, they have to be wrapped in a std::tuple. - * Use std::make_tuple and possible wrap arguments using std::ref/std::cref or use std::forward_as_tuple. + * Use std::make_tuple and possible wrap arguments using std::ref / std::cref or use std::forward_as_tuple. * If an argument is a tuple, it will be unpacked and its members will be passed to the constructor. * In the corner case where you need to pass a tuple to the constructor, * you therefore need to additionally wrap the tuple in a tuple before passing. diff --git a/dumux/multidomain/fvproblem.hh b/dumux/multidomain/fvproblem.hh index 0cc4a8d2e36889e2b25dc3fb01b27046faa80dc5..af9e2ace70a56f6bf3e18bc5a4c9e124553132d4 100644 --- a/dumux/multidomain/fvproblem.hh +++ b/dumux/multidomain/fvproblem.hh @@ -84,7 +84,7 @@ public: /*! * \brief Construct wrapper from a tuple of problems - * \param ggTuple a tuple of shared_ptrs to the problems + * \param problemTuple a tuple of shared_ptrs to the problems */ MultiDomainFVProblem(TupleType problemTuple) : problems_(std::move(problemTuple)) diff --git a/dumux/multidomain/staggeredfreeflow/couplingmanager.hh b/dumux/multidomain/staggeredfreeflow/couplingmanager.hh index 1ccfd7c754b28e3514cfbe44347714ee81bbdbb6..2685c5c403705fcf695f97076e2ede2df980aa5f 100644 --- a/dumux/multidomain/staggeredfreeflow/couplingmanager.hh +++ b/dumux/multidomain/staggeredfreeflow/couplingmanager.hh @@ -161,6 +161,7 @@ public: * * \param domainI the domain index of domain i * \param localAssemblerI the local assembler assembling the element residual of an element of domain i + * \param scvI the sub-control-volume of domain i * \param domainJ the domain index of domain j * \param dofIdxGlobalJ the index of the degree of freedom of domain j which has an influence on the element residual of domain i * diff --git a/dumux/multidomain/subdomainboxlocalassembler.hh b/dumux/multidomain/subdomainboxlocalassembler.hh index 9ad5a02366aff69933025a025c58cf149afd16c5..32a1088a30d3de60503686c6af2f00ceb3bdbee8 100644 --- a/dumux/multidomain/subdomainboxlocalassembler.hh +++ b/dumux/multidomain/subdomainboxlocalassembler.hh @@ -491,8 +491,6 @@ public: /*! * \brief Computes the derivatives with respect to the given element and adds them * to the global matrix. - * - * \return The element residual at the current solution. */ template void assembleJacobianCoupling(Dune::index_constant domainJ, JacobianBlock& A, diff --git a/dumux/multidomain/subdomaincclocalassembler.hh b/dumux/multidomain/subdomaincclocalassembler.hh index 74a98682eb7f5f0a8b58f45d5422d5d7d0003c58..313e6e66d008ced09ba289345dfb03084ea6a18f 100644 --- a/dumux/multidomain/subdomaincclocalassembler.hh +++ b/dumux/multidomain/subdomaincclocalassembler.hh @@ -906,8 +906,6 @@ public: /*! * \brief Computes the derivatives with respect to the given element and adds them * to the global matrix. - * - * \return The element residual at the current solution. */ template void assembleJacobianCoupling(Dune::index_constant domainJ, JacobianBlock& A, diff --git a/dumux/multidomain/subdomainfclocalassembler.hh b/dumux/multidomain/subdomainfclocalassembler.hh index da4f5fdfe5df2eb98d8da8843e3d813e9c547495..da0d064d701152b766aeb61893dadeba345848ce 100644 --- a/dumux/multidomain/subdomainfclocalassembler.hh +++ b/dumux/multidomain/subdomainfclocalassembler.hh @@ -294,8 +294,6 @@ public: /*! * \brief Computes the derivatives with respect to the given element and adds them * to the global matrix. - * - * \return The element residual at the current solution. */ template void assembleJacobianCoupling(Dune::index_constant domainJ, JacobianBlock& A, diff --git a/dumux/multidomain/subdomainstaggeredlocalassembler.hh b/dumux/multidomain/subdomainstaggeredlocalassembler.hh index 6b3ddadfd49203b4ca87fa5c6dcc45429d89b6b6..846587f4f9e2ab4651192ec7d6f2dc34aeae76ea 100644 --- a/dumux/multidomain/subdomainstaggeredlocalassembler.hh +++ b/dumux/multidomain/subdomainstaggeredlocalassembler.hh @@ -714,8 +714,6 @@ public: /*! * \brief Computes the derivatives with respect to the given element and adds them * to the global matrix. - * - * \return The element residual at the current solution. */ template void assembleJacobianCellCenterCoupling(Dune::index_constant domainJ, JacobianBlock& A, @@ -836,8 +834,6 @@ public: /*! * \brief Computes the derivatives with respect to the given element and adds them * to the global matrix. - * - * \return The element residual at the current solution. */ template void assembleJacobianFaceCoupling(Dune::index_constant domainJ, JacobianBlock& A, diff --git a/dumux/porousmediumflow/fluxvariablescachefiller.hh b/dumux/porousmediumflow/fluxvariablescachefiller.hh index 0c220608e8e805bf01a218c26159868a5d18c37a..d7b4d57df5920695a93eb07af1ecbf1fc05f4ff1 100644 --- a/dumux/porousmediumflow/fluxvariablescachefiller.hh +++ b/dumux/porousmediumflow/fluxvariablescachefiller.hh @@ -238,7 +238,6 @@ public: * \param fluxVarsCacheStorage Class that holds the scvf flux vars caches * \param scvfFluxVarsCache The flux var cache to be updated corresponding to the given scvf * \param ivDataStorage Class that stores the interaction volumes & handles - * \param element The finite element * \param fvGeometry The finite volume geometry * \param elemVolVars The element volume variables (primary/secondary variables) * \param scvf The corresponding sub-control volume face diff --git a/dumux/porousmediumflow/problem.hh b/dumux/porousmediumflow/problem.hh index 5c4a599b97dedbbde4a60fc58f6248db385a8ba2..918e38acc0ddb6a5d0634564bed2946dc1b44f57 100644 --- a/dumux/porousmediumflow/problem.hh +++ b/dumux/porousmediumflow/problem.hh @@ -62,6 +62,7 @@ public: * calls temperature(). * * \param globalPos The position in global coordinates where the temperature should be specified. + * \param deprecationHelper The deprecation helper. * \note The deprecation helper int was introduced to facilitate the deprecation phase, by checking * if users have overloaded this function. */