C API Documentation
Public Member Functions | Static Public Member Functions | Friends | List of all members
rr::NLEQ2Interface Class Reference
Inheritance diagram for rr::NLEQ2Interface:
rr::rrSteadyStateSolver rr::Dictionary

Public Member Functions

 NLEQ2Interface (ExecutableModel *_model=NULL)
 
double solve ()
 
virtual void setItem (const std::string &key, const rr::Variant &value)
 
virtual Variant getItem (const std::string &key) const
 
virtual bool hasKey (const std::string &key) const
 
virtual size_t deleteItem (const std::string &key)
 
virtual std::vector< std::string > getKeys () const
 
- Public Member Functions inherited from rr::Dictionary
virtual ~Dictionary ()
 

Static Public Member Functions

static const DictionarygetSteadyStateOptions ()
 

Friends

class NLEQ2Solver
 

Constructor & Destructor Documentation

◆ NLEQ2Interface()

rr::NLEQ2Interface::NLEQ2Interface ( ExecutableModel _model = NULL)

Creates a new Instance of NLEQ for the given Model

Member Function Documentation

◆ deleteItem()

virtual size_t rr::NLEQ2Interface::deleteItem ( const std::string &  key)
virtual

remove a value

Implements rr::Dictionary.

◆ getItem()

virtual Variant rr::NLEQ2Interface::getItem ( const std::string &  key) const
virtual

get a value. Variants are POD.

Implements rr::Dictionary.

◆ getKeys()

virtual std::vector<std::string> rr::NLEQ2Interface::getKeys ( ) const
virtual

list of keys in this object.

Implements rr::Dictionary.

◆ getSteadyStateOptions()

static const Dictionary* rr::NLEQ2Interface::getSteadyStateOptions ( )
static

list of keys that this integrator supports.

◆ hasKey()

virtual bool rr::NLEQ2Interface::hasKey ( const std::string &  key) const
virtual

is there a key matching this name.

Implements rr::Dictionary.

◆ setItem()

virtual void rr::NLEQ2Interface::setItem ( const std::string &  key,
const rr::Variant value 
)
virtual

Implement Dictionary Interface set an arbitrary key

Implements rr::Dictionary.

◆ solve()

double rr::NLEQ2Interface::solve ( )
virtual

Thea actual solver routine making the call to NLEQ2

Returns
sums of squares

Implements rr::rrSteadyStateSolver.


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