Reference documentation for deal.II version 8.4.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Attributes | List of all members
SolverSelector< VectorType > Class Template Reference

#include <deal.II/lac/solver_selector.h>

Inheritance diagram for SolverSelector< VectorType >:
[legend]

Public Types

typedef VectorType vector_type
 

Public Member Functions

 SolverSelector ()
 
 ~SolverSelector ()
 
template<class Matrix , class Preconditioner >
void solve (const Matrix &A, VectorType &x, const VectorType &b, const Preconditioner &precond) const
 
void select (const std::string &name)
 
void set_control (SolverControl &ctrl)
 
void set_data (const typename SolverRichardson< VectorType >::AdditionalData &data)
 
void set_data (const typename SolverCG< VectorType >::AdditionalData &data)
 
void set_data (const typename SolverMinRes< VectorType >::AdditionalData &data)
 
void set_data (const typename SolverBicgstab< VectorType >::AdditionalData &data)
 
void set_data (const typename SolverGMRES< VectorType >::AdditionalData &data)
 
void set_data (const typename SolverFGMRES< VectorType >::AdditionalData &data)
 
 DeclException1 (ExcSolverDoesNotExist, std::string,<< "Solver "<< arg1<< " does not exist. Use one of "<< std::endl<< get_solver_names())
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects."<< "\n\n"<< "(Additional information: "<< arg3<< ")\n\n"<< "See the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "a lot more information on what this error means and "<< "how to fix programs in which it happens.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier <"<< arg2<< "> subscribes to this object of class "<< arg1<< ". Consequently, it cannot be unsubscribed.")
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Static Public Member Functions

static std::string get_solver_names ()
 

Protected Attributes

SmartPointer< SolverControl, SolverSelector< VectorType > > control
 
std::string solver_name
 

Private Attributes

SolverRichardson< VectorType >::AdditionalData richardson_data
 
SolverCG< VectorType >::AdditionalData cg_data
 
SolverMinRes< VectorType >::AdditionalData minres_data
 
SolverBicgstab< VectorType >::AdditionalData bicgstab_data
 
SolverGMRES< VectorType >::AdditionalData gmres_data
 
SolverFGMRES< VectorType >::AdditionalData fgmres_data
 

Detailed Description

template<typename VectorType = Vector<double>>
class SolverSelector< VectorType >

Selects a solver by changing a parameter.

By calling the solve function of this SolverSelector, it selects the solve function of that Solver that was specified in the constructor of this class.

Usage

The simplest use of this class is the following:

// generate a @p SolverControl and
// a @p VectorMemory
// Line 3:
//
// generate a @p SolverSelector that
// calls the @p SolverCG
solver_selector("cg", control, memory);
// generate e.g. a @p PreconditionRelaxation
preconditioning(A, &SparseMatrix<double>
::template precondition_SSOR<double>,0.8);
// call the @p solve function with this
// preconditioning as last argument
solver_selector.solve(A,x,b,preconditioning);

But the full usefulness of the SolverSelector class is not clear until the presentation of the following example that assumes the user using the ParameterHandler class and having declared a "solver" entry, e.g. with

Parameter_Handler prm;
prm.declare_entry ("solver", "none",
...

Assuming that in the users parameter file there exists the line

* set solver = cg
* 

then `Line 3' of the above example reads

solver_selector(prm.get("solver"), control, memory);

If at some time there exists a new solver "xyz" then the user does not need to change his program. Only in the implementation of the SolverSelector the calling of this solver has to be added and each user with program lines quoted above only needs to 'set solver = xyz' in his parameter file to get access to that new solver. :-)

(By the way, thanks to Wolfgang for implementing the ParameterHandler.)

Author
Ralf Hartmann, 1999

Definition at line 98 of file solver_selector.h.

Member Typedef Documentation

template<typename VectorType = Vector<double>>
typedef VectorType SolverSelector< VectorType >::vector_type

A typedef for the underlying vector type

Definition at line 104 of file solver_selector.h.

Constructor & Destructor Documentation

template<typename VectorType >
SolverSelector< VectorType >::SolverSelector ( )

Constructor, filling in default values

Definition at line 237 of file solver_selector.h.

template<typename VectorType >
SolverSelector< VectorType >::~SolverSelector ( )

Destructor

Definition at line 242 of file solver_selector.h.

Member Function Documentation

template<typename VectorType >
template<class Matrix , class Preconditioner >
void SolverSelector< VectorType >::solve ( const Matrix &  A,
VectorType &  x,
const VectorType &  b,
const Preconditioner &  precond 
) const

Solver procedure. Calls the solve function of the solver whose SolverName was specified in the constructor.

Definition at line 257 of file solver_selector.h.

template<typename VectorType >
void SolverSelector< VectorType >::select ( const std::string &  name)

Select a new solver. Note that all solver names used in this class are all lower case.

Definition at line 248 of file solver_selector.h.

template<typename VectorType >
void SolverSelector< VectorType >::set_control ( SolverControl ctrl)

Set a new SolverControl. This needs to be set before solving.

Definition at line 298 of file solver_selector.h.

template<typename VectorType >
void SolverSelector< VectorType >::set_data ( const typename SolverRichardson< VectorType >::AdditionalData &  data)

Set the additional data. For more info see the Solver class.

Definition at line 329 of file solver_selector.h.

template<typename VectorType >
void SolverSelector< VectorType >::set_data ( const typename SolverCG< VectorType >::AdditionalData &  data)

Set the additional data. For more info see the Solver class.

Definition at line 336 of file solver_selector.h.

template<typename VectorType >
void SolverSelector< VectorType >::set_data ( const typename SolverMinRes< VectorType >::AdditionalData &  data)

Set the additional data. For more info see the Solver class.

Definition at line 345 of file solver_selector.h.

template<typename VectorType >
void SolverSelector< VectorType >::set_data ( const typename SolverBicgstab< VectorType >::AdditionalData &  data)

Set the additional data. For more info see the Solver class.

Definition at line 353 of file solver_selector.h.

template<typename VectorType >
void SolverSelector< VectorType >::set_data ( const typename SolverGMRES< VectorType >::AdditionalData &  data)

Set the additional data. For more info see the Solver class.

Definition at line 313 of file solver_selector.h.

template<typename VectorType >
void SolverSelector< VectorType >::set_data ( const typename SolverFGMRES< VectorType >::AdditionalData &  data)

Set the additional data. For more info see the Solver class.

Definition at line 321 of file solver_selector.h.

template<typename VectorType >
std::string SolverSelector< VectorType >::get_solver_names ( )
static

Get the names of all implemented solvers.

Definition at line 305 of file solver_selector.h.

template<typename VectorType = Vector<double>>
SolverSelector< VectorType >::DeclException1 ( ExcSolverDoesNotExist  ,
std::string  ,
<< "Solver "<< arg1<< " does not exist. Use one of "<< std::endl<<   get_solver_names() 
)

Exception.

Member Data Documentation

template<typename VectorType = Vector<double>>
SmartPointer< SolverControl, SolverSelector< VectorType > > SolverSelector< VectorType >::control
protected

Stores the SolverControl that is needed in the constructor of each Solver class. This can be changed with set_control().

Definition at line 193 of file solver_selector.h.

template<typename VectorType = Vector<double>>
std::string SolverSelector< VectorType >::solver_name
protected

Stores the name of the solver.

Definition at line 198 of file solver_selector.h.

template<typename VectorType = Vector<double>>
SolverRichardson<VectorType>::AdditionalData SolverSelector< VectorType >::richardson_data
private

Stores the additional data.

Definition at line 204 of file solver_selector.h.

template<typename VectorType = Vector<double>>
SolverCG<VectorType>::AdditionalData SolverSelector< VectorType >::cg_data
private

Stores the additional data.

Definition at line 209 of file solver_selector.h.

template<typename VectorType = Vector<double>>
SolverMinRes<VectorType>::AdditionalData SolverSelector< VectorType >::minres_data
private

Stores the additional data.

Definition at line 214 of file solver_selector.h.

template<typename VectorType = Vector<double>>
SolverBicgstab<VectorType>::AdditionalData SolverSelector< VectorType >::bicgstab_data
private

Stores the additional data.

Definition at line 219 of file solver_selector.h.

template<typename VectorType = Vector<double>>
SolverGMRES<VectorType>::AdditionalData SolverSelector< VectorType >::gmres_data
private

Stores the additional data.

Definition at line 224 of file solver_selector.h.

template<typename VectorType = Vector<double>>
SolverFGMRES<VectorType>::AdditionalData SolverSelector< VectorType >::fgmres_data
private

Stores the additional data.

Definition at line 229 of file solver_selector.h.


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