gko::Preconditionable Class Reference

A LinOp implementing this interface can be preconditioned. More...

#include <ginkgo/core/base/lin_op.hpp>

Inheritance diagram for gko::Preconditionable:

Public Member Functions
virtual std::shared_ptr< const LinOp >	get_preconditioner () const
	Returns the preconditioner operator used by the Preconditionable. More...
virtual void	set_preconditioner (std::shared_ptr< const LinOp > new_precond)
	Sets the preconditioner operator used by the Preconditionable. More...

Detailed Description

A LinOp implementing this interface can be preconditioned.

Member Function Documentation

get_preconditioner()

virtual std::shared_ptr<const LinOp> gko::Preconditionable::get_preconditioner ( ) const

inlinevirtual

Returns the preconditioner operator used by the Preconditionable.

Returns

the preconditioner operator used by the Preconditionable

Referenced by gko::solver::EnablePreconditionedIterativeSolver< ValueType, Cg< ValueType > >::get_unprojected_preconditioner(), and gko::solver::EnablePreconditionable< Chebyshev< ValueType > >::operator=().

set_preconditioner()

virtual void gko::Preconditionable::set_preconditioner ( std::shared_ptr< const LinOp >  new_precond )

inlinevirtual

Sets the preconditioner operator used by the Preconditionable.

Parameters

new_precond

the new preconditioner operator used by the Preconditionable

Reimplemented in gko::solver::EnablePreconditionedIterativeSolver< ValueType, DerivedType >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Cgs< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Idr< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Fcg< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, CbGmres< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Chebyshev< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Bicg< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Gmres< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, PipeCg< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Minres< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Bicgstab< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Gcr< ValueType > >, gko::solver::EnablePreconditionedIterativeSolver< ValueType, Cg< ValueType > >, gko::solver::EnablePreconditionable< DerivedType >, gko::solver::EnablePreconditionable< PipeCg< ValueType > >, gko::solver::EnablePreconditionable< Bicgstab< ValueType > >, gko::solver::EnablePreconditionable< Gmres< ValueType > >, gko::solver::EnablePreconditionable< CbGmres< ValueType > >, gko::solver::EnablePreconditionable< Fcg< ValueType > >, gko::solver::EnablePreconditionable< Minres< ValueType > >, gko::solver::EnablePreconditionable< Idr< ValueType > >, gko::solver::EnablePreconditionable< Cgs< ValueType > >, gko::solver::EnablePreconditionable< Gcr< ValueType > >, gko::solver::EnablePreconditionable< Cg< ValueType > >, gko::solver::EnablePreconditionable< Bicg< ValueType > >, and gko::solver::EnablePreconditionable< Chebyshev< ValueType > >.

Referenced by gko::solver::EnablePreconditionable< Chebyshev< ValueType > >::set_preconditioner().

---

The documentation for this class was generated from the following file:

• ginkgo/core/base/lin_op.hpp