Prototype to evaluate method-forward paradigm

Uses the ReusePatterns.jl @forward macro to remove field duplication in
structs that have common sets of fields.

Author: daniel-thom

Manifest.toml

@@ -21,6 +21,12 @@ git-tree-sha1 = "70885e5e038cba1c4c17a84ad6c40756e10a4fb5"
 uuid = "19ecbf4d-ef7c-5e4b-b54a-0a0ff23c5aed"
 version = "0.5.0"
 
+[[Combinatorics]]
+deps = ["LinearAlgebra", "Polynomials", "Test"]
+git-tree-sha1 = "50b3ae4d643dc27eaff69fb6be06ee094d5500c9"
+uuid = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
+version = "0.7.0"
+
 [[Compat]]
 deps = ["Base64", "Dates", "DelimitedFiles", "Distributed", "InteractiveUtils", "LibGit2", "Libdl", "LinearAlgebra", "Markdown", "Mmap", "Pkg", "Printf", "REPL", "Random", "Serialization", "SharedArrays", "Sockets", "SparseArrays", "Statistics", "Test", "UUIDs", "Unicode"]
 git-tree-sha1 = "84aa74986c5b9b898b0d1acaf3258741ee64754f"
@@ -124,6 +130,12 @@ version = "0.2.22"
 deps = ["Dates", "LibGit2", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
 uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 
+[[Polynomials]]
+deps = ["LinearAlgebra", "SparseArrays", "Test"]
+git-tree-sha1 = "62142bd65d3f8aeb2226ec64dd8493349147df94"
+uuid = "f27b6e38-b328-58d1-80ce-0feddd5e7a45"
+version = "0.5.2"
+
 [[PooledArrays]]
 deps = ["Test"]
 git-tree-sha1 = "6ea4cfb9136d3ff2b9d30d6696cd72166a3b837c"
@@ -164,6 +176,12 @@ git-tree-sha1 = "f6fbf4ba64d295e146e49e021207993b6b48c7d1"
 uuid = "ae029012-a4dd-5104-9daa-d747884805df"
 version = "0.5.2"
 
+[[ReusePatterns]]
+deps = ["Combinatorics", "InteractiveUtils", "Statistics", "Test"]
+git-tree-sha1 = "929cd6332efae7a2d7aa80d9a257c600b4617d0d"
+uuid = "a39b5e78-89b5-562b-97d8-70689129df0c"
+version = "0.1.2"
+
 [[SHA]]
 uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
 
@@ -205,9 +223,9 @@ version = "1.0.0"
 
 [[Tables]]
 deps = ["IteratorInterfaceExtensions", "LinearAlgebra", "Requires", "TableTraits", "Test"]
-git-tree-sha1 = "e2abd466ca2f00a1bb8cb80024d59745cc8f91a6"
+git-tree-sha1 = "9e748316f5aa7b7753c90de612ef98fe8b0ea297"
 uuid = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
-version = "0.2.0"
+version = "0.2.1"
 
 [[Test]]
 deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]

Project.toml

@@ -12,6 +12,7 @@ JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 JSON2 = "2535ab7d-5cd8-5a07-80ac-9b1792aadce3"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
+ReusePatterns = "a39b5e78-89b5-562b-97d8-70689129df0c"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 TimeSeries = "9e3dc215-6440-5c97-bce1-76c03772f85e"
 UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"

src/PowerSystems.jl

@@ -49,6 +49,15 @@ export RenewableFix
 export RenewableCurtailment
 export RenewableFullDispatch
 
+export available
+export bus
+export econ
+export internal
+export name
+export tech
+export uuid
+export uuids
+
 export ThermalGen
 export TechThermal
 export EconThermal
@@ -98,6 +107,7 @@ import JSON2
 import CSV
 import YAML
 import UUIDs
+import ReusePatterns: forward, @forward
 
 #################################################################################
 # Includes
@@ -167,4 +177,7 @@ include("models/serialization.jl")
 include("utils/data.jl")
 import .UtilsData: TestData
 
+# TODO DT: temporay workaround
+name(value::T) where T <: Component = value.name
+
 end # module

src/internal.jl

@@ -9,6 +9,16 @@ end
 """Creates PowerSystemInternal with a UUID."""
 PowerSystemInternal() = PowerSystemInternal(UUIDs.uuid4())
 
+"""Gets the UUID for any PowerSystemType."""
+function uuid(value::PowerSystemInternal)::Base.UUID
+    return value.uuid
+end
+
+"""Gets the UUIDs for a vector of any PowerSystemType."""
+function uuids(objs::Vector{T})::Vector{Base.UUID} where T <: PowerSystemType
+    return [uuid(x) for x in objs]
+end
+
 """Gets the UUID for any PowerSystemType."""
 function get_uuid(obj::T)::Base.UUID where T <: PowerSystemType
     return obj.internal.uuid

src/models/generation.jl

@@ -51,3 +51,9 @@ function genclassifier(gen::Array{T}) where T <: Generator
     return generators
 end
 
+# TODO DT temporary functions to support changes in the current PR.
+# Can be removed when all Generators implement the method-forward paradigm.
+name(value::Generator) = value.name
+available(value::Generator) = value.available
+bus(value::Generator) = value.bus
+tech(value::Generator) = value.tech

src/models/generation/renewable_generation.jl

@@ -1,41 +1,63 @@
-abstract type
-    RenewableGen <: Generator
+abstract type RenewableGen <: Generator end
+
+# TODO DT temporary workaround
+function get_uuid(obj::T)::Base.UUID where T <: RenewableGen
+    return uuid(obj)
 end
 
-struct RenewableFix <: RenewableGen
+struct RenewableGenBase
     name::String
     available::Bool
     bus::Bus
     tech::TechRenewable
     internal::PowerSystemInternal
 end
 
+function RenewableGenBase(name, available, bus, tech)
+    return RenewableGenBase(name, available, bus, tech, PowerSystemInternal())
+end
+
+RenewableGenBase(; name="init",
+                 status=false,
+                 bus=Bus(),
+                 installedcapacity=0.0) = RenewableGenBase(name, status, bus,
+                                                           installedcapacity)
+
+@forward((RenewableGenBase, :internal), PowerSystemInternal)
+
+name(value::RenewableGenBase) = value.name
+available(value::RenewableGenBase) = value.available
+bus(value::RenewableGenBase) = value.bus
+tech(value::RenewableGenBase) = value.tech
+
+struct RenewableFix <: RenewableGen
+    base::RenewableGenBase
+end
+
 function RenewableFix(name, available, bus, tech)
-    return RenewableFix(name, available, bus, tech, PowerSystemInternal())
+    return RenewableFix(RenewableGenBase(name, available, bus, tech))
 end
 
 """Accepts installedcapacity as a Float64 and then creates a TechRenewable."""
 function RenewableFix(name, status, bus, installedcapacity::Float64)
     tech = TechRenewable(installedcapacity, nothing, 1.0)
-    RenewableFix(name, status, bus, tech)
+    RenewableFix(RenewableGenBase(name, status, bus, tech))
 end
 
 RenewableFix(; name="init",
         status = false,
         bus = Bus(),
         installedcapacity = 0.0) = RenewableFix(name, status, bus, installedcapacity)
 
+@forward((RenewableFix, :base), RenewableGenBase)
+
 struct RenewableCurtailment <: RenewableGen
-    name::String
-    available::Bool
-    bus::Bus
-    tech::TechRenewable
+    base::RenewableGenBase
     econ::Union{EconRenewable,Nothing}
-    internal::PowerSystemInternal
 end
 
 function RenewableCurtailment(name, available, bus, tech, econ)
-    return RenewableCurtailment(name, available, bus, tech, econ, PowerSystemInternal())
+    return RenewableCurtailment(RenewableGenBase(name, available, bus, tech), econ)
 end
 
 """Accepts installedcapacity as a Float64 and then creates a TechRenewable."""
@@ -50,21 +72,32 @@ RenewableCurtailment(; name = "init",
                 installedcapacity = 0.0,
                 econ = EconRenewable()) = RenewableCurtailment(name, status, bus, installedcapacity, econ)
 
+econ(value::RenewableCurtailment) = value.econ
+
+@forward((RenewableCurtailment, :base), RenewableGenBase)
+
 struct RenewableFullDispatch <: RenewableGen
-    name::String
-    available::Bool
-    bus::Bus
-    tech::TechRenewable
+    base::RenewableGenBase
     econ::Union{EconRenewable,Nothing}
-    internal::PowerSystemInternal
 end
 
 function RenewableFullDispatch(name, available, bus, tech, econ)
-    return RenewableFullDispatch(name, available, bus, tech, econ, PowerSystemInternal())
+    return RenewableFullDispatch(RenewableGenBase(name, available, bus, tech), econ)
 end
 
-RenewableFullDispatch(; name = "init",
-                status = false,
-                bus= Bus(),
-                installedcapacity = 0.0,
-                econ = EconRenewable()) = RenewableCurtailment(name, status, bus, installedcapacity, econ)
+function RenewableFullDispatch(; name = "init",
+                               status = false,
+                               bus= Bus(),
+                               installedcapacity = 0.0,
+                               econ = EconRenewable())
+    rc = RenewableCurtailment(name, status, bus, installedcapacity, econ)
+    return RenewableFullDispatch(PowerSystems.name(rc),
+                                 PowerSystems.available(rc),
+                                 PowerSystems.bus(rc),
+                                 PowerSystems.tech(rc),
+                                 PowerSystems.econ(rc))
+end
+
+econ(value::RenewableFullDispatch) = value.econ
+
+@forward((RenewableFullDispatch, :base), RenewableGenBase)

src/parsers/dict_to_struct.jl

@@ -115,8 +115,8 @@ Takes a string or symbol "name" and returns a list of devices within a collectio
 function _get_device(name::Union{String,Symbol}, collection, devices = [])
     if isa(collection,Array) && !isempty(collection) && isassigned(collection)
             fn = fieldnames(typeof(collection[1]))
-            if :name in fn
-                [push!(devices,d) for d in collection if d.name == name]
+            if :name in fn || :base in fn
+                [push!(devices,d) for d in collection if PowerSystems.name(d) == name]
             end
     elseif isa(collection, Dict) && !isempty(collection)
         for (key, val) in collection

src/parsers/forecast_parser.jl

@@ -71,7 +71,7 @@ function make_forecast_array(sys::Union{System,Array{Component,1}},ts_dict::Dict
         if (typeof(ts)==DataFrames.DataFrame) & (size(ts,2) > 2)
             devices = reduce(vcat,[_get_device(c,sys) for c in string.(names(ts)) if c != "DateTime"]) #retrieve devices from system that are in the timeseries data
             for d in devices
-                push!(fc,Deterministic(d,"scalingfactor",TimeSeries.TimeArray(ts.DateTime,ts[Symbol(d.name)]))) # TODO: unhardcode scalingfactor
+                push!(fc,Deterministic(d,"scalingfactor",TimeSeries.TimeArray(ts.DateTime,ts[Symbol(name(d))]))) # TODO: unhardcode scalingfactor
             end
         else
             devices = _get_device(key,sys) #retrieve the device object
@@ -109,12 +109,12 @@ function make_forecast_array(sys::ConcreteSystem,ts_dict::Dict)
     for (key,val) in ts_map
         ts = _access(ts_dict,vcat(val,key)) #retrieve timeseries data
         if (typeof(ts)==DataFrames.DataFrame) & (size(ts,2) > 2)
-            devices = [d for d in all_devices if d.name in string.(names(ts))]
+            devices = [d for d in all_devices if name(d) in string.(names(ts))]
             for d in devices
-                push!(fc,Deterministic(d,"scalingfactor",TimeSeries.TimeArray(ts.DateTime,ts[Symbol(d.name)]))) # TODO: unhardcode scalingfactor
+                push!(fc,Deterministic(d,"scalingfactor",TimeSeries.TimeArray(ts.DateTime,ts[Symbol(name(d))]))) # TODO: unhardcode scalingfactor
             end
         else
-            devices = [d for d in all_devices if d.name == key]
+            devices = [d for d in all_devices if name(d) == key]
 
             cn = isa(ts,DataFrames.DataFrame) ? names(ts) : TimeSeries.colnames(ts)
             cn = [c for c in cn if c != :DateTime]
@@ -165,4 +165,4 @@ function parse_json(filename,device_names)
     end
     return Devices
 end
-=#
+=#

src/utils/IO/branchdata_checks.jl

@@ -36,7 +36,7 @@ function checkanglelimits!(branches::Array{<:Branch,1})
 
             if hist[1]
 
-                branches[ix] = Line(deepcopy(l.name),deepcopy(l.available),
+                branches[ix] = Line(deepcopy(name(l)),deepcopy(l.available),
                                     deepcopy(l.connectionpoints),deepcopy(l.r),
                                     deepcopy(l.x),deepcopy(l.b),deepcopy(l.rate),
                                     hist[2])
@@ -92,7 +92,7 @@ function calculatethermallimits!(branches::Array{<:Branch,1},basemva::Float64)
             end
 
             if flag
-                branches[ix] = Line(deepcopy(l.name),deepcopy(l.available),
+                branches[ix] = Line(deepcopy(name(l)),deepcopy(l.available),
                                     deepcopy(l.connectionpoints),deepcopy(l.r),
                                     deepcopy(l.x),deepcopy(l.b),
                                     rate,deepcopy(l.anglelimits))

src/utils/IO/system_checks.jl

@@ -43,7 +43,7 @@ end
 function pvbuscheck(buses::Array{Bus}, generators::Array{T}) where {T<:Generator}
     pv_list = -1*ones(Int64, length(generators))
     for (ix,g) in enumerate(generators)
-        g.bus.bustype == "PV" ? pv_list[ix] = g.bus.number : continue
+        bus(g).bustype == "PV" ? pv_list[ix] = bus(g).number : continue
     end
 
     for b in buses

src/utils/print.jl

@@ -9,8 +9,8 @@ function printPST(pst::Union{Component, GenClasses}, short = false,
     if short
         pst_summary = Base.summary(pst)
         # objects of type TechnicalParams do not have a 'name' field
-        if in(:name, fieldnames(typeof(pst)))
-            print(io, "$pst_summary(name=\"$(pst.name)\")")
+        if in(:name, fieldnames(typeof(pst))) || in(:base, fieldnames(typeof(pst)))
+            print(io, "$pst_summary(name=\"$(name(pst))\")")
         else
             print(io, "$pst_summary")
         end

src/utils/ptdf_calculations.jl

@@ -96,7 +96,7 @@ end
 function PTDF(branches::Array{T}, nodes::Array{Bus}, dist_slack::Array{Float64}=[0.1]) where {T<:Branch}
 
     #Get axis names
-    line_ax = [branch.name for branch in branches]
+    line_ax = [name(branch) for branch in branches]
     bus_ax = [bus.number for bus in nodes]
     S, A = _buildptdf(branches, nodes, dist_slack)
 

src/utils/ybus_calculations.jl

@@ -128,7 +128,7 @@ function build_ybus(buscount::Int64, branches::Array{T}) where {T <: Branch}
 
     for b in branches
 
-        if b.name == "init"
+        if name(b) == "init"
             @error "The data in Branch is incomplete" # TODO: raise error here?
         end
 

src/validation/branch.jl

@@ -3,6 +3,6 @@
 function validate(branch::Branch)::Bool
     is_valid = true
 
-    @debug "Branch validation" branch.name is_valid
+    @debug "Branch validation" name(branch) is_valid
     return is_valid
 end

src/validation/bus.jl

@@ -3,6 +3,6 @@
 function validate(bus::Bus)::Bool
     is_valid = true
 
-    @debug "Bus validation" bus.name bus.number is_valid
+    @debug "Bus validation" name(bus) bus.number is_valid
     return is_valid
 end

src/validation/generator.jl

@@ -20,6 +20,6 @@ end
 function validate(generator::Generator)::Bool
     is_valid = true
 
-    @debug "Generator validation" generator.name is_valid
+    @debug "Generator validation" name(generator) is_valid
     return is_valid
 end

src/validation/load.jl

@@ -4,6 +4,6 @@
 function validate(load::ElectricLoad)::Bool
     is_valid = true
 
-    @debug "Load validation" load.name is_valid
+    @debug "Load validation" name(load) is_valid
     return is_valid
 end

src/validation/storage.jl

@@ -3,6 +3,6 @@
 function validate(storage::Storage)::Bool
     is_valid = true
 
-    @debug "Storage validation" storage.name is_valid
+    @debug "Storage validation" name(storage) is_valid
     return is_valid
 end

test/cdmparse.jl

@@ -102,11 +102,11 @@ end
     @test compare_values_without_uuids(cdmsys.generators.hydro[1].econ,
                                        mpsys.generators.hydro[1].econ)
 
-    @test compare_values_without_uuids(cdmsys.generators.renewable[1].tech,
-                                       mpsys.generators.renewable[1].tech)
+    @test compare_values_without_uuids(tech(cdmsys.generators.renewable[1]),
+                                       tech(mpsys.generators.renewable[1]))
 
-    @test compare_values_without_uuids(cdmsys.generators.renewable[1].econ,
-                                       mpsys.generators.renewable[1].econ)
+    @test compare_values_without_uuids(econ(cdmsys.generators.renewable[1]),
+                                       econ(mpsys.generators.renewable[1]))
 
     @test cdmsys.branches[1].rate ==
         [b for b in mpsys.branches if