Abstract base class for matrix factorizations. More...
#include <factorization.hh>
Detailed Description
class Kaskade::Factorization< Scalar >
Abstract base class for matrix factorizations.
- Template Parameters
-
Scalar the underlying field type of the matrix elements.
Definition at line 42 of file factorization.hh.
Classes | |
| struct | Info |
| The Info struct provides output information of direct solvers. More... | |
Public Types | |
| typedef Scalar | field_type |
| The type of matrix elements (a field type). More... | |
| using | Options = FactorizationOptions |
Public Member Functions | |
| Factorization ()=default | |
| Factorization (Options options_) | |
| virtual | ~Factorization () |
| void | setVerbose (int verbose_) |
| int | getVerbose () const |
| Info const & | info () const |
| virtual size_t | size () const =0 |
| reports the dimension of the system More... | |
System solution | |
| virtual void | solve (std::vector< field_type > &b) const |
| Solves the system \( Ax=b \) for the given right hand side \( b \). More... | |
| virtual void | solve (field_type *b) const =0 |
| Solves the system \( Ax=b \) for the given right hand side \( b \). More... | |
| virtual void | solve (std::vector< Scalar > const &b, std::vector< Scalar > &x, bool transposed=false) const |
| Solves the system \( Ax=b \) for the given right hand side \( b \). More... | |
| virtual void | solve (Scalar const *b, Scalar *x, bool transposed=false) const =0 |
| Solves the system \( Ax=b \) for the given right hand side \( b \). More... | |
Protected Attributes | |
| Options | options |
| Info | info_ |
Member Typedef Documentation
◆ field_type
| typedef Scalar Kaskade::Factorization< Scalar >::field_type |
The type of matrix elements (a field type).
Definition at line 48 of file factorization.hh.
◆ Options
| using Kaskade::Factorization< Scalar >::Options = FactorizationOptions |
Definition at line 50 of file factorization.hh.
Constructor & Destructor Documentation
◆ Factorization() [1/2]
|
default |
◆ Factorization() [2/2]
|
inline |
Definition at line 112 of file factorization.hh.
◆ ~Factorization()
|
inlinevirtual |
Definition at line 113 of file factorization.hh.
Member Function Documentation
◆ getVerbose()
|
inline |
Definition at line 115 of file factorization.hh.
Referenced by Kaskade::MUMPSFactorization< Scalar >::MUMPSFactorization(), and Kaskade::SUPERLUFactorization< Scalar >::SUPERLUFactorization().
◆ info()
|
inline |
Definition at line 117 of file factorization.hh.
◆ setVerbose()
|
inline |
Definition at line 114 of file factorization.hh.
Referenced by Kaskade::MUMPSFactorization< Scalar >::MUMPSFactorization().
◆ size()
|
pure virtual |
reports the dimension of the system
Implemented in Kaskade::MUMPSFactorization< Scalar >, Kaskade::SUPERLUFactorization< Scalar >, and Kaskade::UMFFactorization< Scalar, UMFPackIndex >.
Referenced by Kaskade::Factorization< Scalar >::solve().
◆ solve() [1/4]
|
pure virtual |
Solves the system \( Ax=b \) for the given right hand side \( b \).
- Parameters
-
[in,out] b right hand side, is overwritten with the solution \( x \). This must point to a memory region of length of system dimension.
Implemented in Kaskade::MUMPSFactorization< Scalar >, Kaskade::SUPERLUFactorization< Scalar >, and Kaskade::UMFFactorization< Scalar, UMFPackIndex >.
◆ solve() [2/4]
|
pure virtual |
Solves the system \( Ax=b \) for the given right hand side \( b \).
- Parameters
-
[in] b the right hand side [out] x the solution. x must point to a memory region of length of system dimension.
Implemented in Kaskade::MUMPSFactorization< Scalar >, Kaskade::SUPERLUFactorization< Scalar >, and Kaskade::UMFFactorization< Scalar, UMFPackIndex >.
◆ solve() [3/4]
|
inlinevirtual |
Solves the system \( Ax=b \) for the given right hand side \( b \).
- Parameters
-
[in,out] b right hand side, is overwritten with the solution \( x \).
Reimplemented in Kaskade::MUMPSFactorization< Scalar >, Kaskade::MUMPSFactorization< Scalar >, Kaskade::PardisoFactorization< Scalar, SparseIndexInt, DIL >, Kaskade::SUPERLUFactorization< Scalar >, and Kaskade::UMFFactorization< Scalar, UMFPackIndex >.
Definition at line 76 of file factorization.hh.
Referenced by Kaskade::Factorization< Scalar >::solve().
◆ solve() [4/4]
|
inlinevirtual |
Solves the system \( Ax=b \) for the given right hand side \( b \).
- Parameters
-
[in] b the right hand side [out] x the solution. x is resized if needed.
Reimplemented in Kaskade::MUMPSFactorization< Scalar >, Kaskade::MUMPSFactorization< Scalar >, Kaskade::PardisoFactorization< Scalar, SparseIndexInt, DIL >, Kaskade::SUPERLUFactorization< Scalar >, and Kaskade::UMFFactorization< Scalar, UMFPackIndex >.
Definition at line 94 of file factorization.hh.
Member Data Documentation
◆ info_
|
protected |
Definition at line 126 of file factorization.hh.
Referenced by Kaskade::MUMPSFactorization< Scalar >::factorize(), and Kaskade::Factorization< Scalar >::info().
◆ options
|
protected |
Definition at line 125 of file factorization.hh.
Referenced by Kaskade::MUMPSFactorization< Scalar >::analyze(), Kaskade::MUMPSFactorization< Scalar >::factorize(), Kaskade::Factorization< Scalar >::getVerbose(), Kaskade::MUMPSFactorization< Scalar >::init(), and Kaskade::Factorization< Scalar >::setVerbose().
The documentation for this class was generated from the following files:
