diff --git a/docs/reference/DOFVector.md b/docs/reference/DOFVector.md index 027bdda2c9ac10279d34d6b598305671e14d7e7c..d213e118fbb94cede7ecda2f9951ac16a09fcd44 100644 --- a/docs/reference/DOFVector.md +++ b/docs/reference/DOFVector.md @@ -23,7 +23,7 @@ The pair $`\{(u_i),\{\phi_i\}\}`$ is called `DOFVector` and the function $`u=u(\ ## class `DOFVector` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/DOFVector.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/DOFVector.hpp) ```c++ template `](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/DOFVector.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/DOFVector.hpp) ```c++ template `](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/gridfunctions/DiscreteFunction.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/gridfunctions/DiscreteFunction.hpp) ```c++ template `](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/gridfunctions/DiscreteFunction.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/gridfunctions/DiscreteFunction.hpp) ```c++ // (1) diff --git a/docs/reference/GridFunctions.md b/docs/reference/GridFunctions.md index fc33b438b9e53ec2362a8847d8e23943d43a216e..4dc85fcc24aca4b851075a4311c28f086627471c 100644 --- a/docs/reference/GridFunctions.md +++ b/docs/reference/GridFunctions.md @@ -152,7 +152,7 @@ auto value = integrate(Expression, prob.gridView()); ## function `evalAtQP()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/gridfunctions/AnalyticGridFunction.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/gridfunctions/AnalyticGridFunction.hpp) ```c++ template @@ -172,7 +172,7 @@ Creates a `GridFunction` that evaluates a functor in global coordinates. ## function `X()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/gridfunctions/CoordsGridFunction.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/gridfunctions/CoordsGridFunction.hpp) ```c++ inline auto X(); // (1) @@ -190,7 +190,7 @@ global coordinates (2). ## function `gradientAtQP()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/gridfunctions/DerivativeGridFunction.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/gridfunctions/DerivativeGridFunction.hpp) ```c++ template @@ -218,7 +218,7 @@ gradientAtQP(X(0) + X(1) + prob.solution(_0)) ## function `invokeAtQP()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/gridfunctions/FunctorGridFunction.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/gridfunctions/FunctorGridFunction.hpp) ```c++ template diff --git a/docs/reference/MatVecBase.md b/docs/reference/MatVecBase.md index 43d1b5c5e3bf3e20d1ee66440f69091ef1996ebd..64e29fbab2a62b540b5c3906f70db9f73393f378 100644 --- a/docs/reference/MatVecBase.md +++ b/docs/reference/MatVecBase.md @@ -13,7 +13,7 @@ class for all matrices associated to the indices of a row and column global basi ## class `MatrixBase` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/linearalgebra/MatrixBase.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/linearalgebra/MatrixBase.hpp) ```c++ template `](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/linearalgebra/VectorBase.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/linearalgebra/VectorBase.hpp) ```c++ template VectorBase(GB&& basis) // (2) ``` -(1) Constructor that stores the `shared_ptr` of the global basis. (2) Constructor that forwards to (1) by wrapping reference +(1) Constructor that stores the `shared_ptr` of the global basis. (2) Constructor that forwards to (1) by wrapping reference into (non-destroying) `shared_ptr`. #### Arguments @@ -311,4 +311,4 @@ to switch insertion mode before calling [finish()](#function-vectorbasefinish). - **expects:** `mask` must be forward iterable for at least `nodeVec.size()` elements ### Postconditions -- **ensures:** Vector is in insertion mode defined by the `assign` functor. \ No newline at end of file +- **ensures:** Vector is in insertion mode defined by the `assign` functor. diff --git a/docs/reference/Operators.md b/docs/reference/Operators.md index 3c977d6f5b37fffdec62158e8ac52abdc8c5b98d..37f56392e7da96aac4a7932d3e159fe0d309a459 100644 --- a/docs/reference/Operators.md +++ b/docs/reference/Operators.md @@ -11,7 +11,7 @@ ## function `makeOperator()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/GridFunctionOperator.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/GridFunctionOperator.hpp) ```c++ template @@ -146,7 +146,7 @@ auto op3 = makeOperator(B, sin(X(0)), Dune::QuadratureRules(Dune::GeometryType:: ## function `zot()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/localoperators/ZeroOrderTestTrial.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/localoperators/ZeroOrderTestTrial.hpp) ```c++ template @@ -161,10 +161,10 @@ the same as for `makeOperator()`. ## function `fot()` Defined in headers -- [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/localoperators/FirstOrderGradTestTrial.hpp) -- [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/localoperators/FirstOrderTestGradTrial.hpp) -- [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/localoperators/FirstOrderPartialTestTrial.hpp) -- [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/localoperators/FirstOrderTestPartialTrial.hpp) +- [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/localoperators/FirstOrderGradTestTrial.hpp) +- [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/localoperators/FirstOrderTestGradTrial.hpp) +- [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/localoperators/FirstOrderPartialTestTrial.hpp) +- [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/localoperators/FirstOrderTestPartialTrial.hpp) ```c++ template @@ -190,7 +190,7 @@ and whether it is a full gradient or just the partial derivative. ## function `sot()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/localoperators/SecondOrderGradTestGradTrial.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/localoperators/SecondOrderGradTestGradTrial.hpp) ```c++ template @@ -203,7 +203,7 @@ as for `makeOperator()`. ## function `sot_ij()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/localoperators/SecondOrderPartialTestPartialTrial.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/localoperators/SecondOrderPartialTestPartialTrial.hpp) ```c++ template @@ -217,7 +217,7 @@ Creates a second-order term of partial derivatives. This is a shortcut for ## function `convectionDiffusion()` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/localoperators/ConvectionDiffusionOperator.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/localoperators/ConvectionDiffusionOperator.hpp) ```c++ template diff --git a/docs/reference/Problem.md b/docs/reference/Problem.md index d7840432683f386cd65fa5fdf346cf68294c4252..ab11f6ff2dc8e4452c5fd3ccf4726459629afc11 100644 --- a/docs/reference/Problem.md +++ b/docs/reference/Problem.md @@ -36,7 +36,7 @@ These two classes build the basis for most AMDiS projects. ## class `ProblemStat` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/ProblemStat.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/ProblemStat.hpp) ```c++ template @@ -368,7 +368,7 @@ prob.addDirichletBC(BoundaryType{1}, 0, 0, 0.0); ``` ## class `ProblemInstat` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/ProblemInstat.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/ProblemInstat.hpp) ```c++ template @@ -393,7 +393,7 @@ Standard implementation of [ProblemTimeInterface](#class-problemtimeinterface) f ## class `StandardProblemIteration` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/StandardProblemIteration.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/StandardProblemIteration.hpp) ```c++ class StandardProblemIteration @@ -416,7 +416,7 @@ A master problem for a single non-coupled problem. ## class `ProblemStatBase` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/ProblemStatBase.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/ProblemStatBase.hpp) ```c++ class ProblemStatBase @@ -440,7 +440,7 @@ Base class for [ProblemStat](#class-problemstat). ## class `ProblemInstatBase` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/ProblemInstatBase.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/ProblemInstatBase.hpp) ```c++ class ProblemInstatBase @@ -463,7 +463,7 @@ Base class for [ProblemInstat](#class-probleminstat). ## class `ProblemIterationInterface` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/ProblemIterationInterface.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/ProblemIterationInterface.hpp) ```c++ class ProblemIterationInterface @@ -487,7 +487,7 @@ estimate, and adapt steps of the single problems in `oneIteration()`. ## class `ProblemTimeInterface` -Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/src/amdis/ProblemTimeInterface.hpp) +Defined in header [``](https://gitlab.mn.tu-dresden.de/amdis/amdis-core/blob/master/amdis/ProblemTimeInterface.hpp) ```c++ class ProblemTimeInterface