Commit 02bf3f0f authored by Simon Scholz's avatar Simon Scholz
Browse files

[doxygen] cleanup common ingroups

parent a9dc19e6
......@@ -25,8 +25,7 @@
#ifndef BALANCE_EQUATION_OPTIONS_HH
#define BALANCE_EQUATION_OPTIONS_HH
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup Common
......
......@@ -27,8 +27,7 @@
#include <algorithm>
#include <array>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup Common
......
......@@ -53,8 +53,8 @@ enum class SherwoodFormulation
};
/*!
* \brief Collection of functions which calculate dimensionless numbers.
* \ingroup Common
* \brief Collection of functions which calculate dimensionless numbers.
* Each number has it's own function.
* All the parameters for the calculation have to be handed over.
* Rendering this collection generic in the sense that it can be used by any model.
......
......@@ -28,8 +28,7 @@
#include <iostream>
#include <ctime>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup Common
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief An axis-aligned bounding box volume hierarchy for dune grids
*
* Dumux implementation of an AABB tree
......@@ -41,11 +41,10 @@
#include <dune/common/timer.hh>
#include <dune/common/fvector.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup Common
* \ingroup Geometry
* \brief An axis-aligned bounding box volume tree implementation
*
* The class constructs a hierarchical structure of bounding box volumes around
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief A class storing intersections from intersecting two bounding box trees
*/
#ifndef DUMUX_BOUNDING_BOX_TREE_INTERSECTION_HH
......@@ -25,11 +25,10 @@
#include <dune/common/fvector.hh>
#include <dune/common/promotiontraits.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup Common
* \ingroup Geometry
* \brief An intersection object resulting from the intersection of two bounding box tree primitives
*
* After is has been found that two leaf bounding boxes intersect a primitive test has to be
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief A function to compute a geometry's diameter, i.e.
* the longest distance between points of a geometry
*/
......@@ -28,7 +28,7 @@
namespace Dumux {
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Computes the longest distance between points of a geometry
* \note Useful e.g. to compute the maximum cell diameter of a grid
*/
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief An interface for a set of geometric entities
* \note This can be used e.g. to contruct a bounding box volume hierarchy of a grid
* It defines the minimum requirement for such a set
......@@ -31,7 +31,7 @@
namespace Dumux {
/*!
* \ingroup Common
* \ingroup Geometry
* \brief An interface for a set of geometric entities
* \note This can be used e.g. to contruct a bounding box volume hierarchy of a grid
* It defines the minimum requirement for such a set
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief A class for collision detection of two geometries
* and computation of intersection corners
*/
......@@ -35,7 +35,7 @@
namespace Dumux {
/*!
* \ingroup Common
* \ingroup Geometry
* \brief A class for geometry collision detection and intersection calculation
* The class can be specialized for combinations of dimworld, dim1, dim2, where
* dimworld is the world dimension embedding a grid of dim1 and a grid of dim2.
......@@ -58,7 +58,10 @@ public:
}
};
//! polyhedron--segment intersection in 3d space
/*!
* \ingroup Geometry
* \brief A class for polyhedron--segment intersection in 3d space
*/
template <class Geometry1, class Geometry2>
class GeometryIntersection<Geometry1, Geometry2, 3, 3, 1>
{
......@@ -173,7 +176,10 @@ public:
}
};
//! polyhedron--polygon intersection in 3d space
/*!
* \ingroup Geometry
* \brief A class for polyhedron--polygon intersection in 3d space
*/
template <class Geometry1, class Geometry2>
class GeometryIntersection<Geometry1, Geometry2, 3, 3, 2>
{
......@@ -315,7 +321,10 @@ public:
}
};
//! polygon--segment intersection in 3d space
/*!
* \ingroup Geometry
* \brief A class for polygon--segment intersection in 3d space
*/
template <class Geometry1, class Geometry2>
class GeometryIntersection<Geometry1, Geometry2, 3, 2, 1>
{
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief A function to compute the convex hull of a point cloud
* and a function to triangulate the polygon area spanned by the convex hull
*/
......@@ -35,6 +35,7 @@
namespace Dumux {
/*!
* \ingroup Geometry
* \brief Returns the orientation of a sequence a-->b-->c in one plane (defined by normal vector)
* \return -1 if a-->b-->c forms a counter-clockwise turn (given the normal vector)
* +1 for a clockwise turn,
......@@ -54,6 +55,7 @@ int getOrientation(const Dune::FieldVector<ctype, 3>& a,
}
/*!
* \ingroup Geometry
* \brief Compute the points making up the convex hull around the given set of unordered points
* \note We assume that all points are coplanar and there are no indentical points in the list
*/
......@@ -66,6 +68,7 @@ grahamConvexHull2d3d(const std::vector<Dune::FieldVector<ctype, 3>>& points)
}
/*!
* \ingroup Geometry
* \brief Compute the points making up the convex hull around the given set of unordered points
* \note We assume that all points are coplanar and there are no indentical points in the list
* \note This algorithm changes the order of the given points a bit
......@@ -171,6 +174,7 @@ grahamConvexHull2d3d(std::vector<Dune::FieldVector<ctype, 3>>& points)
}
/*!
* \ingroup Geometry
* \brief Triangulate area given points of the convex hull
* \note Assumes all points of the convex hull are coplanar
* \note This inserts a mid point and connects all corners with that point to triangles
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief Algorithms that finds which geometric entites intersect
*/
#ifndef DUMUX_INTERSECTING_ENTITIES_HH
......@@ -34,7 +34,7 @@
namespace Dumux {
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Compute all intersections between entities and a point
*/
template<class EntitySet, class ctype, int dimworld>
......@@ -50,7 +50,7 @@ intersectingEntities(const Dune::FieldVector<ctype, dimworld>& point,
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Compute intersections with point for all nodes of the bounding box tree recursively
*/
template<class EntitySet, class ctype, int dimworld>
......@@ -92,7 +92,7 @@ void intersectingEntities(const Dune::FieldVector<ctype, dimworld>& point,
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Compute all intersections between two bounding box trees
*/
template<class EntitySet0, class EntitySet1>
......@@ -117,7 +117,7 @@ intersectingEntities(const BoundingBoxTree<EntitySet0>& treeA,
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Compute all intersections between two all bounding box tree nodes recursively
*/
template<class EntitySet0, class EntitySet1>
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief Detect if a point intersects a geometry
*/
#ifndef DUMUX_INTERSECTS_POINT_GEOMETRY_HH
......@@ -31,7 +31,7 @@
namespace Dumux {
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a three-dimensional geometry
*/
template <class ctype, int dimworld, class Geometry, typename std::enable_if_t<(Geometry::mydimension == 3), int> = 0>
......@@ -79,7 +79,7 @@ bool intersectsPointGeometry(const Dune::FieldVector<ctype, dimworld>& point, co
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a two-dimensional geometry
*/
template <class ctype, int dimworld, class Geometry, typename std::enable_if_t<(Geometry::mydimension == 2), int> = 0>
......@@ -107,7 +107,7 @@ bool intersectsPointGeometry(const Dune::FieldVector<ctype, dimworld>& point, co
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a one-dimensional geometry
*/
template <class ctype, int dimworld, class Geometry, typename std::enable_if_t<(Geometry::mydimension == 1), int> = 0>
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief Detect if a point intersects a simplex (including boundary)
*/
#ifndef DUMUX_INTERSECTS_POINT_SIMPLEX_HH
......@@ -29,7 +29,7 @@
namespace Dumux {
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a tetrahedron (p0, p1, p2, p3) (dimworld is 3)
*/
template<class ctype, int dimworld, typename std::enable_if_t<(dimworld == 3), int> = 0>
......@@ -71,7 +71,7 @@ bool intersectsPointSimplex(const Dune::FieldVector<ctype, dimworld>& point,
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a triangle (p0, p1, p2, p3) (dimworld is 3)
*/
template<class ctype, int dimworld, typename std::enable_if_t<(dimworld == 3), int> = 0>
......@@ -125,7 +125,7 @@ bool intersectsPointSimplex(const Dune::FieldVector<ctype, dimworld>& point,
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a triangle (p0, p1, p2, p3) (dimworld is 2)
*/
template<class ctype, int dimworld, typename std::enable_if_t<(dimworld == 2), int> = 0>
......@@ -152,7 +152,7 @@ bool intersectsPointSimplex(const Dune::FieldVector<ctype, dimworld>& point,
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a interval (p0, p1, p2, p3) (dimworld is 3)
*/
template<class ctype, int dimworld, typename std::enable_if_t<(dimworld == 3), int> = 0>
......@@ -192,7 +192,7 @@ bool intersectsPointSimplex(const Dune::FieldVector<ctype, dimworld>& point,
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a interval (p0, p1, p2, p3) (dimworld is 2)
*/
template<class ctype, int dimworld, typename std::enable_if_t<(dimworld == 2), int> = 0>
......@@ -233,7 +233,7 @@ bool intersectsPointSimplex(const Dune::FieldVector<ctype, dimworld>& point,
}
/*!
* \ingroup Common
* \ingroup Geometry
* \brief Find out whether a point is inside a interval (p0, p1, p2, p3) (dimworld is 1)
*/
template<class ctype, int dimworld, typename std::enable_if_t<(dimworld == 1), int> = 0>
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Geometry
* \brief Create Dune geometries from user-specified points
*/
#ifndef DUMUX_MAKE_GEOMETRY_HH
......@@ -33,7 +33,10 @@
namespace Dumux {
//! Checks if four points lie within the same plane.
/*!
* \ingroup Geometry
* \brief Checks if four points lie within the same plane
*/
template<class CoordScalar>
bool pointsAreCoplanar(const std::vector<Dune::FieldVector<CoordScalar, 3>>& points, const CoordScalar scale)
{
......@@ -48,7 +51,10 @@ bool pointsAreCoplanar(const std::vector<Dune::FieldVector<CoordScalar, 3>>& poi
return abs(M.determinant()) < 1.5e-7*scale*scale*scale*scale;
}
//! Checks if four points lie within the same plane.
/*!
* \ingroup Geometry
* \brief Checks if four points lie within the same plane.
*/
template<class CoordScalar>
bool pointsAreCoplanar(const std::vector<Dune::FieldVector<CoordScalar, 3>>& points)
{
......@@ -71,6 +77,7 @@ bool pointsAreCoplanar(const std::vector<Dune::FieldVector<CoordScalar, 3>>& poi
}
/*!
* \ingroup Geometry
* \brief Returns a vector of points following the dune ordering.
* Convenience method that creates a temporary object in case no array of orientations is desired.
*
......@@ -84,6 +91,7 @@ std::vector<Dune::FieldVector<CoordScalar, 3>> getReorderedPoints(const std::vec
}
/*!
* \ingroup Geometry
* \brief Returns a vector of points following the dune ordering.
*
* \param points The user-specified vector of points (potentially in wrong order).
......@@ -130,6 +138,7 @@ std::vector<Dune::FieldVector<CoordScalar, 3>> getReorderedPoints(const std::vec
}
/*!
* \ingroup Geometry
* \brief Creates a dune quadrilateral geometry given 4 corner points.
*
* \tparam CoordScalar The CoordScalar type.
......
......@@ -34,8 +34,8 @@
#include <dune/common/dynmatrix.hh>
#include <dune/common/float_cmp.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup Common
* \brief Calculate the (weighted) arithmetic mean of two scalar values.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Assembly
* \ingroup Common
* \brief A class for numeric differentiation
*
*/
......@@ -31,7 +31,7 @@
namespace Dumux {
/*!
* \ingroup Assembly
* \ingroup Common
* \brief A class for numeric differentiation with respect to a scalar parameter
*/
class NumericDifferentiation
......
......@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup Common
* \file
* \ingroup Common
*
* \brief _Declares_ all properties used in Dumux.
* \note Include this to forward declare properties in your headers.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Common
* \ingroup Properties
* \ingroup TypeTraits
* \author Timo Koch
* \brief The Dumux property system, traits with inheritance
......
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
* \brief Provides the magic behind the DuMuX property system.
* \ingroup Properties
* \brief Provides the magic behind the DuMuX property system.
*
* Properties allow to associate arbitrary data types to
* identifiers. A property is always defined on a pair (TypeTag,
......@@ -100,6 +100,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
} // end namespace Detail
/*!
* \ingroup Properties
* \brief Define a new type tag.
*
* A type tag can inherit the properties defined on up to five parent
......@@ -127,6 +128,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
} extern int semicolonHack_
/*!
* \ingroup Properties
* \brief Syntactic sugar for NEW_TYPE_TAG.
*
* See the documentation for NEW_TYPE_TAG.
......@@ -134,6 +136,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
#define INHERITS_FROM(...) __VA_ARGS__
/*!
* \ingroup Properties
* \brief Define a property tag.
*
* A property tag is the unique identifier for a property. It may only
......@@ -153,6 +156,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
extern int semicolonHack_
/*!
* \ingroup Properties
* \brief Set a property for a specific type tag.
*
* After this macro, you must to specify a complete body of a class
......@@ -186,6 +190,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
struct PropTagName<TypeTag, TTAG(EffTypeTagName)>
/*!
* \ingroup Properties
* \brief Set a property to a simple constant integer value.
*
* The constant can be accessed by the 'value' attribute.
......@@ -199,6 +204,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
}
/*!
* \ingroup Properties
* \brief Set a property to a simple constant boolean value.
*
* The constant can be accessed by the 'value' attribute.
......@@ -212,6 +218,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
}
/*!
* \ingroup Properties
* \brief Set a property which defines a type.
*
* The type can be accessed by the 'type' attribute.
......@@ -224,6 +231,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
}
/*!
* \ingroup Properties
* \brief Set a property to a simple constant scalar value.
*
* The constant can be accessed by the 'value' attribute. In order to
......@@ -244,6 +252,7 @@ struct GetTypeTagInheritance<std::tuple<FirstTypeTag, OtherTypeTags...>>
PropTagName<TypeTag, TTAG(EffTypeTagName)>::value(__VA_ARGS__)
/*!
* \ingroup Properties
* \brief Set a property to a simple constant string value.
*
* The constant can be accessed by the 'value' attribute and is of
......
......@@ -29,6 +29,10 @@
namespace Dumux {
/*!
* \ingroup Common
* \brief A arithmetic block vector type based on DUNE's reserved vector
*/
template<class BlockType, int capacity>
class ReservedBlockVector : public Dune::ReservedVector<BlockType, capacity>
{
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment