Storage(volume, yst0, tempmodel, activate)
This implements a simple storage tank of variable volume with complete mix. No biological reactions. Dummy states are included.
If liquid volume > 90% of total volume then automatically bypass flow.
If liquid volume < 10% of total volume then automatically input flow.
Storage output and automatic bypass streams are joined in a Combiner afterwards.
-
tempmodeldefines how temperature changes in the input affect the liquid temperature. It also defines rules for a potential necessary bypass of the storage tank. -
activateused to activate dummy states. See documentation by Dr Marie-Noelle Pons.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
volume | float | Volume of the sludge storage tank [m³]. | required |
yst0 | ndarray(22) | Initial integration values of the 21 components (13 ASM1 components, TSS, Q, T and 5 dummy states). [S_I_S, S_S_S, X_I_S, X_S_S, X_BH_S, X_BA_S, X_P_S, S_O_S, S_NO_S, S_NH_S, S_ND_S, X_ND_S, S_ALK_S, TSS_S, Q_S, T_S, S_D1_S, S_D2_S, S_D3_S, X_D4_S, X_D5_S, VOL_INIT_S] | required |
tempmodel | bool | If true, mass balance for the wastewater temperature is used in process rates, otherwise influent wastewater temperature is just passed through process reactors. | required |
activate | bool | If true, dummy states are activated, otherwise dummy states are not activated. | required |
Source code in src/bsm2_python/bsm2/storage_bsm2.py
def __init__(self, volume, yst0, tempmodel, activate):
self.curr_vol = yst0[VOL]
self.max_vol = volume
self.tempmodel = tempmodel
self.activate = activate
self.yst0 = yst0
self.bypasscombiner = Combiner()
output(timestep, step, yst_in, qstorage)
Returns the solved differential equations for the storage tank.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timestep | float | Size of integration interval [d]. | required |
step | float | Upper boundary for integration interval [d]. | required |
yst_in | ndarray(21) | Storage tank influent concentrations of the 21 components (13 ASM1 components, TSS, Q, T and 5 dummy states). [SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, T_WW, SD1, SD2, SD3, XD4, XD5] | required |
qstorage | float | Default flow rate from storage tank [m³ ⋅ d⁻¹]. | required |
Returns:
| Name | Type | Description |
|---|---|---|
yst_out1 | ndarray(21) | Storage tank effluent concentrations of the 21 components (13 ASM1 components, TSS, Q, T and 5 dummy states). [SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, TEMP, SD1, SD2, SD3, XD4, XD5] |
curr_vol | float | Current volume of the storage tank [m³]. |
Source code in src/bsm2_python/bsm2/storage_bsm2.py
def output(self, timestep, step, yst_in, qstorage):
"""Returns the solved differential equations for the storage tank.
Parameters
----------
timestep : float
Size of integration interval [d].
step : float
Upper boundary for integration interval [d].
yst_in : np.ndarray(21)
Storage tank influent concentrations of the 21 components
(13 ASM1 components, TSS, Q, T and 5 dummy states). \n
[SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, T_WW,
SD1, SD2, SD3, XD4, XD5]
qstorage : float
Default flow rate from storage tank [m³ ⋅ d⁻¹].
Returns
-------
yst_out1 : np.ndarray(21)
Storage tank effluent concentrations of the 21 components
(13 ASM1 components, TSS, Q, T and 5 dummy states). \n
[SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, TEMP,
SD1, SD2, SD3, XD4, XD5]
curr_vol : float
Current volume of the storage tank [m³].
"""
yst_in1 = np.zeros(22)
yst_bp = np.zeros(21) # bypass
yst_in1[:21] = yst_in[:]
yst_bp[:] = yst_in[:]
if (self.curr_vol <= (0.9 * self.max_vol)) & (self.curr_vol >= (0.1 * self.max_vol)):
yst_in1[14] = yst_in[14]
# qstorage = qstorage
yst_bp[14] = 0
if (self.curr_vol >= (0.9 * self.max_vol)) & (yst_in[14] > qstorage):
yst_in1[14] = 0
qstorage = 0
yst_bp[14] = yst_in[14]
if (self.curr_vol >= (0.9 * self.max_vol)) & (yst_in[14] <= qstorage):
yst_in1[14] = yst_in[14]
# qstorage = qstorage
yst_bp[14] = 0
if self.curr_vol <= (0.1 * self.max_vol):
yst_in1[14] = yst_in[14]
qstorage = 0
yst_bp[14] = 0
yst_in1[21] = qstorage
t_eval = np.array([step, step + timestep]) # time interval for odeint
ode = odeint(storageequations, self.yst0, t_eval, tfirst=True, args=(yst_in1, self.tempmodel, self.activate))
yst_int = ode[1]
# y = yst_out
# u = yst_in1
# x : yst_int
self.yst0 = yst_int
yst_out = np.zeros(21)
yst_out[:] = yst_int[:21]
yst_out[14] = qstorage
if not self.tempmodel:
yst_out[15] = yst_in1[15]
if not self.activate:
yst_out[16:21] = 0
self.curr_vol = yst_int[21] # update current volume
yst_out1 = self.bypasscombiner.output(yst_out, yst_bp)
return yst_out1, self.curr_vol
storageequations(t, yst, yst_in1, tempmodel, activate)
Returns an array containing the differential equations for the storage tank.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
t | ndarray(2) | Time interval for integration, needed for the solver. [step, step + timestep] | required |
yst | ndarray(22) | Solution of the differential equations, needed for the solver. [SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, TEMP, SD1, SD2, SD3, XD4, XD5, VOL] | required |
yst_in1 | ndarray(21) | Storage tank influent concentrations of the 21 components (13 ASM1 components, TSS, Q, T and 5 dummy states). [SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, T_WW, SD1, SD2, SD3, XD4, XD5] | required |
tempmodel | bool | If true, mass balance for the wastewater temperature is used in process rates, otherwise influent wastewater temperature is just passed through process reactors. | required |
activate | bool | If true, dummy states are activated, otherwise dummy states are not activated. | required |
Returns:
| Name | Type | Description |
|---|---|---|
dyst | array(22) | Array containing the differential values of [SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, TEMP, SD1, SD2, SD3, XD4, XD5, VOL] |
Source code in src/bsm2_python/bsm2/storage_bsm2.py
@jit(nopython=True, cache=True)
def storageequations(t, yst, yst_in1, tempmodel, activate):
"""Returns an array containing the differential equations for the storage tank.
Parameters
----------
t : np.ndarray(2)
Time interval for integration, needed for the solver. \n
[step, step + timestep]
yst : np.ndarray(22)
Solution of the differential equations, needed for the solver. \n
[SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, TEMP, SD1, SD2, SD3, XD4, XD5, VOL]
yst_in1 : np.ndarray(21)
Storage tank influent concentrations of the 21 components
(13 ASM1 components, TSS, Q, T and 5 dummy states). \n
[SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, T_WW,
SD1, SD2, SD3, XD4, XD5]
tempmodel : bool
If true, mass balance for the wastewater temperature is used in process rates,
otherwise influent wastewater temperature is just passed through process reactors.
activate : bool
If true, dummy states are activated, otherwise dummy states are not activated.
Returns
-------
dyst : nd.array(22)
Array containing the differential values of `ys_in1` with volume `VOL` of the storage. \n
[SI, SS, XI, XS, XBH, XBA, XP, SO, SNO, SNH, SND, XND, SALK, TSS, Q, TEMP, SD1, SD2, SD3, XD4, XD5, VOL]
"""
# u = yst_in1
# x = yst
# dx = dyst
dyst = np.zeros(22)
dyst[:14] = yst_in1[Q] / yst[VOL] * (yst_in1[:14] - yst[:14])
dyst[Q] = 0
if not tempmodel:
dyst[TEMP] = 0.0
else:
dyst[TEMP] = yst_in1[Q] / yst[VOL] * (yst_in1[TEMP] - yst[TEMP])
if activate:
dyst[16:21] = yst_in1[Q] / yst[VOL] * (yst_in1[16:21] - yst[16:21])
dyst[VOL] = yst_in1[Q] - yst_in1[VOL] # change in volume
return dyst