taktwerk 0.3.1

Fixed-step model execution engine for Linux with its own OPC UA server
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

//! `taktwerk inspect`: a model's declared interface as text.

use taktwerk_core::model::{Causality, Instances, ModelInterface};
use taktwerk_core::value::{Dim, Layout};

use crate::summary::{table, value_type};

/// Lower-case name of a causality.
pub const fn causality(c: Causality) -> &'static str {
    match c {
        Causality::Input => "input",
        Causality::Output => "output",
        Causality::Parameter => "parameter",
        Causality::Tunable => "tunable",
    }
}

/// `[nx, 3]`, or `scalar`.
pub fn symbolic_shape(shape: &[Dim]) -> String {
    if shape.is_empty() {
        return "scalar".to_owned();
    }
    let parts: Vec<String> = shape
        .iter()
        .map(|d| match d {
            Dim::Literal(n) => n.to_string(),
            Dim::Symbol(s) => s.clone(),
        })
        .collect();
    format!("[{}]", parts.join(", "))
}

/// The interface as `inspect` prints it.
pub fn interface(kind: &str, iface: &ModelInterface) -> String {
    let instances = match iface.instances {
        Instances::Single => "single",
        Instances::Multiple => "multiple",
    };
    let mut out = format!(
        "model {} ({kind})\ninstances {instances} per process\n\n",
        iface.name
    );
    if iface.dimensions.is_empty() {
        out.push_str("dimensions: none (fixed size)\n\n");
    } else {
        let mut rows = vec![vec![
            "dimension".to_owned(),
            "min".to_owned(),
            "max".to_owned(),
            "default".to_owned(),
        ]];
        let opt = |v: Option<usize>| v.map_or_else(|| "-".to_owned(), |n| n.to_string());
        for d in &iface.dimensions {
            rows.push(vec![d.name.clone(), opt(d.min), opt(d.max), opt(d.default)]);
        }
        out.push_str(&table(&rows));
        out.push('\n');
    }
    let mut rows = vec![vec![
        "variable".to_owned(),
        "causality".to_owned(),
        "type".to_owned(),
        "shape".to_owned(),
        "unit".to_owned(),
        "description".to_owned(),
    ]];
    for v in &iface.variables {
        let mut shape = symbolic_shape(&v.shape);
        if v.shape.len() > 1 && v.layout == Layout::ColumnMajor {
            shape.push_str(" col-major");
        }
        rows.push(vec![
            v.name.clone(),
            causality(v.causality).to_owned(),
            value_type(v.ty, v.text),
            shape,
            v.unit.clone().unwrap_or_else(|| "-".to_owned()),
            v.description.clone().unwrap_or_default(),
        ]);
    }
    out.push_str(&table(&rows));
    out
}

#[cfg(test)]
#[allow(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    reason = "tests"
)]
mod tests {
    use taktwerk_core::model::{Dimension, Variable};
    use taktwerk_core::value::ScalarType;

    use super::*;

    #[test]
    fn prints_dimensions_and_symbolic_shapes() {
        let iface = ModelInterface {
            name: "ss".into(),
            dimensions: vec![Dimension {
                name: "nx".into(),
                min: Some(1),
                max: None,
                default: Some(2),
            }],
            variables: vec![
                Variable {
                    name: "A".into(),
                    causality: Causality::Tunable,
                    ty: ScalarType::F64,
                    shape: vec![Dim::Symbol("nx".into()), Dim::Symbol("nx".into())],
                    layout: Layout::ColumnMajor,
                    unit: None,
                    description: Some("system matrix".into()),
                    text: false,
                },
                Variable {
                    name: "label".into(),
                    causality: Causality::Output,
                    ty: ScalarType::U8,
                    shape: vec![Dim::Literal(32)],
                    layout: Layout::RowMajor,
                    unit: None,
                    description: None,
                    text: true,
                },
            ],
            instances: Instances::Multiple,
        };
        let text = interface("fmi", &iface);
        assert!(
            text.starts_with("model ss (fmi)\ninstances multiple per process\n"),
            "{text}"
        );
        assert!(text.contains("  nx         1    -    2\n"), "{text}");
        assert!(
            text.contains("  A         tunable    f64   [nx, nx] col-major  -     system matrix\n"),
            "{text}"
        );
        assert!(
            text.contains("  label     output     text  [32]                -"),
            "{text}"
        );
    }
}