gko::batch::solver::EnableBatchSolver< ConcreteSolver, ValueType, PolymorphicBase > Class Template Reference

This mixin provides apply and common iterative solver functionality to all the batched solvers. More...

#include <ginkgo/core/solver/batch_solver_base.hpp>

Inheritance diagram for gko::batch::solver::EnableBatchSolver< ConcreteSolver, ValueType, PolymorphicBase >:

Collaboration diagram for gko::batch::solver::EnableBatchSolver< ConcreteSolver, ValueType, PolymorphicBase >:

Public Types
using	real_type = remove_complex< ValueType >
Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteSolver >
using	result_type = ConcreteSolver
Public Types inherited from gko::ConvertibleTo< ConcreteSolver >
using	result_type = ConcreteSolver

Public Member Functions
const ConcreteSolver *	apply (ptr_param< const MultiVector< ValueType >> b, ptr_param< MultiVector< ValueType >> x) const
const ConcreteSolver *	apply (ptr_param< const MultiVector< ValueType >> alpha, ptr_param< const MultiVector< ValueType >> b, ptr_param< const MultiVector< ValueType >> beta, ptr_param< MultiVector< ValueType >> x) const
ConcreteSolver *	apply (ptr_param< const MultiVector< ValueType >> b, ptr_param< MultiVector< ValueType >> x)
ConcreteSolver *	apply (ptr_param< const MultiVector< ValueType >> alpha, ptr_param< const MultiVector< ValueType >> b, ptr_param< const MultiVector< ValueType >> beta, ptr_param< MultiVector< ValueType >> x)
Public Member Functions inherited from gko::batch::solver::BatchSolver
std::shared_ptr< const BatchLinOp >	get_system_matrix () const
	Returns the system operator (matrix) of the linear system. More...
std::shared_ptr< const BatchLinOp >	get_preconditioner () const
	Returns the generated preconditioner. More...
double	get_tolerance () const
	Get the residual tolerance used by the solver. More...
void	reset_tolerance (double res_tol)
	Update the residual tolerance to be used by the solver. More...
int	get_max_iterations () const
	Get the maximum number of iterations set on the solver. More...
void	reset_max_iterations (int max_iterations)
	Set the maximum number of iterations for the solver to use, independent of the factory that created it. More...
::gko::batch::stop::tolerance_type	get_tolerance_type () const
	Get the tolerance type. More...
void	reset_tolerance_type (::gko::batch::stop::tolerance_type tol_type)
	Set the type of tolerance check to use inside the solver. More...
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< ConcreteSolver, PolymorphicBase >
std::unique_ptr< ConcreteSolver >	create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< ConcreteSolver >	create_default () const
std::unique_ptr< ConcreteSolver >	clone (std::shared_ptr< const Executor > exec) const
std::unique_ptr< ConcreteSolver >	clone () const
ConcreteSolver *	copy_from (const PolymorphicObject *other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, ConcreteSolver > *	copy_from (std::unique_ptr< Derived > &&other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, ConcreteSolver > *	copy_from (const std::unique_ptr< Derived > &other)
ConcreteSolver *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
ConcreteSolver *	move_from (ptr_param< PolymorphicObject > other)
ConcreteSolver *	clear ()
Public Member Functions inherited from gko::EnablePolymorphicAssignment< ConcreteSolver >
void	convert_to (result_type *result) const override
	Converts the implementer to an object of type result_type. More...
void	move_to (result_type *result) override
	Converts the implementer to an object of type result_type by moving data from this object. More...
Public Member Functions inherited from gko::ConvertibleTo< ConcreteSolver >
void	convert_to (ptr_param< result_type > result) const
void	move_to (ptr_param< result_type > result)

Detailed Description

template<typename ConcreteSolver, typename ValueType, typename PolymorphicBase = BatchLinOp>
class gko::batch::solver::EnableBatchSolver< ConcreteSolver, ValueType, PolymorphicBase >

This mixin provides apply and common iterative solver functionality to all the batched solvers.

Template Parameters

ConcreteSolver	The concrete solver class.
ValueType	The value type of the multivectors.
PolymorphicBase	The base class; must be a subclass of BatchLinOp.

---

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

• ginkgo/core/solver/batch_solver_base.hpp