APMonitor Options Overview
Main.DBS History
Show minor edits - Show changes to markup
Changed lines 11-13 from:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.to:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.
Changed lines 5-6 from:
The database file contains options and model inputs. The following is an exhaustive list of the configuration parameters for APM type and FV, MV, SV, CV type. Each section (Global and Variables) includes an indication of the variable type (Integer or Real), the default value, data flow, and description.
to:
The database file contains options and model inputs. The following is an exhaustive list of the configuration parameters for APM type and FV, MV, SV, CV type. Each option (Global or Local) includes an indication of the variable type (Integer or Real), the default value, data flow, and description.
Changed line 17 from:
FV, MV, SV, and CV Options
to:
FV, MV, SV, and CV (Local) Options
Changed line 21 from:
Local options are associated only with parameters declared as Fixed Values (FVs) or Manipulated Variables (MVs) and variables declared as State Variables (SVs) or Controlled Variables (CVs). These options are not read when APM.DBS_READ = 0 (OFF)''.
to:
Local options are associated only with parameters declared as Fixed Values (FVs) or Manipulated Variables (MVs) and variables declared as State Variables (SVs) or Controlled Variables (CVs). These options are not read when APM.DBS_READ = 0 (OFF).
Changed lines 11-12 from:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.to:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.Changed line 19 from:
to:
Changed lines 13-14 from:
to:
Changed line 23 from:
to:
Changed lines 13-74 from:
- APM.APPINFO
- APM.APPINFOCHG
- APM.APPSTATUS
- APM.AUTO_COLD
- APM.BAD_CYCLES
- APM.BNDS_CHK
- APM.COLDSTART
- APM.CSV_READ
- APM.CSV_WRITE
- APM.CTRL_HOR
- APM.CTRL_TIME
- APM.CTRL_UNITS
- APM.CTRLMODE
- APM.CV_TYPE
- APM.CV_WGT_SLOPE
- APM.CV_WGT_START
- APM.CYCLECOUNT
- APM.DBS_LEVEL
- APM.DBS_READ
- APM.DBS_WRITE
- APM.DIAGLEVEL
- APM.EV_WGT_SLOPE
- APM.EV_TYPE
- APM.FILTER
- APM.FRZE_CHK
- APM.HIST_HOR
- APM.HIST_UNITS
- APM.ICD_CALC
- APM.IMODE
- APM.ITERATIONS
- APM.LINEAR
- APM.MAX_ITER
- APM.MAX_MEMORY
- APM.MAX_TIME
- APM.MEAS_CHK
- APM.MV_DCOST_SLOPE
- APM.MV_STEP_HOR
- APM.MV_TYPE
- APM.NODES
- APM.OBJFCNVAL
- APM.OTOL
- APM.PRED_HOR
- APM.PRED_TIME
- APM.REDUCE
- APM.REPLAY
- APM.REQCTRLMODE
- APM.RTOL
- APM.SCALING
- APM.SENSITIVITY
- APM.SEQUENTIAL
- APM.SOLVER
- APM.SOLVESTATUS
- APM.SOLVETIME
- APM.SPECS
- APM.SPC_CHART
- APM.STREAM_LEVEL
- APM.TIME_SHIFT
- APM.WEB
- APM.WEB_MENU
- APM.WEB_REFRESH
- APM.WEB_PLOT_FREQ
to:
Changed lines 23-64 from:
to:
Changed lines 128-240 from:
Example DBS File
Options are stored in DBS files. When an option is changed with a call to apm_option, a line is added to the overrides.dbs file. When a measurement is recorded with apm_meas, a line is added to measurements.dbs. Below is an example of a DBS file with both global application options and options for individually classified parameters and variables.
APM.APPINFO = 0, 1 APM.APPINFOCHG = 0, 1 APM.APPSTATUS = 1, 1 APM.BNDS_CHK = 1, 1 APM.COLDSTART = 0, 1 APM.CSV_READ = 0, 1 APM.CSV_WRITE = 0, 1 APM.CTRL_HOR = 1, 1 APM.CTRL_TIME = 0.6000000000000000D+02, 1 APM.CTRL_UNITS = 1, 1 APM.CTRLMODE = 1, 1 APM.CV_WGT_SLOPE = 0.0000000000000000D+00, 1 APM.CV_WGT_START = 0, 1 APM.CV_TYPE = 1, 1 APM.CYCLECOUNT = 70, 1 APM.DBS_READ = 0, 1 APM.DBS_WRITE = 1, 1 APM.DIAGLEVEL = 0, 1 APM.EV_WGT_SLOPE = 0.0000000000000000D+00, 1 APM.EV_TYPE = 2, 1 APM.HIST_HOR = 0, 1 APM.HIST_UNITS = 0, 1 APM.ICD_CALC = 0, 1 APM.IMODE = 3, 1 APM.ITERATIONS = 0, 1 APM.MAX_ITER = 25, 1 APM.MAX_TIME = 0.1000000000000000D+21, 1 APM.MEAS_CHK = 1, 1 APM.MV_DCOST_SLOPE = 0.1000000000000000D+00, 1 APM.MV_STEP_HOR = 1, 1 APM.MV_TYPE = 0, 1 APM.NODES = 4, 1 APM.OBJFCNVAL = 0.0000000000000000D+00, 1 APM.OTOL = 0.1000000000000000D-05, 1 APM.PRED_HOR = 3, 1 APM.PRED_TIME = 0.6000000000000000D+02, 1 APM.REQCTRLMODE = 1, 1 APM.RTOL = 0.1000000000000000D-05, 1 APM.SOLVER = 3, 1 APM.SOLVESTATUS = 1, 1 APM.SOLVETIME = 0.5155999999999999D+00, 1 APM.SPECS = 1, 1 APM.TIME_SHIFT = 0, 1 APM.WEB = 1, 1 APM.WEB_MENU = 1, 1 APM.WEB_REFRESH = 10, 1 FV(1).CRITICAL = 0, 0 FV(1).FSTATUS = 0.1000000000000000D+01, 0 FV(1).LSTVAL = 0.5000000000000000D+01, 1 FV(1).MEAS = 0.5000000000000000D+01, 1 FV(1).NEWVAL = 0.5000000000000000D+01, 1 FV(1).OSTATUS[1] = 0, 0 FV(1).OSTATUS[2] = 0, 0 FV(1).OSTATUSCHG[1] = 0, 0 FV(1).OSTATUSCHG[2] = 0, 0 FV(1).PSTATUS = 1, 0 FV(1).STATUS = 0, 0 FV(1).VDVL = 0.1000000000000000D+21, 0 FV(1).VLHI = 0.1000000000000000D+21, 0 FV(1).VLLO = -0.1000000000000000D+21, 0 MV(1).COST = 0.0000000000000000D+00, 0 MV(1).CRITICAL = 0, 0 MV(1).DCOST = 0.9999999747378752D-05, 0 MV(1).DMAX = 0.1000000000000000D+21, 0 MV(1).DMAXHI = 0.1000000000000000D+21, 0 MV(1).DMAXLO = -0.1000000000000000D+21, 0 MV(1).DPRED[1] = 0.0000000000000000D+00, 0 MV(1).FSTATUS = 0.1000000000000000D+01, 0 MV(1).LOWER = 0.1000000000000000D+01, 1 MV(1).LSTVAL = 0.2000000000000000D+01, 1 MV(1).MEAS = 0.2000000000000000D+01, 1 MV(1).MV_STEP_HOR = 0, 0 MV(1).NEWVAL = 0.2000000000000000D+01, 1 MV(1).NXTVAL = 0.2000000000000000D+01, 1 MV(1).OSTATUS[1] = 0, 0 MV(1).OSTATUS[2] = 0, 0 MV(1).OSTATUSCHG[1] = 0, 0 MV(1).OSTATUSCHG[2] = 0, 0 MV(1).PRED[0] = 0.2000000000000000D+01, 1 MV(1).PRED[1] = 0.2000000000000000D+01, 1 MV(1).PSTATUS = 1, 0 MV(1).REQONCTRL = 0, 0 MV(1).STATUS = 0, 0 MV(1).UPPER = 0.3000000000000000D+01, 1 MV(1).VDVL = 0.1000000000000000D+21, 0 MV(1).VLHI = 0.1000000000000000D+21, 0 MV(1).VLLO = -0.1000000000000000D+21, 0 CV(1).CRITICAL = 0, 0 CV(1).FSTATUS = 0.1000000000000000D+01, 0 CV(1).FDELAY = 0, 0 CV(1).LOWER = -0.1000000000000000D+21, 1 CV(1).LSTVAL = 0.5000000000000000D+01, 1 CV(1).MEAS = 0.1000000000000000D+01, 0 CV(1).MEAS_GAP = 0.1000000000000000D+01, 0 CV(1).MODEL = 0.5000000000000000D+01, 1 CV(1).OBJPCT = 0.0000000000000000D+00, 1 CV(1).OSTATUS[1] = 0, 0 CV(1).OSTATUS[2] = 0, 0 CV(1).OSTATUSCHG[1] = 0, 0 CV(1).OSTATUSCHG[2] = 0, 0 CV(1).PRED[0] = 0.5000000000000000D+01, 1 CV(1).PRED[1] = 0.5000000000000000D+01, 1 CV(1).PSTATUS = 1, 0 CV(1).UPPER = 0.1000000000000000D+21, 1 CV(1).VDVL = 0.1000000000000000D+21, 0 CV(1).VLHI = 0.1000000000000000D+21, 0 CV(1).VLLO = -0.1000000000000000D+21, 0 CV(1).WMEAS = 0.2000000000000000D+02, 0 CV(1).WMODEL = 0.2000000000000000D+01, 0
to:
Options are stored in DBS files. When an option is changed with a call to apm_option, a line is added to the overrides.dbs file. When a measurement is recorded with apm_meas, a line is added to measurements.dbs.
Changed lines 11-12 from:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ? = 0 (OFF) only the options associated with variables are skipped.to:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.Changed line 81 from:
Local options are associated only with parameters declared as Fixed Values (FVs) or Manipulated Variables (MVs) and variables declared as State Variables (SVs) or Controlled Variables (CVs). These options are not read when APM.DBS_READ? = 0 (OFF)''.
to:
Local options are associated only with parameters declared as Fixed Values (FVs) or Manipulated Variables (MVs) and variables declared as State Variables (SVs) or Controlled Variables (CVs). These options are not read when APM.DBS_READ = 0 (OFF)''.
Changed lines 11-12 from:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.to:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ? = 0 (OFF) only the options associated with variables are skipped.Changed line 81 from:
Certain options are associated only with parameters declared as Fixed Values (FVs) or Manipulated Variables (MVs) and variables declared as State Variables (SVs) or Controlled Variables (CVs). These options are not read when APM.DBS_READ = 0 (OFF).
to:
Local options are associated only with parameters declared as Fixed Values (FVs) or Manipulated Variables (MVs) and variables declared as State Variables (SVs) or Controlled Variables (CVs). These options are not read when APM.DBS_READ? = 0 (OFF)''.
Changed lines 11-12 from:
The global configuration parameters are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.to:
Global configuration parameters control the overall options for the application and are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.Changed line 81 from:
Certain options are associated only with variables declared as FV, MV, SV, or CV types. They are not read when APM.DBS_READ = 0 (OFF).
to:
Certain options are associated only with parameters declared as Fixed Values (FVs) or Manipulated Variables (MVs) and variables declared as State Variables (SVs) or Controlled Variables (CVs). These options are not read when APM.DBS_READ = 0 (OFF).
Changed lines 83-92 from:
to:
Changed lines 94-124 from:
to:
Changed lines 83-121 from:
- COST
- CRITICAL
- DCOST
- DMAX
- DMAXHI
- DMAXLO
- DPRED
- FSTATUS
- FDELAY
- LOWER
- LSTVAL
- MEAS
- MEAS_GAP
- MODEL
- MV_STEP_HOR
- NEWVAL
- NXTVAL
- OBJPCT
- OSTATUS
- OSTATUSCHG
- PRED
- PSTATUS
- REQONCTRL
- SP
- SPHI
- SPLO
- STATUS
- TAU
- TR_OPEN
- TR_INIT
- UPPER
- VDVL
- VLHI
- VLLO
- WMEAS
- WMODEL
- WSP
- WSPHI
- WSPLO
to:
Changed line 1 from:
(:title Database File (DBS):)
to:
(:title APMonitor Options Overview:)
Changed lines 13-58 from:
- APM.APPINFO
- APM.APPINFOCHG
- APM.APPSTATUS
- APM.BNDS_CHK
- APM.COLDSTART
- APM.CSV_READ
- APM.CSV_WRITE
- APM.CTRLMODE
- APM.CTRL_HOR
- APM.CTRL_TIME
- APM.CTRL_UNITS
- APM.CV_TYPE
- APM.CV_WGT_SLOPE
- APM.CV_WGT_START
- APM.CYCLECOUNT
- APM.DBS_READ
- APM.DBS_WRITE
- APM.DIAGLEVEL
- APM.EV_TYPE
- APM.EV_WGT_SLOPE
- APM.HIST_HOR
- APM.HIST_UNITS
- APM.ICD_CALC
- APM.IMODE
- APM.ITERATIONS
- APM.MAX_ITER
- APM.MAX_TIME
- APM.MEAS_CHK
- APM.MV_DCOST_SLOPE
- APM.MV_STEP_HOR
- APM.MV_TYPE
- APM.NODES
- APM.OBJFCNVAL
- APM.OTOL
- APM.PRED_HOR
- APM.PRED_TIME
- APM.REQCTRLMODE
- APM.RTOL
- APM.SOLVESTATUS
- APM.SOLVER
- APM.SOLVETIME
- APM.SPECS
- APM.TIME_SHIFT
- APM.WEB
- APM.WEB_MENU
- APM.WEB_REFRESH
to:
- APM.APPINFO
- APM.APPINFOCHG
- APM.APPSTATUS
- APM.AUTO_COLD
- APM.BAD_CYCLES
- APM.BNDS_CHK
- APM.COLDSTART
- APM.CSV_READ
- APM.CSV_WRITE
- APM.CTRL_HOR
- APM.CTRL_TIME
- APM.CTRL_UNITS
- APM.CTRLMODE
- APM.CV_WGT_SLOPE
- APM.CV_WGT_START
- APM.CV_TYPE
- APM.CYCLECOUNT
- APM.DBS_LEVEL
- APM.DBS_READ
- APM.DBS_WRITE
- APM.DIAGLEVEL
- APM.EV_WGT_SLOPE
- APM.EV_TYPE
- APM.FILTER
- APM.FRZE_CHK
- APM.HIST_HOR
- APM.HIST_UNITS
- APM.ICD_CALC
- APM.IMODE
- APM.ITERATIONS
- APM.LINEAR
- APM.MAX_ITER
- APM.MAX_MEMORY
- APM.MAX_TIME
- APM.MEAS_CHK
- APM.MV_DCOST_SLOPE
- APM.MV_STEP_HOR
- APM.MV_TYPE
- APM.NODES
- APM.OBJFCNVAL
- APM.OTOL
- APM.PRED_HOR
- APM.PRED_TIME
- APM.REDUCE
- APM.REPLAY
- APM.REQCTRLMODE
- APM.RTOL
- APM.SCALING
- APM.SENSITIVITY
- APM.SEQUENTIAL
- APM.SOLVER
- APM.SOLVESTATUS
- APM.SOLVETIME
- APM.SPECS
- APM.SPC_CHART
- APM.STREAM_LEVEL
- APM.TIME_SHIFT
- APM.WEB
- APM.WEB_MENU
- APM.WEB_REFRESH
- APM.WEB_PLOT_FREQ
Changed lines 199-220 from:
SV(1).CRITICAL = 0, 0 SV(1).FSTATUS = 0.1000000000000000D+01, 0 SV(1).FDELAY = 0, 0 SV(1).LOWER = -0.1000000000000000D+21, 1 SV(1).LSTVAL = 0.5000000000000000D+01, 1 SV(1).MEAS = 0.1000000000000000D+01, 0 SV(1).MEAS_GAP = 0.1000000000000000D+01, 0 SV(1).MODEL = 0.5000000000000000D+01, 1 SV(1).OBJPCT = 0.0000000000000000D+00, 1 SV(1).OSTATUS[1] = 0, 0 SV(1).OSTATUS[2] = 0, 0 SV(1).OSTATUSCHG[1] = 0, 0 SV(1).OSTATUSCHG[2] = 0, 0 SV(1).PRED[0] = 0.5000000000000000D+01, 1 SV(1).PRED[1] = 0.5000000000000000D+01, 1 SV(1).PSTATUS = 1, 0 SV(1).UPPER = 0.1000000000000000D+21, 1 SV(1).VDVL = 0.1000000000000000D+21, 0 SV(1).VLHI = 0.1000000000000000D+21, 0 SV(1).VLLO = -0.1000000000000000D+21, 0 SV(1).WMEAS = 0.2000000000000000D+02, 0 SV(1).WMODEL = 0.2000000000000000D+01, 0
to:
CV(1).CRITICAL = 0, 0 CV(1).FSTATUS = 0.1000000000000000D+01, 0 CV(1).FDELAY = 0, 0 CV(1).LOWER = -0.1000000000000000D+21, 1 CV(1).LSTVAL = 0.5000000000000000D+01, 1 CV(1).MEAS = 0.1000000000000000D+01, 0 CV(1).MEAS_GAP = 0.1000000000000000D+01, 0 CV(1).MODEL = 0.5000000000000000D+01, 1 CV(1).OBJPCT = 0.0000000000000000D+00, 1 CV(1).OSTATUS[1] = 0, 0 CV(1).OSTATUS[2] = 0, 0 CV(1).OSTATUSCHG[1] = 0, 0 CV(1).OSTATUSCHG[2] = 0, 0 CV(1).PRED[0] = 0.5000000000000000D+01, 1 CV(1).PRED[1] = 0.5000000000000000D+01, 1 CV(1).PSTATUS = 1, 0 CV(1).UPPER = 0.1000000000000000D+21, 1 CV(1).VDVL = 0.1000000000000000D+21, 0 CV(1).VLHI = 0.1000000000000000D+21, 0 CV(1).VLLO = -0.1000000000000000D+21, 0 CV(1).WMEAS = 0.2000000000000000D+02, 0 CV(1).WMODEL = 0.2000000000000000D+01, 0
Changed lines 9-12 from:
DBS Parameters for Configuration
The configuration parameters before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the parameters associated with variables are skipped.
to:
Global Application Options
The global configuration parameters are read before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the options associated with variables are skipped.Changed lines 62-65 from:
FV, MV, SV, and CV Parameters
The variable parameters are associated only with variables declared in the INFO file. They are not read when APM.DBS_READ = 0 (OFF).
to:
FV, MV, SV, and CV Options
Certain options are associated only with variables declared as FV, MV, SV, or CV types. They are not read when APM.DBS_READ = 0 (OFF).
Changed lines 108-110 from:
Example File - test.dbs
to:
Example DBS File
Options are stored in DBS files. When an option is changed with a call to apm_option, a line is added to the overrides.dbs file. When a measurement is recorded with apm_meas, a line is added to measurements.dbs. Below is an example of a DBS file with both global application options and options for individually classified parameters and variables.
Changed lines 1-4 from:
DBS - Database File
The database file contains options and model inputs. The following is an exhaustive list of the configuration parameters for NLC type and FV, MV, SV, CV type. Each section (Global and Variables) includes an indication of the variable type (Integer or Real), the default value, data flow, and description.
to:
(:title Database File (DBS):) (:keywords DBS, Database, Optimization, Estimation, Option, Configure, Default, Description:) (:description APMonitor stores options in a database file (DBS). They can be set from MATLAB or Python clients.:)
The database file contains options and model inputs. The following is an exhaustive list of the configuration parameters for APM type and FV, MV, SV, CV type. Each section (Global and Variables) includes an indication of the variable type (Integer or Real), the default value, data flow, and description.
Changed lines 11-59 from:
The configuration parameters before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of NLC.DBS_READ. When NLC.DBS_READ = 0 (OFF) only the parameters associated with variables are skipped.
- NLC.APPINFO
- NLC.APPINFOCHG
- NLC.APPSTATUS
- NLC.BNDS_CHK
- NLC.COLDSTART
- NLC.CSV_READ
- NLC.CSV_WRITE
- NLC.CTRLMODE
- NLC.CTRL_HOR
- NLC.CTRL_TIME
- NLC.CTRL_UNITS
- NLC.CV_TYPE
- NLC.CV_WGT_SLOPE
- NLC.CV_WGT_START
- NLC.CYCLECOUNT
- NLC.DBS_READ
- NLC.DBS_WRITE
- NLC.DIAGLEVEL
- NLC.EV_TYPE
- NLC.EV_WGT_SLOPE
- NLC.HIST_HOR
- NLC.HIST_UNITS
- NLC.ICD_CALC
- NLC.IMODE
- NLC.ITERATIONS
- NLC.MAX_ITER
- NLC.MAX_TIME
- NLC.MEAS_CHK
- NLC.MV_DCOST_SLOPE
- NLC.MV_STEP_HOR
- NLC.MV_TYPE
- NLC.NODES
- NLC.OBJFCNVAL
- NLC.OTOL
- NLC.PRED_HOR
- NLC.PRED_TIME
- NLC.REQCTRLMODE
- NLC.RTOL
- NLC.SOLVESTATUS
- NLC.SOLVER
- NLC.SOLVETIME
- NLC.SPECS
- NLC.TIME_SHIFT
- NLC.WEB
- NLC.WEB_MENU
- NLC.WEB_REFRESH
to:
The configuration parameters before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of APM.DBS_READ. When APM.DBS_READ = 0 (OFF) only the parameters associated with variables are skipped.
- APM.APPINFO
- APM.APPINFOCHG
- APM.APPSTATUS
- APM.BNDS_CHK
- APM.COLDSTART
- APM.CSV_READ
- APM.CSV_WRITE
- APM.CTRLMODE
- APM.CTRL_HOR
- APM.CTRL_TIME
- APM.CTRL_UNITS
- APM.CV_TYPE
- APM.CV_WGT_SLOPE
- APM.CV_WGT_START
- APM.CYCLECOUNT
- APM.DBS_READ
- APM.DBS_WRITE
- APM.DIAGLEVEL
- APM.EV_TYPE
- APM.EV_WGT_SLOPE
- APM.HIST_HOR
- APM.HIST_UNITS
- APM.ICD_CALC
- APM.IMODE
- APM.ITERATIONS
- APM.MAX_ITER
- APM.MAX_TIME
- APM.MEAS_CHK
- APM.MV_DCOST_SLOPE
- APM.MV_STEP_HOR
- APM.MV_TYPE
- APM.NODES
- APM.OBJFCNVAL
- APM.OTOL
- APM.PRED_HOR
- APM.PRED_TIME
- APM.REQCTRLMODE
- APM.RTOL
- APM.SOLVESTATUS
- APM.SOLVER
- APM.SOLVETIME
- APM.SPECS
- APM.TIME_SHIFT
- APM.WEB
- APM.WEB_MENU
- APM.WEB_REFRESH
Changed lines 64-65 from:
The variable parameters are associated only with variables declared in the INFO file. They are not read when NLC.DBS_READ = 0 (OFF).
to:
The variable parameters are associated only with variables declared in the INFO file. They are not read when APM.DBS_READ = 0 (OFF).
Changed lines 110-223 from:
(:table border=1 width=50% align=left bgcolor=#EEEEEE cellspacing=0:) (:cellnr:)
DB_Variables NLC.APPINFO = 0, 1, NONE NLC.APPINFOCHG = 0, 1, NONE NLC.APPSTATUS = 1, 1, NONE NLC.BNDS_CHK = 1, 1, NONE NLC.COLDSTART = 0, 1, NONE NLC.CSV_READ = 0, 1, NONE NLC.CSV_WRITE = 0, 1, NONE NLC.CTRL_HOR = 1, 1, NONE NLC.CTRL_TIME = 0.6000000000000000D+02, 1, NONE NLC.CTRL_UNITS = 1, 1, NONE NLC.CTRLMODE = 1, 1, NONE NLC.CV_WGT_SLOPE = 0.0000000000000000D+00, 1, NONE NLC.CV_WGT_START = 0, 1, NONE NLC.CV_TYPE = 1, 1, NONE NLC.CYCLECOUNT = 70, 1, NONE NLC.DBS_READ = 0, 1, NONE NLC.DBS_WRITE = 1, 1, NONE NLC.DIAGLEVEL = 0, 1, NONE NLC.EV_WGT_SLOPE = 0.0000000000000000D+00, 1, NONE NLC.EV_TYPE = 2, 1, NONE NLC.HIST_HOR = 0, 1, NONE NLC.HIST_UNITS = 0, 1, NONE NLC.ICD_CALC = 0, 1, NONE NLC.IMODE = 3, 1, NONE NLC.ITERATIONS = 0, 1, NONE NLC.MAX_ITER = 25, 1, NONE NLC.MAX_TIME = 0.1000000000000000D+21, 1, NONE NLC.MEAS_CHK = 1, 1, NONE NLC.MV_DCOST_SLOPE = 0.1000000000000000D+00, 1, NONE NLC.MV_STEP_HOR = 1, 1, NONE NLC.MV_TYPE = 0, 1, NONE NLC.NODES = 4, 1, NONE NLC.OBJFCNVAL = 0.0000000000000000D+00, 1, NONE NLC.OTOL = 0.1000000000000000D-05, 1, NONE NLC.PRED_HOR = 3, 1, NONE NLC.PRED_TIME = 0.6000000000000000D+02, 1, NONE NLC.REQCTRLMODE = 1, 1, NONE NLC.RTOL = 0.1000000000000000D-05, 1, NONE NLC.SOLVER = 3, 1, NONE NLC.SOLVESTATUS = 1, 1, NONE NLC.SOLVETIME = 0.5155999999999999D+00, 1, NONE NLC.SPECS = 1, 1, NONE NLC.TIME_SHIFT = 0, 1, NONE NLC.WEB = 1, 1, NONE NLC.WEB_MENU = 1, 1, NONE NLC.WEB_REFRESH = 10, 1, NONE FV(1).CRITICAL = 0, 0, NONE FV(1).FSTATUS = 0.1000000000000000D+01, 0, NONE FV(1).LSTVAL = 0.5000000000000000D+01, 1, NONE FV(1).MEAS = 0.5000000000000000D+01, 1, NONE FV(1).NEWVAL = 0.5000000000000000D+01, 1, NONE FV(1).OSTATUS[1] = 0, 0, NONE FV(1).OSTATUS[2] = 0, 0, NONE FV(1).OSTATUSCHG[1] = 0, 0, NONE FV(1).OSTATUSCHG[2] = 0, 0, NONE FV(1).PSTATUS = 1, 0, NONE FV(1).STATUS = 0, 0, NONE FV(1).VDVL = 0.1000000000000000D+21, 0, NONE FV(1).VLHI = 0.1000000000000000D+21, 0, NONE FV(1).VLLO = -0.1000000000000000D+21, 0, NONE MV(1).COST = 0.0000000000000000D+00, 0, NONE MV(1).CRITICAL = 0, 0, NONE MV(1).DCOST = 0.9999999747378752D-05, 0, NONE MV(1).DMAX = 0.1000000000000000D+21, 0, NONE MV(1).DMAXHI = 0.1000000000000000D+21, 0, NONE MV(1).DMAXLO = -0.1000000000000000D+21, 0, NONE MV(1).DPRED[1] = 0.0000000000000000D+00, 0, NONE MV(1).FSTATUS = 0.1000000000000000D+01, 0, NONE MV(1).LOWER = 0.1000000000000000D+01, 1, NONE MV(1).LSTVAL = 0.2000000000000000D+01, 1, NONE MV(1).MEAS = 0.2000000000000000D+01, 1, NONE MV(1).MV_STEP_HOR = 0, 0, NONE MV(1).NEWVAL = 0.2000000000000000D+01, 1, NONE MV(1).NXTVAL = 0.2000000000000000D+01, 1, NONE MV(1).OSTATUS[1] = 0, 0, NONE MV(1).OSTATUS[2] = 0, 0, NONE MV(1).OSTATUSCHG[1] = 0, 0, NONE MV(1).OSTATUSCHG[2] = 0, 0, NONE MV(1).PRED[0] = 0.2000000000000000D+01, 1, NONE MV(1).PRED[1] = 0.2000000000000000D+01, 1, NONE MV(1).PSTATUS = 1, 0, NONE MV(1).REQONCTRL = 0, 0, NONE MV(1).STATUS = 0, 0, NONE MV(1).UPPER = 0.3000000000000000D+01, 1, NONE MV(1).VDVL = 0.1000000000000000D+21, 0, NONE MV(1).VLHI = 0.1000000000000000D+21, 0, NONE MV(1).VLLO = -0.1000000000000000D+21, 0, NONE SV(1).CRITICAL = 0, 0, NONE SV(1).FSTATUS = 0.1000000000000000D+01, 0, NONE SV(1).FDELAY = 0, 0, NONE SV(1).LOWER = -0.1000000000000000D+21, 1, NONE SV(1).LSTVAL = 0.5000000000000000D+01, 1, NONE SV(1).MEAS = 0.1000000000000000D+01, 0, NONE SV(1).MEAS_GAP = 0.1000000000000000D+01, 0, NONE SV(1).MODEL = 0.5000000000000000D+01, 1, NONE SV(1).OBJPCT = 0.0000000000000000D+00, 1, NONE SV(1).OSTATUS[1] = 0, 0, NONE SV(1).OSTATUS[2] = 0, 0, NONE SV(1).OSTATUSCHG[1] = 0, 0, NONE SV(1).OSTATUSCHG[2] = 0, 0, NONE SV(1).PRED[0] = 0.5000000000000000D+01, 1, NONE SV(1).PRED[1] = 0.5000000000000000D+01, 1, NONE SV(1).PSTATUS = 1, 0, NONE SV(1).UPPER = 0.1000000000000000D+21, 1, NONE SV(1).VDVL = 0.1000000000000000D+21, 0, NONE SV(1).VLHI = 0.1000000000000000D+21, 0, NONE SV(1).VLLO = -0.1000000000000000D+21, 0, NONE SV(1).WMEAS = 0.2000000000000000D+02, 0, NONE SV(1).WMODEL = 0.2000000000000000D+01, 0, NONE End DB_Variables
(:tableend:)
to:
APM.APPINFO = 0, 1 APM.APPINFOCHG = 0, 1 APM.APPSTATUS = 1, 1 APM.BNDS_CHK = 1, 1 APM.COLDSTART = 0, 1 APM.CSV_READ = 0, 1 APM.CSV_WRITE = 0, 1 APM.CTRL_HOR = 1, 1 APM.CTRL_TIME = 0.6000000000000000D+02, 1 APM.CTRL_UNITS = 1, 1 APM.CTRLMODE = 1, 1 APM.CV_WGT_SLOPE = 0.0000000000000000D+00, 1 APM.CV_WGT_START = 0, 1 APM.CV_TYPE = 1, 1 APM.CYCLECOUNT = 70, 1 APM.DBS_READ = 0, 1 APM.DBS_WRITE = 1, 1 APM.DIAGLEVEL = 0, 1 APM.EV_WGT_SLOPE = 0.0000000000000000D+00, 1 APM.EV_TYPE = 2, 1 APM.HIST_HOR = 0, 1 APM.HIST_UNITS = 0, 1 APM.ICD_CALC = 0, 1 APM.IMODE = 3, 1 APM.ITERATIONS = 0, 1 APM.MAX_ITER = 25, 1 APM.MAX_TIME = 0.1000000000000000D+21, 1 APM.MEAS_CHK = 1, 1 APM.MV_DCOST_SLOPE = 0.1000000000000000D+00, 1 APM.MV_STEP_HOR = 1, 1 APM.MV_TYPE = 0, 1 APM.NODES = 4, 1 APM.OBJFCNVAL = 0.0000000000000000D+00, 1 APM.OTOL = 0.1000000000000000D-05, 1 APM.PRED_HOR = 3, 1 APM.PRED_TIME = 0.6000000000000000D+02, 1 APM.REQCTRLMODE = 1, 1 APM.RTOL = 0.1000000000000000D-05, 1 APM.SOLVER = 3, 1 APM.SOLVESTATUS = 1, 1 APM.SOLVETIME = 0.5155999999999999D+00, 1 APM.SPECS = 1, 1 APM.TIME_SHIFT = 0, 1 APM.WEB = 1, 1 APM.WEB_MENU = 1, 1 APM.WEB_REFRESH = 10, 1 FV(1).CRITICAL = 0, 0 FV(1).FSTATUS = 0.1000000000000000D+01, 0 FV(1).LSTVAL = 0.5000000000000000D+01, 1 FV(1).MEAS = 0.5000000000000000D+01, 1 FV(1).NEWVAL = 0.5000000000000000D+01, 1 FV(1).OSTATUS[1] = 0, 0 FV(1).OSTATUS[2] = 0, 0 FV(1).OSTATUSCHG[1] = 0, 0 FV(1).OSTATUSCHG[2] = 0, 0 FV(1).PSTATUS = 1, 0 FV(1).STATUS = 0, 0 FV(1).VDVL = 0.1000000000000000D+21, 0 FV(1).VLHI = 0.1000000000000000D+21, 0 FV(1).VLLO = -0.1000000000000000D+21, 0 MV(1).COST = 0.0000000000000000D+00, 0 MV(1).CRITICAL = 0, 0 MV(1).DCOST = 0.9999999747378752D-05, 0 MV(1).DMAX = 0.1000000000000000D+21, 0 MV(1).DMAXHI = 0.1000000000000000D+21, 0 MV(1).DMAXLO = -0.1000000000000000D+21, 0 MV(1).DPRED[1] = 0.0000000000000000D+00, 0 MV(1).FSTATUS = 0.1000000000000000D+01, 0 MV(1).LOWER = 0.1000000000000000D+01, 1 MV(1).LSTVAL = 0.2000000000000000D+01, 1 MV(1).MEAS = 0.2000000000000000D+01, 1 MV(1).MV_STEP_HOR = 0, 0 MV(1).NEWVAL = 0.2000000000000000D+01, 1 MV(1).NXTVAL = 0.2000000000000000D+01, 1 MV(1).OSTATUS[1] = 0, 0 MV(1).OSTATUS[2] = 0, 0 MV(1).OSTATUSCHG[1] = 0, 0 MV(1).OSTATUSCHG[2] = 0, 0 MV(1).PRED[0] = 0.2000000000000000D+01, 1 MV(1).PRED[1] = 0.2000000000000000D+01, 1 MV(1).PSTATUS = 1, 0 MV(1).REQONCTRL = 0, 0 MV(1).STATUS = 0, 0 MV(1).UPPER = 0.3000000000000000D+01, 1 MV(1).VDVL = 0.1000000000000000D+21, 0 MV(1).VLHI = 0.1000000000000000D+21, 0 MV(1).VLLO = -0.1000000000000000D+21, 0 SV(1).CRITICAL = 0, 0 SV(1).FSTATUS = 0.1000000000000000D+01, 0 SV(1).FDELAY = 0, 0 SV(1).LOWER = -0.1000000000000000D+21, 1 SV(1).LSTVAL = 0.5000000000000000D+01, 1 SV(1).MEAS = 0.1000000000000000D+01, 0 SV(1).MEAS_GAP = 0.1000000000000000D+01, 0 SV(1).MODEL = 0.5000000000000000D+01, 1 SV(1).OBJPCT = 0.0000000000000000D+00, 1 SV(1).OSTATUS[1] = 0, 0 SV(1).OSTATUS[2] = 0, 0 SV(1).OSTATUSCHG[1] = 0, 0 SV(1).OSTATUSCHG[2] = 0, 0 SV(1).PRED[0] = 0.5000000000000000D+01, 1 SV(1).PRED[1] = 0.5000000000000000D+01, 1 SV(1).PSTATUS = 1, 0 SV(1).UPPER = 0.1000000000000000D+21, 1 SV(1).VDVL = 0.1000000000000000D+21, 0 SV(1).VLHI = 0.1000000000000000D+21, 0 SV(1).VLLO = -0.1000000000000000D+21, 0 SV(1).WMEAS = 0.2000000000000000D+02, 0 SV(1).WMODEL = 0.2000000000000000D+01, 0
Changed line 3 from:
The database file contains options and model inputs. The following is an exhaustive list of the configuration parameters for NLC type and FV, MV, SV, CV type. Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and description.
to:
The database file contains options and model inputs. The following is an exhaustive list of the configuration parameters for NLC type and FV, MV, SV, CV type. Each section (Global and Variables) includes an indication of the variable type (Integer or Real), the default value, data flow, and description.
Changed lines 107-108 from:
to:
(:table border=1 width=50% align=left bgcolor=#EEEEEE cellspacing=0:) (:cellnr:)
Added line 220:
(:tableend:)
Changed lines 103-218 from:
to:
Example File - test.dbs
DB_Variables NLC.APPINFO = 0, 1, NONE NLC.APPINFOCHG = 0, 1, NONE NLC.APPSTATUS = 1, 1, NONE NLC.BNDS_CHK = 1, 1, NONE NLC.COLDSTART = 0, 1, NONE NLC.CSV_READ = 0, 1, NONE NLC.CSV_WRITE = 0, 1, NONE NLC.CTRL_HOR = 1, 1, NONE NLC.CTRL_TIME = 0.6000000000000000D+02, 1, NONE NLC.CTRL_UNITS = 1, 1, NONE NLC.CTRLMODE = 1, 1, NONE NLC.CV_WGT_SLOPE = 0.0000000000000000D+00, 1, NONE NLC.CV_WGT_START = 0, 1, NONE NLC.CV_TYPE = 1, 1, NONE NLC.CYCLECOUNT = 70, 1, NONE NLC.DBS_READ = 0, 1, NONE NLC.DBS_WRITE = 1, 1, NONE NLC.DIAGLEVEL = 0, 1, NONE NLC.EV_WGT_SLOPE = 0.0000000000000000D+00, 1, NONE NLC.EV_TYPE = 2, 1, NONE NLC.HIST_HOR = 0, 1, NONE NLC.HIST_UNITS = 0, 1, NONE NLC.ICD_CALC = 0, 1, NONE NLC.IMODE = 3, 1, NONE NLC.ITERATIONS = 0, 1, NONE NLC.MAX_ITER = 25, 1, NONE NLC.MAX_TIME = 0.1000000000000000D+21, 1, NONE NLC.MEAS_CHK = 1, 1, NONE NLC.MV_DCOST_SLOPE = 0.1000000000000000D+00, 1, NONE NLC.MV_STEP_HOR = 1, 1, NONE NLC.MV_TYPE = 0, 1, NONE NLC.NODES = 4, 1, NONE NLC.OBJFCNVAL = 0.0000000000000000D+00, 1, NONE NLC.OTOL = 0.1000000000000000D-05, 1, NONE NLC.PRED_HOR = 3, 1, NONE NLC.PRED_TIME = 0.6000000000000000D+02, 1, NONE NLC.REQCTRLMODE = 1, 1, NONE NLC.RTOL = 0.1000000000000000D-05, 1, NONE NLC.SOLVER = 3, 1, NONE NLC.SOLVESTATUS = 1, 1, NONE NLC.SOLVETIME = 0.5155999999999999D+00, 1, NONE NLC.SPECS = 1, 1, NONE NLC.TIME_SHIFT = 0, 1, NONE NLC.WEB = 1, 1, NONE NLC.WEB_MENU = 1, 1, NONE NLC.WEB_REFRESH = 10, 1, NONE FV(1).CRITICAL = 0, 0, NONE FV(1).FSTATUS = 0.1000000000000000D+01, 0, NONE FV(1).LSTVAL = 0.5000000000000000D+01, 1, NONE FV(1).MEAS = 0.5000000000000000D+01, 1, NONE FV(1).NEWVAL = 0.5000000000000000D+01, 1, NONE FV(1).OSTATUS[1] = 0, 0, NONE FV(1).OSTATUS[2] = 0, 0, NONE FV(1).OSTATUSCHG[1] = 0, 0, NONE FV(1).OSTATUSCHG[2] = 0, 0, NONE FV(1).PSTATUS = 1, 0, NONE FV(1).STATUS = 0, 0, NONE FV(1).VDVL = 0.1000000000000000D+21, 0, NONE FV(1).VLHI = 0.1000000000000000D+21, 0, NONE FV(1).VLLO = -0.1000000000000000D+21, 0, NONE MV(1).COST = 0.0000000000000000D+00, 0, NONE MV(1).CRITICAL = 0, 0, NONE MV(1).DCOST = 0.9999999747378752D-05, 0, NONE MV(1).DMAX = 0.1000000000000000D+21, 0, NONE MV(1).DMAXHI = 0.1000000000000000D+21, 0, NONE MV(1).DMAXLO = -0.1000000000000000D+21, 0, NONE MV(1).DPRED[1] = 0.0000000000000000D+00, 0, NONE MV(1).FSTATUS = 0.1000000000000000D+01, 0, NONE MV(1).LOWER = 0.1000000000000000D+01, 1, NONE MV(1).LSTVAL = 0.2000000000000000D+01, 1, NONE MV(1).MEAS = 0.2000000000000000D+01, 1, NONE MV(1).MV_STEP_HOR = 0, 0, NONE MV(1).NEWVAL = 0.2000000000000000D+01, 1, NONE MV(1).NXTVAL = 0.2000000000000000D+01, 1, NONE MV(1).OSTATUS[1] = 0, 0, NONE MV(1).OSTATUS[2] = 0, 0, NONE MV(1).OSTATUSCHG[1] = 0, 0, NONE MV(1).OSTATUSCHG[2] = 0, 0, NONE MV(1).PRED[0] = 0.2000000000000000D+01, 1, NONE MV(1).PRED[1] = 0.2000000000000000D+01, 1, NONE MV(1).PSTATUS = 1, 0, NONE MV(1).REQONCTRL = 0, 0, NONE MV(1).STATUS = 0, 0, NONE MV(1).UPPER = 0.3000000000000000D+01, 1, NONE MV(1).VDVL = 0.1000000000000000D+21, 0, NONE MV(1).VLHI = 0.1000000000000000D+21, 0, NONE MV(1).VLLO = -0.1000000000000000D+21, 0, NONE SV(1).CRITICAL = 0, 0, NONE SV(1).FSTATUS = 0.1000000000000000D+01, 0, NONE SV(1).FDELAY = 0, 0, NONE SV(1).LOWER = -0.1000000000000000D+21, 1, NONE SV(1).LSTVAL = 0.5000000000000000D+01, 1, NONE SV(1).MEAS = 0.1000000000000000D+01, 0, NONE SV(1).MEAS_GAP = 0.1000000000000000D+01, 0, NONE SV(1).MODEL = 0.5000000000000000D+01, 1, NONE SV(1).OBJPCT = 0.0000000000000000D+00, 1, NONE SV(1).OSTATUS[1] = 0, 0, NONE SV(1).OSTATUS[2] = 0, 0, NONE SV(1).OSTATUSCHG[1] = 0, 0, NONE SV(1).OSTATUSCHG[2] = 0, 0, NONE SV(1).PRED[0] = 0.5000000000000000D+01, 1, NONE SV(1).PRED[1] = 0.5000000000000000D+01, 1, NONE SV(1).PSTATUS = 1, 0, NONE SV(1).UPPER = 0.1000000000000000D+21, 1, NONE SV(1).VDVL = 0.1000000000000000D+21, 0, NONE SV(1).VLHI = 0.1000000000000000D+21, 0, NONE SV(1).VLLO = -0.1000000000000000D+21, 0, NONE SV(1).WMEAS = 0.2000000000000000D+02, 0, NONE SV(1).WMODEL = 0.2000000000000000D+01, 0, NONE End DB_Variables
Deleted line 56:
Added lines 64-102:
- COST
- CRITICAL
- DCOST
- DMAX
- DMAXHI
- DMAXLO
- DPRED
- FSTATUS
- FDELAY
- LOWER
- LSTVAL
- MEAS
- MEAS_GAP
- MODEL
- MV_STEP_HOR
- NEWVAL
- NXTVAL
- OBJPCT
- OSTATUS
- OSTATUSCHG
- PRED
- PSTATUS
- REQONCTRL
- SP
- SPHI
- SPLO
- STATUS
- TAU
- TR_OPEN
- TR_INIT UPPER
- VDVL
- VLHI
- VLLO
- WMEAS
- WMODEL
- WSP
- WSPHI
- WSPLO
Changed lines 65-415 from:
COST
Type: Real Default Value: 0.0 Data Flow: Input Description: Cost weight: (+)=minimize, (-)=maximize
CRITICAL
Type: Integer Default Value: 0 Data Flow: Input Description: Critical: 0=OFF, 1=ON'
DCOST
Type: Real Default Value: 0.00001 Data Flow: Input Description: Delta cost penalty for MV movement
DMAX
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Delta MV maximum step per horizon interval
DMAXHI
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Delta MV positive maximum step per horizon interval
DMAXLO
Type: Real Default Value: -1.0e20 Data Flow: Input Description: Delta MV negative maximum step per horizon interval
DPRED
Type: Real Default Value: 0.0 Data Flow: Output Description: Delta prediction changes for each step'
FSTATUS
Type: Real Default Value: 1.0 Data Flow: Input Description: Feedback status: 1=ON, 0=OFF
FDELAY
Type: Integer Default Value: 0 Data Flow: Input Description: Feedback delay: 0=No Delay, >=1 horizon steps for delay
LOWER
Type: Real Default Value: -1.0e20 Data Flow: Input Description: Lower bound
LSTVAL
Type: Real Default Value: 1.0 Data Flow: Output Description: Last value from previous solution
MEAS
Type: Real Default Value: 1.0 Data Flow: Input Description: Measured value
MEAS_GAP
Type: Real Default Value: 1.0 Data Flow: Input Description: Deadband for noise rejection of measurements in MHE
MODEL
Type: Real Default Value: 1.0 Data Flow: Output Description: Model predicted value
MV_STEP_HOR
Type: Integer Default Value: 1 (for NLC.MV_STEP_HOR) or 0 (for MV(#).MV_STEP_HOR) Data Flow: Input Description: Step length for manipulated variables: 0 uses NLC.MV_STEP_HOR as default
NEWVAL
Type: Real Default Value: 1.0 Data Flow: Output Description: New value implemented by the estimator or controller (NEWVAL = MEAS when not in control)
NXTVAL
Type: Real Default Value: 1.0 Data Flow: Output Description: Next value that the estimator or controller would implement were it on
OBJPCT
Type: Real Default Value: 0.0 Data Flow: Output Description: Percent of objective function contibution considering all SV and CV variables
OSTATUS
Type: Integer Default Value: 0 Data Flow: Input and Output Description: Bit encoding for status messages
OSTATUSCHG
Type: Integer Default Value: 0 Data Flow: Input Description: Change in bit encoding for status messages
PRED
Type: Real Default Value: 1.0 Data Flow: Output Description: Prediction horizon
PSTATUS
Type: Integer Default Value: 1 Data Flow: Input Description: Instrument status: 1=GOOD, 0=BAD
REQONCTRL
Type: Integer Default Value: 0 Data Flow: Input Description: Required for control mode to be ON (3): 1=ON, 0=OFF
SP
Type: Real Default Value: 0.0 Data Flow: Input Description: Set point for squared error model
SPHI
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Set point high for linear error model
SPLO
Type: Real Default Value: -1.0e20 Data Flow: Input Description: Set point low for linear error model
STATUS
Type: Integer Default Value: 0 Data Flow: Input Description: Status: 1=ON, 0=OFF
TAU
Type: Real Default Value: 60.0 Data Flow: Input Description: Time constant for controlled variable response
TR_OPEN
Type: Real Default Value: 1.0 Data Flow: Input Description: Initial trajectory opening ratio (0=ref traj, 1=tunnel, 2=funnel)
TR_INIT
Type: Integer Type: Real Default Value: 1 Data Flow: Input Description: Traj initialization (0=dead-band, 1=re-center with coldstart/out-of-service, 2=re-center always)
UPPER
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Upper bound
VDVL
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Delta validity limit
VLHI
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Upper validity limit
VLLO
Type: Real Default Value: -1.0e20 Data Flow: Input Description: Lower validity limit
WMEAS
Type: Real Default Value: 20.0 Data Flow: Input Description: Objective function weight on measured value
WMODEL
Type: Real Default Value: 2.0d0 Data Flow: Input Description: Objective function weight on model value
WSP
Type: Real Default Value: 1.0 Data Flow: Input Description: Objective function weight on set point for squared error model
WSPHI
Type: Real Default Value: 1.0 Data Flow: Input Description: Objective function weight on upper set point for linear error model
WSPLO
Type: Real Default Value: 1.0 Data Flow: Input Description: Objective function weight on lower set point for linear error model
to:
Changed lines 11-422 from:
NLC.APPINFO
Type: Integer Default Value: 0 Data Flow: Input and Output Description: Application information: 0=good, error otherwise
NLC.APPINFOCHG
Type: Integer Default Value: 0 Data Flow: Output Description: Application information change (new-old): 0=no change
NLC.APPSTATUS
Type: Integer Default Value: 1 Data Flow: Output Description: Application status: 1=good, 0=bad
NLC.BNDS_CHK
Type: Integer Default Value: 1 Data Flow: Input Description: Bounds checking: 1=ON, 0=OFF
NLC.COLDSTART
Type: Integer Default Value: 0 Data Flow: Input and Output Description: Cold start model: 0=warm start, 1=cold start
NLC.CSV_READ
Type: Integer Default Value: 0 Data Flow: Input Description: CSV read: 0=Off, 1=Batch, 2=Sequential
NLC.CSV_WRITE
Type: Integer Default Value: 0 Data Flow: Input Description: CSV write: 0=Off, 1=On
NLC.CTRLMODE
Type: Integer Default Value: 1 Data Flow: Output Description: Control mode: 1=simulate, 2=predict, 3=control
NLC.CTRL_HOR
Type: Integer Default Value: 1 Data Flow: Input Description: Control horizon: Horizon length where MVs can be adjusted by the solver
NLC.CTRL_TIME
Type: Real Default Value: 60 Data Flow: Input Description: Time for each step in the control horizon
NLC.CTRL_UNITS
Type: Integer Default Value: 1 Data Flow: Input Description: Model time units (1=sec, 2=min, 3=hrs, 4=days, 5=yrs)
NLC.CV_TYPE
Type: Integer Default Value: 1 Data Flow: Input Description: Controlled variable error model type: 1=linear, 2=squared, 3=ref traj
NLC.CV_WGT_SLOPE
Type: Real Default Value: 0.0 Data Flow: Input Description: Slope for weight on future CV error (e.g. [+] favors steady state)
NLC.CV_WGT_START
Type: Integer Default Value: 0 Data Flow: Input Description: Start interval for controlled variable error model weights
NLC.CYCLECOUNT
Type: Integer Default Value: 0 Data Flow: Input and Output Description: Cycle count, increments every cycle
NLC.DBS_READ
Type: Integer Default Value: 1 Data Flow: Input Description: Database read: 1=ON, 0=OFF
NLC.DBS_WRITE
Type: Integer Default Value: 1 Data Flow: Input Description: Database write: 1=ON, 0=OFF
NLC.DIAGLEVEL
Type: Integer Default Value: 0 Data Flow: Input Description: Diagnostic level: 0=none, 1=messages, 2=file checkpoints, 4=diagnostic files, 5=check 1st deriv
NLC.EV_TYPE
Type: Integer Default Value: 1 Data Flow: Input Description: Estimated variable error model type: 1=linear, 2=squared, 3=approximate linear
NLC.EV_WGT_SLOPE
Type: Real Default Value: 0.0 Data Flow: Input Description: Slope for weight on more cuurent EV error (e.g. favor near-term matching)
NLC.HIST_HOR
Type: Integer Default Value: 0 Data Flow: Input Description: History horizon (SIM and CTL only): Integer >= 0
NLC.HIST_UNITS
Type: Integer Default Value: 0 Data Flow: Input Description: History time units on plots only (0=same as CTRL_UNITS, 1=sec, 2=min, 3=hrs, 4=days, 5=yrs)
NLC.ICD_CALC
Type: Integer Default Value: 0 Data Flow: Input Description: Specifications for initial condition differentials (MHE only): 0=OFF, 1=ON
NLC.IMODE
Type: Integer Default Value: 3 Data Flow: Input Description: Model solution mode: 1=ss, 2=mpu, 3=rto, 4=sim, 5=est, 6=ctl
NLC.ITERATIONS
Type: Integer Default Value: 1 Data Flow: Output Description: Iterations for solution: >=1
NLC.MAX_ITER
Type: Integer Default Value: 25 Data Flow: Input Description: Maximum iteration: >=1
NLC.MAX_TIME
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Maximum run time in seconds
NLC.MEAS_CHK
Type: Integer Default Value: 1 Data Flow: Input Description: Measurement checking: 1=ON, 0=OFF
NLC.MV_DCOST_SLOPE
Type: Real Default Value: 0.1d0 Data Flow: Input Description: Slope for penalization on future MV moves (i.e. reduces controller procrastination)
NLC.MV_STEP_HOR
Type: Integer Default Value: 1 (for NLC.MV_STEP_HOR) or 0 (for MV(#).MV_STEP_HOR) Data Flow: Input Description: Step length for manipulated variables: 0 uses NLC.MV_STEP_HOR as default
NLC.MV_TYPE
Type: Integer Default Value: 0 Data Flow: Input Description: Manipulated variable type: 0=zero order hold, 1=linear
NLC.NODES
Type: Integer Default Value: 4 Data Flow: Input Description: Nodes in each horizon step
NLC.OBJFCNVAL
Type: Real Default Value: 0.0 Data Flow: Output Description: Objective function value
NLC.OTOL
Type: Real Default Value: 1.0e-6 Data Flow: Input Description: Objective function tolerance for successful solution
NLC.PRED_HOR
Type: Integer Default Value: 1.0 Data Flow: Input Description: Prediction horizon: Total horizon, including control horizon
NLC.PRED_TIME
Type: Real Default Value: 60.0 Data Flow: Input Description: Time for each step in the horizon
NLC.REQCTRLMODE
Type: Integer Default Value: 1 Data Flow: Input Description: Requested control mode: 1=simulate, 2=predict, 3=control
NLC.RTOL
Type: Real Default Value: 1.0e-6 Data Flow: Input Description: Equation solution tolerance
NLC.SOLVESTATUS
Type: Integer Default Value: 1 Data Flow: Output Description: Solution solve status: 1=good
NLC.SOLVER
Type: Integer Default Value: 3 Data Flow: Input Description: Solver options: 1=NOVA, 2=IPOPT-v2.3, 3=IPOPT-v3.5, 4=SNOPT, 5=MINOS
NLC.SOLVETIME
Type: Real Default Value: 1.0 Data Flow: Output Description: Solution time (seconds)
NLC.SPECS
Type: Integer Default Value: 1 Data Flow: Input Description: Secifications from restart file: 1=ON, 0=OFF
NLC.TIME_SHIFT
Type: Integer Default Value: 1 Data Flow: Input Description: Time shift for dynamic problems: 1=ON, 0=OFF
NLC.WEB
Type: Integer Default Value: 1 Data Flow: Input Description: Generate HTML pages: 1=ON, 0=OFF
NLC.WEB_MENU
Type: Integer Default Value: 1 Data Flow: Input Description: Generate HTML navigation menus: 1=ON, 0=OFF
NLC.WEB_REFRESH
Type: Integer Default Value: 10 Data Flow: Input Description: Automatic refresh rate on HTML pages (default 10 minutes)
to:
- NLC.APPINFO
- NLC.APPINFOCHG
- NLC.APPSTATUS
- NLC.BNDS_CHK
- NLC.COLDSTART
- NLC.CSV_READ
- NLC.CSV_WRITE
- NLC.CTRLMODE
- NLC.CTRL_HOR
- NLC.CTRL_TIME
- NLC.CTRL_UNITS
- NLC.CV_TYPE
- NLC.CV_WGT_SLOPE
- NLC.CV_WGT_START
- NLC.CYCLECOUNT
- NLC.DBS_READ
- NLC.DBS_WRITE
- NLC.DIAGLEVEL
- NLC.EV_TYPE
- NLC.EV_WGT_SLOPE
- NLC.HIST_HOR
- NLC.HIST_UNITS
- NLC.ICD_CALC
- NLC.IMODE
- NLC.ITERATIONS
- NLC.MAX_ITER
- NLC.MAX_TIME
- NLC.MEAS_CHK
- NLC.MV_DCOST_SLOPE
- NLC.MV_STEP_HOR
- NLC.MV_TYPE
- NLC.NODES
- NLC.OBJFCNVAL
- NLC.OTOL
- NLC.PRED_HOR
- NLC.PRED_TIME
- NLC.REQCTRLMODE
- NLC.RTOL
- NLC.SOLVESTATUS
- NLC.SOLVER
- NLC.SOLVETIME
- NLC.SPECS
- NLC.TIME_SHIFT
- NLC.WEB
- NLC.WEB_MENU
- NLC.WEB_REFRESH
Changed lines 3-5 from:
The database file contains options and model inputs for the current time instance.
to:
The database file contains options and model inputs. The following is an exhaustive list of the configuration parameters for NLC type and FV, MV, SV, CV type. Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and description.
Changed lines 7-8 from:
APPINFO
to:
DBS Parameters for Configuration
The configuration parameters before the model is parsed or data is input into the model structure. These parameters are read regardless of the value of NLC.DBS_READ. When NLC.DBS_READ = 0 (OFF) only the parameters associated with variables are skipped.
NLC.APPINFO
Changed lines 22-23 from:
APPINFOCHG
to:
NLC.APPINFOCHG
Changed line 31 from:
APPSTATUS
to:
NLC.APPSTATUS
Changed lines 39-40 from:
BNDS_CHK
to:
NLC.BNDS_CHK
Changed lines 48-49 from:
COLDSTART
to:
NLC.COLDSTART
Changed lines 57-58 from:
CSV_READ
to:
NLC.CSV_READ
Changed lines 66-67 from:
CSV_WRITE
to:
NLC.CSV_WRITE
Changed lines 75-76 from:
CTRLMODE
to:
NLC.CTRLMODE
Changed lines 84-85 from:
CTRL_HOR
to:
NLC.CTRL_HOR
Changed lines 93-94 from:
CTRL_TIME
to:
NLC.CTRL_TIME
Changed lines 102-103 from:
CTRL_UNITS
to:
NLC.CTRL_UNITS
Changed lines 111-112 from:
CV_TYPE
to:
NLC.CV_TYPE
Changed lines 120-121 from:
CV_WGT_SLOPE
to:
NLC.CV_WGT_SLOPE
Changed lines 129-130 from:
CV_WGT_START
to:
NLC.CV_WGT_START
Changed lines 138-139 from:
CYCLECOUNT
to:
NLC.CYCLECOUNT
Changed lines 147-148 from:
DBS_READ
to:
NLC.DBS_READ
Changed lines 156-157 from:
DBS_WRITE
to:
NLC.DBS_WRITE
Changed lines 165-166 from:
DIAGLEVEL
to:
NLC.DIAGLEVEL
Changed lines 174-175 from:
EV_TYPE
to:
NLC.EV_TYPE
Changed lines 183-184 from:
EV_WGT_SLOPE
to:
NLC.EV_WGT_SLOPE
Changed lines 192-193 from:
HIST_HOR
to:
NLC.HIST_HOR
Changed lines 201-202 from:
HIST_UNITS
to:
NLC.HIST_UNITS
Changed lines 210-211 from:
ICD_CALC
to:
NLC.ICD_CALC
Changed lines 219-220 from:
IMODE
to:
NLC.IMODE
Changed lines 228-229 from:
ITERATIONS
to:
NLC.ITERATIONS
Changed lines 237-238 from:
MAX_ITER
to:
NLC.MAX_ITER
Changed lines 246-247 from:
MAX_TIME
to:
NLC.MAX_TIME
Changed lines 255-256 from:
MEAS_CHK
to:
NLC.MEAS_CHK
Changed lines 264-265 from:
MV_DCOST_SLOPE
to:
NLC.MV_DCOST_SLOPE
Changed lines 273-274 from:
MV_STEP_HOR
to:
NLC.MV_STEP_HOR
Changed lines 282-283 from:
MV_TYPE
to:
NLC.MV_TYPE
Changed lines 291-292 from:
NODES
to:
NLC.NODES
Changed lines 300-301 from:
OBJFCNVAL
to:
NLC.OBJFCNVAL
Changed lines 309-310 from:
OTOL
to:
NLC.OTOL
Changed lines 318-319 from:
PRED_HOR
to:
NLC.PRED_HOR
Changed lines 327-328 from:
PRED_TIME
to:
NLC.PRED_TIME
Changed lines 336-337 from:
REQCTRLMODE
to:
NLC.REQCTRLMODE
Changed lines 345-346 from:
RTOL
to:
NLC.RTOL
Changed lines 354-355 from:
SOLVESTATUS
to:
NLC.SOLVESTATUS
Changed lines 363-364 from:
SOLVER
to:
NLC.SOLVER
Changed lines 372-373 from:
SOLVETIME
to:
NLC.SOLVETIME
Changed lines 381-382 from:
SPECS
to:
NLC.SPECS
Changed lines 390-391 from:
TIME_SHIFT
to:
NLC.TIME_SHIFT
Changed lines 399-400 from:
WEB
to:
NLC.WEB
Changed lines 408-409 from:
WEB_MENU
to:
NLC.WEB_MENU
Changed lines 417-418 from:
WEB_REFRESH
to:
NLC.WEB_REFRESH
Deleted lines 423-426:
Added lines 426-431:
FV, MV, SV, and CV Parameters
The variable parameters are associated only with variables declared in the INFO file. They are not read when NLC.DBS_READ = 0 (OFF).
Changed lines 438-439 from:
basic = 1
to:
Changed lines 447-448 from:
CASE ('DCOST
to:
DCOST
Changed lines 456-457 from:
basic = 1
to:
Changed lines 465-466 from:
basic = 1
to:
Changed lines 474-475 from:
basic = 1
to:
Changed lines 483-484 from:
basic = 1
to:
Changed lines 501-502 from:
basic = 1
to:
Changed lines 519-520 from:
basic = 1
to:
Changed lines 537-538 from:
basic = 1
to:
Changed lines 555-556 from:
basic = 1
to:
Added lines 558-566:
MV_STEP_HOR
Type: Integer Default Value: 1 (for NLC.MV_STEP_HOR) or 0 (for MV(#).MV_STEP_HOR) Data Flow: Input Description: Step length for manipulated variables: 0 uses NLC.MV_STEP_HOR as default
Changed lines 573-574 from:
basic = 1
to:
Changed lines 645-646 from:
basic = 1
to:
Changed lines 654-655 from:
basic = 1
to:
Changed lines 663-664 from:
basic = 1
to:
Changed lines 672-673 from:
basic = 1
to:
Changed lines 681-682 from:
basic = 1
to:
Deleted line 708:
basic = 1
Changed lines 6-7 from:
---
to:
Changed lines 15-16 from:
---
to:
Changed lines 24-25 from:
---
to:
Changed lines 32-33 from:
---
to:
Changed lines 41-42 from:
---
to:
Changed lines 50-51 from:
---
to:
Changed lines 59-60 from:
---
to:
Changed lines 68-69 from:
---
to:
Changed lines 77-78 from:
---
to:
Changed lines 86-87 from:
---
to:
Changed lines 95-96 from:
---
to:
Changed lines 104-105 from:
---
to:
Changed lines 113-114 from:
---
to:
Changed lines 122-123 from:
---
to:
Changed lines 131-132 from:
---
to:
Changed lines 140-141 from:
---
to:
Changed lines 149-150 from:
---
to:
Changed lines 158-159 from:
---
to:
Changed lines 167-168 from:
---
to:
Changed lines 176-177 from:
---
to:
Changed lines 185-186 from:
---
to:
Changed lines 194-195 from:
---
to:
Changed lines 203-204 from:
---
to:
Changed lines 212-213 from:
---
to:
Changed lines 221-222 from:
---
to:
Changed lines 230-231 from:
---
to:
Changed lines 239-240 from:
---
to:
Changed lines 248-249 from:
---
to:
Changed lines 257-258 from:
---
to:
Changed lines 266-267 from:
---
to:
Changed lines 275-276 from:
---
to:
Changed lines 284-285 from:
---
to:
Changed lines 293-294 from:
---
to:
Changed lines 302-303 from:
---
to:
Changed lines 311-312 from:
---
to:
Changed lines 320-321 from:
---
to:
Changed lines 329-330 from:
---
to:
Changed lines 338-339 from:
---
to:
Changed lines 347-348 from:
---
to:
Changed lines 356-357 from:
---
to:
Changed lines 365-366 from:
---
to:
Changed lines 374-375 from:
---
to:
Changed lines 383-384 from:
---
to:
Changed lines 392-393 from:
---
to:
Changed lines 401-402 from:
---
to:
Changed lines 410-411 from:
---
to:
Changed lines 423-424 from:
---
to:
Changed lines 433-434 from:
---
to:
Changed lines 449-450 from:
---
to:
Changed lines 459-460 from:
---
to:
Changed lines 469-470 from:
---
to:
Changed lines 479-480 from:
---
to:
Changed lines 488-489 from:
---
to:
Changed lines 498-499 from:
---
to:
Changed lines 507-508 from:
---
to:
Changed lines 517-518 from:
---
to:
Changed lines 526-527 from:
---
to:
Changed lines 536-537 from:
---
to:
Changed lines 545-546 from:
---
to:
Changed lines 555-556 from:
---
to:
Changed lines 565-566 from:
---
to:
Changed lines 574-575 from:
---
to:
Changed lines 583-584 from:
---
to:
Changed lines 592-593 from:
---
to:
Changed lines 601-602 from:
---
to:
Changed lines 610-611 from:
---
to:
Changed lines 619-620 from:
---
to:
Changed lines 628-629 from:
---
to:
Changed lines 638-639 from:
---
to:
Changed lines 648-649 from:
---
to:
Changed lines 658-659 from:
---
to:
Changed lines 668-669 from:
---
to:
Changed lines 678-679 from:
---
to:
Changed lines 687-688 from:
---
to:
Changed lines 697-698 from:
---
to:
Changed lines 707-708 from:
---
to:
Changed lines 716-717 from:
---
to:
Changed lines 725-726 from:
---
to:
Changed lines 734-735 from:
---
to:
Changed lines 743-744 from:
---
to:
Changed lines 752-753 from:
---
to:
Changed lines 761-762 from:
---
to:
Changed line 770 from:
---
to:
Added lines 1-777:
DBS - Database File
The database file contains options and model inputs for the current time instance.
---
APPINFO
Type: Integer Default Value: 0 Data Flow: Input and Output Description: Application information: 0=good, error otherwise
---
APPINFOCHG
Type: Integer Default Value: 0 Data Flow: Output Description: Application information change (new-old): 0=no change
---
APPSTATUS
Type: Integer Default Value: 1 Data Flow: Output Description: Application status: 1=good, 0=bad
---
BNDS_CHK
Type: Integer Default Value: 1 Data Flow: Input Description: Bounds checking: 1=ON, 0=OFF
---
COLDSTART
Type: Integer Default Value: 0 Data Flow: Input and Output Description: Cold start model: 0=warm start, 1=cold start
---
CSV_READ
Type: Integer Default Value: 0 Data Flow: Input Description: CSV read: 0=Off, 1=Batch, 2=Sequential
---
CSV_WRITE
Type: Integer Default Value: 0 Data Flow: Input Description: CSV write: 0=Off, 1=On
---
CTRLMODE
Type: Integer Default Value: 1 Data Flow: Output Description: Control mode: 1=simulate, 2=predict, 3=control
---
CTRL_HOR
Type: Integer Default Value: 1 Data Flow: Input Description: Control horizon: Horizon length where MVs can be adjusted by the solver
---
CTRL_TIME
Type: Real Default Value: 60 Data Flow: Input Description: Time for each step in the control horizon
---
CTRL_UNITS
Type: Integer Default Value: 1 Data Flow: Input Description: Model time units (1=sec, 2=min, 3=hrs, 4=days, 5=yrs)
---
CV_TYPE
Type: Integer Default Value: 1 Data Flow: Input Description: Controlled variable error model type: 1=linear, 2=squared, 3=ref traj
---
CV_WGT_SLOPE
Type: Real Default Value: 0.0 Data Flow: Input Description: Slope for weight on future CV error (e.g. [+] favors steady state)
---
CV_WGT_START
Type: Integer Default Value: 0 Data Flow: Input Description: Start interval for controlled variable error model weights
---
CYCLECOUNT
Type: Integer Default Value: 0 Data Flow: Input and Output Description: Cycle count, increments every cycle
---
DBS_READ
Type: Integer Default Value: 1 Data Flow: Input Description: Database read: 1=ON, 0=OFF
---
DBS_WRITE
Type: Integer Default Value: 1 Data Flow: Input Description: Database write: 1=ON, 0=OFF
---
DIAGLEVEL
Type: Integer Default Value: 0 Data Flow: Input Description: Diagnostic level: 0=none, 1=messages, 2=file checkpoints, 4=diagnostic files, 5=check 1st deriv
---
EV_TYPE
Type: Integer Default Value: 1 Data Flow: Input Description: Estimated variable error model type: 1=linear, 2=squared, 3=approximate linear
---
EV_WGT_SLOPE
Type: Real Default Value: 0.0 Data Flow: Input Description: Slope for weight on more cuurent EV error (e.g. favor near-term matching)
---
HIST_HOR
Type: Integer Default Value: 0 Data Flow: Input Description: History horizon (SIM and CTL only): Integer >= 0
---
HIST_UNITS
Type: Integer Default Value: 0 Data Flow: Input Description: History time units on plots only (0=same as CTRL_UNITS, 1=sec, 2=min, 3=hrs, 4=days, 5=yrs)
---
ICD_CALC
Type: Integer Default Value: 0 Data Flow: Input Description: Specifications for initial condition differentials (MHE only): 0=OFF, 1=ON
---
IMODE
Type: Integer Default Value: 3 Data Flow: Input Description: Model solution mode: 1=ss, 2=mpu, 3=rto, 4=sim, 5=est, 6=ctl
---
ITERATIONS
Type: Integer Default Value: 1 Data Flow: Output Description: Iterations for solution: >=1
---
MAX_ITER
Type: Integer Default Value: 25 Data Flow: Input Description: Maximum iteration: >=1
---
MAX_TIME
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Maximum run time in seconds
---
MEAS_CHK
Type: Integer Default Value: 1 Data Flow: Input Description: Measurement checking: 1=ON, 0=OFF
---
MV_DCOST_SLOPE
Type: Real Default Value: 0.1d0 Data Flow: Input Description: Slope for penalization on future MV moves (i.e. reduces controller procrastination)
---
MV_STEP_HOR
Type: Integer Default Value: 1 (for NLC.MV_STEP_HOR) or 0 (for MV(#).MV_STEP_HOR) Data Flow: Input Description: Step length for manipulated variables: 0 uses NLC.MV_STEP_HOR as default
---
MV_TYPE
Type: Integer Default Value: 0 Data Flow: Input Description: Manipulated variable type: 0=zero order hold, 1=linear
---
NODES
Type: Integer Default Value: 4 Data Flow: Input Description: Nodes in each horizon step
---
OBJFCNVAL
Type: Real Default Value: 0.0 Data Flow: Output Description: Objective function value
---
OTOL
Type: Real Default Value: 1.0e-6 Data Flow: Input Description: Objective function tolerance for successful solution
---
PRED_HOR
Type: Integer Default Value: 1.0 Data Flow: Input Description: Prediction horizon: Total horizon, including control horizon
---
PRED_TIME
Type: Real Default Value: 60.0 Data Flow: Input Description: Time for each step in the horizon
---
REQCTRLMODE
Type: Integer Default Value: 1 Data Flow: Input Description: Requested control mode: 1=simulate, 2=predict, 3=control
---
RTOL
Type: Real Default Value: 1.0e-6 Data Flow: Input Description: Equation solution tolerance
---
SOLVESTATUS
Type: Integer Default Value: 1 Data Flow: Output Description: Solution solve status: 1=good
---
SOLVER
Type: Integer Default Value: 3 Data Flow: Input Description: Solver options: 1=NOVA, 2=IPOPT-v2.3, 3=IPOPT-v3.5, 4=SNOPT, 5=MINOS
---
SOLVETIME
Type: Real Default Value: 1.0 Data Flow: Output Description: Solution time (seconds)
---
SPECS
Type: Integer Default Value: 1 Data Flow: Input Description: Secifications from restart file: 1=ON, 0=OFF
---
TIME_SHIFT
Type: Integer Default Value: 1 Data Flow: Input Description: Time shift for dynamic problems: 1=ON, 0=OFF
---
WEB
Type: Integer Default Value: 1 Data Flow: Input Description: Generate HTML pages: 1=ON, 0=OFF
---
WEB_MENU
Type: Integer Default Value: 1 Data Flow: Input Description: Generate HTML navigation menus: 1=ON, 0=OFF
---
WEB_REFRESH
Type: Integer Default Value: 10 Data Flow: Input Description: Automatic refresh rate on HTML pages (default 10 minutes)
---
COST
Type: Real
Default Value: 0.0
Data Flow: Input
Description: Cost weight: (+)=minimize, (-)=maximize
basic = 1
---
CRITICAL
Type: Integer
Default Value: 0
Data Flow: Input
Description: Critical: 0=OFF, 1=ON'
CASE ('DCOST
Type: Real
Default Value: 0.00001
Data Flow: Input
Description: Delta cost penalty for MV movement
basic = 1
---
DMAX
Type: Real
Default Value: 1.0e20
Data Flow: Input
Description: Delta MV maximum step per horizon interval
basic = 1
---
DMAXHI
Type: Real
Default Value: 1.0e20
Data Flow: Input
Description: Delta MV positive maximum step per horizon interval
basic = 1
---
DMAXLO
Type: Real
Default Value: -1.0e20
Data Flow: Input
Description: Delta MV negative maximum step per horizon interval
basic = 1
---
DPRED
Type: Real Default Value: 0.0 Data Flow: Output Description: Delta prediction changes for each step'
---
FSTATUS
Type: Real
Default Value: 1.0
Data Flow: Input
Description: Feedback status: 1=ON, 0=OFF
basic = 1
---
FDELAY
Type: Integer Default Value: 0 Data Flow: Input Description: Feedback delay: 0=No Delay, >=1 horizon steps for delay
---
LOWER
Type: Real
Default Value: -1.0e20
Data Flow: Input
Description: Lower bound
basic = 1
---
LSTVAL
Type: Real Default Value: 1.0 Data Flow: Output Description: Last value from previous solution
---
MEAS
Type: Real
Default Value: 1.0
Data Flow: Input
Description: Measured value
basic = 1
---
MEAS_GAP
Type: Real Default Value: 1.0 Data Flow: Input Description: Deadband for noise rejection of measurements in MHE
---
MODEL
Type: Real
Default Value: 1.0
Data Flow: Output
Description: Model predicted value
basic = 1
---
NEWVAL
Type: Real
Default Value: 1.0
Data Flow: Output
Description: New value implemented by the estimator or controller (NEWVAL = MEAS when not in control)
basic = 1
---
NXTVAL
Type: Real Default Value: 1.0 Data Flow: Output Description: Next value that the estimator or controller would implement were it on
---
OBJPCT
Type: Real Default Value: 0.0 Data Flow: Output Description: Percent of objective function contibution considering all SV and CV variables
---
OSTATUS
Type: Integer Default Value: 0 Data Flow: Input and Output Description: Bit encoding for status messages
---
OSTATUSCHG
Type: Integer Default Value: 0 Data Flow: Input Description: Change in bit encoding for status messages
---
PRED
Type: Real Default Value: 1.0 Data Flow: Output Description: Prediction horizon
---
PSTATUS
Type: Integer Default Value: 1 Data Flow: Input Description: Instrument status: 1=GOOD, 0=BAD
---
REQONCTRL
Type: Integer Default Value: 0 Data Flow: Input Description: Required for control mode to be ON (3): 1=ON, 0=OFF
---
SP
Type: Real
Default Value: 0.0
Data Flow: Input
Description: Set point for squared error model
basic = 1
---
SPHI
Type: Real
Default Value: 1.0e20
Data Flow: Input
Description: Set point high for linear error model
basic = 1
---
SPLO
Type: Real
Default Value: -1.0e20
Data Flow: Input
Description: Set point low for linear error model
basic = 1
---
STATUS
Type: Integer
Default Value: 0
Data Flow: Input
Description: Status: 1=ON, 0=OFF
basic = 1
---
TAU
Type: Real
Default Value: 60.0
Data Flow: Input
Description: Time constant for controlled variable response
basic = 1
---
TR_OPEN
Type: Real Default Value: 1.0 Data Flow: Input Description: Initial trajectory opening ratio (0=ref traj, 1=tunnel, 2=funnel)
---
TR_INIT
Type: Integer Type: Real Default Value: 1 Data Flow: Input Description: Traj initialization (0=dead-band, 1=re-center with coldstart/out-of-service, 2=re-center always)
---
UPPER
Type: Real
Default Value: 1.0e20
Data Flow: Input
Description: Upper bound
basic = 1
---
VDVL
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Delta validity limit
---
VLHI
Type: Real Default Value: 1.0e20 Data Flow: Input Description: Upper validity limit
---
VLLO
Type: Real Default Value: -1.0e20 Data Flow: Input Description: Lower validity limit
---
WMEAS
Type: Real Default Value: 20.0 Data Flow: Input Description: Objective function weight on measured value
---
WMODEL
Type: Real Default Value: 2.0d0 Data Flow: Input Description: Objective function weight on model value
---
WSP
Type: Real Default Value: 1.0 Data Flow: Input Description: Objective function weight on set point for squared error model
---
WSPHI
Type: Real Default Value: 1.0 Data Flow: Input Description: Objective function weight on upper set point for linear error model
---
WSPLO
Type: Real Default Value: 1.0 Data Flow: Input Description: Objective function weight on lower set point for linear error model