RapidNet
Fast Stochastic MPC for Drinking Water Networks
 All Classes Files Functions Variables Typedefs Macros Pages
Public Member Functions | List of all members
SmpcConfiguration Class Reference

Public Member Functions

 SmpcConfiguration (string pathToFile)
 
uint_t getNX ()
 
uint_t getNU ()
 
uint_t getND ()
 
uint_t getNV ()
 
real_tgetMatL ()
 
real_tgetMatLhat ()
 
real_tgetMatPrcndDiag ()
 
real_tgetCostW ()
 
real_tgetCurrentX ()
 
real_tgetPrevU ()
 
real_tgetPrevDemand ()
 
real_t getPenaltyState ()
 
real_t getPenaltySafety ()
 
uint_t getMaxIterations ()
 
real_t getStepSize ()
 
string getPathToControllerConfig ()
 
string getPathToNetwork ()
 
string getPathToScenarioTree ()
 
string getPathToForecaster ()
 
void setCurrentState ()
 
void setPreviousControl ()
 
void setPreviousDemand ()
 
void setCurrentState (real_t *state)
 
void setPreviousControl (real_t *control)
 
void setpreviousdemand (real_t *demand)
 
 ~SmpcConfiguration ()
 

Constructor & Destructor Documentation

SmpcConfiguration::SmpcConfiguration ( string  pathToFile)

Constructor of a SmpcConfiguration entity from a given JSON file.

Parameters
pathToFilefilename of a JSON file containing a representation of the controller configuration.
SmpcConfiguration::~SmpcConfiguration ( )

Default destructor to free the memory

Member Function Documentation

real_t * SmpcConfiguration::getCostW ( )

Smooth operation cost matrix

real_t * SmpcConfiguration::getCurrentX ( )

Current state/level of water in the tanks

Here is the caller graph for this function:

real_t * SmpcConfiguration::getMatL ( )

Affine space representation for the control-disturbance equality

real_t * SmpcConfiguration::getMatLhat ( )

matrix to calculate the particular solution

real_t * SmpcConfiguration::getMatPrcndDiag ( )

Diagonal preconditioner used

uint_t SmpcConfiguration::getMaxIterations ( )

Get the maximum iterations number of iterations

Here is the caller graph for this function:

uint_t SmpcConfiguration::getND ( )

Dimension of the demand

Here is the caller graph for this function:

uint_t SmpcConfiguration::getNU ( )

Dimension of the control

Here is the caller graph for this function:

uint_t SmpcConfiguration::getNV ( )

Reduced dimension of the control after eliminating the control-disturbance equality

Here is the caller graph for this function:

uint_t SmpcConfiguration::getNX ( )

—GETTER'S FOR CONTROLLER CONFIGURATION— Dimension of the state

Here is the caller graph for this function:

string SmpcConfiguration::getPathToControllerConfig ( )
string SmpcConfiguration::getPathToForecaster ( )

Here is the caller graph for this function:

string SmpcConfiguration::getPathToNetwork ( )

Here is the caller graph for this function:

string SmpcConfiguration::getPathToScenarioTree ( )

Here is the caller graph for this function:

real_t SmpcConfiguration::getPenaltySafety ( )

Weight that penalise the safety volume of the tank

Here is the caller graph for this function:

real_t SmpcConfiguration::getPenaltyState ( )

Weight that penalise the constraints on the tank level

Here is the caller graph for this function:

real_t * SmpcConfiguration::getPrevDemand ( )

Previous demand

Here is the caller graph for this function:

real_t * SmpcConfiguration::getPrevU ( )

Previous control/actuators for the valves and pumps

Here is the caller graph for this function:

real_t SmpcConfiguration::getStepSize ( )

Get the step size

Here is the caller graph for this function:

void SmpcConfiguration::setCurrentState ( )

SETTER'S FOR THE CONTROLLER CONFIGURATION OBJECT

Here is the caller graph for this function:

void SmpcConfiguration::setCurrentState ( real_t state)

update the level in the tanks

Parameters
stateupdated state
void SmpcConfiguration::setPreviousControl ( )

Here is the caller graph for this function:

void SmpcConfiguration::setPreviousControl ( real_t control)

update the previous control actions

Parameters
controlprevious control action
void SmpcConfiguration::setPreviousDemand ( )

Here is the caller graph for this function:

void SmpcConfiguration::setpreviousdemand ( real_t demand)

update the previous demand

Parameters
demandprevious demand

Here is the caller graph for this function:


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