dumux merge requestshttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests2018-12-20T17:55:55Zhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1461[contributors] Add Kilian for 20182018-12-20T17:55:55ZTimo Kochtimokoch@math.uio.no[contributors] Add Kilian for 20183.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1462Merge branch 'feature/update-contributers' into 'master'2018-12-20T17:56:22ZTimo Kochtimokoch@math.uio.noMerge branch 'feature/update-contributers' into 'master'[contributors] Add Kilian for 2018
See merge request dumux-repositories/dumux!1461
(cherry picked from commit 5cd0234dc71db9ed9c7962202193f04044213907)
f750c6c7 [contributors] Add Kilian for 2018[contributors] Add Kilian for 2018
See merge request dumux-repositories/dumux!1461
(cherry picked from commit 5cd0234dc71db9ed9c7962202193f04044213907)
f750c6c7 [contributors] Add Kilian for 20183.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1463[cleanup] Replace property macros2018-12-21T11:40:29ZTimo Kochtimokoch@math.uio.no[cleanup] Replace property macros3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1464Merge branch 'cleanup/replace-leftover-macros' into 'master'2018-12-21T11:41:08ZTimo Kochtimokoch@math.uio.noMerge branch 'cleanup/replace-leftover-macros' into 'master'[cleanup] Replace property macros
See merge request dumux-repositories/dumux!1463
(cherry picked from commit c7449b25e5deae9071b63da9732e3a4aba205a3a)
79f0a47a [cleanup] Replace property macros[cleanup] Replace property macros
See merge request dumux-repositories/dumux!1463
(cherry picked from commit c7449b25e5deae9071b63da9732e3a4aba205a3a)
79f0a47a [cleanup] Replace property macros3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1465[doc] Update build badge to new url2018-12-21T11:45:00ZTimo Kochtimokoch@math.uio.no[doc] Update build badge to new url3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1466Merge branch 'feature/update-readme-badge' into 'master'2018-12-21T11:45:31ZTimo Kochtimokoch@math.uio.noMerge branch 'feature/update-readme-badge' into 'master'[doc] Update build badge to new url
See merge request dumux-repositories/dumux!1465
(cherry picked from commit 627d394a9915dcfbf472e15eea7f64297dc3d45b)
9271c26c [doc] Update build badge to new url[doc] Update build badge to new url
See merge request dumux-repositories/dumux!1465
(cherry picked from commit 627d394a9915dcfbf472e15eea7f64297dc3d45b)
9271c26c [doc] Update build badge to new url3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1468finalize CHANGELOG.md for 3.02018-12-21T12:32:14ZBernd Flemischfinalize CHANGELOG.md for 3.03.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1469Merge branch 'cleanup/finalize-changelog' into 'master'2018-12-21T12:32:44ZTimo Kochtimokoch@math.uio.noMerge branch 'cleanup/finalize-changelog' into 'master'finalize CHANGELOG.md for 3.0
See merge request dumux-repositories/dumux!1468
(cherry picked from commit a7adaae565aa36bc4fbca5032235a7e99098dcbb)
407db709 finalize CHANGELOG.md for 3.0finalize CHANGELOG.md for 3.0
See merge request dumux-repositories/dumux!1468
(cherry picked from commit a7adaae565aa36bc4fbca5032235a7e99098dcbb)
407db709 finalize CHANGELOG.md for 3.03.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1467Cleanup/poroelastic2018-12-21T12:35:01ZDennis GläserCleanup/poroelasticThis hopefully increases the stability of the el1p and el2p tests.This hopefully increases the stability of the el1p and el2p tests.3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1470Merge branch 'cleanup/poroelastic' into 'master'2018-12-21T12:35:26ZTimo Kochtimokoch@math.uio.noMerge branch 'cleanup/poroelastic' into 'master'Cleanup/poroelastic
See merge request dumux-repositories/dumux!1467
(cherry picked from commit bdeb14ae0a85d01ef7ed39cda2cb9908f86933f4)
f0437c5d [poroelastic][localres] remove unused alias
d057f66e [poroelastic][cm] use correct domai...Cleanup/poroelastic
See merge request dumux-repositories/dumux!1467
(cherry picked from commit bdeb14ae0a85d01ef7ed39cda2cb9908f86933f4)
f0437c5d [poroelastic][localres] remove unused alias
d057f66e [poroelastic][cm] use correct domain prefix for function argument
73d79d28 [test][poroelastic] use lower newton tolerance
163a90fd [test][poroelastic] use higher zero threshold
a76bbda1 [test][el2p] initialize fluid system to speed up test3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1351Cleanup/doxygen for 3.02019-10-07T16:11:27ZSimon EmmertCleanup/doxygen for 3.0When checking doxygen, the doxygen should be built and the doxyerr.log should have as little lines/errors as possible. We currently have around 1800 lines of errors and want to reduce this to 1 to 7 lines.
The Doxygen for a **file** sh...When checking doxygen, the doxygen should be built and the doxyerr.log should have as little lines/errors as possible. We currently have around 1800 lines of errors and want to reduce this to 1 to 7 lines.
The Doxygen for a **file** should look like this:
```
/*!
* \file
* \ingroup Common
* \brief Manages the handling of time dependent problems
*/
```
It should always contain the `\file` first.
The `\ingroup` gives a Group that is as **precise** as possible and is part of the `modules.txt`
The `\brief` is a **short comment** on what happens in the file. Alternatively a `\copybrief` could be used. **Make sure the copybrief links to the correct section and is not ambigous!**
Additional text could be added similar to the function description.
A class could look like this:
```
/*!
* \ingroup Common
* \brief Manages the handling of time dependent problems.
*
* This class facilitates the time management of the simulation.
* It doesn't manage [...]
* [...]
* [...] index starting at 0.
*
* \note Time and time step sizes are in units of seconds
*/
```
The class should always have the proper `\ingroup` just like the file.
The `\brief` should always contain a **short description**, and only in very very rare occasions a class can have a `\copybrief`. In the end this is also documentation for users that do not build doxygen and `\copybriefs` from another file are most likely not very useful.
The main part should be an in depth explanation of what is done. This should contain math-expressions where applicable. They can look like the following:
```
* This class implements a spline \f$s(x)\f$ for which, given \f$n\f$ sampling
* points \f$x_1, \dots, x_n\f$, the following conditions hold
*\f{align*}{
s(x_i) & = y_i \quad \forall i \in \{1, \dots, n \}\\
s'(x_1) & = m_1 \\
s'(x_n) & = m_n
\f}
*
```
For a **function** in a file the Doxygen can look like this:
```
/*!
* \brief Set the current simulated time and the time step index.
*
* \param t The time \f$\mathrm{[s]}\f$ which should be jumped to
* \param stepIdx The new time step index
*/
void setTime(Scalar t, int stepIdx)
{ time_ = t; timeStepIdx_ = stepIdx; }
```
The function has a **short comment** with the `\brief`.
If there are **function-arguments** that are not self-explanatory, they should be described using `\param`.** Always explain all params or no params at all!** Otherwise Doxygen will throw an error.
Additional Doxygen-commands that might be useful are `\note` for giving an important note/hint on what the function does as well as `\return` which specifies the return value (if applicable).
We will go through the errors according to folders:
* [x] freeflow (262) @nedc
* [x] material (209) @ackerm
* [x] multidomain (168)
* [x] porousmediumflow (558) @scholz
* [x] common, discretization, geomechanics @hommel
* [ ] nonlinear,io,linear, material, nonlinear, parallel
Fix/Document everything according to the guideline. If there is a problem with a copybrief try to fix it or contact @scholz for help.
Closes #5963.0https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/806[discretization] Rename DiscretizationMethods to DiscretizationMethod with lo...2020-02-17T17:28:22ZTimo Kochtimokoch@math.uio.no[discretization] Rename DiscretizationMethods to DiscretizationMethod with lower-case fieldsFixes #444.Fixes #444.3.0Bernd FlemischBernd Flemischhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1364Fix box pv state at boundary2020-05-27T17:55:28ZKilian WeishauptFix box pv state at boundaryfixes #551
fixes #551
3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1068[testing] Use shlex to be able to process quote enclosed strings as parameters2021-11-26T10:35:34ZTimo Kochtimokoch@math.uio.no[testing] Use shlex to be able to process quote enclosed strings as parametersThis makes it possible to pass arguments like "-Grid.Cells \"0 0 0\"" via CMake and the runtest script.
shlex is in the standard library (https://docs.python.org/3/library/shlex.html / https://docs.python.org/2/library/shlex.html) so ...This makes it possible to pass arguments like "-Grid.Cells \"0 0 0\"" via CMake and the runtest script.
shlex is in the standard library (https://docs.python.org/3/library/shlex.html / https://docs.python.org/2/library/shlex.html) so that this doesn't add a bad dependency.3.0Dennis GläserDennis Gläser