Reference documentation for deal.II version Git 44f8b89d8e 2019-09-19 12:50:43 +0200
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Classes | Public Member Functions | Protected Attributes | List of all members
GinkgoWrappers::SolverBicgstab< ValueType, IndexType > Class Template Reference

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

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

Classes

struct  AdditionalData
 

Public Member Functions

 SolverBicgstab (SolverControl &solver_control, const std::string &exec_type, const AdditionalData &data=AdditionalData())
 
 SolverBicgstab (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)
 
SolverControlcontrol () const
 

Protected Attributes

const AdditionalData additional_data
 
- Protected Attributes inherited from GinkgoWrappers::SolverBase< ValueType, IndexType >
SolverControlsolver_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

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

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

Definition at line 271 of file ginkgo_solver.h.

Constructor & Destructor Documentation

◆ SolverBicgstab() [1/2]

template<typename ValueType , typename IndexType >
SolverBicgstab< ValueType, IndexType >::SolverBicgstab ( 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 Bicgstab solver from the Bicgstab factory which solves the linear system.
[in]exec_typeThe execution paradigm for the Bicgstab solver.
[in]dataThe additional data required by the solver.

Definition at line 337 of file ginkgo_solver.cc.

◆ SolverBicgstab() [2/2]

template<typename ValueType , typename IndexType >
SolverBicgstab< ValueType, IndexType >::SolverBicgstab ( 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 Bicgstab solver from the Bicgstab factory which solves the linear system.
[in]exec_typeThe execution paradigm for the Bicgstab solver.
[in]preconditionerThe preconditioner for the solver.
[in]dataThe additional data required by the solver.

Definition at line 353 of file ginkgo_solver.cc.

Member Data Documentation

◆ additional_data

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

Store a copy of the settings for this particular solver.

Definition at line 317 of file ginkgo_solver.h.


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