remove dynamic branch

Author: luke-kiernan

.claude/claude.md

@@ -42,7 +42,6 @@ Core component models and definitions:
 - `static_models.jl` -- static component definitions
 - `dynamic_generator.jl` -- dynamic generator models
 - `dynamic_inverter.jl` -- dynamic inverter models
-- `dynamic_branch.jl` -- dynamic branch models
 - `dynamic_loads.jl` -- dynamic load models
 - `HybridSystem.jl` -- hybrid renewable + storage systems
 - `serialization.jl` -- component serialization

docs/make.jl

@@ -103,7 +103,6 @@ pages["Model Library"] = make_model_library(
     exceptions = [PSY.DynamicComponent,
                   PSY.ActivePowerControl,
                   PSY.ReactivePowerControl,
-                  PSY.DynamicBranch,
                   PSY.HybridSystem,
                   PSY.OperationalCost,
                   PSY.DynamicInverter,
@@ -115,7 +114,6 @@ pages["Model Library"] = make_model_library(
         "DynamicInjection" => ["Dynamic Inverter" => "model_library/dynamic_inverter.md",
         "Dynamic Generator" => "model_library/dynamic_generator.md",
         ],
-        "Branch" => ["Dynamic Lines" => "model_library/dynamic_branch.md"],
         "Operating Costs" => ["ThermalGenerationCost" =>"model_library/thermal_generation_cost.md",
         "HydroGenerationCost" =>"model_library/hydro_generation_cost.md",
         "HydroReservoirCost" =>"model_library/hydro_reservoir_cost.md",

docs/src/how_to/add_new_types.md

@@ -122,9 +122,6 @@ deserialization process doesn't know what concrete type to construct.
 
 *Solution*: Encode the concrete type into the serialized dictionary as a string.
 
-*Example*:  `serialize` and `deserialize` methods for `DynamicBranch` in
-`src/models/dynamic_branch.jl`.
-
 **Problem**: Similar to above in that a field is defined as an abstract type
 but the struct is parameterized on the actual concrete type.
 

docs/src/model_library/dynamic_branch.md

@@ -276,56 +276,19 @@ dynamic_inv = DynamicInverter(;
 
 add_component!(threebus_sys, dynamic_inv, gen_103)
 
-# Both generators have now been updated with dynamic data. Let's complete the [`System`](@ref)
-# updates by adding dynamic lines.
+# Both generators have now been updated with dynamic data.
 
-# ## Adding Dynamic Lines
-# !!! warning
-#     A [`System`](@ref) must have at least two buses and one branch to run a dynamic simulation in
-#     [`PowerSimulationsDynamics.jl`](https://sienna-platform.github.io/PowerSimulationsDynamics.jl/stable/).
-# Let's review the AC branches currently in the system:
-
-get_components(ACBranch, threebus_sys)
-
-# Notice that we have three static [`Line`](@ref) components.
-# Let's also print the first line to review its format:
-
-first(get_components(Line, threebus_sys))
-
-# See that these components do not have the fields for dynamic modeling, such as fields for
-# different [states](@ref S).
-# Let's update that by cycling through these lines and using [`DynamicBranch`](@ref) to extend
-# each static line with the necessary fields:
-
-for l in get_components(Line, threebus_sys)
-    ## create a dynamic branch
-    dyn_branch = DynamicBranch(l)
-    ## add dynamic branch to the system, replacing the static branch
-    add_component!(threebus_sys, dyn_branch)
-end
-
-# Take a look at the AC branches in the system again:
-
-branches = get_components(ACBranch, threebus_sys)
-
-# Notice that now there are 3 [`DynamicBranch`](@ref) components instead of the `Line` components.
-# Let's take a look by printing the first one:
-
-first(branches)
-
-# Observe that this is a wrapper around the static data, with the additional states
-# data for dynamic modeling.
 # Finally, let's print the [`System`](@ref) again to summarize our additions:
 
 threebus_sys
 
-# Verify that the additions were successful, with an added voltage [`Source`](@ref), [`DynamicBranch`](@ref)es
-# replacing the static [`Line`](@ref), and two new dynamic components with the generator and inverter models.
+# Verify that the additions were successful, with an added voltage [`Source`](@ref) and two new
+# dynamic components with the generator and inverter models.
 
 # ## Next Steps
 # In this tutorial, you have updated a static system with a second dynamic data layer.
 # The data you added can enable a phasor-based simulation using the dynamic generator, or
-# a more complex EMT simulation with the additional dynamic inverter and dynamic lines.
+# a more complex EMT simulation with the additional dynamic inverter.
 # Next, you might like to:
 #   - Read more about the static and dynamic data layers and the dynamic data format in
 #     [Dynamic Devices](@ref).

docs/src/tutorials/add_dynamic_data.jl

@@ -170,7 +170,6 @@ export DynamicInjection
 export DynamicGenerator
 
 export DynamicInverter
-export DynamicBranch
 export HybridSystem
 
 export GenericDER
@@ -936,7 +935,6 @@ include("models/RoundRotorExponential.jl")
 include("models/RoundRotorQuadratic.jl")
 include("models/SalientPoleExponential.jl")
 include("models/SalientPoleQuadratic.jl")
-include("models/dynamic_branch.jl")
 
 include("impedance_correction.jl")
 include("models/supplemental_constructors.jl")

src/PowerSystems.jl

@@ -2590,7 +2590,6 @@ function deserialize_components!(sys::System, raw)
     )
     deserialize_and_add!(; include_types = [HydroReservoir])
     deserialize_and_add!(; include_types = [Branch])
-    deserialize_and_add!(; include_types = [DynamicBranch])
     deserialize_and_add!(; include_types = [ConstantReserveGroup, DynamicInjection])
     deserialize_and_add!(; skip_types = [StaticInjectionSubsystem])
     deserialize_and_add!()
@@ -2613,19 +2612,6 @@ Allow types to implement handling of special cases during deserialization.
 """
 handle_deserialization_special_cases!(component::Dict, ::Type{<:Component}) = nothing
 
-# TODO DT: Do I need to handle this in the new format upgrade?
-#function handle_deserialization_special_cases!(component::Dict, ::Type{DynamicBranch})
-#    # IS handles deserialization of supplemental attribues in each component.
-#    # In this case the DynamicBranch's composed branch is not part of the system and so
-#    # IS will not handle it. It can never attributes.
-#    if !isempty(component["branch"]["supplemental_attributes_container"])
-#        error(
-#            "Bug: serialized DynamicBranch.branch has supplemental attributes: $component",
-#        )
-#    end
-#    return
-#end
-
 # This function does an iterative union find to handle the ordering of the reservoir chains
 function _handle_hydro_reservoirs_deserialization_special_cases(
     components::Vector{Dict},
@@ -2831,11 +2817,6 @@ function check_attached_buses(
     return
 end
 
-function check_attached_buses(sys::System, component::DynamicBranch)
-    check_attached_buses(sys, get_branch(component))
-    return
-end
-
 function check_attached_buses(sys::System, component::Arc)
     throw_if_not_attached(get_from(component), sys)
     throw_if_not_attached(get_to(component), sys)
@@ -2911,16 +2892,6 @@ function check_component_addition(
     return
 end
 
-function check_component_addition(sys::System, dyn_branch::DynamicBranch; kwargs...)
-    if !_is_deserialization_in_progress(sys)
-        throw_if_not_attached(dyn_branch.branch, sys)
-    end
-    arc = get_arc(dyn_branch)
-    throw_if_not_attached(get_from(arc), sys)
-    throw_if_not_attached(get_to(arc), sys)
-    return
-end
-
 function check_component_addition(sys::System, dyn_injector::DynamicInjection; kwargs...)
     if _is_deserialization_in_progress(sys)
         # Ordering of component addition makes these checks impossible.
@@ -2977,12 +2948,6 @@ function handle_component_addition!(sys::System, component::Branch; kwargs...)
     return
 end
 
-function handle_component_addition!(sys::System, component::DynamicBranch; kwargs...)
-    _handle_branch_addition_common!(sys, component)
-    remove_component!(sys, component.branch)
-    return
-end
-
 function handle_component_addition!(sys::System, dyn_injector::DynamicInjection; kwargs...)
     static_injector = kwargs[:static_injector]
     static_base_power = _get_base_power(static_injector)

src/base.jl

@@ -27,6 +27,18 @@ end
 
 supports_services(::DynamicInjection) = false
 get_states(::DynamicInjection) = Vector{Symbol}()
+
+# `states` and `n_states` are fixed structural properties of dynamic components, marked
+# `exclude_setter` ("Do not modify") in the struct descriptors so no per-struct setters are
+# generated. The struct generator still exports the public `set_states!`/`set_n_states!`
+# names, so define them here to reject mutation rather than leave the exports undefined.
+set_states!(::Union{DynamicComponent, DynamicInjection}, ::Any) = throw(
+    ArgumentError("`states` is a fixed property of dynamic components and cannot be set"),
+)
+set_n_states!(::Union{DynamicComponent, DynamicInjection}, ::Any) = throw(
+    ArgumentError("`n_states` is a fixed property of dynamic components and cannot be set"),
+)
+
 """
     Default implementation of get_state_types for dynamic components. Assumes all states are
     Differential

src/models/dynamic_branch.jl

@@ -31,15 +31,8 @@
 
 @testset "Test JSON serialization of dynamic inverter" begin
     sys = PSB.build_system(PSB.PSYTestSystems, "dynamic_inverter_sys")
-
-    # Add a dynamic branch to test that code.
-    branch = collect(get_components(Branch, sys))[1]
-    dynamic_branch = DynamicBranch(branch)
-    add_component!(sys, dynamic_branch)
     _, result = validate_serialization(sys)
     @test result
-
-    test_accessors(dynamic_branch)
 end
 
 @testset "Test JSON serialization of StaticGroupReserve" begin