simulation.py
import numpy as np
import system_model
from scipy.integrate import solve_ivp
from ackrep_core import ResultContainer
from ackrep_core.system_model_management import save_plot_in_dir
import matplotlib.pyplot as plt
import os
# link to documentation with examples: https://ackrep-doc.readthedocs.io/en/latest/devdoc/contributing_data.html
def simulate():
"""
simulate the system model with scipy.integrate.solve_ivp
:return: result of solve_ivp
"""
model = system_model.Model()
rhs_xx_pp_symb = model.get_rhs_symbolic()
print("Computational Equations:\n")
for i, eq in enumerate(rhs_xx_pp_symb):
print(f"dot_x{i+1} =", eq)
rhs = model.get_rhs_func()
# ---------start of edit section--------------------------------------
# initial state values
xx0 = [0, 0]
t_end = 5
tt = np.linspace(0, t_end, 10000)
simulation_data = solve_ivp(rhs, (0, t_end), xx0, t_eval=tt)
# ---------end of edit section----------------------------------------
save_plot(simulation_data)
return simulation_data
def save_plot(simulation_data):
"""
plot your data and save the plot
:param simulation_data: simulation_data of system_model
:return: None
"""
# ---------start of edit section--------------------------------------
# plot of your data
# create figure + 2x2 axes array
fig1, axs = plt.subplots(nrows=2, ncols=1, figsize=(12.8, 9.6))
# print in axes top left
axs[0].plot(simulation_data.t, simulation_data.y[0])
axs[0].set_ylabel("Angular velocity [rad/s]") # y-label
axs[0].set_xlabel("Time [s]") # x-label
axs[0].grid()
# print in axes top right
axs[1].plot(simulation_data.t, simulation_data.y[1])
axs[1].set_ylabel("Armature current [A]") # y-label
axs[1].set_xlabel("Time [s]") # x-Label
axs[1].grid()
# ---------end of edit section----------------------------------------
plt.tight_layout()
save_plot_in_dir()
def evaluate_simulation(simulation_data):
"""
assert that the simulation results are as expected
:param simulation_data: simulation_data of system_model
:return:
"""
# ---------start of edit section--------------------------------------
# fill in final states of simulation to check your model
# simulation_data.y[i][-1]
expected_final_state = [29.901048, 0.2956656]
# ---------end of edit section----------------------------------------
rc = ResultContainer(score=1.0)
simulated_final_state = simulation_data.y[:, -1]
rc.final_state_errors = [
simulated_final_state[i] - expected_final_state[i] for i in np.arange(0, len(simulated_final_state))
]
rc.success = np.allclose(expected_final_state, simulated_final_state, rtol=0, atol=1e-2)
return rc
system_model.py
import sympy as sp
import symbtools as st
import importlib
import sys, os
# from ipydex import IPS, activate_ips_on_exception
from ackrep_core.system_model_management import GenericModel, import_parameters
# Import parameter_file
params = import_parameters()
# link to documentation with examples: https://ackrep-doc.readthedocs.io/en/latest/devdoc/contributing_data.html
class Model(GenericModel):
def initialize(self):
"""
this function is called by the constructor of GenericModel
:return: None
"""
# ---------start of edit section--------------------------------------
# Define number of inputs -- MODEL DEPENDENT
self.u_dim = 2
# Set "sys_dim" to constant value, if system dimension is constant
self.sys_dim = 2
# ---------end of edit section----------------------------------------
# check existence of params file
self.has_params = True
self.params = params
# ----------- SET DEFAULT INPUT FUNCTION ---------- #
# --------------- Only for non-autonomous Systems
def uu_default_func(self):
"""
define input function
:return:(function with 2 args - t, xx_nv) default input function
"""
# ---------start of edit section--------------------------------------
def uu_rhs(t, xx_nv):
"""
sequence of numerical input values
:param t:(scalar or vector) time
:param xx_nv:(vector or array of vectors) numeric state vector
:return:(list) numeric inputs
"""
if t < 2.5:
u_func_nv = 2
else:
u_func_nv = 6
if u_func_nv == 0:
e_func_nv = 0
else:
e_func_nv = 5e-2
return [u_func_nv, e_func_nv]
# ---------end of edit section----------------------------------------
return uu_rhs
# ----------- SYMBOLIC RHS FUNCTION ---------- #
def get_rhs_symbolic(self):
"""
define symbolic rhs function
:return: matrix of symbolic rhs-functions
"""
if self.dxx_dt_symb is not None:
return self.dxx_dt_symb
# ---------start of edit section--------------------------------------
x1, x2 = self.xx_symb # state components
c_phi, J, La, Ra = self.pp_symb # parameters
u1, u2 = self.uu_symb # inputs
# define symbolic rhs functions
dx1_dt = c_phi / J * x2 - u2 / J
dx2_dt = -Ra / La * x2 - c_phi / La * x1 + u1 / La
# rhs functions matrix
self.dxx_dt_symb = sp.Matrix([dx1_dt, dx2_dt])
# ---------end of edit section----------------------------------------
return self.dxx_dt_symb
parameters.py
import sys
import os
import numpy as np
import sympy as sp
import tabulate as tab
# link to documentation with examples: https://ackrep-doc.readthedocs.io/en/latest/devdoc/contributing_data.html
# set model name
model_name = "Permanent magnet DC motor"
# ---------- create symbolic parameters
pp_symb = [c_phi, J, La, Ra] = sp.symbols("c_phi, J, La, Ra", real=True)
# ---------- create symbolic parameter functions
# parameter values can be constant/fixed values OR set in relation to other parameters (for example: a = 2*b)
c_phi_sf = 0.169
J_sf = 1.7e-3
La_sf = 0.0256
Ra_sf = 3.2
# list of symbolic parameter functions
# tailing "_sf" stands for "symbolic parameter function"
pp_sf = [c_phi_sf, J_sf, La_sf, Ra_sf]
# ---------- list for substitution
# -- entries are tuples like: (independent symbolic parameter, numerical value)
pp_subs_list = []
# OPTONAL: Dictionary which defines how certain variables shall be written
# in the table - key: Symbolic Variable, Value: LaTeX Representation/Code
# useful for example for complex variables: {Z: r"\underline{Z}"}
latex_names = {}
# ---------- Define LaTeX table
# Define table header
# DON'T CHANGE FOLLOWING ENTRIES: "Symbol", "Value"
tabular_header = ["Parameter Name", "Symbol", "Value", "Unit"]
# Define column text alignments
col_alignment = ["left", "center", "left", "center"]
# Define Entries of all columns before the Symbol-Column
# --- Entries need to be latex code
col_1 = ["motor constant", "moment of inertia", "armature inductance", "armature resistance"]
# contains all lists of the columns before the "Symbol" Column
# --- Empty list, if there are no columns before the "Symbol" Column
start_columns_list = [col_1]
# Define Entries of the columns after the Value-Column
# --- Entries need to be latex code
col_4 = ["Vs", r"$Ws^3$", "H", r"$\Omega$"]
# contains all lists of columns after the FIX ENTRIES
# --- Empty list, if there are no columns after the "Value" column
end_columns_list = [col_4]