fmi-rs 0.3.1

Functional Mock-up Interface (FMI) for Rust
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


package fmi:fmi3@3.0.0;

// ── Model Exchange FMU ────────────────────────────────────────────────────────

// World implemented by a Model Exchange FMU component.
//
// The FMU exports the `common` and `model-exchange` interfaces.
// The host provides logging callbacks.
world model-exchange-fmu {
  // ── Imports (host provides) ──────────────────────────────────────────────
  import callbacks;

  // ── Exports (FMU provides) ───────────────────────────────────────────────

  /// Common variable access, lifecycle, and state-save/restore functions.
  export common;

  /// Model-Exchange–specific functions (set-time, derivatives, event indicators).
  export model-exchange;
}

// ── Co-Simulation FMU ─────────────────────────────────────────────────────────

// World implemented by a Co-Simulation FMU component.
//
// The FMU exports the `common` and `co-simulation` interfaces.
// The host provides logging and (optionally) intermediate-update callbacks.
world co-simulation-fmu {
  // ── Imports (host provides) ──────────────────────────────────────────────
  import callbacks;

  /// Optional: only required when instantiate-co-simulation is called with
  /// early-return-allowed = true.
  import intermediate-update-callbacks;

  // ── Exports (FMU provides) ───────────────────────────────────────────────
  export common;
  export co-simulation;
}

// ── Scheduled Execution FMU ───────────────────────────────────────────────────

// World implemented by a Scheduled Execution FMU component.
//
// The FMU exports the `common` and `scheduled-execution` interfaces.
// The host provides logging, clock-update, and preemption callbacks.
world scheduled-execution-fmu {
  // ── Imports (host provides) ──────────────────────────────────────────────

  /// All four callbacks (log-message, clock-update,
  /// lock-preemption, unlock-preemption) are mandatory for SE.
  import callbacks;

  // ── Exports (FMU provides) ───────────────────────────────────────────────
  export common;
  export scheduled-execution;
}

// ── Master Algorithm (importer) ───────────────────────────────────────────────

// World implemented by a master algorithm / simulation environment that
// can host all three FMU types simultaneously.
//
// This is a convenience world for toolchain authors; real masters typically
// target one interface kind at a time.
world master-algorithm {
  // The master imports (i.e. uses) each FMU interface kind.
  import common;
  import model-exchange;
  import co-simulation;
  import scheduled-execution;

  // The master exports the callback interfaces so FMUs can call back into it.
  export callbacks;
  export intermediate-update-callbacks;
}