Introduce stage__output (#1094)

Author: manuelma

src/data_structure/preprocess_data_structure.jl

@@ -914,13 +914,12 @@ function generate_unit_commitment_parameters()
                 indices(shut_down_cost),
                 (x.unit for x in indices(start_up_limit)),
                 (x.unit for x in indices(shut_down_limit)),
-                # ramp_up constraint needs units_started_up variable to avoid being infeasible 
                 (x.unit for x in indices(ramp_up_limit)),
-                # ramp_down constraint needs units_shut_down variable to avoid being infeasible 
                 (x.unit for x in indices(ramp_down_limit)),
                 (x.unit for x in indices(unit_start_flow) if unit_start_flow(; x...) != 0),
                 (x.unit for x in indices(units_started_up_coefficient) if units_started_up_coefficient(; x...) != 0),
-                (u for (st, out, u) in stage__output__unit() if out.name in (:units_started_up, :units_shut_down)),
+                (u for (st, u) in stage__output__unit(output=output.((:units_started_up, :units_shut_down)))),
+                !isempty(stage__output(output=output.((:units_started_up, :units_shut_down)))) ? unit() : (),
             )
         )
     )
@@ -929,7 +928,8 @@ function generate_unit_commitment_parameters()
             (
                 indices(scheduled_outage_duration),
                 indices(fix_units_out_of_service),
-                (u for (st, out, u) in stage__output__unit() if out.name == :units_out_of_service),
+                (u for (st, u) in stage__output__unit(output=output(:units_out_of_service))),
+                !isempty(stage__output(output=output(:units_out_of_service))) ? unit() : (),
             )
         )
     )
@@ -946,7 +946,8 @@ function generate_unit_commitment_parameters()
                 (x.unit for x in indices(minimum_operating_point) if minimum_operating_point(; x...) != 0),
                 (x.unit for x in indices(ramp_up_limit)),
                 (x.unit for x in indices(ramp_down_limit)),
-                (u for (st, out, u) in stage__output__unit() if out.name == :units_on),
+                (u for (st, u) in stage__output__unit(output=output(:units_on))),
+                !isempty(stage__output(output=output(:units_on))) ? unit() : (),
                 (
                     u
                     for u in indices(online_variable_type)

src/run_spineopt.jl

@@ -482,11 +482,14 @@ struct SpineOptExt
             end
         else
             intermediate_results_folder = ""
-            reports_by_output = Dict(
-                (out.name, true) => []
+            outputs = (
+                out
                 for stage__output__entity in (stage__output__unit, stage__output__node, stage__output__connection)
                 for (out, _ent) in stage__output__entity(stage=stage)
             )
+            reports_by_output = Dict(
+                (out.name, true) => [] for out in Iterators.flatten((outputs, stage__output(stage=stage)))
+            )
         end
         event_handlers = Dict(
             :model_built => Set(),

src/run_spineopt_basic.jl

@@ -282,11 +282,15 @@ function _init_downstream_outputs!(st, stage_m, child_models)
         out = output(out_name)
         out_indices = stage_m.ext[:spineopt].variables_definition[out_name][:indices](stage_m)
         isempty(out_indices) && continue
-        objs_by_class_name = Dict(
-            :unit => stage__output__unit(stage=st, output=out),
-            :node => stage__output__node(stage=st, output=out),
-            :connection => stage__output__connection(stage=st, output=out),
-        )
+        objs_by_class_name = if out in stage__output(stage=st)
+            Dict(:unit => anything, :node => anything, :connection => anything)
+        else
+            Dict(
+                :unit => stage__output__unit(stage=st, output=out),
+                :node => stage__output__node(stage=st, output=out),
+                :connection => stage__output__connection(stage=st, output=out),
+            )
+        end
         unique_entities = unique(_drop_key(ind, :t) for ind in out_indices)
         filter!(unique_entities) do ent
             _stage_output_includes_entity(ent, objs_by_class_name)
@@ -301,6 +305,11 @@ function _init_downstream_outputs!(st, stage_m, child_models)
         )
         objs_by_class_name_by_res = Dict()
         for (class_name, objs) in objs_by_class_name
+            if objs === anything
+                res = output_resolution(; stage=st, output=out, _strict=false)
+                get!(objs_by_class_name_by_res, res, Dict())[class_name] = anything
+                continue
+            end
             for obj in objs
                 res = output_resolution(; stage=st, output=out, ((class_name => obj),)..., _strict=false)
                 push!(get!(get!(objs_by_class_name_by_res, res, Dict()), class_name, []), obj)
@@ -331,7 +340,8 @@ end
 
 function _stage_output_includes_entity(ent, objs_by_class_name)
     any(objs_by_class_name) do (class_name, objs)
-        get(ent, class_name, nothing) in objs
+        obj = get(ent, class_name, nothing)
+        obj !== nothing && obj in objs
     end
 end
 

templates/spineopt_template.json

@@ -43,6 +43,7 @@
         ["parent_stochastic_scenario__child_stochastic_scenario", ["stochastic_scenario", "stochastic_scenario"], "A parent-child relationship between two `stochastic_scenario`s defining the master stochastic direct acyclic graph."],
         ["report__output", ["report", "output"], "An `output` that should be included in a `report`."],
         ["stage__child_stage", ["stage", "stage"], "A parent-child relationship between two `stage`s (EXPERIMENTAL)."],
+        ["stage__output", ["stage", "output"], "An `output` that should be fixed by a `stage` for all entities in all its children (EXPERIMENTAL)."],
         ["stage__output__connection", ["stage", "output", "connection"], "An `output` that should be fixed by a `stage` for a `connection` in all its children (EXPERIMENTAL)."],
         ["stage__output__node", ["stage", "output", "node"], "An `output` that should be fixed by a `stage` for a `node` in all its children (EXPERIMENTAL)."],
         ["stage__output__unit", ["stage", "output", "unit"], "An `output` that should be fixed by a `stage` for a `unit` in all its children (EXPERIMENTAL)."],
@@ -349,6 +350,7 @@
         ["node__user_constraint", "storages_invested_available_coefficient", 0.0, null, "Coefficient of the specified node's storages invested available variable in the specified user constraint."],
         ["node__user_constraint", "storages_invested_coefficient", 0.0 , null, "Coefficient of the specified node's storage investment variable in the specified user constraint."],
         ["report__output", "overwrite_results_on_rolling", true, null, "Whether or not results from further windows should overwrite results from previous ones."],
+        ["stage__output", "output_resolution", null, null, "A duration or array of durations indicating the points in time where the output of this stage should be fixed in the children. If not specified, then the output is fixed at the end of each child's roling window (EXPERIMENTAL)."],
         ["stage__output__connection", "output_resolution", null, null, "A duration or array of durations indicating the points in time where the output of this stage should be fixed in the children. If not specified, then the output is fixed at the end of each child's roling window (EXPERIMENTAL)."],
         ["stage__output__node", "output_resolution", null, null, "A duration or array of durations indicating the points in time where the output of this stage should be fixed in the children. If not specified, then the output is fixed at the end of each child's roling window (EXPERIMENTAL)."],
         ["stage__output__unit", "output_resolution", null, null, "A duration or array of durations indicating the points in time where the output of this stage should be fixed in the children. If not specified, then the output is fixed at the end of each child's roling window (EXPERIMENTAL)."],

test/run_spineopt_multi_stage.jl

@@ -168,17 +168,15 @@ function _lt_storage_investments_setup(storage_count)
     lt_storage_data = _lt_storage_data(storage_count)
     lt_storage_investments_data = Dict(
         :relationships => Any[
-            ("stage__output__node", ("lt_storage", "storages_invested_available", "storage_node$k"))
-            for k in 1:storage_count
+            ("stage__output", ("lt_storage", "storages_invested_available"))
         ],
         :relationship_parameter_values => Any[
             (
-                "stage__output__node",
-                ("lt_storage", "storages_invested_available", "storage_node$k"),
+                "stage__output",
+                ("lt_storage", "storages_invested_available"),
                 "output_resolution",
                 unparse_db_value(Hour(1)),
             )
-            for k in 1:storage_count
         ],
     )
     merge!(append!, lt_storage_data, lt_storage_investments_data)