hyteg issueshttps://i10git.cs.fau.de/hyteg/hyteg/-/issues2023-02-17T14:32:07+01:00https://i10git.cs.fau.de/hyteg/hyteg/-/issues/201Update GMG tutorial2023-02-17T14:32:07+01:00Nils KohlUpdate GMG tutorialThe GMG tutorial (05) is a little outdated and could use some more in-depth description to provide a nice starting point for new users.The GMG tutorial (05) is a little outdated and could use some more in-depth description to provide a nice starting point for new users.Nils KohlNils Kohlhttps://i10git.cs.fau.de/hyteg/hyteg/-/issues/207Minor DG tutorial fixes2023-05-26T15:34:21+02:00Nils KohlMinor DG tutorial fixesThere are some minor things that should be fixed in the DG tutorial.
* The full app code is missing on the Doxygen page.
* The computation of h is flawed. Better use h_max or h_min. There are suitable functions in HyTeG.There are some minor things that should be fixed in the DG tutorial.
* The full app code is missing on the Doxygen page.
* The computation of h is flawed. Better use h_max or h_min. There are suitable functions in HyTeG.Nils KohlNils Kohlhttps://i10git.cs.fau.de/hyteg/hyteg/-/issues/214Add documentation to grid transfer functions2023-12-19T17:21:34+01:00Nils KohlAdd documentation to grid transfer functionsFor instance the standard restriction classes are the transpose of the prolongation - but users might think that it is rather an "interpolation". We need better names and documentation.For instance the standard restriction classes are the transpose of the prolongation - but users might think that it is rather an "interpolation". We need better names and documentation.https://i10git.cs.fau.de/hyteg/hyteg/-/issues/251Document whether the pseudo-3D setting for 2D FullStokes is applied.2024-03-06T08:41:58+01:00Nils KohlDocument whether the pseudo-3D setting for 2D FullStokes is applied.From [this comment](https://i10git.cs.fau.de/hyteg/hyteg/-/issues/246#note_28573) in #246:
> just a comment on the `P2P1StokesFull` case in 2D. Though, I am not sure how important this will be for us at the moment. The current **form_st...From [this comment](https://i10git.cs.fau.de/hyteg/hyteg/-/issues/246#note_28573) in #246:
> just a comment on the `P2P1StokesFull` case in 2D. Though, I am not sure how important this will be for us at the moment. The current **form_stokes_full.ufl** for the 2D case uses 2/3 as factor, which is a *'pseudo 2D'* setting. That was motivated by people doing 2D simulations, with are actually 3D but with a cylindrical symmetry of sorts.
We should document what is implemented in the 2D case. Probably needs to be done through the HFG.Nils KohlNils Kohlhttps://i10git.cs.fau.de/hyteg/hyteg/-/issues/216Doxygen Documentation2024-03-20T10:39:17+01:00Marcus MohrDoxygen DocumentationHi,
I was just parsing the output of running Doxygen on our master. One thing I recognised is the following
# \section
In the tutorials we make use of Doxygen's [`\section` command](https://www.doxygen.nl/manual/commands.html#cmdsectio...Hi,
I was just parsing the output of running Doxygen on our master. One thing I recognised is the following
# \section
In the tutorials we make use of Doxygen's [`\section` command](https://www.doxygen.nl/manual/commands.html#cmdsection). Please be aware that the name given to a section is **global**. Thus, we get warnings like the following:
```
Preprocessing .../HyTeG/tutorials/08_CahnHilliard/CahnHilliard.cpp:478: warning: multiple use of section label 'code' while adding section, (first occurrence: .../HyTeG/tutorials/01_PrimitiveStorage.cpp, line 101)
```
This actually has also a real effect. The corresponding section in tutorial \#8 bares the name *Complete Program* as specified in tutorial \#1 and not the name *Code* as given in tutorial \#8.
I suggest to prefix the section names in the tutorials with **`T<tutorial number>-`** to make section names unique.
# $`\LaTeX`$
Do not add pseudo-LaTeX code such as,
```
/// Evaluates the linear functional
///
/// l( v ) = \int_\Omega f * v
///
```
but instead put it into a construct to render it as $`\LaTeX`$:
```
/// Evaluates the linear functional
/// \f[
/// l( v ) = \int_\Omega f \cdot v
/// \f]
```
Also make sure that your $`\LaTeX`$ commands are supported by standard $`\LaTeX`$. Otherwise you will get problems.
While additional packages can be loaded by Doxygen via the `EXTRA_PACKAGES` option, we should IMHO limit this to the really essential stuff for reasons of portability. Currently we only load **amsmath** in this way.
Note, however, that Doxygen seems not so super stable w.r.t. to treating $`\LaTeX`$. For example that following
```
* \f{align*}{
* F(\phi) = \int \boldsymbol \psi(\phi) dx + \frac{\epsilon^2}{2}\int |\nabla \phi |^2 dx
* \f}
```
seems to be responsible for
```
warning: Found unknown command '\boldsymbol'
warning: Found unknown command '\psi'
```
although it is type-set correctly in the output and (at least to me) seems to adhere to the specification.
# Other Issues
Most other warnings seem to belong to one of four categories:
- `The following parameter of XYZ is not documented:`, which would be easy to fix by adding the respective documentations. Unless XYZ is a templated function. I see cases where there is an attempt to document the parameter, but Doxygen seems to have problems to understand this for a concrete template instantiation. Not sure if one can help Doxygen here.
- `warning: no uniquely matching class member found for XYZ` which, without looking too much into details seems to be related to templatisation and, thus, might be unfixable.
- `warning: explicit link request to 'XYZ' could not be resolved`, where XYZ is something like P1Function or ValueType, so again related to templatisation.
- `warning: member XYZ belongs to two different groups. The second one found here will be ignored.` Not sure about that one, yet.
# Pictures
This is more of a question. Can someone please explain to me, why we need to explicitely add pictures, used e.g. in the tutorials, to `EXTRA_HTML_FILES` when we include them using `<img src="..."/>`? This only seems to bother Doxygen, when we [build the documentation as part of the pipeline](https://i10git.cs.fau.de/hyteg/hyteg/-/jobs/1076187), but not, when one builds it locally. What's the difference and could that maybe be resolved?Marcus MohrMarcus Mohrhttps://i10git.cs.fau.de/hyteg/hyteg/-/issues/256Doxygen issues2024-03-26T16:09:48+01:00Nils KohlDoxygen issuesA collection of current issues in our Doxygen documentation:
- [x] LaTeX does not seem to render, see https://hyteg.pages.i10git.cs.fau.de/hyteg/10_DGAMR.html (see https://i10git.cs.fau.de/hyteg/hyteg/-/issues/256#note_29522)
- [ ] CI ba...A collection of current issues in our Doxygen documentation:
- [x] LaTeX does not seem to render, see https://hyteg.pages.i10git.cs.fau.de/hyteg/10_DGAMR.html (see https://i10git.cs.fau.de/hyteg/hyteg/-/issues/256#note_29522)
- [ ] CI badges in README do not link to CI
- [ ] some links in the README do not work correctly when clicked in GitLabNils KohlNils Kohlhttps://i10git.cs.fau.de/hyteg/hyteg/-/issues/257Potential tutorial folder structure2024-03-28T10:34:38+01:00Ponsuganth Ilangovan Ponkumar IlangoPotential tutorial folder structureThis issue is to discuss modifying the tutorials folder structure to make it well categorised, like basics, full apps, etc. As we would also like to have the benchmark apps like Blankenbach under the tutorials which would serve as an exa...This issue is to discuss modifying the tutorials folder structure to make it well categorised, like basics, full apps, etc. As we would also like to have the benchmark apps like Blankenbach under the tutorials which would serve as an example of community standard geophysical application.
A potential folder structure would be,
- Tutorials
- Basics
- 01_PrimitiveStorage
- 02_PrimitiveData
- 03_Communication
- 04_Indexing
- Benchmarks
- 13_Blankenbach
- Full Apps
- others
Any suggestions or improvement with this and maybe also ideas for more tutorials would be greatly helpful as we start to work on these now.Ponsuganth Ilangovan Ponkumar IlangoPonsuganth Ilangovan Ponkumar Ilango