WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »
WSMLink`
WSMLink`

WSMModelData

WSMModelData is being phased out in favor of SystemModel, which was introduced experimentally in Version 11.3.

WSMModelData["mmodel"]

gives a diagram representation of the model "mmodel", usable as input to other functions.

WSMModelData["mmodel","property"]

gives the specified "property" for the model "mmodel".

Details and Options

  • WSMModelData["mmodel","Properties"] gives a list of possible properties.
  • Properties related to the whole model: »
  • "Description"top-level description of model
    "Diagram"diagram view of model
    "Icon"icon view of model
    "ModelicaText"show Modelica model code
    "ModelName"fully qualified path of model
    "LocalPlotNames"names of plots saved locally in model
    "PlotNames"names of plots, including inherited
    "SourceFile"file where the model is saved
    "Summary"model summary data
  • "ModelicaText" creates a cell with style "Program" containing the textual form of "mmodel".
  • With a text-based interface, "ModelicaText" returns the textual form of "mmodel" as a string.
  • WSMModelData[{"mmodel","c1","c2",…}, "Diagram"] shows the diagram for component "c1.c2...ci" in "mmodel".
  • WSMModelData["mmodel",{property,options}] accepts the following options for property "Diagram" and "Icon":
  • FrameTrueshow frame
    FrameTicksFalseshow frame ticks
    GridLinesNonewhat grid lines to show
    PlotRangeAutomaticplot range in mm
    PlotRangePaddingAutomaticpadding in mm
  • GridLines->Inherited inherits the grid defined in the model diagram. »
  • PlotRange->Automatic specifies a plot range that encloses the primitives drawn in the diagram.
  • PlotRange->Inherited inherits the page size specified in the model diagram. »
  • Properties related to equations and variables: »
  • "SystemEquations"differential and algebraic equations
    "InitialEquations"initial value equations
    "StateVariables"differentiated variables
    "AlgebraicVariables"non-differentiated variables
    "SystemVariables"state and algebraic variables
    "InputVariables"variables specified as inputs
    "OutputVariables"variables specified as outputs
    "ParameterNames"parameters
    "DiscreteVariables"variables changing only at events
  • "SystemEquations" gives equations depending on t.
  • WSMModelData["mmodel","SystemEquations",t] gives equations depending on t.
  • WSMModelData[…] contains Missing[type,content] for any parts of equations that cannot be represented.
  • "InputVariables" are distinct from "SystemVariables", and "OutputVariables" are a subset of "SystemVariables".
  • "DiscreteVariables" are a subset of "SystemVariables", and are given in a form suitable as a setting for the DiscreteVariables option to NDSolve.
  • Properties related to values: »
  • "ParameterValues"parameter rules {p1->val1,…}
    "InitialValues"initial value rules {v1->val1,…}
    "GroupedInitialValues"initial values grouped by state, input, and output
  • For variable and parameter lists, WSMModelData["mmodel",{prop,patt}] returns the elements of prop whose Modelica form match the string pattern patt.
  • Properties related to the structure of the model:
  • "BaseClasses"classes the model extends
    "Components"model components
    "Connections"model connections
    "Connectors"model connector components
    "LocalComponents"components defined locally in model
  • Properties related to relations with other models:
  • "ExtendingClasses"classes that build upon this model
    "InstantiatingClasses"classes that use this model as a component
  • The shortest unique model name mmodel can be used where WSMNames["*.mmodel"] gives a unique match.
  • The following options can be given:
  • Method Automaticmethods for equation processing
  • Possible settings for "opti" in Method->{"opt1"->val1} include:
  • "Elimination"Alleliminate simple equations
    "ReduceIndex"Truereduced index of DAEs in balanced models
    "StartTime"0simulation start time

Examples

open allclose all

Basic Examples  (4)Summary of the most common use cases

Load Wolfram System Modeler Link:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-3qjmkz

Show a model represented by a diagram:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-ckywz8
Out[1]=1

Use the diagram representation as input:

In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-3hage
Out[2]=2

Show a summary of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-b6izoh
Out[1]=1

Get the differential equations for a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-d9znhd
Out[1]=1

Scope  (30)Survey of the scope of standard use cases

General Properties  (12)

Show a list of possible properties:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-g14mpi
Out[1]=1

Get the description of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-cz7biy
Out[1]=1

Get the diagram of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-dcrpac
Out[1]=1

Show the grid:

In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-n2duia
Out[2]=2

Show frame ticks:

In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-fllke4
Out[3]=3

Get the diagram of a component in a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-oqskcd
Out[1]=1

Increase the PlotRangePadding for a diagram:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-rbh5co
Out[1]=1

Show the diagram of a model without a frame, using the page size from the model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-hltvch
Out[1]=1

Show the icon of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-4lg7hc
Out[1]=1

Show the text view of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-dzjcz3

Get the path of the file containing a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-wzyhhm
Out[1]=1

Get the names of saved plots in the model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-iaz2x6
In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-pgei9z
Out[2]=2

Simulate and show a saved plot:

In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-qilkkl
Out[3]=3

Plots are inherited:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-9isyqm
In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-bahuzv
Out[2]=2

There are no plots saved locally in the model:

In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-77mkv9
Out[3]=3

The saved model comes from the base class:

In[4]:=4
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-rtqela
Out[4]=4
In[5]:=5
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-cjkxen
Out[5]=5

Retrieve the model name of a diagram representation:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-d655vc
Out[1]=1

Variables and Equations  (9)

Get the system equations of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-72ee5
Out[1]=1

Get the initial equations of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-fw3v6y
Out[1]=1

Get all state variables of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-dhoyio
Out[1]=1

Get a list of all algebraic variables in the model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-lmeh03
Out[1]=1

Get a list of all system variables in the model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-d12m7a
Out[1]=1

Get a list of all input variables in the model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-tqsj2b
Out[1]=1

Get a list of all output variables in the model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-p7rcfu
Out[1]=1

Get the discrete variables of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-yu6pt
Out[1]=1

Get all parameter names of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-hd4drc
Out[1]=1

Initial and Parameter Values  (3)

Get all parameter values of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-cmvnhe

Get all initial values of a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-fd8olg

Get initial values grouped by state, input, and output:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-rcrppa
Out[1]=1

Naming  (2)

By default, equations use t as the time variable:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-cngju5
Out[1]=1

Get the differential equations depending on a chosen variable:

In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-gy68i2
Out[2]=2

Get parameter values matching a pattern:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-r5qdu
Out[1]=1

Structural Properties  (4)

Get the classes a model builds on:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-jf0xe0
Out[1]=1

Get the components and connections in a DC motor model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-mth9xq
In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-z98ph0
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-xiy7bl
Out[3]=3

Get the components locally declared in a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-itc8r4
Out[1]=1

"Components" includes inherited components:

In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-ma9zle
Out[2]=2

Get the connectors in a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-fpf8ro
Out[1]=1

Options  (3)Common values & functionality for each option

Method  (3)

Use a custom start time in initial equations:

In[53]:=53
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-q9xgje
Out[53]=53

The Method option "Elimination" can be used to eliminate redundant equations:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-rcavqz
In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-ewdp7r
Out[2]=2

Elimination can greatly reduce the number of equations:

In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-durr3
Out[3]=3

Disable index reduction with the method option "ReduceIndex":

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-nolh3i
Out[1]=1

Applications  (4)Sample problems that can be solved with this function

Solve equations using NDSolve:

In[58]:=58
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-bhs4h4
In[59]:=59
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-b1t7s

Construct initial equations from an initial values list:

In[60]:=60
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-cxjd59

Solve the system:

In[61]:=61
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-i5owp
Out[61]=61

Plot the found solution:

In[62]:=62
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-clkap2
Out[62]=62

Solve equations using DSolve:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-b6jqus

Get the equations and system variables:

In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-l8at9q
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-jc01kp
Out[3]=3

Get initial values:

In[4]:=4
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-e00uct
Out[4]=4

Combine the equations and replace all parameters with their default values:

In[5]:=5
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-czbn56
Out[5]=5

Solve the system and plot the result:

In[6]:=6
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-fk1rfk
Out[6]=6
In[7]:=7
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-gk3iqo
Out[7]=7

Find an equilibrium point for a model:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-j5qzr7

Get the equations:

In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-fjqrd5
Out[2]=2

Set derivatives to zero and solve:

In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-ib2tmk
Out[3]=3

WSMFindEquilibrium gives the same result:

In[4]:=4
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-nrxxrd
Out[4]=4

Use the differential equations to study the behavior of a damped pendulum:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-rfsk2
In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-cfxf1o
In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-hrjws5
In[4]:=4
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-clhqzc
Out[4]=4

Properties & Relations  (3)Properties of the function, and connections to other functions

Compare the solutions from WSMSimulate and NDSolve:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-henk5h
In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-pi9ke
In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-ghtb0l
In[4]:=4
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-ddbt0s

Solve using NDSolve:

In[5]:=5
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-bl02j5

Solve using WSMSimulate:

In[6]:=6
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-h9cvuq
In[7]:=7
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-eakxc7
In[8]:=8
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-j8t3th
Out[8]=8

A model is represented by its diagram:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-bkk3gf
Out[1]=1

The diagram representation evaluates to WSMModelData["modelname"]:

In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-gmrltu

The diagram representation can be used directly as input in other functions:

In[3]:=3
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-f6gdao
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-nwc40
Out[4]=4

A diagram of a component may be different than a diagram of the component class:

In[1]:=1
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-5kdhjo
Out[1]=1

The motor class itself does not have parameters set:

In[2]:=2
✖
https://wolfram.com/xid/0g0htzbt3k4oefob7r6l4iid1ya-vzgg7o
Out[2]=2