Merge branch 'main' into bugfix/check_empty_not_nothing

Author: ymiftah

README.md

@@ -13,7 +13,6 @@ The `PowerSystems.jl` package provides a rigorous data model using Julia structu
 ## Version Advisory
 
 - PowerSystems will work with Julia v1.6+.
-- If you are planning to use `PowerSystems.jl` in your package, check the [roadmap to version 4.0](https://github.com/NREL-Sienna/PowerSystems.jl/projects/4) for upcoming changes
 
 ## Device data enabled in PowerSystems
 

src/PowerSystems.jl

@@ -192,6 +192,7 @@ export DEGOV
 export DEGOV1
 export PIDGOV
 export WPIDHY
+export TGSimple
 
 # Converter Exports
 export Converter

src/base.jl

@@ -10,7 +10,7 @@ const SYSTEM_KWARGS = Set((
     :generator_mapping,
     :internal,
     :load_name_formatter,
-    :load_zone_formatter,
+    :loadzone_name_formatter,
     :runchecks,
     :shunt_name_formatter,
     :time_series_directory,
@@ -2449,6 +2449,7 @@ function convert_component!(
         (from_to = line.rating, to_from = line.rating),
         line.rating,
         line.angle_limits,
+        line.g,
         line.services,
         line.ext,
         _copy_internal_for_conversion(line),
@@ -2492,6 +2493,7 @@ function convert_component!(
         line.b,
         line.rating,
         line.angle_limits,
+        line.g,
         line.services,
         line.ext,
         _copy_internal_for_conversion(line),

src/descriptors/power_system_structs.json

@@ -480,6 +480,18 @@
                     },
                     "validation_action": "error"
                 },
+                {
+                    "name": "g",
+                    "null_value": "(from=0.0, to=0.0)",
+                    "data_type": "FromTo",
+                    "comment": "Shunt conductance in pu ([`SYSTEM_BASE`](@ref per_unit)), specified both on the `from` and `to` ends of the line. These are commonly modeled with the same value",
+                    "valid_range": {
+                        "min": 0,
+                        "max": 100
+                    },
+                    "validation_action": "warn",
+                    "default": "(from=0.0, to=0.0)"
+                },
                 {
                     "name": "services",
                     "data_type": "Vector{Service}",
@@ -599,6 +611,18 @@
                     },
                     "validation_action": "error"
                 },
+                {
+                    "name": "g",
+                    "null_value": "(from=0.0, to=0.0)",
+                    "data_type": "FromTo",
+                    "comment": "Shunt conductance in pu ([`SYSTEM_BASE`](@ref per_unit)), specified both on the `from` and `to` ends of the line. These are commonly modeled with the same value",
+                    "valid_range": {
+                        "min": 0,
+                        "max": 100
+                    },
+                    "validation_action": "warn",
+                    "default": "(from=0.0, to=0.0)"
+                },
                 {
                     "name": "services",
                     "data_type": "Vector{Service}",
@@ -14122,6 +14146,72 @@
             ],
             "supertype": "TurbineGov"
         },
+        {
+            "struct_name": "TGSimple",
+            "docstring": "Parameters of a Simple one-state Turbine Governor",
+            "fields": [
+                {
+                    "name": "d_t",
+                    "comment": "Inverse Droop parameter",
+                    "null_value": 0,
+                    "data_type": "Float64",
+                    "valid_range": {
+                        "min": 0,
+                        "max": null
+                    }
+                },
+                {
+                    "name": "Tm",
+                    "comment": "Turbine Governor Low-Pass Time Constant [s]",
+                    "null_value": 0,
+                    "data_type": "Float64",
+                    "valid_range": {
+                        "min": 0,
+                        "max": null
+                    }
+                },
+                {
+                    "name": "P_ref",
+                    "comment": "Reference Power Set-point (pu)",
+                    "null_value": 0,
+                    "default": "1.0",
+                    "data_type": "Float64",
+                    "valid_range": {
+                        "min": 0,
+                        "max": null
+                    }
+                },
+                {
+                    "name": "ext",
+                    "comment": "An [*ext*ra dictionary](@ref additional_fields) for users to add metadata that are not used in simulation, such as latitude and longitude.",
+                    "data_type": "Dict{String, Any}",
+                    "null_value": "Dict{String, Any}()",
+                    "default": "Dict{String, Any}()"
+                },
+                {
+                    "name": "states",
+                    "exclude_setter": true,
+                    "comment": "(**Do not modify.**) The [states](@ref S) of the TGSimple model are:\n\tτm: mechanical torque",
+                    "internal_default": "[:τm]",
+                    "data_type": "Vector{Symbol}"
+                },
+                {
+                    "name": "n_states",
+                    "exclude_setter": true,
+                    "comment": "(**Do not modify.**) TGSimple has 1 state",
+                    "internal_default": 1,
+                    "data_type": "Int"
+                },
+                {
+                    "name": "internal",
+                    "comment": "(**Do not modify.**) PowerSystems.jl internal reference",
+                    "data_type": "InfrastructureSystemsInternal",
+                    "internal_default": "InfrastructureSystemsInternal()",
+                    "exclude_setter": true
+                }
+            ],
+            "supertype": "TurbineGov"
+        },
         {
             "struct_name": "AverageConverter",
             "docstring": "Parameters of an average converter model",

src/models/generated/Line.jl

@@ -16,6 +16,7 @@ This file is auto-generated. Do not edit.
         b::FromTo
         rating::Float64
         angle_limits::MinMax
+        g::FromTo
         services::Vector{Service}
         ext::Dict{String, Any}
         internal::InfrastructureSystemsInternal
@@ -34,6 +35,7 @@ An AC transmission line
 - `b::FromTo`: Shunt susceptance in pu ([`SYSTEM_BASE`](@ref per_unit)), specified both on the `from` and `to` ends of the line. These are commonly modeled with the same value, validation range: `(0, 100)`
 - `rating::Float64`: Thermal rating (MVA). Flow on the line must be between -`rating` and `rating`. When defining a line before it is attached to a `System`, `rating` must be in per-unit divided by the base power of the `System` it will be attached to
 - `angle_limits::MinMax`: Minimum and maximum angle limits (radians), validation range: `(-1.571, 1.571)`
+- `g::FromTo`: (default: `(from=0.0, to=0.0)`) Shunt conductance in pu ([`SYSTEM_BASE`](@ref per_unit)), specified both on the `from` and `to` ends of the line. These are commonly modeled with the same value, validation range: `(0, 100)`
 - `services::Vector{Service}`: (default: `Device[]`) Services that this device contributes to
 - `ext::Dict{String, Any}`: (default: `Dict{String, Any}()`) An [*ext*ra dictionary](@ref additional_fields) for users to add metadata that are not used in simulation, such as latitude and longitude.
 - `internal::InfrastructureSystemsInternal`: (**Do not modify.**) PowerSystems.jl internal reference
@@ -59,6 +61,8 @@ mutable struct Line <: ACBranch
     rating::Float64
     "Minimum and maximum angle limits (radians)"
     angle_limits::MinMax
+    "Shunt conductance in pu ([`SYSTEM_BASE`](@ref per_unit)), specified both on the `from` and `to` ends of the line. These are commonly modeled with the same value"
+    g::FromTo
     "Services that this device contributes to"
     services::Vector{Service}
     "An [*ext*ra dictionary](@ref additional_fields) for users to add metadata that are not used in simulation, such as latitude and longitude."
@@ -67,12 +71,12 @@ mutable struct Line <: ACBranch
     internal::InfrastructureSystemsInternal
 end
 
-function Line(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, rating, angle_limits, services=Device[], ext=Dict{String, Any}(), )
-    Line(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, rating, angle_limits, services, ext, InfrastructureSystemsInternal(), )
+function Line(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, rating, angle_limits, g=(from=0.0, to=0.0), services=Device[], ext=Dict{String, Any}(), )
+    Line(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, rating, angle_limits, g, services, ext, InfrastructureSystemsInternal(), )
 end
 
-function Line(; name, available, active_power_flow, reactive_power_flow, arc, r, x, b, rating, angle_limits, services=Device[], ext=Dict{String, Any}(), internal=InfrastructureSystemsInternal(), )
-    Line(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, rating, angle_limits, services, ext, internal, )
+function Line(; name, available, active_power_flow, reactive_power_flow, arc, r, x, b, rating, angle_limits, g=(from=0.0, to=0.0), services=Device[], ext=Dict{String, Any}(), internal=InfrastructureSystemsInternal(), )
+    Line(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, rating, angle_limits, g, services, ext, internal, )
 end
 
 # Constructor for demo purposes; non-functional.
@@ -88,6 +92,7 @@ function Line(::Nothing)
         b=(from=0.0, to=0.0),
         rating=0.0,
         angle_limits=(min=-1.571, max=1.571),
+        g=(from=0.0, to=0.0),
         services=Device[],
         ext=Dict{String, Any}(),
     )
@@ -113,6 +118,8 @@ get_b(value::Line) = value.b
 get_rating(value::Line) = get_value(value, value.rating)
 """Get [`Line`](@ref) `angle_limits`."""
 get_angle_limits(value::Line) = value.angle_limits
+"""Get [`Line`](@ref) `g`."""
+get_g(value::Line) = value.g
 """Get [`Line`](@ref) `services`."""
 get_services(value::Line) = value.services
 """Get [`Line`](@ref) `ext`."""
@@ -138,6 +145,8 @@ set_b!(value::Line, val) = value.b = val
 set_rating!(value::Line, val) = value.rating = set_value(value, val)
 """Set [`Line`](@ref) `angle_limits`."""
 set_angle_limits!(value::Line, val) = value.angle_limits = val
+"""Set [`Line`](@ref) `g`."""
+set_g!(value::Line, val) = value.g = val
 """Set [`Line`](@ref) `services`."""
 set_services!(value::Line, val) = value.services = val
 """Set [`Line`](@ref) `ext`."""

src/models/generated/MonitoredLine.jl

@@ -17,6 +17,7 @@ This file is auto-generated. Do not edit.
         flow_limits::FromTo_ToFrom
         rating::Float64
         angle_limits::MinMax
+        g::FromTo
         services::Vector{Service}
         ext::Dict{String, Any}
         internal::InfrastructureSystemsInternal
@@ -38,6 +39,7 @@ For example, monitored lines can be used to restrict line flow following a conti
 - `flow_limits::FromTo_ToFrom`: Minimum and maximum permissable flow on the line (MVA), if different from the thermal rating defined in `rating`
 - `rating::Float64`: Thermal rating (MVA). Flow through the transformer must be between -`rating` and `rating`. When defining a line before it is attached to a `System`, `rating` must be in per-unit divided by the base power of the `System` it will be attached to
 - `angle_limits::MinMax`: Minimum and maximum angle limits (radians), validation range: `(-1.571, 1.571)`
+- `g::FromTo`: (default: `(from=0.0, to=0.0)`) Shunt conductance in pu ([`SYSTEM_BASE`](@ref per_unit)), specified both on the `from` and `to` ends of the line. These are commonly modeled with the same value, validation range: `(0, 100)`
 - `services::Vector{Service}`: (default: `Device[]`) Services that this device contributes to
 - `ext::Dict{String, Any}`: (default: `Dict{String, Any}()`) An [*ext*ra dictionary](@ref additional_fields) for users to add metadata that are not used in simulation, such as latitude and longitude.
 - `internal::InfrastructureSystemsInternal`: (**Do not modify.**) PowerSystems.jl internal reference
@@ -65,6 +67,8 @@ mutable struct MonitoredLine <: ACBranch
     rating::Float64
     "Minimum and maximum angle limits (radians)"
     angle_limits::MinMax
+    "Shunt conductance in pu ([`SYSTEM_BASE`](@ref per_unit)), specified both on the `from` and `to` ends of the line. These are commonly modeled with the same value"
+    g::FromTo
     "Services that this device contributes to"
     services::Vector{Service}
     "An [*ext*ra dictionary](@ref additional_fields) for users to add metadata that are not used in simulation, such as latitude and longitude."
@@ -73,12 +77,12 @@ mutable struct MonitoredLine <: ACBranch
     internal::InfrastructureSystemsInternal
 end
 
-function MonitoredLine(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, flow_limits, rating, angle_limits, services=Device[], ext=Dict{String, Any}(), )
-    MonitoredLine(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, flow_limits, rating, angle_limits, services, ext, InfrastructureSystemsInternal(), )
+function MonitoredLine(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, flow_limits, rating, angle_limits, g=(from=0.0, to=0.0), services=Device[], ext=Dict{String, Any}(), )
+    MonitoredLine(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, flow_limits, rating, angle_limits, g, services, ext, InfrastructureSystemsInternal(), )
 end
 
-function MonitoredLine(; name, available, active_power_flow, reactive_power_flow, arc, r, x, b, flow_limits, rating, angle_limits, services=Device[], ext=Dict{String, Any}(), internal=InfrastructureSystemsInternal(), )
-    MonitoredLine(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, flow_limits, rating, angle_limits, services, ext, internal, )
+function MonitoredLine(; name, available, active_power_flow, reactive_power_flow, arc, r, x, b, flow_limits, rating, angle_limits, g=(from=0.0, to=0.0), services=Device[], ext=Dict{String, Any}(), internal=InfrastructureSystemsInternal(), )
+    MonitoredLine(name, available, active_power_flow, reactive_power_flow, arc, r, x, b, flow_limits, rating, angle_limits, g, services, ext, internal, )
 end
 
 # Constructor for demo purposes; non-functional.
@@ -95,6 +99,7 @@ function MonitoredLine(::Nothing)
         flow_limits=(from_to=0.0, to_from=0.0),
         rating=0.0,
         angle_limits=(min=-1.571, max=1.571),
+        g=(from=0.0, to=0.0),
         services=Device[],
         ext=Dict{String, Any}(),
     )
@@ -122,6 +127,8 @@ get_flow_limits(value::MonitoredLine) = get_value(value, value.flow_limits)
 get_rating(value::MonitoredLine) = get_value(value, value.rating)
 """Get [`MonitoredLine`](@ref) `angle_limits`."""
 get_angle_limits(value::MonitoredLine) = value.angle_limits
+"""Get [`MonitoredLine`](@ref) `g`."""
+get_g(value::MonitoredLine) = value.g
 """Get [`MonitoredLine`](@ref) `services`."""
 get_services(value::MonitoredLine) = value.services
 """Get [`MonitoredLine`](@ref) `ext`."""
@@ -149,6 +156,8 @@ set_flow_limits!(value::MonitoredLine, val) = value.flow_limits = set_value(valu
 set_rating!(value::MonitoredLine, val) = value.rating = set_value(value, val)
 """Set [`MonitoredLine`](@ref) `angle_limits`."""
 set_angle_limits!(value::MonitoredLine, val) = value.angle_limits = val
+"""Set [`MonitoredLine`](@ref) `g`."""
+set_g!(value::MonitoredLine, val) = value.g = val
 """Set [`MonitoredLine`](@ref) `services`."""
 set_services!(value::MonitoredLine, val) = value.services = val
 """Set [`MonitoredLine`](@ref) `ext`."""

src/models/generated/TGSimple.jl

@@ -0,0 +1,88 @@
+#=
+This file is auto-generated. Do not edit.
+=#
+
+#! format: off
+
+"""
+    mutable struct TGSimple <: TurbineGov
+        d_t::Float64
+        Tm::Float64
+        P_ref::Float64
+        ext::Dict{String, Any}
+        states::Vector{Symbol}
+        n_states::Int
+        internal::InfrastructureSystemsInternal
+    end
+
+Parameters of a Simple one-state Turbine Governor
+
+# Arguments
+- `d_t::Float64`: Inverse Droop parameter, validation range: `(0, nothing)`
+- `Tm::Float64`: Turbine Governor Low-Pass Time Constant [s], validation range: `(0, nothing)`
+- `P_ref::Float64`: (default: `1.0`) Reference Power Set-point (pu), validation range: `(0, nothing)`
+- `ext::Dict{String, Any}`: (default: `Dict{String, Any}()`) An [*ext*ra dictionary](@ref additional_fields) for users to add metadata that are not used in simulation, such as latitude and longitude.
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) of the TGSimple model are:
+	τm: mechanical torque
+- `n_states::Int`: (**Do not modify.**) TGSimple has 1 state
+- `internal::InfrastructureSystemsInternal`: (**Do not modify.**) PowerSystems.jl internal reference
+"""
+mutable struct TGSimple <: TurbineGov
+    "Inverse Droop parameter"
+    d_t::Float64
+    "Turbine Governor Low-Pass Time Constant [s]"
+    Tm::Float64
+    "Reference Power Set-point (pu)"
+    P_ref::Float64
+    "An [*ext*ra dictionary](@ref additional_fields) for users to add metadata that are not used in simulation, such as latitude and longitude."
+    ext::Dict{String, Any}
+    "(**Do not modify.**) The [states](@ref S) of the TGSimple model are:
+	τm: mechanical torque"
+    states::Vector{Symbol}
+    "(**Do not modify.**) TGSimple has 1 state"
+    n_states::Int
+    "(**Do not modify.**) PowerSystems.jl internal reference"
+    internal::InfrastructureSystemsInternal
+end
+
+function TGSimple(d_t, Tm, P_ref=1.0, ext=Dict{String, Any}(), )
+    TGSimple(d_t, Tm, P_ref, ext, [:τm], 1, InfrastructureSystemsInternal(), )
+end
+
+function TGSimple(; d_t, Tm, P_ref=1.0, ext=Dict{String, Any}(), states=[:τm], n_states=1, internal=InfrastructureSystemsInternal(), )
+    TGSimple(d_t, Tm, P_ref, ext, states, n_states, internal, )
+end
+
+# Constructor for demo purposes; non-functional.
+function TGSimple(::Nothing)
+    TGSimple(;
+        d_t=0,
+        Tm=0,
+        P_ref=0,
+        ext=Dict{String, Any}(),
+    )
+end
+
+"""Get [`TGSimple`](@ref) `d_t`."""
+get_d_t(value::TGSimple) = value.d_t
+"""Get [`TGSimple`](@ref) `Tm`."""
+get_Tm(value::TGSimple) = value.Tm
+"""Get [`TGSimple`](@ref) `P_ref`."""
+get_P_ref(value::TGSimple) = value.P_ref
+"""Get [`TGSimple`](@ref) `ext`."""
+get_ext(value::TGSimple) = value.ext
+"""Get [`TGSimple`](@ref) `states`."""
+get_states(value::TGSimple) = value.states
+"""Get [`TGSimple`](@ref) `n_states`."""
+get_n_states(value::TGSimple) = value.n_states
+"""Get [`TGSimple`](@ref) `internal`."""
+get_internal(value::TGSimple) = value.internal
+
+"""Set [`TGSimple`](@ref) `d_t`."""
+set_d_t!(value::TGSimple, val) = value.d_t = val
+"""Set [`TGSimple`](@ref) `Tm`."""
+set_Tm!(value::TGSimple, val) = value.Tm = val
+"""Set [`TGSimple`](@ref) `P_ref`."""
+set_P_ref!(value::TGSimple, val) = value.P_ref = val
+"""Set [`TGSimple`](@ref) `ext`."""
+set_ext!(value::TGSimple, val) = value.ext = val