From f87849867eccfe51ddd2f9d5dbbcaf3498a36915 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Oberhuber?= <oberhuber.tomas@gmail.com>
Date: Thu, 30 Dec 2021 13:07:50 +0100
Subject: [PATCH] Added example to documentation of iterative linear solvers.
---
src/TNL/Solvers/Linear/BICGStab.h | 2 ++
src/TNL/Solvers/Linear/BICGStabL.h | 4 +++-
src/TNL/Solvers/Linear/CG.h | 2 ++
src/TNL/Solvers/Linear/GMRES.h | 4 ++++
src/TNL/Solvers/Linear/Jacobi.h | 2 ++
5 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/src/TNL/Solvers/Linear/BICGStab.h b/src/TNL/Solvers/Linear/BICGStab.h
index 2d1e7d3a10..c9d973ad12 100644
--- a/src/TNL/Solvers/Linear/BICGStab.h
+++ b/src/TNL/Solvers/Linear/BICGStab.h
@@ -23,6 +23,8 @@ namespace TNL {
*
* See [Wikipedia](https://en.wikipedia.org/wiki/Biconjugate_gradient_stabilized_method) for more details.
*
+ * See \ref TNL::Solvers::Linear::IterativeSolver for example of showing how to use the linear solvers.
+ *
* \tparam Matrix is type of matrix describing the linear system.
*/
template< typename Matrix >
diff --git a/src/TNL/Solvers/Linear/BICGStabL.h b/src/TNL/Solvers/Linear/BICGStabL.h
index 682d14370b..1814ac3148 100644
--- a/src/TNL/Solvers/Linear/BICGStabL.h
+++ b/src/TNL/Solvers/Linear/BICGStabL.h
@@ -71,7 +71,9 @@ namespace TNL {
*
* [4] Martin H. Gutknecht, "Variants of BiCGStab for matrices with complex
* spectrum", IPS Research Report No. 91-14 (1991).
-
+ *
+ * See \ref TNL::Solvers::Linear::IterativeSolver for example of showing how to use the linear solvers.
+ *
* \tparam Matrix is type of matrix describing the linear system.
*/
template< typename Matrix >
diff --git a/src/TNL/Solvers/Linear/CG.h b/src/TNL/Solvers/Linear/CG.h
index ecabc0296f..605c81fb30 100644
--- a/src/TNL/Solvers/Linear/CG.h
+++ b/src/TNL/Solvers/Linear/CG.h
@@ -24,6 +24,8 @@ namespace TNL {
* See [Wikipedia](https://en.wikipedia.org/wiki/Conjugate_gradient_method) for more details.
*
* \tparam Matrix is type of matrix describing the linear system.
+ *
+ * See \ref TNL::Solvers::Linear::IterativeSolver for example of showing how to use the linear solvers.
*/
template< typename Matrix >
class CG
diff --git a/src/TNL/Solvers/Linear/GMRES.h b/src/TNL/Solvers/Linear/GMRES.h
index c2f0c32ef9..67c5edc164 100644
--- a/src/TNL/Solvers/Linear/GMRES.h
+++ b/src/TNL/Solvers/Linear/GMRES.h
@@ -37,6 +37,10 @@ namespace TNL {
*
* See [Wikipedia](https://en.wikipedia.org/wiki/Generalized_minimal_residual_method) for more details.
*
+ * See \ref TNL::Solvers::Linear::IterativeSolver for example of showing how to use the linear solvers.
+ *
+ * See \ref TNL::Solvers::Linear::IterativeSolver for example of showing how to use the linear solvers.
+ *
* \tparam Matrix is type of matrix describing the linear system.
*/
template< typename Matrix >
diff --git a/src/TNL/Solvers/Linear/Jacobi.h b/src/TNL/Solvers/Linear/Jacobi.h
index 18afea2048..1cc061da98 100644
--- a/src/TNL/Solvers/Linear/Jacobi.h
+++ b/src/TNL/Solvers/Linear/Jacobi.h
@@ -21,6 +21,8 @@ namespace TNL {
*
* See [Wikipedia](https://en.wikipedia.org/wiki/Jacobi_method) for more details.
*
+ * See \ref TNL::Solvers::Linear::IterativeSolver for example of showing how to use the linear solvers.
+ *
* \tparam Matrix is type of matrix describing the linear system.
*/
template< typename Matrix >
--
GitLab