Storage class¶
Storage components store commodities and thus transfer commodities between time steps.
Storage class description:

class
storage.
Storage
(esM, name, commodity, chargeRate=1, dischargeRate=1, chargeEfficiency=1, dischargeEfficiency=1, selfDischarge=0, cyclicLifetime=None, stateOfChargeMin=0, stateOfChargeMax=1, hasCapacityVariable=True, capacityVariableDomain='continuous', capacityPerPlantUnit=1, hasIsBuiltBinaryVariable=False, bigM=None, doPreciseTsaModeling=False, chargeOpRateMax=None, chargeOpRateFix=None, chargeTsaWeight=1, dischargeOpRateMax=None, dischargeOpRateFix=None, dischargeTsaWeight=1, isPeriodicalStorage=False, locationalEligibility=None, capacityMin=None, capacityMax=None, partLoadMin=None, sharedPotentialID=None, linkedQuantityID=None, capacityFix=None, isBuiltFix=None, investPerCapacity=0, investIfBuilt=0, opexPerChargeOperation=0, opexPerDischargeOperation=0, opexPerCapacity=0, opexIfBuilt=0, interestRate=0.08, economicLifetime=10, technicalLifetime=None, socOffsetDown=1, socOffsetUp=1)[source]¶ A Storage component can store a commodity and thus transfers it between time steps.

__init__
(esM, name, commodity, chargeRate=1, dischargeRate=1, chargeEfficiency=1, dischargeEfficiency=1, selfDischarge=0, cyclicLifetime=None, stateOfChargeMin=0, stateOfChargeMax=1, hasCapacityVariable=True, capacityVariableDomain='continuous', capacityPerPlantUnit=1, hasIsBuiltBinaryVariable=False, bigM=None, doPreciseTsaModeling=False, chargeOpRateMax=None, chargeOpRateFix=None, chargeTsaWeight=1, dischargeOpRateMax=None, dischargeOpRateFix=None, dischargeTsaWeight=1, isPeriodicalStorage=False, locationalEligibility=None, capacityMin=None, capacityMax=None, partLoadMin=None, sharedPotentialID=None, linkedQuantityID=None, capacityFix=None, isBuiltFix=None, investPerCapacity=0, investIfBuilt=0, opexPerChargeOperation=0, opexPerDischargeOperation=0, opexPerCapacity=0, opexIfBuilt=0, interestRate=0.08, economicLifetime=10, technicalLifetime=None, socOffsetDown=1, socOffsetUp=1)[source]¶ Constructor for creating an Storage class instance. The Storage component specific input arguments are described below. The general component input arguments are described in the Component class.
Required arguments:
Parameters: commodity (string) – to the component related commodity. Default arguments:
Parameters:  chargeRate (0 <= float <=1) –
ratio of the maximum storage inflow (in commodityUnit/hour) to the storage capacity (in commodityUnit). Example:
 A hydrogen salt cavern which can store 133 GWh_H2_LHV can be charged 0.45 GWh_H2_LHV during one hour. The chargeRate thus equals 0.45/133 1/h.
* the default value is 1  dischargeRate (0 <= float <=1) –
ratio of the maximum storage outflow (in commodityUnit/hour) to the storage capacity (in commodityUnit). Example:
 A hydrogen salt cavern which can store 133 GWh_H2_LHV can be discharged 0.45 GWh_H2_LHV during one hour. The dischargeRate thus equals 0.45/133.
* the default value is 1  chargeEfficiency (0 <= float <=1) – defines the efficiency with which the storage can be charged (equals
the percentage of the injected commodity that is transformed into stored commodity).
Enter 0.98 for 98% etc.
* the default value is 1  dischargeEfficiency (0 <= float <=1) – defines the efficiency with which the storage can be discharged
(equals the percentage of the withdrawn commodity that is transformed into stored commodity).
Enter 0.98 for 98% etc.
* the default value is 1  selfDischarge (0 <= float <=1) – percentage of selfdischarge from the storage during one hour
* the default value is 0  cyclicLifetime (None or positive float) – if specified, the total number of full cycle equivalents that are supported
by the technology.
* the default value is None  stateOfChargeMin (0 <= float <=1) – threshold (percentage) that the state of charge can not drop under
* the default value is 0  stateOfChargeMax (0 <= float <=1) – threshold (percentage) that the state of charge can not exceed
* the default value is 1  doPreciseTsaModeling (boolean) – determines whether the state of charge is limited precisely (True) or
with a simplified method (False). The error is small if the selfDischarge is small.
* the default value is False  chargeOpRateMax (None or Pandas DataFrame with positive (>= 0) entries. The row indices have
to match the in the energy system model specified time steps. The column indices have to match the
in the energy system model specified locations.) – if specified, indicates a maximum charging rate for each location and each time
step by a positive float. If hasCapacityVariable is set to True, the values are given relative
to the installed capacities (i.e. a value of 1 indicates a utilization of 100% of the
capacity). If hasCapacityVariable is set to False, the values are given as absolute values in form
of the commodityUnit, referring to the charged commodity (before multiplying the charging efficiency)
during one time step.
* the default value is None  chargeOpRateFix (None or Pandas DataFrame with positive (>= 0) entries. The row indices have
to match the in the energy system model specified time steps. The column indices have to match the
in the energy system model specified locations.) – if specified, indicates a fixed charging rate for each location and each time
step by a positive float. If hasCapacityVariable is set to True, the values are given relative
to the installed capacities (i.e. a value of 1 indicates a utilization of 100% of the
capacity). If hasCapacityVariable is set to False, the values are given as absolute values in form
of the commodityUnit, referring to the charged commodity (before multiplying the charging efficiency)
during one time step.
* the default value is None  chargeTsaWeight (positive (>= 0) float) – weight with which the chargeOpRate (max/fix) time series of the
component should be considered when applying time series aggregation.
* the default value is 1  dischargeOpRateMax (None or Pandas DataFrame with positive (>= 0) entries. The row indices have
to match the in the energy system model specified time steps. The column indices have to match the
in the energy system model specified locations.) – if specified, indicates a maximum discharging rate for each location and each
time step by a positive float. If hasCapacityVariable is set to True, the values are given relative
to the installed capacities (i.e. a value of 1 indicates a utilization of 100% of the
capacity). If hasCapacityVariable is set to False, the values are given as absolute values in form
of the commodityUnit, referring to the discharged commodity (after multiplying the discharging
efficiency) during one time step.
* the default value is None  dischargeOpRateFix (None or Pandas DataFrame with positive (>= 0) entries. The row indices have
to match the in the energy system model specified time steps. The column indices have to match the
in the energy system model specified locations.) – if specified, indicates a fixed discharging rate for each location and each
time step by a positive float. If hasCapacityVariable is set to True, the values are given relative
to the installed capacities (i.e. a value of 1 indicates a utilization of 100% of the
capacity). If hasCapacityVariable is set to False, the values are given as absolute values in form
of the commodityUnit, referring to the charged commodity (after multiplying the discharging
efficiency) during one time step.
* the default value is None  dischargeTsaWeight (positive (>= 0) float) – weight with which the dischargeOpRate (max/fix) time series of the
component should be considered when applying time series aggregation.
* the default value is 1  isPeriodicalStorage (boolean) – indicates if the state of charge of the storage has to be at the same value
after the end of each period. This is especially relevant when using daily periods where short term
storage can be restrained to daily cycles. Benefits the run time of the model.
* the default value is False  opexPerChargeOperation (positive (>=0) float or Pandas Series with positive (>=0) values.
The indices of the series have to equal the in the energy system model specified locations.) – describes the cost for one unit of the charge operation.
The cost which is directly proportional to the charge operation of the
component is obtained by multiplying the opexPerChargeOperation parameter with the annual sum of the
operational time series of the components. The opexPerChargeOperation can either be given as a float
or a Pandas Series with location specific values.
The cost unit in which the parameter is given has to match the one specified in the energy
system model (e.g. Euro, Dollar, 1e6 Euro).
* the default value is 0  opexPerDischargeOperation (positive (>=0) float or Pandas Series with positive (>=0) values.
The indices of the series have to equal the in the energy system model specified locations.) – describes the cost for one unit of the discharge operation.
The cost which is directly proportional to the discharge operation
of the component is obtained by multiplying the opexPerDischargeOperation parameter with the annual sum
of the operational time series of the components. The opexPerDischargeOperation can either be given as
a float or a Pandas Series with location specific values.
The cost unit in which the parameter is given has to match the one specified in the energy
system model (e.g. Euro, Dollar, 1e6 Euro).
* the default value is 0  socOffsetDown (float) – determines whether the state of charge at the end of a period p has
to be equal to the one at the beginning of a period p+1 (socOffsetDown=1) or if
it can be smaller at the beginning of p+1 (socOffsetDown>=0). In the latter case,
the product of the parameter socOffsetDown and the actual soc offset is used as a penalty
factor in the objective function.
* the default value is 1  socOffsetUp (float) – determines whether the state of charge at the end of a period p has
to be equal to the one at the beginning of a period p+1 (socOffsetUp=1) or if
it can be larger at the beginning of p+1 (socOffsetUp>=0). In the latter case,
the product of the parameter socOffsetUp and the actual soc offset is used as a penalty
factor in the objective function.
* the default value is 1
 chargeRate (0 <= float <=1) –

addToEnergySystemModel
(esM)[source]¶ Function for adding a storage component to the given energy system model.
Parameters: esM (EnergySystemModel class instance) – energy system model to which the storage component should be added.

setTimeSeriesData
(hasTSA)[source]¶ Function for setting the maximum operation rate and fixed operation rate for charging and discharging depending on whether a time series analysis is requested or not.
Parameters: hasTSA (boolean) – states whether a time series aggregation is requested (True) or not (False).

Inheritance diagram:
StorageModel class description:

class
storage.
StorageModel
[source]¶ A StorageModel class instance will be instantly created if a Storage class instance is initialized. It is used for the declaration of the sets, variables and constraints which are valid for the Storage class instance. These declarations are necessary for the modeling and optimization of the energy system model. The StorageModel class inherits from the ComponentModel class.

declareSets
(esM, pyM)[source]¶ Declare sets: design variable sets, operation variable set, operation mode sets.
Parameters:  esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.
 pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.

declareVariables
(esM, pyM, relaxIsBuiltBinary)[source]¶ Declare design and operation variables.
Parameters:  esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.
 pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.

connectSOCs
(pyM, esM)[source]¶ Declare the constraint for connecting the state of charge with the charge and discharge operation: the change in the state of charge between two points in time has to match the values of charging and discharging (considering the efficiencies of these processes) within the time step in between minus the selfdischarge of the storage.
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

cyclicState
(pyM, esM)[source]¶ Declare the constraint for connecting the states of charge: the state of charge at the beginning of a period has to be the same as the state of charge in the end of that period.
with full temporal resolution
with time series aggregation:
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

cyclicLifetime
(pyM, esM)[source]¶ Declare the constraint for limiting the number of full cycle equivalents to stay below cyclic lifetime.
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

connectInterPeriodSOC
(pyM, esM)[source]¶ Declare the constraint that the state of charge at the end of each period has to be equivalent to the state of charge of the period before it (minus its self discharge) plus the change in the state of charge which happened during the typical period which was assigned to that period.
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

intraSOCstart
(pyM, esM)[source]¶ Declare the constraint that the (virtual) state of charge at the beginning of a typical period is zero.
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

equalInterSOC
(pyM, esM)[source]¶ Declare the constraint that, if periodic storage is selected, the states of charge between periods have the same value.
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

minSOC
(pyM)[source]¶ Declare the constraint that the state of charge [commodityUnit*h] has to be larger than the installed capacity [commodityUnit*h] multiplied with the relative minimum state of charge.
Parameters: pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.

limitSOCwithSimpleTsa
(pyM, esM)[source]¶ Simplified version of the state of charge limitation control. The error compared to the precise version is small in cases of small selfDischarge.
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

operationModeSOC
(pyM, esM)[source]¶ Declare the constraint that the state of charge [commodityUnit*h] is limited by the installed capacity [commodityUnit*h] and the relative maximum state of charge [].
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

operationModeSOCwithTSA
(pyM, esM)[source]¶ Declare the constraint that the state of charge [commodityUnit*h] is limited by the installed capacity # [commodityUnit*h] and the relative maximum state of charge [].
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

minSOCwithTSAprecise
(pyM, esM)[source]¶ Declare the constraint that the state of charge [commodityUnit*h] at each time step cannot be smaller than the installed capacity [commodityUnit*h] multiplied with the relative minimum state of charge [].
Parameters:  pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
 esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.

declareComponentConstraints
(esM, pyM)[source]¶ Declare time independent and dependent constraints.
Parameters:  esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.
 pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.
Get contributions to shared location potential.

hasOpVariablesForLocationCommodity
(esM, loc, commod)[source]¶ Check if operation variables exist in the modeling class at a location which are connected to a commodity.
Parameters:  esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.
 loc (string) – Name of the regarded location (locations are defined in the EnergySystemModel instance)
 commod – Name of the regarded commodity (commodities are defined in the EnergySystemModel instance)
 commod – string

getCommodityBalanceContribution
(pyM, commod, loc, p, t)[source]¶ Get contribution to a commodity balance.

getObjectiveFunctionContribution
(esM, pyM)[source]¶ Get contribution to the objective function.
Parameters:  esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.
 pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.

setOptimalValues
(esM, pyM)[source]¶ Set the optimal values of the components.
Parameters:  esM (esM  EnergySystemModel class instance) – EnergySystemModel instance representing the energy system in which the component should be modeled.
 pyM (pyomo ConcreteModel) – pyomo ConcreteModel which stores the mathematical formulation of the model.

getOptimalValues
(name='all')[source]¶ Return optimal values of the components.
Parameters: name – name of the variables of which the optimal values should be returned:  ‘capacityVariables’,
 ‘isBuiltVariables’,
 ‘chargeOperationVariablesOptimum’,
 ‘dischargeOperationVariablesOptimum’,
 ‘stateOfChargeOperationVariablesOptimum’,
 ‘all’ or another input: all variables are returned.
* the default value is ‘all’ :type name: stringReturns: a dictionary with the optimal values of the components Return type: dict

Inheritance diagram: