Internal functions

create_area(m, a::Area, 𝒯, ℒᵗʳᵃⁿˢ, modeltype)

Set all constraints for an Area. Can serve as fallback option for all unspecified subtypes of Area.

create_area(m, a::LimitedExchangeArea, 𝒯, ℒᵗʳᵃⁿˢ, modeltype)

When the area is a LimitedExchangeArea, we limit the export of the specified limit resources p to the providewd value.

create_model(case::Dict, modeltype::EnergyModel, m::JuMP.Model; check_timeprofiles::Bool=true)

Create the model and call all required functions. This method is a deprecated method and should no longer be called.

create_transmission_mode(m, tm::TransmissionMode, 𝒯, modeltype::EnergyModel)

Set all constraints for a TransmissionMode.

Serves as a fallback option for unspecified subtypes of TransmissionMode.

Called constraint functions

• constraints_trans_balance,
• constraints_trans_loss,
• constraints_capacity,
• constraints_emission,
• constraints_opex_fixed, and
• constraints_opex_var.

constraints_capacity(m, tm::TransmissionMode, 𝒯::TimeStructure, modeltype::EnergyModel)
constraints_capacity(m, tm::PipeMode, 𝒯::TimeStructure, modeltype::EnergyModel)

Function for creating the constraint on the maximum capacity of a generic TransmissionMode and PipeMode.

These functions serve as fallback option if no other method is specified for a specific TransmissionMode.

constraints_capacity(m, tm::PipeLinepackSimple, 𝒯::TimeStructure, modeltype::EnergyModel)

Function for creating the constraint on the maximum capacity of a PipeLinepackSimple.

The difference is given by the inclusion of the linepack storage level constraint.

constraints_capacity_installed(m, tm::TransmissionMode, 𝒯::TimeStructure, modeltype::EnergyModel)

Function for creating the constraint on the installed capacity of a TransmissionMode.

This function serves as fallback option if no other method is specified for a specific TransmissionMode.

constraints_emission(m, tm::TransmissionMode, 𝒯, modeltype::EnergyModel)

Function for creating the constraints on the emissions of a generic TransmissionMode tm.

This function serves as fallback option if no other function is specified for a TransmissionMode.

constraints_opex_fixed(m, tm::TransmissionMode, 𝒯ᴵⁿᵛ, modeltype::EnergyModel)

Function for creating the constraint on the fixed OPEX of a generic TransmissionMode.

This function serves as fallback option if no other function is specified for a TransmissionMode.

constraints_opex_var(m, tm::TransmissionMode, 𝒯ᴵⁿᵛ, modeltype::EnergyModel)

Function for creating the constraint on the variable OPEX of a generic TransmissionMode.

This function serves as fallback option if no other function is specified for a TransmissionMode.

constraints_trans_balance(m, tm::TransmissionMode, 𝒯::TimeStructure, modeltype::EnergyModel)

Function for creating the transmission balance for a generic TransmissionMode.

This function serves as fallback option if no other function is specified for a TransmissionMode.

constraints_trans_balance(m, tm::PipeLinepackSimple, 𝒯::TimeStructure, modeltype::EnergyModel)

Function for creating the transmission balance for a PipeLinepackSimple.

constraints_trans_loss(m, tm::TransmissionMode, 𝒯::TimeStructure, modeltype::EnergyModel)
constraints_trans_loss(m, tm::PipeMode, 𝒯::TimeStructure, modeltype::EnergyModel)

Function for creating the constraint on the transmission loss of a generic TransmissionMode and PipeMode

These functions serve as fallback option if no other function is specified for a TransmissionMode. If you plan to use the methods, it is necessary that the function loss is either declared for your TransmissionMode or you provide alternatively a new method.

compute_trans_in(m, t, p, tm::TransmissionMode)
compute_trans_in(m, t, p, tm::PipeMode)

Return the amount of resource p going into transmission mode tm in operational period t.

The function is declared for both a generic TransmissionMode and for a PipeMode.

compute_trans_out(m, t, p, tm::TransmissionMode)
compute_trans_out(m, t, p, tm::PipeMode)

Return the amount of resource p going out of transmission mode tm in operational period t.

The function is declared for both a generic TransmissionMode and for a PipeMode.

variables_trans_mode(m, 𝒯, ℳˢᵘᵇ::Vector{<:TransmissionMode}, modeltype::EnergyModel)

Default fallback method when no function is defined for a TransmissionMode type. It introduces the variables that are required in all TransmissionModes.

These variables are:

• :trans_loss - loss during transmission
• :trans_loss_neg - negative loss during transmission, helper variable if bidirectional transport is possible
• :trans_loss_pos - positive loss during transmission, helper variable if bidirectional transport is possible

variables_trans_mode(m, 𝒯, ℳᴸᴾ::Vector{<:PipeLinepackSimple}, modeltype::EnergyModel)

When the node vector is a Vector{<:PipeLinepackSimple}, we declare the variable :linepack_stor_level to account for the energy stored through line packing.

check_area(a::Area, 𝒯, modeltype::EnergyModel, check_timeprofiles::Bool)

Check that the fields of an Area corresponds to required structure.

check_transmission(l::Transmission, 𝒯, modeltype::EnergyModel, check_timeprofiles::Bool)

Check that the fields of a Transmission corridor corresponds to required structure.

check_mode(tm::TransmissionMode, 𝒯, modeltype::EnergyModel, check_timeprofiles::Bool)
check_mode(tm::Union{RefDynamic, RefStatic}, 𝒯, modeltype::EnergyModel, check_timeprofiles::Bool)
check_mode(tm::PipeSimple, 𝒯, modeltype::EnergyModel, check_timeprofiles::Bool)
check_mode(tm::PipeLinepackSimple, 𝒯, modeltype::EnergyModel, check_timeprofiles::Bool)

Check that the fields of a TransmissionMode corresponds to required structure.

Checks RefDynamic and RefStatic

• The field trans_cap is required to be non-negative.
• The field trans_loss is required to be in the range $[0, 1]$.
• The field fixed_opex is required to be non-negative and accessible through a StrategicPeriod as outlined in the function check_fixed_opex.
• The field directions must be 1 or 2.

Checks PipeSimple

• All checks included in the subroutine check_mode_default.

Checks PipeLinepackSimple

• All checks included in the subroutine check_mode_default.
• The field energy_share is required to be non-negative.

check_mode_default(tm::PipeMode, 𝒯, modeltype::EnergyModel, check_timeprofiles::Bool)

Subroutine that can be utilized in other packages for incorporating the standard tests for a PipeMode node.

Checks

• The field consumption_rate is required to be non-negative.
• The field trans_cap is required to be non-negative.
• The field trans_loss is required to be in the range $[0, 1]$.
• The field fixed_opex is required to be non-negative and accessible through a StrategicPeriod as outlined in the function check_fixed_opex.

extract_resources(ℒᵗʳᵃⁿˢ, resource_method)

Return the resources transported/consumed by the transmission corridors in ℒᵗʳᵃⁿˢ.

export_resources(ℒᵗʳᵃⁿˢ, a::Area)

Return the resources exported from area a on the transmission corridors in ℒᵗʳᵃⁿˢ.

import_resources(ℒᵗʳᵃⁿˢ, a::Area)

Return the resources imported into area a on the transmission corridors in ℒᵗʳᵃⁿˢ.

emit_resources(m::TransmissionMode)

Returns the types of emissions associated with transmission mode tm.

emissions(tm::TransmissionMode, p::ResourceEmit)
emissions(tm::TransmissionMode, p::ResourceEmit, t)

Returns the emission of transmission mode tm of a specific resource p as TimeProfile or in operational period t.

is_bidirectional(tm::TransmissionMode)
is_bidirectional(tm::PipeMode)

Checks whether transmission mode tm is bidirectional. By default, it checks whether the the function directions returns the value 2.

PipeModes return false.

trans_sub(ℒᵗʳᵃⁿˢ, a::Area)

Return connected transmission corridors for a given area a.

connected_nodes(n::EMB.Node, ℒ::Vector{<:Link}, nodes::Vector{EMB.Node})

Returns a vector of all unique nodes connected to node n through links ℒ. The corresponding links are also returned.

Arguments

• n::EMB.Node is the node from which the connections are evaluated.
• ℒ::Vector{<:Link} is a vector of links that should be evaluated.
• nodes::Vector{EMB.Node} is a vector of nodes that should not be included.