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

Inheritance diagram for SolverSelector< VectorType >:

Public Types
using	vector_type = VectorType

Public Member Functions
	SolverSelector ()=default

	SolverSelector (const std::string &name, SolverControl &control)

virtual	~SolverSelector () override=default

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)

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int	n_subscriptions () const

template<typename StreamType >
void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

Static Public Member Functions
static std::string	get_solver_names ()

static ::ExceptionBase &	ExcSolverDoesNotExist (std::string arg1)

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Attributes
SmartPointer< SolverControl, SolverSelector< VectorType > >	control

std::string	solver_name

Private Types
using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
void	check_no_subscribers () const noexcept

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

std::atomic< unsigned int >	counter

std::map< std::string, unsigned int >	counter_map

std::vector< std::atomic< bool > * >	validity_pointers

const std::type_info *	object_info

Static Private Attributes
static std::mutex	mutex

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 SolverSelector that calls the @p SolverCG
SolverControl control;
SolverSelector<Vector<double> > solver_selector ("cg", control);
 
// generate e.g. a @p PreconditionRelaxation
PreconditionRelaxation<SparseMatrix<double>, Vector<double> >
  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",
                   Patterns::Selection(
                     SolverSelector<>::get_solver_names()));
...

Assuming that in the users parameter file there exists the line

set solver = cg

then the constructor call in the above example can be written as

SolverSelector<SparseMatrix<double>, Vector<double> >

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

If at some time there exists a new solver "xyz" then the user does not need to change their 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 their parameter file to get access to that new solver.

Definition at line 91 of file solver_selector.h.

Member Typedef Documentation

◆ vector_type

template<typename VectorType = Vector<double>>

using SolverSelector< VectorType >::vector_type = VectorType

An alias for the underlying vector type

Definition at line 97 of file solver_selector.h.

◆ map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 230 of file subscriptor.h.

◆ map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 235 of file subscriptor.h.

Constructor & Destructor Documentation

◆ SolverSelector() [1/2]

template<typename VectorType = Vector<double>>

SolverSelector< VectorType >::SolverSelector ( )

default

Constructor, filling in default values

◆ SolverSelector() [2/2]

template<typename VectorType >

SolverSelector< VectorType >::SolverSelector	(	const std::string &	name,
		SolverControl &	control
	)

Constructor, selecting the solver name and the SolverControl object control already.

Definition at line 250 of file solver_selector.h.

◆ ~SolverSelector()

template<typename VectorType = Vector<double>>

virtual SolverSelector< VectorType >::~SolverSelector ( )

overridevirtualdefault

Destructor

Member Function Documentation

◆ solve()

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 270 of file solver_selector.h.

◆ select()

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 260 of file solver_selector.h.

◆ set_control()

template<typename VectorType >

void SolverSelector< VectorType >::set_control ( SolverControl & ctrl )

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

Definition at line 313 of file solver_selector.h.

◆ set_data() [1/6]

template<typename VectorType >

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

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

Definition at line 351 of file solver_selector.h.

◆ set_data() [2/6]

template<typename VectorType >

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

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

Definition at line 361 of file solver_selector.h.

◆ set_data() [3/6]

template<typename VectorType >

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

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

Definition at line 371 of file solver_selector.h.

◆ set_data() [4/6]

template<typename VectorType >

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

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

Definition at line 381 of file solver_selector.h.

◆ set_data() [5/6]

template<typename VectorType >

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

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

Definition at line 331 of file solver_selector.h.

◆ set_data() [6/6]

template<typename VectorType >

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

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

Definition at line 341 of file solver_selector.h.

◆ get_solver_names()

template<typename VectorType >

std::string SolverSelector< VectorType >::get_solver_names

static

Get the names of all implemented solvers. The list of possible options includes:

"richardson"
"cg"
"bicgstab"
"gmres"
"fgmres"
"minres"

Definition at line 322 of file solver_selector.h.

◆ subscribe()

void Subscriptor::subscribe	(	std::atomic< bool > *const	validity,
		const std::string &	identifier = `""`
	)		const

inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe	(	std::atomic< bool > *const	validity,
		const std::string &	identifier = `""`
	)		const

inherited

Unsubscribes a user from the object.

Note: The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const

inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void Subscriptor::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

template<class Archive >

void Subscriptor::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 309 of file subscriptor.h.

◆ check_no_subscribers()

void Subscriptor::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note: Since this function is just a consistency check it does nothing in release mode.; If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file subscriptor.cc.

Member Data Documentation

◆ control

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 206 of file solver_selector.h.

◆ solver_name

template<typename VectorType = Vector<double>>

std::string SolverSelector< VectorType >::solver_name

protected

Stores the name of the solver.

Definition at line 211 of file solver_selector.h.

◆ richardson_data

template<typename VectorType = Vector<double>>

SolverRichardson<VectorType>::AdditionalData SolverSelector< VectorType >::richardson_data

private

Stores the additional data.

Definition at line 217 of file solver_selector.h.

◆ cg_data

template<typename VectorType = Vector<double>>

SolverCG<VectorType>::AdditionalData SolverSelector< VectorType >::cg_data

private

Stores the additional data.

Definition at line 222 of file solver_selector.h.

◆ minres_data

template<typename VectorType = Vector<double>>

SolverMinRes<VectorType>::AdditionalData SolverSelector< VectorType >::minres_data

private

Stores the additional data.

Definition at line 227 of file solver_selector.h.

◆ bicgstab_data

template<typename VectorType = Vector<double>>

SolverBicgstab<VectorType>::AdditionalData SolverSelector< VectorType >::bicgstab_data

private

Stores the additional data.

Definition at line 232 of file solver_selector.h.

◆ gmres_data

template<typename VectorType = Vector<double>>

SolverGMRES<VectorType>::AdditionalData SolverSelector< VectorType >::gmres_data

private

Stores the additional data.

Definition at line 237 of file solver_selector.h.

◆ fgmres_data

template<typename VectorType = Vector<double>>

SolverFGMRES<VectorType>::AdditionalData SolverSelector< VectorType >::fgmres_data

private

Stores the additional data.

Definition at line 242 of file solver_selector.h.

◆ counter

std::atomic<unsigned int> Subscriptor::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 219 of file subscriptor.h.

◆ counter_map

std::map<std::string, unsigned int> Subscriptor::counter_map

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 225 of file subscriptor.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> Subscriptor::validity_pointers

mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 241 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 249 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::mutex

staticprivateinherited

A mutex used to ensure data consistency when printing out the list of subscribers.

Definition at line 271 of file subscriptor.h.

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

include/deal.II/lac/solver_selector.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Usage

Member Typedef Documentation

◆ vector_type

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ SolverSelector() [1/2]

◆ SolverSelector() [2/2]

◆ ~SolverSelector()

Member Function Documentation

◆ solve()

◆ select()

◆ set_control()

◆ set_data() [1/6]

◆ set_data() [2/6]

◆ set_data() [3/6]

◆ set_data() [4/6]

◆ set_data() [5/6]

◆ set_data() [6/6]

◆ get_solver_names()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ control

◆ solver_name

◆ richardson_data

◆ cg_data

◆ minres_data

◆ bicgstab_data

◆ gmres_data

◆ fgmres_data

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex