eelib.core.devices.heatpump.heatpump_simulator

Mosaik interface for the eELib heatpump model. Simulator for communication between orchestrator (mosaik) and heatpump entities.

Within this interface mosaik functionalities are used. Copyright (c) LGPL

Author: elenia@TUBS
Copyright 2024 elenia
This file is part of eELib, which is free software under the terms of the GNU GPL Version 3.

Module Contents

Classes

Sim

Simulator class for eELib heatpump model.

Attributes

ADAPTION_TOLERANCE

META

ADAPTION_TOLERANCE = '1e-05'
META
class Sim

Bases: mosaik_api_v3.Simulator

Simulator class for eELib heatpump model.

output_cache
data
entities
init(sid: str, scenario_config: dict, time_resolution: int = 1) → dict

Initializes parameters for an object of the Heatpump:Sim class.

Parameters:

  • sid (str) – ID of the created entity of the simulator (e.g. LoadSim-0)

  • scenario_config (dict) – scenario configuration data, like resolution or step size

  • time_resolution (int) – Time resolution of current scenario.

Returns:

description of the simulator

Return type:

dict

create(num: int, model_type: str, init_vals: dict) → dict

Creates entities of the eELib load model. Core function of mosaik.

Parameters:

  • num (int) – number of load models to created

  • model_type (str) – type of created instance (e.g. “household”)

  • init_vals (dict) – dict with initial values for each load entity

Raises:

ValueError – If entity ID is already existing

Returns:

created entities

Return type:

dict

get_entity_by_id(entity_id: str) → eelib.core.devices.heatpump.heatpump_model.Heatpump

Searches for a requested entity id and gives back the entity model.

Parameters:

entity_id (str) – id of the entity to be searched for

Returns:

entity model if found, None otherwise

Return type:

heatpump_model.Heatpump

step(time: int, inputs: dict, max_advance: int) → int

Performs simulation step calling the eELib load model. Core function of mosaik.

Parameters:

  • time (int) – current simulation time (given by mosaik)

  • inputs (dict, optional) – allocation of return values to specific models (NOT NEEDED FOR LOAD MODEL)

  • max_advance (int, optional) – simulation time until the simulator can safely advance it’s internal time without causing any causality errors.

Raises:

  • ValueError – Error if more than one set value is tried to be given to entity

  • TypeError – value_dict has unknown format

Returns:

next timestep (when orchestrator calls again)

Return type:

int

get_data(outputs: dict) → dict

Gets the data for the next connected model. Core function of mosaik.

Parameters:

outputs (dict) – dictionary with data outputs from each entity

Raises:

ValueError – error if attribute not in model metadata

Returns:

dictionary with simulation outputs

Return type:

dict