Ginkgo  Generated from pipelines/1556235455 branch based on develop. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
gko::solver::Gmres< ValueType > Class Template Reference

GMRES or the generalized minimal residual method is an iterative type Krylov subspace method which is suitable for nonsymmetric linear systems. More...

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

Inheritance diagram for gko::solver::Gmres< ValueType >:
[legend]
Collaboration diagram for gko::solver::Gmres< ValueType >:
[legend]

Classes

class  Factory
 
struct  parameters_type
 

Public Types

using value_type = ValueType
 
using transposed_type = Gmres< ValueType >
 
- Public Types inherited from gko::EnablePolymorphicAssignment< Gmres< ValueType > >
using result_type = Gmres< ValueType >
 
- Public Types inherited from gko::ConvertibleTo< Gmres< ValueType > >
using result_type = Gmres< ValueType >
 

Public Member Functions

std::unique_ptr< LinOptranspose () const override
 Returns a LinOp representing the transpose of the Transposable object. More...
 
std::unique_ptr< LinOpconj_transpose () const override
 Returns a LinOp representing the conjugate transpose of the Transposable object. More...
 
bool apply_uses_initial_guess () const override
 Return true as iterative solvers use the data in x as an initial guess. More...
 
size_type get_krylov_dim () const
 Gets the Krylov dimension of the solver. More...
 
void set_krylov_dim (size_type other)
 Sets the Krylov dimension. More...
 
const parameters_typeget_parameters () const
 
- Public Member Functions inherited from gko::EnableLinOp< Gmres< ValueType > >
const Gmres< ValueType > * apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
 
Gmres< ValueType > * apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
 
const Gmres< ValueType > * apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
 
Gmres< ValueType > * apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Gmres< ValueType >, LinOp >
std::unique_ptr< Gmres< ValueType > > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Gmres< ValueType > > create_default () const
 
std::unique_ptr< Gmres< ValueType > > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Gmres< ValueType > > clone () const
 
Gmres< ValueType > * copy_from (const PolymorphicObject *other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Gmres< ValueType > > * copy_from (std::unique_ptr< Derived > &&other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Gmres< ValueType > > * copy_from (const std::unique_ptr< Derived > &other)
 
Gmres< ValueType > * copy_from (const std::shared_ptr< const PolymorphicObject > &other)
 
Gmres< ValueType > * move_from (ptr_param< PolymorphicObject > other)
 
Gmres< ValueType > * clear ()
 
- Public Member Functions inherited from gko::LinOp
LinOpapply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
const LinOpapply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
 
LinOpapply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)
 Performs the operation x = alpha * op(b) + beta * x. More...
 
const LinOpapply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
 
const dim< 2 > & get_size () const noexcept
 Returns the size of the operator. More...
 
LinOpoperator= (const LinOp &)=default
 Copy-assigns a LinOp. More...
 
LinOpoperator= (LinOp &&other)
 Move-assigns a LinOp. More...
 
 LinOp (const LinOp &)=default
 Copy-constructs a LinOp. More...
 
 LinOp (LinOp &&other)
 Move-constructs a LinOp. More...
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOpcreate_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpcreate_default () const
 
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpclone () const
 
LinOpcopy_from (const PolymorphicObject *other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * copy_from (std::unique_ptr< Derived > &&other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * copy_from (const std::unique_ptr< Derived > &other)
 
LinOpcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 
LinOpmove_from (ptr_param< PolymorphicObject > other)
 
LinOpclear ()
 
- Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObjectoperator= (const PolymorphicObject &)
 
std::unique_ptr< PolymorphicObjectcreate_default (std::shared_ptr< const Executor > exec) const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object. More...
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object. More...
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object. More...
 
template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > * copy_from (std::unique_ptr< Derived, Deleter > &&other)
 Moves another object into this object. More...
 
template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > * copy_from (const std::unique_ptr< Derived, Deleter > &other)
 Copies another object into this object. More...
 
PolymorphicObjectcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 Copies another object into this object. More...
 
PolymorphicObjectmove_from (ptr_param< PolymorphicObject > other)
 Moves another object into this object. More...
 
PolymorphicObjectclear ()
 Transforms the object into its default state. More...
 
std::shared_ptr< const Executorget_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)
 
- Public Member Functions inherited from gko::EnablePolymorphicAssignment< Gmres< ValueType > >
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< Gmres< ValueType > >
void convert_to (ptr_param< result_type > result) const
 
void move_to (ptr_param< result_type > result)
 
- Public Member Functions inherited from gko::solver::EnablePreconditionedIterativeSolver< ValueType, Gmres< ValueType > >
 EnablePreconditionedIterativeSolver (std::shared_ptr< const LinOp > system_matrix, std::shared_ptr< const stop::CriterionFactory > stop_factory, std::shared_ptr< const LinOp > preconditioner)
 
 EnablePreconditionedIterativeSolver (std::shared_ptr< const LinOp > system_matrix, const FactoryParameters &params)
 
- Public Member Functions inherited from gko::solver::EnableSolverBase< Gmres< ValueType > >
EnableSolverBaseoperator= (const EnableSolverBase &other)
 Creates a shallow copy of the provided system matrix, clones it onto this executor if executors don't match.
 
EnableSolverBaseoperator= (EnableSolverBase &&other)
 Moves the provided system matrix, clones it onto this executor if executors don't match. More...
 
 EnableSolverBase (std::shared_ptr< const LinOp > system_matrix)
 
 EnableSolverBase (const EnableSolverBase &other)
 Creates a shallow copy of the provided system matrix.
 
 EnableSolverBase (EnableSolverBase &&other)
 Moves the provided system matrix. More...
 
int get_num_workspace_ops () const override
 
std::vector< std::string > get_workspace_op_names () const override
 
std::vector< int > get_workspace_scalars () const override
 Returns the IDs of all scalars (workspace vectors with system dimension-independent size, usually 1 x num_rhs).
 
std::vector< int > get_workspace_vectors () const override
 Returns the IDs of all vectors (workspace vectors with system dimension-dependent size, usually system_matrix_size x num_rhs).
 
- Public Member Functions inherited from gko::solver::SolverBase< LinOp >
std::shared_ptr< const LinOpget_system_matrix () const
 Returns the system matrix, with its concrete type, used by the solver. More...
 
- Public Member Functions inherited from gko::solver::EnableIterativeBase< Gmres< ValueType > >
EnableIterativeBaseoperator= (const EnableIterativeBase &other)
 Creates a shallow copy of the provided stopping criterion, clones it onto this executor if executors don't match.
 
EnableIterativeBaseoperator= (EnableIterativeBase &&other)
 Moves the provided stopping criterion, clones it onto this executor if executors don't match. More...
 
 EnableIterativeBase (std::shared_ptr< const stop::CriterionFactory > stop_factory)
 
 EnableIterativeBase (const EnableIterativeBase &other)
 Creates a shallow copy of the provided stopping criterion.
 
 EnableIterativeBase (EnableIterativeBase &&other)
 Moves the provided stopping criterion. More...
 
void set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > new_stop_factory) override
 Sets the stopping criterion of the solver. More...
 
- Public Member Functions inherited from gko::solver::IterativeBase
std::shared_ptr< const stop::CriterionFactoryget_stop_criterion_factory () const
 Gets the stopping criterion factory of the solver. More...
 
- Public Member Functions inherited from gko::solver::EnablePreconditionable< Gmres< ValueType > >
void set_preconditioner (std::shared_ptr< const LinOp > new_precond) override
 Sets the preconditioner operator used by the Preconditionable. More...
 
EnablePreconditionableoperator= (const EnablePreconditionable &other)
 Creates a shallow copy of the provided preconditioner, clones it onto this executor if executors don't match.
 
EnablePreconditionableoperator= (EnablePreconditionable &&other)
 Moves the provided preconditioner, clones it onto this executor if executors don't match. More...
 
 EnablePreconditionable (std::shared_ptr< const LinOp > preconditioner)
 
 EnablePreconditionable (const EnablePreconditionable &other)
 Creates a shallow copy of the provided preconditioner.
 
 EnablePreconditionable (EnablePreconditionable &&other)
 Moves the provided preconditioner. More...
 
- Public Member Functions inherited from gko::Preconditionable
virtual std::shared_ptr< const LinOpget_preconditioner () const
 Returns the preconditioner operator used by the Preconditionable. More...
 

Static Public Member Functions

static auto build () -> decltype(Factory ::create())
 
static parameters_type parse (const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType >())
 Create the parameters from the property_tree. More...
 

Friends

class EnableLinOp< Gmres >
 
class EnablePolymorphicObject< Gmres, LinOp >
 

Detailed Description

template<typename ValueType = default_precision>
class gko::solver::Gmres< ValueType >

GMRES or the generalized minimal residual method is an iterative type Krylov subspace method which is suitable for nonsymmetric linear systems.

The implementation in Ginkgo makes use of the merged kernel to make the best use of data locality. The inner operations in one iteration of GMRES are merged into 2 separate steps. Modified Gram-Schmidt is used.

Template Parameters
ValueTypeprecision of matrix elements

Member Function Documentation

◆ apply_uses_initial_guess()

template<typename ValueType = default_precision>
bool gko::solver::Gmres< ValueType >::apply_uses_initial_guess ( ) const
inlineoverridevirtual

Return true as iterative solvers use the data in x as an initial guess.

Returns
true as iterative solvers use the data in x as an initial guess.

Reimplemented from gko::LinOp.

◆ conj_transpose()

template<typename ValueType = default_precision>
std::unique_ptr<LinOp> gko::solver::Gmres< ValueType >::conj_transpose ( ) const
overridevirtual

Returns a LinOp representing the conjugate transpose of the Transposable object.

Returns
a pointer to the new conjugate transposed object

Implements gko::Transposable.

◆ get_krylov_dim()

template<typename ValueType = default_precision>
size_type gko::solver::Gmres< ValueType >::get_krylov_dim ( ) const
inline

Gets the Krylov dimension of the solver.

Returns
the Krylov dimension

References gko::solver::Gmres< ValueType >::parameters_type::krylov_dim.

◆ parse()

template<typename ValueType = default_precision>
static parameters_type gko::solver::Gmres< ValueType >::parse ( const config::pnode config,
const config::registry context,
const config::type_descriptor td_for_child = config::make_type_descriptor< ValueType >() 
)
static

Create the parameters from the property_tree.

Because this is directly tied to the specific type, the value/index type settings within config are ignored and type_descriptor is only used for children configs.

Parameters
configthe property tree for setting
contextthe registry
td_for_childthe type descriptor for children configs. The default uses the value type of this class.
Returns
parameters

◆ set_krylov_dim()

template<typename ValueType = default_precision>
void gko::solver::Gmres< ValueType >::set_krylov_dim ( size_type  other)
inline

Sets the Krylov dimension.

Parameters
otherthe new Krylov dimension

References gko::solver::Gmres< ValueType >::parameters_type::krylov_dim.

◆ transpose()

template<typename ValueType = default_precision>
std::unique_ptr<LinOp> gko::solver::Gmres< ValueType >::transpose ( ) const
overridevirtual

Returns a LinOp representing the transpose of the Transposable object.

Returns
a pointer to the new transposed object

Implements gko::Transposable.


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