From 860952ee829f07b8080cc0ec9084c9b7caf0fbeb 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:08:00 +0100
Subject: [PATCH] Added example to documentation of iterative linear solvers.
---
src/TNL/Solvers/Linear/SOR.h | 2 ++
src/TNL/Solvers/Linear/TFQMR.h | 2 ++
2 files changed, 4 insertions(+)
diff --git a/src/TNL/Solvers/Linear/SOR.h b/src/TNL/Solvers/Linear/SOR.h
index a64a4a509e..76ff1db97d 100644
--- a/src/TNL/Solvers/Linear/SOR.h
+++ b/src/TNL/Solvers/Linear/SOR.h
@@ -21,6 +21,8 @@ namespace TNL {
*
* See (Wikipedia)[https://en.wikipedia.org/wiki/Successive_over-relaxation] 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/TFQMR.h b/src/TNL/Solvers/Linear/TFQMR.h
index e9ec68de5b..97a2438829 100644
--- a/src/TNL/Solvers/Linear/TFQMR.h
+++ b/src/TNL/Solvers/Linear/TFQMR.h
@@ -21,6 +21,8 @@ namespace TNL {
*
* See (Wikipedia)[https://second.wiki/wiki/algoritmo_tfqmr] 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