Commit 3ad8ddf9 authored by Dennis Gläser's avatar Dennis Gläser
Browse files

[doc][doxygen] add magnitude group

parent 8b89f2a4
......@@ -9,11 +9,6 @@
* \brief Common classes, functions, properties and concepts
*/
/*!
* \defgroup Distance Distance
* \brief Functionality related to distance computations between geometrical objects.
*/
/*!
* \defgroup EntityNetwork Entity Networks
* \brief Classes, functions and concepts related to networks of geometrical entities.
......@@ -44,6 +39,16 @@
* \brief Classes and functions related to intersections between geometries.
*/
/*!
* \defgroup Distance Distance
* \brief Functionality related to distance computations between geometrical objects.
*/
/*!
* \defgroup Magnitude Magnitude
* \brief Functionality related to magnitude (length/area/volume) computations of geometrical objects.
*/
/*!
* \defgroup IO Input-Output
* \brief Classes and functions for file input/output.
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Magnitude
* \brief Contains functionality for computing the
* areas of two-dimensional geometries.
*/
......@@ -36,6 +37,7 @@
namespace Frackit {
/*!
* \ingroup Magnitude
* \brief Returns the area of an internal geometry
* that has an area() function available.
*/
......@@ -44,6 +46,7 @@ typename Geometry::ctype computeArea(const Geometry& geometry)
{ return geometry.area(); }
/*!
* \ingroup Magnitude
* \brief Returns the area of a TopoDS_Face.
* \param face The face
* \param eps Tolerance value to be used
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Magnitude
* \brief Contains functionality for computing the
* magnitude (length/area/volume) of the part
* of a geometry contained within another geometry.
......@@ -39,6 +40,7 @@
namespace Frackit {
/*!
* \ingroup Magnitude
* \brief Returns the magnitude of zero-dimensional geometries (points)
* \note The magnitude of points is always zero independent on if they
* are contained in the geometry or not.
......@@ -50,6 +52,7 @@ computeContainedMagnitude(const Geometry& geometry,
{ return 0.0; }
/*!
* \ingroup Magnitude
* \brief Returns the length of the part of a one-dimensional
* geometry that is contained in a domain geometry.
*/
......@@ -73,6 +76,7 @@ computeContainedMagnitude(const Geometry& geometry,
}
/*!
* \ingroup Magnitude
* \brief Returns the surface area of the part of a two-dimensional
* geometry that is contained in a domain geometry.
*/
......@@ -98,7 +102,9 @@ computeContainedMagnitude(const Geometry& geometry,
}
/*!
* \brief TODO doc
* \ingroup Magnitude
* \brief Returns the magnitude of that part of a
* geometry that is contained in a domamin.
*/
template<class Domain>
typename CoordinateTypeTraits<Domain>::type
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Magnitude
* \brief Contains functionality for computing the
* lengths of one-dimensional geometries.
*/
......@@ -42,6 +43,7 @@
namespace Frackit {
/*!
* \ingroup Magnitude
* \brief Returns the length of a geometry.
* \note This is the default overload trying to get
* the length from the geometry itself.
......@@ -51,6 +53,7 @@ typename Geometry::ctype computeLength(const Geometry& geom)
{ return geom.length(); }
/*!
* \ingroup Magnitude
* \brief Returns the length of a curve of the Geom package.
*/
template<class ctype = double>
......@@ -63,6 +66,7 @@ ctype computeLength(const Handle(Geom_Curve)& curve)
}
/*!
* \ingroup Magnitude
* \brief Returns the length of a BRep edge.
*/
template<class ctype = double>
......@@ -70,6 +74,7 @@ ctype computeLength(const TopoDS_Edge& edge)
{ return computeLength(OCCUtilities::getGeomHandle(edge)); }
/*!
* \ingroup Magnitude
* \brief Returns the length of a circle (circumference).
*/
template<class ctype, int worldDim>
......@@ -77,6 +82,7 @@ ctype computeLength(const Circle<ctype, worldDim>& circle)
{ return 2.0*M_PI*circle.radius(); }
/*!
* \ingroup Magnitude
* \brief Returns the length of an ellipse.
*/
template<class ctype, int worldDim>
......@@ -84,6 +90,7 @@ ctype computeLength(const Ellipse<ctype, worldDim>& ellipse)
{ return M_PI*(ellipse.majorAxisLength() + ellipse.minorAxisLength()); }
/*!
* \ingroup Magnitude
* \brief Returns the length of an elliptical arc.
*/
template<class ctype>
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Magnitude
* \brief Contains functionality for computing the
* magnitude (length/area/volume) of geometries.
*/
......@@ -38,6 +39,7 @@
namespace Frackit {
/*!
* \ingroup Magnitude
* \brief Returns the magnitude of zero-dimensional geometries (points)
*/
template<class Geometry, std::enable_if_t<Geometry::myDimension() == 0, int> = 0>
......@@ -45,6 +47,7 @@ typename Geometry::ctype computeMagnitude(const Geometry& geometry)
{ return 0.0; }
/*!
* \ingroup Magnitude
* \brief Returns the length of one-dimensional geometries
*/
template<class Geometry, std::enable_if_t<Geometry::myDimension() == 1, int> = 0>
......@@ -52,6 +55,7 @@ typename Geometry::ctype computeMagnitude(const Geometry& geometry)
{ return computeLength(geometry); }
/*!
* \ingroup Magnitude
* \brief Returns the area of two-dimensional geometries
*/
template<class Geometry, std::enable_if_t<Geometry::myDimension() == 2, int> = 0>
......@@ -59,6 +63,7 @@ typename Geometry::ctype computeMagnitude(const Geometry& geometry)
{ return computeArea(geometry); }
/*!
* \ingroup Magnitude
* \brief Returns the volume of three-dimensional geometries
*/
template<class Geometry, std::enable_if_t<Geometry::myDimension() == 3, int> = 0>
......@@ -66,6 +71,7 @@ typename Geometry::ctype computeMagnitude(const Geometry& geometry)
{ return computeVolume(geometry); }
/*!
* \ingroup Magnitude
* \brief Returns the length of a BRep edge
*/
template<class ctype = double>
......@@ -73,6 +79,7 @@ ctype computeMagnitude(const TopoDS_Edge& edge)
{ return computeLength(edge); }
/*!
* \ingroup Magnitude
* \brief Returns the area of a BRep face
* \param face The face
* \param eps Tolerance value to be used
......@@ -87,6 +94,7 @@ ctype computeMagnitude(const TopoDS_Face& face,
{ return computeArea(face, eps, loc); }
/*!
* \ingroup Magnitude
* \brief Returns the volume of a BRep solid
* \param solid The solid
* \param eps Tolerance value to be used
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Magnitude
* \brief Contains functionality for computing the
* volume of three-dimensional geometries.
*/
......@@ -36,6 +37,7 @@
namespace Frackit {
/*!
* \ingroup Magnitude
* \brief Returns the volume of a TopoDS_Solid.
* \param solid The solid
* \param eps Tolerance value to be used
......
Markdown is supported
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