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 Member Functions
void	apply (ptr_param< const MultiVector< ValueType >> b, ptr_param< MultiVector< ValueType >> x) const
void	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
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::batch::BatchLinOp
size_type	get_num_batch_items () const noexcept
	Returns the number of items in the batch operator. More...
dim< 2 >	get_common_size () const
	Returns the common size of the batch items. More...
const batch_dim< 2 > &	get_size () const noexcept
	Returns the size of the batch operator. More...
template<typename ValueType >
void	validate_application_parameters (const MultiVector< ValueType > *b, MultiVector< ValueType > *x) const
	Validates the sizes for the apply(b,x) operation in the concrete BatchLinOp.
template<typename ValueType >
void	validate_application_parameters (const MultiVector< ValueType > *alpha, const MultiVector< ValueType > *b, const MultiVector< ValueType > *beta, MultiVector< ValueType > *x) const
	Validates the sizes for the apply(alpha, b , beta, x) operation in the concrete BatchLinOp.
Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)
std::shared_ptr< const Executor >	get_executor () const noexcept
	Returns the Executor of the object. More...
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override
void	remove_logger (const Logger *logger) override
void	remove_logger (ptr_param< const Logger > logger)
const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override
void	clear_loggers () override
Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

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