Energy sink

The energy sink component is used to model the consumption or export of a commodity inside the energy system.

The following attributes are available:

pydantic model ensysmod.schemas.EnergySinkCreate[source]

Attributes to receive via API on creation of an energy sink.

field commodity_name: str [Required]

Commodity the energy sink is based on.

Constraints:

  • min_length = 1

  • max_length = 255

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

field type: EnergyComponentType = EnergyComponentType.SINK
field commodity_cost: float | None = None

Cost of the energy sink per unit of energy.

Constraints:

  • ge = 0

field yearly_limit: float | None = None

The yearly limit of the energy sink. If specified, commodity_limit_id must be specified as well.

Constraints:

  • ge = 0

field commodity_limit_id: str | None = None

Commodity limit ID of the energy sink. Required if yearly_limit is specified. The limit is shared among all components of the same commodity_limit_id.

Constraints:

  • max_length = 255

field ref_dataset: int [Required]

Reference to dataset that energy component belongs to.

Constraints:

  • gt = 0

field name: str [Required]

Unique name of the energy component. It is used to identify the component.

Constraints:

  • min_length = 1

  • max_length = 255

field description: str | None = None

Description of the energy component. Can be used to explain the component.

Constraints:

  • max_length = 1024

field capacity_variable: bool | None = False

Whether the energy component should be model with a capacity or not.

field capacity_variable_domain: CapacityVariableDomain | None = CapacityVariableDomain.CONTINUOUS

Mathematical domain of the capacity variables. ‘continuous’ means that the capacity is modeled as real values >= 0. ‘discrete’ means that the capacity is modeled as integer values >= 0.

field capacity_per_plant_unit: float | None = 1.0

Capacity per plant unit. By default is 1, thus the number of plants is the equal to the installed capacity.

Constraints:

  • gt = 0

field invest_per_capacity: float | None = 0.0

Investment per capacity.

Constraints:

  • ge = 0

field opex_per_capacity: float | None = 0.0

Operational expenditure per capacity.

Constraints:

  • ge = 0

field interest_rate: float | None = 0.08

Interest rate.

Constraints:

  • ge = 0

  • le = 1

field economic_lifetime: int | None = 10

Economic lifetime.

Constraints:

  • gt = 0

field shared_potential_id: str | None = None

Shared potential ID. If specified, the maximum potential capacity is shared among all components of the same shared potential id.

Constraints:

  • max_length = 255

field linked_quantity_id: str | None = None

Linked quantity ID. If specified, components of the same linked quantity ID are built with the same quantity.

Constraints:

  • max_length = 255