Commit 53d64ebf authored by Praetorius, Simon's avatar Praetorius, Simon

improved doxygen documentation

parent 43e0a683
Pipeline #1773 passed with stage
in 33 minutes and 54 seconds
...@@ -28,13 +28,13 @@ PREDEFINED += HAVE_UMFPACK \ ...@@ -28,13 +28,13 @@ PREDEFINED += HAVE_UMFPACK \
# with spaces. # with spaces.
INPUT += @top_srcdir@/src/amdis \ INPUT += @top_srcdir@/src/amdis \
@top_srcdir@/src/amdis/assembler \
@top_srcdir@/src/amdis/common \ @top_srcdir@/src/amdis/common \
@top_srcdir@/src/amdis/gridfunctions \ @top_srcdir@/src/amdis/gridfunctions \
@top_srcdir@/src/amdis/io \
@top_srcdir@/src/amdis/linearalgebra \ @top_srcdir@/src/amdis/linearalgebra \
@top_srcdir@/src/amdis/linearalgebra/mtl \ @top_srcdir@/src/amdis/linearalgebra/mtl \
@top_srcdir@/src/amdis/localoperators \
@top_srcdir@/src/amdis/operations \ @top_srcdir@/src/amdis/operations \
@top_srcdir@/src/amdis/typetree \
@top_srcdir@/src/amdis/utility \ @top_srcdir@/src/amdis/utility \
@top_srcdir@/doc @top_srcdir@/doc
# see e.g. dune-grid for the examples of mainpage and modules # see e.g. dune-grid for the examples of mainpage and modules
......
...@@ -6,12 +6,18 @@ ...@@ -6,12 +6,18 @@
namespace AMDiS namespace AMDiS
{ {
/**
* \addtogroup Adaption
* @{
**/
typedef enum { typedef enum {
NO_OPERATION = 0, NO_OPERATION = 0,
INTERPOLATE = 1 INTERPOLATE = 1
} DataTransferOperation; } DataTransferOperation;
/// \brief Interface for Containers allowing data transfer between grid changes.
template <class Container> template <class Container>
class DataTransferInterface class DataTransferInterface
{ {
...@@ -27,8 +33,10 @@ namespace AMDiS ...@@ -27,8 +33,10 @@ namespace AMDiS
}; };
/// Implementation of \ref DataTransferInterface that does not interpolation, but /**
/// just resizes the containers to the dimension of the basis * \brief Implementation of \ref DataTransferInterface that does not interpolate, but
* just resizes the containers to the dimension of the basis
**/
template <class Container> template <class Container>
class NoDataTransfer class NoDataTransfer
: public DataTransferInterface<Container> : public DataTransferInterface<Container>
...@@ -69,6 +77,8 @@ namespace AMDiS ...@@ -69,6 +77,8 @@ namespace AMDiS
} }
}; };
/// @}
} // end namespace AMDiS } // end namespace AMDiS
#include "DataTransfer.inc.hpp" #include "DataTransfer.inc.hpp"
...@@ -198,6 +198,7 @@ namespace AMDiS ...@@ -198,6 +198,7 @@ namespace AMDiS
}; };
#ifndef DOXYGEN
template <class Tag, class PreGridFct, class PreQuadFactory> template <class Tag, class PreGridFct, class PreQuadFactory>
struct PreGridFunctionOperator struct PreGridFunctionOperator
{ {
...@@ -205,6 +206,7 @@ namespace AMDiS ...@@ -205,6 +206,7 @@ namespace AMDiS
PreGridFct expr; PreGridFct expr;
PreQuadFactory quadFactory; PreQuadFactory quadFactory;
}; };
#endif
/// Store tag and expression into a \ref PreGridFunctionOperator to create a \ref GridFunctionOperator /// Store tag and expression into a \ref PreGridFunctionOperator to create a \ref GridFunctionOperator
template <class Tag, class Expr, class... QuadratureArgs> template <class Tag, class Expr, class... QuadratureArgs>
......
...@@ -7,6 +7,12 @@ ...@@ -7,6 +7,12 @@
namespace AMDiS namespace AMDiS
{ {
/**
* \addtogroup Adaption
* @{
**/
/// \brief Interface for transfer between grid changes to be registered in a \ref GridTransferManager
class GridTransferInterface class GridTransferInterface
{ {
public: public:
...@@ -17,10 +23,10 @@ namespace AMDiS ...@@ -17,10 +23,10 @@ namespace AMDiS
virtual bool preAdapt() = 0; virtual bool preAdapt() = 0;
virtual bool adapt() = 0; virtual bool adapt() = 0;
virtual void postAdapt() = 0; virtual void postAdapt() = 0;
}; };
/// \brief Implementation of \ref GridTransferInterface for concrete Grid type.
template <class Grid> template <class Grid>
class GridTransfer class GridTransfer
: public GridTransferInterface : public GridTransferInterface
...@@ -100,4 +106,6 @@ namespace AMDiS ...@@ -100,4 +106,6 @@ namespace AMDiS
unsigned long changeIndex_ = 0; unsigned long changeIndex_ = 0;
}; };
/// @}
} // end namespace AMDiS } // end namespace AMDiS
...@@ -9,6 +9,11 @@ ...@@ -9,6 +9,11 @@
namespace AMDiS namespace AMDiS
{ {
/**
* \addtogroup Adaption
* @{
**/
/// Static administration class for automatic handling of DOFVectors during grid adaption /// Static administration class for automatic handling of DOFVectors during grid adaption
class GridTransferManager class GridTransferManager
{ {
...@@ -93,4 +98,6 @@ namespace AMDiS ...@@ -93,4 +98,6 @@ namespace AMDiS
using GridTransferCache = ConcurrentCache< Key, Data, StaticLockedPolicy, std::map<Key, Data> >; using GridTransferCache = ConcurrentCache< Key, Data, StaticLockedPolicy, std::map<Key, Data> >;
}; };
/// @}
} // end namespace AMDiS } // end namespace AMDiS
...@@ -213,6 +213,7 @@ namespace AMDiS ...@@ -213,6 +213,7 @@ namespace AMDiS
GridFctF gridFctF_; GridFctF gridFctF_;
}; };
#ifndef DOXYGEN
template <class PreGridFctA, class PreGridFctB, class PreGridFctC, class PreGridFctF, class c> template <class PreGridFctA, class PreGridFctB, class PreGridFctC, class PreGridFctF, class c>
struct PreConvectionDiffusionOperator struct PreConvectionDiffusionOperator
{ {
...@@ -222,6 +223,8 @@ namespace AMDiS ...@@ -222,6 +223,8 @@ namespace AMDiS
PreGridFctC gridFctC; PreGridFctC gridFctC;
PreGridFctF gridFctF; PreGridFctF gridFctF;
}; };
#endif
template <class PreGridFctA, class PreGridFctB, class PreGridFctC, class PreGridFctF, bool conserving = true> template <class PreGridFctA, class PreGridFctB, class PreGridFctC, class PreGridFctF, bool conserving = true>
auto convectionDiffusion(PreGridFctA const& gridFctA, PreGridFctB const& gridFctB, auto convectionDiffusion(PreGridFctA const& gridFctA, PreGridFctB const& gridFctB,
...@@ -232,6 +235,8 @@ namespace AMDiS ...@@ -232,6 +235,8 @@ namespace AMDiS
return Pre{gridFctA, gridFctB, gridFctC, gridFctF}; return Pre{gridFctA, gridFctB, gridFctC, gridFctF};
} }
#ifndef DOXYGEN
template <class Context, class... T, class GridView> template <class Context, class... T, class GridView>
auto makeLocalOperator(PreConvectionDiffusionOperator<T...> pre, GridView const& gridView) auto makeLocalOperator(PreConvectionDiffusionOperator<T...> pre, GridView const& gridView)
{ {
...@@ -247,6 +252,7 @@ namespace AMDiS ...@@ -247,6 +252,7 @@ namespace AMDiS
GridFctOp localOperator{std::move(gridFctA), std::move(gridFctB), std::move(gridFctC), std::move(gridFctF)}; GridFctOp localOperator{std::move(gridFctA), std::move(gridFctB), std::move(gridFctC), std::move(gridFctF)};
return localOperator; return localOperator;
} }
#endif
/** @} **/ /** @} **/
......
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