dune-istl  2.3.1
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Friends | List of all members
Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > > Class Template Reference

SuperLu Solver. More...

#include <dune/istl/superlu.hh>

Inheritance diagram for Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >:
Dune::InverseOperator< BlockVector< FieldVector< T, m >, A::template rebind< FieldVector< T, m > >::other >, BlockVector< FieldVector< T, n >, A::template rebind< FieldVector< T, n > >::other > >

Public Types

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

Public Member Functions

 SuperLU (const Matrix &mat, bool verbose=false, bool reusevector=true)
 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 ()
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,.
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.

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 double iter, const DataType &norm, const DataType &norm_old) const
 helper function for printing solver output
void printOutput (std::ostream &s, const double iter, const DataType &norm) const
 helper function for printing solver output

Friends

class std::mem_fun_ref_t< void, SuperLU >
class SeqOverlappingSchwarz
struct SeqOverlappingSchwarzAssemblerHelper< SuperLU< Matrix >, true >

Detailed Description

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

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. Therfore 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

template<typename T , typename A , int n, int m>
typedef Dune::BlockVector< FieldVector<T,m>, typename A::template rebind<FieldVector<T,m> >::other> Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::domain_type

The type of the domain of the solver.

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.

template<typename T , typename A , int n, int m>
typedef Dune::BCRSMatrix<FieldMatrix<T,n,m>,A> Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::Matrix

The matrix type.

template<typename T , typename A , int n, int m>
typedef Dune::BCRSMatrix<FieldMatrix<T,n,m>,A> Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::matrix_type
template<typename T , typename A , int n, int m>
typedef SuperMatrixInitializer<BCRSMatrix<FieldMatrix<T,n,m>,A> > Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::MatrixInitializer

Type of an associated initializer class.

template<typename T , typename A , int n, int m>
typedef Dune::BlockVector< FieldVector<T,n>, typename A::template rebind<FieldVector<T,n> >::other> Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::range_type

The type of the range of the solver.

template<typename T , typename A , int n, int m>
typedef Dune::SuperLUMatrix<Matrix> Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::SuperLUMatrix

The corresponding SuperLU Matrix type.

Member Enumeration Documentation

anonymous enum
protectedinherited

Member Function Documentation

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.
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.
template<typename T , typename A , int n, int m>
void Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::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.

template<typename T , typename A , int n, int m>
const char* Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::name ( )
inline
template<typename T , typename A , int n, int m>
SuperLUMatrix::size_type Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::nnz ( ) const
inline

References mat.

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

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 double  iter,
const DataType &  norm,
const DataType &  norm_old 
) const
inlineprotectedinherited

helper function for printing solver output

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 double  iter,
const DataType &  norm 
) const
inlineprotectedinherited

helper function for printing solver output

Friends And Related Function Documentation

template<typename T , typename A , int n, int m>
friend class SeqOverlappingSchwarz
friend
template<typename T , typename A , int n, int m>
friend struct SeqOverlappingSchwarzAssemblerHelper< SuperLU< Matrix >, true >
friend
template<typename T , typename A , int n, int m>
friend class std::mem_fun_ref_t< void, SuperLU >
friend

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