sofirpy.simulation.fmu module

Module containing the Fmu class.

class sofirpy.simulation.fmu.Fmu(fmu_path: Path, name: str, step_size: float)[source]

Bases: SimulationEntity

Class representing a fmu.

Parameters:

  • fmu_path (Path) – path to the fmu

  • step_size (float) – step size of the simulation

conclude_simulation() → None[source]

Conclude the simulation process of the FMU.

do_step(time: float) → None[source]

Perform a simulation step.

Parameters:

time (float) – current time

property fmu_path: Path

Path to the fmu.

Returns:

Path to the fmu.

Return type:

Path

get_dtype_of_parameter(parameter_name: str) → type[source]

Return the data type of a parameter.

Parameters:

parameter_name (str) – Name of the parameter.

Returns:

Data type of the parameter.

Return type:

type

get_parameter_value(parameter_name: str) → bool | float | int | str | object[source]

Return the value of a parameter.

Parameters:

parameter_name (str) – name of parameter whose value is to be obtained

Returns:

value of the parameter

Return type:

ParameterValue

get_unit(parameter_name: str) → str | None[source]

Return the unit of a variable.

Parameters:

parameter_name (str) – Name of the variable.

Returns:

The unit of the variable.

Return type:

str

initialize(start_values: dict[str, bool | float | int | str | object | tuple[bool | float | int | str | object, str]]) → None[source]

Initialize the fmu.

Parameters:

start_time (float, optional) – start time. Defaults to 0.

set_parameter(parameter_name: str, parameter_value: bool | float | int | str | object) → None[source]

Set the value of a parameter.

Parameters:

  • parameter_name (str) – name of the parameter that should be set

  • parameter_value (ParameterValue) – value to which the parameter is to be set