Main

APMonitor Global Options

Main.DbsGlobal History

Hide minor edits - Show changes to output

June 08, 2017, at 08:44 PM by 10.5.113.159 -
Changed line 5 from:
%width=30px%Attach:apm.png [[Main/DbsGlobal|Global Options]] | %width=30px%Attach:fv.png %width=30px%Attach:mv.png %width=30px%Attach:sv.png %width=30px%Attach:cv.png[[Main/DbsVariable|Local Options]]
to:
%width=50px%Attach:apm.png [[Main/DbsGlobal|Global Options]] | %width=30px%Attach:fv.png %width=30px%Attach:mv.png %width=30px%Attach:sv.png %width=30px%Attach:cv.png[[Main/DbsVariable|Local Options]]
June 08, 2017, at 05:51 PM by 10.5.113.159 -
Changed line 1 from:
(:title Global Options (APM):)
to:
(:title APMonitor Global Options:)
June 08, 2017, at 05:45 PM by 10.5.113.159 -
Changed line 5 from:
%width=30px%Attach:apm.png [[Main/DbsGlobal|Global Options]] | [[Main/DbsVariable|Local Options]]
to:
%width=30px%Attach:apm.png [[Main/DbsGlobal|Global Options]] | %width=30px%Attach:fv.png %width=30px%Attach:mv.png %width=30px%Attach:sv.png %width=30px%Attach:cv.png[[Main/DbsVariable|Local Options]]
June 08, 2017, at 05:44 PM by 10.5.113.159 -
Changed line 5 from:
%width=50px%Attach:apm.png [[Main/DbsVariable|Local Options]]
to:
%width=30px%Attach:apm.png [[Main/DbsGlobal|Global Options]] | [[Main/DbsVariable|Local Options]]
June 08, 2017, at 05:43 PM by 10.5.113.159 -
Changed line 5 from:
%width=50px%Attach:apm.png [[Main/DbsVariable|Local Options]] | [[Main/DbsGlobal|Global Options]]
to:
%width=50px%Attach:apm.png [[Main/DbsVariable|Local Options]]
June 08, 2017, at 05:42 PM by 10.5.113.159 -
Changed lines 5-7 from:
%width=50px%Attach:apm.png Global options in APMonitor configure and report application level information. Global options begin with the prefix APM. There are also [[Main/DbsVariable|Local Options]] that configure and report parameters associated with individual variables or parameters. Below is a list of all global options.
to:
%width=50px%Attach:apm.png [[Main/DbsVariable|Local Options]] | [[Main/DbsGlobal|Global Options]]

Global options in APMonitor configure and report application level information. Global options begin with the prefix APM. There are also [[Main/DbsVariable|Local Options]] that configure and report parameters associated with individual variables or parameters. Below is a list of all global options.
June 08, 2017, at 05:29 PM by 10.5.113.159 -
Changed lines 5-18 from:
%width=50px%Attach:apm.png An option can be changed from a MATLAB or Python script. Below is a command to set an option to run the model as a Nonlinear Control application with [[Main/OptionApmImode|APM.IMODE]]=6.

 apm_option(s,
a,'apm.imode',6)

Output options can also be read after the solution with the command to access a ''tag'' from the database
. If the tag does not exist, a value of -99999 is returned. In this case, the user wants to know if the application was solved successfully by retrieving the [[Main/OptionApmAppstatus|APM.APPSTATUS]] value.

 success_check = apm_tag(s,a,'apm.appstatus')

In this case, the argument ''s='http://byu.apmonitor.com' '' is the server address and ''a='myApp' '' is the application name. When running a local server, the server address should be changed to ''s='http://127.0.0.1' '' or ''s='http://localhost' ''.

The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description. While this list is exhaustive, there are typically only a few of these that are used most commonly for [[http://apmonitor.com/do/index.php/Main/EstimatorTuning|estimation]] and [[http://apmonitor.com/do/index.php/Main/ControllerTuning|control]].

----

to:
%width=50px%Attach:apm.png Global options in APMonitor configure and report application level information. Global options begin with the prefix APM. There are also [[Main/DbsVariable|Local Options]] that configure and report parameters associated with individual variables or parameters. Below is a list of all global options.
Changed lines 69-80 from:
----
to:
An option can be changed from a MATLAB or Python script. Below is a command to set an option to run the model as a Nonlinear Control application with [[Main/OptionApmImode|APM.IMODE]]=6.

 apm_option(s,a,'apm.imode',6)

Output options can also be read after the solution with the command to access a ''tag'' from the database. If the tag does not exist, a value of
-99999 is returned. In this case, the user wants to know if the application was solved successfully by retrieving the [[Main/OptionApmAppstatus|APM.APPSTATUS]] value.

 success_check = apm_tag(s,a,'apm.appstatus')

In this case, the argument ''s='http://byu.apmonitor.com' '' is the server address and ''a='myApp' '' is the application name. When running a local server, the server address should be changed to ''s='http://127.0.0.1' '' or ''s='http://localhost' ''.

The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description. While this list is exhaustive, there are typically only a few of these that are used most commonly for [[http://apmonitor.com/do/index.php/Main/EstimatorTuning|estimation]] and [[http://apmonitor.com/do/index.php/Main/ControllerTuning|control]].

June 02, 2017, at 06:01 AM by 45.56.3.173 -
June 02, 2017, at 06:00 AM by 45.56.3.173 -
Changed lines 5-6 from:
%width=50px%Attach:apm.png An option can be changed from a MATLAB or Python script. Below is a command to set an option to run the model as a Nonlinear Control application with [[Main/OptionsApmImode|APM.IMODE]]=6.
to:
%width=50px%Attach:apm.png An option can be changed from a MATLAB or Python script. Below is a command to set an option to run the model as a Nonlinear Control application with [[Main/OptionApmImode|APM.IMODE]]=6.
Changed line 9 from:
Output options can also be read after the solution with the command to access a ''tag'' from the database. If the tag does not exist, a value of -99999 is returned. In this case, the user wants to know if the application was solved successfully by retrieving the [[Main/OptionsApmAppstatus|APM.APPSTATUS]] value.
to:
Output options can also be read after the solution with the command to access a ''tag'' from the database. If the tag does not exist, a value of -99999 is returned. In this case, the user wants to know if the application was solved successfully by retrieving the [[Main/OptionApmAppstatus|APM.APPSTATUS]] value.
June 02, 2017, at 06:00 AM by 45.56.3.173 -
June 02, 2017, at 05:59 AM by 45.56.3.173 -
Changed lines 5-10 from:
%width=50px%Attach:apm.png An option can be changed from a MATLAB or Python script. An example command to define one of the options is

 apm_option(s,
a,'apm.imode',5)

Output options can also be read after the solution with the
command
to:
%width=50px%Attach:apm.png An option can be changed from a MATLAB or Python script. Below is a command to set an option to run the model as a Nonlinear Control application with [[Main/OptionsApmImode|APM.IMODE]]=6.

 apm_option(s,a,'apm.imode',6)

Output options can also be read after the solution with the
command to access a ''tag'' from the database. If the tag does not exist, a value of -99999 is returned. In this case, the user wants to know if the application was solved successfully by retrieving the [[Main/OptionsApmAppstatus|APM.APPSTATUS]] value.
Changed line 13 from:
In this case, the argument ''s='http://byu.apmonitor.com' '' is the server address and ''a='myApp' '' is the application name.
to:
In this case, the argument ''s='http://byu.apmonitor.com' '' is the server address and ''a='myApp' '' is the application name. When running a local server, the server address should be changed to ''s='http://127.0.0.1' '' or ''s='http://localhost' ''.
June 02, 2017, at 05:51 AM by 45.56.3.173 -
Changed lines 5-8 from:
%width=50px%Attach:apm.png  The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description. While this list is exhaustive, there are typically only a few of these that are used most commonly for [[http://apmonitor.com/do/index.php/Main/EstimatorTuning|estimation]] and [[http://apmonitor.com/do/index.php/Main/ControllerTuning|control]].

An option can be changed from a MATLAB or Python script. An example command to define one of the options is
to:
%width=50px%Attach:apm.png An option can be changed from a MATLAB or Python script. An example command to define one of the options is
Added lines 15-18:
The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description. While this list is exhaustive, there are typically only a few of these that are used most commonly for [[http://apmonitor.com/do/index.php/Main/EstimatorTuning|estimation]] and [[http://apmonitor.com/do/index.php/Main/ControllerTuning|control]].

----

Added line 81:
----
June 02, 2017, at 05:50 AM by 45.56.3.173 -
Changed lines 7-15 from:
An option can be changed from a MATLAB or Python script. An example command to define one of the options is ''apm_option(s,a,'apm.imode',5)''. Output options can also be read after the solution with the command ''apm_tag(s,a,'apm.appstatus')''. In this case, the argument ''s='http://byu.apmonitor.com' '' is the server address and ''a='myApp' '' is the application name.
to:
An option can be changed from a MATLAB or Python script. An example command to define one of the options is

 
apm_option(s,a,'apm.imode',5)

Output options can also be read after the solution with the command

 success
_check = apm_tag(s,a,'apm.appstatus')

In this case, the argument ''s='http://byu.apmonitor.com' '' is the server address and ''a='myApp' '' is the application name.
June 02, 2017, at 05:49 AM by 45.56.3.173 -
Changed lines 7-14 from:

Objective Functions:
Estimation (EV_Type): http://apmonitor.com/do/index.php/Main/EstimatorObjective
Control (CV_Type): http://apmonitor
.com/do/index.php/Main/ControllerObjective
Local Options: DBS Parameters for Variables
 

An option can be changed from
a MATLAB or Python script. An example command to define one of the options is ''apm_option(s,a,'apm.imode',5)''. Output options can also be read after the solution with the command ''apm_tag(s,a,'apm.appstatus')''. In this case, the argument ''s='http://byu.apmonitor.com''' is the server address and ''a='myApp''' is the application name.
to:
An option can be changed from a MATLAB or Python script. An example command to define one of the options is ''apm_option(s,a,'apm.imode',5)''. Output options can also be read after the solution with the command ''apm_tag(s,a,'apm.appstatus')''. In this case, the argument ''s='http://byu.apmonitor.com' '' is the server address and ''a='myApp' '' is the application name.
June 02, 2017, at 05:48 AM by 45.56.3.173 -
Changed lines 5-14 from:
%width=50px%Attach:apm.png  The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description.
to:
%width=50px%Attach:apm.png  The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description. While this list is exhaustive, there are typically only a few of these that are used most commonly for [[http://apmonitor.com/do/index.php/Main/EstimatorTuning|estimation]] and [[http://apmonitor.com/do/index.php/Main/ControllerTuning|control]].


Objective Functions:
Estimation (EV_Type): http://apmonitor.com/do/index.php/Main/EstimatorObjective
Control (CV_Type): http://apmonitor.com/do/index.php/Main/ControllerObjective
Local Options: DBS Parameters for Variables
 

An option can be changed from a MATLAB or Python script. An example command to define one of the options is ''apm_option(s,a,'apm.imode',5)''. Output options can also be read after the solution with the command ''apm_tag(s,a,'apm.appstatus')''. In this case, the argument ''s='http://byu.apmonitor.com''' is the server address and ''a='myApp''' is the application name
.
June 01, 2017, at 08:01 PM by 45.56.3.173 -
Deleted lines 68-586:
----

!!! APM.APPINFO

 Type: Integer
 Default Value: 0
 Data Flow: Input and Output
 Description: Application information: 0=good, error otherwise

----

!!! APM.APPINFOCHG

 Type: Integer
 Default Value: 0
 Data Flow: Output
 Description: Application information change (new-old)
              0=no change

----

!!! APM.APPSTATUS
 Type: Integer
 Default Value: 1
 Data Flow: Output
 Description: Application status: 1=good, 0=bad

----

!!! APM.BNDS_CHK

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Bounds checking: 1=ON, 0=OFF

----

!!! APM.COLDSTART

 Type: Integer
 Default Value: 0
 Data Flow: Input and Output
 Description: Cold start model
              0=warm start
              1=cold start
              2=decompose problem

----

!!! APM.CSV_READ

 Type: Integer
 Default Value: 0
 Data Flow: Input
 Description: CSV read
              0=Off
              1=Batch
              2=Sequential

----

!!! APM.CSV_WRITE

 Type: Integer
 Default Value: 0
 Data Flow: Input
 Description: CSV write
              0=Off
              1=Write results.csv
              2=Write results_all.csv

----

!!! APM.CTRLMODE

 Type: Integer
 Default Value: 1
 Data Flow: Output
 Description: Control mode
              1=simulate
              2=predict
              3=control

----

!!! APM.CTRL_HOR

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Control horizon length where MVs
              can be adjusted by the solver

----

!!! APM.CTRL_TIME

 Type: Real
 Default Value: 60
 Data Flow: Input
 Description: Time for each step in the control horizon

----

!!! APM.CTRL_UNITS

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Model time units
              1=seconds
              2=minutes
              3=hours
              4=days
              5=years

----

!!! APM.CV_TYPE

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Controlled variable error model type
              1=linear error with dead-band trajectory
              2=squared error to single trajectory
              3=nonlinear error approximates linear
                without slack variables

----

!!! APM.CV_WGT_SLOPE

 Type: Real
 Default Value: 0.0
 Data Flow: Input
 Description: Slope for weight on future CV error
              [+] favors future steady state target
              [-] favors near-term trajectory matching

----

!!! APM.CV_WGT_START

 Type: Integer
 Default Value: 0
 Data Flow: Input
 Description: Start interval for controlled variable
              error model weights

----

!!! APM.CYCLECOUNT

 Type: Integer
 Default Value: 0
 Data Flow: Input and Output
 Description: Cycle count, increments every cycle

----

!!! APM.DBS_READ

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Database read option
              0=OFF
              1={Name = Value, Status}
              2={Name = Value, Status, Units}

----

!!! APM.DBS_WRITE

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Database write
              0=OFF
              1={Name = Value, Status}
              2={Name = Value, Status, Units}

----

!!! APM.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 derivatives
              6=check 2nd derivatives

----

!!! APM.EV_TYPE

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Estimated variable error model type
              1=linear error
              2=squared error
              3=approximate linear error without
                slack variables

----

!!! APM.EV_WGT_SLOPE

 Type: Real
 Default Value: 0.0
 Data Flow: Input
 Description: Slope for weight on more cuurent EV error
              [+] favors matching of most recent data
              [-] favors matching of oldest horizon data

----

!!! APM.HIST_HOR

 Type: Integer
 Default Value: 0
 Data Flow: Input
 Description: History horizon for web-interface plots

----

!!! APM.HIST_UNITS

 Type: Integer
 Default Value: 0
 Data Flow: Input
 Description: History time units on plots only
              0=same as CTRL_UNITS
              1=seconds
              2=minutes
              3=hours
              4=days
              5=years

----

!!! APM.ICD_CALC

 Type: Integer
 Default Value: 0
 Data Flow: Input
 Description: Specifications for initial condition
              differentials (MHE only): 0=OFF, 1=ON

----

!!! APM.IMODE

 Type: Integer
 Default Value: 3
 Data Flow: Input
 Description: Model solution mode
              1=ss, Simulation (steady state)
              2=mpu, Model parameter update (steady state)
              3=rto, Real time optimization (steady state)
              4=sim, Dynamic simulation (simultaneous)
              5=est, Dynamic estimation (simultaneous)
              6=ctl, Dynamic control (simultaneous)
              7=sqs, Dynamic simulation (sequential)
              8=sqe, Dynamic estimation (sequential)
              9=sqo, Dynamic control (sequential)

----

!!! APM.ITERATIONS

 Type: Integer
 Default Value: 1
 Data Flow: Output
 Description: Iterations for solution

----

!!! APM.MAX_ITER

 Type: Integer
 Default Value: 25
 Data Flow: Input
 Description: Maximum iterations

----

!!! APM.MAX_TIME

 Type: Real
 Default Value: 1.0e20
 Data Flow: Input
 Description: Maximum run time in seconds

----

!!! APM.MEAS_CHK

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Measurement checking: 1=ON, 0=OFF

----

!!! APM.MV_DCOST_SLOPE

 Type: Real
 Default Value: 0.1d0
 Data Flow: Input
 Description: Slope for penalization on future MV moves
              to reduce controller procrastination

----

!!! APM.MV_STEP_HOR

 Type: Integer
 Default Value: 1 (for APM.MV_STEP_HOR)
                0 (for MV(#).MV_STEP_HOR)
 Data Flow: Input
 Description: Step length for manipulated variables
              0 uses APM.MV_STEP_HOR as default

----

!!! APM.MV_TYPE

 Type: Integer
 Default Value: 0
 Data Flow: Input
 Description: Manipulated variable type
              0=zero order hold
              1=first order hold (linear)

----

!!! APM.NODES

 Type: Integer
 Default Value: 4
 Data Flow: Input
 Description: Nodes in each horizon step

----

!!! APM.OBJFCNVAL

 Type: Real
 Default Value: 0.0
 Data Flow: Output
 Description: Objective function value

----

!!! APM.OTOL

 Type: Real
 Default Value: 1.0e-6
 Data Flow: Input
 Description: Objective function tolerance for
              successful solution

----

!!! APM.PRED_HOR

 Type: Integer
 Default Value: 1.0
 Data Flow: Input
 Description: Prediction horizon
              Total horizon, including control horizon

----

!!! APM.PRED_TIME

 Type: Real
 Default Value: 60.0
 Data Flow: Input
 Description: Time for each step in the horizon

----

!!! APM.REQCTRLMODE

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Requested control mode
              0=off
              1=simulate
              2=predict
              3=control

----

!!! APM.RTOL

 Type: Real
 Default Value: 1.0e-6
 Data Flow: Input
 Description: Equation solution tolerance

----

!!! APM.SCALING

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Variable and Equation Scaling
              0=Off
              1=On (Automatic)
              2=On (Manual)

----

!!! APM.SENSITIVITY

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Sensitivity Analysis
              0=Off
              1=On

----

!!! APM.SOLVESTATUS

 Type: Integer
 Default Value: 1
 Data Flow: Output
 Description: Solution solve status: 1=good

----

!!! APM.SOLVER

 Type: Integer
 Default Value: 3
 Data Flow: Input
 Description: Solver options
              0 = Benchmark All Solvers
              1-5 = Available Solvers Depends on License

----

!!! APM.SOLVETIME

 Type: Real
 Default Value: 1.0
 Data Flow: Output
 Description: Solution time (seconds)

----

!!! APM.SPECS

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Secifications from restart file
              1=ON
              0=OFF

----

!!! APM.TIME_SHIFT

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Time shift for dynamic problems
              0  = OFF
              1  = ON (1 step)
              2+ = ON (multiple steps)

----

!!! APM.WEB

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Generate HTML pages
              1=ON
              0=OFF

----

!!! APM.WEB_MENU

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Generate HTML navigation menus
              1=ON
              0=OFF

----

!!! APM.WEB_REFRESH

 Type: Integer
 Default Value: 10
 Data Flow: Input
 Description: Automatic refresh rate on HTML pages

----
June 01, 2017, at 02:03 PM by 45.56.3.173 -
Changed lines 341-342 from:
             8=est, Dynamic estimation (sequential)
              9=ctl, Dynamic control (sequential)
to:
             8=sqe, Dynamic estimation (sequential)
              9=sqo, Dynamic control (sequential)
June 01, 2017, at 01:50 PM by 45.56.3.173 -
Added line 28:
* [[Main/OptionApmEv_Type|APM.EV_TYPE]]
Deleted line 29:
* [[Main/OptionApmEv_Type|APM.EV_TYPE]]
June 01, 2017, at 07:03 AM by 45.56.3.173 -
Changed lines 7-54 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.SCALING
* APM.SENSITIVITY
* APM.SOLVESTATUS
* APM.SOLVER
* APM.SOLVETIME
* APM.SPECS
* APM.TIME
_SHIFT
* APM.WEB
* APM.WEB
_MENU
* APM.WEB_REFRESH
to:
* [[Main/OptionApmAppinfo|APM.APPINFO]]
* [[Main/OptionApmAppinfochg|
APM.APPINFOCHG]]
* [[Main/OptionApmAppstatus|
APM.APPSTATUS]]
* [[Main/OptionApmAuto_Cold|
APM.AUTO_COLD]]
* [[Main/OptionApmBad_Cycles|
APM.BAD_CYCLES]]
* [[Main/OptionApmBnds_Chk|
APM.BNDS_CHK]]
* [[Main/OptionApmColdstart|
APM.COLDSTART]]
* [[Main/OptionApmCsv_Read|
APM.CSV_READ]]
* [[Main/OptionApmCsv_Write|
APM.CSV_WRITE]]
* [[Main/OptionApmCtrl_Hor|
APM.CTRL_HOR]]
* [[Main/OptionApmCtrl_Time|
APM.CTRL_TIME]]
* [[Main/OptionApmCtrl_Units|
APM.CTRL_UNITS]]
* [[Main/OptionApmCtrlmode|
APM.CTRLMODE]]
* [[Main/OptionApmCv_Type|
APM.CV_TYPE]]
* [[Main/OptionApmCv
_Wgt_Slope|APM.CV_WGT_SLOPE]]
* [[Main/OptionApmCv
_Wgt_Start|APM.CV_WGT_START]]
* [[Main/OptionApmCyclecount|APM.CYCLECOUNT]]
* [[Main/OptionApmDbs_Level|
APM.DBS_LEVEL]]
* [[Main/OptionApmDbs_Read|
APM.DBS_READ]]
* [[Main/OptionApmDbs_Write|
APM.DBS_WRITE]]
* [[Main/OptionApmDiaglevel|
APM.DIAGLEVEL]]
* [[Main/OptionApmEv
_Wgt_Slope|APM.EV_WGT_SLOPE]]
* [[Main/OptionApmEv_Type|
APM.EV_TYPE]]
* [[Main/OptionApmFilter|
APM.FILTER]]
* [[Main/OptionApmFrze_Chk|
APM.FRZE_CHK]]
* [[Main/OptionApmHist_Hor|
APM.HIST_HOR]]
* [[Main/OptionApmHist_Units|
APM.HIST_UNITS]]
* [[Main/OptionApmIcd_Calc|
APM.ICD_CALC]]
* [[Main/OptionApmImode|
APM.IMODE]]
* [[Main/OptionApmIterations|APM.ITERATIONS]]
* [[Main/OptionApmLinear|APM.LINEAR]]
* [[Main/OptionApmMax_Iter|
APM.MAX_ITER]]
* [[Main/OptionApmMax_Memory|
APM.MAX_MEMORY]]
* [[Main/OptionApmMax_Time|
APM.MAX_TIME]]
* [[Main/OptionApmMeas_Chk|
APM.MEAS_CHK]]
* [[Main/OptionApmMv
_Dcost_Slope|APM.MV_DCOST_SLOPE]]
* [[Main/OptionApmMv_Step_Hor|APM.MV_STEP_HOR]]
* [[Main/OptionApmMv_Type|APM.MV_TYPE]]
* [[Main/OptionApmNodes|APM.NODES]]
* [[Main/OptionApmObjfcnval|APM.OBJFCNVAL]]
* [[Main/OptionApmOtol|APM.OTOL]]
* [[Main/OptionApmPred_Hor|APM.PRED_HOR]]
* [[Main/OptionApmPred_Time|APM.PRED_TIME]]
* [[Main/OptionApmReduce|APM.REDUCE]]
* [[Main/OptionApmReplay|APM.REPLAY]]
* [[Main/OptionApmReqctrlmode|APM.REQCTRLMODE]]
* [[Main/OptionApmRtol|APM.RTOL]]
* [[Main/OptionApmScaling|APM.SCALING]]
* [[Main/OptionApmSensitivity|APM.SENSITIVITY]]
* [[Main/OptionApmSequential|APM.SEQUENTIAL]]
* [[Main/OptionApmSolver|APM.SOLVER]]
* [[Main/OptionApmSolvestatus|APM.SOLVESTATUS]]
* [[Main/OptionApmSolvetime|APM.SOLVETIME]]
* [[Main/OptionApmSpecs|APM.SPECS]]
* [[Main/OptionApmSpc_Chart|APM.SPC_CHART]]
* [[Main/OptionApmStream_Level|APM.STREAM_LEVEL]]
* [[Main/OptionApmTime_Shift|APM.TIME_SHIFT]]
* [[Main/OptionApmWeb|APM.WEB]]
* [[Main/OptionApmWeb_Menu|APM.WEB_MENU]]
* [[Main/OptionApmWeb_Refresh|APM.WEB_REFRESH]]
* [[Main/OptionApmWeb_Plot_Freq|APM.WEB_PLOT_FREQ]]
May 31, 2017, at 04:09 PM by 10.5.113.210 -
Changed line 5 from:
%width=100px%Attach:apm.png  The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description.
to:
%width=50px%Attach:apm.png  The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description.
May 31, 2017, at 04:08 PM by 10.5.113.210 -
Changed line 5 from:
Attach:apm.png  The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description.
to:
%width=100px%Attach:apm.png  The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description.
May 31, 2017, at 04:05 PM by 10.5.113.210 -
Changed line 5 from:
The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description.
to:
Attach:apm.png  The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description.
May 31, 2017, at 04:05 PM by 10.5.113.210 -
Changed line 5 from:
The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and description.
to:
The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and a brief description.
May 31, 2017, at 04:04 PM by 10.5.113.210 -
Changed lines 424-425 from:
 Description: Objective function tolerance for successful solution
to:
 Description: Objective function tolerance for
             successful solution
Changed lines 434-435 from:
 Description: Prediction horizon: Total horizon, including control horizon
to:
 Description: Prediction horizon
             Total horizon, including control horizon
Changed lines 453-454 from:
 Description: Requested control mode: 1=simulate, 2=predict, 3=control
to:
 Description: Requested control mode
             0=off
              1=simulate
              2=predict
           
3=control
Changed lines 475-476 from:
 Description: Variable and Equation Scaling: 0=Off, 1=On (Automatic), 2=On (Manual)
to:
 Description: Variable and Equation Scaling
             0=Off
              1=On (Automatic)
           
2=On (Manual)
Changed lines 487-488 from:
 Description: Sensitivity Analysis: 0=Off, 1=On
to:
 Description: Sensitivity Analysis
             0=Off
           
1=On
Changed lines 507-508 from:
 Description: Solver options: 0 = Benchmark All Solvers, 1-5 = Available Solvers Depending on License
to:
 Description: Solver options
             0 = Benchmark All Solvers
              1-5 = Available Solvers Depends
on License
Changed lines 527-528 from:
 Description: Secifications from restart file: 1=ON, 0=OFF
to:
 Description: Secifications from restart file
             1=ON
           
0=OFF
Changed lines 538-539 from:
 Description: Time shift for dynamic problems: 1=ON, 0=OFF
to:
 Description: Time shift for dynamic problems
             0  = OFF
             1  = ON (1 step)
              2+ = ON (multiple steps)

Changed lines 550-551 from:
 Description: Generate HTML pages: 1=ON, 0=OFF
to:
 Description: Generate HTML pages
             1=ON
           
0=OFF
Changed lines 561-562 from:
 Description: Generate HTML navigation menus: 1=ON, 0=OFF
to:
 Description: Generate HTML navigation menus
             1=ON
           
0=OFF
Changed line 572 from:
 Description: Automatic refresh rate on HTML pages (default 10 minutes)
to:
 Description: Automatic refresh rate on HTML pages
May 31, 2017, at 04:00 PM by 10.5.113.210 -
Changed lines 72-73 from:
 Description: Application information change (new-old): 0=no change
to:
 Description: Application information change (new-old)
             0=no change
Changed lines 99-100 from:
 Description: Cold start model: 0=warm start, 1=cold start, 2=decompose problem
to:
 Description: Cold start model
             0=warm start
              1=cold start
           
2=decompose problem
Changed lines 111-112 from:
 Description: CSV read: 0=Off, 1=Batch, 2=Sequential
to:
 Description: CSV read
             0=Off
              1=Batch
           
2=Sequential
Changed lines 123-124 from:
 Description: CSV write: 0=Off, 1=Write results.csv, 2=Write results_all.csv
to:
 Description: CSV write
             0=Off
              1=Write results.csv
           
2=Write results_all.csv
Changed lines 135-136 from:
 Description: Control mode: 1=simulate, 2=predict, 3=control
to:
 Description: Control mode
             1=simulate
              2=predict
           
3=control
Changed lines 147-148 from:
 Description: Control horizon: Horizon length where MVs can be adjusted by the solver
to:
 Description: Control horizon length where MVs
             can be adjusted by the solver
Changed lines 166-167 from:
 Description: Model time units (1=sec, 2=min, 3=hrs, 4=days, 5=yrs)
to:
 Description: Model time units
             1=seconds
              2=minutes
              3=hours
              4=days
              5=years

Changed lines 180-181 from:
 Description: Controlled variable error model type: 1=linear, 2=squared, 3=ref traj
to:
 Description: Controlled variable error model type
             1=linear error with dead-band trajectory
              2=squared error to single trajectory
              3=nonlinear error approximates linear
                without slack variables

Changed lines 193-194 from:
 Description: Slope for weight on future CV error (e.g. [+] favors steady state)
to:
 Description: Slope for weight on future CV error
             [+] favors future steady state target
              [-] favors near-term trajectory matching

Changed lines 204-205 from:
 Description: Start interval for controlled variable error model weights
to:
 Description: Start interval for controlled variable
             error model weights
Changed lines 223-224 from:
 Description: Database read: 0=OFF, 1={Name = Value, Status, Units}, 2={Name,Value}
to:
 Description: Database read option
 
             0=OFF
              1={Name = Value, Status}
              2={Name = Value, Status, Units}

Changed lines 235-236 from:
 Description: Database write: 0=OFF, 1={Name = Value, Status, Units}, 2={Name,Value}
to:
 Description: Database write
             0=OFF
              1={Name = Value, Status}
              2={Name = Value, Status, Units}

Changed lines 247-248 from:
 Description: Diagnostic level: 0=none, 1=messages, 2=file checkpoints, 4=diagnostic files, 5=check 1st deriv
to:
 Description: Diagnostic level
             0=none
              1=messages
              2=file checkpoints
              4=diagnostic files
              5=check 1st derivatives
              6=check 2nd derivatives

Changed lines 262-263 from:
 Description: Estimated variable error model type: 1=linear, 2=squared, 3=approximate linear
to:
 Description: Estimated variable error model type
             1=linear error
              2=squared error
              3=approximate linear error without
                slack variables

Changed lines 275-276 from:
 Description: Slope for weight on more cuurent EV error (e.g. favor near-term matching)
to:
 Description: Slope for weight on more cuurent EV error
             [+] favors matching of most recent data
              [-] favors matching of oldest horizon data

Changed lines 286-287 from:
 Description: History horizon (SIM and CTL only): Integer >= 0
to:
 Description: History horizon for web-interface plots
Changed lines 295-296 from:
 Description: History time units on plots only (0=same as CTRL_UNITS, 1=sec, 2=min, 3=hrs, 4=days, 5=yrs)
to:
 Description: History time units on plots only
             0=same as CTRL_UNITS
              1=seconds
              2=minutes
              3=hours
              4=days
              5=years

Changed lines 310-311 from:
 Description: Specifications for initial condition differentials (MHE only): 0=OFF, 1=ON
to:
 Description: Specifications for initial condition
             differentials (MHE only): 0=OFF, 1=ON
Changed lines 320-321 from:
 Description: Model solution mode: 1=ss, 2=mpu, 3=rto, 4=sim, 5=est, 6=ctl
to:
 Description: Model solution mode
             1=ss, Simulation (steady state)
              2=mpu, Model parameter update (steady state)
              3=rto, Real time optimization (steady state)
              4=sim, Dynamic simulation (simultaneous)
              5=est, Dynamic estimation (simultaneous)
              6=
ctl, Dynamic control (simultaneous)
              7=sqs, Dynamic simulation (sequential)
              8=est, Dynamic estimation (sequential)
              9=ctl, Dynamic control (sequential)

Changed lines 338-339 from:
 Description: Iterations for solution: >=1
to:
 Description: Iterations for solution
Changed lines 347-348 from:
 Description: Maximum iteration: >=1
to:
 Description: Maximum iterations
Changed lines 374-375 from:
 Description: Slope for penalization on future MV moves (i.e. reduces controller procrastination)
to:
 Description: Slope for penalization on future MV moves
             to reduce controller procrastination
Changed lines 382-383 from:
 Default Value: 1 (for APM.MV_STEP_HOR) or 0 (for MV(#).MV_STEP_HOR)
to:
 Default Value: 1 (for APM.MV_STEP_HOR)
               0 (for MV(#).MV_STEP_HOR)
Changed lines 385-386 from:
 Description: Step length for manipulated variables: 0 uses APM.MV_STEP_HOR as default
to:
 Description: Step length for manipulated variables
             0 uses APM.MV_STEP_HOR as default
Changed lines 395-397 from:
 Description: Manipulated variable type: 0=zero order hold, 1=linear
to:
 Description: Manipulated variable type
             0=zero order hold
              1=first order hold (linear)
May 31, 2017, at 03:34 PM by 10.5.113.210 -
Changed lines 1-53 from:
!! DBS Global Variables

The following is a list of parameters that may be found
in the DBS file header section.  It is a complete list of the configuration parameters for ''NLC'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and description.

* 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.SCALING
* NLC.SENSITIVITY
* NLC.SOLVESTATUS
* NLC.SOLVER
* NLC.SOLVETIME
* NLC.SPECS
* NLC.TIME_SHIFT
* NLC.WEB
* NLC.WEB_MENU
* NLC.WEB_REFRESH
to:
(:title Global Options (APM):)
(:keywords Global, Optimization, Estimation, Option, Configure, Default, Description:)
(:description Global options
in APMonitor begin with APM. They can be set from MATLAB or Python clients.:)

The following is a list of global options that may be set to configure an APMonitor application.  It is a complete list of the configuration parameters for ''APM'' type parameters
.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and description.

* 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.SCALING
* APM.SENSITIVITY
* APM.SOLVESTATUS
* APM.SOLVER
* APM.SOLVETIME
* APM.SPECS
* APM.TIME_SHIFT
* APM.WEB
* APM.WEB_MENU
* APM
.WEB_REFRESH
Changed lines 58-59 from:
!!! NLC.APPINFO
to:
!!! APM.APPINFO
Changed lines 67-68 from:
!!! NLC.APPINFOCHG
to:
!!! APM.APPINFOCHG
Changed line 76 from:
!!! NLC.APPSTATUS
to:
!!! APM.APPSTATUS
Changed lines 84-85 from:
!!! NLC.BNDS_CHK
to:
!!! APM.BNDS_CHK
Changed lines 93-94 from:
!!! NLC.COLDSTART
to:
!!! APM.COLDSTART
Changed lines 102-103 from:
!!! NLC.CSV_READ
to:
!!! APM.CSV_READ
Changed lines 111-112 from:
!!! NLC.CSV_WRITE
to:
!!! APM.CSV_WRITE
Changed lines 120-121 from:
!!! NLC.CTRLMODE
to:
!!! APM.CTRLMODE
Changed lines 129-130 from:
!!! NLC.CTRL_HOR
to:
!!! APM.CTRL_HOR
Changed lines 138-139 from:
!!! NLC.CTRL_TIME
to:
!!! APM.CTRL_TIME
Changed lines 147-148 from:
!!! NLC.CTRL_UNITS
to:
!!! APM.CTRL_UNITS
Changed lines 156-157 from:
!!! NLC.CV_TYPE
to:
!!! APM.CV_TYPE
Changed lines 165-166 from:
!!! NLC.CV_WGT_SLOPE
to:
!!! APM.CV_WGT_SLOPE
Changed lines 174-175 from:
!!! NLC.CV_WGT_START
to:
!!! APM.CV_WGT_START
Changed lines 183-184 from:
!!! NLC.CYCLECOUNT
to:
!!! APM.CYCLECOUNT
Changed lines 192-193 from:
!!! NLC.DBS_READ
to:
!!! APM.DBS_READ
Changed lines 201-202 from:
!!! NLC.DBS_WRITE
to:
!!! APM.DBS_WRITE
Changed lines 210-211 from:
!!! NLC.DIAGLEVEL
to:
!!! APM.DIAGLEVEL
Changed lines 219-220 from:
!!! NLC.EV_TYPE
to:
!!! APM.EV_TYPE
Changed lines 228-229 from:
!!! NLC.EV_WGT_SLOPE
to:
!!! APM.EV_WGT_SLOPE
Changed lines 237-238 from:
!!! NLC.HIST_HOR
to:
!!! APM.HIST_HOR
Changed lines 246-247 from:
!!! NLC.HIST_UNITS
to:
!!! APM.HIST_UNITS
Changed lines 255-256 from:
!!! NLC.ICD_CALC
to:
!!! APM.ICD_CALC
Changed lines 264-265 from:
!!! NLC.IMODE
to:
!!! APM.IMODE
Changed lines 273-274 from:
!!! NLC.ITERATIONS
to:
!!! APM.ITERATIONS
Changed lines 282-283 from:
!!! NLC.MAX_ITER
to:
!!! APM.MAX_ITER
Changed lines 291-292 from:
!!! NLC.MAX_TIME
to:
!!! APM.MAX_TIME
Changed lines 300-301 from:
!!! NLC.MEAS_CHK
to:
!!! APM.MEAS_CHK
Changed lines 309-310 from:
!!! NLC.MV_DCOST_SLOPE
to:
!!! APM.MV_DCOST_SLOPE
Changed lines 318-319 from:
!!! NLC.MV_STEP_HOR
to:
!!! APM.MV_STEP_HOR
Changed line 321 from:
 Default Value: 1 (for NLC.MV_STEP_HOR) or 0 (for MV(#).MV_STEP_HOR)
to:
 Default Value: 1 (for APM.MV_STEP_HOR) or 0 (for MV(#).MV_STEP_HOR)
Changed lines 323-324 from:
 Description: Step length for manipulated variables: 0 uses NLC.MV_STEP_HOR as default
to:
 Description: Step length for manipulated variables: 0 uses APM.MV_STEP_HOR as default
Changed lines 327-328 from:
!!! NLC.MV_TYPE
to:
!!! APM.MV_TYPE
Changed lines 336-337 from:
!!! NLC.NODES
to:
!!! APM.NODES
Changed lines 345-346 from:
!!! NLC.OBJFCNVAL
to:
!!! APM.OBJFCNVAL
Changed lines 354-355 from:
!!! NLC.OTOL
to:
!!! APM.OTOL
Changed lines 363-364 from:
!!! NLC.PRED_HOR
to:
!!! APM.PRED_HOR
Changed lines 372-373 from:
!!! NLC.PRED_TIME
to:
!!! APM.PRED_TIME
Changed lines 381-382 from:
!!! NLC.REQCTRLMODE
to:
!!! APM.REQCTRLMODE
Changed lines 390-391 from:
!!! NLC.RTOL
to:
!!! APM.RTOL
Changed lines 399-400 from:
!!! NLC.SCALING
to:
!!! APM.SCALING
Changed lines 408-409 from:
!!! NLC.SENSITIVITY
to:
!!! APM.SENSITIVITY
Changed lines 417-418 from:
!!! NLC.SOLVESTATUS
to:
!!! APM.SOLVESTATUS
Changed lines 426-427 from:
!!! NLC.SOLVER
to:
!!! APM.SOLVER
Changed lines 435-436 from:
!!! NLC.SOLVETIME
to:
!!! APM.SOLVETIME
Changed lines 444-445 from:
!!! NLC.SPECS
to:
!!! APM.SPECS
Changed lines 453-454 from:
!!! NLC.TIME_SHIFT
to:
!!! APM.TIME_SHIFT
Changed lines 462-463 from:
!!! NLC.WEB
to:
!!! APM.WEB
Changed lines 471-472 from:
!!! NLC.WEB_MENU
to:
!!! APM.WEB_MENU
Changed line 480 from:
!!! NLC.WEB_REFRESH
to:
!!! APM.WEB_REFRESH
Changed line 114 from:
 Description: CSV write: 0=Off, 1=On
to:
 Description: CSV write: 0=Off, 1=Write results.csv, 2=Write results_all.csv
May 15, 2013, at 06:30 PM by 128.187.97.23 -
Added line 44:
* NLC.SENSITIVITY
Added lines 403-411:

----

!!! NLC.SENSITIVITY

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Sensitivity Analysis: 0=Off, 1=On
May 15, 2013, at 06:28 PM by 128.187.97.23 -
Added lines 393-401:

----

!!! NLC.SCALING

 Type: Integer
 Default Value: 1
 Data Flow: Input
 Description: Variable and Equation Scaling: 0=Off, 1=On (Automatic), 2=On (Manual)
May 15, 2013, at 06:27 PM by 128.187.97.23 -
Added line 43:
* NLC.SCALING
May 10, 2013, at 10:52 PM by 128.187.97.23 -
Changed line 94 from:
 Description: Cold start model: 0=warm start, 1=cold start
to:
 Description: Cold start model: 0=warm start, 1=cold start, 2=decompose problem
October 08, 2008, at 02:23 PM by 158.35.225.230 -
Changed lines 193-194 from:
 Description: Database read: 1=ON, 0=OFF
to:
 Description: Database read: 0=OFF, 1={Name = Value, Status, Units}, 2={Name,Value}
Changed line 202 from:
 Description: Database write: 1=ON, 0=OFF
to:
 Description: Database write: 0=OFF, 1={Name = Value, Status, Units}, 2={Name,Value}
October 02, 2008, at 08:33 PM by 158.35.225.228 -
Changed line 409 from:
 Description: Solver options: 0=Benchmark All Solvers, 1=NOVA, 2=IPOPT-v2.3, 3=IPOPT-v3.5, 4=SNOPT, 5=MINOS
to:
 Description: Solver options: 0 = Benchmark All Solvers, 1-5 = Available Solvers Depending on License
October 01, 2008, at 05:14 PM by 158.35.225.229 -
Changed line 409 from:
 Description: Solver options: 1=NOVA, 2=IPOPT-v2.3, 3=IPOPT-v3.5, 4=SNOPT, 5=MINOS
to:
 Description: Solver options: 0=Benchmark All Solvers, 1=NOVA, 2=IPOPT-v2.3, 3=IPOPT-v3.5, 4=SNOPT, 5=MINOS
October 01, 2008, at 04:55 PM by 158.35.225.229 -
Added line 465:
----
October 01, 2008, at 04:54 PM by 158.35.225.229 -
Added lines 4-50:

* 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
October 01, 2008, at 04:54 PM by 158.35.225.229 -
Added lines 1-4:
!! DBS Global Variables

The following is a list of parameters that may be found in the DBS file header section.  It is a complete list of the configuration parameters for ''NLC'' type parameters.  Each section includes an indication of the variable type (Integer or Real), the default value, data flow, and description.

October 01, 2008, at 04:46 PM by 158.35.225.229 -
Added lines 1-413:
----

!!! 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)