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

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, 2=decompose problem

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: 0=OFF, 1={Name = Value, Status, Units}, 2={Name,Value} 

NLC.DBS_WRITE

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

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.SCALING

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

NLC.SENSITIVITY

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

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: 0 = Benchmark All Solvers, 1-5 = Available Solvers Depending on License

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)