OMPython/tests/test_ModelicaSystemRunner.py at 207c47d09cea7358f4f4767093e42915e63c8dac · syntron/OMPython · GitHub

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
import numpy as np
import pytest

import OMPython


@pytest.fixture
def model_firstorder_content():
    return """
model M
  Real x(start = 1, fixed = true);
  parameter Real a = -1;
equation
  der(x) = x*a;
end M;
"""


@pytest.fixture
def model_firstorder(tmp_path, model_firstorder_content):
    mod = tmp_path / "M.mo"
    mod.write_text(model_firstorder_content)
    return mod


@pytest.fixture
def param():
    x0 = 1
    a = -1
    tau = -1 / a
    stopTime = 5*tau

    return {
        'x0': x0,
        'a': a,
        'stopTime': stopTime,
    }


def test_runner(model_firstorder, param):
    # create a model using ModelicaSystem
    mod = OMPython.ModelicaSystemOMC()
    mod.model(
        model_file=model_firstorder,
        model_name="M",
    )

    resultfile_mod = mod.getWorkDirectory() / f"{mod.get_model_name()}_res_mod.mat"
    _run_simulation(mod=mod, resultfile=resultfile_mod, param=param)

    # run the model using only the runner class
    omcs = OMPython.OMSessionRunner(
        version=mod.get_session().get_version(),
    )
    modr = OMPython.ModelicaSystemRunner(
        session=omcs,
        work_directory=mod.getWorkDirectory(),
    )
    modr.setup(
        model_name="M",
    )

    resultfile_modr = mod.getWorkDirectory() / f"{mod.get_model_name()}_res_modr.mat"
    _run_simulation(mod=modr, resultfile=resultfile_modr, param=param)

    # cannot check the content as runner does not have the capability to open a result file
    assert resultfile_mod.size() == resultfile_modr.size()

    # check results
    _check_result(mod=mod, resultfile=resultfile_mod, param=param)
    _check_result(mod=mod, resultfile=resultfile_modr, param=param)


def _run_simulation(mod, resultfile, param):
    simOptions = {"stopTime": param['stopTime'], "stepSize": 0.1, "tolerance": 1e-8}
    mod.setSimulationOptions(**simOptions)
    mod.simulate(resultfile=resultfile)

    assert resultfile.exists()


def _check_result(mod, resultfile, param):
    x = mod.getSolutions(resultfile=resultfile, varList="x")
    t, x2 = mod.getSolutions(resultfile=resultfile, varList=["time", "x"])
    assert (x2 == x).all()
    sol_names = mod.getSolutions(resultfile=resultfile)
    assert isinstance(sol_names, tuple)
    assert "time" in sol_names
    assert "x" in sol_names
    assert "der(x)" in sol_names
    with pytest.raises(OMPython.ModelicaSystemError):
        mod.getSolutions(resultfile=resultfile, varList="thisVariableDoesNotExist")
    assert np.isclose(t[0], 0), "time does not start at 0"
    assert np.isclose(t[-1], param['stopTime']), "time does not end at stopTime"
    x_analytical = param['x0'] * np.exp(param['a']*t)
    assert np.isclose(x, x_analytical, rtol=1e-4).all()