Skip to content

Conversation

MarcelKoch
Copy link
Member

This PR fixes the SOR (and Gauss-Seidel) documentation.

@MarcelKoch MarcelKoch added the 1:ST:ready-for-review This PR is ready for review label Oct 31, 2024
@MarcelKoch MarcelKoch added this to the Ginkgo 1.9.0 milestone Oct 31, 2024
@MarcelKoch MarcelKoch self-assigned this Oct 31, 2024
@ginkgo-bot ginkgo-bot added mod:core This is related to the core module. type:preconditioner This is related to the preconditioners labels Oct 31, 2024
* The preconditioner can be made symmetric, leading to the SSOR preconitioner.
* Here, $M$ is defined as
* $$
* \f[
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought \[ is enough, does it need to \f[?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No \[ doesn't work, it has to be \f[.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume you also look this page https://www.doxygen.nl/manual/formulas.html
maybe we or they have the tranformation from $ to \f$? I wonder the transformation makes \f[ to \ff[

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was a bit confused by that, somehow \f$ didn't work, but $works as expected.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found we have used \f[ and the formula is shown in https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/develop/classgko_1_1matrix_1_1Fft.html.
I think we can rely on \f[

* The preconditioner can be made symmetric, leading to the SSOR preconitioner.
* Here, $M$ is defined as
* $$
* \f[
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found we have used \f[ and the formula is shown in https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/develop/classgko_1_1matrix_1_1Fft.html.
I think we can rely on \f[

@MarcelKoch MarcelKoch added 1:ST:ready-to-merge This PR is ready to merge. and removed 1:ST:ready-for-review This PR is ready for review labels Nov 4, 2024
@MarcelKoch MarcelKoch merged commit add6468 into develop Nov 4, 2024
4 of 11 checks passed
@MarcelKoch MarcelKoch deleted the fix-sor-doc branch November 4, 2024 08:04
@ginkgo-bot
Copy link
Member

Error: PR already merged!

MarcelKoch added a commit to MarcelKoch/ginkgo that referenced this pull request Dec 2, 2024
This merge fixes the formulas for SOR by using `\f[` instead of `$$` (or `\[`).

Related PR: ginkgo-project#1720
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1:ST:ready-to-merge This PR is ready to merge. mod:core This is related to the core module. type:preconditioner This is related to the preconditioners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants