dune-pdelab 2.7-git
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver > Class Template Reference

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

Inheritance diagram for Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver >:
Inheritance graph

Public Types

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

Public Member Functions

 ISTLBackend_AMG (const GFS &gfs_, unsigned maxiter_=5000, int verbose_=1, bool reuse_=false, bool usesuperlu_=true)
 
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(). More...
 
bool getReuse () const
 Return whether the AMG is reused during call to apply() More...
 
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. More...
 

Protected Attributes

Dune::PDELab::LinearSolverResult< double > res
 

Member Typedef Documentation

◆ Parameters

template<class GO , int s, template< class, class, class, int > class Preconditioner, template< class > class Solver>
typedef Dune::Amg::Parameters Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver >::Parameters

Parameters object to customize matrix hierachy building.

Constructor & Destructor Documentation

◆ ISTLBackend_AMG()

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

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 
)
inline

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

◆ getReuse()

template<class GO , int s, template< class, class, class, int > class Preconditioner, template< class > class Solver>
bool Dune::PDELab::ISTLBackend_AMG< GO, s, Preconditioner, Solver >::getReuse ( ) const
inline

Return whether the AMG is reused during call to apply()

◆ 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
inline

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
inline

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.

◆ result()

const Dune::PDELab::LinearSolverResult< double > & Dune::PDELab::LinearResultStorage::result ( ) const
inlineinherited

Return access to result data.

◆ 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_)
inline

set AMG parameters

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

◆ setReuse()

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 >::setReuse ( bool  reuse_)
inline

Set whether the AMG should be reused again during call to apply().

◆ 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
inline

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

Returns
statistis of the AMG solver.

Member Data Documentation

◆ res

Dune::PDELab::LinearSolverResult<double> Dune::PDELab::LinearResultStorage::res
protectedinherited

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