Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor edits needed for release #45

Merged
merged 7 commits into from
Oct 25, 2024
Merged

Minor edits needed for release #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fec8d7a
Update FMI references to FMI 3.0
pmai Oct 12, 2024
f5147a5
Update copyrights in schemas (fix #42)
pmai Oct 12, 2024
84662e7
Update reference to OSMP
pmai Oct 12, 2024
1f0a539
Remove no-longer true sentence on causal connections
pmai Oct 25, 2024
f0dcdf9
Adjust wording for FMI 3.0
pmai Oct 25, 2024
b7b2ef3
Add missing description of signature element
pmai Oct 25, 2024
195781c
Further 2.0/3.0 wording update
pmai Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/1___overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ SSP is a tool-independent format for the description, packaging and exchange of
The standard is comprised of a set of XML-based formats to describe a network of component models with their signal flow and parametrization, as well as a ZIP-based packaging format for efficient distribution of entire systems, including any referenced models and other resources.
This description is tool neutral and is intended to be used primarly as an exchange format of simulation system descriptions between different tools.

SSP can be seen as an extension to the FMI (Functional Mockup Interface) standard [FMI20].
SSP can be seen as an extension to the FMI (Functional Mockup Interface) standard [FMI30].
FMI describes a tool independent standard to exchange single simulation models.
Using SSP, complete systems consisting of multiple interconnected simulation models can be defined with the desired signal flow and also with the wanted parameterization of each single model as well as the parameters for the complete system.
This system topology can include hierarchies of sub-systems for proper structuring of the overall system.
Expand Down Expand Up @@ -52,7 +52,6 @@ From a simulation perspective, each component has to be described with its input
This can be done using SSP by defining the wrapper of this component with an empty Component element comprising the connectors for the inputs and outputs and the component's parameters.

The interaction of the components is defined by the connections.
Connections in SSP are always causal.
Connections can be made directly between components or via signal dictionaries.
A signal dictionary is a collection of signals similar to a bus concept (e.g. like a CAN bus).
During the design phase of a system, a signal dictionary can be a good way to predefine the available signal connections.
Expand Down
14 changes: 8 additions & 6 deletions docs/4___common_content.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ The following XML child elements are specified for the Unit element:
===== BaseUnit

This element defines the base unit of the given unit in SI units.
This is completely aligned with the specification of base units in section 2.2.2 of the FMI 2.0 standard [FMI20].
This is completely aligned with the specification of base units in section 2.4.3 of the FMI 3.0 standard [FMI30] and section 2.2.2 of the FMI 2.0 standard [FMI20].

image:images/image10.png[image,width=263,height=771]

Expand Down Expand Up @@ -312,7 +312,7 @@ The name *MUST* match the name of an Enumeration entry in the Enumerations XML e

image:images/image17.png[image,width=319,height=114]

This type specifies that the connector in question represents a length-terminated binary data type, like the binary type defined for the FMI 3.0 standard, or substitute types like the binary type defined via the OSI Sensor Model Packaging specification [OSMP120].
This type specifies that the connector in question represents a length-terminated binary data type, like the binary type defined for the FMI 3.0 standard, or substitute types like the binary type defined via the OSI Sensor Model Packaging specification [OSMP150].

[width="100%",cols="28%,72%",options="header",]
|===
Expand Down Expand Up @@ -466,13 +466,15 @@ This attribute references another connector by name, that gives the size of this

image:images/SystemStructureCommon_GMetaData.png[image,width=597,height=196]

The MetaData element allows the specification of additional meta data for a given model element.
Multiple (or no) MetaData elements may be present in a given model element.
The group GMetaData allows the specification of additional meta data and signatures for a given model element.
Multiple (or no) MetaData and Signature elements may be present in a given model element.

[width="100%",cols="33%,67%",options="header",]
|===
|Element |Description
|MetaData |One or more instances of this element *CAN* be present to specify meta data related to the containing model element.
|Element |Description
|MetaData |One or more instances of this element *CAN* be present to specify meta data related to the containing model element.
See below for details.
|Signature |One or more instances of this element *CAN* be present to specify signatures related to the containing model element.
See below for details.
|===

Expand Down
10 changes: 5 additions & 5 deletions docs/5___ssd.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ image:images/image24.png[image,width=449,height=248]

This element contains information of a default simulation setup that is supplied with the system definition for informational purposes.

{empty}[ _Note that in contrast to FMI 2.0 only start and stop time are specified here, since values like step size or tolerance depend on the specific solver or master algorithms employed and are hence not specified in this global element._
{empty}[ _Note that in contrast to FMI 2.0/3.0 only start and stop time are specified here, since values like step size or tolerance depend on the specific solver or master algorithms employed and are hence not specified in this global element._
_Additional solver or master algorithm specific information can be supplied through the annotation mechanism, or using a future layered standard._ ]

{empty}[ _The handling of systems comprising components with differing units for the independent variable depends on the implementation._
Expand Down Expand Up @@ -91,12 +91,12 @@ See below for details.
image:images/image26.png[image,width=371,height=82]

This optional element specifies the set of connectors of this model element, which represent the interface of the model element to the outside world.
For components the set of connectors *MUST* match variables/ports of the underlying component implementation, e.g., for referenced FMI 2.0 FMUs, the name of a connector has to match the name attribute of the corresponding <ScalarVariable> element; for referenced FMUs that follow the OSI Sensor Model Packaging specification [OSMP120], the name of a connector of type Binary has to match the name attribute of the corresponding <osmp:osmp-binary-variable>.
For components the set of connectors *MUST* match variables/ports of the underlying component implementation, e.g., for referenced FMI 2.0 FMUs, the name of a connector has to match the name attribute of the corresponding <ScalarVariable> element; for referenced FMUs that follow the OSI Sensor Model Packaging specification [OSMP150], the name of a connector of type Binary has to match the name attribute of the corresponding <osmp:osmp-binary-variable>.
For FMI 3.0 FMUs, the connector name has to match either the name of the corresponding variable element, or one of its <Alias> elements.

Names of variable elements of an FMU might follow the “Variable Naming Conventions” specification as defined by the FMI standard.
Hence, several ScalarVariables might be grouped as a structure or an array.
However, the name of a connector *MUST* match the name of a single <ScalarVariable>.
Hence, several variables might be grouped as a structure or an array.
However, the name of a connector *MUST* match the name of a single variable.

Note that there is no requirement that connectors have to be present for all variables/ports of an underlying component implementation.
At least those connectors *MUST* be present which are referenced in connections inside the SSD.
Expand Down Expand Up @@ -410,7 +410,7 @@ For structural parameters it is assumed that the parameterization is applied in
This means that variables eligible for parameterization are those with:

* either causality = "input" or a start value for FMI 1.0
* variability != "constant" and initial = "exact" or "approx" for FMI 2.0
* variability != "constant" and initial = "exact" or "approx" for FMI 2.0/3.0

All kinds of system connectors can be parameterized.
In case the system level connectors are connected to FMU components, the parameterization *MUST* be compatible with the variable in the connected FMU.
Expand Down
11 changes: 7 additions & 4 deletions docs/A___literature.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ https://semver.org/spec/v2.0.0.html
[XML10] World Wide Web Consortium: *Extensible Markup Language (XML) 1.0 (Fifth Edition).* W3C Recommendation. 2008. +
http://www.w3.org/TR/2008/REC-xml-20081126/

[FMI20] Modelica Association: *Functional Mock-up Interface for Model Exchange and Co-Simulation, Version 2.0.3.* 2021. +
https://github.com/modelica/fmi-standard/releases/download/v2.0.3/FMI-Specification-2.0.3.pdf
[FMI20] Modelica Association: *Functional Mock-up Interface for Model Exchange and Co-Simulation, Version 2.0.4.* 2022. +
https://github.com/modelica/fmi-standard/releases/download/v2.0.4/FMI-Specification-2.0.4.pdf

[OSMP120] ASAM e.V.: *OSI Sensor Model Packaging Version 1.2.0.* 2021. +
https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/releases/tag/v1.2.0
[FMI30] Modelica Association: *Functional Mock-up Interface Specification, Version 3.0.1.* 2023. +
https://fmi-standard.org/docs/3.0.1/

[OSMP150] ASAM e.V.: *OSI Sensor Model Packaging Version 1.5.0.* 2024. +
https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/releases/tag/v1.5.0
2 changes: 1 addition & 1 deletion schema/SystemStructureDescription.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Version: 2.0-alpha

Copyright 2016 -- 2019 Modelica Association Project "SSP"
Copyright 2016 -- 2024 Modelica Association Project "SSP"

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
Expand Down
2 changes: 1 addition & 1 deletion schema/SystemStructureDescription11.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

Version: 2.0-alpha

Copyright 2016 -- 2019 Modelica Association Project "SSP"
Copyright 2016 -- 2024 Modelica Association Project "SSP"

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
Expand Down
2 changes: 1 addition & 1 deletion schema/SystemStructureParameterMapping.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Version: 2.0-alpha

Copyright 2016 -- 2019 Modelica Association Project "SSP"
Copyright 2016 -- 2024 Modelica Association Project "SSP"

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
Expand Down
2 changes: 1 addition & 1 deletion schema/SystemStructureParameterValues.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Version: 2.0-alpha

Copyright 2016 -- 2019 Modelica Association Project "SSP"
Copyright 2016 -- 2024 Modelica Association Project "SSP"

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
Expand Down
2 changes: 1 addition & 1 deletion schema/SystemStructureSignalDictionary.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Version: 2.0-alpha

Copyright 2016 -- 2019 Modelica Association Project "SSP"
Copyright 2016 -- 2024 Modelica Association Project "SSP"

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
Expand Down