This project is archived. Its data is read-only.

Commit f8784986 authored Dec 30, 2021 by Tomáš Oberhuber

Added example to documentation of iterative linear solvers.

parent fd1386cb

src/TNL/Solvers/Linear/BICGStab.h

+2 −0

Original line number	Diff line number	Diff line
		@@ -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 >

src/TNL/Solvers/Linear/BICGStabL.h

+3 −1

Original line number	Diff line number	Diff line
		@@ -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 >

src/TNL/Solvers/Linear/CG.h

+2 −0

Original line number	Diff line number	Diff line
		@@ -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

src/TNL/Solvers/Linear/GMRES.h

+4 −0

Original line number	Diff line number	Diff line
		@@ -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 >

src/TNL/Solvers/Linear/Jacobi.h

+2 −0

Original line number	Diff line number	Diff line
		@@ -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 >