sll_m_linear_solver_iter_abstract Module Reference

Description

module for abstract iterative linear solvers

Maintainer ARA Modified by Benedikt Perse Stability stable

Derived types and interfaces
type	sll_t_linear_solver_iter_abstract
	class for abstract iterative linear solver More...
interface	sll_p_set_guess_linear_solver_iter_abstract
interface	sll_p_check_convergence_linear_solver_iter_abstract

Functions/Subroutines
subroutine	compute_residual_error_linear_solver_iter_abstract (self, unknown, rhs, r_err)
	computes the residual error for an iterative solver More...
subroutine	set_linop_linear_solver_iter_abstract (self, linear_operator)
	sets a linear operator for an iterative solver More...
subroutine	set_tolerance_linear_solver_iter_abstract (self, atol)
	set absolute tolerance More...
subroutine	free_abstract_linear_solver_iter_abstract (self)
	abstract free for an iterative solver More...

Function/Subroutine Documentation

compute_residual_error_linear_solver_iter_abstract()

subroutine sll_m_linear_solver_iter_abstract::compute_residual_error_linear_solver_iter_abstract	(	class(sll_t_linear_solver_iter_abstract), intent(in)	self,
		real(kind=f64), dimension(:), intent(in)	unknown,
		real(kind=f64), dimension(:), intent(in)	rhs,
		real(kind=f64), intent(inout)	r_err
	)

computes the residual error for an iterative solver

Parameters

[in,out]	self	the current object
[in,out]	unknown	the solution
[in]	rhs	the right hand side

Definition at line 91 of file sll_m_linear_solver_iter_abstract.F90.

free_abstract_linear_solver_iter_abstract()

subroutine sll_m_linear_solver_iter_abstract::free_abstract_linear_solver_iter_abstract ( class(sll_t_linear_solver_iter_abstract), intent(inout)  self )

private

abstract free for an iterative solver

Parameters

[in,out]

self

the current object

Definition at line 188 of file sll_m_linear_solver_iter_abstract.F90.

set_linop_linear_solver_iter_abstract()

subroutine sll_m_linear_solver_iter_abstract::set_linop_linear_solver_iter_abstract ( class(sll_t_linear_solver_iter_abstract), intent(inout), target  self, class(sll_t_linear_operator_abstract), intent(in), target  linear_operator  )

private

sets a linear operator for an iterative solver

Parameters

[in,out]	self	the current object
[in]	linear_operator	a linear operator

Todo:

add nullspace arguments

Definition at line 122 of file sll_m_linear_solver_iter_abstract.F90.

set_tolerance_linear_solver_iter_abstract()

subroutine sll_m_linear_solver_iter_abstract::set_tolerance_linear_solver_iter_abstract ( class(sll_t_linear_solver_iter_abstract), intent(inout)  self, real(kind=f64), intent(in)  atol  )

private

set absolute tolerance

Parameters

[in,out]	self	the current object
[in]	atol	the absolute tolerance to set

Definition at line 172 of file sll_m_linear_solver_iter_abstract.F90.