dune-istl  2.5-git
Public Types | Public Member Functions | Protected Types | Protected Member Functions | List of all members
Dune::SPQR< BCRSMatrix< FieldMatrix< T, n, m >, A > > Class Template Referenceabstract

The SPQR direct sparse solver for matrices of type BCRSMatrix. More...

#include <dune/istl/spqr.hh>

Inheritance diagram for Dune::SPQR< BCRSMatrix< FieldMatrix< T, n, m >, A > >:
Inheritance graph

Public Types

typedef Dune::BCRSMatrix< FieldMatrix< T, n, m >, A > Matrix
 The matrix type. More...
 
typedef Dune::BCRSMatrix< FieldMatrix< T, n, m >, A > matrix_type
 
typedef Dune::ColCompMatrix< MatrixSPQRMatrix
 The corresponding SuperLU Matrix type. More...
 
typedef ColCompMatrixInitializer< BCRSMatrix< FieldMatrix< T, n, m >, A > > MatrixInitializer
 Type of an associated initializer class. More...
 
typedef Dune::BlockVector< FieldVector< T, m >, typename A::template rebind< FieldVector< T, m > >::other > domain_type
 The type of the domain of the solver. More...
 
typedef Dune::BlockVector< FieldVector< T, n >, typename A::template rebind< FieldVector< T, n > >::other > range_type
 The type of the range of the solver. More...
 
typedef BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > ::field_type field_type
 The field type of the operator. More...
 

Public Member Functions

 SPQR (const Matrix &matrix, int verbose=0)
 Construct a solver object from a BCRSMatrix. More...
 
 SPQR (const Matrix &matrix, int verbose, bool)
 Constructor for compatibility with SuperLU standard constructor. More...
 
 SPQR ()
 Default constructor. More...
 
virtual ~SPQR ()
 Destructor. More...
 
virtual void apply (domain_type &x, range_type &b, InverseOperatorResult &res)
 Apply inverse operator,. More...
 
virtual void apply (domain_type &x, range_type &b, double reduction, InverseOperatorResult &res)
 apply inverse operator, with given convergence criteria. More...
 
void setOption (unsigned int option, double value)
 
void setMatrix (const Matrix &matrix)
 Initialize data from given matrix. More...
 
template<class S >
void setSubMatrix (const Matrix &matrix, const S &rowIndexSet)
 
void setVerbosity (int v)
 Sets the verbosity level for the solver. More...
 
SuiteSparseQR_factorization< T > * getFactorization ()
 Return the matrix factorization. More...
 
SPQRMatrixgetInternalMatrix ()
 Return the column coppressed matrix. More...
 
void free ()
 Free allocated space. More...
 
const char * name ()
 Get method name. More...
 
virtual void apply (BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > &x, BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > &b, InverseOperatorResult &res)=0
 Apply inverse operator,. More...
 
virtual void apply (BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > &x, BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > &b, double reduction, InverseOperatorResult &res)=0
 apply inverse operator, with given convergence criteria. More...
 

Protected Types

enum  
 

Protected Member Functions

void printHeader (std::ostream &s) const
 helper function for printing header of solver output More...
 
void printOutput (std::ostream &s, const CountType &iter, const DataType &norm, const DataType &norm_old) const
 helper function for printing solver output More...
 
void printOutput (std::ostream &s, const CountType &iter, const DataType &norm) const
 helper function for printing solver output More...
 

Detailed Description

template<typename T, typename A, int n, int m>
class Dune::SPQR< BCRSMatrix< FieldMatrix< T, n, m >, A > >

The SPQR direct sparse solver for matrices of type BCRSMatrix.

Specialization for the Dune::BCRSMatrix. SPQR will always go double precision and supports complex numbers too (use std::complex<double> for that).

Template Parameters
TNumber type. Only double and std::complex<double> is supported
ASTL-compatible allocator type
nNumber of rows in a matrix block
mNumber of columns in a matrix block
Note
This will only work if dune-istl has been configured to use SPQR

Member Typedef Documentation

§ field_type

typedef BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > ::field_type Dune::InverseOperator< BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > , BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > >::field_type
inherited

The field type of the operator.

Member Enumeration Documentation

§ anonymous enum

anonymous enum
protectedinherited

Member Function Documentation

§ apply() [1/2]

virtual void Dune::InverseOperator< BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > , BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > >::apply ( BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > &  x,
BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > &  b,
InverseOperatorResult res 
)
pure virtualinherited

Apply inverse operator,.

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

§ apply() [2/2]

virtual void Dune::InverseOperator< BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > , BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > >::apply ( BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > &  x,
BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > &  b,
double  reduction,
InverseOperatorResult res 
)
pure virtualinherited

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

§ printHeader()

void Dune::InverseOperator< BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > , BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > >::printHeader ( std::ostream &  s) const
inlineprotectedinherited

helper function for printing header of solver output

§ printOutput() [1/2]

void Dune::InverseOperator< BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > , BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > >::printOutput ( std::ostream &  s,
const CountType &  iter,
const DataType &  norm,
const DataType &  norm_old 
) const
inlineprotectedinherited

helper function for printing solver output

§ printOutput() [2/2]

void Dune::InverseOperator< BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other > , BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > >::printOutput ( std::ostream &  s,
const CountType &  iter,
const DataType &  norm 
) const
inlineprotectedinherited

helper function for printing solver output


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