libMesh
|
This class stores solver configuration data, e.g. More...
#include <solver_configuration.h>
Public Member Functions | |
SolverConfiguration ()=default | |
Constructor. More... | |
virtual | ~SolverConfiguration ()=default |
Destructor. More... | |
virtual void | set_options_during_init () |
Apply options during initialization of a solver. More... | |
virtual void | configure_solver ()=0 |
Apply solver options to a particular solver. More... | |
virtual void | respond_to_solve_failure (unsigned int) |
This method can be called after the solver has failed (e.g. More... | |
Static Public Member Functions | |
static std::string | get_info () |
Gets a string containing the reference information. More... | |
static void | print_info (std::ostream &out_stream=libMesh::out) |
Prints the reference information, by default to libMesh::out . More... | |
static unsigned int | n_objects () |
Prints the number of outstanding (created, but not yet destroyed) objects. More... | |
static void | enable_print_counter_info () |
Methods to enable/disable the reference counter output from print_info() More... | |
static void | disable_print_counter_info () |
Public Attributes | |
std::map< std::string, Real > | real_valued_data |
Store real-valued solver parameters in this map, e.g. More... | |
std::map< std::string, int > | int_valued_data |
Store integer solver parameters in this map, e.g. More... | |
std::map< std::string, std::string > | string_data |
Store string data in this map, e.g. More... | |
Protected Types | |
typedef std::map< std::string, std::pair< unsigned int, unsigned int > > | Counts |
Data structure to log the information. More... | |
Protected Member Functions | |
void | increment_constructor_count (const std::string &name) noexcept |
Increments the construction counter. More... | |
void | increment_destructor_count (const std::string &name) noexcept |
Increments the destruction counter. More... | |
Static Protected Attributes | |
static Counts | _counts |
Actually holds the data. More... | |
static Threads::atomic< unsigned int > | _n_objects |
The number of objects. More... | |
static Threads::spin_mutex | _mutex |
Mutual exclusion object to enable thread-safe reference counting. More... | |
static bool | _enable_print_counter = true |
Flag to control whether reference count information is printed when print_info is called. More... | |
This class stores solver configuration data, e.g.
tolerances and iteration limits. Override the pure virtual function configure_solver() in order to provide specific behavior for particular types of solvers (e.g. LinearSolver, EigenSolver, etc).
Definition at line 39 of file solver_configuration.h.
|
protectedinherited |
Data structure to log the information.
The log is identified by the class name.
Definition at line 119 of file reference_counter.h.
|
default |
Constructor.
|
virtualdefault |
Destructor.
|
pure virtual |
Apply solver options to a particular solver.
Override in subclasses to provide specific behavior.
Implemented in SlepcSolverConfiguration, and PetscSolverConfiguration.
|
staticinherited |
Definition at line 100 of file reference_counter.C.
References libMesh::ReferenceCounter::_enable_print_counter.
|
staticinherited |
Methods to enable/disable the reference counter output from print_info()
Definition at line 94 of file reference_counter.C.
References libMesh::ReferenceCounter::_enable_print_counter.
|
staticinherited |
Gets a string containing the reference information.
Definition at line 47 of file reference_counter.C.
References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().
Referenced by libMesh::ReferenceCounter::print_info().
|
inlineprotectednoexceptinherited |
Increments the construction counter.
Should be called in the constructor of any derived class that will be reference counted.
Definition at line 183 of file reference_counter.h.
References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.
Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().
|
inlineprotectednoexceptinherited |
Increments the destruction counter.
Should be called in the destructor of any derived class that will be reference counted.
Definition at line 207 of file reference_counter.h.
References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.
Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().
|
inlinestaticinherited |
Prints the number of outstanding (created, but not yet destroyed) objects.
Definition at line 85 of file reference_counter.h.
References libMesh::ReferenceCounter::_n_objects.
Referenced by libMesh::LibMeshInit::~LibMeshInit().
|
staticinherited |
Prints the reference information, by default to libMesh::out
.
Definition at line 81 of file reference_counter.C.
References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().
Referenced by libMesh::LibMeshInit::~LibMeshInit().
|
inlinevirtual |
This method can be called after the solver has failed (e.g.
on catching an exception thrown by a solver). It allows an appropriate response to the failure, e.g. terminate the program, or change configuration options and try again. solve_failure_count
specifies the number of times we've tried to recover from a failure.
Definition at line 74 of file solver_configuration.h.
|
inlinevirtual |
Apply options during initialization of a solver.
Default is a no-op. Override in subclasses to provide specific behavior.
Definition at line 58 of file solver_configuration.h.
|
staticprotectedinherited |
Actually holds the data.
Definition at line 124 of file reference_counter.h.
Referenced by libMesh::ReferenceCounter::get_info().
|
staticprotectedinherited |
Flag to control whether reference count information is printed when print_info is called.
Definition at line 143 of file reference_counter.h.
Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().
|
staticprotectedinherited |
Mutual exclusion object to enable thread-safe reference counting.
Definition at line 137 of file reference_counter.h.
|
staticprotectedinherited |
The number of objects.
Print the reference count information when the number returns to 0.
Definition at line 132 of file reference_counter.h.
Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().
std::map<std::string, int> libMesh::SolverConfiguration::int_valued_data |
Store integer solver parameters in this map, e.g.
iteration limits.
Definition at line 87 of file solver_configuration.h.
std::map<std::string, Real> libMesh::SolverConfiguration::real_valued_data |
Store real-valued solver parameters in this map, e.g.
solver tolerances.
Definition at line 82 of file solver_configuration.h.
std::map<std::string, std::string> libMesh::SolverConfiguration::string_data |
Store string data in this map, e.g.
"solver_type" : "gmres".
Definition at line 92 of file solver_configuration.h.