Basic Sets#

Basic classes of the used parameter sets

class basd.designer.basic_sets.CellBlock(x: int = 1, y: int = 1)[source]#

dataclass for the cell block

Parameters:

  • x – number of cells in x-direction

  • y – number of cells in y-direction

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(x: int = 1, y: int = 1) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.Module(x: int = 1, y: int = 1)[source]#

dataclass for the module

Parameters:

  • x – number of cell blocks in x-direction

  • y – number of cell blocks in y-direction

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(x: int = 1, y: int = 1) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.String(x: int = 1, y: int = 1, z: int = 1)[source]#

dataclass for the string

Parameters:

  • x – number of modules in x-direction

  • y – number of modules in y-direction

  • z – number of modules in z-direction

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(x: int = 1, y: int = 1, z: int = 1) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.Pack(x: int = 1, y: int = 1, z: int = 1)[source]#

dataclass for the pack

Parameters:

  • x – number of strings in x-direction

  • y – number of strings in y-direction

  • z – number of strings in z-direction

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(x: int = 1, y: int = 1, z: int = 1) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.Overhead(cell_block: tuple[float, int], module: tuple[float, int], string: tuple[float, int], pack: tuple[float, int])[source]#

dataclass for the overhead values

Parameters:

  • cell_block – overhead value in a specific direction

  • module – overhead value in a specific direction

  • string – overhead value in a specific direction

  • pack – overhead value in a specific direction

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(cell_block: tuple[float, int], module: tuple[float, int], string: tuple[float, int], pack: tuple[float, int]) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.SlaveUtilization(min: int, max: int, slaves: int)[source]#

SlaveUtilization dataclass

Parameters:

  • min – minimal workload of the slaves

  • max – maximal workload of the slaves

  • slaves – number of slaves per modules

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(min: int, max: int, slaves: int) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.ElectricalConfiguration(cells_in_parallel: int, cells_in_series: int, nominal_system_voltage: float, system_capacity: float, lower_bound_cell_voltage: float, upper_bound_cell_voltage: float, used_cell_capacity: float, system_energy: float)[source]#

dataclass to save the electrical configuration of a battery system

Parameters:

  • cells_in_parallel – number of cells connected in parallel

  • cells_in_series – number of cells connected in series

  • nominal_system_voltage – the nominal battery system voltage

  • system_capacity – the battery system capacity

  • lower_bound_cell_voltage – the minimal cell voltage in the configuration

  • upper_bound_cell_voltage – the maximal cell voltage in the configuration

  • used_cell_capacity – the usable cell capacity in the configuration

  • system_energy – the energy of the battery system

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(cells_in_parallel: int, cells_in_series: int, nominal_system_voltage: float, system_capacity: float, lower_bound_cell_voltage: float, upper_bound_cell_voltage: float, used_cell_capacity: float, system_energy: float) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.MechanicalProperties(height: float, length: float, width: float, weight: float, height_overhead: float, length_overhead: float, width_overhead: float, weight_overhead: float, height_without_overhead: float, length_without_overhead: float, width_without_overhead: float, weight_without_overhead: float, volume: float | None = None)[source]#

dataclass for the mechanical properties of a system

Parameters:

  • height – the height of the system in meter

  • length – the length of the system in meter

  • width – the width of the system in meter

  • weight – the weight of the system in meter

  • height_overhead – the height overhead of the system in meter

  • length_overhead – the length overhead of the system in meter

  • width_overhead – the width overhead of the system in meter

  • weight_overhead – the weight overhead of the system in meter

__post_init__() → None[source]#

set the value for the volume

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(height: float, length: float, width: float, weight: float, height_overhead: float, length_overhead: float, width_overhead: float, weight_overhead: float, height_without_overhead: float, length_without_overhead: float, width_without_overhead: float, weight_without_overhead: float, volume: float | None = None) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.BasicParameterSet(*, cell: ~basd.database.battery_cell.BatteryCell, cell_block: ~basd.designer.basic_sets.CellBlock = <factory>, module: ~basd.designer.basic_sets.Module = <factory>, string: ~basd.designer.basic_sets.String = <factory>, pack: ~basd.designer.basic_sets.Pack = <factory>, cell_rotation: int = 0)[source]#

Defines the basic parameter set for the battery system layout

Parameters:

  • cell – used cell for the parameter set

  • cell_block – cell block related parameter

  • module – module related parameter

  • string – string related parameter

  • pack – pack related parameter

  • cell_rotation – specifies the rotation of the cell in the layout

__getitem__(item: Literal['series', 'parallel']) → tuple[Module, String] | tuple[CellBlock, Pack][source]#

layout parameters related to series and parallel connection are accessed by the key ‘series’ or ‘parallel’.

:param item : used to access specific series or parallel related elements

__setitem__(item: str, value: list) → None[source]#

__getitem__ layout parameters related to series and parallel connection are set by the key ‘series’ or ‘parallel’.

Parameters:

item – used to set specific series or parallel related elements

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(*, cell: ~basd.database.battery_cell.BatteryCell, cell_block: ~basd.designer.basic_sets.CellBlock = <factory>, module: ~basd.designer.basic_sets.Module = <factory>, string: ~basd.designer.basic_sets.String = <factory>, pack: ~basd.designer.basic_sets.Pack = <factory>, cell_rotation: int = 0) → None#
__repr__()#

Return repr(self).

class basd.designer.basic_sets.ElectricalProperties(parameter_set: BasicParameterSet, electrical_configuration: ElectricalConfiguration, **kwargs)[source]#

the dataclass for the electrical properties of a system

Parameters:

module_voltage – the voltage of the modules in the system

__init__(parameter_set: BasicParameterSet, electrical_configuration: ElectricalConfiguration, **kwargs)[source]#

Constructor of ElectricalProperties

__eq__(other)#

Return self==value.

__hash__ = None#
__repr__()#

Return repr(self).