hyteg merge requestshttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests2024-03-28T20:35:31+01:00https://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/734Update/extend documentation of PrimitiveID class2024-03-28T20:35:31+01:00Marcus MohrUpdate/extend documentation of PrimitiveID classThis merge request
- re-writes and extends documentation text of `PrimitiveID` class
- adds three images to better explain the format of the bit pattern
- groups documentation of `PrimitiveID::asIntArray()` methods together
- updates met...This merge request
- re-writes and extends documentation text of `PrimitiveID` class
- adds three images to better explain the format of the bit pattern
- groups documentation of `PrimitiveID::asIntArray()` methods together
- updates meta-data in `PrimitiveID.hpp`
- relocates PrimitiveID.hpp to the sub-folder `src/hyteg/primitives`https://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/733Update Doxygen Config File and some version infos in README2024-03-28T13:15:37+01:00Marcus MohrUpdate Doxygen Config File and some version infos in READMEThe MR updates the config file for Doxygen to version 1.10.0, adds Doxygen as optional dendency in the README and sets the version requirement for ADIOS2 to 2.9.2 in the README. See also #235 in this respect.The MR updates the config file for Doxygen to version 1.10.0, adds Doxygen as optional dendency in the README and sets the version requirement for ADIOS2 to 2.9.2 in the README. See also #235 in this respect.https://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/731Fix mathjax by switching the content delivery network2024-03-27T15:54:08+01:00Nils KohlFix mathjax by switching the content delivery networkTrying to fix mathjax by switching the content delivery network to what is recommended in the documentation.
The former link is deprecated.Trying to fix mathjax by switching the content delivery network to what is recommended in the documentation.
The former link is deprecated.Nils KohlNils Kohlhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/730[Rebased] Implementing doxygen-awesome-css into the documentation.2024-03-22T15:41:44+01:00Nils Kohl[Rebased] Implementing doxygen-awesome-css into the documentation.Rebased from !726.Rebased from !726.Nils KohlNils Kohlhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/726Draft: Implementing doxygen-awesome-css into the documentation.2024-03-22T11:07:28+01:00Nils KohlDraft: Implementing doxygen-awesome-css into the documentation.Still WIP.
---
This MR is an attempt to streamline, improve, update, and modernize our documentation. Mainly everything that is generated via doxygen, but it will also update the README in one fell swoop.
**Note that this introduces a...Still WIP.
---
This MR is an attempt to streamline, improve, update, and modernize our documentation. Mainly everything that is generated via doxygen, but it will also update the README in one fell swoop.
**Note that this introduces a new submodule - so testing requires `git submodule update`**
Open (at least):
- [x] check which doxygen version we need (testing locally with 1.10.0) (→ @thoennes will update the CI to doxygen 1.10.0)
- [x] resolve construction sites in README
- [ ] improve tutorial landing pageNils KohlNils Kohlhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/720Trying to exclude the implementation files of the generated operators from do...2024-03-13T15:05:22+01:00Nils KohlTrying to exclude the implementation files of the generated operators from doxygen.Nils KohlNils Kohlhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/714Update doxygen documentation for GeometryMap class2024-03-04T15:08:34+01:00Marcus MohrUpdate doxygen documentation for GeometryMap classAdd new image to `HTML_EXTRA_FILES`, activate `DISTRIBUTE_GROUP_DOC` and group 2D with 3D version of `evalDFinvDF()`.Add new image to `HTML_EXTRA_FILES`, activate `DISTRIBUTE_GROUP_DOC` and group 2D with 3D version of `evalDFinvDF()`.Marcus MohrMarcus Mohrhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/711Resolves issue #2302024-02-27T14:36:41+01:00Marcus MohrResolves issue #230This MR removes the HYTEG_BUILD_DOC flag again. CMake will check for Doxygen and not add a doc target, if it is not found. Additionally the commit adds several new feature macros to the list we predefine for Doxygen.This MR removes the HYTEG_BUILD_DOC flag again. CMake will check for Doxygen and not add a doc target, if it is not found. Additionally the commit adds several new feature macros to the list we predefine for Doxygen.https://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/709Add note about MR workflow2024-03-13T18:28:30+01:00Daniel BauerAdd note about MR workflowAs discussed in today's meeting.As discussed in today's meeting.Daniel BauerDaniel Bauerhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/636Update README: add ADIOS2 info and CMake options2023-07-28T15:00:17+02:00Marcus MohrUpdate README: add ADIOS2 info and CMake optionsExtend capabilities for exporting data by adding support for ADIOS2Marcus MohrMarcus Mohrhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/629Couple Doxygen and CMake tighter together2023-07-19T13:12:58+02:00Marcus MohrCouple Doxygen and CMake tighter togetherSo far the Doxygen documentation is decoupled from the features we acitvate or deactivate for a build. So, for example, Doxygen is unaware whether WALBERLA_BUILD_WITH_MPI is defined or not. This MR adds macros for activated features t...So far the Doxygen documentation is decoupled from the features we acitvate or deactivate for a build. So, for example, Doxygen is unaware whether WALBERLA_BUILD_WITH_MPI is defined or not. This MR adds macros for activated features to Doxygen's PREDEFINED list, so that the correct documentation is generated.Marcus MohrMarcus Mohrhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/628Move Table and KeyValueStore to a central place2023-07-20T11:23:12+02:00Daniel BauerMove Table and KeyValueStore to a central placeRebase of !625.
`Table` and `KeyValueStore` can be used to write data in HyTeG apps/tests such that they can be later directly included in LaTeX code. See the docstrings for example usages.
This MR documents the existing classes and mo...Rebase of !625.
`Table` and `KeyValueStore` can be used to write data in HyTeG apps/tests such that they can be later directly included in LaTeX code. See the docstrings for example usages.
This MR documents the existing classes and moves them to `src/hyteg/dataexport`. Before, they were hidden away in `apps/2023-bauer-mt`.Daniel BauerDaniel Bauerhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/625Draft: Move Table and KeyValueStore to a central place2023-07-18T09:35:57+02:00Daniel BauerDraft: Move Table and KeyValueStore to a central place`Table` and `KeyValueStore` can be used to write data in HyTeG apps/tests such that they can be later directly included in LaTeX code.
See the docstrings for example usages.
This MR documents the existing classes and moves them to `src/...`Table` and `KeyValueStore` can be used to write data in HyTeG apps/tests such that they can be later directly included in LaTeX code.
See the docstrings for example usages.
This MR documents the existing classes and moves them to `src/hyteg/dataexport`.
Before, they were hidden away in `apps/2023-bauer-mt`.Daniel BauerDaniel Bauerhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/611Update text of tutorial no. 9 on multiple BCs2023-06-12T15:33:51+02:00Marcus MohrUpdate text of tutorial no. 9 on multiple BCsThe update fixes some typos and formulations and improves description of step no. 3.The update fixes some typos and formulations and improves description of step no. 3.Marcus MohrMarcus Mohrhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/608Add note on minimal CMake version to README2023-06-19T15:38:33+02:00Marcus MohrAdd note on minimal CMake version to READMEhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/606Add a tutorial on simple Couette flow in a 2D annulus2023-05-30T16:32:01+02:00Marcus MohrAdd a tutorial on simple Couette flow in a 2D annulusThis MR is the successor of !604.This MR is the successor of !604.Ponsuganth Ilangovan Ponkumar IlangoPonsuganth Ilangovan Ponkumar Ilangohttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/603Improve Doxygen documentation a little bit2023-05-30T08:51:38+02:00Marcus MohrImprove Doxygen documentation a little bitMR addresses some of the problems described in #216.MR addresses some of the problems described in #216.Marcus MohrMarcus Mohrhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/580Add new configure flag HYTEG_BUILD_DOC2023-10-13T11:31:17+02:00Marcus MohrAdd new configure flag HYTEG_BUILD_DOCBy default this is ON and CMake file try to locate doxygen and add a custom target for building the documentation. So default behaviour is
as before. Concept follows that used in waLBerla.
Rational: We do not always want/need to build t...By default this is ON and CMake file try to locate doxygen and add a custom target for building the documentation. So default behaviour is
as before. Concept follows that used in waLBerla.
Rational: We do not always want/need to build the documentation and not on every machine doxygen will be available. E.g. CMake fails to locate it on HAWK.Marcus MohrMarcus Mohrhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/576Mark Eigen as dependency2023-03-22T16:56:25+01:00Marcus MohrMark Eigen as dependencySince we can no longer built without Eigen, it no longer belongs in the "optional" sectionSince we can no longer built without Eigen, it no longer belongs in the "optional" sectionhttps://i10git.cs.fau.de/hyteg/hyteg/-/merge_requests/559Pimp math formulas in documentation of DGFunction class2023-01-13T17:55:27+01:00Marcus MohrPimp math formulas in documentation of DGFunction class