dune-istl  2.7.0
Public Types | Public Member Functions | List of all members
Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA > Class Template Reference

Sequential overlapping Schwarz preconditioner. More...

#include <dune/istl/colcompmatrix.hh>

Inheritance diagram for Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >:
Inheritance graph

Public Types

typedef M matrix_type
 The type of the matrix to precondition. More...
 
typedef X domain_type
 The domain type of the preconditioner. More...
 
typedef X range_type
 The range type of the preconditioner. More...
 
typedef TM Mode
 The mode (additive or multiplicative) of the Schwarz method. More...
 
typedef X::field_type field_type
 The field type of the preconditioner. More...
 
typedef matrix_type::size_type size_type
 The return type of the size method. More...
 
typedef TA allocator
 The allocator to use. More...
 
typedef std::set< size_type, std::less< size_type >, typename TA::template rebind< size_type >::other > subdomain_type
 The type for the subdomain to row index mapping. More...
 
typedef std::vector< subdomain_type, typename TA::template rebind< subdomain_type >::other > subdomain_vector
 The vector type containing the subdomain to row index mapping. More...
 
typedef SLList< size_type, typename TA::template rebind< size_type >::other > subdomain_list
 The type for the row to subdomain mapping. More...
 
typedef std::vector< subdomain_list, typename TA::template rebind< subdomain_list >::other > rowtodomain_vector
 The vector type containing the row index to subdomain mapping. More...
 
typedef TD slu
 The type for the subdomain solver in use. More...
 
typedef std::vector< slu, typename TA::template rebind< slu >::other > slu_vector
 The vector type containing subdomain solvers. More...
 

Public Member Functions

 SeqOverlappingSchwarz (const matrix_type &mat, const subdomain_vector &subDomains, field_type relaxationFactor=1, bool onTheFly_=true)
 Construct the overlapping Schwarz method. More...
 
 SeqOverlappingSchwarz (const matrix_type &mat, const rowtodomain_vector &rowToDomain, field_type relaxationFactor=1, bool onTheFly_=true)
 
virtual void pre (X &x, X &b)
 Prepare the preconditioner. More...
 
virtual void apply (X &v, const X &d)
 Apply the precondtioner. More...
 
virtual void post (X &x)
 Postprocess the preconditioner. More...
 
template<bool forward>
void apply (X &v, const X &d)
 
virtual SolverCategory::Category category () const
 Category of the preconditioner (see SolverCategory::Category) More...
 

Detailed Description

template<class M, class X, class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
class Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >

Sequential overlapping Schwarz preconditioner.

Template Parameters
MThe matrix type.
XThe range and domain type.
TMThe Schwarz mode. Currently supported modes are AdditiveSchwarzMode, MultiplicativeSchwarzMode, and SymmetricMultiplicativeSchwarzMode. (Default values is AdditiveSchwarzMode)
TDThe type of the local subdomain solver to be used.
TAThe type of the allocator to use.

Member Typedef Documentation

◆ allocator

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef TA Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::allocator

The allocator to use.

◆ domain_type

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef X Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::domain_type

The domain type of the preconditioner.

◆ field_type

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef X::field_type Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::field_type

The field type of the preconditioner.

◆ matrix_type

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef M Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::matrix_type

The type of the matrix to precondition.

◆ Mode

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef TM Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::Mode

The mode (additive or multiplicative) of the Schwarz method.

Either AdditiveSchwarzMode or MultiplicativeSchwarzMode

◆ range_type

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef X Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::range_type

The range type of the preconditioner.

◆ rowtodomain_vector

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef std::vector<subdomain_list, typename TA::template rebind<subdomain_list>::other > Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::rowtodomain_vector

The vector type containing the row index to subdomain mapping.

◆ size_type

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef matrix_type::size_type Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::size_type

The return type of the size method.

◆ slu

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef TD Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::slu

The type for the subdomain solver in use.

◆ slu_vector

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef std::vector<slu, typename TA::template rebind<slu>::other> Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::slu_vector

The vector type containing subdomain solvers.

◆ subdomain_list

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef SLList<size_type, typename TA::template rebind<size_type>::other> Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::subdomain_list

The type for the row to subdomain mapping.

◆ subdomain_type

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef std::set<size_type, std::less<size_type>, typename TA::template rebind<size_type>::other> Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::subdomain_type

The type for the subdomain to row index mapping.

◆ subdomain_vector

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
typedef std::vector<subdomain_type, typename TA::template rebind<subdomain_type>::other> Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::subdomain_vector

The vector type containing the subdomain to row index mapping.

Member Function Documentation

◆ apply()

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
template<bool forward>
void Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::apply ( X &  v,
const X &  d 
)

◆ category()

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
virtual SolverCategory::Category Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::category ( ) const
inlinevirtual

Category of the preconditioner (see SolverCategory::Category)

◆ post()

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
virtual void Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::post ( X &  x)
inlinevirtual

Postprocess the preconditioner.

Clean up. This method is called after the last apply call for the linear system to be solved. Memory may be deallocated safely here. x is the solution of the linear equation.

Parameters
xThe right hand side of the equation.

◆ pre()

template<class M , class X , class TM = AdditiveSchwarzMode, class TD = ILU0SubdomainSolver<M,X,X>, class TA = std::allocator<X>>
virtual void Dune::SeqOverlappingSchwarz< M, X, TM, TD, TA >::pre ( X &  x,
X &  b 
)
inlinevirtual

Prepare the preconditioner.

Prepare the preconditioner. A solver solves a linear operator equation A(x)=b by applying one or several steps of the preconditioner. The method pre() is called before the first apply operation. b and x are right hand side and solution vector of the linear system respectively. It may. e.g., scale the system, allocate memory or compute a (I)LU decomposition. Note: The ILU decomposition could also be computed in the constructor or with a separate method of the derived method if several linear systems with the same matrix are to be solved.

Note
if a preconditioner is copied (e.g. for a second thread) again the pre() method has to be called to ensure proper memory mangement.
X x(0.0);
Y b = ...; // rhs
Preconditioner<X,Y> prec(...);
prec.pre(x,b); // prepare the preconditioner
prec.apply(x,b); // can be called multiple times now...
prec.post(x); // cleanup internal state
Parameters
xThe left hand side of the equation.
bThe right hand side of the equation.

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