DUNE PDELab (git)

Dune::PDELab::ISTLBackend_BCGS_AMG_SSOR< GO, s > Class Template Reference

Overlapping parallel BiCGStab solver preconditioned with AMG smoothed by SSOR. More...

#include <dune/pdelab/backend/istl/ovlpistlsolverbackend.hh>

Public Types

typedef Dune::Amg::Parameters Parameters
 Parameters object to customize matrix hierachy building.
 

Public Member Functions

 ISTLBackend_BCGS_AMG_SSOR (const GFS &gfs_, unsigned maxiter_=5000, int verbose_=1, bool reuse_=false, bool usesuperlu_=true)
 Constructor. More...
 
void setParameters (const Parameters &params_)
 set AMG parameters More...
 
const Parametersparameters () const
 Get the parameters describing the behaviuour of AMG. More...
 
void setReuse (bool reuse_)
 Set whether the AMG should be reused again during call to apply().
 
bool getReuse () const
 Return whether the AMG is reused during call to apply()
 
V::ElementType norm (const V &v) const
 compute global norm of a vector More...
 
void apply (M &A, V &z, V &r, typename Dune::template FieldTraits< typename V::ElementType >::real_type reduction)
 solve the given linear system More...
 
const ISTLAMGStatisticsstatistics () const
 Get statistics of the AMG solver (no of levels, timings). More...
 
const Dune::PDELab::LinearSolverResult< double > & result () const
 Return access to result data.
 

Detailed Description

template<class GO, int s = 96>
class Dune::PDELab::ISTLBackend_BCGS_AMG_SSOR< GO, s >

Overlapping parallel BiCGStab solver preconditioned with AMG smoothed by SSOR.

Template Parameters
GOThe type of the grid operator (or the fakeGOTraits class for the old grid operator space).
sThe bits to use for the globale index.

Constructor & Destructor Documentation

◆ ISTLBackend_BCGS_AMG_SSOR()

template<class GO , int s = 96>
Dune::PDELab::ISTLBackend_BCGS_AMG_SSOR< GO, s >::ISTLBackend_BCGS_AMG_SSOR ( const GFS &  gfs_,
unsigned  maxiter_ = 5000,
int  verbose_ = 1,
bool  reuse_ = false,
bool  usesuperlu_ = true 
)
inline

Constructor.

Parameters
gfs_The grid function space used.
maxiter_The maximum number of iterations allowed.
verbose_The verbosity level to use.
reuse_Set true, if the Matrix to be used is always identical (AMG aggregation is then only performed once).
usesuperlu_Set false, to suppress the no SuperLU warning

Member Function Documentation

◆ apply()

template<class GO , int s, template< class, class, class, int > class Preconditioner, template< class > class Solver>
void Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver >::apply ( M &  A,
V &  z,
V &  r,
typename Dune::template FieldTraits< typename V::ElementType >::real_type  reduction 
)
inlineinherited

solve the given linear system

Parameters
[in]Athe given matrix
[out]zthe solution vector to be computed
[in]rright hand side
[in]reductionto be achieved

◆ norm()

template<class GO , int s, template< class, class, class, int > class Preconditioner, template< class > class Solver>
V::ElementType Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver >::norm ( const V &  v) const
inlineinherited

compute global norm of a vector

Parameters
[in]vthe given vector

◆ parameters()

template<class GO , int s, template< class, class, class, int > class Preconditioner, template< class > class Solver>
const Parameters & Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver >::parameters ( ) const
inlineinherited

Get the parameters describing the behaviuour of AMG.

The returned object can be adjusted to ones needs and then can be reset using setParameters.

Returns
The object holding the parameters of AMG.

◆ setParameters()

template<class GO , int s, template< class, class, class, int > class Preconditioner, template< class > class Solver>
void Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver >::setParameters ( const Parameters params_)
inlineinherited

set AMG parameters

Parameters
[in]params_a parameter object of Type Dune::Amg::Parameters

◆ statistics()

template<class GO , int s, template< class, class, class, int > class Preconditioner, template< class > class Solver>
const ISTLAMGStatistics & Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver >::statistics ( ) const
inlineinherited

Get statistics of the AMG solver (no of levels, timings).

Returns
statistis of the AMG solver.

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 23, 23:29, 2024)