![]() |
Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
|
This class generates the (S)SOR preconditioner. More...
#include <ginkgo/core/preconditioner/sor.hpp>
Classes | |
| struct | parameters_type |
Public Types | |
| using | value_type = ValueType |
| using | index_type = IndexType |
| using | composition_type = Composition<ValueType> |
| Public Types inherited from gko::EnablePolymorphicAssignment< Sor< default_precision, int32 > > | |
| using | result_type |
| Public Types inherited from gko::ConvertibleTo< Sor< default_precision, int32 > > | |
| using | result_type |
Public Member Functions | |
| const parameters_type & | get_parameters () |
| Returns the parameters used to construct the factory. | |
| const parameters_type & | get_parameters () const |
| Returns the parameters used to construct the factory. | |
| std::unique_ptr< composition_type > | generate (std::shared_ptr< const LinOp > system_matrix) const |
| Creates a new product from the given components. | |
| Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Sor< default_precision, int32 >, LinOpFactory > | |
| std::unique_ptr< Sor< default_precision, int32 > > | create_default (std::shared_ptr< const Executor > exec) const |
| std::unique_ptr< Sor< default_precision, int32 > > | clone (std::shared_ptr< const Executor > exec) const |
| Sor< default_precision, int32 > * | copy_from (const PolymorphicObject *other) |
| Sor< default_precision, int32 > * | move_from (ptr_param< PolymorphicObject > other) |
| Sor< default_precision, int32 > * | clear () |
| Public Member Functions inherited from gko::LinOpFactory | |
| std::unique_ptr< LinOp > | generate (std::shared_ptr< const LinOp > input) const |
| Public Member Functions inherited from gko::PolymorphicObject | |
| PolymorphicObject & | operator= (const PolymorphicObject &) |
| std::unique_ptr< PolymorphicObject > | create_default (std::shared_ptr< const Executor > exec) const |
| Creates a new "default" object of the same dynamic type as this object. | |
| std::unique_ptr< PolymorphicObject > | create_default () const |
| Creates a new "default" object of the same dynamic type as this object. | |
| std::unique_ptr< PolymorphicObject > | clone (std::shared_ptr< const Executor > exec) const |
| Creates a clone of the object. | |
| std::unique_ptr< PolymorphicObject > | clone () const |
| Creates a clone of the object. | |
| PolymorphicObject * | copy_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. | |
| PolymorphicObject * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
| Copies another object into this object. | |
| PolymorphicObject * | move_from (ptr_param< PolymorphicObject > other) |
| Moves another object into this object. | |
| PolymorphicObject * | clear () |
| Transforms the object into its default state. | |
| std::shared_ptr< const Executor > | get_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< Sor< default_precision, int32 > > | |
| void | convert_to (result_type *result) const override |
| void | move_to (result_type *result) override |
Static Public Member Functions | |
| static parameters_type | build () |
| Creates a new parameter_type to set up the factory. | |
| static parameters_type | parse (const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >()) |
Friends | |
| class | EnablePolymorphicObject< Sor, LinOpFactory > |
| class | enable_parameters_type< parameters_type, Sor > |
This class generates the (S)SOR preconditioner.
The SOR preconditioner starts from a splitting of the the matrix 




![\[M = \frac{1}{\omega} (D + \omega L), \quad 0 < \omega < 2.
\]](form_114.png)


![\[M = \frac{1}{\omega (2 - \omega)} (D + \omega L) D^{-1} (D + \omega U) ,
\quad 0 < \omega < 2.
\]](form_116.png)
A detailed description can be found in Iterative Methods for Sparse Linear Systems (Y. Saad) ch. 4.1.
This class is a factory, which will only generate the preconditioner. The resulting LinOp will represent the application of 
| ValueType | The value type of the internally used CSR matrix |
| IndexType | The index type of the internally used CSR matrix |
| std::unique_ptr< composition_type > gko::preconditioner::Sor< ValueType, IndexType >::generate | ( | std::shared_ptr< const LinOp > | system_matrix | ) | const |
Creates a new product from the given components.
The method will create an ComponentsType object from the arguments of this method, and pass it to the generate_impl() function which will create a new AbstractProductType.
| Args | types of arguments passed to the constructor of ComponentsType |
| args | arguments passed to the constructor of ComponentsType |
|
inline |
Returns the parameters used to construct the factory.
|
inline |
Returns the parameters used to construct the factory.