Simantics System Dynamics - Revision history

Tuukka Lehtonen: /* Installation Instructions */

2018-02-20T10:41:03Z

Installation Instructions

← Older revision		Revision as of 10:41, 20 February 2018
Line 63:		Line 63:
	System dynamics tool is provided with the Simantics platform.		System dynamics tool is provided with the Simantics platform.

	# [~~https~~://~~www~~.simantics.org/~~simantics/download~~ Download installer from ~~Simantics~~ download page]		# [http://sysdyn.simantics.org/ Download installer from the tool's download page]
	# Install the program to a directory without spaces (limitation inherited from OpenModelica).		# Install the program to a directory without spaces (limitation inherited from OpenModelica).
	# Run the application through the launcher generated by the installer<br/>		# Run the application through the launcher generated by the installer<br/>

Tuomas Miettinen at 07:11, 3 April 2017

2017-04-03T07:11:41Z

← Older revision		Revision as of 07:11, 3 April 2017
Line 1,110:		Line 1,110:
	=== External Functions ===		=== External Functions ===

	Modelica allows you to use external functions that are programmed using C language. Below is a simple example of using a function that returns the sum of two arguments.		Modelica allows you to use external functions that are programmed using C language. To use this feature, you need to have the Sysdyn version with OpenModelica included and OpenModelica set as the solver in the Preferences (Window -> Preferences -> Solver). The installation package with OpenModelica has also MinGW C compiler included that allows to build object files from C source code.

			Below is a simple example of using a function that returns the sum of two arguments.

	double exampleCFunction(double x, double y)		double exampleCFunction(double x, double y)

Tuomas Miettinen at 07:21, 9 January 2017

2017-01-09T07:21:45Z

← Older revision		Revision as of 07:21, 9 January 2017
Line 357:		Line 357:
	Unit validation can also cope with certain different forms of units, e.g., you can write dollars, dollar, or $ and the validator considers these equal. This functionality can be disabled from Model Properties tab checkbox "Unit equivalents".		Unit validation can also cope with certain different forms of units, e.g., you can write dollars, dollar, or $ and the validator considers these equal. This functionality can be disabled from Model Properties tab checkbox "Unit equivalents".

	As there may be cases for which the unit validation is for some reason not working as desired, the unitCast() function can be used in the ~~expression~~ of ~~the~~ variable to cast any ~~unit in~~ the ~~expression~~ to a wildcard. E.g., if expression		As there may be cases for which the unit validation is for some reason not working as desired, the unitCast() function can be used in the equation of a variable to cast the unit of any expression within the equation to a wildcard. E.g., if expression
	Aux1 + time		Aux1 + time
	yields a warning, it can be fixed be changing the expression to		yields a warning, it can be fixed be changing the expression to

Tuomas Miettinen at 07:08, 9 January 2017

2017-01-09T07:08:59Z

← Older revision		Revision as of 07:08, 9 January 2017
Line 356:		Line 356:

	Unit validation can also cope with certain different forms of units, e.g., you can write dollars, dollar, or $ and the validator considers these equal. This functionality can be disabled from Model Properties tab checkbox "Unit equivalents".		Unit validation can also cope with certain different forms of units, e.g., you can write dollars, dollar, or $ and the validator considers these equal. This functionality can be disabled from Model Properties tab checkbox "Unit equivalents".

			As there may be cases for which the unit validation is for some reason not working as desired, the unitCast() function can be used in the expression of the variable to cast any unit in the expression to a wildcard. E.g., if expression
			Aux1 + time
			yields a warning, it can be fixed be changing the expression to
			unitCast(Aux1) + time
			, in which case the unit of the expression is that of time, or to
			Aux1 + unitCast(time)
			, in which case the unit of the expression is that of Aux1.

	=== Diagram Profiles ===		=== Diagram Profiles ===

Tuomas Miettinen at 12:18, 26 August 2014

2014-08-26T12:18:38Z

← Older revision		Revision as of 12:18, 26 August 2014
Line 1,308:		Line 1,308:

	[[File:HistoryData.png\|History data in two charts]]		[[File:HistoryData.png\|History data in two charts]]

			== Vensim Model Import ==

			The tool also has a limited support for importing system dynamics models created with the simulation and modelling tool [http://vensim.com/ Vensim]. This functionality is used similarly to the regular model import, so by right-clicking the browser and selecting "Import" -> "Vensim Model (.mdl)".

			The import process has several known limitations:

			* The Vensim model must be in the .mdl file format, the other Vensim file formats are proprietary and thus not supported.
			* Only variables and connections are imported.
			* Many advanced Vensim features, such as input and output objects (e.g. graphs and parameter value editors) and other diagram customizations, are not supported.
			* Variable value range data is not always imported correctly.
			* Subscripts are automatically converted to enumerations which may sometimes lead into problems as the constructions are not exactly equivalent.
			* Dimensionless units are currently not converted correctly (in Simantics System Dynamics, dimensionless should be indicated with a constant).
			* Non-shadow duplicate variables are sometimes very problematic and may be imported incorrectly, shadow variables should work fine.
			* Only a limited subset of Vensim functions is currently implemented in Simantics System Dynamics, so some equations might require additional work before they can be evaluated correctly.

	== Sample Models and Molecules ==		== Sample Models and Molecules ==

Tuomas Miettinen at 09:47, 18 August 2014

2014-08-18T09:47:30Z

← Older revision		Revision as of 09:47, 18 August 2014
Line 512:		Line 512:

	;Loops		;Loops
	:Loops display all feedback loops which the selected variable belongs to. <br /> [[File:~~Dependencies~~.png]]		:Loops display all feedback loops which the selected variable belongs to. <br /> [[File:Loops.png]]

	== Custom Charts ==		== Custom Charts ==

Tuomas Miettinen at 07:41, 12 June 2014

2014-06-12T07:41:49Z

← Older revision		Revision as of 07:41, 12 June 2014
Line 150:		Line 150:
	ANY VARIABLE -----> MODULE		ANY VARIABLE -----> MODULE
	:This is just the visual configuration, but you need those connections to really connect variables in the module's properties.		:This is just the visual configuration, but you need those connections to really connect variables in the module's properties.
	:In Inputs -tab you select which variables you connect to inputs inside the module. In Outputs -tab you select which variables you lift from the module to inputs outside it.		:In the ''Inputs'' tab stacked under ''Module Properties'' you can select which variables you connect to inputs inside the module. In the ''Outputs'' tab you can select which variables you lift from the module to inputs outside it.

	:'''Inside the module''' <br />		:'''Inside the module''' <br />

Tuomas Miettinen at 13:03, 6 June 2014

2014-06-06T13:03:54Z

← Older revision		Revision as of 13:03, 6 June 2014
Line 463:		Line 463:
	\|-		\|-
	\|Distribution		\|Distribution
	\|Probability distribution for the varied parameter. "Normal" is for [http://en.wikipedia.org/wiki/Truncated_normal_distribution truncated normal distribution and "Uniform" for [http://en.wikipedia.org/wiki/Uniform_distribution_(continuous) uniform distribution]. With "Interval" the values have equal intervals between each other and are selected in increasing order. In multivariate sensitivity analyses, it is recommended to select either "Normal" or "Uniform".		\|Probability distribution for the varied parameter. "Normal" is for [http://en.wikipedia.org/wiki/Truncated_normal_distribution truncated normal distribution] and "Uniform" for [http://en.wikipedia.org/wiki/Uniform_distribution_(continuous) uniform distribution]. With "Interval" the values have equal intervals between each other and are selected in increasing order. In multivariate sensitivity analyses, it is recommended to select either "Normal" or "Uniform".
	\|-		\|-
	\|'''Distribution properties'''		\|'''Distribution properties'''
Line 492:		Line 492:
	== Simulation Result and Model Structure Analysis ==		== Simulation Result and Model Structure Analysis ==

	Simulation results can be viewed as trends in the trend view or as plain numbers in the values view. The views display results of variables that are selected in the workbench. Users can also create [[#Custom ~~charts~~ \|custom charts]].		Simulation results can be viewed as trends in the trend view or as plain numbers in the values view. The views display results of variables that are selected in the workbench. Users can also create [[#Custom Charts\|custom charts]].

	Model structure can be examined in the Structure view. There are three options: dependency structures of individual variables, the complete hierarchy structure of the model, or the feedback loops which individual variables belong to.		Model structure can be examined in the Structure view. There are three options: dependency structures of individual variables, the complete hierarchy structure of the model, or the feedback loops which individual variables belong to.

Tuomas Miettinen at 12:55, 6 June 2014

2014-06-06T12:55:12Z

← Older revision		Revision as of 12:55, 6 June 2014
Line 1:		Line 1:
	== Simantics System Dynamics ==		== Simantics System Dynamics ==

	Simantics System Dynamics is currently the only open source modelling and simulating tool for Simantics. Simantics System Dynamics is under development and will go through some changes in the future. New features will be added and old ones improved according to the needs of the modellers.		''Simantics System Dynamics'' is currently the only open source modelling and simulating tool for Simantics. Simantics System Dynamics is under development and will go through some changes in the future. New features will be added and old ones improved according to the needs of the modellers.

	This documentation introduces you to the current version of Simantics System Dynamics. Documentation includes the basic modelling principles and a guide on how to model system dynamics models with Simantics System Dynamics. If you like to get to know the tool better and try modelling and simulating yourself, [[#Installation Instructions\|install]] the software and try our [[Tutorial: Basic System Dynamics Modelling\|basic]] and [[Tutorial: Advanced System Dynamics Modelling\|advanced]] tutorials!		This documentation introduces you to the current version of Simantics System Dynamics. Documentation includes the basic modelling principles and a guide on how to model system dynamics models with Simantics System Dynamics. If you like to get to know the tool better and try modelling and simulating yourself, [[#Installation Instructions\|install]] the software and try our [[Tutorial: Basic System Dynamics Modelling\|basic]] and [[Tutorial: Advanced System Dynamics Modelling\|advanced]] tutorials!
Line 9:		Line 9:
	=== System Dynamics ===		=== System Dynamics ===

	System dynamics is an approach to understanding different organizations, markets and other complex systems and their dynamic behavior. Simantics System ~~dynamics~~ is a free modelling tool. See [[#Installation Instructions\|installation instructions]].		System dynamics is an approach to understanding different organizations, markets and other complex systems and their dynamic behavior. Simantics System Dynamics is a free modelling tool for system dynamics modeling and simulation. See [[#Installation Instructions\|installation instructions]].

	=== Model ===		=== Model ===

	[[File:ModelStructure.png\|right\|thumb\|Model structure]]		[[File:ModelStructure.png\|right\|thumb\|Model structure]]
	System dynamics model is generally understood as the model configuration. In this tool, the model contains also other components: Experiments are the way to simulate the model. ~~In the future, you~~ can have experiments with different configurations, for example different initial values for some parameters. In that way, you don't have to always configure the model for different scenarios. Modules folder contains all the different module types in your model and you can create new module types there.		System dynamics model is generally understood as the model configuration. In this tool, the model contains also other components: [[#Experiments\|Experiments]] are the way to simulate the model. You can have experiments with different configurations, for example different initial values for some parameters. In that way, you don't have to always configure the model for different scenarios. [[#Basic Modelling\|Module types]] allow user to create reusable component types which can be instantiated as Modules. The Modules folder contains all the different module types in your model and you can create new module types there. The [[#Functions\|Functions]] folder contains built-in and user-defined functions.

	<br style="clear: both" />		<br style="clear: both" />
Line 23:		Line 23:
	[[File:ComponentTypes.png\|right\|frame\|Component types]]		[[File:ComponentTypes.png\|right\|frame\|Component types]]
	;Auxiliary		;Auxiliary
	:Auxiliary is the most basic variable you can use. It represents a single value or a mathematical expression. There are different types of auxiliary variables currently in the system: Auxiliary, Parameter, Constant, Delay and WithLookup. Auxiliary is the default type. Parameters are ~~single~~ values that the user can change. When only parameters are changed, the model simulates faster, because the system does not have to recompile the model. WithLookup and Delay are special variables. WithLookup has an expression and a lookup table. The expression defines what value is taken from the defined table. Delay variable delays an equation a given time with a given delay order.		:Auxiliary is the most basic variable you can use. It represents a single value or a mathematical expression. There are different types of auxiliary variables currently in the system: ''Auxiliary'', ''Parameter'', ''Constant'', [[#Delay\|''Delay'']] and [[#WithLookup\|''WithLookup'']]. Auxiliary is the default type. Parameters are static values that the user can change. When only parameters are changed, the model simulates faster, because the system does not have to recompile the model. WithLookup and Delay are special variables. WithLookup has an expression and a lookup table. The expression defines what value is taken from the defined table. Delay variable delays an equation a given time with a given delay order.
	;Dependency		;Dependency
	:Dependency is an arrow that connects two components. It means that the value of the variable from which the arrow starts is used to calculate the value of the variable where the arrow ends. Dependencies that are used for a stock initial value only are colored grey by default, in contrast to the regular blue dependency arrows.		:Dependency is an arrow that connects two components. It means that the value of the variable from which the arrow starts is used to calculate the value of the variable where the arrow ends. Dependencies that are used for a stock initial value only are colored grey by default, in contrast to the regular blue dependency arrows.
Line 68:		Line 68:
	: (default: Simantics\Simantics-1.8.0-Sysdyn-32\Simantics-1.8.0-Sysdyn-32)		: (default: Simantics\Simantics-1.8.0-Sysdyn-32\Simantics-1.8.0-Sysdyn-32)

	[http://www.openmodelica.org/ OpenModelica] is used to build and simulate the models. Simantics platform has integrated OpenModelica 1.9.0 beta4 for Windows environments. For other versions and other environments you need to install [http://www.openmodelica.org/index.php/download OpenModelica]. In addition to OpenModelica, a development version of a purpose-built Modelica solver is embedded in the tool.		[http://www.openmodelica.org/ OpenModelica] is used to build and simulate the models. Simantics platform has integrated OpenModelica 1.9.0 beta4 for Windows environments. For other versions and other environments you need to install [http://www.openmodelica.org/index.php/download OpenModelica]. In addition to OpenModelica, a development version of a [[#Solvers\|purpose-built Modelica solver]] is embedded in the tool.

	== Workbench ==		== Workbench ==
Line 76:		Line 76:
	# '''Diagram''' <br /> Diagram is the area where you will graphically modify your model. Diagrams are built from elements that can be dragged from Symbols view or populated using shortcut keys.		# '''Diagram''' <br /> Diagram is the area where you will graphically modify your model. Diagrams are built from elements that can be dragged from Symbols view or populated using shortcut keys.
	# '''Model Browser''' <br /> Model browser shows the structure of your model and all items related to it. <br />'''Symbols''' <br/> Symbols view (stacked with the model browser) is used for dragging elements to diagrams. <br />'''Search''' <br/> Search view (stacked with the model browser) is used for searching elements in all models. Search can be launched also from the search field in the bottom right corner or by Ctrl+F.		# '''Model Browser''' <br /> Model browser shows the structure of your model and all items related to it. <br />'''Symbols''' <br/> Symbols view (stacked with the model browser) is used for dragging elements to diagrams. <br />'''Search''' <br/> Search view (stacked with the model browser) is used for searching elements in all models. Search can be launched also from the search field in the bottom right corner or by Ctrl+F.
	# '''Properties''' <br /> Property view shows the selected variable's properties. Property view has a different layout depending on the type of the selected component. The view can also have different tabs depending on the component type. Basic tabs for variables are Equation, Indexes, and Additional information.<br />'''Console''' <br /> Console view (stacked with the property view) shows console messages from the simulator. Console can be used for debugging models simulated using OpenModelica. <br />'''Issues''' <br /> Issue view (stacked with the property view) shows the errors and warnings in all models. <br />'''Profiles''' <br /> Profiles view (stacked with the property view) allows enabling/disabling some visual diagram effects.		# '''Properties''' <br /> Property view shows the selected variable's properties. Property view has a different layout depending on the type of the selected component. The view can also have different tabs depending on the component type. Basic tabs for variables are Equation, Indexes, and Additional information.<br />'''Console''' <br /> Console view (stacked with the property view) shows console messages from the simulator. Console can be used for debugging models simulated using OpenModelica. <br />'''Issues''' <br /> Issue view (stacked with the property view) shows the errors and warnings in all models. <br />'''Profiles''' <br /> [[#Diagram Profiles\|Profiles]] view (stacked with the property view) allows enabling/disabling some visual diagram effects.
	# '''Trend''' <br /> Trend view shows the graphical representation of the values of the selected value over time. For the trend to be shown, a simulation has to be run. The view shows always the results of the latest run, but you can save results of a simulation and show them in the same trend with results from another simulation. <br />'''Structure''' <br /> The structure view (stacked with the trend view) can be used for analyzing the varaible dependencies, loops, and the structure of the model. <br/>'''Values''' <br/> The values view (stacked with the trend view) shows the values of the selected value over time. For the values to be shown, a simulation has to be run.		# '''Trend''' <br /> [[#Simulation Result and Model Structure Analysis\|Trend]] view shows the graphical representation of the values of the selected value over time. For the trend to be shown, a simulation has to be run. The view shows always the results of the latest run, but you can save results of a simulation and show them in the same trend with results from another simulation. <br />'''Structure''' <br /> The [[#Simulation Result and Model Structure Analysis\|structure]] view (stacked with the trend view) can be used for analyzing the varaible dependencies, loops, and the structure of the model. <br/>'''Values''' <br/> The [[#Simulation Result and Model Structure Analysis\|values]] view (stacked with the trend view) shows the values of the selected value over time. For the values to be shown, a simulation has to be run.
	# '''Save and save as...''' <br/> Save buttons can be used to export the selected model as .sysdyn file. The buttons save that model which is selected in the model browser or, if the focus is on the diagram, the model that is currently open on the diagram.		# '''Save and save as...''' <br/> Save buttons can be used to export the selected model as .sysdyn file. The buttons save that model which is selected in the model browser or, if the focus is on the diagram, the model that is currently open on the diagram.
	# '''Diagram tool mode''' <br /> With the diagram tool mode, you can select how the elements on the diagram are edited. The Lock mode prohibits editing diagram elements, the pointer mode allows moving and editing diagram elements, and with the dependency and flow modes arrows can be drawn using only mouse1 and mouse2.		# '''Diagram tool mode''' <br /> With the diagram tool mode, you can select how the elements on the diagram are edited. The Lock mode prohibits editing diagram elements, the pointer mode allows moving and editing diagram elements, and with the dependency and flow modes arrows can be drawn using only mouse1 and mouse2.
	# '''Experiment controls''' <br /> Experiment controls are shown when an experiment is active. Experiment is activated by double clicking an experiment in the model browser. With the experiment control, you can start simulation runs and save simulation results.		# '''Experiment controls''' <br /> Experiment controls are shown when an experiment is active. Experiment is activated by double clicking an experiment in the model browser. With the experiment control, you can start simulation runs and save simulation results.
	# '''Perspectives''' <br/> Perspectives allow changing between different layouts of the views. On start-up, only the default perspective is open. Try adding the two predefined perspectives by clicking the Open Perspective [[File:OpenPerspective.png]] button.		# '''Perspectives''' <br/> Perspectives allow changing between different layouts of the views. On start-up, only the default perspective is open. Try adding the two predefined perspectives by clicking the Open Perspective [[File:OpenPerspective.png]] button.
	# '''Chart Panel''' <br/> Chart panel is able to house multiple charts at the same time. Charts are added to the panel by dragging from model browser.		# '''Chart Panel''' <br/> [[#Chart Panel\|Chart panel]] is able to house multiple [[#Charts\|charts]] at the same time. Charts are added to the panel by dragging from model browser.

	<br />		<br />
Line 97:		Line 97:
	{\|		{\|
	\|General -> Keys		\|General -> Keys
	\|All keyboard shortcuts available.		\|All [[#Shortcut and Control Keys\|keyboard shortcuts]] available.
	\|-		\|-
	\|Modelica		\|Modelica
Line 103:		Line 103:
	\|-		\|-
	\|Solver		\|Solver
	\|Solver to be used for simulation. OpenModelica or internal custom solver (experimental) can be selected.		\|[[#Solvers\|Solver]] to be used for simulation. OpenModelica or internal custom solver (experimental) can be selected.
	\|-		\|-
	\|Sysdyn Diagrams		\|Sysdyn Diagrams
Line 198:		Line 198:
	\|-		\|-
	\|Validate units		\|Validate units
	\|Unit validation on/off. If unit validation is enabled, the unit of the simulation time is selected from the pull-down menu.		\|[[#Unit Validation\|Unit validation]] on/off. If unit validation is enabled, the unit of the simulation time is selected from the pull-down menu.
	\|-		\|-
	\|Unit equivalents		\|Unit equivalents
Line 215:		Line 215:
	Auxiliary and valve variables have two special types: WithLookup and Delay. These types are selected from Type drop down menu in the variable's properties. The variable types offer more specific functionalities than normal variables, but the same functionality could be achieved using normal variables.		Auxiliary and valve variables have two special types: WithLookup and Delay. These types are selected from Type drop down menu in the variable's properties. The variable types offer more specific functionalities than normal variables, but the same functionality could be achieved using normal variables.

	;WithLookup		==== WithLookup ====
	WithLookup variable has two equation fields, WithLookup and Lookup table. Lookup table has a table from which the value of the variable is interpolated using the value of WithLookup field.		WithLookup variable has two equation fields, WithLookup and Lookup table. Lookup table has a table from which the value of the variable is interpolated using the value of WithLookup field.

Line 224:		Line 224:
	[[File:WithLookup2.png]]		[[File:WithLookup2.png]]

	;Delay		==== Delay ====
	Delay variables build equations for Nth order delays. Users can set the equation for the value that is to be delayed, the time and order of the delay and a possible start value. If start value is empty, the start value is set automatically.		Delay variables build equations for Nth order delays. Users can set the equation for the value that is to be delayed, the time and order of the delay and a possible start value. If start value is empty, the start value is set automatically.

Tuomas Miettinen at 11:30, 4 June 2014

2014-06-04T11:30:28Z

Show changes