Reference documentation for deal.II version 9.2.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Classes | Public Member Functions | Protected Attributes | List of all members
GinkgoWrappers::SolverGMRES< ValueType, IndexType > Class Template Reference

#include <deal.II/lac/ginkgo_solver.h>

Inheritance diagram for GinkgoWrappers::SolverGMRES< ValueType, IndexType >:
[legend]

Classes

struct  AdditionalData
 

Public Member Functions

 SolverGMRES (SolverControl &solver_control, const std::string &exec_type, const AdditionalData &data=AdditionalData())
 
 SolverGMRES (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< double, int32_t >
 SolverBase (SolverControl &solver_control, const std::string &exec_type)
 
virtual ~SolverBase ()=default
 
void initialize (const SparseMatrix< double > &matrix)
 
void apply (Vector< double > &solution, const Vector< double > &rhs)
 
void solve (const SparseMatrix< double > &matrix, Vector< double > &solution, const Vector< double > &rhs)
 
SolverControlcontrol () const
 

Protected Attributes

const AdditionalData additional_data
 
- Protected Attributes inherited from GinkgoWrappers::SolverBase< double, int32_t >
SolverControlsolver_control
 
std::shared_ptr< gko::LinOpFactory > solver_gen
 
std::shared_ptr< gko::stop::ResidualNormReduction<>::Factoryresidual_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

template<typename ValueType = double, typename IndexType = int32_t>
class GinkgoWrappers::SolverGMRES< ValueType, IndexType >

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

Definition at line 451 of file ginkgo_solver.h.

Constructor & Destructor Documentation

◆ SolverGMRES() [1/2]

template<typename ValueType , typename IndexType >
SolverGMRES< ValueType, IndexType >::SolverGMRES ( SolverControl solver_control,
const std::string &  exec_type,
const AdditionalData data = AdditionalData() 
)

Constructor.

Parameters
[in,out]solver_controlThe solver control object is then used to set the parameters and setup the GMRES solver from the GMRES factory which solves the linear system.
[in]exec_typeThe execution paradigm for the GMRES solver.
[in]dataThe additional data required by the solver.

Definition at line 446 of file ginkgo_solver.cc.

◆ SolverGMRES() [2/2]

template<typename ValueType , typename IndexType >
SolverGMRES< ValueType, IndexType >::SolverGMRES ( SolverControl solver_control,
const std::string &  exec_type,
const std::shared_ptr< gko::LinOpFactory > &  preconditioner,
const AdditionalData data = AdditionalData() 
)

Constructor.

Parameters
[in,out]solver_controlThe solver control object is then used to set the parameters and setup the GMRES solver from the GMRES factory which solves the linear system.
[in]exec_typeThe execution paradigm for the GMRES solver.
[in]preconditionerThe preconditioner for the solver.
[in]dataThe additional data required by the solver.

Definition at line 462 of file ginkgo_solver.cc.

Member Data Documentation

◆ additional_data

template<typename ValueType = double, typename IndexType = int32_t>
const AdditionalData GinkgoWrappers::SolverGMRES< ValueType, IndexType >::additional_data
protected

Store a copy of the settings for this particular solver.

Definition at line 508 of file ginkgo_solver.h.


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