sofirpy.simulation.fmu module

Module containing the Fmu class.

class sofirpy.simulation.fmu.Fmu(init_config: dict[str, Any])

Bases: SimulationEntity

Class representing a fmu.

Parameters:

fmu_path (Path) – path to the fmu

conclude_simulation() → None

Conclude the simulation process of the FMU.

do_step(time: float, step_size: float) → None

Perform a simulation step.

Parameters:

• time (float) – current time

• step_size (float) – simulation step size

property fmu_path: Path

Path to the fmu.

Returns:

Path to the fmu.

Return type:

Path

get_dtype_of_parameter(parameter_name: str) → type

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

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

Return the unit of a variable.

Parameters:

parameter_name (str) – Name of the variable.

Returns:

The unit of the variable.

Return type:

str | None

initialize() → None

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

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

class sofirpy.simulation.fmu.FmuInitConfig(*, fmu_path: ~pathlib.Path, name: str, start_values: dict[str, bool | float | int | str | object | tuple[bool | float | int | str | object, str]] = <factory>)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].