![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/lac/solver_selector.h>
Public Types | |
using | vector_type = VectorType |
Public Member Functions | |
SolverSelector ()=default | |
SolverSelector (const std::string &name, SolverControl &control) | |
virtual | ~SolverSelector () override=default |
template<typename MatrixType , typename PreconditionerType > | |
void | solve (const MatrixType &A, VectorType &x, const VectorType &b, const PreconditionerType &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 |
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.
The simplest use of this class is the following:
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
Assuming that in the users parameter file there exists the line
then the constructor call in the above example can be written as
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 92 of file solver_selector.h.
using SolverSelector< VectorType >::vector_type = VectorType |
An alias for the underlying vector type
Definition at line 98 of file solver_selector.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
|
default |
Constructor, filling in default values
SolverSelector< VectorType >::SolverSelector | ( | const std::string & | name, |
SolverControl & | control ) |
Constructor, selecting the solver name
and the SolverControl object control
already.
Definition at line 254 of file solver_selector.h.
|
overridevirtualdefault |
Destructor
void SolverSelector< VectorType >::solve | ( | const MatrixType & | A, |
VectorType & | x, | ||
const VectorType & | b, | ||
const PreconditionerType & | precond ) const |
Solver procedure. Calls the solve
function of the solver
whose SolverName
was specified in the constructor.
Definition at line 277 of file solver_selector.h.
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 264 of file solver_selector.h.
void SolverSelector< VectorType >::set_control | ( | SolverControl & | ctrl | ) |
Set a new SolverControl. This needs to be set before solving.
Definition at line 320 of file solver_selector.h.
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 358 of file solver_selector.h.
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 368 of file solver_selector.h.
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 378 of file solver_selector.h.
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 388 of file solver_selector.h.
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 338 of file solver_selector.h.
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 348 of file solver_selector.h.
|
static |
Get the names of all implemented solvers. The list of possible options includes:
Definition at line 329 of file solver_selector.h.
|
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 135 of file subscriptor.cc.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.
|
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.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 203 of file subscriptor.cc.
|
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.
|
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.
Definition at line 52 of file subscriptor.cc.
|
protected |
Stores the SolverControl
that is needed in the constructor of each Solver
class. This can be changed with set_control()
.
Definition at line 209 of file solver_selector.h.
|
protected |
Stores the name of the solver.
Definition at line 214 of file solver_selector.h.
|
private |
Stores the additional data.
Definition at line 220 of file solver_selector.h.
|
private |
Stores the additional data.
Definition at line 225 of file solver_selector.h.
|
private |
Stores the additional data.
Definition at line 230 of file solver_selector.h.
|
private |
Stores the additional data.
Definition at line 235 of file solver_selector.h.
|
private |
Stores the additional data.
Definition at line 240 of file solver_selector.h.
|
private |
Stores the additional data.
Definition at line 245 of file solver_selector.h.
|
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 218 of file subscriptor.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 240 of file subscriptor.h.
|
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 248 of file subscriptor.h.
|
staticprivateinherited |
A mutex used to ensure data consistency when accessing the mutable
members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers()
.
Definition at line 271 of file subscriptor.h.