refactor function names

Author: kaarthiksundar

CHANGELOG.md

@@ -6,6 +6,8 @@
 ## v0.9.3
 - update Memento dependency version
 - adds linear relaxation formulation for steady state OGF
+- adds a new `run_ogf_comp_power_proxy` problem formulation 
+- the `LRWPGasModel` now is populated
 
 
 ## v0.9.2 

src/GasModels.jl

@@ -83,7 +83,7 @@ module GasModels
     include("prob/ls.jl")
     include("prob/nels.jl")
     include("prob/ogf.jl")
-    include("prob/new_ogf.jl")
+    include("prob/ogf_comp_power_proxy.jl")
     include("prob/transient_ogf.jl")
     include("prob/transient_ogf_archived_storage.jl")
 

src/core/objective.jl

@@ -205,7 +205,7 @@ end
 
 "function for minimizing new economic costs: ``\\min \\sum_{j \\in {\\cal D}} \\kappa_j \\boldsymbol{d}_j - \\sum_{j \\in {\\cal T}} \\kappa_j \\boldsymbol{\\tau}_j - \\sum_{j \\in {\\cal R}} \\kappa_j \\boldsymbol{r}_j -
     \\sum_{k \\in {\\cal C}} |\\boldsymbol{p^2}_{jk} - \\boldsymbol{p^2}_{ik}| ``"
-function objective_min_new_economic_costs(gm::AbstractGasModel, nws = [nw_id_default])
+function objective_min_proxy_economic_costs(gm::AbstractGasModel, nws = [nw_id_default])
     mpp = Dict(n => var(gm, n, :min_power_proxy) for n in nws)
     f = Dict(n => var(gm, n, :f_compressor) for n in nws)
     p2 = Dict(n => var(gm, n, :psqr) for n in nws)

src/prob/new_ogf.jl src/prob/ogf_comp_power_proxy.jl

@@ -1,12 +1,12 @@
 # Definitions for running the new optimal gas flow (ogf) (with a proxy compressor power term in the objective)
 
 "entry point into running the new ogf problem"
-function run_new_ogf(file, model_type, optimizer; kwargs...)
+function run_ogf_comp_power_proxy(file, model_type, optimizer; kwargs...)
     return run_model(
         file,
         model_type,
         optimizer,
-        build_new_ogf;
+        build_ogf_comp_power_proxy;
         solution_processors = [
             sol_psqr_to_p!,
             sol_compressor_p_to_r!,
@@ -19,18 +19,18 @@ end
 
 ""
 function run_soc_new_ogf(file, optimizer; kwargs...)
-    return run_new_ogf(file, CRDWPGasModel, optimizer; kwargs...)
+    return run_ogf_comp_power_proxy(file, CRDWPGasModel, optimizer; kwargs...)
 end
 
 
 ""
 function run_dwp_new_ogf(file, optimizer; kwargs...)
-    return run_new_ogf(file, DWPGasModel, optimizer; kwargs...)
+    return run_ogf_comp_power_proxy(file, DWPGasModel, optimizer; kwargs...)
 end
 
 
 "construct the new ogf problem"
-function build_new_ogf(gm::AbstractGasModel)
+function build_ogf_comp_power_proxy(gm::AbstractGasModel)
     bounded_compressors = Dict(
         x for x in ref(gm, :compressor) if
         _calc_is_compressor_energy_bounded(
@@ -53,7 +53,7 @@ function build_new_ogf(gm::AbstractGasModel)
     variable_storage(gm)
     variable_form_specific(gm)
 
-    objective_min_new_economic_costs(gm)
+    objective_min_proxy_economic_costs(gm)
 
     for (i, junction) in ref(gm, :junction)
         constraint_mass_flow_balance(gm, i)

test/new_ogf.jl test/ogf_comp_power_proxy.jl

@@ -1,19 +1,19 @@
 @testset "test new ogf" begin
     @testset "test wp new ogf" begin
         @testset "case 6 new ogf" begin
-            @info "Testing NEW OGF"
+            @info "Testing OGF with compressor power proxy (linear)"
             data = GasModels.parse_file("../test/data/matgas/case-6-no-power-limits.m")
-            result = run_new_ogf(data, WPGasModel, nlp_solver)
+            result = run_ogf_comp_power_proxy(data, WPGasModel, nlp_solver)
             @test result["termination_status"] in [LOCALLY_SOLVED, ALMOST_LOCALLY_SOLVED, OPTIMAL, :Suboptimal]
             @test isapprox(result["objective"], -253.683; atol = 1e-2)
             GasModels.make_si_units!(result["solution"])
             @test isapprox(result["solution"]["receipt"]["1"]["fg"], 123.6822; atol = 1e-2)
         end
 
         @testset "case 6 new ogf weymouth lin rel" begin
-            @info "Testing NEW OGF Linear Relaxation of Pipe Weymouth Physics"
+            @info "Testing  OGF with compressor power proxy Linear Relaxation of Pipe Weymouth Physics"
             data = GasModels.parse_file("../test/data/matgas/case-6-no-power-limits.m")
-            result = run_new_ogf(data, LRWPGasModel, lp_solver)
+            result = run_ogf_comp_power_proxy(data, LRWPGasModel, lp_solver)
             @test result["termination_status"] in [LOCALLY_SOLVED, ALMOST_LOCALLY_SOLVED, OPTIMAL, :Suboptimal]
             @test isapprox(result["objective"], -260.00; atol = 1e-2)
             GasModels.make_si_units!(result["solution"])
@@ -22,19 +22,19 @@
 
 
         @testset "case 6 wp new ogf binding energy constraint" begin
-            @info "Testing NEW OGF Binding Energy Cosntraint"
+            @info "Testing  OGF with compressor power proxy Binding Energy Cosntraint"
             data = GasModels.parse_file("../test/data/matgas/case-6.m")
-            result = run_new_ogf(data, WPGasModel, nlp_solver)
+            result = run_ogf_comp_power_proxy(data, WPGasModel, nlp_solver)
             @test result["termination_status"] in [LOCALLY_SOLVED, ALMOST_LOCALLY_SOLVED, OPTIMAL, :Suboptimal]
             @test isapprox(result["objective"], -237.718; atol = 1e-2)
             GasModels.make_si_units!(result["solution"])
             @test isapprox(result["solution"]["receipt"]["1"]["fg"], 97.33; atol = 1e-2)
         end
 
         @testset "case 6 wp new ogf elevation constraint" begin
-            @info "Testing NEW OGF Elevation Cosntraint"
+            @info "Testing  OGF with compressor power proxy Elevation Cosntraint"
             data = GasModels.parse_file("../test/data/matgas/case-6-elevation.m")
-            result = run_new_ogf(data, WPGasModel, nlp_solver)
+            result = run_ogf_comp_power_proxy(data, WPGasModel, nlp_solver)
             @test result["termination_status"] in [LOCALLY_SOLVED, ALMOST_LOCALLY_SOLVED, OPTIMAL, :Suboptimal]
             @test isapprox(result["objective"], -245.251; atol = 1e-2)
             GasModels.make_si_units!(result["solution"])

test/runtests.jl

@@ -52,7 +52,7 @@ include("common.jl")
 
     include("ogf.jl")
 
-    include("new_ogf.jl")
+    include("ogf_comp_power_proxy.jl")
 
     include("ls.jl")