Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
gko::solver::Idr< ValueType > Class Template Reference

IDR(s) is an efficient method for solving large nonsymmetric systems of linear equations. More...

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

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

Classes

class  Factory
struct  parameters_type

Public Types

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

Public Member Functions

std::unique_ptr< LinOptranspose () const override
 Returns a LinOp representing the transpose of the Transposable object.
std::unique_ptr< LinOpconj_transpose () const override
 Returns a LinOp representing the conjugate transpose of the Transposable object.
bool apply_uses_initial_guess () const override
 Return true as iterative solvers use the data in x as an initial guess.
size_type get_subspace_dim () const
 Gets the subspace dimension of the solver.
void set_subspace_dim (const size_type other)
 Sets the subspace dimension of the solver.
remove_complex< ValueType > get_kappa () const
 Gets the kappa parameter of the solver.
void set_kappa (const remove_complex< ValueType > other)
 Sets the kappa parameter of the solver.
bool get_deterministic () const
 Gets the deterministic parameter of the solver.
void set_deterministic (const bool other)
 Sets the deterministic parameter of the solver.
bool get_complex_subspace () const
 Gets the complex_subspace parameter of the solver.
void set_complex_subpsace (const bool other)
 Sets the complex_subspace parameter of the solver.
void set_complex_subspace (const bool other)
 Sets the complex_subspace parameter of the solver.
const parameters_typeget_parameters () const
Public Member Functions inherited from gko::EnableLinOp< Idr< default_precision > >
const Idr< default_precision > * apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Idr< default_precision >, LinOp >
std::unique_ptr< Idr< default_precision > > create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Idr< default_precision > > clone (std::shared_ptr< const Executor > exec) const
Idr< default_precision > * copy_from (const PolymorphicObject *other)
Idr< default_precision > * move_from (ptr_param< PolymorphicObject > other)
Idr< default_precision > * 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).
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.
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.
LinOpoperator= (const LinOp &)=default
 Copy-assigns a LinOp.
LinOpoperator= (LinOp &&other)
 Move-assigns a LinOp.
 LinOp (const LinOp &)=default
 Copy-constructs a LinOp.
 LinOp (LinOp &&other)
 Move-constructs a LinOp.
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOpcreate_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
LinOpcopy_from (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.
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object.
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object.
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object.
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object.
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.
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.
PolymorphicObjectcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 Copies another object into this object.
PolymorphicObjectmove_from (ptr_param< PolymorphicObject > other)
 Moves another object into this object.
PolymorphicObjectclear ()
 Transforms the object into its default state.
std::shared_ptr< const Executorget_executor () const noexcept
 Returns the Executor of the object.
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void add_logger (std::shared_ptr< const Logger > logger) override
 Adds a new logger to the list of subscribed loggers.
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers.
const std::vector< std::shared_ptr< const Logger > > & get_loggers () const override
 Returns the vector containing all loggers registered at this object.
void clear_loggers () override
 Remove all loggers registered at this object.
Public Member Functions inherited from gko::log::Loggable
void remove_logger (ptr_param< const Logger > logger)
Public Member Functions inherited from gko::EnablePolymorphicAssignment< Idr< default_precision > >
void convert_to (result_type *result) const override
void move_to (result_type *result) override
Public Member Functions inherited from gko::solver::EnableSolverBase< Idr< default_precision > >
EnableSolverBaseoperator= (const EnableSolverBase &other)
 Creates a shallow copy of the provided system matrix, clones it onto this executor if executors don't match.
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.
Public Member Functions inherited from gko::solver::EnableIterativeBase< Idr< default_precision > >
EnableIterativeBaseoperator= (const EnableIterativeBase &other)
 Creates a shallow copy of the provided stopping criterion, clones it onto this executor if executors don't match.
void set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > new_stop_factory) override
 Sets the stopping criterion of the solver.
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.
Public Member Functions inherited from gko::solver::EnablePreconditionable< Idr< default_precision > >
void set_preconditioner (std::shared_ptr< const LinOp > new_precond) override
 Sets the preconditioner operator used by the Preconditionable.
EnablePreconditionableoperator= (const EnablePreconditionable &other)
 Creates a shallow copy of the provided preconditioner, clones it onto this executor if executors don't match.
Public Member Functions inherited from gko::Preconditionable
virtual std::shared_ptr< const LinOpget_preconditioner () const
 Returns the preconditioner operator used by the Preconditionable.

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.

Friends

class EnableLinOp< Idr >
class EnablePolymorphicObject< Idr, LinOp >

Detailed Description

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

IDR(s) is an efficient method for solving large nonsymmetric systems of linear equations.

The implemented version is the one presented in the paper "Algorithm 913: An elegant IDR(s) variant that efficiently exploits biorthogonality properties" by M. B. Van Gijzen and P. Sonneveld.

The method is based on the induced dimension reduction theorem which provides a way to construct subsequent residuals that lie in a sequence of shrinking subspaces. These subspaces are spanned by s vectors which are first generated randomly and then orthonormalized. They are stored in a dense matrix.

Template Parameters
ValueTypeprecision of the elements of the system matrix.

Member Function Documentation

◆ apply_uses_initial_guess()

template<typename ValueType = default_precision>
bool gko::solver::Idr< 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::Idr< 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_complex_subspace()

template<typename ValueType = default_precision>
bool gko::solver::Idr< ValueType >::get_complex_subspace ( ) const
inline

Gets the complex_subspace parameter of the solver.

Returns
the complex_subspace parameter

◆ get_deterministic()

template<typename ValueType = default_precision>
bool gko::solver::Idr< ValueType >::get_deterministic ( ) const
inline

Gets the deterministic parameter of the solver.

Returns
the deterministic parameter

◆ get_kappa()

template<typename ValueType = default_precision>
remove_complex< ValueType > gko::solver::Idr< ValueType >::get_kappa ( ) const
inline

Gets the kappa parameter of the solver.

Returns
the kappa parameter

◆ get_subspace_dim()

template<typename ValueType = default_precision>
size_type gko::solver::Idr< ValueType >::get_subspace_dim ( ) const
inline

Gets the subspace dimension of the solver.

Returns
the subspace Dimension

◆ parse()

template<typename ValueType = default_precision>
parameters_type gko::solver::Idr< 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_complex_subpsace()

template<typename ValueType = default_precision>
void gko::solver::Idr< ValueType >::set_complex_subpsace ( const bool other)
inline

Sets the complex_subspace parameter of the solver.

Parameters
otherthe new complex_subspace parameter

◆ set_complex_subspace()

template<typename ValueType = default_precision>
void gko::solver::Idr< ValueType >::set_complex_subspace ( const bool other)
inline

Sets the complex_subspace parameter of the solver.

Parameters
otherthe new complex_subspace parameter

Referenced by set_complex_subpsace().

◆ set_deterministic()

template<typename ValueType = default_precision>
void gko::solver::Idr< ValueType >::set_deterministic ( const bool other)
inline

Sets the deterministic parameter of the solver.

Parameters
otherthe new deterministic parameter

◆ set_kappa()

template<typename ValueType = default_precision>
void gko::solver::Idr< ValueType >::set_kappa ( const remove_complex< ValueType > other)
inline

Sets the kappa parameter of the solver.

Parameters
otherthe new kappa parameter

◆ set_subspace_dim()

template<typename ValueType = default_precision>
void gko::solver::Idr< ValueType >::set_subspace_dim ( const size_type other)
inline

Sets the subspace dimension of the solver.

Parameters
otherthe new subspace Dimension

◆ transpose()

template<typename ValueType = default_precision>
std::unique_ptr< LinOp > gko::solver::Idr< 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: