dune-istl 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Dune::SuperLU< M > Class Template Reference

SuperLu Solver. More...

#include <dune/istl/superlu.hh>

Inheritance diagram for Dune::SuperLU< M >:
Inheritance graph

Public Types

using Matrix = M
 The matrix type.
 
using matrix_type = M
 
typedef Dune::SuperLUMatrix< MatrixSuperLUMatrix
 The corresponding SuperLU Matrix type.
 
typedef SuperMatrixInitializer< MatrixMatrixInitializer
 Type of an associated initializer class.
 
using domain_type = typename Impl::SuperLUVectorChooser< M >::domain_type
 The type of the domain of the solver.
 
using range_type = typename Impl::SuperLUVectorChooser< M >::range_type
 The type of the range of the solver.
 

Public Member Functions

virtual SolverCategory::Category category () const
 Category of the solver (see SolverCategory::Category)
 
 SuperLU (const Matrix &mat, bool verbose=false, bool reusevector=true)
 Constructs the SuperLU solver.
 
 SuperLU (const Matrix &mat, const ParameterTree &config)
 Constructs the SuperLU solver.
 
 SuperLU ()
 Empty default constructor.
 
 ~SuperLU ()
 
void apply (domain_type &x, range_type &b, InverseOperatorResult &res)
 Apply inverse operator,.
 
void apply (domain_type &x, range_type &b, double reduction, InverseOperatorResult &res)
 apply inverse operator, with given convergence criteria.
 
void apply (T *x, T *b)
 Apply SuperLu to C arrays.
 
void setMatrix (const Matrix &mat)
 Initialize data from given matrix.
 
SuperLUMatrix::size_type nnz () const
 
template<class S >
void setSubMatrix (const Matrix &mat, const S &rowIndexSet)
 
void setVerbosity (bool v)
 
void free ()
 free allocated space.
 
const char * name ()
 

Detailed Description

template<typename M>
class Dune::SuperLU< M >

SuperLu Solver.

Uses the well known SuperLU package to solve the system.

SuperLU supports single and double precision floating point and complex numbers. Unfortunately these cannot be used at the same time. Therefore users must set SUPERLU_NTYPE (0: float, 1: double, 2: std::complex<float>, 3: std::complex<double>) if the numeric type should be different from double.

Member Typedef Documentation

◆ domain_type

template<typename M >
using Dune::SuperLU< M >::domain_type = typename Impl::SuperLUVectorChooser<M>::domain_type

The type of the domain of the solver.

◆ Matrix

template<typename M >
using Dune::SuperLU< M >::Matrix = M

The matrix type.

◆ matrix_type

template<typename M >
using Dune::SuperLU< M >::matrix_type = M

◆ MatrixInitializer

template<typename M >
typedef SuperMatrixInitializer<Matrix> Dune::SuperLU< M >::MatrixInitializer

Type of an associated initializer class.

◆ range_type

template<typename M >
using Dune::SuperLU< M >::range_type = typename Impl::SuperLUVectorChooser<M>::range_type

The type of the range of the solver.

◆ SuperLUMatrix

template<typename M >
typedef Dune::SuperLUMatrix<Matrix> Dune::SuperLU< M >::SuperLUMatrix

The corresponding SuperLU Matrix type.

Constructor & Destructor Documentation

◆ SuperLU()

template<typename M >
Dune::SuperLU< M >::SuperLU ( const Matrix mat,
const ParameterTree &  config 
)
inline

Constructs the SuperLU solver.

Parameters
matrixThe matrix of the system to solve.
configParameterTree containing solver parameters.
ParameterTree Key Meaning
verbose The verbosity level. default=false
reuseVector Reuse initially allocated vectors in apply. default=true

Member Function Documentation

◆ apply()

template<typename M >
void Dune::SuperLU< M >::apply ( domain_type x,
range_type b,
double  reduction,
InverseOperatorResult res 
)
inline

apply inverse operator, with given convergence criteria.

Warning
Right hand side b may be overwritten!
Parameters
xThe left hand side to store the result in.
bThe right hand side
reductionThe minimum defect reduction to achieve.
resObject to store the statistics about applying the operator.
Exceptions
SolverAbortWhen the solver detects a problem and cannot continue

◆ category()

template<typename M >
virtual SolverCategory::Category Dune::SuperLU< M >::category ( ) const
inlinevirtual

◆ name()

template<typename M >
const char * Dune::SuperLU< M >::name ( )
inline

◆ nnz()

template<typename M >
SuperLUMatrix::size_type Dune::SuperLU< M >::nnz ( ) const
inline

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