Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
dumux-repositories
dumux
Commits
c98f4f96
Commit
c98f4f96
authored
Dec 13, 2018
by
Simon Scholz
Browse files
[doxygen] cleanup discretization ingroups
parent
02bf3f0f
Changes
40
Hide whitespace changes
Inline
Side-by-side
dumux/discretization/box.hh
View file @
c98f4f96
...
...
@@ -17,9 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup Properties
* \file
*
*
\ingroup Discretization
* \brief Defines a type tag and some properties for models using the box scheme.
*/
...
...
dumux/discretization/box/boxgeometryhelper.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief Helper class constructing the dual grid finite volume geometries
* for the box discretizazion method
*/
...
...
@@ -29,8 +30,7 @@
#include
<dumux/common/math.hh>
namespace
Dumux
{
namespace
Dumux
{
//! Create sub control volumes and sub control volume face geometries
template
<
class
GridView
,
int
dim
,
class
ScvType
,
class
ScvfType
>
...
...
dumux/discretization/box/elementboundarytypes.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief Boundary types gathered on an element
*/
#ifndef DUMUX_BOX_ELEMENT_BOUNDARY_TYPES_HH
...
...
@@ -29,7 +30,7 @@
namespace
Dumux
{
/*!
* \ingroup Box
Model
* \ingroup Box
Discretization
* \brief This class stores an array of BoundaryTypes objects
*/
template
<
class
BTypes
>
...
...
dumux/discretization/box/elementfluxvariablescache.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief Global flux variable cache
*/
#ifndef DUMUX_DISCRETIZATION_BOX_ELEMENT_FLUXVARSCACHE_HH
...
...
dumux/discretization/box/elementsolution.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief The local element solution class for the box method
*/
#ifndef DUMUX_BOX_ELEMENT_SOLUTION_HH
...
...
@@ -30,7 +31,7 @@
namespace
Dumux
{
/*!
* \ingroup Box
Model
* \ingroup Box
Discretization
* \brief The element solution vector
*/
template
<
class
FVElementGeometry
,
class
PV
>
...
...
dumux/discretization/box/elementvolumevariables.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief The local volume variables class
*/
#ifndef DUMUX_DISCRETIZATION_BOX_ELEMENT_VOLUMEVARIABLES_HH
...
...
dumux/discretization/box/fluxvariablescache.hh
View file @
c98f4f96
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Discretization
* \ingroup
Box
Discretization
* \brief Flux variables cache class for the box scheme
*/
#ifndef DUMUX_DISCRETIZATION_BOX_FLUXVARIABLES_CACHE_HH
...
...
@@ -30,7 +30,6 @@
namespace
Dumux
{
/*!
* \ingroup Discretization
* \ingroup BoxDiscretization
* \brief Flux variables cache class for the box scheme.
* For the box scheme, this class does not contain any physics-/process-dependent
...
...
dumux/discretization/box/gridfluxvariablescache.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief Global flux variable cache
*/
#ifndef DUMUX_DISCRETIZATION_BOX_GRID_FLUXVARSCACHE_HH
...
...
dumux/discretization/box/gridvolumevariables.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief The grid volume variables class for box models
*/
#ifndef DUMUX_DISCRETIZATION_BOX_GRID_VOLUMEVARIABLES_HH
...
...
@@ -43,7 +44,7 @@ struct BoxDefaultGridVolumeVariablesTraits
};
/*!
* \ingroup Box
Model
* \ingroup Box
Discretization
* \brief Base class for the grid volume variables
*/
template
<
class
Problem
,
...
...
dumux/discretization/box/scvftoscvboundarytypes.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief Convert intersection boundary types to vertex boundary types
*/
#ifndef DUMUX_SCVF_TO_SCV_BCTYPES_HH
...
...
@@ -27,11 +28,10 @@
#include
<dune/common/exceptions.hh>
#include
<dumux/discretization/method.hh>
namespace
Dumux
{
namespace
Dumux
{
/*!
* \ingroup Box
Model
* \ingroup Box
Discretization
* \brief Convert intersection boundary types to vertex boundary types
*/
template
<
class
BoundaryTypes
,
DiscretizationMethod
discMethod
>
...
...
dumux/discretization/box/subcontrolvolume.hh
View file @
c98f4f96
...
...
@@ -190,6 +190,6 @@ private:
GridIndexType
dofIndex_
;
};
}
// end namespace
}
// end namespace
Dumux
#endif
dumux/discretization/box/subcontrolvolumeface.hh
View file @
c98f4f96
...
...
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup BoxDiscretization
* \brief Base class for a sub control volume face
*/
#ifndef DUMUX_DISCRETIZATION_BOX_SUBCONTROLVOLUMEFACE_HH
...
...
dumux/discretization/cellcentered/elementsolution.hh
View file @
c98f4f96
...
...
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Discretization
* \ingroup
CC
Discretization
* \brief The local element solution class for cell-centered methods
*/
#ifndef DUMUX_CC_ELEMENT_SOLUTION_HH
...
...
@@ -32,7 +32,7 @@
namespace
Dumux
{
/*!
* \ingroup Discretization
* \ingroup
CC
Discretization
* \brief The element solution vector
*/
template
<
class
FVElementGeometry
,
class
PV
>
...
...
@@ -106,7 +106,7 @@ private:
};
/*!
* \ingroup Discretization
* \ingroup
CC
Discretization
* \brief Make an element solution for cell-centered schemes
*/
template
<
class
Element
,
class
SolutionVector
,
class
FVGridGeometry
>
...
...
@@ -122,8 +122,8 @@ auto elementSolution(const Element& element, const SolutionVector& sol, const FV
}
/*!
* \ingroup Discretization
* \brief Make an element solution for cell-centered schemes
* \ingroup
CC
Discretization
* \brief Make an element solution for cell-centered schemes
*/
template
<
class
Element
,
class
ElementVolumeVariables
,
class
FVElementGeometry
>
auto
elementSolution
(
const
Element
&
element
,
const
ElementVolumeVariables
&
elemVolVars
,
const
FVElementGeometry
&
gg
)
...
...
@@ -136,7 +136,7 @@ auto elementSolution(const Element& element, const ElementVolumeVariables& elemV
}
/*!
* \ingroup Discretization
* \ingroup
CC
Discretization
* \brief Make an element solution for cell-centered schemes
* \note This is e.g. used to contruct an element solution at Dirichlet boundaries
*/
...
...
@@ -150,7 +150,7 @@ auto elementSolution(PrimaryVariables&& priVars)
}
/*!
* \ingroup Discretization
* \ingroup
CC
Discretization
* \brief Make an element solution for cell-centered schemes
* \note This is e.g. used to contruct an element solution at Dirichlet boundaries
*/
...
...
dumux/discretization/cellcentered/mpfa/connectivitymap.hh
View file @
c98f4f96
...
...
@@ -30,8 +30,8 @@
#include
<dumux/discretization/cellcentered/mpfa/methods.hh>
#include
<dumux/discretization/cellcentered/connectivitymap.hh>
namespace
Dumux
{
namespace
Dumux
{
//! Forward declaration of method specific implementation of the assembly map
template
<
class
FVGridGeometry
,
MpfaMethods
method
>
class
CCMpfaConnectivityMap
;
...
...
@@ -39,6 +39,6 @@ class CCMpfaConnectivityMap;
//! The o-method can use the simple (symmetric) assembly map
template
<
class
FVGridGeometry
>
class
CCMpfaConnectivityMap
<
FVGridGeometry
,
MpfaMethods
::
oMethod
>
:
public
CCSimpleConnectivityMap
<
FVGridGeometry
>
{};
}
}
// end namespace Dumux
#endif
dumux/discretization/cellcentered/mpfa/dualgridindexset.hh
View file @
c98f4f96
...
...
@@ -31,8 +31,8 @@
#include
<dune/common/reservedvector.hh>
#include
<dumux/common/indextraits.hh>
namespace
Dumux
{
namespace
Dumux
{
/*!
* \ingroup CCMpfaDiscretization
* \brief Default traits to be used in conjuntion
...
...
dumux/discretization/cellcentered/mpfa/elementvolumevariables.hh
View file @
c98f4f96
...
...
@@ -438,6 +438,6 @@ private:
std
::
vector
<
VolumeVariables
>
volumeVariables_
;
};
}
// end namespace
}
// end namespace
Dumux
#endif
dumux/discretization/cellcentered/mpfa/fluxvariablescachefiller.hh
View file @
c98f4f96
...
...
@@ -30,8 +30,7 @@
#include
<dumux/discretization/method.hh>
#include
<dumux/discretization/cellcentered/mpfa/tensorlambdafactory.hh>
namespace
Dumux
{
namespace
Dumux
{
/*!
* \ingroup CCMpfaDiscretization
...
...
dumux/discretization/cellcentered/mpfa/fvelementgeometry.hh
View file @
c98f4f96
...
...
@@ -34,8 +34,8 @@
#include
<dumux/common/indextraits.hh>
#include
<dumux/discretization/scvandscvfiterators.hh>
namespace
Dumux
{
namespace
Dumux
{
/*!
* \ingroup CCMpfaDiscretization
* \brief Stencil-local finite volume geometry (scvs and scvfs) for cell-centered mpfa models
...
...
dumux/discretization/cellcentered/mpfa/gridinteractionvolumeindexsets.hh
View file @
c98f4f96
...
...
@@ -28,8 +28,7 @@
#include
"dualgridindexset.hh"
namespace
Dumux
{
namespace
Dumux
{
/*!
* \ingroup CCMpfaDiscretization
...
...
dumux/discretization/cellcentered/mpfa/interactionvolumebase.hh
View file @
c98f4f96
...
...
@@ -29,8 +29,7 @@
#include
<dune/common/exceptions.hh>
#include
<dune/geometry/multilineargeometry.hh>
namespace
Dumux
{
namespace
Dumux
{
/*
* \ingroup CCMpfaDiscretization
...
...
Prev
1
2
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment