roadrunner  2.6.0
Fast simulator for SBML models
Public Member Functions | List of all members
rr::SteadyStateSensitivitySolver Class Referenceabstract

genetic interface for sensitivity solvers that solve for steady state before computing model sensitivities More...

#include <SensitivitySolver.h>

Inheritance diagram for rr::SteadyStateSensitivitySolver:
rr::SensitivitySolver rr::Solver rr::Registrable

Public Member Functions

virtual double solveSteadyState ()=0
 solves the model for steady state. More...
 
virtual rr::Matrix< double > solveSensitivities (std::vector< std::string > params=std::vector< std::string >(), int k=0)=0
 compute sensitivities at steady state More...
 
- Public Member Functions inherited from rr::SensitivitySolver
virtual rr::Matrix< double > getSensitivityMatrix (int k=0)=0
 get current values of sensitivities of model variables to parameters. More...
 
 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 void resetSettings ()
 Reset all settings to their respective default values.
 
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...
 
virtual std::string toString () const
 Return a std::string representation of the solver. More...
 
virtual std::string toRepr () const
 Return std::string representation a la Python repr method. 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 void syncWithModel (ExecutableModel *m)=0
 Called whenever a new model is loaded to allow integrator to reset internal state. More...
 
virtual ExecutableModelgetModel () 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 Solverconstruct (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
ExecutableModelmModel = nullptr
 non-owning pointer to model
 

Detailed Description

genetic interface for sensitivity solvers that solve for steady state before computing model sensitivities

Member Function Documentation

◆ solveSensitivities()

virtual rr::Matrix<double> rr::SteadyStateSensitivitySolver::solveSensitivities ( std::vector< std::string >  params = std::vector< std::string >(),
int  k = 0 
)
pure virtual

compute sensitivities at steady state

Parameters
paramswhich parameters do you want sensitivities for? Each string must be a valid model parameter. If left empty (default) then all model parameters are selected.
kreturned double matrix will contain the kth order derivative of the sensitivities, where 0 (default) is just the sensitivity values
Returns
the k'th order derivitive of the Sensitivities for this model at steady state. Rows (number of model variables), columns (Np, number of parameters user has requested sensitivites for).

◆ solveSteadyState()

virtual double rr::SteadyStateSensitivitySolver::solveSteadyState ( )
pure virtual

solves the model for steady state.

this method is called prior to computing sensitivities to get sensitivities at steady state.


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