dune-istl 2.10
|
Dune wrapper for SuiteSparse/CHOLMOD solver. More...
#include <dune/istl/cholmod.hh>
Public Types | |
typedef Vector | domain_type |
Type of the domain of the operator to be inverted. | |
typedef Vector | range_type |
Type of the range of the operator to be inverted. | |
typedef Vector::field_type | field_type |
The field type of the operator. | |
typedef FieldTraits< field_type >::real_type | real_type |
The real type of the field type (is the same if using real numbers, but differs for std::complex) | |
typedef Simd::Scalar< real_type > | scalar_real_type |
scalar type underlying the field_type | |
Public Member Functions | |
Cholmod () | |
Default constructor. | |
~Cholmod () | |
Destructor. | |
Cholmod (const Cholmod &)=delete | |
Cholmod & | operator= (const Cholmod &)=delete |
void | apply (Vector &x, Vector &b, double reduction, InverseOperatorResult &res) |
simple forward to apply(X&, Y&, InverseOperatorResult&) | |
void | apply (Vector &x, Vector &b, InverseOperatorResult &res) |
solve the linear system Ax=b (possibly with respect to some ignore field) | |
template<class Matrix > | |
void | setMatrix (const Matrix &matrix) |
Set matrix without ignore nodes. | |
template<class Matrix , class Ignore > | |
void | setMatrix (const Matrix &matrix, const Ignore *ignore) |
Set matrix and ignore nodes. | |
virtual SolverCategory::Category | category () const |
Category of the solver (see SolverCategory::Category) | |
cholmod_common & | cholmodCommonObject () |
return a reference to the CHOLMOD common object for advanced option settings | |
cholmod_factor & | cholmodFactor () |
The CHOLMOD data structure that stores the factorization. | |
const cholmod_factor & | cholmodFactor () const |
The CHOLMOD data structure that stores the factorization. | |
Protected Types | |
enum | |
Protected Member Functions | |
void | printHeader (std::ostream &s) const |
helper function for printing header of solver output | |
void | printOutput (std::ostream &s, const CountType &iter, const DataType &norm, const DataType &norm_old) const |
helper function for printing solver output | |
void | printOutput (std::ostream &s, const CountType &iter, const DataType &norm) const |
helper function for printing solver output | |
Dune wrapper for SuiteSparse/CHOLMOD solver.
This class implements an InverseOperator between Vector types
Vector | Data type for solution and right-hand-side vectors |
Index | Type used by CHOLMOD for indices. Must be either 'int' or 'SuiteSparse_long' (which is usually long int ). |
|
inherited |
Type of the domain of the operator to be inverted.
|
inherited |
The field type of the operator.
|
inherited |
Type of the range of the operator to be inverted.
|
inherited |
The real type of the field type (is the same if using real numbers, but differs for std::complex)
|
inherited |
scalar type underlying the field_type
|
protectedinherited |
|
inline |
Default constructor.
Calls the the cholmod runtime, see CHOLMOD doc
|
inline |
Destructor.
Free space and calls cholmod_finish, see CHOLMOD doc
|
delete |
|
inlinevirtual |
simple forward to apply(X&, Y&, InverseOperatorResult&)
Implements Dune::InverseOperator< Vector, Vector >.
|
inlinevirtual |
solve the linear system Ax=b (possibly with respect to some ignore field)
The method assumes that setMatrix() was called before In the case of a given ignore field the corresponding entries of both in x and b will stay untouched in this method.
Implements Dune::InverseOperator< Vector, Vector >.
|
inlinevirtual |
Category of the solver (see SolverCategory::Category)
Implements Dune::InverseOperator< Vector, Vector >.
|
inline |
return a reference to the CHOLMOD common object for advanced option settings
The CHOLMOD common object stores all parameters and options for the solver to run and can be modified in several ways, see CHOLMOD Userguide for further information.
|
inline |
The CHOLMOD data structure that stores the factorization.
Access to this is necessary for the more advanced features of CHOLMOD. You need to know what you are doing!
|
inline |
The CHOLMOD data structure that stores the factorization.
Access to this is necessary for the more advanced features of CHOLMOD. You need to know what you are doing!
|
delete |
|
inlineprotectedinherited |
helper function for printing header of solver output
|
inlineprotectedinherited |
helper function for printing solver output
|
inlineprotectedinherited |
helper function for printing solver output
|
inline |
Set matrix without ignore nodes.
This method forwards a nullptr to the setMatrix method with ignore nodes
|
inline |
Set matrix and ignore nodes.
The input matrix is copied to CHOLMOD compatible form. It is possible to ignore some degrees of freedom, provided an ignore field is given with same block structure like the BlockVector template of the class.
The ignore field causes the method to ignore both rows and cols of the matrix and therefore operates only on the reduced quadratic matrix. In case of, e.g., Dirichlet values the user has to take care of proper adjusting of the rhs before calling apply().
Decomposing the matrix at the end takes a lot of time
[in] | matrix | Matrix to be decomposed. In BCRS compatible form |
[in] | ignore | Pointer to a compatible BitVector |