Reference
Index
EnergyModelsBase.capacity
EnergyModelsBase.capacity
EnergyModelsBase.create_node
EnergyModelsBase.inputs
EnergyModelsBase.opex_fixed
EnergyModelsBase.opex_fixed
EnergyModelsBase.opex_var
EnergyModelsBase.opex_var
EnergyModelsBase.outputs
EnergyModelsGeography.check_area
EnergyModelsGeography.check_case_data
EnergyModelsGeography.check_data
EnergyModelsGeography.check_mode
EnergyModelsGeography.check_time_structure
EnergyModelsGeography.check_transmission
EnergyModelsGeography.compute_trans_in
EnergyModelsGeography.compute_trans_in
EnergyModelsGeography.compute_trans_out
EnergyModelsGeography.compute_trans_out
EnergyModelsGeography.constraints_area
EnergyModelsGeography.constraints_capacity
EnergyModelsGeography.constraints_capacity
EnergyModelsGeography.constraints_capacity
EnergyModelsGeography.constraints_capacity_installed
EnergyModelsGeography.constraints_opex_fixed
EnergyModelsGeography.constraints_opex_var
EnergyModelsGeography.constraints_trans_balance
EnergyModelsGeography.constraints_trans_balance
EnergyModelsGeography.constraints_trans_loss
EnergyModelsGeography.constraints_trans_loss
EnergyModelsGeography.constraints_transmission
EnergyModelsGeography.create_area
EnergyModelsGeography.create_area
EnergyModelsGeography.create_model
EnergyModelsGeography.create_transmission_mode
EnergyModelsGeography.export_resources
EnergyModelsGeography.extract_resources
EnergyModelsGeography.import_resources
EnergyModelsGeography.is_bidirectional
EnergyModelsGeography.trans_sub
EnergyModelsGeography.update_objective
EnergyModelsGeography.variables_area
EnergyModelsGeography.variables_trans_capacity
EnergyModelsGeography.variables_trans_capex
EnergyModelsGeography.variables_trans_mode
EnergyModelsGeography.variables_trans_mode
EnergyModelsGeography.variables_trans_modes
EnergyModelsGeography.variables_trans_opex
Types
Methods
EnergyModelsBase.capacity
— Methodcapacity(tm::TransmissionMode, t)
Returns the capacity of transmission mode tm
at time period t
.
EnergyModelsBase.capacity
— Methodcapacity(tm::TransmissionMode)
Returns the capacity of transmission mode tm
as TimeProfile
.
EnergyModelsBase.create_node
— MethodEMB.create_node(m, n::GeoAvailability, 𝒯, 𝒫, modeltype::EnergyModel)
Repaces constraints for availability nodes of type GeoAvailability. The resource balances are set by the area constraints instead.
EnergyModelsBase.inputs
— Methodinput(tm::TransmissionMode)
Returns the input resources of transmission mode tm
.
EnergyModelsBase.opex_fixed
— Methodopex_fixed(tm::TransmissionMode, t_inv)
Returns the variable OPEX of transmission mode tm
at strategic period t_inv
.
EnergyModelsBase.opex_fixed
— Methodopex_fixed(tm::TransmissionMode)
Returns the variable OPEX of transmission mode tm
as TimeProfile
.
EnergyModelsBase.opex_var
— Methodopex_var(tm::TransmissionMode, t)
Returns the variable OPEX of transmission mode tm
at time period t
.
EnergyModelsBase.opex_var
— Methodopex_var(tm::TransmissionMode)
Returns the variable OPEX of transmission mode tm
as TimeProfile
.
EnergyModelsBase.outputs
— Methodoutput(tm::TransmissionMode)
Returns the output resources of transmission mode tm
.
EnergyModelsGeography.check_area
— Methodcheck_area(a::Area, 𝒯, 𝒫, modeltype::EnergyModel, check_timeprofiles::Bool)
Check that the fields of an Area
corresponds to required structure.
EnergyModelsGeography.check_case_data
— Methodcheck_case_data(case)
Checks the case
dictionary is in the correct format. The function is only checking the new, additional data as we do not yet consider dispatch on the case data.
Checks
- The dictionary requires the keys
:areas
and:transmission
. - The individual keys are of the correct type, that is
:areas::Area
and:transmission::Vector{<:Transmission}
.
EnergyModelsGeography.check_data
— Methodcheck_data(case, modeltype, check_timeprofiles::Bool)
Check if the case data is consistent. Use the @assert_or_log
macro when testing. Currently, not checking data except that the case dictionary follows the required structure.
EnergyModelsGeography.check_mode
— Methodcheck_mode(m::TransmissionMode, 𝒯, 𝒫, modeltype::EnergyModel, check_timeprofiles::Bool)
Check that the fields of a TransmissionMode
corresponds to required structure.
EnergyModelsGeography.check_time_structure
— Methodcheck_time_structure(m::TransmissionMode, 𝒯)
Check that all fields of a TransmissionMode
that are of type TimeProfile
correspond to the time structure 𝒯
.
EnergyModelsGeography.check_transmission
— Methodcheck_transmission(l::Transmission, 𝒯, 𝒫, modeltype::EnergyModel, check_timeprofiles::Bool)
Check that the fields of a Transmission
corridor corresponds to required structure.
EnergyModelsGeography.compute_trans_in
— Methodcompute_trans_in(m, t, p, tm::PipeMode)
Return the amount of resources going into transmission corridor l
by a PipeMode
.
EnergyModelsGeography.compute_trans_in
— Methodcompute_trans_in(m, t, p, tm::TransmissionMode)
Return the amount of resources going into transmission corridor l
by a generic TransmissionMode
EnergyModelsGeography.compute_trans_out
— Methodcompute_trans_out(m, t, p, tm::PipeMode)
Return the amount of resources going out of transmission corridor l
by a PipeMode
.
EnergyModelsGeography.compute_trans_out
— Methodcompute_trans_out(m, t, p, tm::TransmissionMode)
Return the amount of resources going out of transmission corridor l
by a generic TransmissionMode
EnergyModelsGeography.constraints_area
— Methodconstraints_area(m, 𝒜, 𝒯, ℒᵗʳᵃⁿˢ, 𝒫, modeltype::EnergyModel)
Create constraints for the energy balances within an area for each resource using the GeoAvailability node. Keep track of the exchange with other areas in a seperate variable :area_exchange
.
EnergyModelsGeography.constraints_capacity
— Methodconstraints_capacity(m, tm::PipeLinepackSimple, 𝒯::TimeStructure, modeltype::EnergyModel)
Function for creating the constraint on the maximum capacity of a PipeLinepackSimple
.
EnergyModelsGeography.constraints_capacity
— Methodconstraints_capacity(m, tm::PipeMode, 𝒯::TimeStructure, modeltype::EnergyModel)
Function for creating the constraint on the maximum capacity of a generic PipeMode
.
EnergyModelsGeography.constraints_capacity
— Methodconstraints_capacity(m, tm::TransmissionMode, 𝒯::TimeStructure, modeltype::EnergyModel)
Function for creating the constraint on the maximum capacity of a generic TransmissionMode
. This function serves as fallback option if no other function is specified for a TransmissionMode
.
EnergyModelsGeography.constraints_capacity_installed
— Methodconstraints_capacity_installed(m, tm::TransmissionMode, 𝒯::TimeStructure, modeltype::EnergyModel)
Function for creating the constraint on the installed capacity of a TransmissionMode
.
EnergyModelsGeography.constraints_opex_fixed
— Methodconstraints_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
.
EnergyModelsGeography.constraints_opex_var
— Methodconstraints_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
.
EnergyModelsGeography.constraints_trans_balance
— Methodconstraints_trans_balance(m, tm::PipeLinepackSimple, 𝒯::TimeStructure, modeltype::EnergyModel)
Function for creating the transmission balance for aPipeLinepackSimple
.
EnergyModelsGeography.constraints_trans_balance
— Methodconstraints_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
.
EnergyModelsGeography.constraints_trans_loss
— Methodconstraints_trans_loss(m, tm::PipeMode, 𝒯::TimeStructure, modeltype::EnergyModel)
Function for creating the constraint on the transmission loss of a generic PipeMode
.
EnergyModelsGeography.constraints_trans_loss
— Methodconstraints_trans_loss(m, tm::TransmissionMode, 𝒯::TimeStructure, modeltype::EnergyModel)
Function for creating the constraint on the transmission loss of a generic TransmissionMode
. This function serves as fallback option if no other function is specified for a TransmissionMode
.
EnergyModelsGeography.constraints_transmission
— Methodconstraints_transmission(m, 𝒯, ℳ, modeltype::EnergyModel)
Create transmission constraints on all transmission corridors.
EnergyModelsGeography.create_area
— Methodcreate_area(m, a::Area, 𝒯, ℒᵗʳᵃⁿˢ, modeltype)
Default fallback method when no function is defined for a node type.
EnergyModelsGeography.create_area
— Methodcreate_area(m, a::LimitedExchangeArea, 𝒯, ℒᵗʳᵃⁿˢ, modeltype)
Constraint that limit exchange with other areas based on the specified exchange_limit.
EnergyModelsGeography.create_model
— Methodcreate_model(case, modeltype::EnergyModel; check_timeprofiles::Bool=true)
Create the model and call all required functions.
Input
case
- The case dictionary requiring the keys:T
,:nodes
,:links
,products
as it is the case for standardEnergyModelsBase
models. In addition, the keys:areas
and:transmission
are required for extending the existing model. If the input is not provided in the correct form, the checks will identify the problem. In the case of amodeltype::EnergyModel
- Used modeltype, that is a subtype of the typeEnergyModel
.m
- the emptyJuMP.Model
instance. If it is not provided, then it is assumed that the input is a standardJuMP.Model
.
Conditional input
check_timeprofiles::Bool=true
- A boolean indicator whether the time profiles of the individual nodes should be checked or not. It is advised to not deactivate the check, except if you are testing new components. It may lead to unexpected behaviour and potential inconsistencies in the input data, if the time profiles are not checked.
EnergyModelsGeography.create_transmission_mode
— Methodcreate_transmission_mode(m, tm::TransmissionMode, 𝒯, modeltype::EnergyModel)
Set all constraints for transmission mode. Serves as a fallback option for unspecified subtypes of TransmissionMode
.
EnergyModelsGeography.export_resources
— Methodexport_resources(ℒ, a::Area)
Return the resources exported from area a
on the transmission corridors in ℒ
.
EnergyModelsGeography.extract_resources
— Methodextract_resources(ℒ, resource_method)
Return the resources transported/consumed by the transmission corridors in ℒ.
EnergyModelsGeography.import_resources
— Methodimport_resources(ℒ, a::Area)
Return the resources imported into area a
on the transmission corridors in ℒ
.
EnergyModelsGeography.is_bidirectional
— Methodis_bidirectional(tm::TransmissionMode)
Checks whether TransmissionMode tm
is bidirectional.
EnergyModelsGeography.trans_sub
— Methodtrans_sub(ℒ, a::Area)
Return connected transmission corridors for a given area.
EnergyModelsGeography.update_objective
— Methodupdate_objective(m, 𝒩, 𝒯, 𝒫, ℒᵗʳᵃⁿˢ, modeltype::EnergyModel)
Update the objective function with costs related to geography (areas and energy transmission).
EnergyModelsGeography.variables_area
— Methodvariables_area(m, 𝒜, 𝒯, ℒᵗʳᵃⁿˢ, modeltype::EnergyModel)
Create variables to track how much energy is exchanged from an area for all time periods t ∈ 𝒯
.
EnergyModelsGeography.variables_trans_capacity
— Methodvariables_trans_capacity(m, 𝒯, ℳ, modeltype::EnergyModel)
Declaration of variables for tracking how much of installed transmision capacity is used f or all time periods t ∈ 𝒯
of the tranmission modes.
EnergyModelsGeography.variables_trans_capex
— Methodvariables_trans_capex(m, 𝒯, ℳ, modeltype::EnergyModel)
Create variables for the capital costs for the investments in transmission. Empty function to allow for multiple dispatch in the EnergyModelsInvestment
package.
EnergyModelsGeography.variables_trans_mode
— Methodvariables_trans_mode(m, 𝒯, ℳᴸᴾ::Vector{<:PipeLinepackSimple}, modeltype::EnergyModel)
Adds the following special variables for linepacking:
:linepack_stor_level
- storage level in linepack
EnergyModelsGeography.variables_trans_mode
— Methodvariables_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 TransmissionMode
s. These variables are:
:trans_in
- inlet flow to transmission mode:trans_out
- outlet flow from a transmission mode: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
EnergyModelsGeography.variables_trans_modes
— Methodvariables_trans_modes(m, 𝒯, ℳ, modeltype::EnergyModel)
Loop through all TransmissionMode
types and create variables specific to each type. This is done by calling the method variables_trans_mode
on all modes of each type.
The TransmissionMode
type representing the widest category will be called first. That is, variables_trans_mode
will be called on a TransmissionMode
before it is called on PipeMode
-nodes.
EnergyModelsGeography.variables_trans_opex
— Methodvariables_trans_opex(m, 𝒯, ℳ, modeltype::EnergyModel)
Declaration of variables for the operational costs of the tranmission modes.