Skip to content
Snippets Groups Projects
Commit f8784986 authored by Tomáš Oberhuber's avatar Tomáš Oberhuber
Browse files

Added example to documentation of iterative linear solvers.

parent fd1386cb
No related branches found
No related tags found
1 merge request!116Documentation for linear solvers and preconditioners
...@@ -23,6 +23,8 @@ namespace TNL { ...@@ -23,6 +23,8 @@ namespace TNL {
* *
* See [Wikipedia](https://en.wikipedia.org/wiki/Biconjugate_gradient_stabilized_method) for more details. * 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. * \tparam Matrix is type of matrix describing the linear system.
*/ */
template< typename Matrix > template< typename Matrix >
......
...@@ -71,7 +71,9 @@ namespace TNL { ...@@ -71,7 +71,9 @@ namespace TNL {
* *
* [4] Martin H. Gutknecht, "Variants of BiCGStab for matrices with complex * [4] Martin H. Gutknecht, "Variants of BiCGStab for matrices with complex
* spectrum", IPS Research Report No. 91-14 (1991). * 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. * \tparam Matrix is type of matrix describing the linear system.
*/ */
template< typename Matrix > template< typename Matrix >
......
...@@ -24,6 +24,8 @@ namespace TNL { ...@@ -24,6 +24,8 @@ namespace TNL {
* See [Wikipedia](https://en.wikipedia.org/wiki/Conjugate_gradient_method) for more details. * See [Wikipedia](https://en.wikipedia.org/wiki/Conjugate_gradient_method) for more details.
* *
* \tparam Matrix is type of matrix describing the linear system. * \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 > template< typename Matrix >
class CG class CG
......
...@@ -37,6 +37,10 @@ namespace TNL { ...@@ -37,6 +37,10 @@ namespace TNL {
* *
* See [Wikipedia](https://en.wikipedia.org/wiki/Generalized_minimal_residual_method) for more details. * 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. * \tparam Matrix is type of matrix describing the linear system.
*/ */
template< typename Matrix > template< typename Matrix >
......
...@@ -21,6 +21,8 @@ namespace TNL { ...@@ -21,6 +21,8 @@ namespace TNL {
* *
* See [Wikipedia](https://en.wikipedia.org/wiki/Jacobi_method) for more details. * 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. * \tparam Matrix is type of matrix describing the linear system.
*/ */
template< typename Matrix > template< typename Matrix >
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment