dumux merge requestshttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests2023-04-03T07:39:19Zhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3517[doc][fix] Fix group name parameter2023-04-03T07:39:19ZTimo Kochtimokoch@math.uio.no[doc][fix] Fix group name parameterhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3513Merge branch 'feature/doxygen-footer' into 'master'2023-03-29T18:45:51ZTimo Kochtimokoch@math.uio.noMerge branch 'feature/doxygen-footer' into 'master'3.7Hamza OukiliHamza Oukilihttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3512[doxygen] Extend footer with copyright link2023-07-18T11:11:21ZTimo Kochtimokoch@math.uio.no[doxygen] Extend footer with copyright link3.7https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3511Merge branch 'feature/doc-handbook-to-doxygen' into 'master'2023-03-29T18:13:02ZTimo Kochtimokoch@math.uio.noMerge branch 'feature/doc-handbook-to-doxygen' into 'master'3.7Hamza OukiliHamza Oukilihttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3507[example] Fix compiler warning about multiline comment2023-07-18T11:11:20ZTimo Kochtimokoch@math.uio.no[example] Fix compiler warning about multiline comment3.7Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3506[readme] Update links to doxygen2023-07-18T11:11:19ZTimo Kochtimokoch@math.uio.no[readme] Update links to doxygenFixes links after docs were moved to the doxygen documentationFixes links after docs were moved to the doxygen documentation3.7Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3504Merge branch 'feature/doxygen-update-3.7' into 'master'2023-03-28T11:47:18ZTimo Kochtimokoch@math.uio.noMerge branch 'feature/doxygen-update-3.7' into 'master'3.7Hamza OukiliHamza Oukilihttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3503[doxygen] Update doxygen for 3.72023-07-18T11:11:20ZTimo Kochtimokoch@math.uio.no[doxygen] Update doxygen for 3.7* Remove broken Files tab
* Update installation instruction to 3.7* Remove broken Files tab
* Update installation instruction to 3.73.7https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3498[doc] Move some documentation from handbook to doxygen2023-07-18T11:11:21ZTimo Kochtimokoch@math.uio.no[doc] Move some documentation from handbook to doxygenMove some documentation the handbook to doxygenMove some documentation the handbook to doxygen3.7Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3476[handbook] Bump the required CMake version to 3.14.2023-07-18T11:11:17ZIvan Buntic[handbook] Bump the required CMake version to 3.14.<!--
Thanks for considering to open a merge request!
Before asking for a review of your MR, please read the [contributing guidelines](/CONTRIBUTING.md)
-->
**What this MR does / why does DuMux need it**:
Bump the required version of C...<!--
Thanks for considering to open a merge request!
Before asking for a review of your MR, please read the [contributing guidelines](/CONTRIBUTING.md)
-->
**What this MR does / why does DuMux need it**:
Bump the required version of CMake to 3.14 in the handbook
<!--
Keep the following TODO list in the merge request description for documentation.
Bullet points marked with _(if not applicable remove)_ may be removed.
-->
- [x] does the new code follow the [style guide](doc/styleguide.md)?
- [x] do the test pipelines pass? (see guide on [how to run pipelines for a merge request](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/wikis/Running-test-pipelines-for-merge-requests))
<!--
The following aspects might also come up during review:
* Does the change reduce the performance of the code (more CPU time or more memory) and is this justified by the benefits
* Does the change improve the performance? (if yes, add this aspect to the MR description)
* Is the code is a gross violation of programming best practices such as DRY (don't repeat yourself / code duplication, see https://de.wikipedia.org/wiki/Don%E2%80%99t_repeat_yourself, the SOLID principles (https://en.wikipedia.org/wiki/SOLID), or the C++ Core Guidelines (https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines)?
* Is the code well-documented, concise, easily readable? (e.g. variables are well-named, the logic is split into small & well-named functions)
-->3.7Ivan BunticIvan Buntichttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3474[python] update readme for new setup2023-07-18T11:11:18ZMathis Kelm[python] update readme for new setup<!--
Thanks for considering to open a merge request!
Before asking for a review of your MR, please read the [contributing guidelines](/CONTRIBUTING.md)
-->
**What this MR does / why does DuMux need it**:
By default we now enable pytho...<!--
Thanks for considering to open a merge request!
Before asking for a review of your MR, please read the [contributing guidelines](/CONTRIBUTING.md)
-->
**What this MR does / why does DuMux need it**:
By default we now enable python bindings. This adapts the readme instructions accordingly.3.7Mathis KelmMathis Kelmhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3453Feature/doxygen markdown main readme2023-03-23T13:16:00ZTimo Kochtimokoch@math.uio.noFeature/doxygen markdown main readme* [x] Modify actual readme to look the same in GitLab and doxygen
* [x] Improve sections What is Dumux
* [x] Fix links
* [x] Create anchors with filter
* [x] Resolve `installation` section in readme and put in `Documentation`
* [x] renam...* [x] Modify actual readme to look the same in GitLab and doxygen
* [x] Improve sections What is Dumux
* [x] Fix links
* [x] Create anchors with filter
* [x] Resolve `installation` section in readme and put in `Documentation`
* [x] rename `Documentation` in README to `Overview`
* [x] modify script such that all .md are processed (runtime flag for header-level modification used in readme). Call math-modification script internally. The goal is that all headers in all .md files get anchors
* [x] Fix links to papers (seems to be too complex of a markdown link for doxygen)
* [x] Write compatibility table in ~~html~~markdown
Concept:
* Don't add default "pages" in the doxygen layout file
* Add pages and subpages manually into the sidebar
* TOCs in markdown are created with the `[TOC]` command
This allows to
* Split the module description into several files
* The use of `@addtogroup` to combine module documentation3.7Dennis GläserDennis Gläserhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3452[doxygen] Add filter to convert GitLab math to doxygen math in markdown2023-03-16T08:39:05ZTimo Kochtimokoch@math.uio.no[doxygen] Add filter to convert GitLab math to doxygen math in markdownMakes it possible to use GitLab markdown math syntax in doxygen markdown filesMakes it possible to use GitLab markdown math syntax in doxygen markdown files3.7Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3449[doxygen][header] Fix page overflow with gitlab corner2023-03-15T17:07:40ZTimo Kochtimokoch@math.uio.no[doxygen][header] Fix page overflow with gitlab corner3.7https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3444[handbook] Update to 3.7, update discretization images and some text.2023-03-16T14:25:18ZIvan Buntic[handbook] Update to 3.7, update discretization images and some text.<!--
Thanks for considering to open a merge request!
Before asking for a review of your MR, please read the [contributing guidelines](/CONTRIBUTING.md)
-->
**What this MR does / why does DuMux need it**:
This MR updates the versions o...<!--
Thanks for considering to open a merge request!
Before asking for a review of your MR, please read the [contributing guidelines](/CONTRIBUTING.md)
-->
**What this MR does / why does DuMux need it**:
This MR updates the versions of Dumux and Dune in the handbook. Also, the images for tpfa, mpfa and box have been unified and the text for the box method has been updated.
<!--
Is there a corresponding issue? Add "Fixes hashtag issuenumber" which will automatically close the issue when this MR is merged. Add "Related to hashtag issuenumber" if it's related but doesn't fix the issue completely.
-->
**Notes for the reviewer**
You need to compile the pdf of the handbook locally.
<!--
Keep the following TODO list in the merge request description for documentation.
Bullet points marked with _(if not applicable remove)_ may be removed.
-->
Before you request a review from someone, make sure to revise the following points:
- [x] do the test pipelines pass? (see guide on [how to run pipelines for a merge request](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/wikis/Running-test-pipelines-for-merge-requests))
- [x] all files have to end with a `\n` character. Make sure there is no `\ No newline at end of file` comment in "Changes" of this MR.
<!--
The following aspects might also come up during review:
* Does the change reduce the performance of the code (more CPU time or more memory) and is this justified by the benefits
* Does the change improve the performance? (if yes, add this aspect to the MR description)
* Is the code is a gross violation of programming best practices such as DRY (don't repeat yourself / code duplication, see https://de.wikipedia.org/wiki/Don%E2%80%99t_repeat_yourself, the SOLID principles (https://en.wikipedia.org/wiki/SOLID), or the C++ Core Guidelines (https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines)?
* Is the code well-documented, concise, easily readable? (e.g. variables are well-named, the logic is split into small & well-named functions)
-->3.7Ivan BunticIvan Buntichttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3440cleanup/resolve doxygen fluidsystem warnings2023-03-14T17:14:46ZDennis Gläsercleanup/resolve doxygen fluidsystem warningsFixes doxygen warnings in the fluid system. Doxygen seems to have issues when bringing in functions from a base class, in the context of CRTP-like inheritance, via an alias. Moreover, `copybrief`ing docs from the base class have to occur...Fixes doxygen warnings in the fluid system. Doxygen seems to have issues when bringing in functions from a base class, in the context of CRTP-like inheritance, via an alias. Moreover, `copybrief`ing docs from the base class have to occur with the specific overload one wants to bring in, otherwise one gets an error from undocumented parameters. The original code had further issues, which are fixed with this MR
- Our fluid system functions usuall have two overloads (with and w/o `ParameterCache`). However, the rendered docs showed 4 overloads, probably due to the issue mentioned above.
- In some places, `using Base::` was placed below the doxygen documentation, which renders wrong.
- Sometimes the empty line between the brief and long descriptions were missing (there's probably still more occurrences of that)
- Fixes the ordering between params and long description in the base fluid system
Further changes in this MR:
- when the function docs in derived fluid systems did not add anything to that of the base, they were replaced with a `copydoc` command
depends on !34393.7Dennis GläserDennis Gläserhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3439Cleanup/resolve doxygen multidomain warnings2023-03-13T23:00:23ZDennis GläserCleanup/resolve doxygen multidomain warningsResolves a few doxygen warnings from `MultiDomain` coupling managers.
Depends on !3431Resolves a few doxygen warnings from `MultiDomain` coupling managers.
Depends on !34313.7Dennis GläserDennis Gläserhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3435[doxygen] Improve module structure2023-03-13T13:25:08ZTimo Kochtimokoch@math.uio.no[doxygen] Improve module structure3.7Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3431Cleanup/resolve doxygen warnings2023-03-13T18:36:31ZDennis GläserCleanup/resolve doxygen warningsFixes a few minor doxygen docu bugs that triggered warnings upon doc compilationFixes a few minor doxygen docu bugs that triggered warnings upon doc compilation3.7Dennis GläserDennis Gläserhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/3430[disc][elemsol] put elementSolution() in single group2023-03-10T22:25:45ZDennis Gläser[disc][elemsol] put elementSolution() in single group<!--
Thanks for considering to open a merge request!
Before asking for a review of your MR, please read the [contributing guidelines](/CONTRIBUTING.md)
-->
**What this MR does / why does DuMux need it**:
The overloads for the free fun...<!--
Thanks for considering to open a merge request!
Before asking for a review of your MR, please read the [contributing guidelines](/CONTRIBUTING.md)
-->
**What this MR does / why does DuMux need it**:
The overloads for the free function `elementSolution` were placed in different doxygen groups. However, the doxygen documentation says
_Note that compound entities (like classes, files and namespaces) can be put into multiple groups, but members (like variable, functions, typedefs and enums) can only be a member of one group (this restriction is in place to avoid ambiguous linking targets in case a member is not documented in the context of its class, namespace or file, but only visible as part of a group)._
and we get warnings like
```sh
/builds/dumux-repositories/dumux/dumux/discretization/cellcentered/elementsolution.hh:144: warning: Member documentation for elementSolution found several times in @ingroup groups!
```
and ultimately it says
```sh
/builds/dumux-repositories/dumux/dumux/discretization/staggered/elementsolution.hh:62: The member will remain in group CCDiscretization, and won't be put into group StaggeredDiscretization
```
which seems random. This MR proposes to put `elementSolution` into the `Discretization` group. All overloads should then be listed when looking at that group, which seems more intuitive.3.7Dennis GläserDennis Gläser