@@ -76,331 +76,3 @@ The example below contains a root system with two subsystems, ``WC1`` and ``WC2`
7676 </ssd:Annotations>
7777 </ssd:System>
7878 </ssd:SystemStructureDescription>
79-
80- .. index:: SSP; TLM Systems
81-
82- TLM Systems
83- -----------
84-
85- TLM systems are only allowed on top-level. SSD annotations are used to specify the system type inside the ``ssd:SimulationInformation`` tag, as shown in the example below. Attributes ``ip``, ``managerport`` and ``monitorport`` defines the socket communication, used both to exchange data with external tools and with internal simulation threads.
86-
87- .. code-block:: xml
88- :emphasize-lines: 4-8
89-
90- <?xml version="1.0"?>
91- <ssd:System name="tlm">
92- <ssd:SimulationInformation>
93- <ssd:Annotations>
94- <ssd:Annotation type="org.openmodelica">
95- <oms:TlmMaster ip="127.0.1.1" managerport="11111" monitorport="11121"/>
96- </ssd:Annotation>
97- </ssd:Annotations>
98- </ssd:SimulationInformation>
99- <ssd:Elements>
100- <ssd:System name="weaklycoupled">
101- <ssd:SimulationInformation>
102- <ssd:FixedStepMaster description="oms-ma" stepSize="1e-1" />
103- </ssd:SimulationInformation>
104- </ssd:System>
105- </ssd:Elements>
106- </ssd:System>
107-
108-
109- .. index:: SSP; TLM connections
110-
111- TLM Connections
112- ---------------
113-
114- TLM connections are implemented without regular SSD connections. TLM connections are only allowed in TLM systems. TLM connectors are only allowed in weakly coupled or strongly coupled systems. Both connectors and connections are implemented as SSD annotations in the System tag.
115-
116- The example below shows a TLM system containing two weakly coupled systems, ``wc1`` and ``wc2``. System ``wc1`` contains two TLM connectors, one of type 1D signal and one of type 1D mechanical. System ``wc2`` contains only a 1D signal type connector. The two 1D signal connectors are connected to each other in the TLM top-level system.
117-
118- .. code-block:: xml
119- :emphasize-lines: 8-17,26-43,46-56
120-
121- <?xml version="1.0"?>
122- <ssd:System name="tlm">
123- <ssd:Elements>
124- <ssd:System name="wc2">
125- <ssd:Connectors>
126- <ssd:Connector name="y" kind="input" type="Real" />
127- </ssd:Connectors>
128- <ssd:Annotations>
129- <ssd:Annotation type="org.openmodelica">
130- <oms:Bus name="bus2" type="tlm" domain="signal"
131- dimension="1" interpolation="none">
132- <oms:Signals>
133- <oms:Signal name="y" tlmType="value" />
134- </oms:Signals>
135- </oms:Bus>
136- </ssd:Annotation>
137- </ssd:Annotations>
138- </ssd:System>
139- <ssd:System name="wc1">
140- <ssd:Connectors>
141- <ssd:Connector name="y" kind="output" type="Real" />
142- <ssd:Connector name="x" kind="output" type="Real" />
143- <ssd:Connector name="v" kind="output" type="Real" />
144- <ssd:Connector name="f" kind="input" type="Real" />
145- </ssd:Connectors>
146- <ssd:Annotations>
147- <ssd:Annotation type="org.openmodelica">
148- <oms:Bus name="bus1" type="tlm" domain="signal"
149- dimension="1" interpolation="none">
150- <oms:Signals>
151- <oms:Signal name="y" tlmType="value" />
152- </oms:Signals>
153- </oms:Bus>
154- <oms:Bus name="bus2" type="tlm" domain="mechanical"
155- dimension="1" interpolation="none">
156- <oms:Signals>
157- <oms:Signal name="x" tlmType="state" />
158- <oms:Signal name="v" tlmType="flow" />
159- <oms:Signal name="f" tlmType="effort" />
160- </oms:Signals>
161- </oms:Bus>
162- </ssd:Annotation>
163- </ssd:Annotations>
164- </ssd:System>
165- </ssd:Elements>
166- <ssd:Annotations>
167- <ssd:Annotation type="org.openmodelica">
168- <oms:Connections>
169- <oms:Connection startElement="wc1" startConnector="bus1"
170- endElement="wc2" endConnector="bus2"
171- delay="0.001000" alpha="0.300000"
172- linearimpedance="100.000000"
173- angularimpedance="0.000000" />
174- </oms:Connections>
175- </ssd:Annotation>
176- </ssd:Annotations>
177- </ssd:System>
178-
179-
180- .. index::SSP; TLM Connector Types
181-
182- Depending on the type of TLM bus connector (dimension, domain and interpolation), connectors need to be assigned to different tlm variable types. Below is the complete list of supported TLM bus types and their respective connectors.
183-
184- **1D signal**
185-
186- ============= ==============
187- tlmType causality
188- ============= ==============
189- ``"value"`` input/output
190- ============= ==============
191-
192- **1D physical (no interpolation)**
193-
194- ============== ==============
195- tlmType causality
196- ============== ==============
197- ``"state"`` output
198- ``"flow"`` output
199- ``"effort"`` input
200- ============== ==============
201-
202- **1D physical (coarse-grained interpolation)**
203-
204- ================ ==============
205- tlmType causality
206- ================ ==============
207- ``"state"`` output
208- ``"flow"`` output
209- ``"wave"`` input
210- ``"impedance"`` input
211- ================ ==============
212-
213- **1D physical (fine-grained interpolation)**
214-
215- ================ ==============
216- tlmType causality
217- ================ ==============
218- ``"state"`` output
219- ``"flow"`` output
220- ``"wave1"`` input
221- ``"wave2"`` input
222- ``"wave3"`` input
223- ``"wave4"`` input
224- ``"wave5"`` input
225- ``"wave6"`` input
226- ``"wave7"`` input
227- ``"wave8"`` input
228- ``"wave9"`` input
229- ``"wave10"`` input
230- ``"time1"`` input
231- ``"time2"`` input
232- ``"time3"`` input
233- ``"time4"`` input
234- ``"time5"`` input
235- ``"time6"`` input
236- ``"time7"`` input
237- ``"time8"`` input
238- ``"time9"`` input
239- ``"time10"`` input
240- ``"impedance"`` input
241- ================ ==============
242-
243- **3D physical (no interpolation)**
244-
245- ================== ==============
246- tlmType causality
247- ================== ==============
248- ``"state1"`` output
249- ``"state2"`` output
250- ``"state3"`` output
251- ``"A11"`` output
252- ``"A12"`` output
253- ``"A13"`` output
254- ``"A21"`` output
255- ``"A22"`` output
256- ``"A23"`` output
257- ``"A31"`` output
258- ``"A32"`` output
259- ``"A33"`` output
260- ``"flow1"`` output
261- ``"flow2"`` output
262- ``"flow3"`` output
263- ``"flow4"`` output
264- ``"flow5"`` output
265- ``"flow6"`` output
266- ``"effort1"`` input
267- ``"effort2"`` input
268- ``"effort3"`` input
269- ``"effort4"`` input
270- ``"effort5"`` input
271- ``"effort6"`` input
272- ================== ==============
273-
274-
275-
276-
277- **3D physical (coarse-grained interpolation)**
278-
279- ====================== ==============
280- tlmType causality
281- ====================== ==============
282- ``"state1"`` output
283- ``"state2"`` output
284- ``"state3"`` output
285- ``"A11"`` output
286- ``"A12"`` output
287- ``"A13"`` output
288- ``"A21"`` output
289- ``"A22"`` output
290- ``"A23"`` output
291- ``"A31"`` output
292- ``"A32"`` output
293- ``"A33"`` output
294- ``"flow1"`` output
295- ``"flow2"`` output
296- ``"flow3"`` output
297- ``"flow4"`` output
298- ``"flow5"`` output
299- ``"flow6"`` output
300- ``"wave1"`` input
301- ``"wave2"`` input
302- ``"wave3"`` input
303- ``"wave4"`` input
304- ``"wave5"`` input
305- ``"wave6"`` input
306- ``"linearimpedance"`` input
307- ``"angularimpedance"`` input
308- ====================== ==============
309-
310- **3D physical (fine-grained interpolation)**
311-
312- ====================== ==============
313- tlmType causality
314- ====================== ==============
315- ``"state1"`` output
316- ``"state2"`` output
317- ``"state3"`` output
318- ``"A11"`` output
319- ``"A12"`` output
320- ``"A13"`` output
321- ``"A21"`` output
322- ``"A22"`` output
323- ``"A23"`` output
324- ``"A31"`` output
325- ``"A32"`` output
326- ``"A33"`` output
327- ``"flow1"`` output
328- ``"flow2"`` output
329- ``"flow3"`` output
330- ``"flow4"`` output
331- ``"flow5"`` output
332- ``"flow6"`` output
333- ``"wave1_1"`` input
334- ``"wave1_2"`` input
335- ``"wave1_3"`` input
336- ``"wave1_4"`` input
337- ``"wave1_5"`` input
338- ``"wave1_6"`` input
339- ``"wave2_1"`` input
340- ``"wave2_2"`` input
341- ``"wave2_3"`` input
342- ``"wave2_4"`` input
343- ``"wave2_5"`` input
344- ``"wave2_6"`` input
345- ``"wave3_1"`` input
346- ``"wave3_2"`` input
347- ``"wave3_3"`` input
348- ``"wave3_4"`` input
349- ``"wave3_5"`` input
350- ``"wave3_6"`` input
351- ``"wave4_1"`` input
352- ``"wave4_2"`` input
353- ``"wave4_3"`` input
354- ``"wave4_4"`` input
355- ``"wave4_5"`` input
356- ``"wave4_6"`` input
357- ``"wave5_1"`` input
358- ``"wave5_2"`` input
359- ``"wave5_3"`` input
360- ``"wave5_4"`` input
361- ``"wave5_5"`` input
362- ``"wave5_6"`` input
363- ``"wave6_1"`` input
364- ``"wave6_2"`` input
365- ``"wave6_3"`` input
366- ``"wave6_4"`` input
367- ``"wave6_5"`` input
368- ``"wave6_6"`` input
369- ``"wave7_1"`` input
370- ``"wave7_2"`` input
371- ``"wave7_3"`` input
372- ``"wave7_4"`` input
373- ``"wave7_5"`` input
374- ``"wave7_6"`` input
375- ``"wave8_1"`` input
376- ``"wave8_2"`` input
377- ``"wave8_3"`` input
378- ``"wave8_4"`` input
379- ``"wave8_5"`` input
380- ``"wave8_6"`` input
381- ``"wave9_1"`` input
382- ``"wave9_2"`` input
383- ``"wave9_3"`` input
384- ``"wave9_4"`` input
385- ``"wave9_5"`` input
386- ``"wave9_6"`` input
387- ``"wave10_1"`` input
388- ``"wave10_2"`` input
389- ``"wave10_3"`` input
390- ``"wave10_4"`` input
391- ``"wave10_5"`` input
392- ``"wave10_6"`` input
393- ``"time1"`` input
394- ``"time2"`` input
395- ``"time3"`` input
396- ``"time4"`` input
397- ``"time5"`` input
398- ``"time6"`` input
399- ``"time7"`` input
400- ``"time8"`` input
401- ``"time9"`` input
402- ``"time10"`` input
403- ``"linearimpedance"`` input
404- ``"angularimpedance"`` input
405- ====================== ==============
406-
0 commit comments