modelModelSettings
Setting important global variables within a model
Extends from Icons.ConverterName (Icon for converter elements).
Information
This information is part of the Business Simulation Library (BSL). Please support this work and ► donate.
This class should be placed in the top level scope of any simulation model. It will automatically be assigned the prefix inner as it provides global parameters for the model.
Parameters
| Type | Name | Default | Description |
|---|---|---|---|
| Model Time Settings | |||
| TimeBases | modelDisplayTimeBase | TimeBases.seconds | The model's time base with regard to input and output |
| Time | modelTimeHorizon | 10 | The time horizon for the model (i.e., stopTime - startTime) |
| Time | dt | 0.25 | Smallest possible interval of time for compatibility with conventional fixed-step system dynamics models |
| Time | samplingPeriod | dt/4 | Default sampling period for discrete model components (should be ≤ dt/4) |
| Initialization | |||
| Time | modelStartTime | Start time of the model (will be automatically determined) | |
| Time | modelStopTime | Stop time of the model (will be determined from startTime and modelTimeHorizon) | |
| String | modelDisplayTimeUnit | BusinessSimulation.Constants.timeBaseUnits[modelDisplayTimeBase] | Unit string according to modelDisplayTimeBase choice |
| Model Input Settings | |||
| Boolean | gaming | false | = true, if gaming mode is to be activated |
| Data Sources | |||
| String | lookupDataFileURI | "LookupData.txt" | URI for the lookup data file |
| String | exogenousDataFileURI | "ExogenousData.txt" | URI for the exogenous data file |
| Advanced | |||
| InitializationOptions | init | BusinessSimulation.Types.InitializationOptions.FixedValue | Provide InitializationOptions (Free, FixedValue, SteadyState) as global default |
Revisions
- Structural parameters, e.g.,
modelDisplayTimeBase, changed to constant variability in v2.0.0. - Added
Evaluate = truetodtto make this a structrual parameter in v2.1.0.