rumoca 0.7.28

Modelica compiler written in RUST
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
//! MLS §9: Medium Priority Connector and Connection Tests
//!
//! This module tests medium priority normative requirements:
//! - §9.1: Connector restrictions (no parameter/constant)
//! - §9.2: Flow singleton sets (unconnected flow)
//! - §9.3: Mixed flow/non-flow forbidden
//! - §9.4: Expandable connectors
//! - §9.5: Overconstrained connections
//!
//! Reference: https://specification.modelica.org/master/connectors-connections.html

use crate::spec::{expect_failure, expect_parse_success, expect_success};

// ============================================================================
// §9.1 CONNECTOR RESTRICTIONS
// ============================================================================

/// MLS §9.1: Connector declaration restrictions
mod connector_restrictions {
    use super::*;

    /// MLS: "Connectors cannot have parameter components with flow/potential"
    #[test]
    #[ignore = "Connector parameter restriction not yet implemented"]
    fn mls_9_1_connector_no_parameter() {
        expect_failure(
            r#"
            connector BadConnector
                parameter Real p = 1.0;
                Real v;
                flow Real i;
            end BadConnector;
            "#,
            "BadConnector",
        );
    }

    /// MLS: "Connectors cannot have constant components"
    #[test]
    #[ignore = "Connector constant restriction not yet implemented"]
    fn mls_9_1_connector_no_constant() {
        expect_failure(
            r#"
            connector BadConnector
                constant Real c = 1.0;
                Real v;
                flow Real i;
            end BadConnector;
            "#,
            "BadConnector",
        );
    }

    /// Valid: Connector with only potential and flow
    #[test]
    fn mls_9_1_valid_connector() {
        expect_success(
            r#"
            connector Pin
                Real v;
                flow Real i;
            end Pin;

            model Test
                Pin p;
            equation
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Connector with nested connector
    #[test]
    fn mls_9_1_nested_connector() {
        expect_success(
            r#"
            connector Inner
                Real x;
                flow Real f;
            end Inner;

            connector Outer
                Inner a;
                Inner b;
            end Outer;

            model Test
                Outer o;
            equation
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §9.2 FLOW VARIABLE RESTRICTIONS
// ============================================================================

/// MLS §9.2: Flow variable handling
mod flow_restrictions {
    use super::*;

    /// MLS: "Unconnected flow variables are set to zero"
    #[test]
    fn mls_9_2_unconnected_flow_zero() {
        expect_success(
            r#"
            connector Pin
                Real v;
                flow Real i;
            end Pin;

            model Test
                Pin p;
            equation
                p.v = 1.0;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "Flow variables sum to zero at connection"
    #[test]
    fn mls_9_2_flow_sum_zero() {
        expect_success(
            r#"
            connector Pin
                Real v;
                flow Real i;
            end Pin;

            model Resistor
                Pin p, n;
                parameter Real R = 1;
            equation
                p.v - n.v = R * p.i;
                p.i + n.i = 0;
            end Resistor;

            model Test
                Resistor r1, r2;
            equation
                connect(r1.n, r2.p);
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "Flow sign convention: positive into component"
    #[test]
    fn mls_9_2_flow_sign_convention() {
        expect_success(
            r#"
            connector Pin
                Real v;
                flow Real i;
            end Pin;

            model Source
                Pin p;
                parameter Real I = 1;
            equation
                p.i = -I;
            end Source;

            model Load
                Pin p;
            equation
                p.i = p.v;
            end Load;

            model Test
                Source src;
                Load load;
            equation
                connect(src.p, load.p);
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §9.3 CONNECTION RESTRICTIONS
// ============================================================================

/// MLS §9.3: Connection restrictions
mod connection_restrictions {
    use super::*;

    /// MLS: "Cannot connect flow to non-flow variable"
    #[test]
    #[ignore = "Flow/non-flow mixing check not yet implemented"]
    fn mls_9_3_no_flow_nonflow_mix() {
        expect_failure(
            r#"
            connector FlowConnector
                flow Real f;
            end FlowConnector;

            connector PotentialConnector
                Real v;
            end PotentialConnector;

            model Test
                FlowConnector fc;
                PotentialConnector pc;
            equation
                connect(fc.f, pc.v);
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "Connectors in connect must be compatible"
    #[test]
    fn mls_9_3_connector_type_mismatch() {
        expect_failure(
            r#"
            connector ElectricalPin
                Real v;
                flow Real i;
            end ElectricalPin;

            connector MechanicalFlange
                Real s;
                flow Real f;
            end MechanicalFlange;

            model Test
                ElectricalPin ep;
                MechanicalFlange mf;
            equation
                connect(ep, mf);
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Compatible connector types
    #[test]
    fn mls_9_3_compatible_connectors() {
        expect_success(
            r#"
            connector Pin
                Real v;
                flow Real i;
            end Pin;

            model Component
                Pin p, n;
            equation
            end Component;

            model Test
                Component c1, c2;
            equation
                connect(c1.n, c2.p);
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §9.4 EXPANDABLE CONNECTORS
// ============================================================================

/// MLS §9.4: Expandable connector rules
mod expandable_connectors {
    use super::*;

    /// MLS: "expandable connector syntax"
    #[test]
    fn mls_9_4_expandable_syntax() {
        expect_parse_success(
            r#"
            expandable connector Bus
            end Bus;

            model Test
                Bus bus;
            equation
            end Test;
            "#,
        );
    }

    /// MLS: "expandable connector can have any variables added"
    #[test]
    fn mls_9_4_expandable_dynamic() {
        expect_parse_success(
            r#"
            expandable connector Bus
            end Bus;

            connector Signal
                Real s;
            end Signal;

            model Sender
                Bus bus;
                Signal sig;
            equation
                connect(sig, bus.signal1);
            end Sender;
            "#,
        );
    }

    /// MLS: "flow forbidden in expandable connector declaration"
    #[test]
    #[ignore = "expandable connector flow restriction not yet implemented"]
    fn mls_9_4_expandable_no_flow() {
        expect_failure(
            r#"
            expandable connector BadBus
                flow Real f;
            end BadBus;
            "#,
            "BadBus",
        );
    }

    /// MLS: "expandable only connects to expandable"
    #[test]
    #[ignore = "expandable connector type check not yet implemented"]
    fn mls_9_4_expandable_to_expandable() {
        expect_failure(
            r#"
            expandable connector Bus
            end Bus;

            connector Pin
                Real v;
                flow Real i;
            end Pin;

            model Test
                Bus bus;
                Pin pin;
            equation
                connect(bus, pin);
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §9.5 OVERCONSTRAINED CONNECTIONS
// ============================================================================

/// MLS §9.5: Overconstrained connection equations
mod overconstrained_connections {
    use super::*;

    /// MLS: "Connections.branch creates a spanning tree edge"
    #[test]
    fn mls_9_5_connections_branch() {
        expect_parse_success(
            r#"
            connector Frame
                Real r[3];
                Real T[3,3];
            end Frame;

            model Body
                Frame frame_a, frame_b;
            equation
                Connections.branch(frame_a, frame_b);
            end Body;
            "#,
        );
    }

    /// MLS: "Connections.root specifies the root of spanning tree"
    #[test]
    fn mls_9_5_connections_root() {
        expect_parse_success(
            r#"
            connector Frame
                Real r[3];
            end Frame;

            model World
                Frame frame;
            equation
                Connections.root(frame);
            end World;
            "#,
        );
    }

    /// MLS: "Connections.potentialRoot marks potential root"
    #[test]
    fn mls_9_5_connections_potential_root() {
        expect_parse_success(
            r#"
            connector Frame
                Real r[3];
            end Frame;

            model Body
                Frame frame;
            equation
                Connections.potentialRoot(frame, priority=1);
            end Body;
            "#,
        );
    }

    /// MLS: "Connections.isRoot queries if connector is root"
    #[test]
    fn mls_9_5_connections_is_root() {
        expect_parse_success(
            r#"
            connector Frame
                Real r[3];
            end Frame;

            model Body
                Frame frame;
                Boolean isRoot;
            equation
                isRoot = Connections.isRoot(frame);
            end Body;
            "#,
        );
    }

    /// MLS: "Connections.rooted queries if rooted"
    #[test]
    fn mls_9_5_connections_rooted() {
        expect_parse_success(
            r#"
            connector Frame
                Real r[3];
            end Frame;

            model Body
                Frame frame_a, frame_b;
                Boolean aRooted;
            equation
                Connections.branch(frame_a, frame_b);
                aRooted = Connections.rooted(frame_a);
            end Body;
            "#,
        );
    }

    /// MLS: "equalityConstraint function for overdetermined systems"
    #[test]
    fn mls_9_5_equality_constraint() {
        expect_parse_success(
            r#"
            connector Orientation
                Real T[3,3];

                function equalityConstraint
                    input Orientation oc1;
                    input Orientation oc2;
                    output Real residue[3];
                algorithm
                    residue := {0, 0, 0};
                end equalityConstraint;
            end Orientation;
            "#,
        );
    }
}