Inheritance diagram for GinkgoWrappers::SolverCGS< ValueType, IndexType >:

Public Member Functions
	SolverCGS (SolverControl &solver_control, const std::string &exec_type, const AdditionalData &data=AdditionalData())

	SolverCGS (SolverControl &solver_control, const std::string &exec_type, const std::shared_ptr< gko::LinOpFactory > &preconditioner, const AdditionalData &data=AdditionalData())

Public Member Functions inherited from GinkgoWrappers::SolverBase< ValueType, IndexType >
	SolverBase (SolverControl &solver_control, const std::string &exec_type)

virtual	~SolverBase ()=default

void	initialize (const SparseMatrix< ValueType > &matrix)

void	apply (Vector< ValueType > &solution, const Vector< ValueType > &rhs)

void	solve (const SparseMatrix< ValueType > &matrix, Vector< ValueType > &solution, const Vector< ValueType > &rhs)

SolverControl &	control () const

Protected Attributes
const AdditionalData	additional_data

Protected Attributes inherited from GinkgoWrappers::SolverBase< ValueType, IndexType >
SolverControl &	solver_control

std::shared_ptr< gko::LinOpFactory >	solver_gen

std::shared_ptr< gko::stop::ResidualNormReduction<>::Factory >	residual_criterion

std::shared_ptr< gko::log::Convergence<> >	convergence_logger

std::shared_ptr< gko::stop::Combined::Factory >	combined_factory

std::shared_ptr< gko::Executor >	executor

Detailed Description

An implementation of the solver interface using the Ginkgo CGS solver.

CGS or the conjugate gradient square method is an iterative type Krylov subspace method which is suitable for general systems.

Definition at line 329 of file ginkgo_solver.h.

Constructor & Destructor Documentation

template<typename ValueType , typename IndexType >

GinkgoWrappers::SolverCGS< ValueType, IndexType >::SolverCGS	(	SolverControl &	solver_control,
		const std::string &	exec_type,
		const AdditionalData &	data = `AdditionalData()`
	)

Constructor.

Parameters

[in,out]	solver_control	The solver control object is then used to set the parameters and setup the CGS solver from the CGS factory which solves the linear system.
[in]	exec_type	The execution paradigm for the CGS solver.
[in]	data	The additional data required by the solver.

Definition at line 372 of file ginkgo_solver.cc.

template<typename ValueType , typename IndexType >

GinkgoWrappers::SolverCGS< ValueType, IndexType >::SolverCGS	(	SolverControl &	solver_control,
		const std::string &	exec_type,
		const std::shared_ptr< gko::LinOpFactory > &	preconditioner,
		const AdditionalData &	data = `AdditionalData()`
	)

Constructor.

Parameters

[in,out]	solver_control	The solver control object is then used to set the parameters and setup the CGS solver from the CGS factory which solves the linear system.
[in]	exec_type	The execution paradigm for the CGS solver.
[in]	preconditioner	The preconditioner for the solver.
[in]	data	The additional data required by the solver.

Definition at line 386 of file ginkgo_solver.cc.

template<typename ValueType = double, typename IndexType = int32_t>

const AdditionalData GinkgoWrappers::SolverCGS< ValueType, IndexType >::additional_data

protected

Store a copy of the settings for this particular solver.

Definition at line 375 of file ginkgo_solver.h.

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