eelib.data.dataclass.devices

Dataclasses for devices’ data used in eELib.

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

BaseDeviceData

Baseclass for Dataclasses of the devices.

BSSData

Dataclass for eELib BSS model.

EVData

Dataclass for eELib EV model.

CSData

Dataclass for eElib charging station model.

HPData

Dataclass for eElib heatpump model.

TESData

Dataclass for eELib TES model.

PVData

Dataclass for eElib pv(lib) model.

class BaseDeviceData

Bases: eelib.data.dataclass.BaseData

Baseclass for Dataclasses of the devices. Power limit for minimum and maximum power are using the passive sign convention. Hence, for consumption devices the maximum power is the maximum power demand and for generation devices the maximum power is the minimum power generation.

p

current active power

Type:

float

p_min

minimum active power limit (for generating devices: maximum output)

Type:

float

p_max

maximum active power limit (for generating devices: minimum output)

Type:

float

class BSSData

Bases: BaseDeviceData

Dataclass for eELib BSS model.

e_bss_rated

rated energy amount of bss

Type:

float | None

p_rated_charge_max

maximum charge power of bss

Type:

float | None

p_rated_discharge_max

maximum discharge power of bss

Type:

float | None

loss_rate

self-discharge (per month) of bss

Type:

float | None

self_discharge_step

self-discharge rate (per simulation step) of bss

Type:

float | None

status_aging

whether to account for aging of battery

Type:

bool | None

status_curve

whether to use a coded curve (true) or static efficiency (false)

Type:

bool | None

soh_cycles_max

state of health at end of lifetime

Type:

float | None

bss_cycles_max

maximum cycles to reach end of lifetime

Type:

int | None

soc_min

lower soc level of bss

Type:

float

soc_max

upper soc level of bss

Type:

float

bat2ac_efficiency

exponential discharging efficiency values

Type:

list[float] | None

ac2bss_efficiency

exponential charging efficiency values

Type:

list[float] | None

bss_threshold

threshold for bss inverter start

Type:

float | None

charge_efficiency

charging efficiency

Type:

float | None

discharge_efficiency

discharging efficiency

Type:

float | None

soh

state of health

Type:

float | None

bss_cycles

number of cycles accumulated by the battery

Type:

float | None

e_bat

current energy amount stored

Type:

float | None

e_bss_usable

usable energy amount of bss considering ageing

Type:

float | None

class EVData

Bases: BaseDeviceData

Dataclass for eELib EV model.

soc_min

minimum soc level of car

Type:

float

e_max

rated energy level of car battery

Type:

float

p_nom_charge_max

maximum charging power of car

Type:

float

p_nom_discharge_max

maximum discharging power of car

Type:

float

charge_efficiency

charge efficiency of car

Type:

float

dcharge_efficiency

discharge efficiency of car

Type:

float

e_bat

energy amount of the car

Type:

float

appearance

where car is available at charging point or not

Type:

bool

class CSData

Bases: BaseDeviceData

Dataclass for eElib charging station model.

charge_efficiency

charge efficiency of charging station

Type:

float

discharge_efficiency

discharge efficiency of charging station

Type:

float

p_rated

rated power of charging station

Type:

float

ev_data

information about all the connected electric vehicles, with {ev_id: EVData}.

Type:

dict

q

current reactive power

Type:

float

class HPData

Bases: BaseDeviceData

Dataclass for eElib heatpump model.

p_rated_th

rated thermal power of heatpumps

Type:

float

p_modulation_rel

relative minimum power (of rated power) for modulating heatpumps

Type:

float

time_min

minimum on/off-time for heatpumps

Type:

int

time_on

current on-time for heatpumps

Type:

int

time_off

current off-time for heatpumps

Type:

int

state

current state of heatpumps (on, off, must-on or must-off)

Type:

str

cop

current coefficient of power for heatpumps

Type:

float

p_th

current thermal power

Type:

float

p_th_min

minimum thermal power limit (maximum thermal output)

Type:

float

p_th_mod_start

minimum thermal output in on-state

Type:

float

p_mod_start

minimum electrical power limit in on-state

Type:

float

p_th_max

maximum thermal power limit (minimum thermal output)

Type:

float

q

current reactive power

Type:

float

class TESData

Bases: eelib.data.dataclass.BaseData

Dataclass for eELib TES model.

e_tes_rated

rated storage capacity of TES, in Wh

Type:

float

charge_efficiency

charge efficiency

Type:

float

discharge_efficiency

discharge efficiency

Type:

float

loss_rate

proportion of lost energy during 24h

Type:

float

e_tes

current energy amount stored, in Wh

Type:

float

soc

current state of charge

Type:

float

p_th

thermal power of TES, in W

Type:

float

p_th_max

max. (charging) thermal power of TES, in W

Type:

float

p_th_min

min. (discharging) thermal power of TES, in W

Type:

float

class PVData

Bases: BaseDeviceData

Dataclass for eElib pv(lib) model.

p_rated

rated power of system

Type:

float

q

current reactive power

Type:

float