Added support for TwoLevelTree in checks (#83)

* Included checks for TwoLevelTree
* Added checks for StrategicStochasticProfile

Author: JulStraus

NEWS.md

@@ -1,5 +1,9 @@
 # Release notes
 
+## Unversioned
+
+* Introduced support in checks for `TwoLevelTree` and `StrategicStochasticProfile`.
+
 ## Version 0.9.5 (2026-03-25)
 
 ### Minor updates

docs/src/nodes/sink.md

@@ -111,9 +111,8 @@ Hence, if you do not have to call additional functions, but only plan to include
   ```math
   \begin{aligned}
   \texttt{opex\_var}[n, t_{inv}] = & scale\_op\_sp(t_{inv}, t) \times \\
-    \sum_{t \in t_{inv}} & ( surplus\_penalty(n, t) \times \texttt{sink\_surplus}[n, t] + \\ &
-    deficit\_penalty(n, t) \times \texttt{sink\_deficit}[n, t]) \\ &
-
+    & \sum_{t \in t_{inv}} ( surplus\_penalty(n, t) \times \texttt{sink\_surplus}[n, t] + \\
+    & deficit\_penalty(n, t) \times \texttt{sink\_deficit}[n, t])
   \end{aligned}
   ```
 

src/checks.jl

@@ -354,25 +354,39 @@ function check_time_structure(x::AbstractElement, 𝒯)
 end
 
 """
-    check_profile(fieldname, value::TimeProfile, 𝒯)
+    check_profile(fieldname, value::TimeProfile, 𝒯::TwoLevel)
+    check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevel)
+    check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevel)
 
-Check that an individual `TimeProfile` corresponds to the time structure `𝒯`.
-It currently does not include support for identifying `OperationalScenarios`.
+    check_profile(fieldname, value::TimeProfile, 𝒯::TwoLevelTree)
+    check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevelTree)
+    check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevelTree)
+
+Check that an individual `TimeProfile` corresponds to the time structure `𝒯`. The individual
+checks are depending on the profile type and the time structure.
 """
+function check_profile(fieldname, value::TimeProfile, 𝒯::TwoLevel)
+    𝒯ᴵⁿᵛ = strategic_periods(𝒯)
+    for t_inv ∈ 𝒯ᴵⁿᵛ
+        p_msg = "strategic period $(t_inv.sp)"
+        check_profile(fieldname, value, t_inv.operational, p_msg)
+    end
+end
 function check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevel)
     𝒯ᴵⁿᵛ = strategic_periods(𝒯)
 
     len_vals = length(value.vals)
     len_ts = length(𝒯ᴵⁿᵛ)
     if len_vals > len_ts
-        message = "` is longer than the strategic time structure. \
-        Its last $(len_vals - len_ts) value(s) will be omitted."
+        message = "` is longer than the strategic time structure. " *
+            "Its last $(len_vals - len_ts) value(s) will be omitted."
     elseif len_vals < len_ts
-        message = "` is shorter than the strategic time structure. It will use the last \
-        value for the last $(len_ts - len_vals) strategic period(s)."
+        message = "` is shorter than the strategic time structure. It will use the last " *
+            "value for the last $(len_ts - len_vals) strategic period(s)."
     end
-    @assert_or_log len_vals ==
-        len_ts "The `TimeProfile` of field `" * string(fieldname) * message
+    @assert_or_log(
+        len_vals == len_ts, "The `TimeProfile` of field `" * string(fieldname) * message
+    )
     for t_inv ∈ 𝒯ᴵⁿᵛ
         p_msg = "strategic period $(t_inv.sp)"
         check_profile(
@@ -383,13 +397,102 @@ function check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevel)
         )
     end
 end
-function check_profile(fieldname, value, 𝒯::TwoLevel)
+function check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevel)
+    @warn(
+        "Using `StrategicStochasticProfile` with `TwoLevel` is dangerous, " *
+        "as it may lead to unexpected behaviour. " *
+        "In this case, only the profiles of the first scenario are used in the model and " *
+        "tested.",
+        maxlog = 1
+    )
+    prof = StrategicProfile([op_prof[1] for op_prof ∈ value.vals])
+    check_profile(fieldname, prof, 𝒯)
+end
+function check_profile(fieldname, value::TimeProfile, 𝒯::TwoLevelTree)
     𝒯ᴵⁿᵛ = strategic_periods(𝒯)
     for t_inv ∈ 𝒯ᴵⁿᵛ
-        p_msg = "strategic period $(t_inv.sp)"
+        p_msg = "branch $(t_inv.branch) in strategic period $(t_inv.sp)"
         check_profile(fieldname, value, t_inv.operational, p_msg)
     end
 end
+function check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevelTree)
+    𝒯ˢˢᶜ = strategic_scenarios(𝒯)
+    t_inv_vec = []
+
+    for ssc ∈ 𝒯ˢˢᶜ
+        𝒯ᴵⁿᵛ = strategic_periods(ssc)
+        len_vals = length(value.vals)
+        len_ts = length(𝒯ᴵⁿᵛ)
+        if len_vals > len_ts
+            message = "` is longer than strategic scenario $(ssc.scen). " *
+                "Its last $(len_vals - len_ts) value(s) will be omitted."
+        elseif len_vals < len_ts
+            message = "` is shorter than strategic scenario $(ssc.scen). It will use the " *
+                "last value for the last $(len_ts - len_vals) strategic period(s)."
+        end
+        @assert_or_log(
+            len_vals == len_ts, "The `TimeProfile` of field `" * string(fieldname) * message,
+        )
+        for t_inv ∈ 𝒯ᴵⁿᵛ
+            t_inv ∈ t_inv_vec && continue
+            push!(t_inv_vec, t_inv)
+
+            p_msg = "branch $(t_inv.branch) in strategic period $(t_inv.sp)"
+            check_profile(
+                fieldname,
+                value.vals[minimum([t_inv.sp, length(value.vals)])],
+                t_inv.operational,
+                p_msg,
+            )
+        end
+    end
+end
+function check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevelTree)
+    # Check for the number of strategic periods
+    len_vals = length(value.vals)
+    len_ts = n_strat_per(𝒯)
+    if len_vals > len_ts
+        message = "` is longer than the strategic time structure. " *
+            "Its last $(len_vals - len_ts) value(s) will be omitted."
+    elseif len_vals < len_ts
+        message = "` is shorter than the strategic time structure. It will use the last " *
+            "value for the last $(len_ts - len_vals) strategic period(s)."
+    end
+    @assert_or_log(
+        len_vals == len_ts,
+        "The `TimeProfile` of field `" * string(fieldname) * message,
+    )
+
+    # Check each individual branch
+    for sp ∈ 1:n_strat_per(𝒯)
+        pre_msg = "` in strategic period $(sp) has "
+        len_vals = length(value.vals[minimum([sp, length(value.vals)])])
+        len_branches = n_branches(𝒯, sp)
+        if len_vals > len_branches
+            message = pre_msg * "more branches than the time structure. " *
+                "Its last $(len_vals - len_branches) value(s) will be omitted."
+        elseif len_vals < len_branches
+            message = pre_msg * "less branches than the time structure. It will use the " *
+                "last value for the last $(len_branches - len_vals) branche(s)."
+        end
+        @assert_or_log(
+            len_vals == len_branches,
+            "The `TimeProfile` of field `" * string(fieldname) * message,
+        )
+    end
+
+    # Check the sub profiles
+    for t_inv ∈ strategic_periods(𝒯)
+        p_msg = "branch $(t_inv.branch) in strategic period $(t_inv.sp)"
+        sp_prof = value.vals[minimum([t_inv.sp, length(value.vals)])]
+        check_profile(
+            fieldname,
+            sp_prof[minimum([t_inv.branch, length(sp_prof)])],
+            t_inv.operational,
+            p_msg,
+        )
+    end
+end
 
 """
     check_profile(fieldname, value::TimeProfile, ts::TimeStructure, p_msg)

src/model.jl

@@ -783,6 +783,7 @@ function objective(m, 𝒳ᵛᵉᶜ, 𝒫, 𝒯, modeltype::EnergyModel)
         for t_inv ∈ 𝒯ᴵⁿᵛ)
     )
 end
+
 """
     objective_operational(m, 𝒳, 𝒯ᴵⁿᵛ::TS.AbstractStratPers, modeltype::EnergyModel)
 

test/test_checks.jl

@@ -278,24 +278,85 @@ end
 
     # Test that there is an error with wrong strategic profiles
     # - EMB.check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevel)
-    ts = TwoLevel(2, 1, day)
+    # - EMB.check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevelTree)
+    ts = TwoLevel(3, 1, day)
+    ts_tree_reg = TwoLevelTree(1, [2, 1], day)
+    ts_tree_irreg = TwoLevelTree(
+        TreeNode(1, day, [
+            TreeNode(1, day, TreeNode(1, day, TreeNode(1, day))),
+            TreeNode(1, day)
+        ])
+    )
     ops = OperationalProfile(ones(24))
     profiles = [
-        StrategicProfile([ops, ops, ops]),
-        StrategicProfile([ops]),
+        StrategicProfile([ops, ops, ops, ops]),
+        StrategicProfile([ops, ops]),
+    ]
+    for tp ∈ profiles
+        @test_throws AssertionError create_simple_graph(ts, tp)
+        @test_throws AssertionError create_simple_graph(ts_tree_reg, tp)
+        @test_throws AssertionError create_simple_graph(ts_tree_irreg, tp)
+    end
+
+    # Test that there is a warning when using `StrategicStochasticProfile` and `TwoLevel`
+    # - EMB.check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevel)
+    profiles_ssc = StrategicStochasticProfile([[ops], [ops], [ops]])
+    msg =
+        "Using `StrategicStochasticProfile` with `TwoLevel` is dangerous, " *
+        "as it may lead to unexpected behaviour. " *
+        "In this case, only the profiles of the first scenario are used in the model and " *
+        "tested."
+    @test_logs (:warn, msg) create_simple_graph(ts, profiles_ssc);
+
+    # Test that there is an error with wrong `StrategicStochasticProfile`s with `TwoLevel`
+    # - EMB.check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevel)
+    profiles = [
+        StrategicStochasticProfile([[ops], [ops], [ops], [ops]]),
+        StrategicStochasticProfile([[ops], [ops]]),
     ]
     for tp ∈ profiles
         @test_throws AssertionError create_simple_graph(ts, tp)
     end
 
+    # Test that there is an error with wrong `StrategicStochasticProfile`s with `TwoLevelTree`
+    # - EMB.check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevelTree)
+    profiles = [
+        StrategicStochasticProfile([[ops], [ops, ops], [ops, ops], [ops, ops]]),
+        StrategicStochasticProfile([[ops], [ops, ops]]),
+        StrategicStochasticProfile([[ops], [ops, ops], [ops]]),
+        StrategicStochasticProfile([[ops], [ops, ops], [ops, ops, ops]]),
+    ]
+    for tp ∈ profiles
+        @test_throws AssertionError create_simple_graph(ts_tree_reg, tp)
+    end
+
     # Test that there is an error with wrong `OperationalProfile`s
+    # - EMB.check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevel)
+    # - EMB.check_profile(fieldname, value::StrategicProfile, 𝒯::TwoLevelTree)
+    # - EMB.check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevel)
+    # - EMB.check_profile(fieldname, value::StrategicStochasticProfile, 𝒯::TwoLevelTree)
+    # - EMB.check_profile(fieldname, value::TimeProfile, 𝒯::TwoLevel)
+    # - EMB.check_profile(fieldname, value::TimeProfile, 𝒯::TwoLevelTree)
     # - EMB.check_profile(fieldname, value::OperationalProfile, ts::SimpleTimes, sp)
     profiles = [
         OperationalProfile(ones(20)),
         OperationalProfile(ones(30)),
     ]
-    for tp ∈ profiles
+    profiles_sp = [
+        StrategicProfile([ops, ops, profiles[1]]),
+        StrategicProfile([ops, ops, profiles[2]]),
+    ]
+    profiles_ssc = [
+        StrategicStochasticProfile([[ops], [ops, ops], [profiles[1], ops]]),
+        StrategicStochasticProfile([[ops], [ops, ops], [profiles[2], ops]]),
+    ]
+    for (tp, tp_sp, tp_ssc) ∈ zip(profiles, profiles_sp, profiles_ssc)
         @test_throws AssertionError create_simple_graph(ts, tp)
+        @test_throws AssertionError create_simple_graph(ts, tp_sp)
+        @test_throws AssertionError create_simple_graph(ts, tp_ssc)
+        @test_throws AssertionError create_simple_graph(ts_tree_reg, tp)
+        @test_throws AssertionError create_simple_graph(ts_tree_reg, tp_sp)
+        @test_throws AssertionError create_simple_graph(ts_tree_reg, tp_ssc)
     end
 
     # Test that there is an error with wrong `OperationalProfile`s in operational scenarios