Commit 3ce10edb by Sina Ackermann Committed by Simon Scholz

### [doxygen] Fix doxygen errors in multidomain folders

parent 1d3dc55f
 ... ... @@ -110,7 +110,7 @@ public: * that couple with / influence the element residual of the given element of domain i * * \param domainI the domain index of domain i * \param elementI the coupled element of domain í * \param element the coupled element of domain í * \param domainJ the domain index of domain j */ template ... ...
 ... ... @@ -162,7 +162,7 @@ public: * that couple with / influence the element residual of the given element of domain i * * \param domainI the domain index of domain i * \param elementI the coupled element of domain í * \param eIdxI the index of the coupled element of domain í * \param domainJ the domain index of domain j * * \note The element residual definition depends on the discretization scheme of domain i ... ...
 ... ... @@ -160,7 +160,7 @@ public: * that couple with / influence the element residual of the given element of domain i * * \param domainI the domain index of domain i * \param elementI the coupled element of domain í * \param element the coupled element of domain í * \param domainJ the domain index of domain j * * \note The element residual definition depends on the discretization scheme of domain i ... ...
 ... ... @@ -157,7 +157,7 @@ public: * \param facetProblem The problem to be solved on the (2d) facet domain * \param edgeProblem The problem to be solved on the (1d) edge domain * \param couplingMapper The mapper object containing the connectivity between the domains * \tparam curSol The current solution * \param curSol The current solution */ void init(std::shared_ptr< Problem > bulkProblem, std::shared_ptr< Problem > facetProblem, ... ...
 ... ... @@ -167,7 +167,7 @@ protected: * \param bulkFvGridGeometry The finite-volume grid geometry of the bulk grid * \param lowDimFvGridGeometry The finite-volume grid geometry of the lower-dimensional grid * \param embeddings Class that contains the embedments and allows obtaining entity insertion indices * \param AddCouplingEntryPolicy Policy for adding coupling entries starting from a lower-dimensional * \param addCouplingEntryPolicy Policy for adding coupling entries starting from a lower-dimensional * element and corresponding adjoined higher-dimensional entity indices */ template< class Embeddings, typename AddCouplingEntryPolicy > ... ...
 ... ... @@ -17,7 +17,7 @@ /*! * \file * \ingroup FacetCoupling * \copydoc Dumux::FacetCouplingGmshReader. * \copydoc Dumux::FacetCouplingGmshReader */ #ifndef DUMUX_FACETCOUPLING_GMSH_READER_HH #define DUMUX_FACETCOUPLING_GMSH_READER_HH ... ...
 ... ... @@ -129,7 +129,6 @@ public: /*! * \brief Indicates that one Newton iteration was finished. * * \param assembler The jacobian assembler * \param uCurrentIter The solution after the current Newton iteration * \param uLastIter The solution at the beginning of the current Newton iteration */ ... ...
 ... ... @@ -66,7 +66,7 @@ public: static constexpr auto faceIdx = Dune::index_constant<1>(); /*! * \copydoc CouplingManager::updateCouplingContext * \copydoc Dumux::CouplingManager::updateCouplingContext() */ template void updateCouplingContext(Dune::index_constant domainI, ... ... @@ -144,7 +144,7 @@ public: } /*! * \copydoc ParentType::evalCouplingResidual * \copydoc Dumux::CouplingManager::evalCouplingResidual() * * \note this is a specialization for calculating the coupled residual for cellcentered dofs * w.r.t. staggered face dof changes ... ...
 ... ... @@ -197,7 +197,7 @@ public: * of the local residual for the current element. * * \param elemVolVars The element volume variables * \param elemVolVars The element face variables * \param elemFaceVars The element face variables */ CellCenterResidualValue evalLocalFluxAndSourceResidualForCellCenter(const ElementVolumeVariables& elemVolVars, const ElementFaceVariables& elemFaceVars) const { ... ...
 ... ... @@ -132,7 +132,6 @@ public: * \brief Evaluate the boundary conditions for a dirichlet * control volume. * * \param values The dirichlet values for the primary variables * \param globalPos The center of the finite volume which ought to be set. * * For this method, the \a values parameter stores primary variables. ... ...
 ... ... @@ -127,7 +127,6 @@ public: * \brief Evaluate the boundary conditions for a dirichlet * control volume. * * \param values The dirichlet values for the primary variables * \param globalPos The center of the finite volume which ought to be set. * * For this method, the \a values parameter stores primary variables. ... ...
 ... ... @@ -85,11 +85,8 @@ public: /*! * \brief Returns the parameter object for the Brooks-Corey material law. * In this test, we use element-wise distributed material parameters. * * \param element The current element * \param scv The sub-control volume inside the element. * \param elemSol The solution at the dofs connected to the element. * In this test, we use element-wise distributed material parameters. * \return the material parameters object */ const MaterialLawParams& materialLawParamsAtPos(const GlobalPosition& globalPos) const ... ...
 ... ... @@ -190,7 +190,7 @@ public: * \brief Evaluate the boundary conditions for a Neumann control volume. * * \param element The element for which the Neumann boundary condition is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param scvf The boundary sub control volume face * ... ... @@ -221,7 +221,7 @@ public: * sub-control-volume. * * \param element The element for which the source term is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param scv The subcontrolvolume */ ... ...
 ... ... @@ -195,9 +195,6 @@ public: /*! * \brief Evaluate the boundary conditions for a Dirichlet control volume. * * \param element The element * \param scvf The sub control volume face */ PrimaryVariables dirichletAtPos(const GlobalPosition& globalPos) const { ... ... @@ -215,7 +212,7 @@ public: * \brief Evaluate the boundary conditions for a Neumann control volume. * * \param element The element for which the Neumann boundary condition is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param elemFaceVars The element face variables * \param scvf The boundary sub control volume face ... ...
 ... ... @@ -204,7 +204,7 @@ public: * \brief Evaluate the boundary conditions for a Neumann control volume. * * \param element The element for which the Neumann boundary condition is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param scvf The boundary sub control volume face * ... ... @@ -235,7 +235,7 @@ public: * sub-control-volume. * * \param element The element for which the source term is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param scv The subcontrolvolume */ ... ...
 ... ... @@ -218,9 +218,6 @@ public: /*! * \brief Evaluate the boundary conditions for a Dirichlet control volume. * * \param element The element * \param scvf The sub control volume face */ PrimaryVariables dirichletAtPos(const GlobalPosition& globalPos) const { ... ... @@ -266,7 +263,7 @@ public: * \brief Evaluate the boundary conditions for a Neumann control volume. * * \param element The element for which the Neumann boundary condition is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param elemFaceVars The element face variables * \param scvf The boundary sub control volume face ... ...
 ... ... @@ -247,7 +247,7 @@ public: * control volume. * * \param element The element for which the Neumann boundary condition is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param scvf The boundary sub control volume face * ... ... @@ -287,7 +287,7 @@ public: * sub-control-volume. * * \param element The element for which the source term is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param scv The subcontrolvolume * ... ...
 ... ... @@ -216,9 +216,6 @@ public: /*! * \brief Evaluate the boundary conditions for a Dirichlet control volume. * * \param element The element * \param scvf The subcontrolvolume face */ PrimaryVariables dirichletAtPos(const GlobalPosition& pos) const { ... ... @@ -232,7 +229,7 @@ public: * \brief Evaluate the boundary conditions for a Neumann control volume. * * \param element The element for which the Neumann boundary condition is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param elemFaceVars The element face variables * \param scvf The boundary sub control volume face ... ...
 ... ... @@ -186,7 +186,7 @@ public: * \brief Evaluate the boundary conditions for a Neumann control volume. * * \param element The element for which the Neumann boundary condition is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param scvf The boundary sub control volume face * ... ... @@ -217,7 +217,7 @@ public: * sub-control-volume. * * \param element The element for which the source term is set * \param fvGeomentry The fvGeometry * \param fvGeometry The fvGeometry * \param elemVolVars The element volume variables * \param scv The subcontrolvolume */ ... ... @@ -233,8 +233,6 @@ public: /*! * \brief Evaluate the initial value for a control volume. * * \param element The element * * For this method, the \a priVars parameter stores primary * variables. */ ... ...
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!