sox.plant.thevenin.parameters¶

Module Contents¶

Classes¶

Inputs

Input variables to the battery model.

Outputs

Output variables from the battery model.

Attributes¶

Temp

Current

SOC

OCV

dOCVdT

Resistance

Capacitance

sox.plant.thevenin.parameters.Temp¶
sox.plant.thevenin.parameters.Current¶
sox.plant.thevenin.parameters.SOC¶
sox.plant.thevenin.parameters.OCV¶
sox.plant.thevenin.parameters.dOCVdT¶
sox.plant.thevenin.parameters.Resistance¶
sox.plant.thevenin.parameters.Capacitance¶
class sox.plant.thevenin.parameters.Inputs¶

Input variables to the battery model.

Parameters:

  • rc_pairs (int) – Number of RC pairs.

  • initial_rc_voltage (list) – Element-i initial overpotential [V].

  • voltage_high_cut (float) – Upper voltage cut-off [V].

  • voltage_low_cut (float) – Lower voltage cut-off [V].

  • capacity (float) – Cell capacity [A.h].

  • initial_soc (float) – Initial SoC.

  • open_circuit_voltage (callable) – Open-circuit voltage [V].

  • entropic_change (callable) – Entropic change [V/K] (temp in degC).

  • series_resistance (callable) – R0 [Ohm].

  • rc_resistance (list) – [R1 [Ohm], R2 [Ohm], …, Rn [Ohm]].

  • rc_capacitance (list) – [C1 [F], C2 [F], …, Cn [F]].

  • initial_temperature (float) – Initial temperature [K].

  • ambient_temperature (float) – Ambient temperature [K].

  • cth_cell (float) – Cell thermal mass [J/K].

  • cth_jig (float) – Jig thermal mass [J/K].

  • k_cell_jig (float) – Cell-jig heat transfer coefficient [W/K].

  • k_jig_air (float) – Jig-air heat transfer coefficient [W/K].

rc_pairs: int¶
initial_rc_voltage: List[float]¶
voltage_high_cut: float¶
voltage_low_cut: float¶
capacity: float¶
initial_soc: float¶
open_circuit_voltage: Callable[[SOC], OCV]¶
entropic_change: Callable[[OCV, Temp], dOCVdT]¶
series_resistance: Callable[[Temp, Current, SOC], Resistance]¶
rc_resistance: List[Callable[[Temp, Current, SOC], Resistance]]¶
rc_capacitance: List[Callable[[Temp, Current, SOC], Capacitance]]¶
initial_temperature: float¶
ambient_temperature: float¶
cth_cell: float¶
cth_jig: float¶
k_cell_jig: float¶
k_jig_air: float¶
class sox.plant.thevenin.parameters.Outputs¶

Output variables from the battery model.

Parameters:

  • time (array_like) – Time [s].

  • voltage (array_like) – Voltage [V].

  • rc_voltage (list) – [Element-1 overpotential [V], …, Element-n overpotential [V]].

  • ocv (array_like) – Open-circuit voltage [V].

  • current (array_like) – Current [A].

  • power (array_like) – Power [W].

  • resistance (array_like) – Resistance [Ohm].

  • series_resistance (array_like) – R0 [Ohm].

  • rc_resistance (list) – [R1 [Ohm], …, Rn [Ohm]].

  • rc_capacitance (list) – [C1 [F], …, Cn [F]].

  • soc (array_like) – SoC.

  • ambient_temperature (array_like) – Ambient temperature [degC].

  • cell_temperature (array_like) – Cell temperature [degC].

  • jig_temperature (array_like) – Jig temperature [degC].

time: numpy.ndarray¶
voltage: numpy.ndarray¶
rc_voltage: List[numpy.ndarray]¶
ocv: numpy.ndarray¶
current: numpy.ndarray¶
power: numpy.ndarray¶
resistance: numpy.ndarray¶
series_resistance: numpy.ndarray¶
rc_resistance: List[numpy.ndarray]¶
rc_capacitance: List[numpy.ndarray]¶
soc: numpy.ndarray¶
ambient_temperature: numpy.ndarray¶
cell_temperature: numpy.ndarray¶
jig_temperature: numpy.ndarray¶