Base class for NLEQ type steady state solvers. More...
#include <NLEQSolver.h>
Inheritance diagram for rr::NLEQSolver:
Public Member Functions | |
| NLEQSolver (ExecutableModel *model) | |
| Creates a new Instance of NLEQ for the given Model. | |
| void | syncWithModel (ExecutableModel *m) override |
| Called whenever a new model is loaded to allow integrator to reset internal state. | |
| void | loadConfigSettings () override |
| void | resetSettings () override |
| Reset all integrator settings to their respective default values. | |
| template<class NLEQSolverType > | |
| double | solveNLEQ () |
| main solver method. More... | |
 Public Member Functions inherited from rr::SteadyStateSolver | |
| virtual double | solve ()=0 |
| std::string | toString () const override |
| Return a std::string representation of the solver. More... | |
| std::string | toRepr () const override |
| Return std::string representation a la Python repr method. More... | |
| void | resetSettings () override |
| Implements settings shared by all steady state solvers. | |
| Solver ()=default | |
| Solver (ExecutableModel *model) | |
| Public Member Functions inherited from rr::Solver | |
| Solver (ExecutableModel *model) | |
| void | updateSettings (Dictionary *inputSettings) |
| Update settings values. More... | |
| std::vector< std::string > | getSettings () const |
| Get a list of all settings for this solver. More... | |
| std::unordered_map< std::string, Setting > & | getSettingsMap () |
| get settings for this solver More... | |
| virtual Setting | getValue (const std::string &key) const |
| Get the value of an integrator setting. More... | |
| virtual Setting | hasValue (const std::string &key) const |
| Return true if this setting is supported by the integrator. More... | |
| virtual size_t | getNumParams () const |
| Get the number of parameters. More... | |
| virtual std::string | getParamName (size_t n) const |
| Get the name of the parameter at index n. More... | |
| virtual std::string | getParamDisplayName (int n) const |
| Get the display name of the parameter at index n. More... | |
| virtual std::string | getParamHint (int n) const |
| Get the hint of the parameter at index n. More... | |
| virtual std::string | getParamDesc (int n) const |
| Get the description of the parameter at index n. More... | |
| virtual std::string | getValueAsString (const std::string &key) |
| Wrapper for getValue which converts output to a specific type. More... | |
| virtual void | setValue (const std::string &key, Setting value) |
| virtual std::string | getSettingsRepr () const |
| Get the solver settings as a std::string. More... | |
| virtual std::string | settingsPyDictRepr () const |
| Python dictionary-style std::string representation of settings. More... | |
| const std::string & | getDisplayName (const std::string &key) const |
| Gets the hint associated with a given key. More... | |
| const std::string & | getHint (const std::string &key) const |
| Gets the hint associated with a given key. More... | |
| const std::string & | getDescription (const std::string &key) const |
| Gets the description associated with a given key. More... | |
| Setting::TypeId | getType (const std::string &key) const |
| Gets the type associated with a given key. More... | |
| virtual ExecutableModel * | getModel () const |
| returns the pointer to the ExecutableModel | |
| virtual std::string | getName () const=0 |
| Gets the name associated with this Solver type. More... | |
| virtual std::string | getHint () const=0 |
| Gets the hint associated with this Solver type. More... | |
| virtual std::string | getDescription () const=0 |
| Gets the description associated with this Solver type. More... | |
| Public Member Functions inherited from rr::Registrable | |
| virtual std::string | getName () const =0 |
| Gets the name associated with this Solver type. More... | |
| virtual std::string | getDescription () const =0 |
| Gets the description associated with this Solver type. More... | |
| virtual std::string | getHint () const =0 |
| Gets the hint associated with this Solver type. More... | |
| virtual Solver * | construct (ExecutableModel *model) const =0 |
| Constructs a new Solver of a given type. More... | |
Additional Inherited Members | |
| Public Types inherited from rr::Solver | |
| using | SettingsList = std::vector< std::string > |
| using | SettingsMap = std::unordered_map< std::string, Setting > |
| using | DisplayNameMap = std::unordered_map< std::string, std::string > |
| using | HintMap = std::unordered_map< std::string, std::string > |
| using | DescriptionMap = std::unordered_map< std::string, std::string > |
| Public Attributes inherited from rr::Solver | |
| SettingsList | sorted_settings |
| SettingsMap | settings |
| DisplayNameMap | display_names_ |
| HintMap | hints |
| DescriptionMap | descriptions |
| Protected Member Functions inherited from rr::Solver | |
| void | addSetting (const std::string &name, const Setting &val, const std::string &display_name, const std::string &hint, const std::string &description) |
| Protected Attributes inherited from rr::Solver | |
| ExecutableModel * | mModel = nullptr |
| non-owning pointer to model | |
Detailed Description
Base class for NLEQ type steady state solvers.
Member Function Documentation
◆ solveNLEQ()
template<class NLEQSolverType >
|
inline |
main solver method.
NLEQ1 and NLEQ2 have the same interface, which means we only need 1 method for both.
- Parameters
-
which either "nleq1" or "nleq2"
The documentation for this class was generated from the following files:
- NLEQSolver.h
- NLEQSolver.cpp
