Resource types and function interfaces

An abstract type that should be subtyped for users creating GenX resources.

const default_zero = 0

Default value for resource attributes.

resource_types

Name of the type of resources available in the model.

Possible values:

• :Thermal
• :Vre
• :Hydro
• :Storage
• :MustRun
• :FlexDemand
• :VreStorage
• :Electrolyzer
• :AllamCycleLox

findall(f::Function, rs::Vector{<:AbstractResource})

Find all resources in the vector rs that satisfy the condition given by the function f. Return the resource id instead of the vector index.

Arguments

• f::Function: The condition function.
• rs::Vector{<:AbstractResource}: The vector of resources.

Returns

• Vector: The vector of resource ids.

Examples

julia> findall(r -> max_cap_mwh(r) != 0, gen.Storage)
3-element Vector{Int64}:
 48
 49
 50

Base.get(r::AbstractResource, sym::Symbol, default)

Retrieves the value of a specific attribute from an AbstractResource object. If the attribute exists, its value is returned; otherwise, the default value is returned.

Arguments:

• r::AbstractResource: The resource object.
• sym::Symbol: The symbol representing the attribute name.
• default: The default value to return if the attribute does not exist.

Returns:

• The value of the attribute if it exists in the parent object, default otherwise.

Base.getproperty(r::AbstractResource, sym::Symbol)

Allows to access the attributes of an AbstractResource object using dot syntax. It checks if the attribute exists in the object and returns its value, otherwise it throws an ErrorException indicating that the attribute does not exist.

Arguments:

• r::AbstractResource: The resource object.
• sym::Symbol: The symbol representing the attribute name.

Returns:

• The value of the attribute if it exists in the parent object.

Throws:

• ErrorException: If the attribute does not exist in the resource.

Base.getproperty(rs::Vector{<:AbstractResource}, sym::Symbol)

Allows to return all resources of a given type of a vector of AbstractResource objects using dot syntax.

Arguments:

• rs::Vector{<:AbstractResource}: The vector of AbstractResource objects.
• sym::Symbol: The symbol representing the type from resource_types.

Returns:

• If sym is an element of the resource_types constant, it returns a vector containing all resources of that type.

Examples

julia> vre_gen = gen.Vre;  # gen vector of resources
julia> typeof(vre_gen)
Vector{Vre} (alias for Array{Vre, 1})
julia> GenX.zone_id.(vre_gen)

haskey(r::AbstractResource, sym::Symbol)

Check if an AbstractResource object has a specific attribute. It returns a boolean value indicating whether the attribute exists in the parent object.

Arguments:

• r::AbstractResource: The resource object.
• sym::Symbol: The symbol representing the attribute name.

Returns:

• true if the attribute exists in the parent object, false otherwise.

pairs(r::AbstractResource)

Return an iterator of key-value pairs with the attributes of a given resource.

Arguments

• r::AbstractResource: The resource.

Returns

• Pairs: An iterator of key-value pairs over the attributes.

Base.setindex!(rs::Vector{<:AbstractResource}, value::Vector, sym::Symbol)

Define dot syntax for setting the attributes specified by sym to the corresponding values in value for a vector of resources.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• value::Vector: The vector of values to set for the attribute.
• sym::Symbol: The symbol representing the attribute to set.

Returns

• rs::Vector{<:AbstractResource}: The updated vector of resources.

setproperty!(r::AbstractResource, sym::Symbol, value)

Allows to set the attribute sym of an AbstractResource object using dot syntax.

Arguments:

• r::AbstractResource: The resource object.
• sym::Symbol: The symbol representing the attribute name.
• value: The value to set for the attribute.

Base.setproperty!(rs::Vector{<:AbstractResource}, sym::Symbol, value::Vector)

Set the attributes specified by sym to the corresponding values in value for a vector of resources.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• sym::Symbol: The symbol representing the attribute to set.
• value::Vector: The vector of values to set for the attribute.

Returns

• rs::Vector{<:AbstractResource}: The updated vector of resources.

show(io::IO, r::AbstractResource)

Print the attributes of the given resource.

Arguments

• io::IO: The IO stream to print to.
• r::AbstractResource: The resource.

allam_cycle_lox(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all ALLAMCYCLELOX resources in the vector rs.

attributes(r::AbstractResource)

Returns a tuple of the attribute names of the given resource.

Arguments

• r::AbstractResource: The resource.

Returns

• Tuple: A tuple with symbols representing the attribute names.

elec(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all co-located electrolyzer resources in the vector rs.

electrolyzer(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all electrolyzer resources in the vector rs.

flex_demand(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all flexible demand resources in the vector rs.

get_attr(r::AbstractResource, attr::Symbol, default_value::Real)

Function to get attribute attr from a GenX resource r. If the attribute is not found, return default_value.

Arguments

• r::AbstractResource: The resource.
• attr::Symbol: The attribute to get.
• default_value::Real: The default value to return if the attribute is not found.

Returns

• value::Real: The value of the attribute.

get_attr(rs::Vector{<:AbstractResource}, attr::Symbol, default_value::Real)

Function to get attribute attr from a vector of GenX resources rs.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• attr::Symbol: The attribute to get.
• default_value::Real: The default value to return if the attribute is not found in any of the resources.

Returns

• values::Vector{Real}: The vector of values of the attribute.

get_attr_by_index(rs::Vector{<:AbstractResource}, index::Int64, attr::Symbol, default_value::Real)

Function to get attribute attr from a GenX resource r with index rid. Warning: Always double check the index being passed in is correct. The index in the vector rs might be different from the resource ID. See also by_rid_res for getting the attribute by resource ID.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• index::Int64: The index of the resource.
• attr::Symbol: The attribute to get.
• default_value::Real: The default value to return if the attribute is not found in the resource.

Returns

• value::Real: The value of the attribute.

has_all_options_contributing(retrofit_res::AbstractResource, rs::Vector{T}) where T <: AbstractResource

Check if all retrofit options in the retrofit cluster of the retrofit resource retrofit_res contribute to min retirement.

Arguments

• retrofit_res::AbstractResource: The retrofit resource.
• rs::Vector{T}: The vector of resources.

Returns

• Bool: True if all retrofit options contribute to min retirement, otherwise false.

has_all_options_not_contributing(retrofit_res::AbstractResource, rs::Vector{T}) where T <: AbstractResource

Check if all retrofit options in the retrofit cluster of the retrofit resource retrofit_res do not contribute to min retirement.

Arguments

• retrofit_res::AbstractResource: The retrofit resource.
• rs::Vector{T}: The vector of resources.

Returns

• Bool: True if all retrofit options do not contribute to min retirement, otherwise false.

hydro(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all hydro resources in the vector rs.

ids_with(rs::Vector{T}, f::Function, default=default_zero) where T <: AbstractResource

Function for finding resources in a vector rs where the attribute specified by f is not equal to default.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• f::Function: The getter of the attribute.
• default: The default value of the attribute.

Returns

• ids (Vector{Int64}): The vector of resource ids with attribute not equal to default.

Examples

julia> ids_with(gen.Thermal, existing_cap_mw)
4-element Vector{Int64}:
 21
 22
 23
 24
julia> existing_cap_mw(gen[21])
7.0773

ids_with(rs::Vector{T}, name::Symbol, default=default_zero) where T <: AbstractResource

Function for finding resources in a vector rs where the attribute specified by name is not equal to the default value of the attribute.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• name::Symbol: The name of the attribute.
• default: The default value of the attribute.

Returns

• ids (Vector{Int64}): The vector of resource ids with attribute not equal to default.

Examples

julia> ids_with(gen.Thermal, :existing_cap_mw)
4-element Vector{Int64}:
 21
 22
 23
 24
julia> existing_cap_mw(gen[21])
7.0773

ids_with_all_options_contributing(rs::Vector{T}) where T <: AbstractResource

Find the resource ids of the retrofit units in the vector rs where all retrofit options contribute to min retirement.

Arguments

• rs::Vector{T}: The vector of resources.

Returns

• Vector{Int64}: The vector of resource ids.

ids_with_all_options_not_contributing(rs::Vector{T}) where T <: AbstractResource

Find the resource ids of the retrofit units in the vector rs where all retrofit options do not contribute to min retirement.

Arguments

• rs::Vector{T}: The vector of resources.

Returns

• Vector{Int64}: The vector of resource ids.

ids_with_nonneg(rs::Vector{T}, f::Function) where T <: AbstractResource

Function for finding resources in a vector rs where the attribute specified by f is non-negative.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• f::Function: The getter of the attribute.

Returns

• ids (Vector{Int64}): The vector of resource ids with non-negative attribute.

Examples

julia> ids_with_nonneg(gen, max_cap_mw)

ids_with_nonneg(rs::Vector{T}, f::Function) where T <: AbstractResource

Function for finding resources in a vector rs where the attribute specified by name is non-negative.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• name::Symbol: The name of the attribute.

Returns

• ids (Vector{Int64}): The vector of resource ids with non-negative attribute.

Examples

julia> ids_with_nonneg(gen, max_cap_mw)

ids_with_policy(rs::Vector{T}, f::Function; tag::Int64) where T <: AbstractResource

Function for finding resources in a vector rs where the policy specified by f with tag equal to tag is positive.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• f::Function: The policy getter function.
• tag::Int64: The tag of the policy.

Returns

• ids (Vector{Int64}): The vector of resource ids with a positive value for policy f and tag tag.

idswithpolicy(rs::Vector{T}, name::Symbol; tag::Int64) where T <: AbstractResource

Function for finding resources in a vector rs where the policy specified by name with tag equal to tag is positive.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• name::Symbol: The name of the policy.
• tag::Int64: The tag of the policy.

Returns

• ids (Vector{Int64}): The vector of resource ids with a positive value for policy name and tag tag.

ids_with_positive(rs::Vector{T}, f::Function) where T <: AbstractResource

Function for finding indices of resources in a vector rs where the attribute specified by f is positive.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• f::Function: The getter of the attribute.

Returns

• ids (Vector{Int64}): The vector of resource ids with positive attribute.

Examples

julia> ids_with_positive(gen, max_cap_mw)
3-element Vector{Int64}:
 3 
 4
 5
julia> max_cap_mw(gen[3])
4.888236

ids_with_positive(rs::Vector{T}, name::Symbol) where T <: AbstractResource

Function for finding indices of resources in a vector rs where the attribute specified by name is positive.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• name::Symbol: The name of the attribute.

Returns

• Vector{Int64}: The vector of resource ids with positive attribute.

Examples

julia> ids_with_positive(gen, :max_cap_mw)
3-element Vector{Int64}:
 3 
 4
 5
julia> max_cap_mw(gen[3])
4.888236

must_run(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all must-run resources in the vector rs.

resource_by_name(rs::Vector{<:AbstractResource}, name::AbstractString)

Find the resource with name in the vector rs.

Arguments

• rs: A vector of resources.
• name: The name of the resource.

Returns

• AbstractResource: The resource with the name name.

resources_in_retrofit_cluster_by_rid(rs::Vector{<:AbstractResource}, cluster_id::String)

Find RID's of resources with retrofit cluster id `clusterid`.

Arguments

• rs::Vector{<:AbstractResource}: The vector of resources.
• cluster_id::String: The retrofit cluster id.

Returns

• Vector{Int64}: The vector of resource ids in the retrofit cluster.

resources_in_zone_by_rid(rs::Vector{<:AbstractResource}, zone::Int)

Find R_ID's of resources in a zone.

solar(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all co-located solar resources in the vector rs.

storage(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all storage resources in the vector rs.

storage_ac_charge(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all co-located storage resources in the vector rs that charge AC.

storage_ac_discharge(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all co-located storage resources in the vector rs that discharge AC.

storage_dc_charge(rs::Vector{T}) where T <: AbstractResource
Returns the indices of all co-located storage resources in the vector `rs` that charge DC.

storage_dc_discharge(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all co-located storage resources in the vector rs that discharge DC.

thermal(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all thermal resources in the vector rs.

validate_boolean_attribute(r::AbstractResource, attr::Symbol)

Validate that the attribute attr in the resource r is boolean {0, 1}.

Arguments

• r::AbstractResource: The resource.
• attr::Symbol: The name of the attribute.

vre(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all Vre resources in the vector rs.

vre_stor(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all VRE_STOR resources in the vector rs.

wind(rs::Vector{T}) where T <: AbstractResource

Returns the indices of all co-located wind resources in the vector rs.

interface(name, default=default_zero, type=AbstractResource)

Define a function interface for accessing the attribute specified by name in a resource of type type.

Arguments

• name: The name of the attribute.
• default: The default value to return if the attribute is not found.
• type: The type of the resource.

Returns

• Function: The generated function.

Examples

julia> @interface max_cap_mw 0 Vre
julia> max_cap_mw(gen.Vre[3])
4.888236
julia> max_cap_mw.(gen.Vre) # vectorized
5-element Vector{Float64}:
  0.0
  0.0
  4.888236
 20.835569
  9.848441999999999