diff --git a/dev/api/internal/index.html b/dev/api/internal/index.html index fecd58e842..0e1a5464d0 100644 --- a/dev/api/internal/index.html +++ b/dev/api/internal/index.html @@ -1,5 +1,5 @@ -Internal API Reference · PowerSystems.jl
Edit on GitHub

Internal API

PowerSystems._pti_dtypes — Constant

lookup array of data types for PTI file sections given by field_name, as enumerated by PSS/E Program Operation Manual.

source
PowerSystems.EX4VSA — Type
mutable struct EX4VSA <: AVR
+Internal API Reference · PowerSystems.jl
Edit on GitHub
Internal API
PowerSystems._pti_dtypes — Constant
lookup array of data types for PTI file sections given by field_name, as enumerated by PSS/E Program Operation Manual.
source
PowerSystems.EX4VSA — Type
mutable struct EX4VSA <: AVR
     Iflim::Float64
     d::Float64
     f::Float64
@@ -19,7 +19,7 @@
     internal::InfrastructureSystemsInternal
 end
IEEE Excitation System for Voltage Security Assesment
Arguments
  • Iflim::Float64: OEL Field current limit, validation range: (0, nothing)
  • d::Float64: OEL parameter d, validation range: (0, nothing)
  • f::Float64: OEL parameter f, validation range: (0, nothing)
  • Spar::Float64: OEL parameter Spar, validation range: (0, nothing)
  • K1::Float64: OEL delay time constant, validation range: (0, nothing)
  • K2::Float64: OEL parameter K2, validation range: (0, nothing)
  • Oel_lim::MinMax: Oel integrator limits (Oelmin, Oelmax)
  • G::Float64: AVR Exciter Gain, validation range: (0, nothing)
  • Ta::Float64: Numerator lead-lag (lag) time constant in s, validation range: (0, nothing)
  • Tb::Float64: Denominator lead-lag (lag) time constant in s, validation range: (0, nothing)
  • Te::Float64: Exciter Time Constant in s, validation range: (0, nothing)
  • E_lim::MinMax: Voltage regulator limits (regulator output) (Emin, Emax)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vll: Lead-lag internal state,
 Vex: Exciter Output, 
-oel: OEL integrator state
  • n_states::Int: (Do not modify.) The EX4VSA has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.EXST1 — Type
mutable struct EXST1 <: AVR
+oel: OEL integrator state
  • n_states::Int: (Do not modify.) The EX4VSA has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.EXST1 — Type
mutable struct EXST1 <: AVR
     Tr::Float64
     Vi_lim::MinMax
     Tc::Float64
@@ -38,763 +38,763 @@
 end
IEEE Type ST1 Excitation System (PTI version)
Arguments
  • Tr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)
  • Vi_lim::MinMax: Voltage input limits (Vimin, Vimax)
  • Tc::Float64: Numerator lead-lag (lead) time constant in s, validation range: (0, nothing)
  • Tb::Float64: Denominator lead-lag (lag) time constant in s, validation range: (0, nothing)
  • Ka::Float64: Amplifier Gain, validation range: (0, nothing)
  • Ta::Float64: Amplifier Time Constant in s, validation range: (0, nothing)
  • Vr_lim::MinMax: Voltage regulator limits (regulator output) (Vrmin, Vrmax)
  • Kc::Float64: Current field constant limiter multiplier, validation range: (0, nothing)
  • Kf::Float64: Excitation control system stabilizer gain, validation range: (eps(), 0.3)
  • Tf::Float64: Excitation control system stabilizer time constant, validation range: (eps(), nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vm: Sensed Terminal Voltage,
 Vrll: Lead-Lag state,
 Vr: Regulator Output, 
-Vfb: Feedback state
  • n_states::Int: (Do not modify.) The EXST1 has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.PowerFlowDataNetwork — Method
PowerFlowDataNetwork(
+Vfb: Feedback state
  • n_states::Int: (Do not modify.) The EXST1 has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.PowerFlowDataNetwork — Method
PowerFlowDataNetwork(
     file::Union{IO, String};
     kwargs...
 ) -> PowerSystems.PowerFlowDataNetwork
-
Constructs PowerFlowDataNetwork from a raw file. Currently Supports PSSE data files v30, v32 and v33
source
Base.convert — Method
convert(
+
Constructs PowerFlowDataNetwork from a raw file. Currently Supports PSSE data files v30, v32 and v33
source
Base.convert — Method
convert(
     _::Type{@NamedTuple{min::Float64, max::Float64}},
     input::Tuple{Float64, Float64}
 ) -> @NamedTuple{min::Float64, max::Float64}
-
Convert Tuple to Min Max Named Tuple
source
Base.convert — Method
convert(
     _::Type{@NamedTuple{up::Float64, down::Float64}},
     input::Tuple{Float64, Float64}
 ) -> @NamedTuple{up::Float64, down::Float64}
-
Convert Tuple to Up Down Named Tuple
source
Base.zero — Method
zero(
     _::Union{Type{AverageRateCurve}, AverageRateCurve}
 ) -> AverageRateCurve{LinearFunctionData}
-
Get an AverageRateCurve representing f(x)/x = 0 with zero initial_input
source
Base.zero — Method
zero(
+
Get an AverageRateCurve representing f(x)/x = 0 with zero initial_input
source
Base.zero — Method
zero(
     _::Union{Type{CostCurve}, CostCurve}
 ) -> CostCurve{LinearCurve}
-
Get a CostCurve representing zero variable cost
source
Base.zero — Method
zero(
+
Get a CostCurve representing zero variable cost
source
Base.zero — Method
zero(
     _::Union{Type{FuelCurve}, FuelCurve}
 ) -> FuelCurve{LinearCurve}
-
Get a FuelCurve representing zero fuel usage and zero fuel cost
source
Base.zero — Method
zero(
+
Get a FuelCurve representing zero fuel usage and zero fuel cost
source
Base.zero — Method
zero(
     _::Union{Type{IncrementalCurve}, IncrementalCurve}
 ) -> IncrementalCurve{LinearFunctionData}
-
Get an IncrementalCurve representing f'(x) = 0 with zero initial_input
source
Base.zero — Method
zero(
+
Get an IncrementalCurve representing f'(x) = 0 with zero initial_input
source
Base.zero — Method
zero(
     _::Union{Type{InputOutputCurve}, InputOutputCurve}
 ) -> LinearCurve
-
Get an InputOutputCurve representing f(x) = 0
source
Base.zero — Method
zero(_::Union{Type{ValueCurve}, ValueCurve}) -> LinearCurve
-
Get a ValueCurve representing zero variable cost
source
Base.zero — Method
zero(_::Union{Type{ValueCurve}, ValueCurve}) -> LinearCurve
+
Get a ValueCurve representing zero variable cost
source
PowerSystems._convert_argument_types! — Method
_convert_argument_types!(
     str::AbstractString,
     struct_args::Vector
 ) -> Any
-
Convert specific parameters to types that are not Float64 for specific inverter components
source
PowerSystems._create_starbus_from_transformer — Method
_create_starbus_from_transformer(
     pm_data::Dict,
     transformer::Dict,
     starbus_id::Int64
 ) -> Dict{String, Any}
-
create_starbus(pm_data, transformer)
Creates a starbus from a given three-winding transformer. "sourceid" is given by `["busi", "name", "I", "J", "K", "CKT"]` where "bus_i" and "name" are the modified names for the starbus, and "I", "J", "K" and "CKT" come from the originating transformer, in the PSS(R)E transformer specification.
source
PowerSystems._extract_matlab_assignment — Method
_extract_matlab_assignment(
+
create_starbus(pm_data, transformer)
Creates a starbus from a given three-winding transformer. "sourceid" is given by `["busi", "name", "I", "J", "K", "CKT"]` where "bus_i" and "name" are the modified names for the starbus, and "I", "J", "K" and "CKT" come from the originating transformer, in the PSS(R)E transformer specification.
source
PowerSystems._float2string — Method
_float2string(
     v::AbstractFloat,
     float_precision::Int64
 ) -> Union{String, WeakRefStrings.PosLenString}
-
converts a float value into a string of fixed precision
sprintf would do the job but this work around is needed because sprintf cannot take format strings during runtime
source
PowerSystems._get_bus_value — Method
_get_bus_value(
+
converts a float value into a string of fixed precision
sprintf would do the job but this work around is needed because sprintf cannot take format strings during runtime
source
PowerSystems._get_bus_value — Method
_get_bus_value(
     bus_i::Int64,
     field::String,
     pm_data::Dict{String, Any}
 ) -> Any
-
_get_bus_value(bus_i, field, pm_data)
Returns the value of field of bus_i from the PowerModels data. Requires "bus" Dict to already be populated.
source
PowerSystems._get_contributing_devices — Method
_get_contributing_devices(
+
_get_bus_value(bus_i, field, pm_data)
Returns the value of field of bus_i from the PowerModels data. Requires "bus" Dict to already be populated.
source
PowerSystems._get_line_elements — Method
_get_line_elements(
     line::AbstractString
 ) -> Tuple{Vector{T} where T<:SubString, Union{String, SubString}}
-
_get_line_elements(line)
Internal function. Uses regular expressions to extract all separate data elements from a line of a PTI file and populate them into an Array{String}. Comments, typically indicated at the end of a line with a '/' character, are also extracted separately, and Array{Array{String}, String} is returned.
source
PowerSystems._get_pm_branch_name — Method
_get_pm_branch_name(
+
_get_line_elements(line)
Internal function. Uses regular expressions to extract all separate data elements from a line of a PTI file and populate them into an Array{String}. Comments, typically indicated at the end of a line with a '/' character, are also extracted separately, and Array{Array{String}, String} is returned.
source
PowerSystems._grey — Method
_grey(s::String) -> String
-
Makes a string grey in the terminal, does not seem to work well on Windows terminals more info can be found at https://en.wikipedia.org/wiki/ANSIescapecode
source
PowerSystems._grey — Method
_grey(s::String) -> String
+
Makes a string grey in the terminal, does not seem to work well on Windows terminals more info can be found at https://en.wikipedia.org/wiki/ANSIescapecode
source
PowerSystems._import_remaining_comps! — Method
_import_remaining_comps!(
     data_out::Dict,
     data_in::Dict;
     exclude
 )
-
Imports remaining top level component lists from data_in into data_out, excluding keys in exclude
source
PowerSystems._import_remaining_keys! — Method
_import_remaining_keys!(
     comp_dest::Dict,
     comp_src::Dict;
     exclude
 )
-
Imports remaining keys from a source component into detestation component, excluding keys in exclude
source
PowerSystems._init_bus! — Method
_init_bus!(bus::Dict{String, Any}, id::Int64)
-
_init_bus!(bus, id)
Initializes a bus of id id with default values given in the PSS(R)E specification.
source
PowerSystems._init_bus! — Method
_init_bus!(bus::Dict{String, Any}, id::Int64)
+
_init_bus!(bus, id)
Initializes a bus of id id with default values given in the PSS(R)E specification.
source
PowerSystems._merge_cost_data! — Method
_merge_cost_data!(
     data::Dict{String, Any}
 ) -> Union{Nothing, Dict{String, Any}}
-
merges generator cost functions into generator data, if costs exist
source
PowerSystems._parse_dera1! — Method
_parse_dera1!(
     bus_dict,
     componentID,
     componentValues,
     param_map::Dict,
     bus_num::Int64
 )
-
Parse dictionary of data (from _parse_dyr_file) into a dictionary of DERA1. The function receives the parsed dictionary and constructs a dictionary indexed by bus, that contains a dictionary with each DERA1 indexed by its id.
source
PowerSystems._parse_dyr_components — Method
_parse_dyr_components(
+
Parse dictionary of data (from _parse_dyr_file) into a dictionary of DERA1. The function receives the parsed dictionary and constructs a dictionary indexed by bus, that contains a dictionary with each DERA1 indexed by its id.
source
PowerSystems._parse_dyr_components — Method
_parse_dyr_components(
     dyr_file::AbstractString
 ) -> Dict{Int64, Any}
-
Parse a .dyr file directly from its name by constructing its dictionary of dictionaries.
source
PowerSystems._parse_dyr_components — Method
_parse_dyr_components(data::Dict) -> Dict{Int64, Any}
-
Parse dictionary of dictionaries of data (from _parse_dyr_file) into a dictionary of struct components. The function receives the parsed dictionary and constructs a dictionary indexed by bus, that contains a dictionary with each dynamic generator and dynamic inverter components (indexed via its id).
For Generators, each dictionary indexed by id contains a vector with 5 of its components:
  • Machine
  • Shaft
  • AVR
  • TurbineGov
  • PSS
For Inverters, each dictionary indexed by id contains a vector with 7 of its components:
  • Converter
  • ActivePowerControl
  • ReactivePowerControl
  • InnerControl
  • DCSource
  • FrequencyEstimator
  • Filter
source
PowerSystems._parse_dyr_file — Method
_parse_dyr_file(file::AbstractString) -> Dict{Int64, Dict}
-
Parse .dyr file into a dictionary indexed by bus number. Each bus number key has a dictionary indexed by component type and id.
Comments in .dyr files are not supported (beginning of lines with //).
source
PowerSystems._parse_dyr_components — Method
_parse_dyr_components(data::Dict) -> Dict{Int64, Any}
+
Parse dictionary of dictionaries of data (from _parse_dyr_file) into a dictionary of struct components. The function receives the parsed dictionary and constructs a dictionary indexed by bus, that contains a dictionary with each dynamic generator and dynamic inverter components (indexed via its id).
For Generators, each dictionary indexed by id contains a vector with 5 of its components:
  • Machine
  • Shaft
  • AVR
  • TurbineGov
  • PSS
For Inverters, each dictionary indexed by id contains a vector with 7 of its components:
  • Converter
  • ActivePowerControl
  • ReactivePowerControl
  • InnerControl
  • DCSource
  • FrequencyEstimator
  • Filter
source
PowerSystems._parse_dyr_file — Method
_parse_dyr_file(file::AbstractString) -> Dict{Int64, Dict}
+
Parse .dyr file into a dictionary indexed by bus number. Each bus number key has a dictionary indexed by component type and id.
Comments in .dyr files are not supported (beginning of lines with //).
source
PowerSystems._parse_dyr_generator_components! — Method
_parse_dyr_generator_components!(
     bus_dict::Dict,
     componentID,
     componentValues,
     gen_map::Dict,
     param_map::Dict
 )
-
Parse dictionary of data (from _parse_dyr_file) into a dictionary of struct components. The function receives the parsed dictionary and constructs a dictionary indexed by bus, that contains a dictionary with each dynamic generator indexed by its id.
source
PowerSystems._parse_dyr_inverter_components! — Method
_parse_dyr_inverter_components!(
+
Parse dictionary of data (from _parse_dyr_file) into a dictionary of struct components. The function receives the parsed dictionary and constructs a dictionary indexed by bus, that contains a dictionary with each dynamic generator indexed by its id.
source
PowerSystems._parse_dyr_inverter_components! — Method
_parse_dyr_inverter_components!(
     bus_dict::Dict,
     inv_dict::Dict,
     componentID::Tuple{String, String},
     inv_map::Dict
 )
-
Parse dictionary of data (from _parse_dyr_file) into a dictionary of struct components. The function receives the parsed dictionary and constructs a dictionary indexed by bus, that contains a dictionary with each dynamic inverter indexed by its id.
source
PowerSystems._parse_elements — Method
_parse_elements(
+
Parse dictionary of data (from _parse_dyr_file) into a dictionary of struct components. The function receives the parsed dictionary and constructs a dictionary indexed by bus, that contains a dictionary with each dynamic inverter indexed by its id.
source
PowerSystems._parse_elements — Method
_parse_elements(
     elements::Array,
     dtypes::Array,
     defaults::Dict,
     section::AbstractString
 ) -> Dict{String, Any}
-
This is an experimental method for parsing elements and setting defaults at the same time. It is not currently working but would reduce memory allocations if implemented correctly.
source
PowerSystems._parse_line_element! — Method
_parse_line_element!(
+
This is an experimental method for parsing elements and setting defaults at the same time. It is not currently working but would reduce memory allocations if implemented correctly.
source
PowerSystems._parse_line_element! — Method
_parse_line_element!(
     data::Dict,
     elements::Array,
     section::AbstractString
 )
-
_parse_line_element!(data, elements, section)
Internal function. Parses a single "line" of data elements from a PTI file, as given by elements which is an array of the line, typically split at ,. Elements are parsed into data types given by section and saved into data::Dict.
source
PowerSystems._parse_matlab_data — Method
_parse_matlab_data(
+
_parse_line_element!(data, elements, section)
Internal function. Parses a single "line" of data elements from a PTI file, as given by elements which is an array of the line, typically split at ,. Elements are parsed into data types given by section and saved into data::Dict.
source
PowerSystems._parse_pti_data — Method
_parse_pti_data(data_io::IO) -> Dict{String, Array{Dict}}
-
_parse_pti_data(data_string, sections)
Internal function. Parse a PTI raw file into a Dict, given the data_string of the file and a list of the sections in the PTI file (typically given by default by get_pti_sections().
source
PowerSystems._populate_args — Method
_populate_args(param_map::Vector, val) -> Vector{Any}
-
Populate arguments in a vector for each dynamic component (except Shafts). Returns a vector with the parameter values of the argument of each component.
source
PowerSystems._process_get_cost — Method
_process_get_cost(_, _, cost::Nothing, _, _, _, _)
-
Helper function for cost getters.
Arguments
  • T: type/eltype we expect
  • component::Component: the component
  • cost: the data: either a single element of type T or a TimeSeriesKey
  • transform_fn: a function to apply to the elements of the time series
  • start_time: as in get_time_series
  • len: as in get_time_series
source
PowerSystems._process_set_cost — Method
_process_set_cost(_, _, _, _, _::Nothing)
-
Helper function for cost setters.
Arguments
  • T1: type we expect if it's not a time series
  • T2: eltype we expect if it is a time series
  • sys::System: the system
  • component::Component: the component
  • cost: the data: either a single element of type T1 or a IS.TimeSeriesData of eltype T2
source
PowerSystems._parse_pti_data — Method
_parse_pti_data(data_io::IO) -> Dict{String, Array{Dict}}
+
_parse_pti_data(data_string, sections)
Internal function. Parse a PTI raw file into a Dict, given the data_string of the file and a list of the sections in the PTI file (typically given by default by get_pti_sections().
source
PowerSystems._populate_args — Method
_populate_args(param_map::Vector, val) -> Vector{Any}
+
Populate arguments in a vector for each dynamic component (except Shafts). Returns a vector with the parameter values of the argument of each component.
source
PowerSystems._process_get_cost — Method
_process_get_cost(_, _, cost::Nothing, _, _, _, _)
+
Helper function for cost getters.
Arguments
  • T: type/eltype we expect
  • component::Component: the component
  • cost: the data: either a single element of type T or a TimeSeriesKey
  • transform_fn: a function to apply to the elements of the time series
  • start_time: as in get_time_series
  • len: as in get_time_series
source
PowerSystems._process_set_cost — Method
_process_set_cost(_, _, _, _, _::Nothing)
+
Helper function for cost setters.
Arguments
  • T1: type we expect if it's not a time series
  • T2: eltype we expect if it is a time series
  • sys::System: the system
  • component::Component: the component
  • cost: the data: either a single element of type T1 or a IS.TimeSeriesData of eltype T2
source
PowerSystems._psse2pm_branch! — Method
_psse2pm_branch!(
     pm_data::Dict,
     pti_data::Dict,
     import_all::Bool
 )
-
_psse2pm_branch!(pm_data, pti_data)
Parses PSS(R)E-style Branch data into a PowerModels-style Dict. "source_id" is given by ["I", "J", "CKT"] in PSS(R)E Branch specification.
source
PowerSystems._psse2pm_bus! — Method
_psse2pm_bus!(
+
_psse2pm_branch!(pm_data, pti_data)
Parses PSS(R)E-style Branch data into a PowerModels-style Dict. "source_id" is given by ["I", "J", "CKT"] in PSS(R)E Branch specification.
source
PowerSystems._psse2pm_bus! — Method
_psse2pm_bus!(
     pm_data::Dict,
     pti_data::Dict,
     import_all::Bool
 )
-
_psse2pm_bus!(pm_data, pti_data)
Parses PSS(R)E-style Bus data into a PowerModels-style Dict. "source_id" is given by ["I", "NAME"] in PSS(R)E Bus specification.
source
PowerSystems._psse2pm_dcline! — Method
_psse2pm_dcline!(
+
_psse2pm_bus!(pm_data, pti_data)
Parses PSS(R)E-style Bus data into a PowerModels-style Dict. "source_id" is given by ["I", "NAME"] in PSS(R)E Bus specification.
source
PowerSystems._psse2pm_dcline! — Method
_psse2pm_dcline!(
     pm_data::Dict,
     pti_data::Dict,
     import_all::Bool
 )
-
_psse2pm_dcline!(pm_data, pti_data)
Parses PSS(R)E-style Two-Terminal and VSC DC Lines data into a PowerModels compatible Dict structure by first converting them to a simple DC Line Model. For Two-Terminal DC lines, "sourceid" is given by ["IPR", "IPI", "NAME"] in the PSS(R)E Two-Terminal DC specification. For Voltage Source Converters, "sourceid" is given by ["IBUS1", "IBUS2", "NAME"], where "IBUS1" is "IBUS" of the first converter bus, and "IBUS2" is the "IBUS" of the second converter bus, in the PSS(R)E Voltage Source Converter specification.
source
PowerSystems._psse2pm_generator! — Method
_psse2pm_generator!(
+
_psse2pm_dcline!(pm_data, pti_data)
Parses PSS(R)E-style Two-Terminal and VSC DC Lines data into a PowerModels compatible Dict structure by first converting them to a simple DC Line Model. For Two-Terminal DC lines, "sourceid" is given by ["IPR", "IPI", "NAME"] in the PSS(R)E Two-Terminal DC specification. For Voltage Source Converters, "sourceid" is given by ["IBUS1", "IBUS2", "NAME"], where "IBUS1" is "IBUS" of the first converter bus, and "IBUS2" is the "IBUS" of the second converter bus, in the PSS(R)E Voltage Source Converter specification.
source
PowerSystems._psse2pm_generator! — Method
_psse2pm_generator!(
     pm_data::Dict,
     pti_data::Dict,
     import_all::Bool
 ) -> Union{Nothing, Vector{Dict{String, Any}}}
-
_psse2pm_generator!(pm_data, pti_data)
Parses PSS(R)E-style Generator data in a PowerModels-style Dict. "source_id" is given by ["I", "ID"] in PSS(R)E Generator specification.
source
PowerSystems._psse2pm_load! — Method
_psse2pm_load!(
+
_psse2pm_generator!(pm_data, pti_data)
Parses PSS(R)E-style Generator data in a PowerModels-style Dict. "source_id" is given by ["I", "ID"] in PSS(R)E Generator specification.
source
PowerSystems._psse2pm_load! — Method
_psse2pm_load!(
     pm_data::Dict,
     pti_data::Dict,
     import_all::Bool
 )
-
_psse2pm_load!(pm_data, pti_data)
Parses PSS(R)E-style Load data into a PowerModels-style Dict. "source_id" is given by ["I", "ID"] in the PSS(R)E Load specification.
source
PowerSystems._psse2pm_shunt! — Method
_psse2pm_shunt!(
+
_psse2pm_load!(pm_data, pti_data)
Parses PSS(R)E-style Load data into a PowerModels-style Dict. "source_id" is given by ["I", "ID"] in the PSS(R)E Load specification.
source
PowerSystems._psse2pm_shunt! — Method
_psse2pm_shunt!(
     pm_data::Dict,
     pti_data::Dict,
     import_all::Bool
 )
-
_psse2pm_shunt!(pm_data, pti_data)
Parses PSS(R)E-style Fixed and Switched Shunt data into a PowerModels-style Dict. "source_id" is given by ["I", "ID"] for Fixed Shunts, and ["I", "SWREM"] for Switched Shunts, as given by the PSS(R)E Fixed and Switched Shunts specifications.
source
PowerSystems._psse2pm_transformer! — Method
_psse2pm_transformer!(
+
_psse2pm_shunt!(pm_data, pti_data)
Parses PSS(R)E-style Fixed and Switched Shunt data into a PowerModels-style Dict. "source_id" is given by ["I", "ID"] for Fixed Shunts, and ["I", "SWREM"] for Switched Shunts, as given by the PSS(R)E Fixed and Switched Shunts specifications.
source
PowerSystems._psse2pm_transformer! — Method
_psse2pm_transformer!(
     pm_data::Dict,
     pti_data::Dict,
     import_all::Bool
 )
-
_psse2pm_transformer!(pm_data, pti_data)
Parses PSS(R)E-style Transformer data into a PowerModels-style Dict. "source_id" is given by ["I", "J", "K", "CKT", "winding"], where "winding" is 0 if transformer is two-winding, and 1, 2, or 3 for three-winding, and the remaining keys are defined in the PSS(R)E Transformer specification.
source
PowerSystems._pti_to_powermodels! — Method
_pti_to_powermodels!(
+
_psse2pm_transformer!(pm_data, pti_data)
Parses PSS(R)E-style Transformer data into a PowerModels-style Dict. "source_id" is given by ["I", "J", "K", "CKT", "winding"], where "winding" is 0 if transformer is two-winding, and 1, 2, or 3 for three-winding, and the remaining keys are defined in the PSS(R)E Transformer specification.
source
PowerSystems._pti_to_powermodels! — Method
_pti_to_powermodels!(
     pti_data::Dict;
     import_all,
     validate,
     correct_branch_rating
 ) -> Dict{String, Any}
-
_pti_to_powermodels!(pti_data)
Converts PSS(R)E-style data parsed from a PTI raw file, passed by pti_data into a format suitable for use internally in PowerModels. Imports all remaining data from the PTI file if import_all is true (Default: false).
source
PowerSystems._read_data_row — Method
_read_data_row(
+
_pti_to_powermodels!(pti_data)
Converts PSS(R)E-style data parsed from a PTI raw file, passed by pti_data into a format suitable for use internally in PowerModels. Imports all remaining data from the PTI file if import_all is true (Default: false).
source
PowerSystems._read_data_row — Method
_read_data_row(
     data::PowerSystemTableData,
     row,
     field_infos;
     na_to_nothing
 ) -> NamedTuple
-
Reads values from dataframe row and performs necessary conversions.
source
PowerSystems._remove_pwl_cost_duplicates! — Function
_remove_pwl_cost_duplicates!(id, comp, type_name) -> Bool
 _remove_pwl_cost_duplicates!(
     id,
     comp,
     type_name,
     tolerance
 ) -> Bool
-
checks that each point in the a pwl function is unique, simplifies the function if duplicates appear
source
PowerSystems._simplify_pwl_cost! — Function
_simplify_pwl_cost!(id, comp, type_name) -> Bool
+
checks that each point in the a pwl function is unique, simplifies the function if duplicates appear
source
PowerSystems._simplify_pwl_cost! — Function
_simplify_pwl_cost!(id, comp, type_name) -> Bool
 _simplify_pwl_cost!(id, comp, type_name, tolerance) -> Bool
-
checks the slope of each segment in a pwl function, simplifies the function if the slope changes is below a tolerance
source
PowerSystems._split_loads_shunts! — Method
_split_loads_shunts!(data::Dict{String, Any})
-
_split_loads_shunts!(data)
Seperates Loads and Shunts in data under separate "load" and "shunt" keys in the PowerModels data format. Includes references to originating bus via "loadbus" and "shuntbus" keys, respectively.
source
PowerSystems._split_loads_shunts! — Method
_split_loads_shunts!(data::Dict{String, Any})
+
_split_loads_shunts!(data)
Seperates Loads and Shunts in data under separate "load" and "shunt" keys in the PowerModels data format. Includes references to originating bus via "loadbus" and "shuntbus" keys, respectively.
source
PowerSystems._standardize_cost_terms! — Method
_standardize_cost_terms!(
     components::Dict{String},
     comp_order::Int64,
     cost_comp_name::String
 ) -> Set{Int64}
-
ensures all polynomial costs functions have at exactly comp_order terms
source
PowerSystems._type_array — Method
_type_array(
     string_array::Array{T<:AbstractString, 1}
 ) -> Vector
-
Attempts to determine the type of an array of strings extracted from a matlab file
source
PowerSystems._type_value — Method
_type_value(value_string::AbstractString) -> Any
-
Attempts to determine the type of a string extracted from a matlab file
source
PowerSystems.add_service_internal! — Method
add_service_internal!(device::Device, service::Service)
-
This function add a service to the component without checking if the component and the service are attached to the same system
source
PowerSystems.adequacy_check — Method
adequacy_check(sys::System)
-
adequacy_check(sys::System)
Checks the system for sum(generator ratings) >= sum(load ratings).
Arguments
  • sys::System: system
source
PowerSystems._type_value — Method
_type_value(value_string::AbstractString) -> Any
+
Attempts to determine the type of a string extracted from a matlab file
source
PowerSystems.add_service_internal! — Method
add_service_internal!(device::Device, service::Service)
+
This function add a service to the component without checking if the component and the service are attached to the same system
source
PowerSystems.adequacy_check — Method
adequacy_check(sys::System)
+
adequacy_check(sys::System)
Checks the system for sum(generator ratings) >= sum(load ratings).
Arguments
  • sys::System: system
source
PowerSystems.bus_gen_lookup — Method
bus_gen_lookup(
     gen_data::Dict{String},
     bus_data::Dict{String}
 ) -> Dict
-
builds a lookup list of what generators are connected to a given bus
source
PowerSystems.bus_load_lookup — Method
bus_load_lookup(
     load_data::Dict{String},
     bus_data::Dict{String}
 ) -> Dict
-
builds a lookup list of what loads are connected to a given bus
source
PowerSystems.bus_shunt_lookup — Method
bus_shunt_lookup(
     shunt_data::Dict{String},
     bus_data::Dict{String}
 ) -> Dict
-
builds a lookup list of what shunts are connected to a given bus
source
PowerSystems.bus_storage_lookup — Method
bus_storage_lookup(
     storage_data::Dict{String},
     bus_data::Dict{String}
 ) -> Dict
-
builds a lookup list of what storage is connected to a given bus
source
PowerSystems.calc_branch_flow_ac — Method
calc_branch_flow_ac(data::Dict{String}) -> Dict{String, Any}
-
assumes a vaild ac solution is included in the data and computes the branch flow values
source
PowerSystems.calc_branch_flow_dc — Method
calc_branch_flow_dc(data::Dict{String}) -> Dict{String, Any}
-
assumes a vaild dc solution is included in the data and computes the branch flow values
source
PowerSystems.calc_branch_flow_ac — Method
calc_branch_flow_ac(data::Dict{String}) -> Dict{String, Any}
+
assumes a vaild ac solution is included in the data and computes the branch flow values
source
PowerSystems.calc_branch_flow_dc — Method
calc_branch_flow_dc(data::Dict{String}) -> Dict{String, Any}
+
assumes a vaild dc solution is included in the data and computes the branch flow values
source
PowerSystems.calc_connected_components — Method
calc_connected_components(
     pm_data::Dict{String};
     edges
 ) -> Set{Set{Int64}}
-
computes the connected components of the network graph returns a set of sets of bus ids, each set is a connected component
source
PowerSystems.calc_cost_pwl_lines — Method
calc_cost_pwl_lines(comp_dict::Dict) -> Dict{Any, Any}
-
compute lines in m and b from from pwl cost models data is a list of components.
Can be run on data or ref data structures
source
PowerSystems.calc_power_balance — Method
calc_power_balance(data::Dict{String}) -> Dict{String, Any}
-
assumes a vaild solution is included in the data and computes the power balance at each bus
source
PowerSystems.calc_cost_pwl_lines — Method
calc_cost_pwl_lines(comp_dict::Dict) -> Dict{Any, Any}
+
compute lines in m and b from from pwl cost models data is a list of components.
Can be run on data or ref data structures
source
PowerSystems.calc_power_balance — Method
calc_power_balance(data::Dict{String}) -> Dict{String, Any}
+
assumes a vaild solution is included in the data and computes the power balance at each bus
source
PowerSystems.calculate_saturation_coefficients — Method
calculate_saturation_coefficients(
     E::Tuple{Float64, Float64},
     Se::Tuple{Float64, Float64}
 ) -> Tuple{Float64, Float64}
-
Obtain coefficients (A, B) of the function Se(x) = B(x - A)^2/x for Se(E1) = B(E1 - A)^2/E1 and Se(E2) = B(E2 - A)^2/E2 and uses the negative solution of the quadratic equation 
source
PowerSystems.check_ascending_order — Method
check_ascending_order(
+
Obtain coefficients (A, B) of the function Se(x) = B(x - A)^2/x for Se(E1) = B(E1 - A)^2/E1 and Se(E2) = B(E2 - A)^2/E2 and uses the negative solution of the quadratic equation 
source
PowerSystems.check_component_addition — Method
check_component_addition(
     sys::System,
     component::Component;
     kwargs...
 )
-
Throws ArgumentError if a PowerSystems rule blocks addition to the system.
This method is tied with handlecomponentaddition!. If the methods are re-implemented for a subtype then whatever is added in handlecomponentaddition! must be checked here.
source
PowerSystems.check_status — Method
check_status(data::Dict{String})
-
checks that active components are not connected to inactive buses, otherwise prints warnings
source
PowerSystems.check_type — Method
check_type(typ, value) -> Any
-
Checks if the given value is of a given type, if not tries to make it that type
source
PowerSystems.correct_component_refrence_bus! — Method
correct_component_refrence_bus!(
+
Throws ArgumentError if a PowerSystems rule blocks addition to the system.
This method is tied with handlecomponentaddition!. If the methods are re-implemented for a subtype then whatever is added in handlecomponentaddition! must be checked here.
source
PowerSystems.check_status — Method
check_status(data::Dict{String})
+
checks that active components are not connected to inactive buses, otherwise prints warnings
source
PowerSystems.check_type — Method
check_type(typ, value) -> Any
+
Checks if the given value is of a given type, if not tries to make it that type
source
PowerSystems.correct_network_data! — Method
correct_network_data!(
     data::Dict{String};
     correct_branch_rating
 ) -> Dict{String, Dict{Symbol, Set{Int64}}}
-
Runs various data quality checks on a PowerModels data dictionary. Applies modifications in some cases.  Reports modified component ids.
source
PowerSystems.correct_transformer_parameters! — Method
correct_transformer_parameters!(
     data::Dict{String}
 ) -> Set{Int64}
-
checks that each branch has a reasonable transformer parameters
this is important because setting tap == 0.0 leads to NaN computations, which are hard to debug
source
PowerSystems.correct_voltage_angle_differences! — Function
correct_voltage_angle_differences!(
     data::Dict{String}
 ) -> Set{Int64}
 correct_voltage_angle_differences!(
     data::Dict{String},
     default_pad
 ) -> Set{Int64}
-
checks that voltage angle differences are within 90 deg., if not tightens
source
PowerSystems.deactivate_isolated_components! — Method
deactivate_isolated_components!(data::Dict{String}) -> Bool
-
removes buses with single branch connections and without any other attached components.  Also removes connected components without suffuceint generation or loads.
also deactivates 0 valued loads and shunts.
source
PowerSystems.deactivate_isolated_components! — Method
deactivate_isolated_components!(data::Dict{String}) -> Bool
+
removes buses with single branch connections and without any other attached components.  Also removes connected components without suffuceint generation or loads.
also deactivates 0 valued loads and shunts.
source
PowerSystems.get_avr_saturation — Method
get_avr_saturation(
     E::Tuple{Float64, Float64},
     Se::Tuple{Float64, Float64}
 ) -> Tuple{Float64, Float64}
-
Obtain coefficients for an AVR 
source
PowerSystems.get_dataframe — Method
get_dataframe(
     data::PowerSystemTableData,
     category::PowerSystems.InputCategoryModule.InputCategory
 ) -> DataFrames.DataFrame
-
Return the dataframe for the category.
source
PowerSystems.get_exponential_saturation — Method
get_exponential_saturation(
     Se::Tuple{Float64, Float64}
 ) -> Tuple{Float64, Float64}
-
Obtain coefficients (A, B) of the function Se = Bx^A for Se(1.2) = B(1.2)^A and Se(1.0) = B(1.0)^A as: B = Se(1.0) and hence (1.2)^A = Se(1.2)/B -> A = log(Se(1.2)/B) / log(1.2)
source
PowerSystems.get_generator_mapping — Function
get_generator_mapping() -> Dict{NamedTuple, DataType}
+
Obtain coefficients (A, B) of the function Se = Bx^A for Se(1.2) = B(1.2)^A and Se(1.0) = B(1.0)^A as: B = Se(1.0) and hence (1.2)^A = Se(1.2)/B -> A = log(Se(1.2)/B) / log(1.2)
source
PowerSystems.get_generator_mapping — Function
get_generator_mapping() -> Dict{NamedTuple, DataType}
 get_generator_mapping(
     filename
 ) -> Dict{NamedTuple, DataType}
-
Return a dict where keys are a tuple of input parameters (fuel, unit_type) and values are generator types.
source
PowerSystems.get_generator_type — Method
get_generator_type(
     fuel,
     unit_type,
     mappings::Dict{NamedTuple, DataType}
 ) -> Union{Nothing, DataType}
-
Return the PowerSystems generator type for this fuel and unit_type.
source
PowerSystems.get_quadratic_saturation — Method
get_quadratic_saturation(
     Se::Tuple{Float64, Float64}
 ) -> Tuple{Float64, Float64}
-
Obtain coefficients (A, B) of the function Se = B(x - A)^2/x for Se(1.2) = B(1.2 - A)^2/1.2 and Se(1.0) = B(1.0 - A)^2/1.0 as: Se(1.0) = (Se(1.2) * 1.2) /(1.2 - A)^2 * (1.0 - A)^2/1.0 that yields (1.2 - A)^2 Se(1.0) = Se(1.2) * 1.2 * (1.0 - A)^2 or expanding: (1.2 * Se(1.2) - Se(1.0)) A^2 + (2.4 Se(1.0) - 2 * 1.2 * Se(1.2)) A + (1.2 * Se(1.2) - 1.44 Se(1.0)) = 0 and uses the negative solution of the quadratic equation.
source
PowerSystems.get_series_susceptance — Method
get_series_susceptance(
+
Obtain coefficients (A, B) of the function Se = B(x - A)^2/x for Se(1.2) = B(1.2 - A)^2/1.2 and Se(1.0) = B(1.0 - A)^2/1.0 as: Se(1.0) = (Se(1.2) * 1.2) /(1.2 - A)^2 * (1.0 - A)^2/1.0 that yields (1.2 - A)^2 Se(1.0) = Se(1.2) * 1.2 * (1.0 - A)^2 or expanding: (1.2 * Se(1.2) - Se(1.0)) A^2 + (2.4 Se(1.0) - 2 * 1.2 * Se(1.2)) A + (1.2 * Se(1.2) - 1.44 Se(1.0)) = 0 and uses the negative solution of the quadratic equation.
source
PowerSystems.get_series_susceptance — Method
get_series_susceptance(
     b::Union{PhaseShiftingTransformer, TapTransformer}
 ) -> Float64
-
Returns the series susceptance of a controllable transformer following the convention in power systems to define susceptance as the inverse of the imaginary part of the impedance. In the case of phase shifter transformers the angle is ignored.
source
PowerSystems.get_user_field — Method
get_user_field(
+
Returns the series susceptance of a controllable transformer following the convention in power systems to define susceptance as the inverse of the imaginary part of the impedance. In the case of phase shifter transformers the angle is ignored.
source
PowerSystems.get_user_field — Method
get_user_field(
     data::PowerSystemTableData,
     category::PowerSystems.InputCategoryModule.InputCategory,
     field::AbstractString
 ) -> Any
-
Return the custom name stored in the user descriptor file.
Throws DataFormatError if a required value is not found in the file.
source
PowerSystems.get_user_fields — Method
get_user_fields(
+
Return the custom name stored in the user descriptor file.
Throws DataFormatError if a required value is not found in the file.
source
PowerSystems.get_user_fields — Method
get_user_fields(
     data::PowerSystemTableData,
     category::PowerSystems.InputCategoryModule.InputCategory
 ) -> Any
-
Return a vector of user-defined fields for the category.
source
PowerSystems.handle_deserialization_special_cases! — Method
handle_deserialization_special_cases!(
     component::Dict,
     _::Type{<:Component}
 )
-
Allow types to implement handling of special cases during deserialization.
Arguments
  • component::Dict: The component serialized as a dictionary.
  • ::Type: The type of the component.
source
PowerSystems.im_replicate — Method
im_replicate(
+
Allow types to implement handling of special cases during deserialization.
Arguments
  • component::Dict: The component serialized as a dictionary.
  • ::Type: The type of the component.
source
PowerSystems.im_replicate — Method
im_replicate(
     sn_data::Dict{String},
     count::Int64,
     global_keys::Set{String}
 ) -> Dict{String, Any}
-
Transforms a single network into a multinetwork with several deepcopies of the original network
source
PowerSystems.is_attached — Method
is_attached(component::Component, sys::System) -> Bool
-
Return true if the component is attached to the system.
source
PowerSystems.is_attached — Method
is_attached(component::Component, sys::System) -> Bool
+
Return true if the component is attached to the system.
source
PowerSystems.is_cost_alias — Method
is_cost_alias(
     _::Union{Type{<:ValueCurve}, ValueCurve}
 ) -> Bool
-
Whether there is a cost alias for the instance or type under consideration
source
PowerSystems.isafield — Method
isafield(component::Component, field::Symbol) -> Any
-
Checks if a PowerSystemDevice has a field or subfield name.
source
PowerSystems.isafield — Method
isafield(component::Component, field::Symbol) -> Any
+
Checks if a PowerSystemDevice has a field or subfield name.
source
PowerSystems.iterate_rows — Method
iterate_rows(
     data::PowerSystemTableData,
     category;
     na_to_nothing
 ) -> Channel{Any}
-
Return a NamedTuple of parameters from the descriptor file for each row of a dataframe, making type conversions as necessary.
Refer to the PowerSystems descriptor file for field names that will be created.
source
PowerSystems.load_csv_parser! — Method
load_csv_parser!(sys::System, data::PowerSystemTableData)
-
load_csv_parser!(sys::System, data::PowerSystemTableData)
Add loads to the System from the raw load data.
source
PowerSystems.loadzone_csv_parser! — Method
loadzone_csv_parser!(
+
Return a NamedTuple of parameters from the descriptor file for each row of a dataframe, making type conversions as necessary.
Refer to the PowerSystems descriptor file for field names that will be created.
source
PowerSystems.load_csv_parser! — Method
load_csv_parser!(sys::System, data::PowerSystemTableData)
+
load_csv_parser!(sys::System, data::PowerSystemTableData)
Add loads to the System from the raw load data.
source
PowerSystems.loadzone_csv_parser! — Method
loadzone_csv_parser!(
     sys::System,
     data::PowerSystemTableData
 )
-
loadzone_csv_parser!(sys::System, data::PowerSystemTableData)
Add branches to the System from the raw data.
source
PowerSystems.make_bus — Method
make_bus(bus_dict::Dict{String, Any}) -> ACBus
-
Creates a PowerSystems.ACBus from a PowerSystems bus dictionary
source
PowerSystems.make_generator — Method
make_generator(
+
loadzone_csv_parser!(sys::System, data::PowerSystemTableData)
Add branches to the System from the raw data.
source
PowerSystems.make_bus — Method
make_bus(bus_dict::Dict{String, Any}) -> ACBus
+
Creates a PowerSystems.ACBus from a PowerSystems bus dictionary
source
PowerSystems.make_generator — Method
make_generator(
     data::PowerSystemTableData,
     gen,
     cost_colnames,
     bus,
     gen_storage
 ) -> Any
-
Creates a generator of any type.
source
PowerSystems.make_thermal_gen — Method
make_thermal_gen(
     gen_name::Union{SubString{String}, String},
     d::Dict,
     bus::ACBus,
     sys_mbase::Float64
 ) -> ThermalStandard
-
The polynomial term follows the convention that for an n-degree polynomial, at least n + 1 components are needed.     c(p) = cn*p^n+...+c1p+c0     co is stored in the  field in of the Econ Struct
source
PowerSystems.parse_psse — Method
parse_psse(io::IO; kwargs...) -> Dict{String, Any}
-
function parse_psse(io::IO; kwargs...)::Dict
Parses directly from iostream
source
PowerSystems.parse_psse — Method
parse_psse(filename::String; kwargs...) -> Dict{String, Any}
-
parse_psse(filename::String; kwargs...)::Dict
Parses directly from file
source
PowerSystems.parse_pti — Method
parse_pti(io::IO) -> Dict{String, Array{Dict}}
-
parse_pti(io::IO)
Reads PTI data in io::IO, returning a Dict of the data parsed into the proper types.
source
PowerSystems.parse_pti — Method
parse_pti(filename::String) -> Dict{String, Array{Dict}}
-
parse_pti(filename::String)
Open PTI raw file given by filename, returning a Dict of the data parsed into the proper types.
source
PowerSystems.propagate_topology_status! — Method
propagate_topology_status!(
+
The polynomial term follows the convention that for an n-degree polynomial, at least n + 1 components are needed.     c(p) = cn*p^n+...+c1p+c0     co is stored in the  field in of the Econ Struct
source
PowerSystems.parse_psse — Method
parse_psse(io::IO; kwargs...) -> Dict{String, Any}
+
function parse_psse(io::IO; kwargs...)::Dict
Parses directly from iostream
source
PowerSystems.parse_psse — Method
parse_psse(filename::String; kwargs...) -> Dict{String, Any}
+
parse_psse(filename::String; kwargs...)::Dict
Parses directly from file
source
PowerSystems.parse_pti — Method
parse_pti(io::IO) -> Dict{String, Array{Dict}}
+
parse_pti(io::IO)
Reads PTI data in io::IO, returning a Dict of the data parsed into the proper types.
source
PowerSystems.parse_pti — Method
parse_pti(filename::String) -> Dict{String, Array{Dict}}
+
parse_pti(filename::String)
Open PTI raw file given by filename, returning a Dict of the data parsed into the proper types.
source
PowerSystems.propagate_topology_status! — Method
propagate_topology_status!(
     data::Dict{String}
 ) -> Union{Nothing, Bool}
-
finds active network buses and branches that are not necessary for the computation and sets their status to off.
Works on a PowerModels data dict, so that a it can be used without a GenericPowerModel object
Warning: this implementation has quadratic complexity, in the worst case
source
PowerSystems.read_and_convert_ts — Function
read_and_convert_ts(
+
finds active network buses and branches that are not necessary for the computation and sets their status to off.
Works on a PowerModels data dict, so that a it can be used without a GenericPowerModel object
Warning: this implementation has quadratic complexity, in the worst case
source
PowerSystems.read_and_convert_ts — Function
read_and_convert_ts(
     ts::TimeSeriesData,
     component::Component
 ) -> TimeSeries.TimeArray
@@ -816,58 +816,58 @@
     len::Union{Nothing, Int64},
     transform_fn
 ) -> TimeSeries.TimeArray
-
Call gettimeseriesarray on the given time series and return a TimeArray of the results, values mapped by `transformfn` if it is not nothing
source
PowerSystems.read_gen! — Method
read_gen!(
+
Call gettimeseriesarray on the given time series and return a TimeArray of the results, values mapped by `transformfn` if it is not nothing
source
PowerSystems.read_gen! — Method
read_gen!(
     sys::System,
     data::Dict,
     bus_number_to_bus::Dict{Int64, ACBus};
     kwargs...
 )
-
Transfer generators to ps_dict according to their classification
source
PowerSystems.replicate — Method
replicate(
     sn_data::Dict{String},
     count::Int64;
     global_keys
 ) -> Dict{String, Any}
-
Turns in given single network data in multinetwork data with a count replicate of the given network.  Note that this function performs a deepcopy of the network data.  Significant multinetwork space savings can often be achieved by building application specific methods of building multinetwork with minimal data replication.
source
PowerSystems.resolve_swithces! — Method
resolve_swithces!(data::Dict{String})
-
given a network data dict merges buses that are connected by closed switches converting the dataset into a pure bus-branch model.
source
PowerSystems.services_csv_parser! — Method
services_csv_parser!(
+
Turns in given single network data in multinetwork data with a count replicate of the given network.  Note that this function performs a deepcopy of the network data.  Significant multinetwork space savings can often be achieved by building application specific methods of building multinetwork with minimal data replication.
source
PowerSystems.resolve_swithces! — Method
resolve_swithces!(data::Dict{String})
+
given a network data dict merges buses that are connected by closed switches converting the dataset into a pure bus-branch model.
source
PowerSystems.simplify_network! — Method
simplify_network!(data::Dict{String}) -> Bool
-
attempts to deactive components that are not needed in the network by repeated calls to propagate_topology_status! and deactivate_isolated_components!
warning: this implementation has quadratic complexity, in the worst case
source
PowerSystems.total_capacity_rating — Method
total_capacity_rating(sys::System) -> Any
-
total_capacity_rating(sys::System)
Sum of system generator and storage ratings.
Arguments
  • sys::System: system
source
PowerSystems.total_load_rating — Method
total_load_rating(sys::System) -> Any
-
total_load_rating(sys::System)
Checks the system for sum(generator ratings) >= sum(load ratings).
Arguments
  • sys::System: system
source
PowerSystems.simplify_network! — Method
simplify_network!(data::Dict{String}) -> Bool
+
attempts to deactive components that are not needed in the network by repeated calls to propagate_topology_status! and deactivate_isolated_components!
warning: this implementation has quadratic complexity, in the worst case
source
PowerSystems.total_capacity_rating — Method
total_capacity_rating(sys::System) -> Any
+
total_capacity_rating(sys::System)
Sum of system generator and storage ratings.
Arguments
  • sys::System: system
source
PowerSystems.total_load_rating — Method
total_load_rating(sys::System) -> Any
+
total_load_rating(sys::System)
Checks the system for sum(generator ratings) >= sum(load ratings).
Arguments
  • sys::System: system
source
PowerSystems.update_bus_ids! — Method
update_bus_ids!(
     data::Dict{String},
     bus_id_map::Dict{Int64, Int64};
     injective
 )
-
given a network data dict and a mapping of current-bus-ids to new-bus-ids modifies the data dict to reflect the proposed new bus ids.
source
PowerSystems.update_data! — Method
update_data!(data::Dict{String}, new_data::Dict{String})
-
recursively applies new_data to data, overwriting information
source
PowerSystems.update_data! — Method
update_data!(data::Dict{String}, new_data::Dict{String})
+
recursively applies new_data to data, overwriting information
source
PowerSystems.verify_device_eligibility — Method
verify_device_eligibility(
     sys::System,
     component::StaticInjection,
     service::Service
 )
-
Validates if a device is eligible to contribute to a service.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • service::Service,: Service for which the device is eligible to contribute
source

+

Validates if a device is eligible to contribute to a service.

Arguments

  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • service::Service,: Service for which the device is eligible to contribute
source
diff --git a/dev/api/public/index.html b/dev/api/public/index.html index c637ce22f7..4e67ff5ec3 100644 --- a/dev/api/public/index.html +++ b/dev/api/public/index.html @@ -1,112 +1,112 @@ -Public API Reference · PowerSystems.jl
Edit on GitHub

Public API Reference

Modeling

PowerSystems.Component — Type

Supertype for all PowerSystems components. All subtypes must include a InfrastructureSystemsInternal member. Subtypes should call InfrastructureSystemsInternal() by default, but also must provide a constructor that allows existing values to be deserialized.

source
PowerSystems.get_base_power — Method
get_base_power(c::Component) -> Float64
-
Default behavior of a component. If there is no base_power field, assume is in the system's base power.
source
PowerSystems.set_dynamic_injector! — Method
set_dynamic_injector!(
+Public API Reference · PowerSystems.jl
Edit on GitHub
Public API Reference
Modeling
PowerSystems.Component — Type
Supertype for all PowerSystems components. All subtypes must include a InfrastructureSystemsInternal member. Subtypes should call InfrastructureSystemsInternal() by default, but also must provide a constructor that allows existing values to be deserialized.
source
PowerSystems.get_base_power — Method
get_base_power(c::Component) -> Float64
+
Default behavior of a component. If there is no base_power field, assume is in the system's base power.
source
PowerSystems.set_dynamic_injector! — Method
set_dynamic_injector!(
     static_injector::StaticInjection,
     dynamic_injector::Union{Nothing, DynamicInjection}
 )
-
Any StaticInjection struct that wants to support dynamic injectors must implement this method to set the value.
The method is only for internal uses.
source
PowerSystems.has_service — Method
has_service(device::Device, _::Type{T<:Service}) -> Bool
-
Return true if a service with type T is attached to the device.
source
PowerSystems.remove_service! — Method
remove_service!(device::Device, service::Service)
-
Remove a service from a device.
Throws ArgumentError if the service is not attached to the device.
source
PowerSystems.RenewableGen — Type
Supertype for all renewable generation technologies
Requires the implementation of get_ratingand get_power_factor methods
source
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(d::RenewableGen) -> Any
-
Return the max reactive power for the Renewable Generation calculated as the rating * sin(acos(power_factor))
source
PowerSystems.Reserve — Type
A reserve product to be able to respond to unexpected disturbances, such as the sudden loss of a transmission line or generator.
source
PowerSystems.ReserveDown — Type
A downwards reserve to decrease generation or increase load
Downwards reserves are used when total load falls below its expected level, typically due to forecast errors or contingencies. Not work
A Reserve can be specified as a ReserveDown when it is defined.
source
PowerSystems.ReserveSymmetric — Type
A symmetric reserve, procuring the same quantity (MW) of both upwards and downwards reserves
A symmetric reserve is a special case. ReserveUp and ReserveDown can be used individually to specify different quantities of upwards and downwards reserves, respectively.
A Reserve can be specified as a ReserveSymmetric when it is defined.
source
PowerSystems.ReserveUp — Type
An upwards reserve to increase generation or reduce load
Upwards reserves are used when total load exceeds its expected level, typically due to forecast errors or contingencies.
A Reserve can be specified as a ReserveUp when it is defined.
source
PowerSystems.Service — Type
Supertype for all system services
Services (or ancillary services) include additional requirements and support to ensure reliable electricity service to customers. Common services are reserve products to be able to respond quickly to unexpected disturbances, such as the sudden loss of a transmission line or generator.
source
PowerSystems.GeometricDistributionForcedOutage — Type
Attribute that contains information regarding forced outages where the transition probabilities are modeled with geometric distributions. The outage probabilities and recovery probabilities can be modeled as time series.
Arguments
  • time_to_recovery::Int: Time elapsed to recovery after a failure in Milliseconds.
  • outage_transition_probability::Float64: Characterizes the probability of failure (1 - p) in the geometric distribution.
  • internal::InfrastructureSystemsInternal: power system internal reference, do not modify
source
PowerSystems.PlannedOutage — Type
Attribute that contains information regarding planned outages.
Arguments
  • outage_schedule::String: String name of the time series used for the scheduled outages
  • internal::InfrastructureSystemsInternal: power system internal reference, do not modify
source
PowerSystems.TimeSeriesForcedOutage — Type
Attribute that contains the representation of the status of the component forced outage. The data can be obtained from the simulation of an stochastic process or historical information.
Arguments
  • outage_status_scenario::String: String name of the time series used for the forced outage status in the model. 1 is used represent outaged and 0 for available.
  • internal::InfrastructureSystemsInternal: power system internal reference, do not modify
source
PowerSystems.get_mean_time_to_recovery — Method
get_mean_time_to_recovery(
+
Any StaticInjection struct that wants to support dynamic injectors must implement this method to set the value.
The method is only for internal uses.
source
PowerSystems.has_service — Method
has_service(device::Device, _::Type{T<:Service}) -> Bool
+
Return true if a service with type T is attached to the device.
source
PowerSystems.remove_service! — Method
remove_service!(device::Device, service::Service)
+
Remove a service from a device.
Throws ArgumentError if the service is not attached to the device.
source
PowerSystems.RenewableGen — Type
Supertype for all renewable generation technologies
Requires the implementation of get_ratingand get_power_factor methods
source
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(d::RenewableGen) -> Any
+
Return the max reactive power for the Renewable Generation calculated as the rating * sin(acos(power_factor))
source
PowerSystems.Reserve — Type
A reserve product to be able to respond to unexpected disturbances, such as the sudden loss of a transmission line or generator.
source
PowerSystems.ReserveDown — Type
A downwards reserve to decrease generation or increase load
Downwards reserves are used when total load falls below its expected level, typically due to forecast errors or contingencies. Not work
A Reserve can be specified as a ReserveDown when it is defined.
source
PowerSystems.ReserveSymmetric — Type
A symmetric reserve, procuring the same quantity (MW) of both upwards and downwards reserves
A symmetric reserve is a special case. ReserveUp and ReserveDown can be used individually to specify different quantities of upwards and downwards reserves, respectively.
A Reserve can be specified as a ReserveSymmetric when it is defined.
source
PowerSystems.ReserveUp — Type
An upwards reserve to increase generation or reduce load
Upwards reserves are used when total load exceeds its expected level, typically due to forecast errors or contingencies.
A Reserve can be specified as a ReserveUp when it is defined.
source
PowerSystems.Service — Type
Supertype for all system services
Services (or ancillary services) include additional requirements and support to ensure reliable electricity service to customers. Common services are reserve products to be able to respond quickly to unexpected disturbances, such as the sudden loss of a transmission line or generator.
source
PowerSystems.GeometricDistributionForcedOutage — Type
Attribute that contains information regarding forced outages where the transition probabilities are modeled with geometric distributions. The outage probabilities and recovery probabilities can be modeled as time series.
Arguments
  • time_to_recovery::Int: Time elapsed to recovery after a failure in Milliseconds.
  • outage_transition_probability::Float64: Characterizes the probability of failure (1 - p) in the geometric distribution.
  • internal::InfrastructureSystemsInternal: power system internal reference, do not modify
source
PowerSystems.PlannedOutage — Type
Attribute that contains information regarding planned outages.
Arguments
  • outage_schedule::String: String name of the time series used for the scheduled outages
  • internal::InfrastructureSystemsInternal: power system internal reference, do not modify
source
PowerSystems.TimeSeriesForcedOutage — Type
Attribute that contains the representation of the status of the component forced outage. The data can be obtained from the simulation of an stochastic process or historical information.
Arguments
  • outage_status_scenario::String: String name of the time series used for the forced outage status in the model. 1 is used represent outaged and 0 for available.
  • internal::InfrastructureSystemsInternal: power system internal reference, do not modify
source
PowerSystems.StaticInjection — Type
Abstract type for devices that inject power or current
A static injection is a steady state injection, such as modeling the output power of a generator held constant over a five-minute period.
Many StaticInjection models can accept a DynamicInjection model as an optional add-on for conducting dynamic simulations.
source
PowerSystems.StaticInjectionSubsystem — Type
Abstract type for a subsystem that contains multiple instances of StaticInjection
Subtypes must implement:
  • get_subcomponents(subsystem::StaticInjectionSubsystem)
The subcomponents in subtypes must be attached to the System as masked components.
source
PowerSystems.StaticInjection — Type
Abstract type for devices that inject power or current
A static injection is a steady state injection, such as modeling the output power of a generator held constant over a five-minute period.
Many StaticInjection models can accept a DynamicInjection model as an optional add-on for conducting dynamic simulations.
source
PowerSystems.StaticInjectionSubsystem — Type
Abstract type for a subsystem that contains multiple instances of StaticInjection
Subtypes must implement:
  • get_subcomponents(subsystem::StaticInjectionSubsystem)
The subcomponents in subtypes must be attached to the System as masked components.
source
PowerSystems.copy_subcomponent_time_series! — Method
copy_subcomponent_time_series!(
     subsystem::StaticInjectionSubsystem,
     subcomponent::Component
 )
-
Efficiently add all time series data in the subcomponent to the subsystem by copying the underlying references.
source
PowerSystems.get_dynamic_components — Method
get_dynamic_components(
     device::DynamicInjection
 ) -> Base.Generator{I, F} where {I<:(Base.Iterators.Filter{PowerSystems.var"#6#8", I} where I<:(Base.Iterators.Zip{Is} where Is<:Tuple{Any, Tuple})), F<:(PowerSystems.var"#5#7"{<:DynamicInjection})}
-
Return all the dynamic components of a DynamicInjection device
source
PowerSystems.get_states_types — Method
get_states_types(d::DynamicComponent) -> Vector{StateTypes}
 
Default implementation of get_state_types for dynamic components. Assumes all states are
-Differential
source
PowerSystems.AverageRateCurve — Type
An average rate curve, relating the production quantity to the average cost rate from the origin: y = f(x)/x. Can be used, for instance, in the representation of a CostCurve where x is MW and y is currency/MWh, or in the representation of a FuelCurve where x is MW and y is fuel/MWh. Typically calculated by dividing absolute values of cost rate or fuel input rate by absolute values of electric power.
source
PowerSystems.IncrementalCurve — Type
An incremental (or 'marginal') curve, relating the production quantity to the derivative of cost: y = f'(x). Can be used, for instance, in the representation of a CostCurve where x is MW and y is currency/MWh, or in the representation of a FuelCurve where x is MW and y is fuel/MWh.
source
PowerSystems.InputOutputCurve — Type
An input-output curve, directly relating the production quantity to the cost: y = f(x). Can be used, for instance, in the representation of a CostCurve where x is MW and y is currency/hr, or in the representation of a FuelCurve where x is MW and y is fuel/hr.
source
PowerSystems.AverageRateCurve — Type
An average rate curve, relating the production quantity to the average cost rate from the origin: y = f(x)/x. Can be used, for instance, in the representation of a CostCurve where x is MW and y is currency/MWh, or in the representation of a FuelCurve where x is MW and y is fuel/MWh. Typically calculated by dividing absolute values of cost rate or fuel input rate by absolute values of electric power.
source
PowerSystems.IncrementalCurve — Type
An incremental (or 'marginal') curve, relating the production quantity to the derivative of cost: y = f'(x). Can be used, for instance, in the representation of a CostCurve where x is MW and y is currency/MWh, or in the representation of a FuelCurve where x is MW and y is fuel/MWh.
source
PowerSystems.InputOutputCurve — Type
An input-output curve, directly relating the production quantity to the cost: y = f(x). Can be used, for instance, in the representation of a CostCurve where x is MW and y is currency/hr, or in the representation of a FuelCurve where x is MW and y is fuel/hr.
source
PowerSystems.get_initial_input — Method
get_initial_input(
     curve::Union{AverageRateCurve, IncrementalCurve}
 ) -> Union{Nothing, Float64}
-
Get the initial_input field of this ValueCurve (not defined for InputOutputCurve)
source
PowerSystems.get_fuel_cost — Method
get_fuel_cost(
     component::StaticInjection;
     start_time,
     len
 ) -> Union{Float64, TimeSeries.TimeArray}
-
Get the fuel cost of the component's variable cost, which must be a FuelCurve.
source
PowerSystems.get_no_load_cost — Method
get_no_load_cost(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{Float64, TimeSeries.TimeArray}
-
Retrieve the no-load cost data for a StaticInjection device with a MarketBidCost. If this field is a time series, the user may specify start_time and len and the function returns a TimeArray of Float64s; if the field is not a time series, the function returns a single Float64.
source
PowerSystems.get_services_bid — Method
get_services_bid(
+
Retrieve the no-load cost data for a StaticInjection device with a MarketBidCost. If this field is a time series, the user may specify start_time and len and the function returns a TimeArray of Float64s; if the field is not a time series, the function returns a single Float64.
source
PowerSystems.get_services_bid — Method
get_services_bid(
     device::StaticInjection,
     cost::MarketBidCost,
     service::Service;
     start_time,
     len
 ) -> TimeSeries.TimeArray
-
Return service bid time series data for a StaticInjection device with a MarketBidCost. The user may specify start_time and len and the function returns a TimeArray of CostCurves.
source
PowerSystems.get_start_up — Method
get_start_up(
+
Return service bid time series data for a StaticInjection device with a MarketBidCost. The user may specify start_time and len and the function returns a TimeArray of CostCurves.
source
PowerSystems.get_start_up — Method
get_start_up(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeries.TimeArray}
-
Retrieve the no-load cost data for a StaticInjection device with a MarketBidCost. If this field is a time series, the user may specify start_time and len and the function returns a TimeArray of Float64s; if the field is not a time series, the function returns a single Float64.
source
PowerSystems.get_variable_cost — Method
get_variable_cost(
+
Retrieve the no-load cost data for a StaticInjection device with a MarketBidCost. If this field is a time series, the user may specify start_time and len and the function returns a TimeArray of Float64s; if the field is not a time series, the function returns a single Float64.
source
PowerSystems.get_variable_cost — Method
get_variable_cost(
     service::ReserveDemandCurve;
     start_time,
     len
 ) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}
-
Retrieve the variable cost data for a ReserveDemandCurve. The user may specify start_time and len and the function returns a TimeArray of CostCurves.
source
PowerSystems.get_variable_cost — Method
get_variable_cost(
+
Retrieve the variable cost data for a ReserveDemandCurve. The user may specify start_time and len and the function returns a TimeArray of CostCurves.
source
PowerSystems.get_variable_cost — Method
get_variable_cost(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}
-
Retrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If this field is a time series, the user may specify start_time and len and the function returns a TimeArray of CostCurves; if the field is not a time series, the function returns a single CostCurve.
source
PowerSystems.set_fuel_cost! — Method
set_fuel_cost!(
+
Retrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If this field is a time series, the user may specify start_time and len and the function returns a TimeArray of CostCurves; if the field is not a time series, the function returns a single CostCurve.
source
PowerSystems.set_fuel_cost! — Method
set_fuel_cost!(
     sys::System,
     component::StaticInjection,
     data::Union{Float64, TimeSeriesData}
 ) -> Any
-
Set the fuel cost of the component's variable cost, which must be a FuelCurve.
source
PowerSystems.set_no_load_cost! — Method
set_no_load_cost!(
     sys::System,
     component::StaticInjection,
     data::Union{Float64, TimeSeriesData}
 ) -> Union{Float64, TimeSeriesKey}
-
Set the no-load cost for a StaticInjection device with a MarketBidCost to either a single number or a time series.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • time_series_data::Union{Float64, IS.TimeSeriesData},: the data. If a time series, must be of eltype Float64.
source
PowerSystems.set_service_bid! — Method
set_service_bid!(
+
Set the no-load cost for a StaticInjection device with a MarketBidCost to either a single number or a time series.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • time_series_data::Union{Float64, IS.TimeSeriesData},: the data. If a time series, must be of eltype Float64.
source
PowerSystems.set_service_bid! — Method
set_service_bid!(
     sys::System,
     component::StaticInjection,
     service::Service,
     time_series_data::TimeSeriesData
 )
-
Adds service bids time-series data to the MarketBidCost.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • service::Service,: Service for which the device is eligible to contribute
  • time_series_data::IS.TimeSeriesData: TimeSeriesData
source
PowerSystems.set_start_up! — Method
set_start_up!(
+
Adds service bids time-series data to the MarketBidCost.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • service::Service,: Service for which the device is eligible to contribute
  • time_series_data::IS.TimeSeriesData: TimeSeriesData
source
PowerSystems.set_start_up! — Method
set_start_up!(
     sys::System,
     component::StaticInjection,
     data::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesData}
 ) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}
-
Set the startup cost for a StaticInjection device with a MarketBidCost to either a single StartUpStages or a time series.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • time_series_data::Union{StartUpStages, IS.TimeSeriesData},: the data. If a time series, must be of eltype NTuple{3, Float64}.
source
PowerSystems.set_variable_cost! — Method
set_variable_cost!(
+
Set the startup cost for a StaticInjection device with a MarketBidCost to either a single StartUpStages or a time series.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • time_series_data::Union{StartUpStages, IS.TimeSeriesData},: the data. If a time series, must be of eltype NTuple{3, Float64}.
source
PowerSystems.set_variable_cost! — Method
set_variable_cost!(
     _::System,
     component::ReserveDemandCurve,
     data::CostCurve{PiecewiseIncrementalCurve}
 ) -> CostCurve{PiecewiseIncrementalCurve}
-
Adds fixed energy market bids to the ReserveDemandCurve.
Arguments
  • sys::System: PowerSystem System
  • component::ReserveDemandCurve: the curve
  • `timeseriesdata::CostCurve{PiecewiseIncrementalCurve}
source
PowerSystems.set_variable_cost! — Method
set_variable_cost!(
+
Adds fixed energy market bids to the ReserveDemandCurve.
Arguments
  • sys::System: PowerSystem System
  • component::ReserveDemandCurve: the curve
  • `timeseriesdata::CostCurve{PiecewiseIncrementalCurve}
source
PowerSystems.set_variable_cost! — Method
set_variable_cost!(
     sys::System,
     component::ReserveDemandCurve,
     data::Union{Nothing, TimeSeriesData}
 ) -> TimeSeriesKey
-
Adds energy market bids time-series to the ReserveDemandCurve.
Arguments
  • sys::System: PowerSystem System
  • component::ReserveDemandCurve: the curve
  • time_series_data::IS.TimeSeriesData: TimeSeriesData
source
PowerSystems.set_variable_cost! — Method
set_variable_cost!(
+
Adds energy market bids time-series to the ReserveDemandCurve.
Arguments
  • sys::System: PowerSystem System
  • component::ReserveDemandCurve: the curve
  • time_series_data::IS.TimeSeriesData: TimeSeriesData
source
PowerSystems.set_variable_cost! — Method
set_variable_cost!(
     sys::System,
     component::StaticInjection,
     data::Union{Nothing, TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}}
 ) -> Any
-
Set the variable cost bid for a StaticInjection device with a MarketBidCost.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • time_series_data::Union{Nothing, IS.TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}},: the data. If a time series, must be of eltype PiecewiseStepData.
source
TimeSeries
InfrastructureSystems.TimeSeriesData — Type
Abstract type for time series stored in the system. Components store references to these through TimeSeriesMetadata values so that data can reside on storage media instead of memory.
InfrastructureSystems.Deterministic — Type
mutable struct Deterministic <: AbstractDeterministic
+
Set the variable cost bid for a StaticInjection device with a MarketBidCost.
Arguments
  • sys::System: PowerSystem System
  • component::StaticInjection: Static injection device
  • time_series_data::Union{Nothing, IS.TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}},: the data. If a time series, must be of eltype PiecewiseStepData.
source
TimeSeries
InfrastructureSystems.TimeSeriesData — Type
Abstract type for time series stored in the system. Components store references to these through TimeSeriesMetadata values so that data can reside on storage media instead of memory.
InfrastructureSystems.Deterministic — Type
mutable struct Deterministic <: AbstractDeterministic
     name::String
     data::SortedDict
     resolution::Dates.Period
@@ -366,31 +366,31 @@
 System(base_power, buses, generators, loads; kwargs...)
 System(file; kwargs...)
 System(; buses, generators, loads, branches, storage, base_power, services, kwargs...)
-System(; kwargs...)
Arguments
  • base_power::Float64: the base power value for the system
  • buses::Vector{ACBus}: an array of buses
  • components...: Each element must be an iterable containing subtypes of Component.
Keyword arguments
  • ext::Dict: Contains user-defined parameters. Should only contain standard types.
  • runchecks::Bool: Run available checks on input fields and when add_component! is called. Throws InvalidValue if an error is found.
  • time_series_in_memory::Bool=false: Store time series data in memory instead of HDF5.
  • enable_compression::Bool=false: Enable compression of time series data in HDF5.
  • compression::CompressionSettings: Allows customization of HDF5 compression settings.
  • config_path::String: specify path to validation config file
source
PowerSystems.System — Method
System(
+System(; kwargs...)
Arguments
  • base_power::Float64: the base power value for the system
  • buses::Vector{ACBus}: an array of buses
  • components...: Each element must be an iterable containing subtypes of Component.
Keyword arguments
  • ext::Dict: Contains user-defined parameters. Should only contain standard types.
  • runchecks::Bool: Run available checks on input fields and when add_component! is called. Throws InvalidValue if an error is found.
  • time_series_in_memory::Bool=false: Store time series data in memory instead of HDF5.
  • enable_compression::Bool=false: Enable compression of time series data in HDF5.
  • compression::CompressionSettings: Allows customization of HDF5 compression settings.
  • config_path::String: specify path to validation config file
source
PowerSystems.System — Method
System(
     sys_file::AbstractString,
     dyr_file::AbstractString;
     kwargs...
 ) -> Any
 
Parse static and dynamic data directly from PSS/e text files. Automatically generates all the relationships between the available dynamic injection models and the static counterpart
Each dictionary indexed by id contains a vector with 5 of its components:
  • Machine
  • Shaft
  • AVR
  • TurbineGov
  • PSS
Files must be parsed from a .raw file (PTI data format) and a .dyr file.
Examples:
raw_file = "Example.raw"
 dyr_file = "Example.dyr"
-sys = System(raw_file, dyr_file)
source
PowerSystems.System — Method
System(
     file_path::AbstractString;
     assign_new_uuids,
     kwargs...
 ) -> Any
-
Constructs a System from a file path ending with .m, .RAW, or .json
If the file is JSON then assignnewuuids = true will generate new UUIDs for the system and all components.
source
PowerSystems.System — Method
System(
+
Constructs a System from a file path ending with .m, .RAW, or .json
If the file is JSON then assignnewuuids = true will generate new UUIDs for the system and all components.
source
PowerSystems.System — Method
System(
     data,
     base_power::Number;
     internal,
     kwargs...
 ) -> System
-
Construct a System from InfrastructureSystems.SystemData
source
PowerSystems.System — Method
System(
     base_power::Float64,
     buses::Vector{ACBus},
     components...;
     kwargs...
 ) -> System
-
System constructor when components are constructed externally.
source
PowerSystems.System — Method
System(
     ::Nothing;
     buses,
     generators,
@@ -401,8 +401,8 @@
     services,
     kwargs...
 ) -> System
-
Constructs a non-functional System for demo purposes.
source
PowerSystems.System — Method
System(base_power::Number; kwargs...) -> System
-
Construct an empty System. Useful for building a System while parsing raw data.
source
PowerSystems.System — Method
System(base_power::Number; kwargs...) -> System
+
Construct an empty System. Useful for building a System while parsing raw data.
source
PowerSystems.System — Method
System(
     data::PowerSystemTableData;
     time_series_resolution,
     time_series_in_memory,
@@ -410,24 +410,24 @@
     runchecks,
     kwargs...
 ) -> System
-
Construct a System from PowerSystemTableData data.
Arguments
  • time_series_resolution::Union{DateTime, Nothing}=nothing: only store time_series that match this resolution.
  • time_series_in_memory::Bool=false: Store time series data in memory instead of HDF5 file
  • time_series_directory=nothing: Store time series data in directory instead of tmpfs
  • runchecks::Bool=true: Validate struct fields.
Throws DataFormatError if time_series with multiple resolutions are detected.
  • A time_series has a different resolution than others.
  • A time_series has a different horizon than others.
source
PowerSystems.System — Method
System(pm_data::PowerModelsData; kwargs...) -> Any
+
Construct a System from PowerSystemTableData data.
Arguments
  • time_series_resolution::Union{DateTime, Nothing}=nothing: only store time_series that match this resolution.
  • time_series_in_memory::Bool=false: Store time series data in memory instead of HDF5 file
  • time_series_directory=nothing: Store time series data in directory instead of tmpfs
  • runchecks::Bool=true: Validate struct fields.
Throws DataFormatError if time_series with multiple resolutions are detected.
  • A time_series has a different resolution than others.
  • A time_series has a different horizon than others.
source
PowerSystems.System — Method
System(pm_data::PowerModelsData; kwargs...) -> Any
 
Constructs a System from PowerModelsData.
Arguments
  • pm_data::Union{PowerModelsData, Union{String, IO}}: PowerModels data object or supported
load flow case (*.m, *.raw)
Keyword arguments
  • ext::Dict: Contains user-defined parameters. Should only contain standard types.
  • runchecks::Bool: Run available checks on input fields and when add_component! is called. Throws InvalidValue if an error is found.
  • time_series_in_memory::Bool=false: Store time series data in memory instead of HDF5.
  • config_path::String: specify path to validation config file
  • pm_data_corrections::Bool=true : Run the PowerModels data corrections (aka :validate in PowerModels)
  • import_all:Bool=false : Import all fields from PTI files
Examples
sys = System(
     pm_data, config_path = "ACTIVSg25k_validation.json",
     bus_name_formatter = x->string(x["name"]*"-"*string(x["index"])),
     load_name_formatter = x->strip(join(x["source_id"], "_"))
-)
source
InfrastructureSystems.from_json — Method
from_json(
     io::Union{IO, String},
     ::Type{System};
     runchecks,
     assign_new_uuids,
     kwargs...
 ) -> System
-
If assignnewuuids = true, generate new UUIDs for the system and all components.
Warning: time series data is not restored by this method. If that is needed, use the normal process to construct the system from a serialized JSON file instead, such as with System("sys.json").
source
InfrastructureSystems.get_supplemental_attribute — Method
get_supplemental_attribute(
+
If assignnewuuids = true, generate new UUIDs for the system and all components.
Warning: time series data is not restored by this method. If that is needed, use the normal process to construct the system from a serialized JSON file instead, such as with System("sys.json").
source
InfrastructureSystems.get_supplemental_attributes — Method
get_supplemental_attributes(
     filter_func::Function,
     _::Type{T<:SupplementalAttribute},
     sys::System
@@ -438,7 +438,7 @@
 outages = get_supplemental_attributes(GeometricDistributionForcedOutage, sys) do outage
     get_mean_time_to_recovery(x) ==  >= 0.5
 end
-outages = collect(get_supplemental_attributes(GeometricDistributionForcedOutage, sys))
See also: iterate_supplemental_attributes
source
InfrastructureSystems.get_time_series_multiple — Function
get_time_series_multiple(sys::System; ...) -> Channel{Any}
 get_time_series_multiple(
     sys::System,
     filter_func;
@@ -449,20 +449,20 @@
     @show time_series
 end
 
-ts = collect(get_time_series_multiple(sys; type = SingleTimeSeries))
source
InfrastructureSystems.set_name! — Method
set_name!(
     component::Component,
     name::AbstractString
 ) -> AbstractString
-
Set the name of a component.
Throws an exception if the component is attached to a system.
source
InfrastructureSystems.to_json — Method
to_json(
     sys::System,
     filename::AbstractString;
     user_data,
@@ -470,13 +470,13 @@
     force,
     runchecks
 )
-
Serializes a system to a JSON file and saves time series to an HDF5 file.
Arguments
  • sys::System: system
  • filename::AbstractString: filename to write
Keyword arguments
  • user_data::Union{Nothing, Dict} = nothing: optional metadata to record
  • pretty::Bool = false: whether to pretty-print the JSON
  • force::Bool = false: whether to overwrite existing files
  • check::Bool = false: whether to run system validation checks
Refer to check_component for exceptions thrown if check = true.
source
PowerSystems.add_component! — Method
add_component!(
+
Serializes a system to a JSON file and saves time series to an HDF5 file.
Arguments
  • sys::System: system
  • filename::AbstractString: filename to write
Keyword arguments
  • user_data::Union{Nothing, Dict} = nothing: optional metadata to record
  • pretty::Bool = false: whether to pretty-print the JSON
  • force::Bool = false: whether to overwrite existing files
  • check::Bool = false: whether to run system validation checks
Refer to check_component for exceptions thrown if check = true.
source
PowerSystems.add_component! — Method
add_component!(
     sys::System,
     dyn_injector::DynamicInjection,
     static_injector::StaticInjection;
     kwargs...
 )
-
Add a dynamic injector to the system.
Throws ArgumentError if the name does not match the staticinjector name. Throws ArgumentError if the staticinjector is not attached to the system.
All rules for the generic add_component! method also apply.
source
PowerSystems.add_component! — Method
add_component!(
+
Add a dynamic injector to the system.
Throws ArgumentError if the name does not match the staticinjector name. Throws ArgumentError if the staticinjector is not attached to the system.
All rules for the generic add_component! method also apply.
source
PowerSystems.add_component! — Method
add_component!(
     sys::System,
     component::Component;
     skip_validation,
@@ -490,65 +490,65 @@
 # Add many at once.
 buses = [bus1, bus2, bus3]
 generators = [gen1, gen2, gen3]
-foreach(x -> add_component!(sys, x), Iterators.flatten((buses, generators)))
source
PowerSystems.add_components! — Method
add_components!(sys::System, components)
 
Add many components to the system at once.
Throws ArgumentError if the component's name is already stored for its concrete type. Throws ArgumentError if any Component-specific rule is violated. Throws InvalidValue if any of the component's field values are outside of defined valid range.
Examples
sys = System(100.0)
 
 buses = [bus1, bus2, bus3]
 generators = [gen1, gen2, gen3]
-foreach(x -> add_component!(sys, x), Iterators.flatten((buses, generators)))
source
PowerSystems.add_service! — Method
add_service!(device::Device, service::Service, sys::System)
-
Similar to add_service! but for Service and Device already stored in the system. Performs validation checks on the device and the system
Arguments
  • device::Device: Device
  • service::Service: Service
  • sys::System: system
source
PowerSystems.add_service! — Method
add_service!(device::Device, service::Service, sys::System)
+
Similar to add_service! but for Service and Device already stored in the system. Performs validation checks on the device and the system
Arguments
  • device::Device: Device
  • service::Service: Service
  • sys::System: system
source
PowerSystems.add_service! — Method
add_service!(
     sys::System,
     service::ConstantReserveGroup,
     contributing_services::Vector{<:Service};
     skip_validation,
     kwargs...
 )
-
Similar to add_component! but for ConstantReserveGroup.
Arguments
  • sys::System: system
  • service::ConstantReserveGroup: service to add
  • contributing_services: contributing services to the group
source
PowerSystems.add_service! — Method
add_service!(
+
Similar to add_component! but for ConstantReserveGroup.
Arguments
  • sys::System: system
  • service::ConstantReserveGroup: service to add
  • contributing_services: contributing services to the group
source
PowerSystems.add_service! — Method
add_service!(
     sys::System,
     service::ConstantReserveGroup;
     skip_validation,
     kwargs...
 )
-
Similar to add_component! but for ConstantReserveGroup.
Arguments
  • sys::System: system
  • service::ConstantReserveGroup: service to add
source
PowerSystems.add_service! — Method
add_service!(
     sys::System,
     service::Service,
     contributing_devices;
     kwargs...
 )
-
Similar to add_component! but for services.
Arguments
  • sys::System: system
  • service::Service: service to add
  • contributing_devices: Must be an iterable of type Device
source
PowerSystems.add_service! — Method
add_service!(
     sys::System,
     service::Service,
     contributing_device::Device;
     kwargs...
 )
-
Similar to add_component! but for services.
Arguments
  • sys::System: system
  • service::Service: service to add
  • contributing_device::Device: Valid Device
source
PowerSystems.add_supplemental_attribute! — Method
add_supplemental_attribute!(
     sys::System,
     component::Component,
     attribute::SupplementalAttribute
 )
-
Add a supplemental attribute to the component. The attribute may already be attached to a different component.
source
PowerSystems.add_time_series! — Method
add_time_series!(
+
Add a supplemental attribute to the component. The attribute may already be attached to a different component.
source
PowerSystems.add_time_series! — Method
add_time_series!(
     sys::System,
     metadata_file::AbstractString;
     resolution
 ) -> Vector{TimeSeriesKey}
-
Add time series data from a metadata file or metadata descriptors.
Arguments
  • sys::System: system
  • metadata_file::AbstractString: metadata file for timeseries that includes an array of IS.TimeSeriesFileMetadata instances or a vector.
  • resolution::DateTime.Period=nothing: skip time series that don't match this resolution.
source
PowerSystems.add_time_series! — Method
add_time_series!(
+
Add time series data from a metadata file or metadata descriptors.
Arguments
  • sys::System: system
  • metadata_file::AbstractString: metadata file for timeseries that includes an array of IS.TimeSeriesFileMetadata instances or a vector.
  • resolution::DateTime.Period=nothing: skip time series that don't match this resolution.
source
PowerSystems.add_time_series! — Method
add_time_series!(
     sys::System,
     components,
     time_series::TimeSeriesData;
     features...
 ) -> TimeSeriesKey
-
Add the same time series data to multiple components.
This is significantly more efficent than calling add_time_series! for each component individually with the same data because in this case, only one time series array is stored.
Throws ArgumentError if a component is not stored in the system.
source
PowerSystems.add_time_series! — Method
add_time_series!(
+
Add the same time series data to multiple components.
This is significantly more efficent than calling add_time_series! for each component individually with the same data because in this case, only one time series array is stored.
Throws ArgumentError if a component is not stored in the system.
source
PowerSystems.add_time_series! — Method
add_time_series!(
     sys::System,
     component::Component,
     time_series::TimeSeriesData;
     features...
 ) -> TimeSeriesKey
-
Add time series data to a component.
Throws ArgumentError if the component is not stored in the system.
source
PowerSystems.add_time_series! — Method
add_time_series!(
     sys::System,
     file_metadata::Vector{InfrastructureSystems.TimeSeriesFileMetadata};
     resolution
 ) -> Vector{TimeSeriesKey}
-
Add time series data from a metadata file or metadata descriptors.
Arguments
  • sys::System: system
  • timeseries_metadata::Vector{IS.TimeSeriesFileMetadata}: metadata for timeseries
  • resolution::DateTime.Period=nothing: skip time series that don't match this resolution.
source
PowerSystems.bulk_add_time_series! — Method
bulk_add_time_series!(
+
Add time series data from a metadata file or metadata descriptors.
Arguments
  • sys::System: system
  • timeseries_metadata::Vector{IS.TimeSeriesFileMetadata}: metadata for timeseries
  • resolution::DateTime.Period=nothing: skip time series that don't match this resolution.
source
PowerSystems.bulk_add_time_series! — Method
bulk_add_time_series!(
     sys::System,
     associations;
     batch_size
@@ -564,83 +564,83 @@
     )
     for gen in get_components(ThermalStandard, sys)
 )
-bulk_add_time_series!(sys, associations)
source
PowerSystems.check_component — Method
check_component(sys::System, component::Component)
-
Check the values of a component.
Throws InvalidValue if any of the component's field values are outside of defined valid range or if the custom validate method for the type fails its check.
source
PowerSystems.check_component — Method
check_component(sys::System, component::Component)
+
Check the values of a component.
Throws InvalidValue if any of the component's field values are outside of defined valid range or if the custom validate method for the type fails its check.
source
PowerSystems.check_time_series_consistency — Method
check_time_series_consistency(
     sys::System,
     _::Type{T<:TimeSeriesData}
 ) -> Union{Nothing, Tuple{Any, Any}}
-
Checks time series in the system for inconsistencies.
For SingleTimeSeries, returns a Tuple of initial_timestamp and length.
This is a no-op for subtypes of Forecast because those are already guaranteed to be consistent.
Throws InfrastructureSystems.InvalidValue if any time series is inconsistent.
source
PowerSystems.convert_component! — Method
convert_component!(
+
Checks time series in the system for inconsistencies.
For SingleTimeSeries, returns a Tuple of initial_timestamp and length.
This is a no-op for subtypes of Forecast because those are already guaranteed to be consistent.
Throws InfrastructureSystems.InvalidValue if any time series is inconsistent.
source
PowerSystems.convert_component! — Method
convert_component!(
     sys::System,
     line::Line,
     linetype::Type{MonitoredLine};
     kwargs...
 )
-
Converts a Line component to a MonitoredLine component and replaces the original in the system
source
PowerSystems.convert_component! — Method
convert_component!(
     sys::System,
     line::MonitoredLine,
     linetype::Type{Line};
     kwargs...
 )
-
Converts a MonitoredLine component to a Line component and replaces the original in the system.
source
PowerSystems.convert_component! — Method
convert_component!(
     sys::System,
     old_load::PowerLoad,
     new_type::Type{StandardLoad};
     kwargs...
 )
-
Converts a PowerLoad component to a StandardLoad component and replaces the original in the system. Does not set any fields in StandardLoad that lack a PowerLoad equivalent.
source
PowerSystems.filter_components_by_subsystem! — Method
filter_components_by_subsystem!(
+
Converts a PowerLoad component to a StandardLoad component and replaces the original in the system. Does not set any fields in StandardLoad that lack a PowerLoad equivalent.
source
PowerSystems.from_subsystem — Method
from_subsystem(
     sys::System,
     subsystem::AbstractString;
     runchecks
 ) -> System
-
Construct a System from a subsystem of an existing system.
source
PowerSystems.get_bus — Method
get_bus(
     sys::System,
     name::AbstractString
 ) -> Union{Nothing, InfrastructureSystems.InfrastructureSystemsComponent}
-
Return bus with name.
source
PowerSystems.get_buses — Method
get_buses(
     sys::System,
     aggregator::AggregationTopology
 ) -> Vector{ACBus}
-
Return a vector of buses contained within the AggregationTopology.
source
PowerSystems.get_buses — Method
get_buses(
     sys::System,
     bus_numbers::Set{Int64}
 ) -> Vector{ACBus}
-
Return all buses values with bus_numbers.
source
PowerSystems.get_component — Method
get_component(
     sys::System,
     uuid::Base.UUID
 ) -> InfrastructureSystems.InfrastructureSystemsComponent
-
Get the component by UUID.
source
PowerSystems.get_component — Method
get_component(
     _::Type{T<:Component},
     sys::System,
     name::AbstractString
 ) -> Union{Nothing, InfrastructureSystems.InfrastructureSystemsComponent}
-
Get the component of type T with name. Returns nothing if no component matches. If T is an abstract type then the names of components across all subtypes of T must be unique.
See get_components_by_name for abstract types with non-unique names across subtypes.
Throws ArgumentError if T is not a concrete type and there is more than one component with     requested name
source
PowerSystems.get_components — Method
get_components(
+
Get the component of type T with name. Returns nothing if no component matches. If T is an abstract type then the names of components across all subtypes of T must be unique.
See get_components_by_name for abstract types with non-unique names across subtypes.
Throws ArgumentError if T is not a concrete type and there is more than one component with     requested name
source
PowerSystems.get_components — Method
get_components(
     sys::System,
     attribute::SupplementalAttribute
 ) -> Any
-
Return a vector of components that are attached to the supplemental attribute.
source
PowerSystems.get_components_by_name — Method
get_components_by_name(
     _::Type{T<:Component},
     sys::System,
     name::AbstractString
 ) -> Vector{T} where T<:InfrastructureSystems.InfrastructureSystemsComponent
-
Get the components of abstract type T with name. Note that PowerSystems enforces unique names on each concrete type but not across concrete types.
See get_component if the concrete type is known.
Throws ArgumentError if T is not an abstract type.
source
PowerSystems.get_components_in_aggregation_topology — Method
get_components_in_aggregation_topology(
+
Get the components of abstract type T with name. Note that PowerSystems enforces unique names on each concrete type but not across concrete types.
See get_component if the concrete type is known.
Throws ArgumentError if T is not an abstract type.
source
PowerSystems.get_components_in_aggregation_topology — Method
get_components_in_aggregation_topology(
     _::Type{T<:StaticInjection},
     sys::System,
     aggregator::AggregationTopology
 ) -> Vector{T} where T<:StaticInjection
-
Return a vector of components with buses in the AggregationTopology.
source
PowerSystems.get_ext — Method
get_ext(sys::System) -> Union{Nothing, Dict{String, Any}}
-
Return a user-modifiable dictionary to store extra information.
source
PowerSystems.get_ext — Method
get_ext(sys::System) -> Union{Nothing, Dict{String, Any}}
+
Return a user-modifiable dictionary to store extra information.
source
PowerSystems.has_component — Method
has_component(
     sys::System,
     T::Type{<:Component},
     name::AbstractString
 ) -> Bool
-
Check to see if the component of type T with name exists.
source
PowerSystems.iterate_components — Method
iterate_components(
     sys::System
 ) -> Base.Iterators.Flatten{Base.Generator{Base.ValueIterator{Dict{DataType, Dict{String, <:InfrastructureSystems.InfrastructureSystemsComponent}}}, InfrastructureSystems.var"#112#113"}}
 
Iterates over all components.
Examples
for component in iterate_components(sys)
     @show component
-end
See also: get_components
source
PowerSystems.iterate_supplemental_attributes — Method
iterate_supplemental_attributes(
     sys::System
 ) -> Base.Iterators.Flatten{Base.Generator{Base.ValueIterator{Dict{DataType, Dict{Base.UUID, <:SupplementalAttribute}}}, InfrastructureSystems.var"#112#113"}}
 
Iterates over all supplemental_attributes.
Examples
for supplemental_attribute in iterate_supplemental_attributes(sys)
     @show supplemental_attribute
-end
See also: get_supplemental_attributes
source
PowerSystems.open_time_series_store! — Function
open_time_series_store!(
     func::Function,
     sys::System;
     ...
@@ -721,58 +721,58 @@
     for (component, ts) in zip(components, single_time_series)
         add_time_series!(sys, component, ts)
     end
-end
julia>
source
PowerSystems.remove_component! — Method
remove_component!(sys::System, component::Component)
-
Remove a component from the system by its value.
Throws ArgumentError if the component is not stored.
source
PowerSystems.remove_component! — Method
remove_component!(sys::System, component::Component)
+
Remove a component from the system by its value.
Throws ArgumentError if the component is not stored.
source
PowerSystems.remove_component! — Method
remove_component!(
     _::Type{T<:Component},
     sys::System,
     name::AbstractString
 )
-
Remove a component from the system by its name.
Throws ArgumentError if the component is not stored.
source
PowerSystems.remove_supplemental_attribute! — Method
remove_supplemental_attribute!(
     sys::System,
     component::Component,
     attribute::SupplementalAttribute
 )
-
Remove the supplemental attribute from the component. The attribute will be removed from the system if it is not attached to any other component.
source
PowerSystems.remove_time_series! — Method
remove_time_series!(
     sys::System,
     _::Type{T<:TimeSeriesData},
     component::Component,
     name::String
 )
-
Remove the time series data for a component and time series type.
source
PowerSystems.set_runchecks! — Method
set_runchecks!(sys::System, value::Bool)
-
Enable or disable system checks. Applies to component addition as well as overall system consistency.
source
PowerSystems.set_units_base_system! — Method
set_units_base_system!(system::System, settings::String)
-
Sets the units base for the getter functions on the devices. It modifies the behavior of all getter functions
source
PowerSystems.set_runchecks! — Method
set_runchecks!(sys::System, value::Bool)
+
Enable or disable system checks. Applies to component addition as well as overall system consistency.
source
PowerSystems.set_units_base_system! — Method
set_units_base_system!(system::System, settings::String)
+
Sets the units base for the getter functions on the devices. It modifies the behavior of all getter functions
source
PowerSystems.transform_single_time_series! — Method
transform_single_time_series!(
     sys::System,
     horizon::Dates.Period,
     interval::Dates.Period
 )
-
Transform all instances of SingleTimeSeries to DeterministicSingleTimeSeries. If all SingleTimeSeries instances cannot be transformed then none will be.
Any existing DeterministicSingleTimeSeries forecasts will be deleted even if the inputs are invalid.
source
PowerSystems.validate_component_with_system — Method
validate_component_with_system(
+
Transform all instances of SingleTimeSeries to DeterministicSingleTimeSeries. If all SingleTimeSeries instances cannot be transformed then none will be.
Any existing DeterministicSingleTimeSeries forecasts will be deleted even if the inputs are invalid.
source
Additional Component Methods
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(d::RenewableDispatch) -> Any
-
Return the max reactive power for the Renewable Generation calculated as the rating * powerfactor if reactivepower_limits is nothing
source
Additional Component Methods
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(d::RenewableDispatch) -> Any
+
Return the max reactive power for the Renewable Generation calculated as the rating * powerfactor if reactivepower_limits is nothing
source
InfrastructureSystems.get_time_series — Function
get_time_series(
     owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},
     key::TimeSeriesKey
 ) -> Any
@@ -904,19 +904,19 @@
     generator_mapping_file,
     timeseries_metadata_file
 ) -> PowerSystemTableData
-
Reads in all the data stored in csv files The general format for data is     folder:         gen.csv         branch.csv         bus.csv         ..         load.csv
Arguments
  • directory::AbstractString: directory containing CSV files
  • base_power::Float64: base power for System
  • user_descriptor_file::AbstractString: customized input descriptor file
  • descriptor_file=POWER_SYSTEM_DESCRIPTOR_FILE: PowerSystems descriptor file
  • generator_mapping_file=GENERATOR_MAPPING_FILE: generator mapping configuration file
source
PowerSystems.PowerModelsData — Method
PowerModelsData(
+
Reads in all the data stored in csv files The general format for data is     folder:         gen.csv         branch.csv         bus.csv         ..         load.csv
Arguments
  • directory::AbstractString: directory containing CSV files
  • base_power::Float64: base power for System
  • user_descriptor_file::AbstractString: customized input descriptor file
  • descriptor_file=POWER_SYSTEM_DESCRIPTOR_FILE: PowerSystems descriptor file
  • generator_mapping_file=GENERATOR_MAPPING_FILE: generator mapping configuration file
source
PowerSystems.PowerModelsData — Method
PowerModelsData(
     file::Union{IO, String};
     kwargs...
 ) -> PowerModelsData
-
Constructs PowerModelsData from a raw file. Currently Supports MATPOWER and PSSE data files parsed by PowerModels.
source
PowerSystems.TamuSystem — Method
TamuSystem(tamu_folder::AbstractString; kwargs...) -> Any
+
Constructs PowerModelsData from a raw file. Currently Supports MATPOWER and PSSE data files parsed by PowerModels.
source
PowerSystems.TamuSystem — Method
TamuSystem(tamu_folder::AbstractString; kwargs...) -> Any
 
Creates a system from a PSS/e .RAW (v33) load flow case, and an associated .csv with MW load time series data. The format is established by the Texas A&M University Test Case Archive
The general format for data is folder:    [casename].raw    [casename]loadtimeseriesMW.csv
Arguments
  • directory::AbstractString: directory containing RAW and CSV files
Examples
sys = TamuSystem(
     "./ACTIVSg25k",
     config_path = "ACTIVSg25k_validation.json",
     bus_name_formatter = x->string(x["name"]*"-"*string(x["index"])),
     load_name_formatter = x->strip(join(x["source_id"], "_"))
-)
source
PowerSystems.add_dyn_injectors! — Method
add_dyn_injectors!(sys::System, dyr_file::AbstractString)
 
Add to a system already created the dynamic components. The system should already be parsed from a .raw file.
Examples:
dyr_file = "Example.dyr"
-add_dyn_injectors!(sys, dyr_file)
source
Logging
Logging
PowerSystems.configure_logging — Method
configure_logging(
 ;
     console_level,
     file_level,
@@ -924,4 +924,4 @@
 ) -> MultiLogger
 
Creates console and file loggers.
Note: Log messages may not be written to the file until flush() or close() is called on the returned logger.
Arguments
  • console_level = Logging.Error: level for console messages
  • file_level = Logging.Info: level for file messages
  • filename::Union{Nothing, AbstractString} = "power-systems.log": log file; pass nothing to disable file logging
Example
logger = configure_logging(console_level = Logging.Info)
 @info "log message"
-close(logger)
source

+close(logger)
source
diff --git a/dev/code_base_developer_guide/adding_new_types/index.html b/dev/code_base_developer_guide/adding_new_types/index.html index 0aada5d3b8..494c713d0a 100644 --- a/dev/code_base_developer_guide/adding_new_types/index.html +++ b/dev/code_base_developer_guide/adding_new_types/index.html @@ -15,4 +15,4 @@ sys2 = System("sys.json") serialized_device = get_component(NewType, sys, "component_name") -@test get_name(retrieved_device) == get_name(serialized_device) +@test get_name(retrieved_device) == get_name(serialized_device) diff --git a/dev/code_base_developer_guide/developer/index.html b/dev/code_base_developer_guide/developer/index.html index 3aeb117756..0689675fe2 100644 --- a/dev/code_base_developer_guide/developer/index.html +++ b/dev/code_base_developer_guide/developer/index.html @@ -1,2 +1,2 @@ -Developer Guide · PowerSystems.jl
Edit on GitHub
+Developer Guide · PowerSystems.jl
Edit on GitHub
diff --git a/dev/code_base_developer_guide/troubleshooting/index.html b/dev/code_base_developer_guide/troubleshooting/index.html index 1367be18a7..7baa44d684 100644 --- a/dev/code_base_developer_guide/troubleshooting/index.html +++ b/dev/code_base_developer_guide/troubleshooting/index.html @@ -1,2 +1,2 @@ -Troubleshooting · PowerSystems.jl
Edit on GitHub

Troubleshooting code development

Issues with Serialization/De-Serialization

If this doesn't work then you likely need to implement custom InfrastructureSystems.serialize and InfrastructureSystems.deserialize methods for your type. Here are some examples of potential problems and solutions:

Problem: Your struct contains a field defined as an abstract type. The 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.

Solution: Use the fact that the concrete type is encoded into the serialized type of the struct and extract it in a customized deserialze method.

Example: deserialize method for OuterControl in src/models/OuterControl.jl.

+Troubleshooting · PowerSystems.jl
Edit on GitHub

Troubleshooting code development

Issues with Serialization/De-Serialization

If this doesn't work then you likely need to implement custom InfrastructureSystems.serialize and InfrastructureSystems.deserialize methods for your type. Here are some examples of potential problems and solutions:

Problem: Your struct contains a field defined as an abstract type. The 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.

Solution: Use the fact that the concrete type is encoded into the serialized type of the struct and extract it in a customized deserialze method.

Example: deserialize method for OuterControl in src/models/OuterControl.jl.

diff --git a/dev/index.html b/dev/index.html index b1c2af56e4..7faddb965c 100644 --- a/dev/index.html +++ b/dev/index.html @@ -9,4 +9,4 @@ doi = {https://doi.org/10.1016/j.softx.2021.100747}, url = {https://www.sciencedirect.com/science/article/pii/S2352711021000765}, author = {José Daniel Lara and Clayton Barrows and Daniel Thom and Dheepak Krishnamurthy and Duncan Callaway}, -keywords = {Power Systems, Julia, Energy},

PowerSystems has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory (NREL).

+keywords = {Power Systems, Julia, Energy},

PowerSystems has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory (NREL).

diff --git a/dev/model_developer_guide/adding_additional_fields/index.html b/dev/model_developer_guide/adding_additional_fields/index.html index ec671d489b..19327876d0 100644 --- a/dev/model_developer_guide/adding_additional_fields/index.html +++ b/dev/model_developer_guide/adding_additional_fields/index.html @@ -81,4 +81,4 @@ base_value: 100.0 unit_system: UnitSystem.SYSTEM_BASE = 0 has_supplemental_attributes: false - has_time_series: false
julia> my_data = get_ext(gen_alta)["my_data"]1.0 + has_time_series: false
julia> my_data = get_ext(gen_alta)["my_data"]1.0 diff --git a/dev/model_developer_guide/adding_custom_types/index.html b/dev/model_developer_guide/adding_custom_types/index.html index 16199808d1..3e41d76dc8 100644 --- a/dev/model_developer_guide/adding_custom_types/index.html +++ b/dev/model_developer_guide/adding_custom_types/index.html @@ -20,4 +20,4 @@ PSY.get_name(val::MyDevice) = val.name -end

Auto-Generating Custom Structs

It is possible to use an advanced future to auto-generate structs in Julia source code files. It is not mandatory to use these tools, but it can be useful if you need to generate multiple custom structs for your model. Please refer to the docstrings for the functions generate_struct and generate_structs. Full details are in the InfrastructureSystems documentation at https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/devguide/autogeneration/

+end

Auto-Generating Custom Structs

It is possible to use an advanced future to auto-generate structs in Julia source code files. It is not mandatory to use these tools, but it can be useful if you need to generate multiple custom structs for your model. Please refer to the docstrings for the functions generate_struct and generate_structs. Full details are in the InfrastructureSystems documentation at https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/devguide/autogeneration/

diff --git a/dev/model_developer_guide/extending_parsing/index.html b/dev/model_developer_guide/extending_parsing/index.html index ac5ea92f74..ce8eb84a76 100644 --- a/dev/model_developer_guide/extending_parsing/index.html +++ b/dev/model_developer_guide/extending_parsing/index.html @@ -3,4 +3,4 @@ for bus in iterate_rows(data, BUS::InputCategory) @show bus.name, bus.max_active_power, bus.max_reactive_power end -end

iterate_rows returns a NamedTuple where each name defined in src/descriptors/power_system_inputs.json is a field.

Extending PSS/e Dynamic Parsing Capabilities

UNDER CONSTRUCTION

+end

iterate_rows returns a NamedTuple where each name defined in src/descriptors/power_system_inputs.json is a field.

Extending PSS/e Dynamic Parsing Capabilities

UNDER CONSTRUCTION

diff --git a/dev/model_library/cost_curves/index.html b/dev/model_library/cost_curves/index.html index cdb46bf4d0..f6443a49be 100644 --- a/dev/model_library/cost_curves/index.html +++ b/dev/model_library/cost_curves/index.html @@ -1,18 +1,18 @@ Variable Cost Curves · PowerSystems.jl
Edit on GitHub

Variable Cost Curves

PowerSystems.CostCurve — Type
struct CostCurve{T<:ValueCurve} <: ProductionVariableCostCurve{T<:ValueCurve}

  • value_curve::ValueCurve: The underlying ValueCurve representation of this ProductionVariableCostCurve

  • power_units::UnitSystem: (default: natural units (MW)) The units for the x-axis of the curve

  • vom_cost::LinearCurve: (default of 0) Additional proportional Variable Operation and Maintenance Cost in /(power_unit h), represented as a LinearCurve

CostCurve(value_curve, power_units, vom_cost)
-CostCurve(; value_curve, power_units, vom_cost)

Direct representation of the variable operation cost of a power plant in currency. Composed of a ValueCurve that may represent input-output, incremental, or average rate data. The default units for the x-axis are MW and can be specified with power_units.

source
PowerSystems.FuelCurve — Type
struct FuelCurve{T<:ValueCurve} <: ProductionVariableCostCurve{T<:ValueCurve}

  • value_curve::ValueCurve: The underlying ValueCurve representation of this ProductionVariableCostCurve

  • power_units::UnitSystem: (default: natural units (MW)) The units for the x-axis of the curve

  • fuel_cost::Union{Float64, TimeSeriesKey}: Either a fixed value for fuel cost or the key to a fuel cost time series

  • vom_cost::LinearCurve: (default of 0) Additional proportional Variable Operation and Maintenance Cost in /(power_unit h) represented as a LinearCurve

FuelCurve(value_curve, power_units, fuel_cost, vom_cost)
+CostCurve(; value_curve, power_units, vom_cost)

Direct representation of the variable operation cost of a power plant in currency. Composed of a ValueCurve that may represent input-output, incremental, or average rate data. The default units for the x-axis are MW and can be specified with power_units.

source
PowerSystems.FuelCurve — Type
struct FuelCurve{T<:ValueCurve} <: ProductionVariableCostCurve{T<:ValueCurve}

  • value_curve::ValueCurve: The underlying ValueCurve representation of this ProductionVariableCostCurve

  • power_units::UnitSystem: (default: natural units (MW)) The units for the x-axis of the curve

  • fuel_cost::Union{Float64, TimeSeriesKey}: Either a fixed value for fuel cost or the key to a fuel cost time series

  • vom_cost::LinearCurve: (default of 0) Additional proportional Variable Operation and Maintenance Cost in /(power_unit h) represented as a LinearCurve

FuelCurve(value_curve, power_units, fuel_cost, vom_cost)
 FuelCurve(value_curve, fuel_cost)
 FuelCurve(value_curve, fuel_cost, vom_cost)
 FuelCurve(value_curve, power_units, fuel_cost)
-FuelCurve(; value_curve, power_units, fuel_cost, vom_cost)

Representation of the variable operation cost of a power plant in terms of fuel (MBTU, liters, m^3, etc.), coupled with a conversion factor between fuel and currency. Composed of a ValueCurve that may represent input-output, incremental, or average rate data. The default units for the x-axis are MW and can be specified with power_units.

source
PowerSystems.get_fuel_cost — Method
get_fuel_cost(
+FuelCurve(; value_curve, power_units, fuel_cost, vom_cost)

Representation of the variable operation cost of a power plant in terms of fuel (MBTU, liters, m^3, etc.), coupled with a conversion factor between fuel and currency. Composed of a ValueCurve that may represent input-output, incremental, or average rate data. The default units for the x-axis are MW and can be specified with power_units.

source
PowerSystems.get_fuel_cost — Method
get_fuel_cost(
     cost::FuelCurve
 ) -> Union{Float64, TimeSeriesKey}
-

Get the fuel cost or the name of the fuel cost time series

source
PowerSystems.get_function_data — Method
get_function_data(cost::ProductionVariableCostCurve) -> Any
-

Get the FunctionData representation of this ProductionVariableCostCurve's ValueCurve

source
PowerSystems.get_function_data — Method
get_function_data(cost::ProductionVariableCostCurve) -> Any
+

Get the FunctionData representation of this ProductionVariableCostCurve's ValueCurve

source
PowerSystems.get_initial_input — Method
get_initial_input(
     cost::ProductionVariableCostCurve
 ) -> Union{Nothing, Float64}
-

Get the initial_input field of this ProductionVariableCostCurve's ValueCurve (not defined for input-output data)

source
PowerSystems.get_value_curve — Method
get_value_curve(cost::ProductionVariableCostCurve) -> Any
-

Get the underlying ValueCurve representation of this ProductionVariableCostCurve

source
PowerSystems.get_vom_cost — Method
get_vom_cost(cost::ProductionVariableCostCurve) -> Any
-

Get the variable operation and maintenance cost in currency/(power_units h)

source
+

Get the initial_input field of this ProductionVariableCostCurve's ValueCurve (not defined for input-output data)

source
PowerSystems.get_power_units — Method
get_power_units(cost::ProductionVariableCostCurve) -> Any
+

Get the units for the x-axis of the curve

source
PowerSystems.get_value_curve — Method
get_value_curve(cost::ProductionVariableCostCurve) -> Any
+

Get the underlying ValueCurve representation of this ProductionVariableCostCurve

source
PowerSystems.get_vom_cost — Method
get_vom_cost(cost::ProductionVariableCostCurve) -> Any
+

Get the variable operation and maintenance cost in currency/(power_units h)

source
diff --git a/dev/model_library/dynamic_branch/index.html b/dev/model_library/dynamic_branch/index.html index 6646c319d4..4f716d5543 100644 --- a/dev/model_library/dynamic_branch/index.html +++ b/dev/model_library/dynamic_branch/index.html @@ -1,50 +1,50 @@ -Dynamic Lines · PowerSystems.jl
Edit on GitHub

Dynamic Branch

PowerSystems.DynamicBranch — Type

Extends the branch type to add the information required for dynamic modeling of branches. Includes the fields for the states and the number of states

Arguments

  • branch::ACBranch
source
PowerSystems.get_angle_limits — Method
get_angle_limits(
+Dynamic Lines · PowerSystems.jl
Edit on GitHub
Dynamic Branch
PowerSystems.DynamicBranch — Type
Extends the branch type to add the information required for dynamic modeling of branches. Includes the fields for the states and the number of states
Arguments
  • branch::ACBranch
source
PowerSystems.get_b — Method
get_b(
     value::DynamicBranch
 ) -> @NamedTuple{from::Float64, to::Float64}
-
Get DynamicBranch b.
source
PowerSystems.set_angle_limits! — Method
set_angle_limits!(
     value::DynamicBranch,
     val::@NamedTuple{min::Float64, max::Float64}
 ) -> @NamedTuple{min::Float64, max::Float64}
-
Set DynamicBranch angle_limits.
source

+

Set states

source
diff --git a/dev/model_library/dynamic_generator/index.html b/dev/model_library/dynamic_generator/index.html index 20f0e55b98..9243b53c78 100644 --- a/dev/model_library/dynamic_generator/index.html +++ b/dev/model_library/dynamic_generator/index.html @@ -18,4 +18,4 @@ states::Vector{Symbol} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A dynamic generator is composed by 5 components, namely a Machine, a Shaft, an Automatic Voltage Regulator (AVR), a Prime Mover (o Turbine Governor) and Power System Stabilizer (PSS). It requires a StaticInjection device that is attached to it.

Arguments

source +end

A dynamic generator is composed by 5 components, namely a Machine, a Shaft, an Automatic Voltage Regulator (AVR), a Prime Mover (o Turbine Governor) and Power System Stabilizer (PSS). It requires a StaticInjection device that is attached to it.

Arguments

source diff --git a/dev/model_library/dynamic_inverter/index.html b/dev/model_library/dynamic_inverter/index.html index a3f5b27a6f..8f6b5aceaf 100644 --- a/dev/model_library/dynamic_inverter/index.html +++ b/dev/model_library/dynamic_inverter/index.html @@ -21,4 +21,4 @@ states::Vector{Symbol} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A dynamic inverter is composed by 6 components, namely a Converter, an Outer Control, an Inner Control, a DC Source, a Frequency Estimator and a Filter. It requires a StaticInjection device that is attached to it.

Arguments

source +end

A dynamic inverter is composed by 6 components, namely a Converter, an Outer Control, an Inner Control, a DC Source, a Frequency Estimator and a Filter. It requires a StaticInjection device that is attached to it.

Arguments

source diff --git a/dev/model_library/generated_ACBus/index.html b/dev/model_library/generated_ACBus/index.html index d9200e6402..a4307d5a40 100644 --- a/dev/model_library/generated_ACBus/index.html +++ b/dev/model_library/generated_ACBus/index.html @@ -11,25 +11,25 @@ load_zone::Union{Nothing, LoadZone} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

An AC bus

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::ACBus) -> String
-

Get ACBus name.

source
PowerSystems.get_angle — Method
get_angle(value::ACBus) -> Union{Nothing, Float64}
-

Get ACBus angle.

source
PowerSystems.get_area — Method
get_area(value::ACBus) -> Union{Nothing, Area}
-

Get ACBus area.

source
PowerSystems.get_base_voltage — Method
get_base_voltage(value::ACBus) -> Union{Nothing, Float64}
-

Get ACBus base_voltage.

source
PowerSystems.get_bustype — Method
get_bustype(value::ACBus) -> Union{Nothing, ACBusTypes}
-

Get ACBus bustype.

source
PowerSystems.get_ext — Method
get_ext(value::ACBus) -> Dict{String, Any}
-

Get ACBus ext.

source
PowerSystems.get_load_zone — Method
get_load_zone(value::ACBus) -> Union{Nothing, LoadZone}
-

Get ACBus load_zone.

source
PowerSystems.get_magnitude — Method
get_magnitude(value::ACBus) -> Union{Nothing, Float64}
-

Get ACBus magnitude.

source
PowerSystems.get_number — Method
get_number(value::ACBus) -> Int64
-

Get ACBus number.

source
PowerSystems.get_voltage_limits — Method
get_voltage_limits(
+end

An AC bus

Arguments

  • number::Int: A unique bus identification number (positive integer)
  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • bustype::Union{Nothing, ACBusTypes}: Used to describe the connectivity and behavior of this bus. Options are listed here.
  • angle::Union{Nothing, Float64}: angle of the bus in radians, validation range: (-1.571, 1.571)
  • magnitude::Union{Nothing, Float64}: voltage as a multiple of base_voltage, validation range: voltage_limits
  • voltage_limits::Union{Nothing, MinMax}: limits on the voltage variation as multiples of base_voltage
  • base_voltage::Union{Nothing, Float64}: the base voltage in kV, validation range: (0, nothing)
  • area::Union{Nothing, Area}: (default: nothing) the area containing the bus
  • load_zone::Union{Nothing, LoadZone}: (default: nothing) the load zone containing the bus
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ACBus) -> String
+

Get ACBus name.

source
PowerSystems.get_angle — Method
get_angle(value::ACBus) -> Union{Nothing, Float64}
+

Get ACBus angle.

source
PowerSystems.get_area — Method
get_area(value::ACBus) -> Union{Nothing, Area}
+

Get ACBus area.

source
PowerSystems.get_base_voltage — Method
get_base_voltage(value::ACBus) -> Union{Nothing, Float64}
+

Get ACBus base_voltage.

source
PowerSystems.get_bustype — Method
get_bustype(value::ACBus) -> Union{Nothing, ACBusTypes}
+

Get ACBus bustype.

source
PowerSystems.get_ext — Method
get_ext(value::ACBus) -> Dict{String, Any}
+

Get ACBus ext.

source
PowerSystems.get_load_zone — Method
get_load_zone(value::ACBus) -> Union{Nothing, LoadZone}
+

Get ACBus load_zone.

source
PowerSystems.get_magnitude — Method
get_magnitude(value::ACBus) -> Union{Nothing, Float64}
+

Get ACBus magnitude.

source
PowerSystems.get_number — Method
get_number(value::ACBus) -> Int64
+

Get ACBus number.

source
PowerSystems.get_voltage_limits — Method
get_voltage_limits(
     value::ACBus
 ) -> Union{Nothing, @NamedTuple{min::Float64, max::Float64}}
-

Get ACBus voltage_limits.

source
PowerSystems.set_angle! — Method
set_angle!(value::ACBus, val) -> Any
-

Set ACBus angle.

source
PowerSystems.set_area! — Method
set_area!(value::ACBus, val) -> Area
-

Set ACBus area.

source
PowerSystems.set_base_voltage! — Method
set_base_voltage!(value::ACBus, val) -> Any
-

Set ACBus base_voltage.

source
PowerSystems.set_bustype! — Method
set_bustype!(value::ACBus, val) -> Any
-

Set ACBus bustype.

source
PowerSystems.set_ext! — Method
set_ext!(value::ACBus, val) -> Any
-

Set ACBus ext.

source
PowerSystems.set_load_zone! — Method
set_load_zone!(value::ACBus, val) -> LoadZone
-

Set ACBus load_zone.

source
PowerSystems.set_magnitude! — Method
set_magnitude!(value::ACBus, val) -> Any
-

Set ACBus magnitude.

source
PowerSystems.set_number! — Method
set_number!(value::ACBus, val) -> Any
-

Set ACBus number.

source
PowerSystems.set_voltage_limits! — Method
set_voltage_limits!(value::ACBus, val) -> Any
-

Set ACBus voltage_limits.

source
+

Get ACBus voltage_limits.

source
PowerSystems.set_angle! — Method
set_angle!(value::ACBus, val) -> Any
+

Set ACBus angle.

source
PowerSystems.set_area! — Method
set_area!(value::ACBus, val) -> Area
+

Set ACBus area.

source
PowerSystems.set_base_voltage! — Method
set_base_voltage!(value::ACBus, val) -> Any
+

Set ACBus base_voltage.

source
PowerSystems.set_bustype! — Method
set_bustype!(value::ACBus, val) -> Any
+

Set ACBus bustype.

source
PowerSystems.set_ext! — Method
set_ext!(value::ACBus, val) -> Any
+

Set ACBus ext.

source
PowerSystems.set_load_zone! — Method
set_load_zone!(value::ACBus, val) -> LoadZone
+

Set ACBus load_zone.

source
PowerSystems.set_magnitude! — Method
set_magnitude!(value::ACBus, val) -> Any
+

Set ACBus magnitude.

source
PowerSystems.set_number! — Method
set_number!(value::ACBus, val) -> Any
+

Set ACBus number.

source
PowerSystems.set_voltage_limits! — Method
set_voltage_limits!(value::ACBus, val) -> Any
+

Set ACBus voltage_limits.

source
diff --git a/dev/model_library/generated_AGC/index.html b/dev/model_library/generated_AGC/index.html index 013faa5b12..ec2a6129a4 100644 --- a/dev/model_library/generated_AGC/index.html +++ b/dev/model_library/generated_AGC/index.html @@ -11,23 +11,23 @@ initial_ace::Float64 ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

Automatic generation control (AGC) for the system or a certain Area within the system.

This model uses a proportional–integral–derivative (PID) control to simulate a "smooth" response of the AGC to the area control error (ACE). Refer to "AGC Simulation Model for Large Renewable Energy Penetration Studies."

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::AGC) -> String
-

Get AGC name.

source
PowerSystems.get_K_d — Method
get_K_d(value::AGC) -> Float64
-

Get AGC K_d.

source
PowerSystems.get_K_i — Method
get_K_i(value::AGC) -> Float64
-

Get AGC K_i.

source
PowerSystems.get_K_p — Method
get_K_p(value::AGC) -> Float64
-

Get AGC K_p.

source
PowerSystems.get_area — Method
get_area(value::AGC) -> Union{Nothing, Area}
-

Get AGC area.

source
PowerSystems.get_available — Method
get_available(value::AGC) -> Bool
-

Get AGC available.

source
PowerSystems.get_bias — Method
get_bias(value::AGC) -> Float64
-

Get AGC bias.

source
PowerSystems.get_delta_t — Method
get_delta_t(value::AGC) -> Float64
-

Get AGC delta_t.

source
PowerSystems.get_ext — Method
get_ext(value::AGC) -> Dict{String, Any}
-

Get AGC ext.

source
PowerSystems.get_initial_ace — Method
get_initial_ace(value::AGC) -> Float64
-

Get AGC initial_ace.

source
PowerSystems.set_K_d! — Method
set_K_d!(value::AGC, val) -> Any
-

Set AGC K_d.

source
PowerSystems.set_K_i! — Method
set_K_i!(value::AGC, val) -> Any
-

Set AGC K_i.

source
PowerSystems.set_K_p! — Method
set_K_p!(value::AGC, val) -> Any
-

Set AGC K_p.

source
PowerSystems.set_area! — Method
set_area!(value::AGC, val) -> Any
-

Set AGC area.

source
PowerSystems.set_available! — Method
set_available!(value::AGC, val) -> Any
-

Set AGC available.

source
PowerSystems.set_bias! — Method
set_bias!(value::AGC, val) -> Any
-

Set AGC bias.

source
PowerSystems.set_delta_t! — Method
set_delta_t!(value::AGC, val) -> Any
-

Set AGC delta_t.

source
PowerSystems.set_ext! — Method
set_ext!(value::AGC, val) -> Any
-

Set AGC ext.

source
PowerSystems.set_initial_ace! — Method
set_initial_ace!(value::AGC, val) -> Any
-

Set AGC initial_ace.

source
+end

Automatic generation control (AGC) for the system or a certain Area within the system.

This model uses a proportional–integral–derivative (PID) control to simulate a "smooth" response of the AGC to the area control error (ACE). Refer to "AGC Simulation Model for Large Renewable Energy Penetration Studies."

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::AGC) -> String
+

Get AGC name.

source
PowerSystems.get_K_d — Method
get_K_d(value::AGC) -> Float64
+

Get AGC K_d.

source
PowerSystems.get_K_i — Method
get_K_i(value::AGC) -> Float64
+

Get AGC K_i.

source
PowerSystems.get_K_p — Method
get_K_p(value::AGC) -> Float64
+

Get AGC K_p.

source
PowerSystems.get_area — Method
get_area(value::AGC) -> Union{Nothing, Area}
+

Get AGC area.

source
PowerSystems.get_available — Method
get_available(value::AGC) -> Bool
+

Get AGC available.

source
PowerSystems.get_bias — Method
get_bias(value::AGC) -> Float64
+

Get AGC bias.

source
PowerSystems.get_delta_t — Method
get_delta_t(value::AGC) -> Float64
+

Get AGC delta_t.

source
PowerSystems.get_ext — Method
get_ext(value::AGC) -> Dict{String, Any}
+

Get AGC ext.

source
PowerSystems.get_initial_ace — Method
get_initial_ace(value::AGC) -> Float64
+

Get AGC initial_ace.

source
PowerSystems.set_K_d! — Method
set_K_d!(value::AGC, val) -> Any
+

Set AGC K_d.

source
PowerSystems.set_K_i! — Method
set_K_i!(value::AGC, val) -> Any
+

Set AGC K_i.

source
PowerSystems.set_K_p! — Method
set_K_p!(value::AGC, val) -> Any
+

Set AGC K_p.

source
PowerSystems.set_area! — Method
set_area!(value::AGC, val) -> Any
+

Set AGC area.

source
PowerSystems.set_available! — Method
set_available!(value::AGC, val) -> Any
+

Set AGC available.

source
PowerSystems.set_bias! — Method
set_bias!(value::AGC, val) -> Any
+

Set AGC bias.

source
PowerSystems.set_delta_t! — Method
set_delta_t!(value::AGC, val) -> Any
+

Set AGC delta_t.

source
PowerSystems.set_ext! — Method
set_ext!(value::AGC, val) -> Any
+

Set AGC ext.

source
PowerSystems.set_initial_ace! — Method
set_initial_ace!(value::AGC, val) -> Any
+

Set AGC initial_ace.

source
diff --git a/dev/model_library/generated_AVR/index.html b/dev/model_library/generated_AVR/index.html index dc5926b3bc..f3fd38dd9b 100644 --- a/dev/model_library/generated_AVR/index.html +++ b/dev/model_library/generated_AVR/index.html @@ -7,17 +7,17 @@ n_states::Int states_types::Vector{StateTypes} internal::InfrastructureSystemsInternal -end

Parameters of a AVR that returns a fixed voltage to the rotor winding

Arguments

source
PowerSystems.get_V_ref — Method
get_V_ref(value::AVRFixed) -> Float64
-

Get AVRFixed V_ref.

source
PowerSystems.get_Vf — Method
get_Vf(value::AVRFixed) -> Float64
-

Get AVRFixed Vf.

source
PowerSystems.get_ext — Method
get_ext(value::AVRFixed) -> Dict{String, Any}
-

Get AVRFixed ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AVRFixed) -> Int64
-

Get AVRFixed n_states.

source
PowerSystems.get_states — Method
get_states(value::AVRFixed) -> Vector{Symbol}
-

Get AVRFixed states.

source
PowerSystems.get_states_types — Method
get_states_types(value::AVRFixed) -> Vector{StateTypes}
-

Get AVRFixed states_types.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::AVRFixed, val) -> Any
-

Set AVRFixed V_ref.

source
PowerSystems.set_Vf! — Method
set_Vf!(value::AVRFixed, val) -> Any
-

Set AVRFixed Vf.

source
PowerSystems.set_ext! — Method
set_ext!(value::AVRFixed, val) -> Any
-

Set AVRFixed ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::AVRFixed, val) -> Any
-

Set AVRFixed states_types.

source

AVRSimple

PowerSystems.AVRSimple — Type
mutable struct AVRSimple <: AVR
+end

Parameters of a AVR that returns a fixed voltage to the rotor winding

Arguments

  • Vf::Float64: Fixed voltage field applied to the rotor winding in pu (DEVICE_BASE), validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) Fixed AVR has no states
  • n_states::Int: (Do not modify.) Fixed AVR has no states
  • states_types::Vector{StateTypes}: (Do not modify.) Fixed AVR has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_V_ref — Method
get_V_ref(value::AVRFixed) -> Float64
+

Get AVRFixed V_ref.

source
PowerSystems.get_Vf — Method
get_Vf(value::AVRFixed) -> Float64
+

Get AVRFixed Vf.

source
PowerSystems.get_ext — Method
get_ext(value::AVRFixed) -> Dict{String, Any}
+

Get AVRFixed ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AVRFixed) -> Int64
+

Get AVRFixed n_states.

source
PowerSystems.get_states — Method
get_states(value::AVRFixed) -> Vector{Symbol}
+

Get AVRFixed states.

source
PowerSystems.get_states_types — Method
get_states_types(value::AVRFixed) -> Vector{StateTypes}
+

Get AVRFixed states_types.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::AVRFixed, val) -> Any
+

Set AVRFixed V_ref.

source
PowerSystems.set_Vf! — Method
set_Vf!(value::AVRFixed, val) -> Any
+

Set AVRFixed Vf.

source
PowerSystems.set_ext! — Method
set_ext!(value::AVRFixed, val) -> Any
+

Set AVRFixed ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::AVRFixed, val) -> Any
+

Set AVRFixed states_types.

source

AVRSimple

PowerSystems.AVRSimple — Type
mutable struct AVRSimple <: AVR
     Kv::Float64
     V_ref::Float64
     ext::Dict{String, Any}
@@ -25,17 +25,17 @@
     n_states::Int
     states_types::Vector{StateTypes}
     internal::InfrastructureSystemsInternal
-end

Parameters of a simple proportional AVR in the derivative of EMF i.e. an integrator controller on EMF

Arguments

  • Kv::Float64: Proportional Gain, validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vf: field voltage
  • n_states::Int: (Do not modify.) Fixed AVR has 1 state
  • states_types::Vector{StateTypes}: (Do not modify.) Simple AVR has 1 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Kv — Method
get_Kv(value::AVRSimple) -> Float64
-

Get AVRSimple Kv.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::AVRSimple) -> Float64
-

Get AVRSimple V_ref.

source
PowerSystems.get_ext — Method
get_ext(value::AVRSimple) -> Dict{String, Any}
-

Get AVRSimple ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AVRSimple) -> Int64
-

Get AVRSimple n_states.

source
PowerSystems.get_states — Method
get_states(value::AVRSimple) -> Vector{Symbol}
-

Get AVRSimple states.

source
PowerSystems.get_states_types — Method
get_states_types(value::AVRSimple) -> Vector{StateTypes}
-

Get AVRSimple states_types.

source
PowerSystems.set_Kv! — Method
set_Kv!(value::AVRSimple, val) -> Any
-

Set AVRSimple Kv.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::AVRSimple, val) -> Any
-

Set AVRSimple V_ref.

source
PowerSystems.set_ext! — Method
set_ext!(value::AVRSimple, val) -> Any
-

Set AVRSimple ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::AVRSimple, val) -> Any
-

Set AVRSimple states_types.

source

AVRTypeI

PowerSystems.AVRTypeI — Type
mutable struct AVRTypeI <: AVR
+end

Parameters of a simple proportional AVR in the derivative of EMF i.e. an integrator controller on EMF

Arguments

  • Kv::Float64: Proportional Gain, validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vf: field voltage
  • n_states::Int: (Do not modify.) Fixed AVR has 1 state
  • states_types::Vector{StateTypes}: (Do not modify.) Simple AVR has 1 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Kv — Method
get_Kv(value::AVRSimple) -> Float64
+

Get AVRSimple Kv.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::AVRSimple) -> Float64
+

Get AVRSimple V_ref.

source
PowerSystems.get_ext — Method
get_ext(value::AVRSimple) -> Dict{String, Any}
+

Get AVRSimple ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AVRSimple) -> Int64
+

Get AVRSimple n_states.

source
PowerSystems.get_states — Method
get_states(value::AVRSimple) -> Vector{Symbol}
+

Get AVRSimple states.

source
PowerSystems.get_states_types — Method
get_states_types(value::AVRSimple) -> Vector{StateTypes}
+

Get AVRSimple states_types.

source
PowerSystems.set_Kv! — Method
set_Kv!(value::AVRSimple, val) -> Any
+

Set AVRSimple Kv.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::AVRSimple, val) -> Any
+

Set AVRSimple V_ref.

source
PowerSystems.set_ext! — Method
set_ext!(value::AVRSimple, val) -> Any
+

Set AVRSimple ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::AVRSimple, val) -> Any
+

Set AVRSimple states_types.

source

AVRTypeI

PowerSystems.AVRTypeI — Type
mutable struct AVRTypeI <: AVR
     Ka::Float64
     Ke::Float64
     Kf::Float64
@@ -55,37 +55,37 @@
 end

Parameters of an Automatic Voltage Regulator Type I - Resembles IEEE Type DC1

Arguments

  • Ka::Float64: Amplifier Gain, validation range: (0, nothing)
  • Ke::Float64: Field circuit integral deviation, validation range: (0, nothing)
  • Kf::Float64: Stabilizer Gain in s * pu/pu, validation range: (0, nothing)
  • Ta::Float64: Amplifier Time Constant in s, validation range: (0, nothing)
  • Te::Float64: Field Circuit Time Constant in s, validation range: (0, nothing)
  • Tf::Float64: Stabilizer Time Constant in s, validation range: (0, nothing)
  • Tr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)
  • Va_lim::MinMax: Limits for pi controler (Va_min, Va_max)
  • Ae::Float64: 1st ceiling coefficient, validation range: (0, nothing)
  • Be::Float64: 2nd ceiling coefficient, validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vf: Voltage field,
 Vr1: Amplifier State,
 Vr2: Stabilizing Feedback State,
-Vm: Measured voltage
  • n_states::Int: (Do not modify.) The AVR Type I has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) AVR Type I has 4 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ae — Method
get_Ae(value::AVRTypeI) -> Float64
-

Get AVRTypeI Ae.

source
PowerSystems.get_Be — Method
get_Be(value::AVRTypeI) -> Float64
-

Get AVRTypeI Be.

source
PowerSystems.get_Ka — Method
get_Ka(value::AVRTypeI) -> Float64
-

Get AVRTypeI Ka.

source
PowerSystems.get_Ke — Method
get_Ke(value::AVRTypeI) -> Float64
-

Get AVRTypeI Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::AVRTypeI) -> Float64
-

Get AVRTypeI Kf.

source
PowerSystems.get_Ta — Method
get_Ta(value::AVRTypeI) -> Float64
-

Get AVRTypeI Ta.

source
PowerSystems.get_Te — Method
get_Te(value::AVRTypeI) -> Float64
-

Get AVRTypeI Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::AVRTypeI) -> Float64
-

Get AVRTypeI Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::AVRTypeI) -> Float64
-

Get AVRTypeI Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::AVRTypeI) -> Float64
-

Get AVRTypeI V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+Vm: Measured voltage
  • n_states::Int: (Do not modify.) The AVR Type I has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) AVR Type I has 4 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ae — Method
get_Ae(value::AVRTypeI) -> Float64
+

Get AVRTypeI Ae.

source
PowerSystems.get_Be — Method
get_Be(value::AVRTypeI) -> Float64
+

Get AVRTypeI Be.

source
PowerSystems.get_Ka — Method
get_Ka(value::AVRTypeI) -> Float64
+

Get AVRTypeI Ka.

source
PowerSystems.get_Ke — Method
get_Ke(value::AVRTypeI) -> Float64
+

Get AVRTypeI Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::AVRTypeI) -> Float64
+

Get AVRTypeI Kf.

source
PowerSystems.get_Ta — Method
get_Ta(value::AVRTypeI) -> Float64
+

Get AVRTypeI Ta.

source
PowerSystems.get_Te — Method
get_Te(value::AVRTypeI) -> Float64
+

Get AVRTypeI Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::AVRTypeI) -> Float64
+

Get AVRTypeI Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::AVRTypeI) -> Float64
+

Get AVRTypeI Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::AVRTypeI) -> Float64
+

Get AVRTypeI V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
     value::AVRTypeI
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get AVRTypeI Va_lim.

source
PowerSystems.get_ext — Method
get_ext(value::AVRTypeI) -> Dict{String, Any}
-

Get AVRTypeI ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AVRTypeI) -> Int64
-

Get AVRTypeI n_states.

source
PowerSystems.get_states — Method
get_states(value::AVRTypeI) -> Vector{Symbol}
-

Get AVRTypeI states.

source
PowerSystems.get_states_types — Method
get_states_types(value::AVRTypeI) -> Vector{StateTypes}
-

Get AVRTypeI states_types.

source
PowerSystems.set_Ae! — Method
set_Ae!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Ae.

source
PowerSystems.set_Be! — Method
set_Be!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Be.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Ka.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Kf.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Ta.

source
PowerSystems.set_Te! — Method
set_Te!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI Va_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::AVRTypeI, val) -> Any
-

Set AVRTypeI states_types.

source

AVRTypeII

PowerSystems.AVRTypeII — Type
mutable struct AVRTypeII <: AVR
+

Get AVRTypeI Va_lim.

source
PowerSystems.get_ext — Method
get_ext(value::AVRTypeI) -> Dict{String, Any}
+

Get AVRTypeI ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AVRTypeI) -> Int64
+

Get AVRTypeI n_states.

source
PowerSystems.get_states — Method
get_states(value::AVRTypeI) -> Vector{Symbol}
+

Get AVRTypeI states.

source
PowerSystems.get_states_types — Method
get_states_types(value::AVRTypeI) -> Vector{StateTypes}
+

Get AVRTypeI states_types.

source
PowerSystems.set_Ae! — Method
set_Ae!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Ae.

source
PowerSystems.set_Be! — Method
set_Be!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Be.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Ka.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Kf.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Ta.

source
PowerSystems.set_Te! — Method
set_Te!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI Va_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::AVRTypeI, val) -> Any
+

Set AVRTypeI states_types.

source

AVRTypeII

PowerSystems.AVRTypeII — Type
mutable struct AVRTypeII <: AVR
     K0::Float64
     T1::Float64
     T2::Float64
@@ -105,37 +105,37 @@
 end

Parameters of an Automatic Voltage Regulator Type II - Typical static exciter model

Arguments

  • K0::Float64: Regulator Gain, validation range: (0, nothing)
  • T1::Float64: First Pole in s, validation range: (0, nothing)
  • T2::Float64: First zero in s, validation range: (0, nothing)
  • T3::Float64: First Pole in s, validation range: (0, nothing)
  • T4::Float64: First zero in s, validation range: (0, nothing)
  • Te::Float64: Field Circuit Time Constant in s, validation range: (0, nothing)
  • Tr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)
  • Va_lim::MinMax: Limits for pi controler (Va_min, Va_max)
  • Ae::Float64: 1st ceiling coefficient, validation range: (0, nothing)
  • Be::Float64: 2nd ceiling coefficient, validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vf: Voltage field,
 Vr1: First Lead-Lag state,
 Vr2: Second lead-lag state,
-Vm: Measured voltage
  • n_states::Int: (Do not modify.) AVR Type II has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) AVR Type II has 4 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ae — Method
get_Ae(value::AVRTypeII) -> Float64
-

Get AVRTypeII Ae.

source
PowerSystems.get_Be — Method
get_Be(value::AVRTypeII) -> Float64
-

Get AVRTypeII Be.

source
PowerSystems.get_K0 — Method
get_K0(value::AVRTypeII) -> Float64
-

Get AVRTypeII K0.

source
PowerSystems.get_T1 — Method
get_T1(value::AVRTypeII) -> Float64
-

Get AVRTypeII T1.

source
PowerSystems.get_T2 — Method
get_T2(value::AVRTypeII) -> Float64
-

Get AVRTypeII T2.

source
PowerSystems.get_T3 — Method
get_T3(value::AVRTypeII) -> Float64
-

Get AVRTypeII T3.

source
PowerSystems.get_T4 — Method
get_T4(value::AVRTypeII) -> Float64
-

Get AVRTypeII T4.

source
PowerSystems.get_Te — Method
get_Te(value::AVRTypeII) -> Float64
-

Get AVRTypeII Te.

source
PowerSystems.get_Tr — Method
get_Tr(value::AVRTypeII) -> Float64
-

Get AVRTypeII Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::AVRTypeII) -> Float64
-

Get AVRTypeII V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+Vm: Measured voltage
  • n_states::Int: (Do not modify.) AVR Type II has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) AVR Type II has 4 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ae — Method
get_Ae(value::AVRTypeII) -> Float64
+

Get AVRTypeII Ae.

source
PowerSystems.get_Be — Method
get_Be(value::AVRTypeII) -> Float64
+

Get AVRTypeII Be.

source
PowerSystems.get_K0 — Method
get_K0(value::AVRTypeII) -> Float64
+

Get AVRTypeII K0.

source
PowerSystems.get_T1 — Method
get_T1(value::AVRTypeII) -> Float64
+

Get AVRTypeII T1.

source
PowerSystems.get_T2 — Method
get_T2(value::AVRTypeII) -> Float64
+

Get AVRTypeII T2.

source
PowerSystems.get_T3 — Method
get_T3(value::AVRTypeII) -> Float64
+

Get AVRTypeII T3.

source
PowerSystems.get_T4 — Method
get_T4(value::AVRTypeII) -> Float64
+

Get AVRTypeII T4.

source
PowerSystems.get_Te — Method
get_Te(value::AVRTypeII) -> Float64
+

Get AVRTypeII Te.

source
PowerSystems.get_Tr — Method
get_Tr(value::AVRTypeII) -> Float64
+

Get AVRTypeII Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::AVRTypeII) -> Float64
+

Get AVRTypeII V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
     value::AVRTypeII
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get AVRTypeII Va_lim.

source
PowerSystems.get_ext — Method
get_ext(value::AVRTypeII) -> Dict{String, Any}
-

Get AVRTypeII ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AVRTypeII) -> Int64
-

Get AVRTypeII n_states.

source
PowerSystems.get_states — Method
get_states(value::AVRTypeII) -> Vector{Symbol}
-

Get AVRTypeII states.

source
PowerSystems.get_states_types — Method
get_states_types(value::AVRTypeII) -> Vector{StateTypes}
-

Get AVRTypeII states_types.

source
PowerSystems.set_Ae! — Method
set_Ae!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII Ae.

source
PowerSystems.set_Be! — Method
set_Be!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII Be.

source
PowerSystems.set_K0! — Method
set_K0!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII K0.

source
PowerSystems.set_T1! — Method
set_T1!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII T4.

source
PowerSystems.set_Te! — Method
set_Te!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII Te.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII Va_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::AVRTypeII, val) -> Any
-

Set AVRTypeII states_types.

source

ESAC1A

PowerSystems.ESAC1A — Type
mutable struct ESAC1A <: AVR
+

Get AVRTypeII Va_lim.

source
PowerSystems.get_ext — Method
get_ext(value::AVRTypeII) -> Dict{String, Any}
+

Get AVRTypeII ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AVRTypeII) -> Int64
+

Get AVRTypeII n_states.

source
PowerSystems.get_states — Method
get_states(value::AVRTypeII) -> Vector{Symbol}
+

Get AVRTypeII states.

source
PowerSystems.get_states_types — Method
get_states_types(value::AVRTypeII) -> Vector{StateTypes}
+

Get AVRTypeII states_types.

source
PowerSystems.set_Ae! — Method
set_Ae!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII Ae.

source
PowerSystems.set_Be! — Method
set_Be!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII Be.

source
PowerSystems.set_K0! — Method
set_K0!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII K0.

source
PowerSystems.set_T1! — Method
set_T1!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII T4.

source
PowerSystems.set_Te! — Method
set_Te!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII Te.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII Va_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::AVRTypeII, val) -> Any
+

Set AVRTypeII states_types.

source

ESAC1A

PowerSystems.ESAC1A — Type
mutable struct ESAC1A <: AVR
     Tr::Float64
     Tb::Float64
     Tc::Float64
@@ -162,53 +162,53 @@
 Vr1: Lead-lag state,
 Vr2: Regulator output state,
 Ve: Integrator output state,
-Vr3: Feedback output state
  • n_states::Int: (Do not modify.) ESAC1A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESAC1A has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESAC1A) -> Tuple{Float64, Float64}
-

Get ESAC1A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESAC1A) -> Float64
-

Get ESAC1A Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::ESAC1A) -> Float64
-

Get ESAC1A Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::ESAC1A) -> Float64
-

Get ESAC1A Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::ESAC1A) -> Float64
-

Get ESAC1A Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::ESAC1A) -> Float64
-

Get ESAC1A Kf.

source
PowerSystems.get_Se — Method
get_Se(value::ESAC1A) -> Tuple{Float64, Float64}
-

Get ESAC1A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESAC1A) -> Float64
-

Get ESAC1A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESAC1A) -> Float64
-

Get ESAC1A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESAC1A) -> Float64
-

Get ESAC1A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::ESAC1A) -> Float64
-

Get ESAC1A Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::ESAC1A) -> Float64
-

Get ESAC1A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESAC1A) -> Float64
-

Get ESAC1A Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESAC1A) -> Float64
-

Get ESAC1A V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+Vr3: Feedback output state
  • n_states::Int: (Do not modify.) ESAC1A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESAC1A has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESAC1A) -> Tuple{Float64, Float64}
+

Get ESAC1A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESAC1A) -> Float64
+

Get ESAC1A Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::ESAC1A) -> Float64
+

Get ESAC1A Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::ESAC1A) -> Float64
+

Get ESAC1A Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::ESAC1A) -> Float64
+

Get ESAC1A Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::ESAC1A) -> Float64
+

Get ESAC1A Kf.

source
PowerSystems.get_Se — Method
get_Se(value::ESAC1A) -> Tuple{Float64, Float64}
+

Get ESAC1A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESAC1A) -> Float64
+

Get ESAC1A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESAC1A) -> Float64
+

Get ESAC1A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESAC1A) -> Float64
+

Get ESAC1A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::ESAC1A) -> Float64
+

Get ESAC1A Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::ESAC1A) -> Float64
+

Get ESAC1A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESAC1A) -> Float64
+

Get ESAC1A Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESAC1A) -> Float64
+

Get ESAC1A V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
     value::ESAC1A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESAC1A Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get ESAC1A Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::ESAC1A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESAC1A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESAC1A) -> Dict{String, Any}
-

Get ESAC1A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESAC1A) -> Int64
-

Get ESAC1A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get ESAC1A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESAC1A) -> Dict{String, Any}
+

Get ESAC1A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESAC1A) -> Int64
+

Get ESAC1A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::ESAC1A
 ) -> Tuple{Float64, Float64}
-

Get ESAC1A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::ESAC1A) -> Vector{Symbol}
-

Get ESAC1A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESAC1A) -> Vector{StateTypes}
-

Get ESAC1A states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::ESAC1A, val) -> Any
-

Set ESAC1A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESAC1A, val) -> Any
-

Set ESAC1A Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::ESAC1A, val) -> Any
-

Set ESAC1A Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::ESAC1A, val) -> Any
-

Set ESAC1A Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::ESAC1A, val) -> Any
-

Set ESAC1A Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::ESAC1A, val) -> Any
-

Set ESAC1A Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::ESAC1A, val) -> Any
-

Set ESAC1A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESAC1A, val) -> Any
-

Set ESAC1A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESAC1A, val) -> Any
-

Set ESAC1A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESAC1A, val) -> Any
-

Set ESAC1A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::ESAC1A, val) -> Any
-

Set ESAC1A Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::ESAC1A, val) -> Any
-

Set ESAC1A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESAC1A, val) -> Any
-

Set ESAC1A Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESAC1A, val) -> Any
-

Set ESAC1A V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::ESAC1A, val) -> Any
-

Set ESAC1A Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESAC1A, val) -> Any
-

Set ESAC1A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESAC1A, val) -> Any
-

Set ESAC1A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::ESAC1A, val) -> Any
-

Set ESAC1A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESAC1A, val) -> Any
-

Set ESAC1A states_types.

source

ESAC6A

PowerSystems.ESAC6A — Type
mutable struct ESAC6A <: AVR
+

Get ESAC1A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::ESAC1A) -> Vector{Symbol}
+

Get ESAC1A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESAC1A) -> Vector{StateTypes}
+

Get ESAC1A states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::ESAC1A, val) -> Any
+

Set ESAC1A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESAC1A, val) -> Any
+

Set ESAC1A Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::ESAC1A, val) -> Any
+

Set ESAC1A Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::ESAC1A, val) -> Any
+

Set ESAC1A Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::ESAC1A, val) -> Any
+

Set ESAC1A Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::ESAC1A, val) -> Any
+

Set ESAC1A Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::ESAC1A, val) -> Any
+

Set ESAC1A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESAC1A, val) -> Any
+

Set ESAC1A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESAC1A, val) -> Any
+

Set ESAC1A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESAC1A, val) -> Any
+

Set ESAC1A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::ESAC1A, val) -> Any
+

Set ESAC1A Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::ESAC1A, val) -> Any
+

Set ESAC1A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESAC1A, val) -> Any
+

Set ESAC1A Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESAC1A, val) -> Any
+

Set ESAC1A V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::ESAC1A, val) -> Any
+

Set ESAC1A Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESAC1A, val) -> Any
+

Set ESAC1A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESAC1A, val) -> Any
+

Set ESAC1A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::ESAC1A, val) -> Any
+

Set ESAC1A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESAC1A, val) -> Any
+

Set ESAC1A states_types.

source

ESAC6A

PowerSystems.ESAC6A — Type
mutable struct ESAC6A <: AVR
     Tr::Float64
     Ka::Float64
     Ta::Float64
@@ -239,61 +239,61 @@
 Vr1: Lead-lag state,
 Vr2: Regulator output state,
 Ve: Integrator output state,
-Vr3: Feedback output state
  • n_states::Int: (Do not modify.) ESAC6A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESAC6A has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESAC6A) -> Tuple{Float64, Float64}
-

Get ESAC6A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESAC6A) -> Float64
-

Get ESAC6A Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::ESAC6A) -> Float64
-

Get ESAC6A Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::ESAC6A) -> Float64
-

Get ESAC6A Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::ESAC6A) -> Float64
-

Get ESAC6A Ke.

source
PowerSystems.get_Kh — Method
get_Kh(value::ESAC6A) -> Float64
-

Get ESAC6A Kh.

source
PowerSystems.get_Se — Method
get_Se(value::ESAC6A) -> Tuple{Float64, Float64}
-

Get ESAC6A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESAC6A) -> Float64
-

Get ESAC6A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESAC6A) -> Float64
-

Get ESAC6A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESAC6A) -> Float64
-

Get ESAC6A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::ESAC6A) -> Float64
-

Get ESAC6A Te.

source
PowerSystems.get_Th — Method
get_Th(value::ESAC6A) -> Float64
-

Get ESAC6A Th.

source
PowerSystems.get_Tj — Method
get_Tj(value::ESAC6A) -> Float64
-

Get ESAC6A Tj.

source
PowerSystems.get_Tk — Method
get_Tk(value::ESAC6A) -> Float64
-

Get ESAC6A Tk.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESAC6A) -> Float64
-

Get ESAC6A Tr.

source
PowerSystems.get_VFE_lim — Method
get_VFE_lim(value::ESAC6A) -> Float64
-

Get ESAC6A VFE_lim.

source
PowerSystems.get_VH_max — Method
get_VH_max(value::ESAC6A) -> Float64
-

Get ESAC6A VH_max.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESAC6A) -> Float64
-

Get ESAC6A V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+Vr3: Feedback output state
  • n_states::Int: (Do not modify.) ESAC6A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESAC6A has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESAC6A) -> Tuple{Float64, Float64}
+

Get ESAC6A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESAC6A) -> Float64
+

Get ESAC6A Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::ESAC6A) -> Float64
+

Get ESAC6A Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::ESAC6A) -> Float64
+

Get ESAC6A Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::ESAC6A) -> Float64
+

Get ESAC6A Ke.

source
PowerSystems.get_Kh — Method
get_Kh(value::ESAC6A) -> Float64
+

Get ESAC6A Kh.

source
PowerSystems.get_Se — Method
get_Se(value::ESAC6A) -> Tuple{Float64, Float64}
+

Get ESAC6A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESAC6A) -> Float64
+

Get ESAC6A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESAC6A) -> Float64
+

Get ESAC6A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESAC6A) -> Float64
+

Get ESAC6A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::ESAC6A) -> Float64
+

Get ESAC6A Te.

source
PowerSystems.get_Th — Method
get_Th(value::ESAC6A) -> Float64
+

Get ESAC6A Th.

source
PowerSystems.get_Tj — Method
get_Tj(value::ESAC6A) -> Float64
+

Get ESAC6A Tj.

source
PowerSystems.get_Tk — Method
get_Tk(value::ESAC6A) -> Float64
+

Get ESAC6A Tk.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESAC6A) -> Float64
+

Get ESAC6A Tr.

source
PowerSystems.get_VFE_lim — Method
get_VFE_lim(value::ESAC6A) -> Float64
+

Get ESAC6A VFE_lim.

source
PowerSystems.get_VH_max — Method
get_VH_max(value::ESAC6A) -> Float64
+

Get ESAC6A VH_max.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESAC6A) -> Float64
+

Get ESAC6A V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
     value::ESAC6A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESAC6A Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get ESAC6A Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::ESAC6A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESAC6A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESAC6A) -> Dict{String, Any}
-

Get ESAC6A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESAC6A) -> Int64
-

Get ESAC6A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get ESAC6A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESAC6A) -> Dict{String, Any}
+

Get ESAC6A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESAC6A) -> Int64
+

Get ESAC6A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::ESAC6A
 ) -> Tuple{Float64, Float64}
-

Get ESAC6A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::ESAC6A) -> Vector{Symbol}
-

Get ESAC6A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESAC6A) -> Vector{StateTypes}
-

Get ESAC6A states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::ESAC6A, val) -> Any
-

Set ESAC6A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESAC6A, val) -> Any
-

Set ESAC6A Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::ESAC6A, val) -> Any
-

Set ESAC6A Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::ESAC6A, val) -> Any
-

Set ESAC6A Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::ESAC6A, val) -> Any
-

Set ESAC6A Ke.

source
PowerSystems.set_Kh! — Method
set_Kh!(value::ESAC6A, val) -> Any
-

Set ESAC6A Kh.

source
PowerSystems.set_Se! — Method
set_Se!(value::ESAC6A, val) -> Any
-

Set ESAC6A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESAC6A, val) -> Any
-

Set ESAC6A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESAC6A, val) -> Any
-

Set ESAC6A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESAC6A, val) -> Any
-

Set ESAC6A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::ESAC6A, val) -> Any
-

Set ESAC6A Te.

source
PowerSystems.set_Th! — Method
set_Th!(value::ESAC6A, val) -> Any
-

Set ESAC6A Th.

source
PowerSystems.set_Tj! — Method
set_Tj!(value::ESAC6A, val) -> Any
-

Set ESAC6A Tj.

source
PowerSystems.set_Tk! — Method
set_Tk!(value::ESAC6A, val) -> Any
-

Set ESAC6A Tk.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESAC6A, val) -> Any
-

Set ESAC6A Tr.

source
PowerSystems.set_VFE_lim! — Method
set_VFE_lim!(value::ESAC6A, val) -> Any
-

Set ESAC6A VFE_lim.

source
PowerSystems.set_VH_max! — Method
set_VH_max!(value::ESAC6A, val) -> Any
-

Set ESAC6A VH_max.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESAC6A, val) -> Any
-

Set ESAC6A V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::ESAC6A, val) -> Any
-

Set ESAC6A Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESAC6A, val) -> Any
-

Set ESAC6A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESAC6A, val) -> Any
-

Set ESAC6A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::ESAC6A, val) -> Any
-

Set ESAC6A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESAC6A, val) -> Any
-

Set ESAC6A states_types.

source

ESDC1A

PowerSystems.ESDC1A — Type
mutable struct ESDC1A <: AVR
+

Get ESAC6A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::ESAC6A) -> Vector{Symbol}
+

Get ESAC6A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESAC6A) -> Vector{StateTypes}
+

Get ESAC6A states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::ESAC6A, val) -> Any
+

Set ESAC6A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESAC6A, val) -> Any
+

Set ESAC6A Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::ESAC6A, val) -> Any
+

Set ESAC6A Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::ESAC6A, val) -> Any
+

Set ESAC6A Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::ESAC6A, val) -> Any
+

Set ESAC6A Ke.

source
PowerSystems.set_Kh! — Method
set_Kh!(value::ESAC6A, val) -> Any
+

Set ESAC6A Kh.

source
PowerSystems.set_Se! — Method
set_Se!(value::ESAC6A, val) -> Any
+

Set ESAC6A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESAC6A, val) -> Any
+

Set ESAC6A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESAC6A, val) -> Any
+

Set ESAC6A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESAC6A, val) -> Any
+

Set ESAC6A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::ESAC6A, val) -> Any
+

Set ESAC6A Te.

source
PowerSystems.set_Th! — Method
set_Th!(value::ESAC6A, val) -> Any
+

Set ESAC6A Th.

source
PowerSystems.set_Tj! — Method
set_Tj!(value::ESAC6A, val) -> Any
+

Set ESAC6A Tj.

source
PowerSystems.set_Tk! — Method
set_Tk!(value::ESAC6A, val) -> Any
+

Set ESAC6A Tk.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESAC6A, val) -> Any
+

Set ESAC6A Tr.

source
PowerSystems.set_VFE_lim! — Method
set_VFE_lim!(value::ESAC6A, val) -> Any
+

Set ESAC6A VFE_lim.

source
PowerSystems.set_VH_max! — Method
set_VH_max!(value::ESAC6A, val) -> Any
+

Set ESAC6A VH_max.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESAC6A, val) -> Any
+

Set ESAC6A V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::ESAC6A, val) -> Any
+

Set ESAC6A Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESAC6A, val) -> Any
+

Set ESAC6A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESAC6A, val) -> Any
+

Set ESAC6A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::ESAC6A, val) -> Any
+

Set ESAC6A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESAC6A, val) -> Any
+

Set ESAC6A states_types.

source

ESDC1A

PowerSystems.ESDC1A — Type
mutable struct ESDC1A <: AVR
     Tr::Float64
     Ka::Float64
     Ta::Float64
@@ -318,47 +318,47 @@
 Vr1: input lead lag,
 Vr2: Regulator Output,
 Vf: Exciter Output, 
-Vr3: Rate feedback integrator
  • n_states::Int: (Do not modify.) The ESDC1A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESDC1A has 5 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESDC1A) -> Tuple{Float64, Float64}
-

Get ESDC1A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESDC1A) -> Float64
-

Get ESDC1A Ka.

source
PowerSystems.get_Ke — Method
get_Ke(value::ESDC1A) -> Float64
-

Get ESDC1A Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::ESDC1A) -> Float64
-

Get ESDC1A Kf.

source
PowerSystems.get_Se — Method
get_Se(value::ESDC1A) -> Tuple{Float64, Float64}
-

Get ESDC1A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESDC1A) -> Float64
-

Get ESDC1A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESDC1A) -> Float64
-

Get ESDC1A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESDC1A) -> Float64
-

Get ESDC1A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::ESDC1A) -> Float64
-

Get ESDC1A Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::ESDC1A) -> Float64
-

Get ESDC1A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESDC1A) -> Float64
-

Get ESDC1A Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESDC1A) -> Float64
-

Get ESDC1A V_ref.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+Vr3: Rate feedback integrator
  • n_states::Int: (Do not modify.) The ESDC1A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESDC1A has 5 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESDC1A) -> Tuple{Float64, Float64}
+

Get ESDC1A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESDC1A) -> Float64
+

Get ESDC1A Ka.

source
PowerSystems.get_Ke — Method
get_Ke(value::ESDC1A) -> Float64
+

Get ESDC1A Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::ESDC1A) -> Float64
+

Get ESDC1A Kf.

source
PowerSystems.get_Se — Method
get_Se(value::ESDC1A) -> Tuple{Float64, Float64}
+

Get ESDC1A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESDC1A) -> Float64
+

Get ESDC1A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESDC1A) -> Float64
+

Get ESDC1A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESDC1A) -> Float64
+

Get ESDC1A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::ESDC1A) -> Float64
+

Get ESDC1A Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::ESDC1A) -> Float64
+

Get ESDC1A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESDC1A) -> Float64
+

Get ESDC1A Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESDC1A) -> Float64
+

Get ESDC1A V_ref.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::ESDC1A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESDC1A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESDC1A) -> Dict{String, Any}
-

Get ESDC1A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESDC1A) -> Int64
-

Get ESDC1A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get ESDC1A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESDC1A) -> Dict{String, Any}
+

Get ESDC1A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESDC1A) -> Int64
+

Get ESDC1A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::ESDC1A
 ) -> Tuple{Float64, Float64}
-

Get ESDC1A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::ESDC1A) -> Vector{Symbol}
-

Get ESDC1A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESDC1A) -> Vector{StateTypes}
-

Get ESDC1A states_types.

source
PowerSystems.get_switch — Method
get_switch(value::ESDC1A) -> Int64
-

Get ESDC1A switch.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::ESDC1A, val) -> Any
-

Set ESDC1A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESDC1A, val) -> Any
-

Set ESDC1A Ka.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::ESDC1A, val) -> Any
-

Set ESDC1A Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::ESDC1A, val) -> Any
-

Set ESDC1A Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::ESDC1A, val) -> Any
-

Set ESDC1A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESDC1A, val) -> Any
-

Set ESDC1A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESDC1A, val) -> Any
-

Set ESDC1A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESDC1A, val) -> Any
-

Set ESDC1A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::ESDC1A, val) -> Any
-

Set ESDC1A Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::ESDC1A, val) -> Any
-

Set ESDC1A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESDC1A, val) -> Any
-

Set ESDC1A Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESDC1A, val) -> Any
-

Set ESDC1A V_ref.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESDC1A, val) -> Any
-

Set ESDC1A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESDC1A, val) -> Any
-

Set ESDC1A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::ESDC1A, val) -> Any
-

Set ESDC1A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESDC1A, val) -> Any
-

Set ESDC1A states_types.

source
PowerSystems.set_switch! — Method
set_switch!(value::ESDC1A, val) -> Any
-

Set ESDC1A switch.

source

ESDC2A

PowerSystems.ESDC2A — Type
mutable struct ESDC2A <: AVR
+

Get ESDC1A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::ESDC1A) -> Vector{Symbol}
+

Get ESDC1A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESDC1A) -> Vector{StateTypes}
+

Get ESDC1A states_types.

source
PowerSystems.get_switch — Method
get_switch(value::ESDC1A) -> Int64
+

Get ESDC1A switch.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::ESDC1A, val) -> Any
+

Set ESDC1A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESDC1A, val) -> Any
+

Set ESDC1A Ka.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::ESDC1A, val) -> Any
+

Set ESDC1A Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::ESDC1A, val) -> Any
+

Set ESDC1A Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::ESDC1A, val) -> Any
+

Set ESDC1A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESDC1A, val) -> Any
+

Set ESDC1A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESDC1A, val) -> Any
+

Set ESDC1A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESDC1A, val) -> Any
+

Set ESDC1A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::ESDC1A, val) -> Any
+

Set ESDC1A Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::ESDC1A, val) -> Any
+

Set ESDC1A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESDC1A, val) -> Any
+

Set ESDC1A Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESDC1A, val) -> Any
+

Set ESDC1A V_ref.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESDC1A, val) -> Any
+

Set ESDC1A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESDC1A, val) -> Any
+

Set ESDC1A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::ESDC1A, val) -> Any
+

Set ESDC1A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESDC1A, val) -> Any
+

Set ESDC1A states_types.

source
PowerSystems.set_switch! — Method
set_switch!(value::ESDC1A, val) -> Any
+

Set ESDC1A switch.

source

ESDC2A

PowerSystems.ESDC2A — Type
mutable struct ESDC2A <: AVR
     Tr::Float64
     Ka::Float64
     Ta::Float64
@@ -383,47 +383,47 @@
 Vr1: input lead lag,
 Vr2: Regulator Output,
 Vf: Exciter Output, 
-Vr3: Rate feedback integrator
  • n_states::Int: (Do not modify.) The ESDC2A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESDC2A has 5 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESDC2A) -> Tuple{Float64, Float64}
-

Get ESDC2A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESDC2A) -> Float64
-

Get ESDC2A Ka.

source
PowerSystems.get_Ke — Method
get_Ke(value::ESDC2A) -> Float64
-

Get ESDC2A Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::ESDC2A) -> Float64
-

Get ESDC2A Kf.

source
PowerSystems.get_Se — Method
get_Se(value::ESDC2A) -> Tuple{Float64, Float64}
-

Get ESDC2A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESDC2A) -> Float64
-

Get ESDC2A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESDC2A) -> Float64
-

Get ESDC2A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESDC2A) -> Float64
-

Get ESDC2A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::ESDC2A) -> Float64
-

Get ESDC2A Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::ESDC2A) -> Float64
-

Get ESDC2A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESDC2A) -> Float64
-

Get ESDC2A Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESDC2A) -> Float64
-

Get ESDC2A V_ref.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+Vr3: Rate feedback integrator
  • n_states::Int: (Do not modify.) The ESDC2A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESDC2A has 5 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESDC2A) -> Tuple{Float64, Float64}
+

Get ESDC2A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESDC2A) -> Float64
+

Get ESDC2A Ka.

source
PowerSystems.get_Ke — Method
get_Ke(value::ESDC2A) -> Float64
+

Get ESDC2A Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::ESDC2A) -> Float64
+

Get ESDC2A Kf.

source
PowerSystems.get_Se — Method
get_Se(value::ESDC2A) -> Tuple{Float64, Float64}
+

Get ESDC2A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESDC2A) -> Float64
+

Get ESDC2A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESDC2A) -> Float64
+

Get ESDC2A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESDC2A) -> Float64
+

Get ESDC2A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::ESDC2A) -> Float64
+

Get ESDC2A Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::ESDC2A) -> Float64
+

Get ESDC2A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESDC2A) -> Float64
+

Get ESDC2A Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESDC2A) -> Float64
+

Get ESDC2A V_ref.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::ESDC2A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESDC2A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESDC2A) -> Dict{String, Any}
-

Get ESDC2A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESDC2A) -> Int64
-

Get ESDC2A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get ESDC2A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESDC2A) -> Dict{String, Any}
+

Get ESDC2A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESDC2A) -> Int64
+

Get ESDC2A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::ESDC2A
 ) -> Tuple{Float64, Float64}
-

Get ESDC2A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::ESDC2A) -> Vector{Symbol}
-

Get ESDC2A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESDC2A) -> Vector{StateTypes}
-

Get ESDC2A states_types.

source
PowerSystems.get_switch — Method
get_switch(value::ESDC2A) -> Int64
-

Get ESDC2A switch.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::ESDC2A, val) -> Any
-

Set ESDC2A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESDC2A, val) -> Any
-

Set ESDC2A Ka.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::ESDC2A, val) -> Any
-

Set ESDC2A Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::ESDC2A, val) -> Any
-

Set ESDC2A Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::ESDC2A, val) -> Any
-

Set ESDC2A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESDC2A, val) -> Any
-

Set ESDC2A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESDC2A, val) -> Any
-

Set ESDC2A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESDC2A, val) -> Any
-

Set ESDC2A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::ESDC2A, val) -> Any
-

Set ESDC2A Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::ESDC2A, val) -> Any
-

Set ESDC2A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESDC2A, val) -> Any
-

Set ESDC2A Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESDC2A, val) -> Any
-

Set ESDC2A V_ref.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESDC2A, val) -> Any
-

Set ESDC2A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESDC2A, val) -> Any
-

Set ESDC2A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::ESDC2A, val) -> Any
-

Set ESDC2A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESDC2A, val) -> Any
-

Set ESDC2A states_types.

source
PowerSystems.set_switch! — Method
set_switch!(value::ESDC2A, val) -> Any
-

Set ESDC2A switch.

source

ESST1A

PowerSystems.ESST1A — Type
mutable struct ESST1A <: AVR
+

Get ESDC2A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::ESDC2A) -> Vector{Symbol}
+

Get ESDC2A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESDC2A) -> Vector{StateTypes}
+

Get ESDC2A states_types.

source
PowerSystems.get_switch — Method
get_switch(value::ESDC2A) -> Int64
+

Get ESDC2A switch.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::ESDC2A, val) -> Any
+

Set ESDC2A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESDC2A, val) -> Any
+

Set ESDC2A Ka.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::ESDC2A, val) -> Any
+

Set ESDC2A Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::ESDC2A, val) -> Any
+

Set ESDC2A Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::ESDC2A, val) -> Any
+

Set ESDC2A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESDC2A, val) -> Any
+

Set ESDC2A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESDC2A, val) -> Any
+

Set ESDC2A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESDC2A, val) -> Any
+

Set ESDC2A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::ESDC2A, val) -> Any
+

Set ESDC2A Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::ESDC2A, val) -> Any
+

Set ESDC2A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESDC2A, val) -> Any
+

Set ESDC2A Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESDC2A, val) -> Any
+

Set ESDC2A V_ref.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESDC2A, val) -> Any
+

Set ESDC2A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESDC2A, val) -> Any
+

Set ESDC2A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::ESDC2A, val) -> Any
+

Set ESDC2A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESDC2A, val) -> Any
+

Set ESDC2A states_types.

source
PowerSystems.set_switch! — Method
set_switch!(value::ESDC2A, val) -> Any
+

Set ESDC2A switch.

source

ESST1A

PowerSystems.ESST1A — Type
mutable struct ESST1A <: AVR
     UEL_flags::Int
     PSS_flags::Int
     Tr::Float64
@@ -451,53 +451,53 @@
 Vr1: First Lead-lag state,
 Vr2: Second lead-lag state,
 Va: Regulator output state,
-Vr3: Feedback output state
  • n_states::Int: (Do not modify.) ST1A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ST1A has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_I_lr — Method
get_I_lr(value::ESST1A) -> Float64
-

Get ESST1A I_lr.

source
PowerSystems.get_K_lr — Method
get_K_lr(value::ESST1A) -> Float64
-

Get ESST1A K_lr.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESST1A) -> Float64
-

Get ESST1A Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::ESST1A) -> Float64
-

Get ESST1A Kc.

source
PowerSystems.get_Kf — Method
get_Kf(value::ESST1A) -> Float64
-

Get ESST1A Kf.

source
PowerSystems.get_PSS_flags — Method
get_PSS_flags(value::ESST1A) -> Int64
-

Get ESST1A PSS_flags.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESST1A) -> Float64
-

Get ESST1A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESST1A) -> Float64
-

Get ESST1A Tb.

source
PowerSystems.get_Tb1 — Method
get_Tb1(value::ESST1A) -> Float64
-

Get ESST1A Tb1.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESST1A) -> Float64
-

Get ESST1A Tc.

source
PowerSystems.get_Tc1 — Method
get_Tc1(value::ESST1A) -> Float64
-

Get ESST1A Tc1.

source
PowerSystems.get_Tf — Method
get_Tf(value::ESST1A) -> Float64
-

Get ESST1A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESST1A) -> Float64
-

Get ESST1A Tr.

source
PowerSystems.get_UEL_flags — Method
get_UEL_flags(value::ESST1A) -> Int64
-

Get ESST1A UEL_flags.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESST1A) -> Float64
-

Get ESST1A V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+Vr3: Feedback output state
  • n_states::Int: (Do not modify.) ST1A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ST1A has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_I_lr — Method
get_I_lr(value::ESST1A) -> Float64
+

Get ESST1A I_lr.

source
PowerSystems.get_K_lr — Method
get_K_lr(value::ESST1A) -> Float64
+

Get ESST1A K_lr.

source
PowerSystems.get_Ka — Method
get_Ka(value::ESST1A) -> Float64
+

Get ESST1A Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::ESST1A) -> Float64
+

Get ESST1A Kc.

source
PowerSystems.get_Kf — Method
get_Kf(value::ESST1A) -> Float64
+

Get ESST1A Kf.

source
PowerSystems.get_PSS_flags — Method
get_PSS_flags(value::ESST1A) -> Int64
+

Get ESST1A PSS_flags.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESST1A) -> Float64
+

Get ESST1A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::ESST1A) -> Float64
+

Get ESST1A Tb.

source
PowerSystems.get_Tb1 — Method
get_Tb1(value::ESST1A) -> Float64
+

Get ESST1A Tb1.

source
PowerSystems.get_Tc — Method
get_Tc(value::ESST1A) -> Float64
+

Get ESST1A Tc.

source
PowerSystems.get_Tc1 — Method
get_Tc1(value::ESST1A) -> Float64
+

Get ESST1A Tc1.

source
PowerSystems.get_Tf — Method
get_Tf(value::ESST1A) -> Float64
+

Get ESST1A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESST1A) -> Float64
+

Get ESST1A Tr.

source
PowerSystems.get_UEL_flags — Method
get_UEL_flags(value::ESST1A) -> Int64
+

Get ESST1A UEL_flags.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESST1A) -> Float64
+

Get ESST1A V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
     value::ESST1A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESST1A Va_lim.

source
PowerSystems.get_Vi_lim — Method
get_Vi_lim(value::ESST1A) -> Tuple{Float64, Float64}
-

Get ESST1A Vi_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get ESST1A Va_lim.

source
PowerSystems.get_Vi_lim — Method
get_Vi_lim(value::ESST1A) -> Tuple{Float64, Float64}
+

Get ESST1A Vi_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::ESST1A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESST1A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESST1A) -> Dict{String, Any}
-

Get ESST1A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESST1A) -> Int64
-

Get ESST1A n_states.

source
PowerSystems.get_states — Method
get_states(value::ESST1A) -> Vector{Symbol}
-

Get ESST1A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESST1A) -> Vector{StateTypes}
-

Get ESST1A states_types.

source
PowerSystems.set_I_lr! — Method
set_I_lr!(value::ESST1A, val) -> Any
-

Set ESST1A I_lr.

source
PowerSystems.set_K_lr! — Method
set_K_lr!(value::ESST1A, val) -> Any
-

Set ESST1A K_lr.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESST1A, val) -> Any
-

Set ESST1A Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::ESST1A, val) -> Any
-

Set ESST1A Kc.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::ESST1A, val) -> Any
-

Set ESST1A Kf.

source
PowerSystems.set_PSS_flags! — Method
set_PSS_flags!(value::ESST1A, val) -> Any
-

Set ESST1A PSS_flags.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESST1A, val) -> Any
-

Set ESST1A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESST1A, val) -> Any
-

Set ESST1A Tb.

source
PowerSystems.set_Tb1! — Method
set_Tb1!(value::ESST1A, val) -> Any
-

Set ESST1A Tb1.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESST1A, val) -> Any
-

Set ESST1A Tc.

source
PowerSystems.set_Tc1! — Method
set_Tc1!(value::ESST1A, val) -> Any
-

Set ESST1A Tc1.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::ESST1A, val) -> Any
-

Set ESST1A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESST1A, val) -> Any
-

Set ESST1A Tr.

source
PowerSystems.set_UEL_flags! — Method
set_UEL_flags!(value::ESST1A, val) -> Any
-

Set ESST1A UEL_flags.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESST1A, val) -> Any
-

Set ESST1A V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::ESST1A, val) -> Any
-

Set ESST1A Va_lim.

source
PowerSystems.set_Vi_lim! — Method
set_Vi_lim!(value::ESST1A, val) -> Any
-

Set ESST1A Vi_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESST1A, val) -> Any
-

Set ESST1A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESST1A, val) -> Any
-

Set ESST1A ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESST1A, val) -> Any
-

Set ESST1A states_types.

source

ESST4B

PowerSystems.ESST4B — Type
mutable struct ESST4B <: AVR
+

Get ESST1A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::ESST1A) -> Dict{String, Any}
+

Get ESST1A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESST1A) -> Int64
+

Get ESST1A n_states.

source
PowerSystems.get_states — Method
get_states(value::ESST1A) -> Vector{Symbol}
+

Get ESST1A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESST1A) -> Vector{StateTypes}
+

Get ESST1A states_types.

source
PowerSystems.set_I_lr! — Method
set_I_lr!(value::ESST1A, val) -> Any
+

Set ESST1A I_lr.

source
PowerSystems.set_K_lr! — Method
set_K_lr!(value::ESST1A, val) -> Any
+

Set ESST1A K_lr.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::ESST1A, val) -> Any
+

Set ESST1A Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::ESST1A, val) -> Any
+

Set ESST1A Kc.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::ESST1A, val) -> Any
+

Set ESST1A Kf.

source
PowerSystems.set_PSS_flags! — Method
set_PSS_flags!(value::ESST1A, val) -> Any
+

Set ESST1A PSS_flags.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESST1A, val) -> Any
+

Set ESST1A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::ESST1A, val) -> Any
+

Set ESST1A Tb.

source
PowerSystems.set_Tb1! — Method
set_Tb1!(value::ESST1A, val) -> Any
+

Set ESST1A Tb1.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::ESST1A, val) -> Any
+

Set ESST1A Tc.

source
PowerSystems.set_Tc1! — Method
set_Tc1!(value::ESST1A, val) -> Any
+

Set ESST1A Tc1.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::ESST1A, val) -> Any
+

Set ESST1A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESST1A, val) -> Any
+

Set ESST1A Tr.

source
PowerSystems.set_UEL_flags! — Method
set_UEL_flags!(value::ESST1A, val) -> Any
+

Set ESST1A UEL_flags.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESST1A, val) -> Any
+

Set ESST1A V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::ESST1A, val) -> Any
+

Set ESST1A Va_lim.

source
PowerSystems.set_Vi_lim! — Method
set_Vi_lim!(value::ESST1A, val) -> Any
+

Set ESST1A Vi_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESST1A, val) -> Any
+

Set ESST1A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESST1A, val) -> Any
+

Set ESST1A ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESST1A, val) -> Any
+

Set ESST1A states_types.

source

ESST4B

PowerSystems.ESST4B — Type
mutable struct ESST4B <: AVR
     Tr::Float64
     K_pr::Float64
     K_ir::Float64
@@ -524,51 +524,51 @@
 Vt: Sensed Terminal Voltage,
 Vr1: Regulator Integrator,
 Vr2: Regulator Output,
-Vm: Output integrator
  • n_states::Int: (Do not modify.) ST4B has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) ST4B has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K_im — Method
get_K_im(value::ESST4B) -> Float64
-

Get ESST4B K_im.

source
PowerSystems.get_K_ir — Method
get_K_ir(value::ESST4B) -> Float64
-

Get ESST4B K_ir.

source
PowerSystems.get_K_pm — Method
get_K_pm(value::ESST4B) -> Float64
-

Get ESST4B K_pm.

source
PowerSystems.get_K_pr — Method
get_K_pr(value::ESST4B) -> Float64
-

Get ESST4B K_pr.

source
PowerSystems.get_Kc — Method
get_Kc(value::ESST4B) -> Float64
-

Get ESST4B Kc.

source
PowerSystems.get_Kg — Method
get_Kg(value::ESST4B) -> Float64
-

Get ESST4B Kg.

source
PowerSystems.get_Ki — Method
get_Ki(value::ESST4B) -> Float64
-

Get ESST4B Ki.

source
PowerSystems.get_Kp — Method
get_Kp(value::ESST4B) -> Float64
-

Get ESST4B Kp.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESST4B) -> Float64
-

Get ESST4B Ta.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESST4B) -> Float64
-

Get ESST4B Tr.

source
PowerSystems.get_VB_max — Method
get_VB_max(value::ESST4B) -> Float64
-

Get ESST4B VB_max.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESST4B) -> Float64
-

Get ESST4B V_ref.

source
PowerSystems.get_Vm_lim — Method
get_Vm_lim(
+Vm: Output integrator
  • n_states::Int: (Do not modify.) ST4B has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) ST4B has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K_im — Method
get_K_im(value::ESST4B) -> Float64
+

Get ESST4B K_im.

source
PowerSystems.get_K_ir — Method
get_K_ir(value::ESST4B) -> Float64
+

Get ESST4B K_ir.

source
PowerSystems.get_K_pm — Method
get_K_pm(value::ESST4B) -> Float64
+

Get ESST4B K_pm.

source
PowerSystems.get_K_pr — Method
get_K_pr(value::ESST4B) -> Float64
+

Get ESST4B K_pr.

source
PowerSystems.get_Kc — Method
get_Kc(value::ESST4B) -> Float64
+

Get ESST4B Kc.

source
PowerSystems.get_Kg — Method
get_Kg(value::ESST4B) -> Float64
+

Get ESST4B Kg.

source
PowerSystems.get_Ki — Method
get_Ki(value::ESST4B) -> Float64
+

Get ESST4B Ki.

source
PowerSystems.get_Kp — Method
get_Kp(value::ESST4B) -> Float64
+

Get ESST4B Kp.

source
PowerSystems.get_Ta — Method
get_Ta(value::ESST4B) -> Float64
+

Get ESST4B Ta.

source
PowerSystems.get_Tr — Method
get_Tr(value::ESST4B) -> Float64
+

Get ESST4B Tr.

source
PowerSystems.get_VB_max — Method
get_VB_max(value::ESST4B) -> Float64
+

Get ESST4B VB_max.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::ESST4B) -> Float64
+

Get ESST4B V_ref.

source
PowerSystems.get_Vm_lim — Method
get_Vm_lim(
     value::ESST4B
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESST4B Vm_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get ESST4B Vm_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::ESST4B
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get ESST4B Vr_lim.

source
PowerSystems.get_Xl — Method
get_Xl(value::ESST4B) -> Float64
-

Get ESST4B Xl.

source
PowerSystems.get_ext — Method
get_ext(value::ESST4B) -> Dict{String, Any}
-

Get ESST4B ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESST4B) -> Int64
-

Get ESST4B n_states.

source
PowerSystems.get_states — Method
get_states(value::ESST4B) -> Vector{Symbol}
-

Get ESST4B states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESST4B) -> Vector{StateTypes}
-

Get ESST4B states_types.

source
PowerSystems.get_θp — Method
get_θp(value::ESST4B) -> Float64
-

Get ESST4B θp.

source
PowerSystems.get_θp_rad — Method
get_θp_rad(value::ESST4B) -> Float64
-

Get ESST4B θp_rad.

source
PowerSystems.set_K_im! — Method
set_K_im!(value::ESST4B, val) -> Any
-

Set ESST4B K_im.

source
PowerSystems.set_K_ir! — Method
set_K_ir!(value::ESST4B, val) -> Any
-

Set ESST4B K_ir.

source
PowerSystems.set_K_pm! — Method
set_K_pm!(value::ESST4B, val) -> Any
-

Set ESST4B K_pm.

source
PowerSystems.set_K_pr! — Method
set_K_pr!(value::ESST4B, val) -> Any
-

Set ESST4B K_pr.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::ESST4B, val) -> Any
-

Set ESST4B Kc.

source
PowerSystems.set_Kg! — Method
set_Kg!(value::ESST4B, val) -> Any
-

Set ESST4B Kg.

source
PowerSystems.set_Ki! — Method
set_Ki!(value::ESST4B, val) -> Any
-

Set ESST4B Ki.

source
PowerSystems.set_Kp! — Method
set_Kp!(value::ESST4B, val) -> Any
-

Set ESST4B Kp.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESST4B, val) -> Any
-

Set ESST4B Ta.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESST4B, val) -> Any
-

Set ESST4B Tr.

source
PowerSystems.set_VB_max! — Method
set_VB_max!(value::ESST4B, val) -> Any
-

Set ESST4B VB_max.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESST4B, val) -> Any
-

Set ESST4B V_ref.

source
PowerSystems.set_Vm_lim! — Method
set_Vm_lim!(value::ESST4B, val) -> Any
-

Set ESST4B Vm_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESST4B, val) -> Any
-

Set ESST4B Vr_lim.

source
PowerSystems.set_Xl! — Method
set_Xl!(value::ESST4B, val) -> Any
-

Set ESST4B Xl.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESST4B, val) -> Any
-

Set ESST4B ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESST4B, val) -> Any
-

Set ESST4B states_types.

source
PowerSystems.set_θp! — Method
set_θp!(value::ESST4B, val) -> Any
-

Set ESST4B θp.

source
PowerSystems.set_θp_rad! — Method
set_θp_rad!(value::ESST4B, val) -> Any
-

Set ESST4B θp_rad.

source

EXAC1

PowerSystems.EXAC1 — Type
mutable struct EXAC1 <: AVR
+

Get ESST4B Vr_lim.

source
PowerSystems.get_Xl — Method
get_Xl(value::ESST4B) -> Float64
+

Get ESST4B Xl.

source
PowerSystems.get_ext — Method
get_ext(value::ESST4B) -> Dict{String, Any}
+

Get ESST4B ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::ESST4B) -> Int64
+

Get ESST4B n_states.

source
PowerSystems.get_states — Method
get_states(value::ESST4B) -> Vector{Symbol}
+

Get ESST4B states.

source
PowerSystems.get_states_types — Method
get_states_types(value::ESST4B) -> Vector{StateTypes}
+

Get ESST4B states_types.

source
PowerSystems.get_θp — Method
get_θp(value::ESST4B) -> Float64
+

Get ESST4B θp.

source
PowerSystems.get_θp_rad — Method
get_θp_rad(value::ESST4B) -> Float64
+

Get ESST4B θp_rad.

source
PowerSystems.set_K_im! — Method
set_K_im!(value::ESST4B, val) -> Any
+

Set ESST4B K_im.

source
PowerSystems.set_K_ir! — Method
set_K_ir!(value::ESST4B, val) -> Any
+

Set ESST4B K_ir.

source
PowerSystems.set_K_pm! — Method
set_K_pm!(value::ESST4B, val) -> Any
+

Set ESST4B K_pm.

source
PowerSystems.set_K_pr! — Method
set_K_pr!(value::ESST4B, val) -> Any
+

Set ESST4B K_pr.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::ESST4B, val) -> Any
+

Set ESST4B Kc.

source
PowerSystems.set_Kg! — Method
set_Kg!(value::ESST4B, val) -> Any
+

Set ESST4B Kg.

source
PowerSystems.set_Ki! — Method
set_Ki!(value::ESST4B, val) -> Any
+

Set ESST4B Ki.

source
PowerSystems.set_Kp! — Method
set_Kp!(value::ESST4B, val) -> Any
+

Set ESST4B Kp.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::ESST4B, val) -> Any
+

Set ESST4B Ta.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::ESST4B, val) -> Any
+

Set ESST4B Tr.

source
PowerSystems.set_VB_max! — Method
set_VB_max!(value::ESST4B, val) -> Any
+

Set ESST4B VB_max.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ESST4B, val) -> Any
+

Set ESST4B V_ref.

source
PowerSystems.set_Vm_lim! — Method
set_Vm_lim!(value::ESST4B, val) -> Any
+

Set ESST4B Vm_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::ESST4B, val) -> Any
+

Set ESST4B Vr_lim.

source
PowerSystems.set_Xl! — Method
set_Xl!(value::ESST4B, val) -> Any
+

Set ESST4B Xl.

source
PowerSystems.set_ext! — Method
set_ext!(value::ESST4B, val) -> Any
+

Set ESST4B ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::ESST4B, val) -> Any
+

Set ESST4B states_types.

source
PowerSystems.set_θp! — Method
set_θp!(value::ESST4B, val) -> Any
+

Set ESST4B θp.

source
PowerSystems.set_θp_rad! — Method
set_θp_rad!(value::ESST4B, val) -> Any
+

Set ESST4B θp_rad.

source

EXAC1

PowerSystems.EXAC1 — Type
mutable struct EXAC1 <: AVR
     Tr::Float64
     Tb::Float64
     Tc::Float64
@@ -594,49 +594,49 @@
 Vr1: Lead-lag state,
 Vr2: Regulator output state,
 Ve: Integrator output state,
-Vr3: Feedback output state
  • n_states::Int: (Do not modify.) EXAC1 has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) EXAC1 has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::EXAC1) -> Tuple{Float64, Float64}
-

Get EXAC1 E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::EXAC1) -> Float64
-

Get EXAC1 Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::EXAC1) -> Float64
-

Get EXAC1 Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::EXAC1) -> Float64
-

Get EXAC1 Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::EXAC1) -> Float64
-

Get EXAC1 Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::EXAC1) -> Float64
-

Get EXAC1 Kf.

source
PowerSystems.get_Se — Method
get_Se(value::EXAC1) -> Tuple{Float64, Float64}
-

Get EXAC1 Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::EXAC1) -> Float64
-

Get EXAC1 Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::EXAC1) -> Float64
-

Get EXAC1 Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::EXAC1) -> Float64
-

Get EXAC1 Tc.

source
PowerSystems.get_Te — Method
get_Te(value::EXAC1) -> Float64
-

Get EXAC1 Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::EXAC1) -> Float64
-

Get EXAC1 Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::EXAC1) -> Float64
-

Get EXAC1 Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::EXAC1) -> Float64
-

Get EXAC1 V_ref.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+Vr3: Feedback output state
  • n_states::Int: (Do not modify.) EXAC1 has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) EXAC1 has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::EXAC1) -> Tuple{Float64, Float64}
+

Get EXAC1 E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::EXAC1) -> Float64
+

Get EXAC1 Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::EXAC1) -> Float64
+

Get EXAC1 Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::EXAC1) -> Float64
+

Get EXAC1 Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::EXAC1) -> Float64
+

Get EXAC1 Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::EXAC1) -> Float64
+

Get EXAC1 Kf.

source
PowerSystems.get_Se — Method
get_Se(value::EXAC1) -> Tuple{Float64, Float64}
+

Get EXAC1 Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::EXAC1) -> Float64
+

Get EXAC1 Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::EXAC1) -> Float64
+

Get EXAC1 Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::EXAC1) -> Float64
+

Get EXAC1 Tc.

source
PowerSystems.get_Te — Method
get_Te(value::EXAC1) -> Float64
+

Get EXAC1 Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::EXAC1) -> Float64
+

Get EXAC1 Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::EXAC1) -> Float64
+

Get EXAC1 Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::EXAC1) -> Float64
+

Get EXAC1 V_ref.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::EXAC1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXAC1 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::EXAC1) -> Dict{String, Any}
-

Get EXAC1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::EXAC1) -> Int64
-

Get EXAC1 n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get EXAC1 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::EXAC1) -> Dict{String, Any}
+

Get EXAC1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::EXAC1) -> Int64
+

Get EXAC1 n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::EXAC1
 ) -> Tuple{Float64, Float64}
-

Get EXAC1 saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::EXAC1) -> Vector{Symbol}
-

Get EXAC1 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::EXAC1) -> Vector{StateTypes}
-

Get EXAC1 states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::EXAC1, val) -> Any
-

Set EXAC1 E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::EXAC1, val) -> Any
-

Set EXAC1 Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::EXAC1, val) -> Any
-

Set EXAC1 Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::EXAC1, val) -> Any
-

Set EXAC1 Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::EXAC1, val) -> Any
-

Set EXAC1 Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::EXAC1, val) -> Any
-

Set EXAC1 Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::EXAC1, val) -> Any
-

Set EXAC1 Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::EXAC1, val) -> Any
-

Set EXAC1 Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::EXAC1, val) -> Any
-

Set EXAC1 Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::EXAC1, val) -> Any
-

Set EXAC1 Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::EXAC1, val) -> Any
-

Set EXAC1 Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::EXAC1, val) -> Any
-

Set EXAC1 Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::EXAC1, val) -> Any
-

Set EXAC1 Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::EXAC1, val) -> Any
-

Set EXAC1 V_ref.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::EXAC1, val) -> Any
-

Set EXAC1 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::EXAC1, val) -> Any
-

Set EXAC1 ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::EXAC1, val) -> Any
-

Set EXAC1 saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::EXAC1, val) -> Any
-

Set EXAC1 states_types.

source

EXAC1A

PowerSystems.EXAC1A — Type
mutable struct EXAC1A <: AVR
+

Get EXAC1 saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::EXAC1) -> Vector{Symbol}
+

Get EXAC1 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::EXAC1) -> Vector{StateTypes}
+

Get EXAC1 states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::EXAC1, val) -> Any
+

Set EXAC1 E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::EXAC1, val) -> Any
+

Set EXAC1 Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::EXAC1, val) -> Any
+

Set EXAC1 Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::EXAC1, val) -> Any
+

Set EXAC1 Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::EXAC1, val) -> Any
+

Set EXAC1 Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::EXAC1, val) -> Any
+

Set EXAC1 Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::EXAC1, val) -> Any
+

Set EXAC1 Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::EXAC1, val) -> Any
+

Set EXAC1 Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::EXAC1, val) -> Any
+

Set EXAC1 Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::EXAC1, val) -> Any
+

Set EXAC1 Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::EXAC1, val) -> Any
+

Set EXAC1 Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::EXAC1, val) -> Any
+

Set EXAC1 Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::EXAC1, val) -> Any
+

Set EXAC1 Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::EXAC1, val) -> Any
+

Set EXAC1 V_ref.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::EXAC1, val) -> Any
+

Set EXAC1 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::EXAC1, val) -> Any
+

Set EXAC1 ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::EXAC1, val) -> Any
+

Set EXAC1 saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::EXAC1, val) -> Any
+

Set EXAC1 states_types.

source

EXAC1A

PowerSystems.EXAC1A — Type
mutable struct EXAC1A <: AVR
     Tr::Float64
     Tb::Float64
     Tc::Float64
@@ -663,53 +663,53 @@
 Vr1: Lead-lag state,
 Vr2: Regulator output state,
 Ve: Integrator output state,
-Vr3: Feedback output state
  • n_states::Int: (Do not modify.) EXAC1A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) EXAC1A has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::EXAC1A) -> Tuple{Float64, Float64}
-

Get EXAC1A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::EXAC1A) -> Float64
-

Get EXAC1A Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::EXAC1A) -> Float64
-

Get EXAC1A Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::EXAC1A) -> Float64
-

Get EXAC1A Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::EXAC1A) -> Float64
-

Get EXAC1A Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::EXAC1A) -> Float64
-

Get EXAC1A Kf.

source
PowerSystems.get_Se — Method
get_Se(value::EXAC1A) -> Tuple{Float64, Float64}
-

Get EXAC1A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::EXAC1A) -> Float64
-

Get EXAC1A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::EXAC1A) -> Float64
-

Get EXAC1A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::EXAC1A) -> Float64
-

Get EXAC1A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::EXAC1A) -> Float64
-

Get EXAC1A Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::EXAC1A) -> Float64
-

Get EXAC1A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::EXAC1A) -> Float64
-

Get EXAC1A Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::EXAC1A) -> Float64
-

Get EXAC1A V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+Vr3: Feedback output state
  • n_states::Int: (Do not modify.) EXAC1A has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) EXAC1A has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::EXAC1A) -> Tuple{Float64, Float64}
+

Get EXAC1A E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::EXAC1A) -> Float64
+

Get EXAC1A Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::EXAC1A) -> Float64
+

Get EXAC1A Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::EXAC1A) -> Float64
+

Get EXAC1A Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::EXAC1A) -> Float64
+

Get EXAC1A Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::EXAC1A) -> Float64
+

Get EXAC1A Kf.

source
PowerSystems.get_Se — Method
get_Se(value::EXAC1A) -> Tuple{Float64, Float64}
+

Get EXAC1A Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::EXAC1A) -> Float64
+

Get EXAC1A Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::EXAC1A) -> Float64
+

Get EXAC1A Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::EXAC1A) -> Float64
+

Get EXAC1A Tc.

source
PowerSystems.get_Te — Method
get_Te(value::EXAC1A) -> Float64
+

Get EXAC1A Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::EXAC1A) -> Float64
+

Get EXAC1A Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::EXAC1A) -> Float64
+

Get EXAC1A Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::EXAC1A) -> Float64
+

Get EXAC1A V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
     value::EXAC1A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXAC1A Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get EXAC1A Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::EXAC1A
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXAC1A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::EXAC1A) -> Dict{String, Any}
-

Get EXAC1A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::EXAC1A) -> Int64
-

Get EXAC1A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get EXAC1A Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::EXAC1A) -> Dict{String, Any}
+

Get EXAC1A ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::EXAC1A) -> Int64
+

Get EXAC1A n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::EXAC1A
 ) -> Tuple{Float64, Float64}
-

Get EXAC1A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::EXAC1A) -> Vector{Symbol}
-

Get EXAC1A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::EXAC1A) -> Vector{StateTypes}
-

Get EXAC1A states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::EXAC1A, val) -> Any
-

Set EXAC1A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::EXAC1A, val) -> Any
-

Set EXAC1A Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::EXAC1A, val) -> Any
-

Set EXAC1A Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::EXAC1A, val) -> Any
-

Set EXAC1A Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::EXAC1A, val) -> Any
-

Set EXAC1A Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::EXAC1A, val) -> Any
-

Set EXAC1A Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::EXAC1A, val) -> Any
-

Set EXAC1A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::EXAC1A, val) -> Any
-

Set EXAC1A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::EXAC1A, val) -> Any
-

Set EXAC1A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::EXAC1A, val) -> Any
-

Set EXAC1A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::EXAC1A, val) -> Any
-

Set EXAC1A Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::EXAC1A, val) -> Any
-

Set EXAC1A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::EXAC1A, val) -> Any
-

Set EXAC1A Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::EXAC1A, val) -> Any
-

Set EXAC1A V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::EXAC1A, val) -> Any
-

Set EXAC1A Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::EXAC1A, val) -> Any
-

Set EXAC1A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::EXAC1A, val) -> Any
-

Set EXAC1A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::EXAC1A, val) -> Any
-

Set EXAC1A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::EXAC1A, val) -> Any
-

Set EXAC1A states_types.

source

EXAC2

PowerSystems.EXAC2 — Type
mutable struct EXAC2 <: AVR
+

Get EXAC1A saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::EXAC1A) -> Vector{Symbol}
+

Get EXAC1A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::EXAC1A) -> Vector{StateTypes}
+

Get EXAC1A states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::EXAC1A, val) -> Any
+

Set EXAC1A E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::EXAC1A, val) -> Any
+

Set EXAC1A Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::EXAC1A, val) -> Any
+

Set EXAC1A Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::EXAC1A, val) -> Any
+

Set EXAC1A Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::EXAC1A, val) -> Any
+

Set EXAC1A Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::EXAC1A, val) -> Any
+

Set EXAC1A Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::EXAC1A, val) -> Any
+

Set EXAC1A Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::EXAC1A, val) -> Any
+

Set EXAC1A Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::EXAC1A, val) -> Any
+

Set EXAC1A Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::EXAC1A, val) -> Any
+

Set EXAC1A Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::EXAC1A, val) -> Any
+

Set EXAC1A Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::EXAC1A, val) -> Any
+

Set EXAC1A Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::EXAC1A, val) -> Any
+

Set EXAC1A Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::EXAC1A, val) -> Any
+

Set EXAC1A V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::EXAC1A, val) -> Any
+

Set EXAC1A Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::EXAC1A, val) -> Any
+

Set EXAC1A Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::EXAC1A, val) -> Any
+

Set EXAC1A ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::EXAC1A, val) -> Any
+

Set EXAC1A saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::EXAC1A, val) -> Any
+

Set EXAC1A states_types.

source

EXAC2

PowerSystems.EXAC2 — Type
mutable struct EXAC2 <: AVR
     Tr::Float64
     Tb::Float64
     Tc::Float64
@@ -740,61 +740,61 @@
 Vr1: Lead-lag state,
 Vr2: Regulator output state,
 Ve: Integrator output state,
-Vr3: Feedback output state
  • n_states::Int: (Do not modify.) EXAC2 has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) EXAC2 has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::EXAC2) -> Tuple{Float64, Float64}
-

Get EXAC2 E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::EXAC2) -> Float64
-

Get EXAC2 Ka.

source
PowerSystems.get_Kb — Method
get_Kb(value::EXAC2) -> Float64
-

Get EXAC2 Kb.

source
PowerSystems.get_Kc — Method
get_Kc(value::EXAC2) -> Float64
-

Get EXAC2 Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::EXAC2) -> Float64
-

Get EXAC2 Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::EXAC2) -> Float64
-

Get EXAC2 Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::EXAC2) -> Float64
-

Get EXAC2 Kf.

source
PowerSystems.get_Kh — Method
get_Kh(value::EXAC2) -> Float64
-

Get EXAC2 Kh.

source
PowerSystems.get_Kl — Method
get_Kl(value::EXAC2) -> Float64
-

Get EXAC2 Kl.

source
PowerSystems.get_Se — Method
get_Se(value::EXAC2) -> Tuple{Float64, Float64}
-

Get EXAC2 Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::EXAC2) -> Float64
-

Get EXAC2 Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::EXAC2) -> Float64
-

Get EXAC2 Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::EXAC2) -> Float64
-

Get EXAC2 Tc.

source
PowerSystems.get_Te — Method
get_Te(value::EXAC2) -> Float64
-

Get EXAC2 Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::EXAC2) -> Float64
-

Get EXAC2 Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::EXAC2) -> Float64
-

Get EXAC2 Tr.

source
PowerSystems.get_V_lr — Method
get_V_lr(value::EXAC2) -> Float64
-

Get EXAC2 V_lr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::EXAC2) -> Float64
-

Get EXAC2 V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+Vr3: Feedback output state
  • n_states::Int: (Do not modify.) EXAC2 has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) EXAC2 has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::EXAC2) -> Tuple{Float64, Float64}
+

Get EXAC2 E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::EXAC2) -> Float64
+

Get EXAC2 Ka.

source
PowerSystems.get_Kb — Method
get_Kb(value::EXAC2) -> Float64
+

Get EXAC2 Kb.

source
PowerSystems.get_Kc — Method
get_Kc(value::EXAC2) -> Float64
+

Get EXAC2 Kc.

source
PowerSystems.get_Kd — Method
get_Kd(value::EXAC2) -> Float64
+

Get EXAC2 Kd.

source
PowerSystems.get_Ke — Method
get_Ke(value::EXAC2) -> Float64
+

Get EXAC2 Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::EXAC2) -> Float64
+

Get EXAC2 Kf.

source
PowerSystems.get_Kh — Method
get_Kh(value::EXAC2) -> Float64
+

Get EXAC2 Kh.

source
PowerSystems.get_Kl — Method
get_Kl(value::EXAC2) -> Float64
+

Get EXAC2 Kl.

source
PowerSystems.get_Se — Method
get_Se(value::EXAC2) -> Tuple{Float64, Float64}
+

Get EXAC2 Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::EXAC2) -> Float64
+

Get EXAC2 Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::EXAC2) -> Float64
+

Get EXAC2 Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::EXAC2) -> Float64
+

Get EXAC2 Tc.

source
PowerSystems.get_Te — Method
get_Te(value::EXAC2) -> Float64
+

Get EXAC2 Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::EXAC2) -> Float64
+

Get EXAC2 Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::EXAC2) -> Float64
+

Get EXAC2 Tr.

source
PowerSystems.get_V_lr — Method
get_V_lr(value::EXAC2) -> Float64
+

Get EXAC2 V_lr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::EXAC2) -> Float64
+

Get EXAC2 V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
     value::EXAC2
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXAC2 Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get EXAC2 Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::EXAC2
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXAC2 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::EXAC2) -> Dict{String, Any}
-

Get EXAC2 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::EXAC2) -> Int64
-

Get EXAC2 n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get EXAC2 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::EXAC2) -> Dict{String, Any}
+

Get EXAC2 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::EXAC2) -> Int64
+

Get EXAC2 n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::EXAC2
 ) -> Tuple{Float64, Float64}
-

Get EXAC2 saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::EXAC2) -> Vector{Symbol}
-

Get EXAC2 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::EXAC2) -> Vector{StateTypes}
-

Get EXAC2 states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::EXAC2, val) -> Any
-

Set EXAC2 E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::EXAC2, val) -> Any
-

Set EXAC2 Ka.

source
PowerSystems.set_Kb! — Method
set_Kb!(value::EXAC2, val) -> Any
-

Set EXAC2 Kb.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::EXAC2, val) -> Any
-

Set EXAC2 Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::EXAC2, val) -> Any
-

Set EXAC2 Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::EXAC2, val) -> Any
-

Set EXAC2 Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::EXAC2, val) -> Any
-

Set EXAC2 Kf.

source
PowerSystems.set_Kh! — Method
set_Kh!(value::EXAC2, val) -> Any
-

Set EXAC2 Kh.

source
PowerSystems.set_Kl! — Method
set_Kl!(value::EXAC2, val) -> Any
-

Set EXAC2 Kl.

source
PowerSystems.set_Se! — Method
set_Se!(value::EXAC2, val) -> Any
-

Set EXAC2 Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::EXAC2, val) -> Any
-

Set EXAC2 Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::EXAC2, val) -> Any
-

Set EXAC2 Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::EXAC2, val) -> Any
-

Set EXAC2 Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::EXAC2, val) -> Any
-

Set EXAC2 Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::EXAC2, val) -> Any
-

Set EXAC2 Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::EXAC2, val) -> Any
-

Set EXAC2 Tr.

source
PowerSystems.set_V_lr! — Method
set_V_lr!(value::EXAC2, val) -> Any
-

Set EXAC2 V_lr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::EXAC2, val) -> Any
-

Set EXAC2 V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::EXAC2, val) -> Any
-

Set EXAC2 Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::EXAC2, val) -> Any
-

Set EXAC2 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::EXAC2, val) -> Any
-

Set EXAC2 ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::EXAC2, val) -> Any
-

Set EXAC2 saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::EXAC2, val) -> Any
-

Set EXAC2 states_types.

source

EXPIC1

PowerSystems.EXPIC1 — Type
mutable struct EXPIC1 <: AVR
+

Get EXAC2 saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::EXAC2) -> Vector{Symbol}
+

Get EXAC2 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::EXAC2) -> Vector{StateTypes}
+

Get EXAC2 states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::EXAC2, val) -> Any
+

Set EXAC2 E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::EXAC2, val) -> Any
+

Set EXAC2 Ka.

source
PowerSystems.set_Kb! — Method
set_Kb!(value::EXAC2, val) -> Any
+

Set EXAC2 Kb.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::EXAC2, val) -> Any
+

Set EXAC2 Kc.

source
PowerSystems.set_Kd! — Method
set_Kd!(value::EXAC2, val) -> Any
+

Set EXAC2 Kd.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::EXAC2, val) -> Any
+

Set EXAC2 Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::EXAC2, val) -> Any
+

Set EXAC2 Kf.

source
PowerSystems.set_Kh! — Method
set_Kh!(value::EXAC2, val) -> Any
+

Set EXAC2 Kh.

source
PowerSystems.set_Kl! — Method
set_Kl!(value::EXAC2, val) -> Any
+

Set EXAC2 Kl.

source
PowerSystems.set_Se! — Method
set_Se!(value::EXAC2, val) -> Any
+

Set EXAC2 Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::EXAC2, val) -> Any
+

Set EXAC2 Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::EXAC2, val) -> Any
+

Set EXAC2 Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::EXAC2, val) -> Any
+

Set EXAC2 Tc.

source
PowerSystems.set_Te! — Method
set_Te!(value::EXAC2, val) -> Any
+

Set EXAC2 Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::EXAC2, val) -> Any
+

Set EXAC2 Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::EXAC2, val) -> Any
+

Set EXAC2 Tr.

source
PowerSystems.set_V_lr! — Method
set_V_lr!(value::EXAC2, val) -> Any
+

Set EXAC2 V_lr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::EXAC2, val) -> Any
+

Set EXAC2 V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::EXAC2, val) -> Any
+

Set EXAC2 Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::EXAC2, val) -> Any
+

Set EXAC2 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::EXAC2, val) -> Any
+

Set EXAC2 ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::EXAC2, val) -> Any
+

Set EXAC2 saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::EXAC2, val) -> Any
+

Set EXAC2 states_types.

source

EXPIC1

PowerSystems.EXPIC1 — Type
mutable struct EXPIC1 <: AVR
     Tr::Float64
     Ka::Float64
     Ta::Float64
@@ -827,63 +827,63 @@
 Vr2: Third regulator lead-lag state 
 Vf: Exciter output 
 Vr3: First feedback integrator,
-Vr4: second feedback integrator
  • n_states::Int: (Do not modify.) EXPIC1 has 6 states
  • states_types::Vector{StateTypes}: (Do not modify.) EXPIC has 6 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::EXPIC1) -> Tuple{Float64, Float64}
-

Get EXPIC1 E_sat.

source
PowerSystems.get_Efd_lim — Method
get_Efd_lim(
+Vr4: second feedback integrator
  • n_states::Int: (Do not modify.) EXPIC1 has 6 states
  • states_types::Vector{StateTypes}: (Do not modify.) EXPIC has 6 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::EXPIC1) -> Tuple{Float64, Float64}
+

Get EXPIC1 E_sat.

source
PowerSystems.get_Efd_lim — Method
get_Efd_lim(
     value::EXPIC1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXPIC1 Efd_lim.

source
PowerSystems.get_Ka — Method
get_Ka(value::EXPIC1) -> Float64
-

Get EXPIC1 Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::EXPIC1) -> Float64
-

Get EXPIC1 Kc.

source
PowerSystems.get_Ke — Method
get_Ke(value::EXPIC1) -> Float64
-

Get EXPIC1 Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::EXPIC1) -> Float64
-

Get EXPIC1 Kf.

source
PowerSystems.get_Ki — Method
get_Ki(value::EXPIC1) -> Float64
-

Get EXPIC1 Ki.

source
PowerSystems.get_Kp — Method
get_Kp(value::EXPIC1) -> Float64
-

Get EXPIC1 Kp.

source
PowerSystems.get_Se — Method
get_Se(value::EXPIC1) -> Tuple{Float64, Float64}
-

Get EXPIC1 Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::EXPIC1) -> Float64
-

Get EXPIC1 Ta.

source
PowerSystems.get_Ta_2 — Method
get_Ta_2(value::EXPIC1) -> Float64
-

Get EXPIC1 Ta_2.

source
PowerSystems.get_Ta_3 — Method
get_Ta_3(value::EXPIC1) -> Float64
-

Get EXPIC1 Ta_3.

source
PowerSystems.get_Ta_4 — Method
get_Ta_4(value::EXPIC1) -> Float64
-

Get EXPIC1 Ta_4.

source
PowerSystems.get_Te — Method
get_Te(value::EXPIC1) -> Float64
-

Get EXPIC1 Te.

source
PowerSystems.get_Tf_1 — Method
get_Tf_1(value::EXPIC1) -> Float64
-

Get EXPIC1 Tf_1.

source
PowerSystems.get_Tf_2 — Method
get_Tf_2(value::EXPIC1) -> Float64
-

Get EXPIC1 Tf_2.

source
PowerSystems.get_Tr — Method
get_Tr(value::EXPIC1) -> Float64
-

Get EXPIC1 Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::EXPIC1) -> Float64
-

Get EXPIC1 V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+

Get EXPIC1 Efd_lim.

source
PowerSystems.get_Ka — Method
get_Ka(value::EXPIC1) -> Float64
+

Get EXPIC1 Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::EXPIC1) -> Float64
+

Get EXPIC1 Kc.

source
PowerSystems.get_Ke — Method
get_Ke(value::EXPIC1) -> Float64
+

Get EXPIC1 Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::EXPIC1) -> Float64
+

Get EXPIC1 Kf.

source
PowerSystems.get_Ki — Method
get_Ki(value::EXPIC1) -> Float64
+

Get EXPIC1 Ki.

source
PowerSystems.get_Kp — Method
get_Kp(value::EXPIC1) -> Float64
+

Get EXPIC1 Kp.

source
PowerSystems.get_Se — Method
get_Se(value::EXPIC1) -> Tuple{Float64, Float64}
+

Get EXPIC1 Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::EXPIC1) -> Float64
+

Get EXPIC1 Ta.

source
PowerSystems.get_Ta_2 — Method
get_Ta_2(value::EXPIC1) -> Float64
+

Get EXPIC1 Ta_2.

source
PowerSystems.get_Ta_3 — Method
get_Ta_3(value::EXPIC1) -> Float64
+

Get EXPIC1 Ta_3.

source
PowerSystems.get_Ta_4 — Method
get_Ta_4(value::EXPIC1) -> Float64
+

Get EXPIC1 Ta_4.

source
PowerSystems.get_Te — Method
get_Te(value::EXPIC1) -> Float64
+

Get EXPIC1 Te.

source
PowerSystems.get_Tf_1 — Method
get_Tf_1(value::EXPIC1) -> Float64
+

Get EXPIC1 Tf_1.

source
PowerSystems.get_Tf_2 — Method
get_Tf_2(value::EXPIC1) -> Float64
+

Get EXPIC1 Tf_2.

source
PowerSystems.get_Tr — Method
get_Tr(value::EXPIC1) -> Float64
+

Get EXPIC1 Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::EXPIC1) -> Float64
+

Get EXPIC1 V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
     value::EXPIC1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXPIC1 Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get EXPIC1 Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::EXPIC1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXPIC1 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::EXPIC1) -> Dict{String, Any}
-

Get EXPIC1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::EXPIC1) -> Int64
-

Get EXPIC1 n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get EXPIC1 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::EXPIC1) -> Dict{String, Any}
+

Get EXPIC1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::EXPIC1) -> Int64
+

Get EXPIC1 n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::EXPIC1
 ) -> Tuple{Float64, Float64}
-

Get EXPIC1 saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::EXPIC1) -> Vector{Symbol}
-

Get EXPIC1 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::EXPIC1) -> Vector{StateTypes}
-

Get EXPIC1 states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::EXPIC1, val) -> Any
-

Set EXPIC1 E_sat.

source
PowerSystems.set_Efd_lim! — Method
set_Efd_lim!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Efd_lim.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Kc.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Kf.

source
PowerSystems.set_Ki! — Method
set_Ki!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Ki.

source
PowerSystems.set_Kp! — Method
set_Kp!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Kp.

source
PowerSystems.set_Se! — Method
set_Se!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Ta.

source
PowerSystems.set_Ta_2! — Method
set_Ta_2!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Ta_2.

source
PowerSystems.set_Ta_3! — Method
set_Ta_3!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Ta_3.

source
PowerSystems.set_Ta_4! — Method
set_Ta_4!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Ta_4.

source
PowerSystems.set_Te! — Method
set_Te!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Te.

source
PowerSystems.set_Tf_1! — Method
set_Tf_1!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Tf_1.

source
PowerSystems.set_Tf_2! — Method
set_Tf_2!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Tf_2.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::EXPIC1, val) -> Any
-

Set EXPIC1 V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::EXPIC1, val) -> Any
-

Set EXPIC1 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::EXPIC1, val) -> Any
-

Set EXPIC1 ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::EXPIC1, val) -> Any
-

Set EXPIC1 saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::EXPIC1, val) -> Any
-

Set EXPIC1 states_types.

source

IEEET1

PowerSystems.IEEET1 — Type
mutable struct IEEET1 <: AVR
+

Get EXPIC1 saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::EXPIC1) -> Vector{Symbol}
+

Get EXPIC1 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::EXPIC1) -> Vector{StateTypes}
+

Get EXPIC1 states_types.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::EXPIC1, val) -> Any
+

Set EXPIC1 E_sat.

source
PowerSystems.set_Efd_lim! — Method
set_Efd_lim!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Efd_lim.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Kc.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Kf.

source
PowerSystems.set_Ki! — Method
set_Ki!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Ki.

source
PowerSystems.set_Kp! — Method
set_Kp!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Kp.

source
PowerSystems.set_Se! — Method
set_Se!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Ta.

source
PowerSystems.set_Ta_2! — Method
set_Ta_2!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Ta_2.

source
PowerSystems.set_Ta_3! — Method
set_Ta_3!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Ta_3.

source
PowerSystems.set_Ta_4! — Method
set_Ta_4!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Ta_4.

source
PowerSystems.set_Te! — Method
set_Te!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Te.

source
PowerSystems.set_Tf_1! — Method
set_Tf_1!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Tf_1.

source
PowerSystems.set_Tf_2! — Method
set_Tf_2!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Tf_2.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::EXPIC1, val) -> Any
+

Set EXPIC1 V_ref.

source
PowerSystems.set_Va_lim! — Method
set_Va_lim!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Va_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::EXPIC1, val) -> Any
+

Set EXPIC1 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::EXPIC1, val) -> Any
+

Set EXPIC1 ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::EXPIC1, val) -> Any
+

Set EXPIC1 saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::EXPIC1, val) -> Any
+

Set EXPIC1 states_types.

source

IEEET1

PowerSystems.IEEET1 — Type
mutable struct IEEET1 <: AVR
     Tr::Float64
     Ka::Float64
     Ta::Float64
@@ -905,107 +905,107 @@
 end

1968 IEEE type 1 excitation system model

Arguments

  • Tr::Float64: Voltage Measurement Time Constant in s, validation range: (0, 0.5)
  • Ka::Float64: Amplifier Gain, validation range: (10, 500)
  • Ta::Float64: Amplifier Time Constant in s, validation range: (0, 1)
  • Vr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)
  • Ke::Float64: Exciter constant related to self-excited field, validation range: (-1, 1)
  • Te::Float64: Exciter time constant, integration rate associated with exciter control, validation range: (eps(), 1)
  • Kf::Float64: Excitation control system stabilizer gain, validation range: (eps(), 0.3)
  • Tf::Float64: Excitation control system stabilizer time constant. Appropiate Data: 5 <= Tf/Kf <= 15, validation range: (eps(), nothing)
  • switch::Int: Switch, validation range: (0, 1)
  • E_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)
  • Se::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • saturation_coeffs::Tuple{Float64, Float64}: (default: PowerSystems.get_avr_saturation(E_sat, Se)) (Do not modify.) Coefficients (A,B) of the function: Se(V) = B(V - A)^2/V
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vt: Terminal Voltage,
 Vr: Regulator Output,
 Vf: Exciter Output, 
-Vr3: Rate feedback integrator
  • n_states::Int: (Do not modify.) The IEEET1 has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEET1 I has 4 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::IEEET1) -> Tuple{Float64, Float64}
-

Get IEEET1 E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::IEEET1) -> Float64
-

Get IEEET1 Ka.

source
PowerSystems.get_Ke — Method
get_Ke(value::IEEET1) -> Float64
-

Get IEEET1 Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::IEEET1) -> Float64
-

Get IEEET1 Kf.

source
PowerSystems.get_Se — Method
get_Se(value::IEEET1) -> Tuple{Float64, Float64}
-

Get IEEET1 Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::IEEET1) -> Float64
-

Get IEEET1 Ta.

source
PowerSystems.get_Te — Method
get_Te(value::IEEET1) -> Float64
-

Get IEEET1 Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::IEEET1) -> Float64
-

Get IEEET1 Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::IEEET1) -> Float64
-

Get IEEET1 Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::IEEET1) -> Float64
-

Get IEEET1 V_ref.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+Vr3: Rate feedback integrator
  • n_states::Int: (Do not modify.) The IEEET1 has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEET1 I has 4 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::IEEET1) -> Tuple{Float64, Float64}
+

Get IEEET1 E_sat.

source
PowerSystems.get_Ka — Method
get_Ka(value::IEEET1) -> Float64
+

Get IEEET1 Ka.

source
PowerSystems.get_Ke — Method
get_Ke(value::IEEET1) -> Float64
+

Get IEEET1 Ke.

source
PowerSystems.get_Kf — Method
get_Kf(value::IEEET1) -> Float64
+

Get IEEET1 Kf.

source
PowerSystems.get_Se — Method
get_Se(value::IEEET1) -> Tuple{Float64, Float64}
+

Get IEEET1 Se.

source
PowerSystems.get_Ta — Method
get_Ta(value::IEEET1) -> Float64
+

Get IEEET1 Ta.

source
PowerSystems.get_Te — Method
get_Te(value::IEEET1) -> Float64
+

Get IEEET1 Te.

source
PowerSystems.get_Tf — Method
get_Tf(value::IEEET1) -> Float64
+

Get IEEET1 Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::IEEET1) -> Float64
+

Get IEEET1 Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::IEEET1) -> Float64
+

Get IEEET1 V_ref.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::IEEET1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get IEEET1 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::IEEET1) -> Dict{String, Any}
-

Get IEEET1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::IEEET1) -> Int64
-

Get IEEET1 n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get IEEET1 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::IEEET1) -> Dict{String, Any}
+

Get IEEET1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::IEEET1) -> Int64
+

Get IEEET1 n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
     value::IEEET1
 ) -> Tuple{Float64, Float64}
-

Get IEEET1 saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::IEEET1) -> Vector{Symbol}
-

Get IEEET1 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::IEEET1) -> Vector{StateTypes}
-

Get IEEET1 states_types.

source
PowerSystems.get_switch — Method
get_switch(value::IEEET1) -> Int64
-

Get IEEET1 switch.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::IEEET1, val) -> Any
-

Set IEEET1 E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::IEEET1, val) -> Any
-

Set IEEET1 Ka.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::IEEET1, val) -> Any
-

Set IEEET1 Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::IEEET1, val) -> Any
-

Set IEEET1 Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::IEEET1, val) -> Any
-

Set IEEET1 Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::IEEET1, val) -> Any
-

Set IEEET1 Ta.

source
PowerSystems.set_Te! — Method
set_Te!(value::IEEET1, val) -> Any
-

Set IEEET1 Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::IEEET1, val) -> Any
-

Set IEEET1 Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::IEEET1, val) -> Any
-

Set IEEET1 Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::IEEET1, val) -> Any
-

Set IEEET1 V_ref.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::IEEET1, val) -> Any
-

Set IEEET1 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::IEEET1, val) -> Any
-

Set IEEET1 ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::IEEET1, val) -> Any
-

Set IEEET1 saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::IEEET1, val) -> Any
-

Set IEEET1 states_types.

source
PowerSystems.set_switch! — Method
set_switch!(value::IEEET1, val) -> Any
-

Set IEEET1 switch.

source

EX4VSA

PowerSystems.get_E_lim — Method
get_E_lim(
+

Get IEEET1 saturation_coeffs.

source
PowerSystems.get_states — Method
get_states(value::IEEET1) -> Vector{Symbol}
+

Get IEEET1 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::IEEET1) -> Vector{StateTypes}
+

Get IEEET1 states_types.

source
PowerSystems.get_switch — Method
get_switch(value::IEEET1) -> Int64
+

Get IEEET1 switch.

source
PowerSystems.set_E_sat! — Method
set_E_sat!(value::IEEET1, val) -> Any
+

Set IEEET1 E_sat.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::IEEET1, val) -> Any
+

Set IEEET1 Ka.

source
PowerSystems.set_Ke! — Method
set_Ke!(value::IEEET1, val) -> Any
+

Set IEEET1 Ke.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::IEEET1, val) -> Any
+

Set IEEET1 Kf.

source
PowerSystems.set_Se! — Method
set_Se!(value::IEEET1, val) -> Any
+

Set IEEET1 Se.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::IEEET1, val) -> Any
+

Set IEEET1 Ta.

source
PowerSystems.set_Te! — Method
set_Te!(value::IEEET1, val) -> Any
+

Set IEEET1 Te.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::IEEET1, val) -> Any
+

Set IEEET1 Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::IEEET1, val) -> Any
+

Set IEEET1 Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::IEEET1, val) -> Any
+

Set IEEET1 V_ref.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::IEEET1, val) -> Any
+

Set IEEET1 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::IEEET1, val) -> Any
+

Set IEEET1 ext.

source
PowerSystems.set_saturation_coeffs! — Method
set_saturation_coeffs!(value::IEEET1, val) -> Any
+

Set IEEET1 saturation_coeffs.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::IEEET1, val) -> Any
+

Set IEEET1 states_types.

source
PowerSystems.set_switch! — Method
set_switch!(value::IEEET1, val) -> Any
+

Set IEEET1 switch.

source

EX4VSA

PowerSystems.get_E_lim — Method
get_E_lim(
     value::PowerSystems.EX4VSA
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EX4VSA E_lim.

source
PowerSystems.get_G — Method
get_G(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA G.

source
PowerSystems.get_Iflim — Method
get_Iflim(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA Iflim.

source
PowerSystems.get_K1 — Method
get_K1(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA K1.

source
PowerSystems.get_K2 — Method
get_K2(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA K2.

source
PowerSystems.get_Oel_lim — Method
get_Oel_lim(
+

Get EX4VSA E_lim.

source
PowerSystems.get_G — Method
get_G(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA G.

source
PowerSystems.get_Iflim — Method
get_Iflim(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA Iflim.

source
PowerSystems.get_K1 — Method
get_K1(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA K1.

source
PowerSystems.get_K2 — Method
get_K2(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA K2.

source
PowerSystems.get_Oel_lim — Method
get_Oel_lim(
     value::PowerSystems.EX4VSA
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EX4VSA Oel_lim.

source
PowerSystems.get_Spar — Method
get_Spar(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA Spar.

source
PowerSystems.get_Ta — Method
get_Ta(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA Tb.

source
PowerSystems.get_Te — Method
get_Te(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA Te.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA V_ref.

source
PowerSystems.get_d — Method
get_d(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA d.

source
PowerSystems.get_ext — Method
get_ext(value::PowerSystems.EX4VSA) -> Dict{String, Any}
-

Get EX4VSA ext.

source
PowerSystems.get_f — Method
get_f(value::PowerSystems.EX4VSA) -> Float64
-

Get EX4VSA f.

source
PowerSystems.get_n_states — Method
get_n_states(value::PowerSystems.EX4VSA) -> Int64
-

Get EX4VSA n_states.

source
PowerSystems.get_states — Method
get_states(value::PowerSystems.EX4VSA) -> Vector{Symbol}
-

Get EX4VSA states.

source
PowerSystems.set_E_lim! — Method
set_E_lim!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA E_lim.

source
PowerSystems.set_G! — Method
set_G!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA G.

source
PowerSystems.set_Iflim! — Method
set_Iflim!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA Iflim.

source
PowerSystems.set_K1! — Method
set_K1!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA K1.

source
PowerSystems.set_K2! — Method
set_K2!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA K2.

source
PowerSystems.set_Oel_lim! — Method
set_Oel_lim!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA Oel_lim.

source
PowerSystems.set_Spar! — Method
set_Spar!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA Spar.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA Tb.

source
PowerSystems.set_Te! — Method
set_Te!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA Te.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA V_ref.

source
PowerSystems.set_d! — Method
set_d!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA d.

source
PowerSystems.set_ext! — Method
set_ext!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA ext.

source
PowerSystems.set_f! — Method
set_f!(value::PowerSystems.EX4VSA, val) -> Any
-

Set EX4VSA f.

source

EXST1

PowerSystems.get_Ka — Method
get_Ka(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 Kc.

source
PowerSystems.get_Kf — Method
get_Kf(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 Kf.

source
PowerSystems.get_Ta — Method
get_Ta(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 Tc.

source
PowerSystems.get_Tf — Method
get_Tf(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::PowerSystems.EXST1) -> Float64
-

Get EXST1 V_ref.

source
PowerSystems.get_Vi_lim — Method
get_Vi_lim(
+

Get EX4VSA Oel_lim.

source
PowerSystems.get_Spar — Method
get_Spar(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA Spar.

source
PowerSystems.get_Ta — Method
get_Ta(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA Tb.

source
PowerSystems.get_Te — Method
get_Te(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA Te.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA V_ref.

source
PowerSystems.get_d — Method
get_d(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA d.

source
PowerSystems.get_ext — Method
get_ext(value::PowerSystems.EX4VSA) -> Dict{String, Any}
+

Get EX4VSA ext.

source
PowerSystems.get_f — Method
get_f(value::PowerSystems.EX4VSA) -> Float64
+

Get EX4VSA f.

source
PowerSystems.get_n_states — Method
get_n_states(value::PowerSystems.EX4VSA) -> Int64
+

Get EX4VSA n_states.

source
PowerSystems.get_states — Method
get_states(value::PowerSystems.EX4VSA) -> Vector{Symbol}
+

Get EX4VSA states.

source
PowerSystems.set_E_lim! — Method
set_E_lim!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA E_lim.

source
PowerSystems.set_G! — Method
set_G!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA G.

source
PowerSystems.set_Iflim! — Method
set_Iflim!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA Iflim.

source
PowerSystems.set_K1! — Method
set_K1!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA K1.

source
PowerSystems.set_K2! — Method
set_K2!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA K2.

source
PowerSystems.set_Oel_lim! — Method
set_Oel_lim!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA Oel_lim.

source
PowerSystems.set_Spar! — Method
set_Spar!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA Spar.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA Tb.

source
PowerSystems.set_Te! — Method
set_Te!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA Te.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA V_ref.

source
PowerSystems.set_d! — Method
set_d!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA d.

source
PowerSystems.set_ext! — Method
set_ext!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA ext.

source
PowerSystems.set_f! — Method
set_f!(value::PowerSystems.EX4VSA, val) -> Any
+

Set EX4VSA f.

source

EXST1

PowerSystems.get_Ka — Method
get_Ka(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 Ka.

source
PowerSystems.get_Kc — Method
get_Kc(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 Kc.

source
PowerSystems.get_Kf — Method
get_Kf(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 Kf.

source
PowerSystems.get_Ta — Method
get_Ta(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 Tc.

source
PowerSystems.get_Tf — Method
get_Tf(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 Tf.

source
PowerSystems.get_Tr — Method
get_Tr(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 Tr.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::PowerSystems.EXST1) -> Float64
+

Get EXST1 V_ref.

source
PowerSystems.get_Vi_lim — Method
get_Vi_lim(
     value::PowerSystems.EXST1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXST1 Vi_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get EXST1 Vi_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
     value::PowerSystems.EXST1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EXST1 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::PowerSystems.EXST1) -> Dict{String, Any}
-

Get EXST1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::PowerSystems.EXST1) -> Int64
-

Get EXST1 n_states.

source
PowerSystems.get_states — Method
get_states(value::PowerSystems.EXST1) -> Vector{Symbol}
-

Get EXST1 states.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Kc.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Kf.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Tc.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 V_ref.

source
PowerSystems.set_Vi_lim! — Method
set_Vi_lim!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Vi_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::PowerSystems.EXST1, val) -> Any
-

Set EXST1 ext.

source

SCRX

PowerSystems.SCRX — Type
mutable struct SCRX <: AVR
+

Get EXST1 Vr_lim.

source
PowerSystems.get_ext — Method
get_ext(value::PowerSystems.EXST1) -> Dict{String, Any}
+

Get EXST1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::PowerSystems.EXST1) -> Int64
+

Get EXST1 n_states.

source
PowerSystems.get_states — Method
get_states(value::PowerSystems.EXST1) -> Vector{Symbol}
+

Get EXST1 states.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Ka.

source
PowerSystems.set_Kc! — Method
set_Kc!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Kc.

source
PowerSystems.set_Kf! — Method
set_Kf!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Kf.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Tc.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Tf.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Tr.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 V_ref.

source
PowerSystems.set_Vi_lim! — Method
set_Vi_lim!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Vi_lim.

source
PowerSystems.set_Vr_lim! — Method
set_Vr_lim!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 Vr_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::PowerSystems.EXST1, val) -> Any
+

Set EXST1 ext.

source

SCRX

PowerSystems.SCRX — Type
mutable struct SCRX <: AVR
     Ta_Tb::Float64
     Tb::Float64
     K::Float64
@@ -1020,31 +1020,31 @@
     states_types::Vector{StateTypes}
     internal::InfrastructureSystemsInternal
 end

This exciter is based on an IEEE type SCRX solid state exciter. The output field voltage is varied by a control system to maintain the system voltage at Vref. Please note that this exciter model has no initialization capabilities - this means that it will respond to whatever inputs it receives regardless of the state of the machine model

Arguments

  • Ta_Tb::Float64: Lead input constant ratio, validation range: (0.05, 0.3)
  • Tb::Float64: Lag input constant in s, validation range: (5, 20)
  • K::Float64: Regulator Gain, validation range: (20, 100)
  • Te::Float64: Regulator Time Constant, validation range: (0, 1)
  • Efd_lim::MinMax: Field Voltage regulator limits (regulator output) (Efdmin, Efdmax)
  • switch::Int: Switch, validation range: (0, 1)
  • rc_rfd::Float64: Field current capability. Set = 0 for negative current capability. Typical value 10, validation range: (0, 10)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vr1: First integrator,
-Vr2: Second integrator
  • n_states::Int: (Do not modify.) SCRX has 2 states
  • states_types::Vector{StateTypes}: (Do not modify.) SCRX has 2 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Efd_lim — Method
get_Efd_lim(
+Vr2: Second integrator
  • n_states::Int: (Do not modify.) SCRX has 2 states
  • states_types::Vector{StateTypes}: (Do not modify.) SCRX has 2 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Efd_lim — Method
get_Efd_lim(
     value::SCRX
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get SCRX Efd_lim.

source
PowerSystems.get_K — Method
get_K(value::SCRX) -> Float64
-

Get SCRX K.

source
PowerSystems.get_Ta_Tb — Method
get_Ta_Tb(value::SCRX) -> Float64
-

Get SCRX Ta_Tb.

source
PowerSystems.get_Tb — Method
get_Tb(value::SCRX) -> Float64
-

Get SCRX Tb.

source
PowerSystems.get_Te — Method
get_Te(value::SCRX) -> Float64
-

Get SCRX Te.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::SCRX) -> Float64
-

Get SCRX V_ref.

source
PowerSystems.get_ext — Method
get_ext(value::SCRX) -> Dict{String, Any}
-

Get SCRX ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SCRX) -> Int64
-

Get SCRX n_states.

source
PowerSystems.get_rc_rfd — Method
get_rc_rfd(value::SCRX) -> Float64
-

Get SCRX rc_rfd.

source
PowerSystems.get_states — Method
get_states(value::SCRX) -> Vector{Symbol}
-

Get SCRX states.

source
PowerSystems.get_states_types — Method
get_states_types(value::SCRX) -> Vector{StateTypes}
-

Get SCRX states_types.

source
PowerSystems.get_switch — Method
get_switch(value::SCRX) -> Int64
-

Get SCRX switch.

source
PowerSystems.set_Efd_lim! — Method
set_Efd_lim!(value::SCRX, val) -> Any
-

Set SCRX Efd_lim.

source
PowerSystems.set_K! — Method
set_K!(value::SCRX, val) -> Any
-

Set SCRX K.

source
PowerSystems.set_Ta_Tb! — Method
set_Ta_Tb!(value::SCRX, val) -> Any
-

Set SCRX Ta_Tb.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::SCRX, val) -> Any
-

Set SCRX Tb.

source
PowerSystems.set_Te! — Method
set_Te!(value::SCRX, val) -> Any
-

Set SCRX Te.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::SCRX, val) -> Any
-

Set SCRX V_ref.

source
PowerSystems.set_ext! — Method
set_ext!(value::SCRX, val) -> Any
-

Set SCRX ext.

source
PowerSystems.set_rc_rfd! — Method
set_rc_rfd!(value::SCRX, val) -> Any
-

Set SCRX rc_rfd.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::SCRX, val) -> Any
-

Set SCRX states_types.

source
PowerSystems.set_switch! — Method
set_switch!(value::SCRX, val) -> Any
-

Set SCRX switch.

source

SEXS

PowerSystems.SEXS — Type
mutable struct SEXS <: AVR
+

Get SCRX Efd_lim.

source
PowerSystems.get_K — Method
get_K(value::SCRX) -> Float64
+

Get SCRX K.

source
PowerSystems.get_Ta_Tb — Method
get_Ta_Tb(value::SCRX) -> Float64
+

Get SCRX Ta_Tb.

source
PowerSystems.get_Tb — Method
get_Tb(value::SCRX) -> Float64
+

Get SCRX Tb.

source
PowerSystems.get_Te — Method
get_Te(value::SCRX) -> Float64
+

Get SCRX Te.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::SCRX) -> Float64
+

Get SCRX V_ref.

source
PowerSystems.get_ext — Method
get_ext(value::SCRX) -> Dict{String, Any}
+

Get SCRX ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SCRX) -> Int64
+

Get SCRX n_states.

source
PowerSystems.get_rc_rfd — Method
get_rc_rfd(value::SCRX) -> Float64
+

Get SCRX rc_rfd.

source
PowerSystems.get_states — Method
get_states(value::SCRX) -> Vector{Symbol}
+

Get SCRX states.

source
PowerSystems.get_states_types — Method
get_states_types(value::SCRX) -> Vector{StateTypes}
+

Get SCRX states_types.

source
PowerSystems.get_switch — Method
get_switch(value::SCRX) -> Int64
+

Get SCRX switch.

source
PowerSystems.set_Efd_lim! — Method
set_Efd_lim!(value::SCRX, val) -> Any
+

Set SCRX Efd_lim.

source
PowerSystems.set_K! — Method
set_K!(value::SCRX, val) -> Any
+

Set SCRX K.

source
PowerSystems.set_Ta_Tb! — Method
set_Ta_Tb!(value::SCRX, val) -> Any
+

Set SCRX Ta_Tb.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::SCRX, val) -> Any
+

Set SCRX Tb.

source
PowerSystems.set_Te! — Method
set_Te!(value::SCRX, val) -> Any
+

Set SCRX Te.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::SCRX, val) -> Any
+

Set SCRX V_ref.

source
PowerSystems.set_ext! — Method
set_ext!(value::SCRX, val) -> Any
+

Set SCRX ext.

source
PowerSystems.set_rc_rfd! — Method
set_rc_rfd!(value::SCRX, val) -> Any
+

Set SCRX rc_rfd.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::SCRX, val) -> Any
+

Set SCRX states_types.

source
PowerSystems.set_switch! — Method
set_switch!(value::SCRX, val) -> Any
+

Set SCRX switch.

source

SEXS

PowerSystems.SEXS — Type
mutable struct SEXS <: AVR
     Ta_Tb::Float64
     Tb::Float64
     K::Float64
@@ -1056,24 +1056,24 @@
     n_states::Int
     states_types::Vector{StateTypes}
     internal::InfrastructureSystemsInternal
-end

Parameters of Simplified Excitation System Model - SEXS in PSSE

Arguments

  • Ta_Tb::Float64: Ratio of lead and lag time constants, validation range: (0, nothing)
  • Tb::Float64: Lag time constant, validation range: (eps(), nothing)
  • K::Float64: Gain, validation range: (0, nothing)
  • Te::Float64: Field circuit time constant in s, validation range: (0, nothing)
  • V_lim::MinMax: Field voltage limits
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are: Vf: Voltage field, Vr: Lead-lag state
  • n_states::Int: (Do not modify.) SEXS has 2 states
  • states_types::Vector{StateTypes}: (Do not modify.) SEXS has 2 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K — Method
get_K(value::SEXS) -> Float64
-

Get SEXS K.

source
PowerSystems.get_Ta_Tb — Method
get_Ta_Tb(value::SEXS) -> Float64
-

Get SEXS Ta_Tb.

source
PowerSystems.get_Tb — Method
get_Tb(value::SEXS) -> Float64
-

Get SEXS Tb.

source
PowerSystems.get_Te — Method
get_Te(value::SEXS) -> Float64
-

Get SEXS Te.

source
PowerSystems.get_V_lim — Method
get_V_lim(
+end

Parameters of Simplified Excitation System Model - SEXS in PSSE

Arguments

  • Ta_Tb::Float64: Ratio of lead and lag time constants, validation range: (0, nothing)
  • Tb::Float64: Lag time constant, validation range: (eps(), nothing)
  • K::Float64: Gain, validation range: (0, nothing)
  • Te::Float64: Field circuit time constant in s, validation range: (0, nothing)
  • V_lim::MinMax: Field voltage limits
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are: Vf: Voltage field, Vr: Lead-lag state
  • n_states::Int: (Do not modify.) SEXS has 2 states
  • states_types::Vector{StateTypes}: (Do not modify.) SEXS has 2 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K — Method
get_K(value::SEXS) -> Float64
+

Get SEXS K.

source
PowerSystems.get_Ta_Tb — Method
get_Ta_Tb(value::SEXS) -> Float64
+

Get SEXS Ta_Tb.

source
PowerSystems.get_Tb — Method
get_Tb(value::SEXS) -> Float64
+

Get SEXS Tb.

source
PowerSystems.get_Te — Method
get_Te(value::SEXS) -> Float64
+

Get SEXS Te.

source
PowerSystems.get_V_lim — Method
get_V_lim(
     value::SEXS
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get SEXS V_lim.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::SEXS) -> Float64
-

Get SEXS V_ref.

source
PowerSystems.get_ext — Method
get_ext(value::SEXS) -> Dict{String, Any}
-

Get SEXS ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SEXS) -> Int64
-

Get SEXS n_states.

source
PowerSystems.get_states — Method
get_states(value::SEXS) -> Vector{Symbol}
-

Get SEXS states.

source
PowerSystems.get_states_types — Method
get_states_types(value::SEXS) -> Vector{StateTypes}
-

Get SEXS states_types.

source
PowerSystems.set_K! — Method
set_K!(value::SEXS, val) -> Any
-

Set SEXS K.

source
PowerSystems.set_Ta_Tb! — Method
set_Ta_Tb!(value::SEXS, val) -> Any
-

Set SEXS Ta_Tb.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::SEXS, val) -> Any
-

Set SEXS Tb.

source
PowerSystems.set_Te! — Method
set_Te!(value::SEXS, val) -> Any
-

Set SEXS Te.

source
PowerSystems.set_V_lim! — Method
set_V_lim!(value::SEXS, val) -> Any
-

Set SEXS V_lim.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::SEXS, val) -> Any
-

Set SEXS V_ref.

source
PowerSystems.set_ext! — Method
set_ext!(value::SEXS, val) -> Any
-

Set SEXS ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::SEXS, val) -> Any
-

Set SEXS states_types.

source
+

Get SEXS V_lim.

source
PowerSystems.get_V_ref — Method
get_V_ref(value::SEXS) -> Float64
+

Get SEXS V_ref.

source
PowerSystems.get_ext — Method
get_ext(value::SEXS) -> Dict{String, Any}
+

Get SEXS ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SEXS) -> Int64
+

Get SEXS n_states.

source
PowerSystems.get_states — Method
get_states(value::SEXS) -> Vector{Symbol}
+

Get SEXS states.

source
PowerSystems.get_states_types — Method
get_states_types(value::SEXS) -> Vector{StateTypes}
+

Get SEXS states_types.

source
PowerSystems.set_K! — Method
set_K!(value::SEXS, val) -> Any
+

Set SEXS K.

source
PowerSystems.set_Ta_Tb! — Method
set_Ta_Tb!(value::SEXS, val) -> Any
+

Set SEXS Ta_Tb.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::SEXS, val) -> Any
+

Set SEXS Tb.

source
PowerSystems.set_Te! — Method
set_Te!(value::SEXS, val) -> Any
+

Set SEXS Te.

source
PowerSystems.set_V_lim! — Method
set_V_lim!(value::SEXS, val) -> Any
+

Set SEXS V_lim.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::SEXS, val) -> Any
+

Set SEXS V_ref.

source
PowerSystems.set_ext! — Method
set_ext!(value::SEXS, val) -> Any
+

Set SEXS ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::SEXS, val) -> Any
+

Set SEXS states_types.

source
diff --git a/dev/model_library/generated_Arc/index.html b/dev/model_library/generated_Arc/index.html index 7c89560001..a14b95406a 100644 --- a/dev/model_library/generated_Arc/index.html +++ b/dev/model_library/generated_Arc/index.html @@ -3,8 +3,8 @@ from::Bus to::Bus internal::InfrastructureSystemsInternal -end

A topological directed edge connecting two buses.

Arcs are used to define the from and to buses when defining a line or transformer

Arguments

source
PowerSystems.get_from — Method
get_from(value::Arc) -> Bus
-

Get Arc from.

source
PowerSystems.get_to — Method
get_to(value::Arc) -> Bus
-

Get Arc to.

source
PowerSystems.set_from! — Method
set_from!(value::Arc, val) -> Any
-

Set Arc from.

source
PowerSystems.set_to! — Method
set_to!(value::Arc, val) -> Any
-

Set Arc to.

source
+end

A topological directed edge connecting two buses.

Arcs are used to define the from and to buses when defining a line or transformer

Arguments

source
PowerSystems.get_from — Method
get_from(value::Arc) -> Bus
+

Get Arc from.

source
PowerSystems.get_to — Method
get_to(value::Arc) -> Bus
+

Get Arc to.

source
PowerSystems.set_from! — Method
set_from!(value::Arc, val) -> Any
+

Set Arc from.

source
PowerSystems.set_to! — Method
set_to!(value::Arc, val) -> Any
+

Set Arc to.

source
diff --git a/dev/model_library/generated_Area/index.html b/dev/model_library/generated_Area/index.html index 8e881b0901..e0521b438b 100644 --- a/dev/model_library/generated_Area/index.html +++ b/dev/model_library/generated_Area/index.html @@ -6,13 +6,13 @@ load_response::Float64 ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A collection of buses for control purposes.

The Area can be specified when defining each ACBus or DCBus in the area

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::Area) -> String
-

Get Area name.

source
PowerSystems.get_ext — Method
get_ext(value::Area) -> Dict{String, Any}
-

Get Area ext.

source
PowerSystems.get_load_response — Method
get_load_response(value::Area) -> Float64
-

Get Area load_response.

source
PowerSystems.get_peak_active_power — Method
get_peak_active_power(value::Area) -> Any
-

Get Area peak_active_power.

source
PowerSystems.get_peak_reactive_power — Method
get_peak_reactive_power(value::Area) -> Any
-

Get Area peak_reactive_power.

source
PowerSystems.set_ext! — Method
set_ext!(value::Area, val) -> Any
-

Set Area ext.

source
PowerSystems.set_load_response! — Method
set_load_response!(value::Area, val) -> Any
-

Set Area load_response.

source
PowerSystems.set_peak_active_power! — Method
set_peak_active_power!(value::Area, val) -> Any
-

Set Area peak_active_power.

source
PowerSystems.set_peak_reactive_power! — Method
set_peak_reactive_power!(value::Area, val) -> Any
-

Set Area peak_reactive_power.

source
+end

A collection of buses for control purposes.

The Area can be specified when defining each ACBus or DCBus in the area

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::Area) -> String
+

Get Area name.

source
PowerSystems.get_ext — Method
get_ext(value::Area) -> Dict{String, Any}
+

Get Area ext.

source
PowerSystems.get_load_response — Method
get_load_response(value::Area) -> Float64
+

Get Area load_response.

source
PowerSystems.get_peak_active_power — Method
get_peak_active_power(value::Area) -> Any
+

Get Area peak_active_power.

source
PowerSystems.get_peak_reactive_power — Method
get_peak_reactive_power(value::Area) -> Any
+

Get Area peak_reactive_power.

source
PowerSystems.set_ext! — Method
set_ext!(value::Area, val) -> Any
+

Set Area ext.

source
PowerSystems.set_load_response! — Method
set_load_response!(value::Area, val) -> Any
+

Set Area load_response.

source
PowerSystems.set_peak_active_power! — Method
set_peak_active_power!(value::Area, val) -> Any
+

Set Area peak_active_power.

source
PowerSystems.set_peak_reactive_power! — Method
set_peak_reactive_power!(value::Area, val) -> Any
+

Set Area peak_reactive_power.

source
diff --git a/dev/model_library/generated_AreaInterchange/index.html b/dev/model_library/generated_AreaInterchange/index.html index 3fd2a53350..a63da6888d 100644 --- a/dev/model_library/generated_AreaInterchange/index.html +++ b/dev/model_library/generated_AreaInterchange/index.html @@ -8,19 +8,19 @@ flow_limits::FromTo_ToFrom ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

Flow exchanged between Areas. This Interchange is agnostic to the lines connecting the areas. It does not substitute Interface which is the total flow across a group of lines

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::AreaInterchange) -> String
-

Get AreaInterchange name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::AreaInterchange) -> Any
-

Get AreaInterchange active_power_flow.

source
PowerSystems.get_available — Method
get_available(value::AreaInterchange) -> Bool
-

Get AreaInterchange available.

source
PowerSystems.get_ext — Method
get_ext(value::AreaInterchange) -> Dict{String, Any}
-

Get AreaInterchange ext.

source
PowerSystems.get_flow_limits — Method
get_flow_limits(
+end

Flow exchanged between Areas. This Interchange is agnostic to the lines connecting the areas. It does not substitute Interface which is the total flow across a group of lines

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • active_power_flow::Float64: Initial condition of active power flow on the line (MW)
  • from_area::Area: Area from which the power is extracted
  • to_area::Area: Area to which the power is injected
  • flow_limits::FromTo_ToFrom: Max flow between the areas. It ignores lines and other branches totals
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::AreaInterchange) -> String
+

Get AreaInterchange name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::AreaInterchange) -> Any
+

Get AreaInterchange active_power_flow.

source
PowerSystems.get_available — Method
get_available(value::AreaInterchange) -> Bool
+

Get AreaInterchange available.

source
PowerSystems.get_ext — Method
get_ext(value::AreaInterchange) -> Dict{String, Any}
+

Get AreaInterchange ext.

source
PowerSystems.get_flow_limits — Method
get_flow_limits(
     value::AreaInterchange
 ) -> NamedTuple{(:from_to, :to_from), <:Tuple{Any, Any}}
-

Get AreaInterchange flow_limits.

source
PowerSystems.get_from_area — Method
get_from_area(value::AreaInterchange) -> Area
-

Get AreaInterchange from_area.

source
PowerSystems.get_to_area — Method
get_to_area(value::AreaInterchange) -> Area
-

Get AreaInterchange to_area.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::AreaInterchange, val) -> Any
-

Set AreaInterchange active_power_flow.

source
PowerSystems.set_available! — Method
set_available!(value::AreaInterchange, val) -> Any
-

Set AreaInterchange available.

source
PowerSystems.set_ext! — Method
set_ext!(value::AreaInterchange, val) -> Any
-

Set AreaInterchange ext.

source
PowerSystems.set_flow_limits! — Method
set_flow_limits!(value::AreaInterchange, val) -> Any
-

Set AreaInterchange flow_limits.

source
PowerSystems.set_from_area! — Method
set_from_area!(value::AreaInterchange, val) -> Any
-

Set AreaInterchange from_area.

source
PowerSystems.set_to_area! — Method
set_to_area!(value::AreaInterchange, val) -> Any
-

Set AreaInterchange to_area.

source
+

Get AreaInterchange flow_limits.

source
PowerSystems.get_from_area — Method
get_from_area(value::AreaInterchange) -> Area
+

Get AreaInterchange from_area.

source
PowerSystems.get_to_area — Method
get_to_area(value::AreaInterchange) -> Area
+

Get AreaInterchange to_area.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::AreaInterchange, val) -> Any
+

Set AreaInterchange active_power_flow.

source
PowerSystems.set_available! — Method
set_available!(value::AreaInterchange, val) -> Any
+

Set AreaInterchange available.

source
PowerSystems.set_ext! — Method
set_ext!(value::AreaInterchange, val) -> Any
+

Set AreaInterchange ext.

source
PowerSystems.set_flow_limits! — Method
set_flow_limits!(value::AreaInterchange, val) -> Any
+

Set AreaInterchange flow_limits.

source
PowerSystems.set_from_area! — Method
set_from_area!(value::AreaInterchange, val) -> Any
+

Set AreaInterchange from_area.

source
PowerSystems.set_to_area! — Method
set_to_area!(value::AreaInterchange, val) -> Any
+

Set AreaInterchange to_area.

source
diff --git a/dev/model_library/generated_ConstantReserveNonSpinning/index.html b/dev/model_library/generated_ConstantReserveNonSpinning/index.html index d6e4f3c5c9..531acaaeea 100644 --- a/dev/model_library/generated_ConstantReserveNonSpinning/index.html +++ b/dev/model_library/generated_ConstantReserveNonSpinning/index.html @@ -10,52 +10,52 @@ deployed_fraction::Float64 ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A non-spinning reserve product with a constant procurement requirement, such as 3% of the system base power at all times.

This reserve product includes back-up generators that might not be currently synchronized with the power system, but can come online quickly after an unexpected contingency, such as a transmission line or generator outage. This is only an upwards reserve. For faster-responding upwards or downwards reserves from components already synchronized with the system, see ConstantReserve

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::ConstantReserveNonSpinning) -> String
-

Get ConstantReserveNonSpinning name.

source
PowerSystems.get_available — Method
get_available(value::ConstantReserveNonSpinning) -> Bool
-

Get ConstantReserveNonSpinning available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(
+end

A non-spinning reserve product with a constant procurement requirement, such as 3% of the system base power at all times.

This reserve product includes back-up generators that might not be currently synchronized with the power system, but can come online quickly after an unexpected contingency, such as a transmission line or generator outage. This is only an upwards reserve. For faster-responding upwards or downwards reserves from components already synchronized with the system, see ConstantReserve

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • time_frame::Float64: the saturation time frame in minutes that a participating device must provide its reserve contribution, validation range: (0, nothing)
  • requirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)
  • sustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)
  • max_output_fraction::Float64: (default: 1.0) the maximum fraction of each device's output that can be assigned to the service, validation range: (0, 1)
  • max_participation_factor::Float64: (default: 1.0) the maximum portion [0, 1.0] of the reserve that can be contributed per device, validation range: (0, 1)
  • deployed_fraction::Float64: (default: 0.0) Fraction of service procurement that is assumed to be actually deployed. Most commonly, this is assumed to be either 0.0 or 1.0, validation range: (0, 1)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ConstantReserveNonSpinning) -> String
+

Get ConstantReserveNonSpinning name.

source
PowerSystems.get_available — Method
get_available(value::ConstantReserveNonSpinning) -> Bool
+

Get ConstantReserveNonSpinning available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(
     value::ConstantReserveNonSpinning
 ) -> Float64
-

Get ConstantReserveNonSpinning deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(
+

Get ConstantReserveNonSpinning deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(
     value::ConstantReserveNonSpinning
 ) -> Dict{String, Any}
-

Get ConstantReserveNonSpinning ext.

source
PowerSystems.get_max_output_fraction — Method
get_max_output_fraction(
+

Get ConstantReserveNonSpinning ext.

source
PowerSystems.get_max_output_fraction — Method
get_max_output_fraction(
     value::ConstantReserveNonSpinning
 ) -> Float64
-

Get ConstantReserveNonSpinning max_output_fraction.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
+

Get ConstantReserveNonSpinning max_output_fraction.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
     value::ConstantReserveNonSpinning
 ) -> Float64
-

Get ConstantReserveNonSpinning max_participation_factor.

source
PowerSystems.get_requirement — Method
get_requirement(value::ConstantReserveNonSpinning) -> Any
-

Get ConstantReserveNonSpinning requirement.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(
+

Get ConstantReserveNonSpinning max_participation_factor.

source
PowerSystems.get_requirement — Method
get_requirement(value::ConstantReserveNonSpinning) -> Any
+

Get ConstantReserveNonSpinning requirement.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(
     value::ConstantReserveNonSpinning
 ) -> Float64
-

Get ConstantReserveNonSpinning sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::ConstantReserveNonSpinning) -> Float64
-

Get ConstantReserveNonSpinning time_frame.

source
PowerSystems.set_available! — Method
set_available!(
+

Get ConstantReserveNonSpinning sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::ConstantReserveNonSpinning) -> Float64
+

Get ConstantReserveNonSpinning time_frame.

source
PowerSystems.set_available! — Method
set_available!(
     value::ConstantReserveNonSpinning,
     val
 ) -> Any
-

Set ConstantReserveNonSpinning available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(
+

Set ConstantReserveNonSpinning available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(
     value::ConstantReserveNonSpinning,
     val
 ) -> Any
-

Set ConstantReserveNonSpinning deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::ConstantReserveNonSpinning, val) -> Any
-

Set ConstantReserveNonSpinning ext.

source
PowerSystems.set_max_output_fraction! — Method
set_max_output_fraction!(
+

Set ConstantReserveNonSpinning deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::ConstantReserveNonSpinning, val) -> Any
+

Set ConstantReserveNonSpinning ext.

source
PowerSystems.set_max_output_fraction! — Method
set_max_output_fraction!(
     value::ConstantReserveNonSpinning,
     val
 ) -> Any
-

Set ConstantReserveNonSpinning max_output_fraction.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
+

Set ConstantReserveNonSpinning max_output_fraction.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
     value::ConstantReserveNonSpinning,
     val
 ) -> Any
-

Set ConstantReserveNonSpinning max_participation_factor.

source
PowerSystems.set_requirement! — Method
set_requirement!(
+

Set ConstantReserveNonSpinning max_participation_factor.

source
PowerSystems.set_requirement! — Method
set_requirement!(
     value::ConstantReserveNonSpinning,
     val
 ) -> Any
-

Set ConstantReserveNonSpinning requirement.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(
+

Set ConstantReserveNonSpinning requirement.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(
     value::ConstantReserveNonSpinning,
     val
 ) -> Any
-

Set ConstantReserveNonSpinning sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(
+

Set ConstantReserveNonSpinning sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(
     value::ConstantReserveNonSpinning,
     val
 ) -> Any
-

Set ConstantReserveNonSpinning time_frame.

source
+

Set ConstantReserveNonSpinning time_frame.

source diff --git a/dev/model_library/generated_Converter/index.html b/dev/model_library/generated_Converter/index.html index 190fad95c3..a731b28870 100644 --- a/dev/model_library/generated_Converter/index.html +++ b/dev/model_library/generated_Converter/index.html @@ -5,15 +5,15 @@ ext::Dict{String, Any} states::Vector{Symbol} n_states::Int -end

Parameters of an average converter model

Arguments

source
PowerSystems.get_ext — Method
get_ext(value::AverageConverter) -> Dict{String, Any}
-

Get AverageConverter ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AverageConverter) -> Int64
-

Get AverageConverter n_states.

source
PowerSystems.get_rated_current — Method
get_rated_current(value::AverageConverter) -> Float64
-

Get AverageConverter rated_current.

source
PowerSystems.get_rated_voltage — Method
get_rated_voltage(value::AverageConverter) -> Float64
-

Get AverageConverter rated_voltage.

source
PowerSystems.get_states — Method
get_states(value::AverageConverter) -> Vector{Symbol}
-

Get AverageConverter states.

source
PowerSystems.set_ext! — Method
set_ext!(value::AverageConverter, val) -> Any
-

Set AverageConverter ext.

source
PowerSystems.set_rated_current! — Method
set_rated_current!(value::AverageConverter, val) -> Any
-

Set AverageConverter rated_current.

source
PowerSystems.set_rated_voltage! — Method
set_rated_voltage!(value::AverageConverter, val) -> Any
-

Set AverageConverter rated_voltage.

source

RenewableEnergyConverterTypeA

PowerSystems.RenewableEnergyConverterTypeA — Type
mutable struct RenewableEnergyConverterTypeA <: Converter
+end

Parameters of an average converter model

Arguments

  • rated_voltage::Float64: Rated voltage (V), validation range: (0, nothing)
  • rated_current::Float64: Rated current (A), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) AverageConverter has no states
  • n_states::Int: (Do not modify.) AverageConverter has no states
source
PowerSystems.get_ext — Method
get_ext(value::AverageConverter) -> Dict{String, Any}
+

Get AverageConverter ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AverageConverter) -> Int64
+

Get AverageConverter n_states.

source
PowerSystems.get_rated_current — Method
get_rated_current(value::AverageConverter) -> Float64
+

Get AverageConverter rated_current.

source
PowerSystems.get_rated_voltage — Method
get_rated_voltage(value::AverageConverter) -> Float64
+

Get AverageConverter rated_voltage.

source
PowerSystems.get_states — Method
get_states(value::AverageConverter) -> Vector{Symbol}
+

Get AverageConverter states.

source
PowerSystems.set_ext! — Method
set_ext!(value::AverageConverter, val) -> Any
+

Set AverageConverter ext.

source
PowerSystems.set_rated_current! — Method
set_rated_current!(value::AverageConverter, val) -> Any
+

Set AverageConverter rated_current.

source
PowerSystems.set_rated_voltage! — Method
set_rated_voltage!(value::AverageConverter, val) -> Any
+

Set AverageConverter rated_voltage.

source

RenewableEnergyConverterTypeA

PowerSystems.RenewableEnergyConverterTypeA — Type
mutable struct RenewableEnergyConverterTypeA <: Converter
     T_g::Float64
     Rrpwr::Float64
     Brkpt::Float64
@@ -33,79 +33,79 @@
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of a renewable energy generator/converter model, this model corresponds to REGCA1 in PSSE

Arguments

  • T_g::Float64: Converter time constant (s), validation range: (0, nothing)
  • Rrpwr::Float64: Low Voltage Power Logic (LVPL) ramp rate limit (pu/s), validation range: (0, nothing)
  • Brkpt::Float64: LVPL characteristic voltage 2 (pu), validation range: (0, nothing)
  • Zerox::Float64: LVPL characteristic voltage 1 (pu), validation range: (0, nothing)
  • Lvpl1::Float64: LVPL gain (pu), validation range: (0, nothing)
  • Vo_lim::Float64: Voltage limit for high voltage reactive current management (pu), validation range: (0, nothing)
  • Lv_pnts::MinMax: Voltage points for low voltage active current management (pu) (Lvpnt0, Lvpnt1)
  • Io_lim::Float64: Current limit (pu) for high voltage reactive current management (specified as a negative value), validation range: (nothing, 0)
  • T_fltr::Float64: Voltage filter time constant for low voltage active current management (s), validation range: (0, nothing)
  • K_hv::Float64: Overvoltage compensation gain used in the high voltage reactive current management, validation range: (0, nothing)
  • Iqr_lims::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)
  • Accel::Float64: Acceleration factor, validation range: (0, 1)
  • Lvpl_sw::Int: Low voltage power logic (LVPL) switch. (0: LVPL not present, 1: LVPL present), validation range: (0, 1)
  • Q_ref::Float64: (default: 1.0) Initial condition of reactive power from power flow, validation range: (0, nothing)
  • R_source::Float64: (default: 0.0) Output resistor used for the Thevenin Equivalent, validation range: (0, nothing)
  • X_source::Float64: (default: 1.0e5) Output reactance used for the Thevenin Equivalent, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are: Ip: Converter lag for Ipcmd, Iq: Converter lag for Iqcmd, Vmeas: Voltage filter for low voltage active current management
  • n_states::Int: (Do not modify.) RenewableEnergyConverterTypeA has 3 states
source
PowerSystems.get_Accel — Method
get_Accel(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA Accel.

source
PowerSystems.get_Brkpt — Method
get_Brkpt(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA Brkpt.

source
PowerSystems.get_Io_lim — Method
get_Io_lim(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA Io_lim.

source
PowerSystems.get_Iqr_lims — Method
get_Iqr_lims(
+end

Parameters of a renewable energy generator/converter model, this model corresponds to REGCA1 in PSSE

Arguments

  • T_g::Float64: Converter time constant (s), validation range: (0, nothing)
  • Rrpwr::Float64: Low Voltage Power Logic (LVPL) ramp rate limit (pu/s), validation range: (0, nothing)
  • Brkpt::Float64: LVPL characteristic voltage 2 (pu), validation range: (0, nothing)
  • Zerox::Float64: LVPL characteristic voltage 1 (pu), validation range: (0, nothing)
  • Lvpl1::Float64: LVPL gain (pu), validation range: (0, nothing)
  • Vo_lim::Float64: Voltage limit for high voltage reactive current management (pu), validation range: (0, nothing)
  • Lv_pnts::MinMax: Voltage points for low voltage active current management (pu) (Lvpnt0, Lvpnt1)
  • Io_lim::Float64: Current limit (pu) for high voltage reactive current management (specified as a negative value), validation range: (nothing, 0)
  • T_fltr::Float64: Voltage filter time constant for low voltage active current management (s), validation range: (0, nothing)
  • K_hv::Float64: Overvoltage compensation gain used in the high voltage reactive current management, validation range: (0, nothing)
  • Iqr_lims::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)
  • Accel::Float64: Acceleration factor, validation range: (0, 1)
  • Lvpl_sw::Int: Low voltage power logic (LVPL) switch. (0: LVPL not present, 1: LVPL present), validation range: (0, 1)
  • Q_ref::Float64: (default: 1.0) Initial condition of reactive power from power flow, validation range: (0, nothing)
  • R_source::Float64: (default: 0.0) Output resistor used for the Thevenin Equivalent, validation range: (0, nothing)
  • X_source::Float64: (default: 1.0e5) Output reactance used for the Thevenin Equivalent, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are: Ip: Converter lag for Ipcmd, Iq: Converter lag for Iqcmd, Vmeas: Voltage filter for low voltage active current management
  • n_states::Int: (Do not modify.) RenewableEnergyConverterTypeA has 3 states
source
PowerSystems.get_Accel — Method
get_Accel(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA Accel.

source
PowerSystems.get_Brkpt — Method
get_Brkpt(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA Brkpt.

source
PowerSystems.get_Io_lim — Method
get_Io_lim(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA Io_lim.

source
PowerSystems.get_Iqr_lims — Method
get_Iqr_lims(
     value::RenewableEnergyConverterTypeA
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get RenewableEnergyConverterTypeA Iqr_lims.

source
PowerSystems.get_K_hv — Method
get_K_hv(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA K_hv.

source
PowerSystems.get_Lv_pnts — Method
get_Lv_pnts(
+

Get RenewableEnergyConverterTypeA Iqr_lims.

source
PowerSystems.get_K_hv — Method
get_K_hv(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA K_hv.

source
PowerSystems.get_Lv_pnts — Method
get_Lv_pnts(
     value::RenewableEnergyConverterTypeA
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get RenewableEnergyConverterTypeA Lv_pnts.

source
PowerSystems.get_Lvpl1 — Method
get_Lvpl1(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA Lvpl1.

source
PowerSystems.get_Lvpl_sw — Method
get_Lvpl_sw(value::RenewableEnergyConverterTypeA) -> Int64
-

Get RenewableEnergyConverterTypeA Lvpl_sw.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA Q_ref.

source
PowerSystems.get_R_source — Method
get_R_source(
+

Get RenewableEnergyConverterTypeA Lv_pnts.

source
PowerSystems.get_Lvpl1 — Method
get_Lvpl1(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA Lvpl1.

source
PowerSystems.get_Lvpl_sw — Method
get_Lvpl_sw(value::RenewableEnergyConverterTypeA) -> Int64
+

Get RenewableEnergyConverterTypeA Lvpl_sw.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA Q_ref.

source
PowerSystems.get_R_source — Method
get_R_source(
     value::RenewableEnergyConverterTypeA
 ) -> Float64
-

Get RenewableEnergyConverterTypeA R_source.

source
PowerSystems.get_Rrpwr — Method
get_Rrpwr(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA Rrpwr.

source
PowerSystems.get_T_fltr — Method
get_T_fltr(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA T_fltr.

source
PowerSystems.get_T_g — Method
get_T_g(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA T_g.

source
PowerSystems.get_Vo_lim — Method
get_Vo_lim(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA Vo_lim.

source
PowerSystems.get_X_source — Method
get_X_source(
+

Get RenewableEnergyConverterTypeA R_source.

source
PowerSystems.get_Rrpwr — Method
get_Rrpwr(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA Rrpwr.

source
PowerSystems.get_T_fltr — Method
get_T_fltr(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA T_fltr.

source
PowerSystems.get_T_g — Method
get_T_g(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA T_g.

source
PowerSystems.get_Vo_lim — Method
get_Vo_lim(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA Vo_lim.

source
PowerSystems.get_X_source — Method
get_X_source(
     value::RenewableEnergyConverterTypeA
 ) -> Float64
-

Get RenewableEnergyConverterTypeA X_source.

source
PowerSystems.get_Zerox — Method
get_Zerox(value::RenewableEnergyConverterTypeA) -> Float64
-

Get RenewableEnergyConverterTypeA Zerox.

source
PowerSystems.get_ext — Method
get_ext(
+

Get RenewableEnergyConverterTypeA X_source.

source
PowerSystems.get_Zerox — Method
get_Zerox(value::RenewableEnergyConverterTypeA) -> Float64
+

Get RenewableEnergyConverterTypeA Zerox.

source
PowerSystems.get_ext — Method
get_ext(
     value::RenewableEnergyConverterTypeA
 ) -> Dict{String, Any}
-

Get RenewableEnergyConverterTypeA ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::RenewableEnergyConverterTypeA) -> Int64
-

Get RenewableEnergyConverterTypeA n_states.

source
PowerSystems.get_states — Method
get_states(
+

Get RenewableEnergyConverterTypeA ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::RenewableEnergyConverterTypeA) -> Int64
+

Get RenewableEnergyConverterTypeA n_states.

source
PowerSystems.get_states — Method
get_states(
     value::RenewableEnergyConverterTypeA
 ) -> Vector{Symbol}
-

Get RenewableEnergyConverterTypeA states.

source
PowerSystems.set_Accel! — Method
set_Accel!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA Accel.

source
PowerSystems.set_Brkpt! — Method
set_Brkpt!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA Brkpt.

source
PowerSystems.set_Io_lim! — Method
set_Io_lim!(
+

Get RenewableEnergyConverterTypeA states.

source
PowerSystems.set_Accel! — Method
set_Accel!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA Accel.

source
PowerSystems.set_Brkpt! — Method
set_Brkpt!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA Brkpt.

source
PowerSystems.set_Io_lim! — Method
set_Io_lim!(
     value::RenewableEnergyConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyConverterTypeA Io_lim.

source
PowerSystems.set_Iqr_lims! — Method
set_Iqr_lims!(
+

Set RenewableEnergyConverterTypeA Io_lim.

source
PowerSystems.set_Iqr_lims! — Method
set_Iqr_lims!(
     value::RenewableEnergyConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyConverterTypeA Iqr_lims.

source
PowerSystems.set_K_hv! — Method
set_K_hv!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA K_hv.

source
PowerSystems.set_Lv_pnts! — Method
set_Lv_pnts!(
+

Set RenewableEnergyConverterTypeA Iqr_lims.

source
PowerSystems.set_K_hv! — Method
set_K_hv!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA K_hv.

source
PowerSystems.set_Lv_pnts! — Method
set_Lv_pnts!(
     value::RenewableEnergyConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyConverterTypeA Lv_pnts.

source
PowerSystems.set_Lvpl1! — Method
set_Lvpl1!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA Lvpl1.

source
PowerSystems.set_Lvpl_sw! — Method
set_Lvpl_sw!(
+

Set RenewableEnergyConverterTypeA Lv_pnts.

source
PowerSystems.set_Lvpl1! — Method
set_Lvpl1!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA Lvpl1.

source
PowerSystems.set_Lvpl_sw! — Method
set_Lvpl_sw!(
     value::RenewableEnergyConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyConverterTypeA Lvpl_sw.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA Q_ref.

source
PowerSystems.set_R_source! — Method
set_R_source!(
+

Set RenewableEnergyConverterTypeA Lvpl_sw.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA Q_ref.

source
PowerSystems.set_R_source! — Method
set_R_source!(
     value::RenewableEnergyConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyConverterTypeA R_source.

source
PowerSystems.set_Rrpwr! — Method
set_Rrpwr!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA Rrpwr.

source
PowerSystems.set_T_fltr! — Method
set_T_fltr!(
+

Set RenewableEnergyConverterTypeA R_source.

source
PowerSystems.set_Rrpwr! — Method
set_Rrpwr!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA Rrpwr.

source
PowerSystems.set_T_fltr! — Method
set_T_fltr!(
     value::RenewableEnergyConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyConverterTypeA T_fltr.

source
PowerSystems.set_T_g! — Method
set_T_g!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA T_g.

source
PowerSystems.set_Vo_lim! — Method
set_Vo_lim!(
+

Set RenewableEnergyConverterTypeA T_fltr.

source
PowerSystems.set_T_g! — Method
set_T_g!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA T_g.

source
PowerSystems.set_Vo_lim! — Method
set_Vo_lim!(
     value::RenewableEnergyConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyConverterTypeA Vo_lim.

source
PowerSystems.set_X_source! — Method
set_X_source!(
+

Set RenewableEnergyConverterTypeA Vo_lim.

source
PowerSystems.set_X_source! — Method
set_X_source!(
     value::RenewableEnergyConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyConverterTypeA X_source.

source
PowerSystems.set_Zerox! — Method
set_Zerox!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA Zerox.

source
PowerSystems.set_ext! — Method
set_ext!(value::RenewableEnergyConverterTypeA, val) -> Any
-

Set RenewableEnergyConverterTypeA ext.

source

RenewableEnergyVoltageConverterTypeA

PowerSystems.RenewableEnergyVoltageConverterTypeA — Type
mutable struct RenewableEnergyVoltageConverterTypeA <: Converter
+

Set RenewableEnergyConverterTypeA X_source.

source
PowerSystems.set_Zerox! — Method
set_Zerox!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA Zerox.

source
PowerSystems.set_ext! — Method
set_ext!(value::RenewableEnergyConverterTypeA, val) -> Any
+

Set RenewableEnergyConverterTypeA ext.

source

RenewableEnergyVoltageConverterTypeA

PowerSystems.RenewableEnergyVoltageConverterTypeA — Type
mutable struct RenewableEnergyVoltageConverterTypeA <: Converter
     T_g::Float64
     Rrpwr::Float64
     Brkpt::Float64
@@ -123,115 +123,115 @@
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of a renewable energy generator/converter model, this model corresponds to REGCA1 in PSSE, but to be interfaced using a Voltage Source instead of a Current Source

Arguments

  • T_g::Float64: Converter time constant (s), validation range: (0, nothing)
  • Rrpwr::Float64: Low Voltage Power Logic (LVPL) ramp rate limit (pu/s), validation range: (0, nothing)
  • Brkpt::Float64: LVPL characteristic voltage 2 (pu), validation range: (0, nothing)
  • Zerox::Float64: LVPL characteristic voltage 1 (pu), validation range: (0, nothing)
  • Lvpl1::Float64: LVPL gain (pu), validation range: (0, nothing)
  • Vo_lim::Float64: Voltage limit for high voltage reactive current management (pu), validation range: (0, nothing)
  • Lv_pnts::MinMax: Voltage points for low voltage active current management (pu) (Lvpnt0, Lvpnt1)
  • Io_lim::Float64: Current limit (pu) for high voltage reactive current management (specified as a negative value), validation range: (nothing, 0)
  • T_fltr::Float64: Voltage filter time constant for low voltage active current management (s), validation range: (0, nothing)
  • K_hv::Float64: Overvoltage compensation gain used in the high voltage reactive current management, validation range: (0, nothing)
  • Iqr_lims::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)
  • Accel::Float64: Acceleration factor, validation range: (0, 1)
  • Lvpl_sw::Int: Low voltage power logic (LVPL) switch. (0: LVPL not present, 1: LVPL present), validation range: (0, 1)
  • Q_ref::Float64: (default: 1.0) Initial condition of reactive power from power flow, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are: Ip: Converter lag for Ipcmd, Iq: Converter lag for Iqcmd, Vmeas: Voltage filter for low voltage active current management
  • n_states::Int: (Do not modify.) RenewableEnergyVoltageConverterTypeA has 3 states
source
PowerSystems.get_Accel — Method
get_Accel(
+end

Parameters of a renewable energy generator/converter model, this model corresponds to REGCA1 in PSSE, but to be interfaced using a Voltage Source instead of a Current Source

Arguments

  • T_g::Float64: Converter time constant (s), validation range: (0, nothing)
  • Rrpwr::Float64: Low Voltage Power Logic (LVPL) ramp rate limit (pu/s), validation range: (0, nothing)
  • Brkpt::Float64: LVPL characteristic voltage 2 (pu), validation range: (0, nothing)
  • Zerox::Float64: LVPL characteristic voltage 1 (pu), validation range: (0, nothing)
  • Lvpl1::Float64: LVPL gain (pu), validation range: (0, nothing)
  • Vo_lim::Float64: Voltage limit for high voltage reactive current management (pu), validation range: (0, nothing)
  • Lv_pnts::MinMax: Voltage points for low voltage active current management (pu) (Lvpnt0, Lvpnt1)
  • Io_lim::Float64: Current limit (pu) for high voltage reactive current management (specified as a negative value), validation range: (nothing, 0)
  • T_fltr::Float64: Voltage filter time constant for low voltage active current management (s), validation range: (0, nothing)
  • K_hv::Float64: Overvoltage compensation gain used in the high voltage reactive current management, validation range: (0, nothing)
  • Iqr_lims::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)
  • Accel::Float64: Acceleration factor, validation range: (0, 1)
  • Lvpl_sw::Int: Low voltage power logic (LVPL) switch. (0: LVPL not present, 1: LVPL present), validation range: (0, 1)
  • Q_ref::Float64: (default: 1.0) Initial condition of reactive power from power flow, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are: Ip: Converter lag for Ipcmd, Iq: Converter lag for Iqcmd, Vmeas: Voltage filter for low voltage active current management
  • n_states::Int: (Do not modify.) RenewableEnergyVoltageConverterTypeA has 3 states
source
PowerSystems.get_Accel — Method
get_Accel(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA Accel.

source
PowerSystems.get_Brkpt — Method
get_Brkpt(
+

Get RenewableEnergyVoltageConverterTypeA Accel.

source
PowerSystems.get_Brkpt — Method
get_Brkpt(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA Brkpt.

source
PowerSystems.get_Io_lim — Method
get_Io_lim(
+

Get RenewableEnergyVoltageConverterTypeA Brkpt.

source
PowerSystems.get_Io_lim — Method
get_Io_lim(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA Io_lim.

source
PowerSystems.get_Iqr_lims — Method
get_Iqr_lims(
+

Get RenewableEnergyVoltageConverterTypeA Io_lim.

source
PowerSystems.get_Iqr_lims — Method
get_Iqr_lims(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get RenewableEnergyVoltageConverterTypeA Iqr_lims.

source
PowerSystems.get_K_hv — Method
get_K_hv(
+

Get RenewableEnergyVoltageConverterTypeA Iqr_lims.

source
PowerSystems.get_K_hv — Method
get_K_hv(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA K_hv.

source
PowerSystems.get_Lv_pnts — Method
get_Lv_pnts(
+

Get RenewableEnergyVoltageConverterTypeA K_hv.

source
PowerSystems.get_Lv_pnts — Method
get_Lv_pnts(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get RenewableEnergyVoltageConverterTypeA Lv_pnts.

source
PowerSystems.get_Lvpl1 — Method
get_Lvpl1(
+

Get RenewableEnergyVoltageConverterTypeA Lv_pnts.

source
PowerSystems.get_Lvpl1 — Method
get_Lvpl1(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA Lvpl1.

source
PowerSystems.get_Lvpl_sw — Method
get_Lvpl_sw(
+

Get RenewableEnergyVoltageConverterTypeA Lvpl1.

source
PowerSystems.get_Lvpl_sw — Method
get_Lvpl_sw(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Int64
-

Get RenewableEnergyVoltageConverterTypeA Lvpl_sw.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(
+

Get RenewableEnergyVoltageConverterTypeA Lvpl_sw.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA Q_ref.

source
PowerSystems.get_Rrpwr — Method
get_Rrpwr(
+

Get RenewableEnergyVoltageConverterTypeA Q_ref.

source
PowerSystems.get_Rrpwr — Method
get_Rrpwr(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA Rrpwr.

source
PowerSystems.get_T_fltr — Method
get_T_fltr(
+

Get RenewableEnergyVoltageConverterTypeA Rrpwr.

source
PowerSystems.get_T_fltr — Method
get_T_fltr(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA T_fltr.

source
PowerSystems.get_T_g — Method
get_T_g(
+

Get RenewableEnergyVoltageConverterTypeA T_fltr.

source
PowerSystems.get_T_g — Method
get_T_g(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA T_g.

source
PowerSystems.get_Vo_lim — Method
get_Vo_lim(
+

Get RenewableEnergyVoltageConverterTypeA T_g.

source
PowerSystems.get_Vo_lim — Method
get_Vo_lim(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA Vo_lim.

source
PowerSystems.get_Zerox — Method
get_Zerox(
+

Get RenewableEnergyVoltageConverterTypeA Vo_lim.

source
PowerSystems.get_Zerox — Method
get_Zerox(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Float64
-

Get RenewableEnergyVoltageConverterTypeA Zerox.

source
PowerSystems.get_ext — Method
get_ext(
+

Get RenewableEnergyVoltageConverterTypeA Zerox.

source
PowerSystems.get_ext — Method
get_ext(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Dict{String, Any}
-

Get RenewableEnergyVoltageConverterTypeA ext.

source
PowerSystems.get_n_states — Method
get_n_states(
+

Get RenewableEnergyVoltageConverterTypeA ext.

source
PowerSystems.get_n_states — Method
get_n_states(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Int64
-

Get RenewableEnergyVoltageConverterTypeA n_states.

source
PowerSystems.get_states — Method
get_states(
+

Get RenewableEnergyVoltageConverterTypeA n_states.

source
PowerSystems.get_states — Method
get_states(
     value::RenewableEnergyVoltageConverterTypeA
 ) -> Vector{Symbol}
-

Get RenewableEnergyVoltageConverterTypeA states.

source
PowerSystems.set_Accel! — Method
set_Accel!(
+

Get RenewableEnergyVoltageConverterTypeA states.

source
PowerSystems.set_Accel! — Method
set_Accel!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Accel.

source
PowerSystems.set_Brkpt! — Method
set_Brkpt!(
+

Set RenewableEnergyVoltageConverterTypeA Accel.

source
PowerSystems.set_Brkpt! — Method
set_Brkpt!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Brkpt.

source
PowerSystems.set_Io_lim! — Method
set_Io_lim!(
+

Set RenewableEnergyVoltageConverterTypeA Brkpt.

source
PowerSystems.set_Io_lim! — Method
set_Io_lim!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Io_lim.

source
PowerSystems.set_Iqr_lims! — Method
set_Iqr_lims!(
+

Set RenewableEnergyVoltageConverterTypeA Io_lim.

source
PowerSystems.set_Iqr_lims! — Method
set_Iqr_lims!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Iqr_lims.

source
PowerSystems.set_K_hv! — Method
set_K_hv!(
+

Set RenewableEnergyVoltageConverterTypeA Iqr_lims.

source
PowerSystems.set_K_hv! — Method
set_K_hv!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA K_hv.

source
PowerSystems.set_Lv_pnts! — Method
set_Lv_pnts!(
+

Set RenewableEnergyVoltageConverterTypeA K_hv.

source
PowerSystems.set_Lv_pnts! — Method
set_Lv_pnts!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Lv_pnts.

source
PowerSystems.set_Lvpl1! — Method
set_Lvpl1!(
+

Set RenewableEnergyVoltageConverterTypeA Lv_pnts.

source
PowerSystems.set_Lvpl1! — Method
set_Lvpl1!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Lvpl1.

source
PowerSystems.set_Lvpl_sw! — Method
set_Lvpl_sw!(
+

Set RenewableEnergyVoltageConverterTypeA Lvpl1.

source
PowerSystems.set_Lvpl_sw! — Method
set_Lvpl_sw!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Lvpl_sw.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(
+

Set RenewableEnergyVoltageConverterTypeA Lvpl_sw.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Q_ref.

source
PowerSystems.set_Rrpwr! — Method
set_Rrpwr!(
+

Set RenewableEnergyVoltageConverterTypeA Q_ref.

source
PowerSystems.set_Rrpwr! — Method
set_Rrpwr!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Rrpwr.

source
PowerSystems.set_T_fltr! — Method
set_T_fltr!(
+

Set RenewableEnergyVoltageConverterTypeA Rrpwr.

source
PowerSystems.set_T_fltr! — Method
set_T_fltr!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA T_fltr.

source
PowerSystems.set_T_g! — Method
set_T_g!(
+

Set RenewableEnergyVoltageConverterTypeA T_fltr.

source
PowerSystems.set_T_g! — Method
set_T_g!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA T_g.

source
PowerSystems.set_Vo_lim! — Method
set_Vo_lim!(
+

Set RenewableEnergyVoltageConverterTypeA T_g.

source
PowerSystems.set_Vo_lim! — Method
set_Vo_lim!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Vo_lim.

source
PowerSystems.set_Zerox! — Method
set_Zerox!(
+

Set RenewableEnergyVoltageConverterTypeA Vo_lim.

source
PowerSystems.set_Zerox! — Method
set_Zerox!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA Zerox.

source
PowerSystems.set_ext! — Method
set_ext!(
+

Set RenewableEnergyVoltageConverterTypeA Zerox.

source
PowerSystems.set_ext! — Method
set_ext!(
     value::RenewableEnergyVoltageConverterTypeA,
     val
 ) -> Any
-

Set RenewableEnergyVoltageConverterTypeA ext.

source
+

Set RenewableEnergyVoltageConverterTypeA ext.

source diff --git a/dev/model_library/generated_DCBus/index.html b/dev/model_library/generated_DCBus/index.html index ca923bec0b..6e2be8e4f2 100644 --- a/dev/model_library/generated_DCBus/index.html +++ b/dev/model_library/generated_DCBus/index.html @@ -9,21 +9,21 @@ load_zone::Union{Nothing, LoadZone} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A DC bus

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::DCBus) -> String
-

Get DCBus name.

source
PowerSystems.get_area — Method
get_area(value::DCBus) -> Union{Nothing, Area}
-

Get DCBus area.

source
PowerSystems.get_base_voltage — Method
get_base_voltage(value::DCBus) -> Union{Nothing, Float64}
-

Get DCBus base_voltage.

source
PowerSystems.get_ext — Method
get_ext(value::DCBus) -> Dict{String, Any}
-

Get DCBus ext.

source
PowerSystems.get_load_zone — Method
get_load_zone(value::DCBus) -> Union{Nothing, LoadZone}
-

Get DCBus load_zone.

source
PowerSystems.get_magnitude — Method
get_magnitude(value::DCBus) -> Union{Nothing, Float64}
-

Get DCBus magnitude.

source
PowerSystems.get_number — Method
get_number(value::DCBus) -> Int64
-

Get DCBus number.

source
PowerSystems.get_voltage_limits — Method
get_voltage_limits(
+end

A DC bus

Arguments

  • number::Int: A unique bus identification number (positive integer)
  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • magnitude::Union{Nothing, Float64}: voltage as a multiple of base_voltage, validation range: voltage_limits
  • voltage_limits::Union{Nothing, MinMax}: limits on the voltage variation as multiples of base_voltage
  • base_voltage::Union{Nothing, Float64}: the base voltage in kV, validation range: (0, nothing)
  • area::Union{Nothing, Area}: (default: nothing) the area containing the DC bus
  • load_zone::Union{Nothing, LoadZone}: (default: nothing) the load zone containing the DC bus
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::DCBus) -> String
+

Get DCBus name.

source
PowerSystems.get_area — Method
get_area(value::DCBus) -> Union{Nothing, Area}
+

Get DCBus area.

source
PowerSystems.get_base_voltage — Method
get_base_voltage(value::DCBus) -> Union{Nothing, Float64}
+

Get DCBus base_voltage.

source
PowerSystems.get_ext — Method
get_ext(value::DCBus) -> Dict{String, Any}
+

Get DCBus ext.

source
PowerSystems.get_load_zone — Method
get_load_zone(value::DCBus) -> Union{Nothing, LoadZone}
+

Get DCBus load_zone.

source
PowerSystems.get_magnitude — Method
get_magnitude(value::DCBus) -> Union{Nothing, Float64}
+

Get DCBus magnitude.

source
PowerSystems.get_number — Method
get_number(value::DCBus) -> Int64
+

Get DCBus number.

source
PowerSystems.get_voltage_limits — Method
get_voltage_limits(
     value::DCBus
 ) -> Union{Nothing, @NamedTuple{min::Float64, max::Float64}}
-

Get DCBus voltage_limits.

source
PowerSystems.set_area! — Method
set_area!(value::DCBus, val) -> Any
-

Set DCBus area.

source
PowerSystems.set_base_voltage! — Method
set_base_voltage!(value::DCBus, val) -> Any
-

Set DCBus base_voltage.

source
PowerSystems.set_ext! — Method
set_ext!(value::DCBus, val) -> Any
-

Set DCBus ext.

source
PowerSystems.set_load_zone! — Method
set_load_zone!(value::DCBus, val) -> Any
-

Set DCBus load_zone.

source
PowerSystems.set_magnitude! — Method
set_magnitude!(value::DCBus, val) -> Any
-

Set DCBus magnitude.

source
PowerSystems.set_number! — Method
set_number!(value::DCBus, val) -> Any
-

Set DCBus number.

source
PowerSystems.set_voltage_limits! — Method
set_voltage_limits!(value::DCBus, val) -> Any
-

Set DCBus voltage_limits.

source
+

Get DCBus voltage_limits.

source
PowerSystems.set_area! — Method
set_area!(value::DCBus, val) -> Any
+

Set DCBus area.

source
PowerSystems.set_base_voltage! — Method
set_base_voltage!(value::DCBus, val) -> Any
+

Set DCBus base_voltage.

source
PowerSystems.set_ext! — Method
set_ext!(value::DCBus, val) -> Any
+

Set DCBus ext.

source
PowerSystems.set_load_zone! — Method
set_load_zone!(value::DCBus, val) -> Any
+

Set DCBus load_zone.

source
PowerSystems.set_magnitude! — Method
set_magnitude!(value::DCBus, val) -> Any
+

Set DCBus magnitude.

source
PowerSystems.set_number! — Method
set_number!(value::DCBus, val) -> Any
+

Set DCBus number.

source
PowerSystems.set_voltage_limits! — Method
set_voltage_limits!(value::DCBus, val) -> Any
+

Set DCBus voltage_limits.

source
diff --git a/dev/model_library/generated_DCSource/index.html b/dev/model_library/generated_DCSource/index.html index 8bcc619533..7daba6e691 100644 --- a/dev/model_library/generated_DCSource/index.html +++ b/dev/model_library/generated_DCSource/index.html @@ -5,13 +5,13 @@ states::Vector{Symbol} n_states::Int internal::InfrastructureSystemsInternal -end

Parameters of a Fixed DC Source that returns a fixed DC voltage

Arguments

source
PowerSystems.get_ext — Method
get_ext(value::FixedDCSource) -> Dict{String, Any}
-

Get FixedDCSource ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::FixedDCSource) -> Int64
-

Get FixedDCSource n_states.

source
PowerSystems.get_states — Method
get_states(value::FixedDCSource) -> Vector{Symbol}
-

Get FixedDCSource states.

source
PowerSystems.get_voltage — Method
get_voltage(value::FixedDCSource) -> Float64
-

Get FixedDCSource voltage.

source
PowerSystems.set_ext! — Method
set_ext!(value::FixedDCSource, val) -> Any
-

Set FixedDCSource ext.

source
PowerSystems.set_voltage! — Method
set_voltage!(value::FixedDCSource, val) -> Any
-

Set FixedDCSource voltage.

source

ZeroOrderBESS

PowerSystems.ZeroOrderBESS — Type
mutable struct ZeroOrderBESS <: DCSource
+end

Parameters of a Fixed DC Source that returns a fixed DC voltage

Arguments

  • voltage::Float64: Voltage (V), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) FixedDCSource has no states
  • n_states::Int: (Do not modify.) FixedDCSource has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_ext — Method
get_ext(value::FixedDCSource) -> Dict{String, Any}
+

Get FixedDCSource ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::FixedDCSource) -> Int64
+

Get FixedDCSource n_states.

source
PowerSystems.get_states — Method
get_states(value::FixedDCSource) -> Vector{Symbol}
+

Get FixedDCSource states.

source
PowerSystems.get_voltage — Method
get_voltage(value::FixedDCSource) -> Float64
+

Get FixedDCSource voltage.

source
PowerSystems.set_ext! — Method
set_ext!(value::FixedDCSource, val) -> Any
+

Set FixedDCSource ext.

source
PowerSystems.set_voltage! — Method
set_voltage!(value::FixedDCSource, val) -> Any
+

Set FixedDCSource voltage.

source

ZeroOrderBESS

PowerSystems.ZeroOrderBESS — Type
mutable struct ZeroOrderBESS <: DCSource
     rated_voltage::Float64
     rated_current::Float64
     battery_voltage::Float64
@@ -30,32 +30,32 @@
 end

Parameters for the DC-side with a Battery Energy Storage System from "Grid-Coupled Dynamic Response of Battery-Driven Voltage Source Converters."

Arguments

  • rated_voltage::Float64: Rated voltage (V), validation range: (0, nothing)
  • rated_current::Float64: Rated current (A), validation range: (0, nothing)
  • battery_voltage::Float64: battery voltage in pu (DEVICE_BASE), validation range: (0, nothing)
  • battery_resistance::Float64: Battery resistance in pu (DEVICE_BASE), validation range: (0, nothing)
  • dc_dc_inductor::Float64: DC/DC inductance in pu (DEVICE_BASE), validation range: (0, nothing)
  • dc_link_capacitance::Float64: DC-link capacitance in pu (DEVICE_BASE), validation range: (0, nothing)
  • fs::Float64: DC/DC converter switching frequency (kHz), validation range: (0, nothing)
  • kpv::Float64: voltage controller proportional gain, validation range: (0, nothing)
  • kiv::Float64: voltage controller integral gain, validation range: (0, nothing)
  • kpi::Float64: current controller proportional gain, validation range: (0, nothing)
  • kii::Float64: current controller integral gain, validation range: (0, nothing)
  • Vdc_ref::Float64: (default: 1.1) Reference DC-Voltage Set-point in pu (DEVICE_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the ZeroOrderBESS model are:
v_dc: DC-link voltage,
 i_b: Battery current,
  ν: integrator state of the voltage controller,
- ζ: integrator state of the PI current controller
  • n_states::Int: (Do not modify.) ZeroOrderBESS has 4 states
source
PowerSystems.get_Vdc_ref — Method
get_Vdc_ref(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS Vdc_ref.

source
PowerSystems.get_battery_resistance — Method
get_battery_resistance(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS battery_resistance.

source
PowerSystems.get_battery_voltage — Method
get_battery_voltage(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS battery_voltage.

source
PowerSystems.get_dc_dc_inductor — Method
get_dc_dc_inductor(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS dc_dc_inductor.

source
PowerSystems.get_dc_link_capacitance — Method
get_dc_link_capacitance(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS dc_link_capacitance.

source
PowerSystems.get_ext — Method
get_ext(value::ZeroOrderBESS) -> Dict{String, Any}
-

Get ZeroOrderBESS ext.

source
PowerSystems.get_fs — Method
get_fs(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS fs.

source
PowerSystems.get_kii — Method
get_kii(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS kii.

source
PowerSystems.get_kiv — Method
get_kiv(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS kiv.

source
PowerSystems.get_kpi — Method
get_kpi(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS kpi.

source
PowerSystems.get_kpv — Method
get_kpv(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS kpv.

source
PowerSystems.get_n_states — Method
get_n_states(value::ZeroOrderBESS) -> Int64
-

Get ZeroOrderBESS n_states.

source
PowerSystems.get_rated_current — Method
get_rated_current(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS rated_current.

source
PowerSystems.get_rated_voltage — Method
get_rated_voltage(value::ZeroOrderBESS) -> Float64
-

Get ZeroOrderBESS rated_voltage.

source
PowerSystems.get_states — Method
get_states(value::ZeroOrderBESS) -> Vector{Symbol}
-

Get ZeroOrderBESS states.

source
PowerSystems.set_Vdc_ref! — Method
set_Vdc_ref!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS Vdc_ref.

source
PowerSystems.set_battery_resistance! — Method
set_battery_resistance!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS battery_resistance.

source
PowerSystems.set_battery_voltage! — Method
set_battery_voltage!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS battery_voltage.

source
PowerSystems.set_dc_dc_inductor! — Method
set_dc_dc_inductor!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS dc_dc_inductor.

source
PowerSystems.set_dc_link_capacitance! — Method
set_dc_link_capacitance!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS dc_link_capacitance.

source
PowerSystems.set_ext! — Method
set_ext!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS ext.

source
PowerSystems.set_fs! — Method
set_fs!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS fs.

source
PowerSystems.set_kii! — Method
set_kii!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS kii.

source
PowerSystems.set_kiv! — Method
set_kiv!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS kiv.

source
PowerSystems.set_kpi! — Method
set_kpi!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS kpi.

source
PowerSystems.set_kpv! — Method
set_kpv!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS kpv.

source
PowerSystems.set_rated_current! — Method
set_rated_current!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS rated_current.

source
PowerSystems.set_rated_voltage! — Method
set_rated_voltage!(value::ZeroOrderBESS, val) -> Any
-

Set ZeroOrderBESS rated_voltage.

source
+ ζ: integrator state of the PI current controllersource
PowerSystems.get_Vdc_ref — Method
get_Vdc_ref(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS Vdc_ref.

source
PowerSystems.get_battery_resistance — Method
get_battery_resistance(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS battery_resistance.

source
PowerSystems.get_battery_voltage — Method
get_battery_voltage(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS battery_voltage.

source
PowerSystems.get_dc_dc_inductor — Method
get_dc_dc_inductor(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS dc_dc_inductor.

source
PowerSystems.get_dc_link_capacitance — Method
get_dc_link_capacitance(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS dc_link_capacitance.

source
PowerSystems.get_ext — Method
get_ext(value::ZeroOrderBESS) -> Dict{String, Any}
+

Get ZeroOrderBESS ext.

source
PowerSystems.get_fs — Method
get_fs(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS fs.

source
PowerSystems.get_kii — Method
get_kii(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS kii.

source
PowerSystems.get_kiv — Method
get_kiv(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS kiv.

source
PowerSystems.get_kpi — Method
get_kpi(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS kpi.

source
PowerSystems.get_kpv — Method
get_kpv(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS kpv.

source
PowerSystems.get_n_states — Method
get_n_states(value::ZeroOrderBESS) -> Int64
+

Get ZeroOrderBESS n_states.

source
PowerSystems.get_rated_current — Method
get_rated_current(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS rated_current.

source
PowerSystems.get_rated_voltage — Method
get_rated_voltage(value::ZeroOrderBESS) -> Float64
+

Get ZeroOrderBESS rated_voltage.

source
PowerSystems.get_states — Method
get_states(value::ZeroOrderBESS) -> Vector{Symbol}
+

Get ZeroOrderBESS states.

source
PowerSystems.set_Vdc_ref! — Method
set_Vdc_ref!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS Vdc_ref.

source
PowerSystems.set_battery_resistance! — Method
set_battery_resistance!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS battery_resistance.

source
PowerSystems.set_battery_voltage! — Method
set_battery_voltage!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS battery_voltage.

source
PowerSystems.set_dc_dc_inductor! — Method
set_dc_dc_inductor!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS dc_dc_inductor.

source
PowerSystems.set_dc_link_capacitance! — Method
set_dc_link_capacitance!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS dc_link_capacitance.

source
PowerSystems.set_ext! — Method
set_ext!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS ext.

source
PowerSystems.set_fs! — Method
set_fs!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS fs.

source
PowerSystems.set_kii! — Method
set_kii!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS kii.

source
PowerSystems.set_kiv! — Method
set_kiv!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS kiv.

source
PowerSystems.set_kpi! — Method
set_kpi!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS kpi.

source
PowerSystems.set_kpv! — Method
set_kpv!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS kpv.

source
PowerSystems.set_rated_current! — Method
set_rated_current!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS rated_current.

source
PowerSystems.set_rated_voltage! — Method
set_rated_voltage!(value::ZeroOrderBESS, val) -> Any
+

Set ZeroOrderBESS rated_voltage.

source
diff --git a/dev/model_library/generated_EnergyReservoirStorage/index.html b/dev/model_library/generated_EnergyReservoirStorage/index.html index f92a5c51c9..edc99beb3d 100644 --- a/dev/model_library/generated_EnergyReservoirStorage/index.html +++ b/dev/model_library/generated_EnergyReservoirStorage/index.html @@ -24,108 +24,108 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

An energy storage device, modeled as a generic energy reservoir.

This is suitable for modeling storage charging and discharging with average efficiency losses, ignoring the physical dynamics of the storage unit. A variety of energy storage types and chemistries can be modeled with this approach. For pumped hydro storage, alternatively see HydroPumpedStorage

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::EnergyReservoirStorage) -> String
-

Get EnergyReservoirStorage name.

source
PowerSystems.get_active_power — Method
get_active_power(value::EnergyReservoirStorage) -> Any
-

Get EnergyReservoirStorage active_power.

source
PowerSystems.get_available — Method
get_available(value::EnergyReservoirStorage) -> Bool
-

Get EnergyReservoirStorage available.

source
PowerSystems.get_base_power — Method
get_base_power(value::EnergyReservoirStorage) -> Float64
-

Get EnergyReservoirStorage base_power.

source
PowerSystems.get_bus — Method
get_bus(value::EnergyReservoirStorage) -> ACBus
-

Get EnergyReservoirStorage bus.

source
PowerSystems.get_conversion_factor — Method
get_conversion_factor(
+end

An energy storage device, modeled as a generic energy reservoir.

This is suitable for modeling storage charging and discharging with average efficiency losses, ignoring the physical dynamics of the storage unit. A variety of energy storage types and chemistries can be modeled with this approach. For pumped hydro storage, alternatively see HydroPumpedStorage

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here
  • storage_technology_type::StorageTech: Storage Technology Complementary to EIA 923
  • storage_capacity::Float64: Maximum storage capacity (can be in units of, e.g., MWh for batteries or liters for hydrogen), validation range: (0, nothing)
  • storage_level_limits::MinMax: Minimum and maximum allowable storage levels [0, 1], which can be used to model derates or other restrictions, such as state-of-charge restrictions on battery cycling, validation range: (0, 1)
  • initial_storage_capacity_level::Float64: Initial storage capacity level as a ratio [0, 1.0] of storage_capacity, validation range: (0, 1)
  • rating::Float64: Maximum output power rating of the unit (MVA)
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
  • input_active_power_limits::MinMax: Minimum and maximum limits on the input active power (i.e., charging), validation range: (0, nothing)
  • output_active_power_limits::MinMax: Minimum and maximum limits on the output active power (i.e., discharging), validation range: (0, nothing)
  • efficiency::NamedTuple{(:in, :out), Tuple{Float64, Float64}}: Average efficiency [0, 1] in (charging/filling) and out (discharging/consuming) of the storage system, validation range: (0, 1)
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits
  • reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating, validation range: (0, nothing)
  • operation_cost::StorageCost: (default: StorageCost(nothing)) OperationalCost of storage
  • conversion_factor::Float64: (default: 1.0) Conversion factor of storage_capacity to MWh, if different than 1.0. For example, X MWh/liter hydrogen
  • storage_target::Float64: (default: 0.0) Storage target at the end of simulation as ratio of storage capacity
  • cycle_limits::Int: (default: 1e4) Storage Maximum number of cycles per year
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::EnergyReservoirStorage) -> String
+

Get EnergyReservoirStorage name.

source
PowerSystems.get_active_power — Method
get_active_power(value::EnergyReservoirStorage) -> Any
+

Get EnergyReservoirStorage active_power.

source
PowerSystems.get_available — Method
get_available(value::EnergyReservoirStorage) -> Bool
+

Get EnergyReservoirStorage available.

source
PowerSystems.get_base_power — Method
get_base_power(value::EnergyReservoirStorage) -> Float64
+

Get EnergyReservoirStorage base_power.

source
PowerSystems.get_bus — Method
get_bus(value::EnergyReservoirStorage) -> ACBus
+

Get EnergyReservoirStorage bus.

source
PowerSystems.get_conversion_factor — Method
get_conversion_factor(
     value::EnergyReservoirStorage
 ) -> Float64
-

Get EnergyReservoirStorage conversion_factor.

source
PowerSystems.get_cycle_limits — Method
get_cycle_limits(value::EnergyReservoirStorage) -> Int64
-

Get EnergyReservoirStorage cycle_limits.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+

Get EnergyReservoirStorage conversion_factor.

source
PowerSystems.get_cycle_limits — Method
get_cycle_limits(value::EnergyReservoirStorage) -> Int64
+

Get EnergyReservoirStorage cycle_limits.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::EnergyReservoirStorage
 ) -> Union{Nothing, DynamicInjection}
-

Get EnergyReservoirStorage dynamic_injector.

source
PowerSystems.get_efficiency — Method
get_efficiency(
+

Get EnergyReservoirStorage dynamic_injector.

source
PowerSystems.get_efficiency — Method
get_efficiency(
     value::EnergyReservoirStorage
 ) -> @NamedTuple{in::Float64, out::Float64}
-

Get EnergyReservoirStorage efficiency.

source
PowerSystems.get_ext — Method
get_ext(value::EnergyReservoirStorage) -> Dict{String, Any}
-

Get EnergyReservoirStorage ext.

source
PowerSystems.get_initial_storage_capacity_level — Method
get_initial_storage_capacity_level(
+

Get EnergyReservoirStorage efficiency.

source
PowerSystems.get_ext — Method
get_ext(value::EnergyReservoirStorage) -> Dict{String, Any}
+

Get EnergyReservoirStorage ext.

source
PowerSystems.get_initial_storage_capacity_level — Method
get_initial_storage_capacity_level(
     value::EnergyReservoirStorage
 ) -> Float64
-

Get EnergyReservoirStorage initial_storage_capacity_level.

source
PowerSystems.get_input_active_power_limits — Method
get_input_active_power_limits(
+

Get EnergyReservoirStorage initial_storage_capacity_level.

source
PowerSystems.get_input_active_power_limits — Method
get_input_active_power_limits(
     value::EnergyReservoirStorage
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get EnergyReservoirStorage input_active_power_limits.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
+

Get EnergyReservoirStorage input_active_power_limits.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
     value::EnergyReservoirStorage
 ) -> StorageCost
-

Get EnergyReservoirStorage operation_cost.

source
PowerSystems.get_output_active_power_limits — Method
get_output_active_power_limits(
+

Get EnergyReservoirStorage operation_cost.

source
PowerSystems.get_output_active_power_limits — Method
get_output_active_power_limits(
     value::EnergyReservoirStorage
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get EnergyReservoirStorage output_active_power_limits.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
+

Get EnergyReservoirStorage output_active_power_limits.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
     value::EnergyReservoirStorage
 ) -> PrimeMovers
-

Get EnergyReservoirStorage prime_mover_type.

source
PowerSystems.get_rating — Method
get_rating(value::EnergyReservoirStorage) -> Any
-

Get EnergyReservoirStorage rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::EnergyReservoirStorage) -> Any
-

Get EnergyReservoirStorage reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
+

Get EnergyReservoirStorage prime_mover_type.

source
PowerSystems.get_rating — Method
get_rating(value::EnergyReservoirStorage) -> Any
+

Get EnergyReservoirStorage rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::EnergyReservoirStorage) -> Any
+

Get EnergyReservoirStorage reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
     value::EnergyReservoirStorage
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get EnergyReservoirStorage reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(
+

Get EnergyReservoirStorage reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(
     value::EnergyReservoirStorage
 ) -> Vector{Service}
-

Get EnergyReservoirStorage services.

source
PowerSystems.get_storage_capacity — Method
get_storage_capacity(value::EnergyReservoirStorage) -> Any
-

Get EnergyReservoirStorage storage_capacity.

source
PowerSystems.get_storage_level_limits — Method
get_storage_level_limits(
+

Get EnergyReservoirStorage services.

source
PowerSystems.get_storage_capacity — Method
get_storage_capacity(value::EnergyReservoirStorage) -> Any
+

Get EnergyReservoirStorage storage_capacity.

source
PowerSystems.get_storage_level_limits — Method
get_storage_level_limits(
     value::EnergyReservoirStorage
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get EnergyReservoirStorage storage_level_limits.

source
PowerSystems.get_storage_target — Method
get_storage_target(value::EnergyReservoirStorage) -> Float64
-

Get EnergyReservoirStorage storage_target.

source
PowerSystems.get_storage_technology_type — Method
get_storage_technology_type(
+

Get EnergyReservoirStorage storage_level_limits.

source
PowerSystems.get_storage_target — Method
get_storage_target(value::EnergyReservoirStorage) -> Float64
+

Get EnergyReservoirStorage storage_target.

source
PowerSystems.get_storage_technology_type — Method
get_storage_technology_type(
     value::EnergyReservoirStorage
 ) -> StorageTech
-

Get EnergyReservoirStorage storage_technology_type.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage active_power.

source
PowerSystems.set_available! — Method
set_available!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage bus.

source
PowerSystems.set_conversion_factor! — Method
set_conversion_factor!(
+

Get EnergyReservoirStorage storage_technology_type.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage active_power.

source
PowerSystems.set_available! — Method
set_available!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage bus.

source
PowerSystems.set_conversion_factor! — Method
set_conversion_factor!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage conversion_factor.

source
PowerSystems.set_cycle_limits! — Method
set_cycle_limits!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage cycle_limits.

source
PowerSystems.set_efficiency! — Method
set_efficiency!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage efficiency.

source
PowerSystems.set_ext! — Method
set_ext!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage ext.

source
PowerSystems.set_initial_storage_capacity_level! — Method
set_initial_storage_capacity_level!(
+

Set EnergyReservoirStorage conversion_factor.

source
PowerSystems.set_cycle_limits! — Method
set_cycle_limits!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage cycle_limits.

source
PowerSystems.set_efficiency! — Method
set_efficiency!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage efficiency.

source
PowerSystems.set_ext! — Method
set_ext!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage ext.

source
PowerSystems.set_initial_storage_capacity_level! — Method
set_initial_storage_capacity_level!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage initial_storage_capacity_level.

source
PowerSystems.set_input_active_power_limits! — Method
set_input_active_power_limits!(
+

Set EnergyReservoirStorage initial_storage_capacity_level.

source
PowerSystems.set_input_active_power_limits! — Method
set_input_active_power_limits!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage input_active_power_limits.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(
+

Set EnergyReservoirStorage input_active_power_limits.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage operation_cost.

source
PowerSystems.set_output_active_power_limits! — Method
set_output_active_power_limits!(
+

Set EnergyReservoirStorage operation_cost.

source
PowerSystems.set_output_active_power_limits! — Method
set_output_active_power_limits!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage output_active_power_limits.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(
+

Set EnergyReservoirStorage output_active_power_limits.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage prime_mover_type.

source
PowerSystems.set_rating! — Method
set_rating!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(
+

Set EnergyReservoirStorage prime_mover_type.

source
PowerSystems.set_rating! — Method
set_rating!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
+

Set EnergyReservoirStorage reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::EnergyReservoirStorage, val) -> Any
-

Set EnergyReservoirStorage services.

source
PowerSystems.set_storage_capacity! — Method
set_storage_capacity!(
+

Set EnergyReservoirStorage reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::EnergyReservoirStorage, val) -> Any
+

Set EnergyReservoirStorage services.

source
PowerSystems.set_storage_capacity! — Method
set_storage_capacity!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage storage_capacity.

source
PowerSystems.set_storage_level_limits! — Method
set_storage_level_limits!(
+

Set EnergyReservoirStorage storage_capacity.

source
PowerSystems.set_storage_level_limits! — Method
set_storage_level_limits!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage storage_level_limits.

source
PowerSystems.set_storage_target! — Method
set_storage_target!(
+

Set EnergyReservoirStorage storage_level_limits.

source
PowerSystems.set_storage_target! — Method
set_storage_target!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage storage_target.

source
PowerSystems.set_storage_technology_type! — Method
set_storage_technology_type!(
+

Set EnergyReservoirStorage storage_target.

source
PowerSystems.set_storage_technology_type! — Method
set_storage_technology_type!(
     value::EnergyReservoirStorage,
     val
 ) -> Any
-

Set EnergyReservoirStorage storage_technology_type.

source
+

Set EnergyReservoirStorage storage_technology_type.

source diff --git a/dev/model_library/generated_ExponentialLoad/index.html b/dev/model_library/generated_ExponentialLoad/index.html index 7c1d7edc4d..320c301098 100644 --- a/dev/model_library/generated_ExponentialLoad/index.html +++ b/dev/model_library/generated_ExponentialLoad/index.html @@ -14,30 +14,30 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A voltage-dependent ZIP load, most commonly used for dynamics modeling.

An ExponentialLoad models active power as P = P0 * V^α and reactive power as Q = Q0 * V^β, where the exponents α and β select govern the voltage dependency. For an alternative three-part formulation of the ZIP model, see StandardLoad. For a simpler load model with no voltage dependency, see PowerLoad

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::ExponentialLoad) -> String
-

Get ExponentialLoad name.

source
PowerSystems.get_active_power — Method
get_active_power(value::ExponentialLoad) -> Any
-

Get ExponentialLoad active_power.

source
PowerSystems.get_available — Method
get_available(value::ExponentialLoad) -> Bool
-

Get ExponentialLoad available.

source
PowerSystems.get_base_power — Method
get_base_power(value::ExponentialLoad) -> Float64
-

Get ExponentialLoad base_power.

source
PowerSystems.get_bus — Method
get_bus(value::ExponentialLoad) -> ACBus
-

Get ExponentialLoad bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A voltage-dependent ZIP load, most commonly used for dynamics modeling.

An ExponentialLoad models active power as P = P0 * V^α and reactive power as Q = Q0 * V^β, where the exponents α and β select govern the voltage dependency. For an alternative three-part formulation of the ZIP model, see StandardLoad. For a simpler load model with no voltage dependency, see PowerLoad

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Active power coefficient, P0 (MW)
  • reactive_power::Float64: Reactive power coefficient, Q0 (MVAR)
  • α::Float64: Exponent relating voltage dependency for active power. 0 = constant power only, 1 = constant current only, and 2 = constant impedance only, validation range: (0, nothing)
  • β::Float64: Exponent relating voltage dependency for reactive power. 0 = constant power only, 1 = constant current only, and 2 = constant impedance only, validation range: (0, nothing)
  • base_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)
  • max_active_power::Float64: Maximum active power (MW) that this load can demand
  • max_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ExponentialLoad) -> String
+

Get ExponentialLoad name.

source
PowerSystems.get_active_power — Method
get_active_power(value::ExponentialLoad) -> Any
+

Get ExponentialLoad active_power.

source
PowerSystems.get_available — Method
get_available(value::ExponentialLoad) -> Bool
+

Get ExponentialLoad available.

source
PowerSystems.get_base_power — Method
get_base_power(value::ExponentialLoad) -> Float64
+

Get ExponentialLoad base_power.

source
PowerSystems.get_bus — Method
get_bus(value::ExponentialLoad) -> ACBus
+

Get ExponentialLoad bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::ExponentialLoad
 ) -> Union{Nothing, DynamicInjection}
-

Get ExponentialLoad dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::ExponentialLoad) -> Dict{String, Any}
-

Get ExponentialLoad ext.

source
PowerSystems.get_max_active_power — Method
get_max_active_power(value::ExponentialLoad) -> Any
-

Get ExponentialLoad max_active_power.

source
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(value::ExponentialLoad) -> Any
-

Get ExponentialLoad max_reactive_power.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::ExponentialLoad) -> Any
-

Get ExponentialLoad reactive_power.

source
PowerSystems.get_services — Method
get_services(value::ExponentialLoad) -> Vector{Service}
-

Get ExponentialLoad services.

source
PowerSystems.get_α — Method
get_α(value::ExponentialLoad) -> Float64
-

Get ExponentialLoad α.

source
PowerSystems.get_β — Method
get_β(value::ExponentialLoad) -> Float64
-

Get ExponentialLoad β.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad active_power.

source
PowerSystems.set_available! — Method
set_available!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad ext.

source
PowerSystems.set_max_active_power! — Method
set_max_active_power!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad max_active_power.

source
PowerSystems.set_max_reactive_power! — Method
set_max_reactive_power!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad max_reactive_power.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad services.

source
PowerSystems.set_α! — Method
set_α!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad α.

source
PowerSystems.set_β! — Method
set_β!(value::ExponentialLoad, val) -> Any
-

Set ExponentialLoad β.

source
+

Get ExponentialLoad dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::ExponentialLoad) -> Dict{String, Any}
+

Get ExponentialLoad ext.

source
PowerSystems.get_max_active_power — Method
get_max_active_power(value::ExponentialLoad) -> Any
+

Get ExponentialLoad max_active_power.

source
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(value::ExponentialLoad) -> Any
+

Get ExponentialLoad max_reactive_power.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::ExponentialLoad) -> Any
+

Get ExponentialLoad reactive_power.

source
PowerSystems.get_services — Method
get_services(value::ExponentialLoad) -> Vector{Service}
+

Get ExponentialLoad services.

source
PowerSystems.get_α — Method
get_α(value::ExponentialLoad) -> Float64
+

Get ExponentialLoad α.

source
PowerSystems.get_β — Method
get_β(value::ExponentialLoad) -> Float64
+

Get ExponentialLoad β.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad active_power.

source
PowerSystems.set_available! — Method
set_available!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad ext.

source
PowerSystems.set_max_active_power! — Method
set_max_active_power!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad max_active_power.

source
PowerSystems.set_max_reactive_power! — Method
set_max_reactive_power!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad max_reactive_power.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad services.

source
PowerSystems.set_α! — Method
set_α!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad α.

source
PowerSystems.set_β! — Method
set_β!(value::ExponentialLoad, val) -> Any
+

Set ExponentialLoad β.

source
diff --git a/dev/model_library/generated_Filter/index.html b/dev/model_library/generated_Filter/index.html index a188de395b..6dc01effef 100644 --- a/dev/model_library/generated_Filter/index.html +++ b/dev/model_library/generated_Filter/index.html @@ -7,17 +7,17 @@ states::Vector{Symbol} n_states::Int end

Parameters of a LCL filter outside the converter

Arguments

ir_filter: Real current out of the filter,
-ii_filter: Imaginary current out of the filter
source
PowerSystems.get_cf — Method
get_cf(value::LCFilter) -> Float64
-

Get LCFilter cf.

source
PowerSystems.get_ext — Method
get_ext(value::LCFilter) -> Dict{String, Any}
-

Get LCFilter ext.

source
PowerSystems.get_lf — Method
get_lf(value::LCFilter) -> Float64
-

Get LCFilter lf.

source
PowerSystems.get_n_states — Method
get_n_states(value::LCFilter) -> Int64
-

Get LCFilter n_states.

source
PowerSystems.get_rf — Method
get_rf(value::LCFilter) -> Float64
-

Get LCFilter rf.

source
PowerSystems.get_states — Method
get_states(value::LCFilter) -> Vector{Symbol}
-

Get LCFilter states.

source
PowerSystems.set_cf! — Method
set_cf!(value::LCFilter, val) -> Any
-

Set LCFilter cf.

source
PowerSystems.set_ext! — Method
set_ext!(value::LCFilter, val) -> Any
-

Set LCFilter ext.

source
PowerSystems.set_lf! — Method
set_lf!(value::LCFilter, val) -> Any
-

Set LCFilter lf.

source
PowerSystems.set_rf! — Method
set_rf!(value::LCFilter, val) -> Any
-

Set LCFilter rf.

source

LCLFilter

PowerSystems.LCLFilter — Type
mutable struct LCLFilter <: Filter
+ii_filter: Imaginary current out of the filter
  • n_states::Int: (Do not modify.) LCFilter has two states
source
PowerSystems.get_cf — Method
get_cf(value::LCFilter) -> Float64
+

Get LCFilter cf.

source
PowerSystems.get_ext — Method
get_ext(value::LCFilter) -> Dict{String, Any}
+

Get LCFilter ext.

source
PowerSystems.get_lf — Method
get_lf(value::LCFilter) -> Float64
+

Get LCFilter lf.

source
PowerSystems.get_n_states — Method
get_n_states(value::LCFilter) -> Int64
+

Get LCFilter n_states.

source
PowerSystems.get_rf — Method
get_rf(value::LCFilter) -> Float64
+

Get LCFilter rf.

source
PowerSystems.get_states — Method
get_states(value::LCFilter) -> Vector{Symbol}
+

Get LCFilter states.

source
PowerSystems.set_cf! — Method
set_cf!(value::LCFilter, val) -> Any
+

Set LCFilter cf.

source
PowerSystems.set_ext! — Method
set_ext!(value::LCFilter, val) -> Any
+

Set LCFilter ext.

source
PowerSystems.set_lf! — Method
set_lf!(value::LCFilter, val) -> Any
+

Set LCFilter lf.

source
PowerSystems.set_rf! — Method
set_rf!(value::LCFilter, val) -> Any
+

Set LCFilter rf.

source

LCLFilter

PowerSystems.LCLFilter — Type
mutable struct LCLFilter <: Filter
     lf::Float64
     rf::Float64
     cf::Float64
@@ -31,32 +31,32 @@
 vr_filter: Real voltage at the filter's capacitor,
 vi_filter: Imaginary voltage at the filter's capacitor,
 ir_filter: Real current out of the filter,
-ii_filter: Imaginary current out of the filter
  • n_states::Int: (Do not modify.) LCLFilter has 6 states
source
PowerSystems.get_cf — Method
get_cf(value::LCLFilter) -> Float64
-

Get LCLFilter cf.

source
PowerSystems.get_ext — Method
get_ext(value::LCLFilter) -> Dict{String, Any}
-

Get LCLFilter ext.

source
PowerSystems.get_lf — Method
get_lf(value::LCLFilter) -> Float64
-

Get LCLFilter lf.

source
PowerSystems.get_lg — Method
get_lg(value::LCLFilter) -> Float64
-

Get LCLFilter lg.

source
PowerSystems.get_n_states — Method
get_n_states(value::LCLFilter) -> Int64
-

Get LCLFilter n_states.

source
PowerSystems.get_rf — Method
get_rf(value::LCLFilter) -> Float64
-

Get LCLFilter rf.

source
PowerSystems.get_rg — Method
get_rg(value::LCLFilter) -> Float64
-

Get LCLFilter rg.

source
PowerSystems.get_states — Method
get_states(value::LCLFilter) -> Vector{Symbol}
-

Get LCLFilter states.

source
PowerSystems.set_cf! — Method
set_cf!(value::LCLFilter, val) -> Any
-

Set LCLFilter cf.

source
PowerSystems.set_ext! — Method
set_ext!(value::LCLFilter, val) -> Any
-

Set LCLFilter ext.

source
PowerSystems.set_lf! — Method
set_lf!(value::LCLFilter, val) -> Any
-

Set LCLFilter lf.

source
PowerSystems.set_lg! — Method
set_lg!(value::LCLFilter, val) -> Any
-

Set LCLFilter lg.

source
PowerSystems.set_rf! — Method
set_rf!(value::LCLFilter, val) -> Any
-

Set LCLFilter rf.

source
PowerSystems.set_rg! — Method
set_rg!(value::LCLFilter, val) -> Any
-

Set LCLFilter rg.

source

RLFilter

PowerSystems.RLFilter — Type
mutable struct RLFilter <: Filter
+ii_filter: Imaginary current out of the filter
  • n_states::Int: (Do not modify.) LCLFilter has 6 states
source
PowerSystems.get_cf — Method
get_cf(value::LCLFilter) -> Float64
+

Get LCLFilter cf.

source
PowerSystems.get_ext — Method
get_ext(value::LCLFilter) -> Dict{String, Any}
+

Get LCLFilter ext.

source
PowerSystems.get_lf — Method
get_lf(value::LCLFilter) -> Float64
+

Get LCLFilter lf.

source
PowerSystems.get_lg — Method
get_lg(value::LCLFilter) -> Float64
+

Get LCLFilter lg.

source
PowerSystems.get_n_states — Method
get_n_states(value::LCLFilter) -> Int64
+

Get LCLFilter n_states.

source
PowerSystems.get_rf — Method
get_rf(value::LCLFilter) -> Float64
+

Get LCLFilter rf.

source
PowerSystems.get_rg — Method
get_rg(value::LCLFilter) -> Float64
+

Get LCLFilter rg.

source
PowerSystems.get_states — Method
get_states(value::LCLFilter) -> Vector{Symbol}
+

Get LCLFilter states.

source
PowerSystems.set_cf! — Method
set_cf!(value::LCLFilter, val) -> Any
+

Set LCLFilter cf.

source
PowerSystems.set_ext! — Method
set_ext!(value::LCLFilter, val) -> Any
+

Set LCLFilter ext.

source
PowerSystems.set_lf! — Method
set_lf!(value::LCLFilter, val) -> Any
+

Set LCLFilter lf.

source
PowerSystems.set_lg! — Method
set_lg!(value::LCLFilter, val) -> Any
+

Set LCLFilter lg.

source
PowerSystems.set_rf! — Method
set_rf!(value::LCLFilter, val) -> Any
+

Set LCLFilter rf.

source
PowerSystems.set_rg! — Method
set_rg!(value::LCLFilter, val) -> Any
+

Set LCLFilter rg.

source

RLFilter

PowerSystems.RLFilter — Type
mutable struct RLFilter <: Filter
     rf::Float64
     lf::Float64
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of RL series filter in algebraic representation

Arguments

  • rf::Float64: Series resistance in p.u. of converter filter to the grid, validation range: (0, nothing)
  • lf::Float64: Series inductance in p.u. of converter filter to the grid, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) RLFilter has zero states
  • n_states::Int: (Do not modify.) RLFilter has zero states
source
PowerSystems.get_ext — Method
get_ext(value::RLFilter) -> Dict{String, Any}
-

Get RLFilter ext.

source
PowerSystems.get_lf — Method
get_lf(value::RLFilter) -> Float64
-

Get RLFilter lf.

source
PowerSystems.get_n_states — Method
get_n_states(value::RLFilter) -> Int64
-

Get RLFilter n_states.

source
PowerSystems.get_rf — Method
get_rf(value::RLFilter) -> Float64
-

Get RLFilter rf.

source
PowerSystems.get_states — Method
get_states(value::RLFilter) -> Vector{Symbol}
-

Get RLFilter states.

source
PowerSystems.set_ext! — Method
set_ext!(value::RLFilter, val) -> Any
-

Set RLFilter ext.

source
PowerSystems.set_lf! — Method
set_lf!(value::RLFilter, val) -> Any
-

Set RLFilter lf.

source
PowerSystems.set_rf! — Method
set_rf!(value::RLFilter, val) -> Any
-

Set RLFilter rf.

source
+end

Parameters of RL series filter in algebraic representation

Arguments

source
PowerSystems.get_ext — Method
get_ext(value::RLFilter) -> Dict{String, Any}
+

Get RLFilter ext.

source
PowerSystems.get_lf — Method
get_lf(value::RLFilter) -> Float64
+

Get RLFilter lf.

source
PowerSystems.get_n_states — Method
get_n_states(value::RLFilter) -> Int64
+

Get RLFilter n_states.

source
PowerSystems.get_rf — Method
get_rf(value::RLFilter) -> Float64
+

Get RLFilter rf.

source
PowerSystems.get_states — Method
get_states(value::RLFilter) -> Vector{Symbol}
+

Get RLFilter states.

source
PowerSystems.set_ext! — Method
set_ext!(value::RLFilter, val) -> Any
+

Set RLFilter ext.

source
PowerSystems.set_lf! — Method
set_lf!(value::RLFilter, val) -> Any
+

Set RLFilter lf.

source
PowerSystems.set_rf! — Method
set_rf!(value::RLFilter, val) -> Any
+

Set RLFilter rf.

source
diff --git a/dev/model_library/generated_FixedAdmittance/index.html b/dev/model_library/generated_FixedAdmittance/index.html index 5c90898aeb..a44f2144b0 100644 --- a/dev/model_library/generated_FixedAdmittance/index.html +++ b/dev/model_library/generated_FixedAdmittance/index.html @@ -8,18 +8,18 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A fixed admittance.

Most often used in dynamics or AC power flow studies as a source of reactive power

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::FixedAdmittance) -> String
-

Get FixedAdmittance name.

source
PowerSystems.get_Y — Method
get_Y(value::FixedAdmittance) -> ComplexF64
-

Get FixedAdmittance Y.

source
PowerSystems.get_available — Method
get_available(value::FixedAdmittance) -> Bool
-

Get FixedAdmittance available.

source
PowerSystems.get_bus — Method
get_bus(value::FixedAdmittance) -> ACBus
-

Get FixedAdmittance bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A fixed admittance.

Most often used in dynamics or AC power flow studies as a source of reactive power

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • Y::Complex{Float64}: Fixed admittance in p.u. (SYSTEM_BASE)
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection model for admittance
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::FixedAdmittance) -> String
+

Get FixedAdmittance name.

source
PowerSystems.get_Y — Method
get_Y(value::FixedAdmittance) -> ComplexF64
+

Get FixedAdmittance Y.

source
PowerSystems.get_available — Method
get_available(value::FixedAdmittance) -> Bool
+

Get FixedAdmittance available.

source
PowerSystems.get_bus — Method
get_bus(value::FixedAdmittance) -> ACBus
+

Get FixedAdmittance bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::FixedAdmittance
 ) -> Union{Nothing, DynamicInjection}
-

Get FixedAdmittance dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::FixedAdmittance) -> Dict{String, Any}
-

Get FixedAdmittance ext.

source
PowerSystems.get_services — Method
get_services(value::FixedAdmittance) -> Vector{Service}
-

Get FixedAdmittance services.

source
PowerSystems.set_Y! — Method
set_Y!(value::FixedAdmittance, val) -> Any
-

Set FixedAdmittance Y.

source
PowerSystems.set_available! — Method
set_available!(value::FixedAdmittance, val) -> Any
-

Set FixedAdmittance available.

source
PowerSystems.set_bus! — Method
set_bus!(value::FixedAdmittance, val) -> Any
-

Set FixedAdmittance bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::FixedAdmittance, val) -> Any
-

Set FixedAdmittance ext.

source
PowerSystems.set_services! — Method
set_services!(value::FixedAdmittance, val) -> Any
-

Set FixedAdmittance services.

source
+

Get FixedAdmittance dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::FixedAdmittance) -> Dict{String, Any}
+

Get FixedAdmittance ext.

source
PowerSystems.get_services — Method
get_services(value::FixedAdmittance) -> Vector{Service}
+

Get FixedAdmittance services.

source
PowerSystems.set_Y! — Method
set_Y!(value::FixedAdmittance, val) -> Any
+

Set FixedAdmittance Y.

source
PowerSystems.set_available! — Method
set_available!(value::FixedAdmittance, val) -> Any
+

Set FixedAdmittance available.

source
PowerSystems.set_bus! — Method
set_bus!(value::FixedAdmittance, val) -> Any
+

Set FixedAdmittance bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::FixedAdmittance, val) -> Any
+

Set FixedAdmittance ext.

source
PowerSystems.set_services! — Method
set_services!(value::FixedAdmittance, val) -> Any
+

Set FixedAdmittance services.

source
diff --git a/dev/model_library/generated_FrequencyEstimator/index.html b/dev/model_library/generated_FrequencyEstimator/index.html index b620391c76..3b7b323953 100644 --- a/dev/model_library/generated_FrequencyEstimator/index.html +++ b/dev/model_library/generated_FrequencyEstimator/index.html @@ -4,13 +4,13 @@ ext::Dict{String, Any} states::Vector{Symbol} n_states::Int -end

Parameters of a Fixed Frequency Estimator (i.e. no PLL)

Arguments

source
PowerSystems.get_ext — Method
get_ext(value::FixedFrequency) -> Dict{String, Any}
-

Get FixedFrequency ext.

source
PowerSystems.get_frequency — Method
get_frequency(value::FixedFrequency) -> Float64
-

Get FixedFrequency frequency.

source
PowerSystems.get_n_states — Method
get_n_states(value::FixedFrequency) -> Int64
-

Get FixedFrequency n_states.

source
PowerSystems.get_states — Method
get_states(value::FixedFrequency) -> Vector{Symbol}
-

Get FixedFrequency states.

source
PowerSystems.set_ext! — Method
set_ext!(value::FixedFrequency, val) -> Any
-

Set FixedFrequency ext.

source
PowerSystems.set_frequency! — Method
set_frequency!(value::FixedFrequency, val) -> Any
-

Set FixedFrequency frequency.

source

KauraPLL

PowerSystems.KauraPLL — Type
mutable struct KauraPLL <: FrequencyEstimator
+end

Parameters of a Fixed Frequency Estimator (i.e. no PLL)

Arguments

  • frequency::Float64: (default: 1.0) Reference Frequency (pu)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) FixedFrequency has no states
  • n_states::Int: (Do not modify.) FixedFrequency has no states
source
PowerSystems.get_ext — Method
get_ext(value::FixedFrequency) -> Dict{String, Any}
+

Get FixedFrequency ext.

source
PowerSystems.get_frequency — Method
get_frequency(value::FixedFrequency) -> Float64
+

Get FixedFrequency frequency.

source
PowerSystems.get_n_states — Method
get_n_states(value::FixedFrequency) -> Int64
+

Get FixedFrequency n_states.

source
PowerSystems.get_states — Method
get_states(value::FixedFrequency) -> Vector{Symbol}
+

Get FixedFrequency states.

source
PowerSystems.set_ext! — Method
set_ext!(value::FixedFrequency, val) -> Any
+

Set FixedFrequency ext.

source
PowerSystems.set_frequency! — Method
set_frequency!(value::FixedFrequency, val) -> Any
+

Set FixedFrequency frequency.

source

KauraPLL

PowerSystems.KauraPLL — Type
mutable struct KauraPLL <: FrequencyEstimator
     ω_lp::Float64
     kp_pll::Float64
     ki_pll::Float64
@@ -20,17 +20,17 @@
 end

Parameters of a Phase-Locked Loop (PLL) based on "Operation of a phase locked loop system under distorted utility conditions" by Vikram Kaura, and Vladimir Blasko

Arguments

  • ω_lp::Float64: PLL low-pass filter frequency (rad/sec), validation range: (0, nothing)
  • kp_pll::Float64: PLL proportional gain, validation range: (0, nothing)
  • ki_pll::Float64: PLL integral gain, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the KauraPLL model are:
vd_pll: d-axis of the measured voltage in the PLL synchronous reference frame (SRF),
 vq_pll: q-axis of the measured voltage in the PLL SRF,
 ε_pll: Integrator state of the PI controller,
-θ_pll: Phase angle displacement in the PLL SRF
  • n_states::Int: (Do not modify.) KauraPLL has 4 states
source
PowerSystems.get_ext — Method
get_ext(value::KauraPLL) -> Dict{String, Any}
-

Get KauraPLL ext.

source
PowerSystems.get_ki_pll — Method
get_ki_pll(value::KauraPLL) -> Float64
-

Get KauraPLL ki_pll.

source
PowerSystems.get_kp_pll — Method
get_kp_pll(value::KauraPLL) -> Float64
-

Get KauraPLL kp_pll.

source
PowerSystems.get_n_states — Method
get_n_states(value::KauraPLL) -> Int64
-

Get KauraPLL n_states.

source
PowerSystems.get_states — Method
get_states(value::KauraPLL) -> Vector{Symbol}
-

Get KauraPLL states.

source
PowerSystems.get_ω_lp — Method
get_ω_lp(value::KauraPLL) -> Float64
-

Get KauraPLL ω_lp.

source
PowerSystems.set_ext! — Method
set_ext!(value::KauraPLL, val) -> Any
-

Set KauraPLL ext.

source
PowerSystems.set_ki_pll! — Method
set_ki_pll!(value::KauraPLL, val) -> Any
-

Set KauraPLL ki_pll.

source
PowerSystems.set_kp_pll! — Method
set_kp_pll!(value::KauraPLL, val) -> Any
-

Set KauraPLL kp_pll.

source
PowerSystems.set_ω_lp! — Method
set_ω_lp!(value::KauraPLL, val) -> Any
-

Set KauraPLL ω_lp.

source

ReducedOrderPLL

PowerSystems.ReducedOrderPLL — Type
mutable struct ReducedOrderPLL <: FrequencyEstimator
+θ_pll: Phase angle displacement in the PLL SRF
  • n_states::Int: (Do not modify.) KauraPLL has 4 states
source
PowerSystems.get_ext — Method
get_ext(value::KauraPLL) -> Dict{String, Any}
+

Get KauraPLL ext.

source
PowerSystems.get_ki_pll — Method
get_ki_pll(value::KauraPLL) -> Float64
+

Get KauraPLL ki_pll.

source
PowerSystems.get_kp_pll — Method
get_kp_pll(value::KauraPLL) -> Float64
+

Get KauraPLL kp_pll.

source
PowerSystems.get_n_states — Method
get_n_states(value::KauraPLL) -> Int64
+

Get KauraPLL n_states.

source
PowerSystems.get_states — Method
get_states(value::KauraPLL) -> Vector{Symbol}
+

Get KauraPLL states.

source
PowerSystems.get_ω_lp — Method
get_ω_lp(value::KauraPLL) -> Float64
+

Get KauraPLL ω_lp.

source
PowerSystems.set_ext! — Method
set_ext!(value::KauraPLL, val) -> Any
+

Set KauraPLL ext.

source
PowerSystems.set_ki_pll! — Method
set_ki_pll!(value::KauraPLL, val) -> Any
+

Set KauraPLL ki_pll.

source
PowerSystems.set_kp_pll! — Method
set_kp_pll!(value::KauraPLL, val) -> Any
+

Set KauraPLL kp_pll.

source
PowerSystems.set_ω_lp! — Method
set_ω_lp!(value::KauraPLL, val) -> Any
+

Set KauraPLL ω_lp.

source

ReducedOrderPLL

PowerSystems.ReducedOrderPLL — Type
mutable struct ReducedOrderPLL <: FrequencyEstimator
     ω_lp::Float64
     kp_pll::Float64
     ki_pll::Float64
@@ -39,14 +39,14 @@
     n_states::Int
 end

Parameters of a Phase-Locked Loop (PLL) based on "Reduced-order Structure-preserving Model for Parallel-connected Three-phase Grid-tied Inverters."

Arguments

  • ω_lp::Float64: PLL low-pass filter frequency (rad/sec), validation range: (0, nothing)
  • kp_pll::Float64: PLL proportional gain, validation range: (0, nothing)
  • ki_pll::Float64: PLL integral gain, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the ReducedOrderPLL model are:
vq_pll: q-axis of the measured voltage in the PLL synchronous reference frame (SRF),
 ε_pll: Integrator state of the PI controller,
-θ_pll: Phase angle displacement in the PLL SRF
  • n_states::Int: (Do not modify.) ReducedOrderPLL has 3 states
source
PowerSystems.get_ext — Method
get_ext(value::ReducedOrderPLL) -> Dict{String, Any}
-

Get ReducedOrderPLL ext.

source
PowerSystems.get_ki_pll — Method
get_ki_pll(value::ReducedOrderPLL) -> Float64
-

Get ReducedOrderPLL ki_pll.

source
PowerSystems.get_kp_pll — Method
get_kp_pll(value::ReducedOrderPLL) -> Float64
-

Get ReducedOrderPLL kp_pll.

source
PowerSystems.get_n_states — Method
get_n_states(value::ReducedOrderPLL) -> Int64
-

Get ReducedOrderPLL n_states.

source
PowerSystems.get_states — Method
get_states(value::ReducedOrderPLL) -> Vector{Symbol}
-

Get ReducedOrderPLL states.

source
PowerSystems.get_ω_lp — Method
get_ω_lp(value::ReducedOrderPLL) -> Float64
-

Get ReducedOrderPLL ω_lp.

source
PowerSystems.set_ext! — Method
set_ext!(value::ReducedOrderPLL, val) -> Any
-

Set ReducedOrderPLL ext.

source
PowerSystems.set_ki_pll! — Method
set_ki_pll!(value::ReducedOrderPLL, val) -> Any
-

Set ReducedOrderPLL ki_pll.

source
PowerSystems.set_kp_pll! — Method
set_kp_pll!(value::ReducedOrderPLL, val) -> Any
-

Set ReducedOrderPLL kp_pll.

source
PowerSystems.set_ω_lp! — Method
set_ω_lp!(value::ReducedOrderPLL, val) -> Any
-

Set ReducedOrderPLL ω_lp.

source
+θ_pll: Phase angle displacement in the PLL SRFsource
PowerSystems.get_ext — Method
get_ext(value::ReducedOrderPLL) -> Dict{String, Any}
+

Get ReducedOrderPLL ext.

source
PowerSystems.get_ki_pll — Method
get_ki_pll(value::ReducedOrderPLL) -> Float64
+

Get ReducedOrderPLL ki_pll.

source
PowerSystems.get_kp_pll — Method
get_kp_pll(value::ReducedOrderPLL) -> Float64
+

Get ReducedOrderPLL kp_pll.

source
PowerSystems.get_n_states — Method
get_n_states(value::ReducedOrderPLL) -> Int64
+

Get ReducedOrderPLL n_states.

source
PowerSystems.get_states — Method
get_states(value::ReducedOrderPLL) -> Vector{Symbol}
+

Get ReducedOrderPLL states.

source
PowerSystems.get_ω_lp — Method
get_ω_lp(value::ReducedOrderPLL) -> Float64
+

Get ReducedOrderPLL ω_lp.

source
PowerSystems.set_ext! — Method
set_ext!(value::ReducedOrderPLL, val) -> Any
+

Set ReducedOrderPLL ext.

source
PowerSystems.set_ki_pll! — Method
set_ki_pll!(value::ReducedOrderPLL, val) -> Any
+

Set ReducedOrderPLL ki_pll.

source
PowerSystems.set_kp_pll! — Method
set_kp_pll!(value::ReducedOrderPLL, val) -> Any
+

Set ReducedOrderPLL kp_pll.

source
PowerSystems.set_ω_lp! — Method
set_ω_lp!(value::ReducedOrderPLL, val) -> Any
+

Set ReducedOrderPLL ω_lp.

source
diff --git a/dev/model_library/generated_HydroDispatch/index.html b/dev/model_library/generated_HydroDispatch/index.html index 8c252a9fd6..b19fa3ae34 100644 --- a/dev/model_library/generated_HydroDispatch/index.html +++ b/dev/model_library/generated_HydroDispatch/index.html @@ -17,46 +17,46 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A hydropower generator without a reservoir, suitable for modeling run-of-river hydropower.

For hydro generators with an upper reservoir, see HydroEnergyReservoir

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::HydroDispatch) -> String
-

Get HydroDispatch name.

source
PowerSystems.get_active_power — Method
get_active_power(value::HydroDispatch) -> Any
-

Get HydroDispatch active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
+end

A hydropower generator without a reservoir, suitable for modeling run-of-river hydropower.

For hydro generators with an upper reservoir, see HydroEnergyReservoir

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits
  • rating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)
  • prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here
  • active_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)
  • reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable
  • ramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)
  • time_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating, validation range: (0, nothing)
  • operation_cost::Union{HydroGenerationCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::HydroDispatch) -> String
+

Get HydroDispatch name.

source
PowerSystems.get_active_power — Method
get_active_power(value::HydroDispatch) -> Any
+

Get HydroDispatch active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
     value::HydroDispatch
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get HydroDispatch active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::HydroDispatch) -> Bool
-

Get HydroDispatch available.

source
PowerSystems.get_base_power — Method
get_base_power(value::HydroDispatch) -> Float64
-

Get HydroDispatch base_power.

source
PowerSystems.get_bus — Method
get_bus(value::HydroDispatch) -> ACBus
-

Get HydroDispatch bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+

Get HydroDispatch active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::HydroDispatch) -> Bool
+

Get HydroDispatch available.

source
PowerSystems.get_base_power — Method
get_base_power(value::HydroDispatch) -> Float64
+

Get HydroDispatch base_power.

source
PowerSystems.get_bus — Method
get_bus(value::HydroDispatch) -> ACBus
+

Get HydroDispatch bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::HydroDispatch
 ) -> Union{Nothing, DynamicInjection}
-

Get HydroDispatch dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::HydroDispatch) -> Dict{String, Any}
-

Get HydroDispatch ext.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
+

Get HydroDispatch dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::HydroDispatch) -> Dict{String, Any}
+

Get HydroDispatch ext.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
     value::HydroDispatch
 ) -> Union{HydroGenerationCost, MarketBidCost}
-

Get HydroDispatch operation_cost.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(value::HydroDispatch) -> PrimeMovers
-

Get HydroDispatch prime_mover_type.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
+

Get HydroDispatch operation_cost.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(value::HydroDispatch) -> PrimeMovers
+

Get HydroDispatch prime_mover_type.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
     value::HydroDispatch
 ) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}
-

Get HydroDispatch ramp_limits.

source
PowerSystems.get_rating — Method
get_rating(value::HydroDispatch) -> Any
-

Get HydroDispatch rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::HydroDispatch) -> Any
-

Get HydroDispatch reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
+

Get HydroDispatch ramp_limits.

source
PowerSystems.get_rating — Method
get_rating(value::HydroDispatch) -> Any
+

Get HydroDispatch rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::HydroDispatch) -> Any
+

Get HydroDispatch reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
     value::HydroDispatch
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get HydroDispatch reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::HydroDispatch) -> Vector{Service}
-

Get HydroDispatch services.

source
PowerSystems.get_time_limits — Method
get_time_limits(
+

Get HydroDispatch reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::HydroDispatch) -> Vector{Service}
+

Get HydroDispatch services.

source
PowerSystems.get_time_limits — Method
get_time_limits(
     value::HydroDispatch
 ) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}
-

Get HydroDispatch time_limits.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch ext.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch operation_cost.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch prime_mover_type.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch ramp_limits.

source
PowerSystems.set_rating! — Method
set_rating!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch services.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::HydroDispatch, val) -> Any
-

Set HydroDispatch time_limits.

source
+

Get HydroDispatch time_limits.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch ext.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch operation_cost.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch prime_mover_type.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch ramp_limits.

source
PowerSystems.set_rating! — Method
set_rating!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch services.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::HydroDispatch, val) -> Any
+

Set HydroDispatch time_limits.

source
diff --git a/dev/model_library/generated_HydroEnergyReservoir/index.html b/dev/model_library/generated_HydroEnergyReservoir/index.html index 2e04b7cf9d..ea835ad30d 100644 --- a/dev/model_library/generated_HydroEnergyReservoir/index.html +++ b/dev/model_library/generated_HydroEnergyReservoir/index.html @@ -24,82 +24,82 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A hydropower generator with an upper reservoir, offering some energy storage and operational flexibility.

For hydro generators with pumped storage, see HydroPumpedStorage

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::HydroEnergyReservoir) -> String
-

Get HydroEnergyReservoir name.

source
PowerSystems.get_active_power — Method
get_active_power(value::HydroEnergyReservoir) -> Any
-

Get HydroEnergyReservoir active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
+end

A hydropower generator with an upper reservoir, offering some energy storage and operational flexibility.

For hydro generators with pumped storage, see HydroPumpedStorage

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits
  • rating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)
  • prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here
  • active_power_limits::MinMax: Minimum and maximum stable active power levels (MW)
  • reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable
  • ramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)
  • time_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating, validation range: (0, nothing)
  • storage_capacity::Float64: Maximum storage capacity in the reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)
  • inflow::Float64: Baseline inflow into the reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)
  • initial_storage::Float64: Initial storage capacity in the reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)
  • operation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation
  • storage_target::Float64: (default: 1.0) Storage target at the end of simulation as a fraction of storage capacity
  • conversion_factor::Float64: (default: 1.0) Conversion factor from flow/volume to energy: m^3 -> p.u-hr
  • status::Bool: (default: false) Initial commitment condition at the start of a simulation (true = on or false = off)
  • time_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::HydroEnergyReservoir) -> String
+

Get HydroEnergyReservoir name.

source
PowerSystems.get_active_power — Method
get_active_power(value::HydroEnergyReservoir) -> Any
+

Get HydroEnergyReservoir active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
     value::HydroEnergyReservoir
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get HydroEnergyReservoir active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::HydroEnergyReservoir) -> Bool
-

Get HydroEnergyReservoir available.

source
PowerSystems.get_base_power — Method
get_base_power(value::HydroEnergyReservoir) -> Float64
-

Get HydroEnergyReservoir base_power.

source
PowerSystems.get_bus — Method
get_bus(value::HydroEnergyReservoir) -> ACBus
-

Get HydroEnergyReservoir bus.

source
PowerSystems.get_conversion_factor — Method
get_conversion_factor(
+

Get HydroEnergyReservoir active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::HydroEnergyReservoir) -> Bool
+

Get HydroEnergyReservoir available.

source
PowerSystems.get_base_power — Method
get_base_power(value::HydroEnergyReservoir) -> Float64
+

Get HydroEnergyReservoir base_power.

source
PowerSystems.get_bus — Method
get_bus(value::HydroEnergyReservoir) -> ACBus
+

Get HydroEnergyReservoir bus.

source
PowerSystems.get_conversion_factor — Method
get_conversion_factor(
     value::HydroEnergyReservoir
 ) -> Float64
-

Get HydroEnergyReservoir conversion_factor.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+

Get HydroEnergyReservoir conversion_factor.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::HydroEnergyReservoir
 ) -> Union{Nothing, DynamicInjection}
-

Get HydroEnergyReservoir dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::HydroEnergyReservoir) -> Dict{String, Any}
-

Get HydroEnergyReservoir ext.

source
PowerSystems.get_inflow — Method
get_inflow(value::HydroEnergyReservoir) -> Any
-

Get HydroEnergyReservoir inflow.

source
PowerSystems.get_initial_storage — Method
get_initial_storage(value::HydroEnergyReservoir) -> Any
-

Get HydroEnergyReservoir initial_storage.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
+

Get HydroEnergyReservoir dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::HydroEnergyReservoir) -> Dict{String, Any}
+

Get HydroEnergyReservoir ext.

source
PowerSystems.get_inflow — Method
get_inflow(value::HydroEnergyReservoir) -> Any
+

Get HydroEnergyReservoir inflow.

source
PowerSystems.get_initial_storage — Method
get_initial_storage(value::HydroEnergyReservoir) -> Any
+

Get HydroEnergyReservoir initial_storage.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
     value::HydroEnergyReservoir
 ) -> Union{HydroGenerationCost, MarketBidCost, StorageCost}
-

Get HydroEnergyReservoir operation_cost.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
+

Get HydroEnergyReservoir operation_cost.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
     value::HydroEnergyReservoir
 ) -> PrimeMovers
-

Get HydroEnergyReservoir prime_mover_type.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
+

Get HydroEnergyReservoir prime_mover_type.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
     value::HydroEnergyReservoir
 ) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}
-

Get HydroEnergyReservoir ramp_limits.

source
PowerSystems.get_rating — Method
get_rating(value::HydroEnergyReservoir) -> Any
-

Get HydroEnergyReservoir rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::HydroEnergyReservoir) -> Any
-

Get HydroEnergyReservoir reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
+

Get HydroEnergyReservoir ramp_limits.

source
PowerSystems.get_rating — Method
get_rating(value::HydroEnergyReservoir) -> Any
+

Get HydroEnergyReservoir rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::HydroEnergyReservoir) -> Any
+

Get HydroEnergyReservoir reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
     value::HydroEnergyReservoir
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get HydroEnergyReservoir reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::HydroEnergyReservoir) -> Vector{Service}
-

Get HydroEnergyReservoir services.

source
PowerSystems.get_status — Method
get_status(value::HydroEnergyReservoir) -> Bool
-

Get HydroEnergyReservoir status.

source
PowerSystems.get_storage_capacity — Method
get_storage_capacity(value::HydroEnergyReservoir) -> Any
-

Get HydroEnergyReservoir storage_capacity.

source
PowerSystems.get_storage_target — Method
get_storage_target(value::HydroEnergyReservoir) -> Float64
-

Get HydroEnergyReservoir storage_target.

source
PowerSystems.get_time_at_status — Method
get_time_at_status(value::HydroEnergyReservoir) -> Float64
-

Get HydroEnergyReservoir time_at_status.

source
PowerSystems.get_time_limits — Method
get_time_limits(
+

Get HydroEnergyReservoir reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::HydroEnergyReservoir) -> Vector{Service}
+

Get HydroEnergyReservoir services.

source
PowerSystems.get_status — Method
get_status(value::HydroEnergyReservoir) -> Bool
+

Get HydroEnergyReservoir status.

source
PowerSystems.get_storage_capacity — Method
get_storage_capacity(value::HydroEnergyReservoir) -> Any
+

Get HydroEnergyReservoir storage_capacity.

source
PowerSystems.get_storage_target — Method
get_storage_target(value::HydroEnergyReservoir) -> Float64
+

Get HydroEnergyReservoir storage_target.

source
PowerSystems.get_time_at_status — Method
get_time_at_status(value::HydroEnergyReservoir) -> Float64
+

Get HydroEnergyReservoir time_at_status.

source
PowerSystems.get_time_limits — Method
get_time_limits(
     value::HydroEnergyReservoir
 ) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}
-

Get HydroEnergyReservoir time_limits.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
+

Get HydroEnergyReservoir time_limits.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
     value::HydroEnergyReservoir,
     val
 ) -> Any
-

Set HydroEnergyReservoir active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir bus.

source
PowerSystems.set_conversion_factor! — Method
set_conversion_factor!(
+

Set HydroEnergyReservoir active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir bus.

source
PowerSystems.set_conversion_factor! — Method
set_conversion_factor!(
     value::HydroEnergyReservoir,
     val
 ) -> Any
-

Set HydroEnergyReservoir conversion_factor.

source
PowerSystems.set_ext! — Method
set_ext!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir ext.

source
PowerSystems.set_inflow! — Method
set_inflow!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir inflow.

source
PowerSystems.set_initial_storage! — Method
set_initial_storage!(
+

Set HydroEnergyReservoir conversion_factor.

source
PowerSystems.set_ext! — Method
set_ext!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir ext.

source
PowerSystems.set_inflow! — Method
set_inflow!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir inflow.

source
PowerSystems.set_initial_storage! — Method
set_initial_storage!(
     value::HydroEnergyReservoir,
     val
 ) -> Any
-

Set HydroEnergyReservoir initial_storage.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir operation_cost.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(
+

Set HydroEnergyReservoir initial_storage.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir operation_cost.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(
     value::HydroEnergyReservoir,
     val
 ) -> Any
-

Set HydroEnergyReservoir prime_mover_type.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir ramp_limits.

source
PowerSystems.set_rating! — Method
set_rating!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
+

Set HydroEnergyReservoir prime_mover_type.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir ramp_limits.

source
PowerSystems.set_rating! — Method
set_rating!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
     value::HydroEnergyReservoir,
     val
 ) -> Any
-

Set HydroEnergyReservoir reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir services.

source
PowerSystems.set_status! — Method
set_status!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir status.

source
PowerSystems.set_storage_capacity! — Method
set_storage_capacity!(
+

Set HydroEnergyReservoir reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir services.

source
PowerSystems.set_status! — Method
set_status!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir status.

source
PowerSystems.set_storage_capacity! — Method
set_storage_capacity!(
     value::HydroEnergyReservoir,
     val
 ) -> Any
-

Set HydroEnergyReservoir storage_capacity.

source
PowerSystems.set_storage_target! — Method
set_storage_target!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir storage_target.

source
PowerSystems.set_time_at_status! — Method
set_time_at_status!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir time_at_status.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::HydroEnergyReservoir, val) -> Any
-

Set HydroEnergyReservoir time_limits.

source
+

Set HydroEnergyReservoir storage_capacity.

source
PowerSystems.set_storage_target! — Method
set_storage_target!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir storage_target.

source
PowerSystems.set_time_at_status! — Method
set_time_at_status!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir time_at_status.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::HydroEnergyReservoir, val) -> Any
+

Set HydroEnergyReservoir time_limits.

source
diff --git a/dev/model_library/generated_HydroPumpedStorage/index.html b/dev/model_library/generated_HydroPumpedStorage/index.html index 459aeee17e..db4f58c648 100644 --- a/dev/model_library/generated_HydroPumpedStorage/index.html +++ b/dev/model_library/generated_HydroPumpedStorage/index.html @@ -31,107 +31,107 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A hydropower generator with pumped storage and upper and lower reservoirs.

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::HydroPumpedStorage) -> String
-

Get HydroPumpedStorage name.

source
PowerSystems.get_active_power — Method
get_active_power(value::HydroPumpedStorage) -> Any
-

Get HydroPumpedStorage active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
+end

A hydropower generator with pumped storage and upper and lower reservoirs.

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR)
  • rating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating, validation range: (0, nothing)
  • prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here
  • active_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)
  • reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable
  • ramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)
  • time_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)
  • rating_pump::Float64: Maximum power withdrawal (MVA) of the pump, validation range: (0, nothing)
  • active_power_limits_pump::MinMax:
  • reactive_power_limits_pump::Union{Nothing, MinMax}:
  • ramp_limits_pump::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min of pump, validation range: (0, nothing)
  • time_limits_pump::Union{Nothing, UpDown}: Minimum up and Minimum down time limits of pump in hours, validation range: (0, nothing)
  • storage_capacity::UpDown: Maximum storage capacity in the upper and lower reservoirs (units can be p.u-hr or m^3), validation range: (0, nothing)
  • inflow::Float64: Baseline inflow into the upper reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)
  • outflow::Float64: Baseline outflow from the lower reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)
  • initial_storage::UpDown: Initial storage capacity in the upper and lower reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)
  • storage_target::UpDown: (default: (up=1.0, down=1.0)) Storage target of upper reservoir at the end of simulation as ratio of storage capacity
  • operation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation
  • pump_efficiency::Float64: (default: 1.0) Pumping efficiency [0, 1.0], validation range: (0, 1)
  • conversion_factor::Float64: (default: 1.0) Conversion factor from flow/volume to energy: m^3 -> p.u-hr
  • status::PumpHydroStatus: (default: PumpHydroStatus.OFF) Initial commitment condition at the start of a simulation (PumpHydroStatus.PUMP, PumpHydroStatus.GEN, or PumpHydroStatus.OFF)
  • time_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been generating, pumping, or off, as indicated by status
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::HydroPumpedStorage) -> String
+

Get HydroPumpedStorage name.

source
PowerSystems.get_active_power — Method
get_active_power(value::HydroPumpedStorage) -> Any
+

Get HydroPumpedStorage active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
     value::HydroPumpedStorage
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get HydroPumpedStorage active_power_limits.

source
PowerSystems.get_active_power_limits_pump — Method
get_active_power_limits_pump(
+

Get HydroPumpedStorage active_power_limits.

source
PowerSystems.get_active_power_limits_pump — Method
get_active_power_limits_pump(
     value::HydroPumpedStorage
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get HydroPumpedStorage active_power_limits_pump.

source
PowerSystems.get_available — Method
get_available(value::HydroPumpedStorage) -> Bool
-

Get HydroPumpedStorage available.

source
PowerSystems.get_base_power — Method
get_base_power(value::HydroPumpedStorage) -> Float64
-

Get HydroPumpedStorage base_power.

source
PowerSystems.get_bus — Method
get_bus(value::HydroPumpedStorage) -> ACBus
-

Get HydroPumpedStorage bus.

source
PowerSystems.get_conversion_factor — Method
get_conversion_factor(value::HydroPumpedStorage) -> Float64
-

Get HydroPumpedStorage conversion_factor.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+

Get HydroPumpedStorage active_power_limits_pump.

source
PowerSystems.get_available — Method
get_available(value::HydroPumpedStorage) -> Bool
+

Get HydroPumpedStorage available.

source
PowerSystems.get_base_power — Method
get_base_power(value::HydroPumpedStorage) -> Float64
+

Get HydroPumpedStorage base_power.

source
PowerSystems.get_bus — Method
get_bus(value::HydroPumpedStorage) -> ACBus
+

Get HydroPumpedStorage bus.

source
PowerSystems.get_conversion_factor — Method
get_conversion_factor(value::HydroPumpedStorage) -> Float64
+

Get HydroPumpedStorage conversion_factor.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::HydroPumpedStorage
 ) -> Union{Nothing, DynamicInjection}
-

Get HydroPumpedStorage dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::HydroPumpedStorage) -> Dict{String, Any}
-

Get HydroPumpedStorage ext.

source
PowerSystems.get_inflow — Method
get_inflow(value::HydroPumpedStorage) -> Any
-

Get HydroPumpedStorage inflow.

source
PowerSystems.get_initial_storage — Method
get_initial_storage(
+

Get HydroPumpedStorage dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::HydroPumpedStorage) -> Dict{String, Any}
+

Get HydroPumpedStorage ext.

source
PowerSystems.get_inflow — Method
get_inflow(value::HydroPumpedStorage) -> Any
+

Get HydroPumpedStorage inflow.

source
PowerSystems.get_initial_storage — Method
get_initial_storage(
     value::HydroPumpedStorage
 ) -> NamedTuple{(:up, :down), <:Tuple{Any, Any}}
-

Get HydroPumpedStorage initial_storage.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
+

Get HydroPumpedStorage initial_storage.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
     value::HydroPumpedStorage
 ) -> Union{HydroGenerationCost, MarketBidCost, StorageCost}
-

Get HydroPumpedStorage operation_cost.

source
PowerSystems.get_outflow — Method
get_outflow(value::HydroPumpedStorage) -> Float64
-

Get HydroPumpedStorage outflow.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
+

Get HydroPumpedStorage operation_cost.

source
PowerSystems.get_outflow — Method
get_outflow(value::HydroPumpedStorage) -> Float64
+

Get HydroPumpedStorage outflow.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
     value::HydroPumpedStorage
 ) -> PrimeMovers
-

Get HydroPumpedStorage prime_mover_type.

source
PowerSystems.get_pump_efficiency — Method
get_pump_efficiency(value::HydroPumpedStorage) -> Float64
-

Get HydroPumpedStorage pump_efficiency.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
+

Get HydroPumpedStorage prime_mover_type.

source
PowerSystems.get_pump_efficiency — Method
get_pump_efficiency(value::HydroPumpedStorage) -> Float64
+

Get HydroPumpedStorage pump_efficiency.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
     value::HydroPumpedStorage
 ) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}
-

Get HydroPumpedStorage ramp_limits.

source
PowerSystems.get_ramp_limits_pump — Method
get_ramp_limits_pump(
+

Get HydroPumpedStorage ramp_limits.

source
PowerSystems.get_ramp_limits_pump — Method
get_ramp_limits_pump(
     value::HydroPumpedStorage
 ) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}
-

Get HydroPumpedStorage ramp_limits_pump.

source
PowerSystems.get_rating — Method
get_rating(value::HydroPumpedStorage) -> Any
-

Get HydroPumpedStorage rating.

source
PowerSystems.get_rating_pump — Method
get_rating_pump(value::HydroPumpedStorage) -> Any
-

Get HydroPumpedStorage rating_pump.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::HydroPumpedStorage) -> Any
-

Get HydroPumpedStorage reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
+

Get HydroPumpedStorage ramp_limits_pump.

source
PowerSystems.get_rating — Method
get_rating(value::HydroPumpedStorage) -> Any
+

Get HydroPumpedStorage rating.

source
PowerSystems.get_rating_pump — Method
get_rating_pump(value::HydroPumpedStorage) -> Any
+

Get HydroPumpedStorage rating_pump.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::HydroPumpedStorage) -> Any
+

Get HydroPumpedStorage reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
     value::HydroPumpedStorage
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get HydroPumpedStorage reactive_power_limits.

source
PowerSystems.get_reactive_power_limits_pump — Method
get_reactive_power_limits_pump(
+

Get HydroPumpedStorage reactive_power_limits.

source
PowerSystems.get_reactive_power_limits_pump — Method
get_reactive_power_limits_pump(
     value::HydroPumpedStorage
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get HydroPumpedStorage reactive_power_limits_pump.

source
PowerSystems.get_services — Method
get_services(value::HydroPumpedStorage) -> Vector{Service}
-

Get HydroPumpedStorage services.

source
PowerSystems.get_status — Method
get_status(
+

Get HydroPumpedStorage reactive_power_limits_pump.

source
PowerSystems.get_services — Method
get_services(value::HydroPumpedStorage) -> Vector{Service}
+

Get HydroPumpedStorage services.

source
PowerSystems.get_status — Method
get_status(
     value::HydroPumpedStorage
 ) -> PowerSystems.PumpHydroStatusModule.PumpHydroStatus
-

Get HydroPumpedStorage status.

source
PowerSystems.get_storage_capacity — Method
get_storage_capacity(
+

Get HydroPumpedStorage status.

source
PowerSystems.get_storage_capacity — Method
get_storage_capacity(
     value::HydroPumpedStorage
 ) -> NamedTuple{(:up, :down), <:Tuple{Any, Any}}
-

Get HydroPumpedStorage storage_capacity.

source
PowerSystems.get_storage_target — Method
get_storage_target(
+

Get HydroPumpedStorage storage_capacity.

source
PowerSystems.get_storage_target — Method
get_storage_target(
     value::HydroPumpedStorage
 ) -> @NamedTuple{up::Float64, down::Float64}
-

Get HydroPumpedStorage storage_target.

source
PowerSystems.get_time_at_status — Method
get_time_at_status(value::HydroPumpedStorage) -> Float64
-

Get HydroPumpedStorage time_at_status.

source
PowerSystems.get_time_limits — Method
get_time_limits(
+

Get HydroPumpedStorage storage_target.

source
PowerSystems.get_time_at_status — Method
get_time_at_status(value::HydroPumpedStorage) -> Float64
+

Get HydroPumpedStorage time_at_status.

source
PowerSystems.get_time_limits — Method
get_time_limits(
     value::HydroPumpedStorage
 ) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}
-

Get HydroPumpedStorage time_limits.

source
PowerSystems.get_time_limits_pump — Method
get_time_limits_pump(
+

Get HydroPumpedStorage time_limits.

source
PowerSystems.get_time_limits_pump — Method
get_time_limits_pump(
     value::HydroPumpedStorage
 ) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}
-

Get HydroPumpedStorage time_limits_pump.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
+

Get HydroPumpedStorage time_limits_pump.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
     value::HydroPumpedStorage,
     val
 ) -> Any
-

Set HydroPumpedStorage active_power_limits.

source
PowerSystems.set_active_power_limits_pump! — Method
set_active_power_limits_pump!(
+

Set HydroPumpedStorage active_power_limits.

source
PowerSystems.set_active_power_limits_pump! — Method
set_active_power_limits_pump!(
     value::HydroPumpedStorage,
     val
 ) -> Any
-

Set HydroPumpedStorage active_power_limits_pump.

source
PowerSystems.set_available! — Method
set_available!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage bus.

source
PowerSystems.set_conversion_factor! — Method
set_conversion_factor!(
+

Set HydroPumpedStorage active_power_limits_pump.

source
PowerSystems.set_available! — Method
set_available!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage bus.

source
PowerSystems.set_conversion_factor! — Method
set_conversion_factor!(
     value::HydroPumpedStorage,
     val
 ) -> Any
-

Set HydroPumpedStorage conversion_factor.

source
PowerSystems.set_ext! — Method
set_ext!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage ext.

source
PowerSystems.set_inflow! — Method
set_inflow!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage inflow.

source
PowerSystems.set_initial_storage! — Method
set_initial_storage!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage initial_storage.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage operation_cost.

source
PowerSystems.set_outflow! — Method
set_outflow!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage outflow.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage prime_mover_type.

source
PowerSystems.set_pump_efficiency! — Method
set_pump_efficiency!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage pump_efficiency.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage ramp_limits.

source
PowerSystems.set_ramp_limits_pump! — Method
set_ramp_limits_pump!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage ramp_limits_pump.

source
PowerSystems.set_rating! — Method
set_rating!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage rating.

source
PowerSystems.set_rating_pump! — Method
set_rating_pump!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage rating_pump.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
+

Set HydroPumpedStorage conversion_factor.

source
PowerSystems.set_ext! — Method
set_ext!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage ext.

source
PowerSystems.set_inflow! — Method
set_inflow!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage inflow.

source
PowerSystems.set_initial_storage! — Method
set_initial_storage!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage initial_storage.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage operation_cost.

source
PowerSystems.set_outflow! — Method
set_outflow!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage outflow.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage prime_mover_type.

source
PowerSystems.set_pump_efficiency! — Method
set_pump_efficiency!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage pump_efficiency.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage ramp_limits.

source
PowerSystems.set_ramp_limits_pump! — Method
set_ramp_limits_pump!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage ramp_limits_pump.

source
PowerSystems.set_rating! — Method
set_rating!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage rating.

source
PowerSystems.set_rating_pump! — Method
set_rating_pump!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage rating_pump.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
     value::HydroPumpedStorage,
     val
 ) -> Any
-

Set HydroPumpedStorage reactive_power_limits.

source
PowerSystems.set_reactive_power_limits_pump! — Method
set_reactive_power_limits_pump!(
+

Set HydroPumpedStorage reactive_power_limits.

source
PowerSystems.set_reactive_power_limits_pump! — Method
set_reactive_power_limits_pump!(
     value::HydroPumpedStorage,
     val
 ) -> Any
-

Set HydroPumpedStorage reactive_power_limits_pump.

source
PowerSystems.set_services! — Method
set_services!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage services.

source
PowerSystems.set_status! — Method
set_status!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage status.

source
PowerSystems.set_storage_capacity! — Method
set_storage_capacity!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage storage_capacity.

source
PowerSystems.set_storage_target! — Method
set_storage_target!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage storage_target.

source
PowerSystems.set_time_at_status! — Method
set_time_at_status!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage time_at_status.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage time_limits.

source
PowerSystems.set_time_limits_pump! — Method
set_time_limits_pump!(value::HydroPumpedStorage, val) -> Any
-

Set HydroPumpedStorage time_limits_pump.

source
+

Set HydroPumpedStorage reactive_power_limits_pump.

source
PowerSystems.set_services! — Method
set_services!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage services.

source
PowerSystems.set_status! — Method
set_status!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage status.

source
PowerSystems.set_storage_capacity! — Method
set_storage_capacity!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage storage_capacity.

source
PowerSystems.set_storage_target! — Method
set_storage_target!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage storage_target.

source
PowerSystems.set_time_at_status! — Method
set_time_at_status!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage time_at_status.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage time_limits.

source
PowerSystems.set_time_limits_pump! — Method
set_time_limits_pump!(value::HydroPumpedStorage, val) -> Any
+

Set HydroPumpedStorage time_limits_pump.

source
diff --git a/dev/model_library/generated_InnerControl/index.html b/dev/model_library/generated_InnerControl/index.html index 5d9c3b5319..ed1ffa9072 100644 --- a/dev/model_library/generated_InnerControl/index.html +++ b/dev/model_library/generated_InnerControl/index.html @@ -7,17 +7,17 @@ states::Vector{Symbol} n_states::Int end

Parameters of an inner loop proportional integral (PI) current control based on "Reduced-order Structure-preserving Model for Parallel-connected Three-phase Grid-tied Inverters."

Arguments

γd_ic: d-axis integrator state of the PI current controller,
-γq_ic: q-axis integrator state of the PI current controller
source
PowerSystems.get_ext — Method
get_ext(value::CurrentModeControl) -> Dict{String, Any}
-

Get CurrentModeControl ext.

source
PowerSystems.get_kffv — Method
get_kffv(value::CurrentModeControl) -> Float64
-

Get CurrentModeControl kffv.

source
PowerSystems.get_kic — Method
get_kic(value::CurrentModeControl) -> Float64
-

Get CurrentModeControl kic.

source
PowerSystems.get_kpc — Method
get_kpc(value::CurrentModeControl) -> Float64
-

Get CurrentModeControl kpc.

source
PowerSystems.get_n_states — Method
get_n_states(value::CurrentModeControl) -> Int64
-

Get CurrentModeControl n_states.

source
PowerSystems.get_states — Method
get_states(value::CurrentModeControl) -> Vector{Symbol}
-

Get CurrentModeControl states.

source
PowerSystems.set_ext! — Method
set_ext!(value::CurrentModeControl, val) -> Any
-

Set CurrentModeControl ext.

source
PowerSystems.set_kffv! — Method
set_kffv!(value::CurrentModeControl, val) -> Any
-

Set CurrentModeControl kffv.

source
PowerSystems.set_kic! — Method
set_kic!(value::CurrentModeControl, val) -> Any
-

Set CurrentModeControl kic.

source
PowerSystems.set_kpc! — Method
set_kpc!(value::CurrentModeControl, val) -> Any
-

Set CurrentModeControl kpc.

source

RECurrentControlB

PowerSystems.RECurrentControlB — Type
mutable struct RECurrentControlB <: InnerControl
+γq_ic: q-axis integrator state of the PI current controller
  • n_states::Int: (Do not modify.) CurrentControl has 2 states
source
PowerSystems.get_ext — Method
get_ext(value::CurrentModeControl) -> Dict{String, Any}
+

Get CurrentModeControl ext.

source
PowerSystems.get_kffv — Method
get_kffv(value::CurrentModeControl) -> Float64
+

Get CurrentModeControl kffv.

source
PowerSystems.get_kic — Method
get_kic(value::CurrentModeControl) -> Float64
+

Get CurrentModeControl kic.

source
PowerSystems.get_kpc — Method
get_kpc(value::CurrentModeControl) -> Float64
+

Get CurrentModeControl kpc.

source
PowerSystems.get_n_states — Method
get_n_states(value::CurrentModeControl) -> Int64
+

Get CurrentModeControl n_states.

source
PowerSystems.get_states — Method
get_states(value::CurrentModeControl) -> Vector{Symbol}
+

Get CurrentModeControl states.

source
PowerSystems.set_ext! — Method
set_ext!(value::CurrentModeControl, val) -> Any
+

Set CurrentModeControl ext.

source
PowerSystems.set_kffv! — Method
set_kffv!(value::CurrentModeControl, val) -> Any
+

Set CurrentModeControl kffv.

source
PowerSystems.set_kic! — Method
set_kic!(value::CurrentModeControl, val) -> Any
+

Set CurrentModeControl kic.

source
PowerSystems.set_kpc! — Method
set_kpc!(value::CurrentModeControl, val) -> Any
+

Set CurrentModeControl kpc.

source

RECurrentControlB

PowerSystems.RECurrentControlB — Type
mutable struct RECurrentControlB <: InnerControl
     Q_Flag::Int
     PQ_Flag::Int
     Vdip_lim::MinMax
@@ -33,41 +33,41 @@
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of the Inner Control part of the REECB model in PSS/E

Arguments

  • Q_Flag::Int: Q Flag used for I_qinj, validation range: (0, 1)
  • PQ_Flag::Int: PQ Flag used for the Current Limit Logic, validation range: (0, 1)
  • Vdip_lim::MinMax: Limits for Voltage Dip Logic (Vdip, Vup)
  • T_rv::Float64: Voltage Filter Time Constant, validation range: (0, nothing)
  • dbd_pnts::Tuple{Float64, Float64}: Voltage error deadband thresholds (dbd1, dbd2)
  • K_qv::Float64: Reactive current injection gain during over and undervoltage conditions, validation range: (0, nothing)
  • Iqinj_lim::MinMax: Limits for Iqinj (I_qh1, I_ql1)
  • V_ref0::Float64: User defined reference. If 0, PowerSimulationsDynamics.jl initializes to initial terminal voltage, validation range: (0, nothing)
  • K_vp::Float64: Voltage regulator proportional gain (used when QFlag = 1), validation range: (0, nothing)
  • K_vi::Float64: Voltage regulator integral gain (used when QFlag = 1), validation range: (0, nothing)
  • T_iq::Float64: Time constant for low-pass filter for state q_V when QFlag = 0, validation range: (0, nothing)
  • I_max::Float64: Maximum limit on total converter current, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the RECurrentControlB depends on the Flags
  • n_states::Int: (Do not modify.) The states of the RECurrentControlB depends on the Flags
source
PowerSystems.get_I_max — Method
get_I_max(value::RECurrentControlB) -> Float64
-

Get RECurrentControlB I_max.

source
PowerSystems.get_Iqinj_lim — Method
get_Iqinj_lim(
+end

Parameters of the Inner Control part of the REECB model in PSS/E

Arguments

  • Q_Flag::Int: Q Flag used for I_qinj, validation range: (0, 1)
  • PQ_Flag::Int: PQ Flag used for the Current Limit Logic, validation range: (0, 1)
  • Vdip_lim::MinMax: Limits for Voltage Dip Logic (Vdip, Vup)
  • T_rv::Float64: Voltage Filter Time Constant, validation range: (0, nothing)
  • dbd_pnts::Tuple{Float64, Float64}: Voltage error deadband thresholds (dbd1, dbd2)
  • K_qv::Float64: Reactive current injection gain during over and undervoltage conditions, validation range: (0, nothing)
  • Iqinj_lim::MinMax: Limits for Iqinj (I_qh1, I_ql1)
  • V_ref0::Float64: User defined reference. If 0, PowerSimulationsDynamics.jl initializes to initial terminal voltage, validation range: (0, nothing)
  • K_vp::Float64: Voltage regulator proportional gain (used when QFlag = 1), validation range: (0, nothing)
  • K_vi::Float64: Voltage regulator integral gain (used when QFlag = 1), validation range: (0, nothing)
  • T_iq::Float64: Time constant for low-pass filter for state q_V when QFlag = 0, validation range: (0, nothing)
  • I_max::Float64: Maximum limit on total converter current, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the RECurrentControlB depends on the Flags
  • n_states::Int: (Do not modify.) The states of the RECurrentControlB depends on the Flags
source
PowerSystems.get_I_max — Method
get_I_max(value::RECurrentControlB) -> Float64
+

Get RECurrentControlB I_max.

source
PowerSystems.get_Iqinj_lim — Method
get_Iqinj_lim(
     value::RECurrentControlB
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get RECurrentControlB Iqinj_lim.

source
PowerSystems.get_K_qv — Method
get_K_qv(value::RECurrentControlB) -> Float64
-

Get RECurrentControlB K_qv.

source
PowerSystems.get_K_vi — Method
get_K_vi(value::RECurrentControlB) -> Float64
-

Get RECurrentControlB K_vi.

source
PowerSystems.get_K_vp — Method
get_K_vp(value::RECurrentControlB) -> Float64
-

Get RECurrentControlB K_vp.

source
PowerSystems.get_PQ_Flag — Method
get_PQ_Flag(value::RECurrentControlB) -> Int64
-

Get RECurrentControlB PQ_Flag.

source
PowerSystems.get_Q_Flag — Method
get_Q_Flag(value::RECurrentControlB) -> Int64
-

Get RECurrentControlB Q_Flag.

source
PowerSystems.get_T_iq — Method
get_T_iq(value::RECurrentControlB) -> Float64
-

Get RECurrentControlB T_iq.

source
PowerSystems.get_T_rv — Method
get_T_rv(value::RECurrentControlB) -> Float64
-

Get RECurrentControlB T_rv.

source
PowerSystems.get_V_ref0 — Method
get_V_ref0(value::RECurrentControlB) -> Float64
-

Get RECurrentControlB V_ref0.

source
PowerSystems.get_Vdip_lim — Method
get_Vdip_lim(
+

Get RECurrentControlB Iqinj_lim.

source
PowerSystems.get_K_qv — Method
get_K_qv(value::RECurrentControlB) -> Float64
+

Get RECurrentControlB K_qv.

source
PowerSystems.get_K_vi — Method
get_K_vi(value::RECurrentControlB) -> Float64
+

Get RECurrentControlB K_vi.

source
PowerSystems.get_K_vp — Method
get_K_vp(value::RECurrentControlB) -> Float64
+

Get RECurrentControlB K_vp.

source
PowerSystems.get_PQ_Flag — Method
get_PQ_Flag(value::RECurrentControlB) -> Int64
+

Get RECurrentControlB PQ_Flag.

source
PowerSystems.get_Q_Flag — Method
get_Q_Flag(value::RECurrentControlB) -> Int64
+

Get RECurrentControlB Q_Flag.

source
PowerSystems.get_T_iq — Method
get_T_iq(value::RECurrentControlB) -> Float64
+

Get RECurrentControlB T_iq.

source
PowerSystems.get_T_rv — Method
get_T_rv(value::RECurrentControlB) -> Float64
+

Get RECurrentControlB T_rv.

source
PowerSystems.get_V_ref0 — Method
get_V_ref0(value::RECurrentControlB) -> Float64
+

Get RECurrentControlB V_ref0.

source
PowerSystems.get_Vdip_lim — Method
get_Vdip_lim(
     value::RECurrentControlB
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get RECurrentControlB Vdip_lim.

source
PowerSystems.get_dbd_pnts — Method
get_dbd_pnts(
+

Get RECurrentControlB Vdip_lim.

source
PowerSystems.get_dbd_pnts — Method
get_dbd_pnts(
     value::RECurrentControlB
 ) -> Tuple{Float64, Float64}
-

Get RECurrentControlB dbd_pnts.

source
PowerSystems.get_ext — Method
get_ext(value::RECurrentControlB) -> Dict{String, Any}
-

Get RECurrentControlB ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::RECurrentControlB) -> Int64
-

Get RECurrentControlB n_states.

source
PowerSystems.get_states — Method
get_states(value::RECurrentControlB) -> Vector{Symbol}
-

Get RECurrentControlB states.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB I_max.

source
PowerSystems.set_Iqinj_lim! — Method
set_Iqinj_lim!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB Iqinj_lim.

source
PowerSystems.set_K_qv! — Method
set_K_qv!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB K_qv.

source
PowerSystems.set_K_vi! — Method
set_K_vi!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB K_vi.

source
PowerSystems.set_K_vp! — Method
set_K_vp!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB K_vp.

source
PowerSystems.set_PQ_Flag! — Method
set_PQ_Flag!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB PQ_Flag.

source
PowerSystems.set_Q_Flag! — Method
set_Q_Flag!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB Q_Flag.

source
PowerSystems.set_T_iq! — Method
set_T_iq!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB T_iq.

source
PowerSystems.set_T_rv! — Method
set_T_rv!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB T_rv.

source
PowerSystems.set_V_ref0! — Method
set_V_ref0!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB V_ref0.

source
PowerSystems.set_Vdip_lim! — Method
set_Vdip_lim!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB Vdip_lim.

source
PowerSystems.set_dbd_pnts! — Method
set_dbd_pnts!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB dbd_pnts.

source
PowerSystems.set_ext! — Method
set_ext!(value::RECurrentControlB, val) -> Any
-

Set RECurrentControlB ext.

source

VoltageModeControl

PowerSystems.VoltageModeControl — Type
mutable struct VoltageModeControl <: InnerControl
+

Get RECurrentControlB dbd_pnts.

source
PowerSystems.get_ext — Method
get_ext(value::RECurrentControlB) -> Dict{String, Any}
+

Get RECurrentControlB ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::RECurrentControlB) -> Int64
+

Get RECurrentControlB n_states.

source
PowerSystems.get_states — Method
get_states(value::RECurrentControlB) -> Vector{Symbol}
+

Get RECurrentControlB states.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB I_max.

source
PowerSystems.set_Iqinj_lim! — Method
set_Iqinj_lim!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB Iqinj_lim.

source
PowerSystems.set_K_qv! — Method
set_K_qv!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB K_qv.

source
PowerSystems.set_K_vi! — Method
set_K_vi!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB K_vi.

source
PowerSystems.set_K_vp! — Method
set_K_vp!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB K_vp.

source
PowerSystems.set_PQ_Flag! — Method
set_PQ_Flag!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB PQ_Flag.

source
PowerSystems.set_Q_Flag! — Method
set_Q_Flag!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB Q_Flag.

source
PowerSystems.set_T_iq! — Method
set_T_iq!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB T_iq.

source
PowerSystems.set_T_rv! — Method
set_T_rv!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB T_rv.

source
PowerSystems.set_V_ref0! — Method
set_V_ref0!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB V_ref0.

source
PowerSystems.set_Vdip_lim! — Method
set_Vdip_lim!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB Vdip_lim.

source
PowerSystems.set_dbd_pnts! — Method
set_dbd_pnts!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB dbd_pnts.

source
PowerSystems.set_ext! — Method
set_ext!(value::RECurrentControlB, val) -> Any
+

Set RECurrentControlB ext.

source

VoltageModeControl

PowerSystems.VoltageModeControl — Type
mutable struct VoltageModeControl <: InnerControl
     kpv::Float64
     kiv::Float64
     kffv::Float64
@@ -86,28 +86,28 @@
 γd_ic: d-axis integrator state of the PI current controller,
 γq_ic: q-axis integrator state of the PI current controller,
 ϕd_ic: d-axis low-pass filter of active damping,
-ϕq_ic: q-axis low-pass filter of active damping
  • n_states::Int: (Do not modify.) VoltageModeControl has 6 states
source
PowerSystems.get_ext — Method
get_ext(value::VoltageModeControl) -> Dict{String, Any}
-

Get VoltageModeControl ext.

source
PowerSystems.get_kad — Method
get_kad(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl kad.

source
PowerSystems.get_kffi — Method
get_kffi(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl kffi.

source
PowerSystems.get_kffv — Method
get_kffv(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl kffv.

source
PowerSystems.get_kic — Method
get_kic(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl kic.

source
PowerSystems.get_kiv — Method
get_kiv(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl kiv.

source
PowerSystems.get_kpc — Method
get_kpc(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl kpc.

source
PowerSystems.get_kpv — Method
get_kpv(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl kpv.

source
PowerSystems.get_lv — Method
get_lv(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl lv.

source
PowerSystems.get_n_states — Method
get_n_states(value::VoltageModeControl) -> Int64
-

Get VoltageModeControl n_states.

source
PowerSystems.get_rv — Method
get_rv(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl rv.

source
PowerSystems.get_states — Method
get_states(value::VoltageModeControl) -> Vector{Symbol}
-

Get VoltageModeControl states.

source
PowerSystems.get_ωad — Method
get_ωad(value::VoltageModeControl) -> Float64
-

Get VoltageModeControl ωad.

source
PowerSystems.set_ext! — Method
set_ext!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl ext.

source
PowerSystems.set_kad! — Method
set_kad!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl kad.

source
PowerSystems.set_kffi! — Method
set_kffi!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl kffi.

source
PowerSystems.set_kffv! — Method
set_kffv!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl kffv.

source
PowerSystems.set_kic! — Method
set_kic!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl kic.

source
PowerSystems.set_kiv! — Method
set_kiv!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl kiv.

source
PowerSystems.set_kpc! — Method
set_kpc!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl kpc.

source
PowerSystems.set_kpv! — Method
set_kpv!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl kpv.

source
PowerSystems.set_lv! — Method
set_lv!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl lv.

source
PowerSystems.set_rv! — Method
set_rv!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl rv.

source
PowerSystems.set_ωad! — Method
set_ωad!(value::VoltageModeControl, val) -> Any
-

Set VoltageModeControl ωad.

source
+ϕq_ic: q-axis low-pass filter of active dampingsource
PowerSystems.get_ext — Method
get_ext(value::VoltageModeControl) -> Dict{String, Any}
+

Get VoltageModeControl ext.

source
PowerSystems.get_kad — Method
get_kad(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl kad.

source
PowerSystems.get_kffi — Method
get_kffi(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl kffi.

source
PowerSystems.get_kffv — Method
get_kffv(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl kffv.

source
PowerSystems.get_kic — Method
get_kic(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl kic.

source
PowerSystems.get_kiv — Method
get_kiv(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl kiv.

source
PowerSystems.get_kpc — Method
get_kpc(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl kpc.

source
PowerSystems.get_kpv — Method
get_kpv(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl kpv.

source
PowerSystems.get_lv — Method
get_lv(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl lv.

source
PowerSystems.get_n_states — Method
get_n_states(value::VoltageModeControl) -> Int64
+

Get VoltageModeControl n_states.

source
PowerSystems.get_rv — Method
get_rv(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl rv.

source
PowerSystems.get_states — Method
get_states(value::VoltageModeControl) -> Vector{Symbol}
+

Get VoltageModeControl states.

source
PowerSystems.get_ωad — Method
get_ωad(value::VoltageModeControl) -> Float64
+

Get VoltageModeControl ωad.

source
PowerSystems.set_ext! — Method
set_ext!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl ext.

source
PowerSystems.set_kad! — Method
set_kad!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl kad.

source
PowerSystems.set_kffi! — Method
set_kffi!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl kffi.

source
PowerSystems.set_kffv! — Method
set_kffv!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl kffv.

source
PowerSystems.set_kic! — Method
set_kic!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl kic.

source
PowerSystems.set_kiv! — Method
set_kiv!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl kiv.

source
PowerSystems.set_kpc! — Method
set_kpc!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl kpc.

source
PowerSystems.set_kpv! — Method
set_kpv!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl kpv.

source
PowerSystems.set_lv! — Method
set_lv!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl lv.

source
PowerSystems.set_rv! — Method
set_rv!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl rv.

source
PowerSystems.set_ωad! — Method
set_ωad!(value::VoltageModeControl, val) -> Any
+

Set VoltageModeControl ωad.

source
diff --git a/dev/model_library/generated_InterconnectingConverter/index.html b/dev/model_library/generated_InterconnectingConverter/index.html index 18ec7d1b3e..c5467e639e 100644 --- a/dev/model_library/generated_InterconnectingConverter/index.html +++ b/dev/model_library/generated_InterconnectingConverter/index.html @@ -13,45 +13,45 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

Interconnecting Power Converter (IPC) for transforming power from an ACBus to a DCBus

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::InterconnectingConverter) -> String
-

Get InterconnectingConverter name.

source
PowerSystems.get_active_power — Method
get_active_power(value::InterconnectingConverter) -> Any
-

Get InterconnectingConverter active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
+end

Interconnecting Power Converter (IPC) for transforming power from an ACBus to a DCBus

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus on the AC side of this converter
  • dc_bus::DCBus: Bus on the DC side of this converter
  • active_power::Float64: Active power (MW) on the DC side, validation range: active_power_limits
  • rating::Float64: Maximum output power rating of the converter (MVA), validation range: (0, nothing)
  • active_power_limits::MinMax: Minimum and maximum stable active power levels (MW)
  • base_power::Float64: Base power of the converter in MVA, validation range: (0, nothing)
  • loss_function::Union{LinearCurve, QuadraticCurve}: (default: LinearCurve(0.0)) Linear or quadratic loss function with respect to the converter current
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::InterconnectingConverter) -> String
+

Get InterconnectingConverter name.

source
PowerSystems.get_active_power — Method
get_active_power(value::InterconnectingConverter) -> Any
+

Get InterconnectingConverter active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
     value::InterconnectingConverter
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get InterconnectingConverter active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::InterconnectingConverter) -> Bool
-

Get InterconnectingConverter available.

source
PowerSystems.get_base_power — Method
get_base_power(value::InterconnectingConverter) -> Float64
-

Get InterconnectingConverter base_power.

source
PowerSystems.get_bus — Method
get_bus(value::InterconnectingConverter) -> ACBus
-

Get InterconnectingConverter bus.

source
PowerSystems.get_dc_bus — Method
get_dc_bus(value::InterconnectingConverter) -> DCBus
-

Get InterconnectingConverter dc_bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+

Get InterconnectingConverter active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::InterconnectingConverter) -> Bool
+

Get InterconnectingConverter available.

source
PowerSystems.get_base_power — Method
get_base_power(value::InterconnectingConverter) -> Float64
+

Get InterconnectingConverter base_power.

source
PowerSystems.get_bus — Method
get_bus(value::InterconnectingConverter) -> ACBus
+

Get InterconnectingConverter bus.

source
PowerSystems.get_dc_bus — Method
get_dc_bus(value::InterconnectingConverter) -> DCBus
+

Get InterconnectingConverter dc_bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::InterconnectingConverter
 ) -> Union{Nothing, DynamicInjection}
-

Get InterconnectingConverter dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(
+

Get InterconnectingConverter dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(
     value::InterconnectingConverter
 ) -> Dict{String, Any}
-

Get InterconnectingConverter ext.

source
PowerSystems.get_loss_function — Method
get_loss_function(
+

Get InterconnectingConverter ext.

source
PowerSystems.get_loss_function — Method
get_loss_function(
     value::InterconnectingConverter
 ) -> Union{LinearCurve, QuadraticCurve}
-

Get InterconnectingConverter loss_function.

source
PowerSystems.get_rating — Method
get_rating(value::InterconnectingConverter) -> Any
-

Get InterconnectingConverter rating.

source
PowerSystems.get_services — Method
get_services(
+

Get InterconnectingConverter loss_function.

source
PowerSystems.get_rating — Method
get_rating(value::InterconnectingConverter) -> Any
+

Get InterconnectingConverter rating.

source
PowerSystems.get_services — Method
get_services(
     value::InterconnectingConverter
 ) -> Vector{Service}
-

Get InterconnectingConverter services.

source
PowerSystems.set_active_power! — Method
set_active_power!(
+

Get InterconnectingConverter services.

source
PowerSystems.set_active_power! — Method
set_active_power!(
     value::InterconnectingConverter,
     val
 ) -> Any
-

Set InterconnectingConverter active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
+

Set InterconnectingConverter active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
     value::InterconnectingConverter,
     val
 ) -> Any
-

Set InterconnectingConverter active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::InterconnectingConverter, val) -> Any
-

Set InterconnectingConverter available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::InterconnectingConverter, val) -> Any
-

Set InterconnectingConverter base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::InterconnectingConverter, val) -> Any
-

Set InterconnectingConverter bus.

source
PowerSystems.set_dc_bus! — Method
set_dc_bus!(value::InterconnectingConverter, val) -> Any
-

Set InterconnectingConverter dc_bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::InterconnectingConverter, val) -> Any
-

Set InterconnectingConverter ext.

source
PowerSystems.set_loss_function! — Method
set_loss_function!(
+

Set InterconnectingConverter active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::InterconnectingConverter, val) -> Any
+

Set InterconnectingConverter available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::InterconnectingConverter, val) -> Any
+

Set InterconnectingConverter base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::InterconnectingConverter, val) -> Any
+

Set InterconnectingConverter bus.

source
PowerSystems.set_dc_bus! — Method
set_dc_bus!(value::InterconnectingConverter, val) -> Any
+

Set InterconnectingConverter dc_bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::InterconnectingConverter, val) -> Any
+

Set InterconnectingConverter ext.

source
PowerSystems.set_loss_function! — Method
set_loss_function!(
     value::InterconnectingConverter,
     val
 ) -> Any
-

Set InterconnectingConverter loss_function.

source
PowerSystems.set_rating! — Method
set_rating!(value::InterconnectingConverter, val) -> Any
-

Set InterconnectingConverter rating.

source
PowerSystems.set_services! — Method
set_services!(value::InterconnectingConverter, val) -> Any
-

Set InterconnectingConverter services.

source
+

Set InterconnectingConverter loss_function.

source
PowerSystems.set_rating! — Method
set_rating!(value::InterconnectingConverter, val) -> Any
+

Set InterconnectingConverter rating.

source
PowerSystems.set_services! — Method
set_services!(value::InterconnectingConverter, val) -> Any
+

Set InterconnectingConverter services.

source
diff --git a/dev/model_library/generated_InterruptiblePowerLoad/index.html b/dev/model_library/generated_InterruptiblePowerLoad/index.html index b127e526b5..9a656d2ba1 100644 --- a/dev/model_library/generated_InterruptiblePowerLoad/index.html +++ b/dev/model_library/generated_InterruptiblePowerLoad/index.html @@ -13,44 +13,44 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A static power load that can be compensated for temporary or continuous interruptions to its requested demand.

These loads are most commonly used for operational optimizations and can be used to model, for example, large commercial and industrial customers enrolled in demand response programs. This load has a target demand profile (set by a max_active_power time series for an operational simulation) that can be reduced to satisfy other system needs. For simpler loads without an operating cost for demand response, see PowerLoad

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::InterruptiblePowerLoad) -> String
-

Get InterruptiblePowerLoad name.

source
PowerSystems.get_active_power — Method
get_active_power(value::InterruptiblePowerLoad) -> Any
-

Get InterruptiblePowerLoad active_power.

source
PowerSystems.get_available — Method
get_available(value::InterruptiblePowerLoad) -> Bool
-

Get InterruptiblePowerLoad available.

source
PowerSystems.get_base_power — Method
get_base_power(value::InterruptiblePowerLoad) -> Float64
-

Get InterruptiblePowerLoad base_power.

source
PowerSystems.get_bus — Method
get_bus(value::InterruptiblePowerLoad) -> ACBus
-

Get InterruptiblePowerLoad bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A static power load that can be compensated for temporary or continuous interruptions to its requested demand.

These loads are most commonly used for operational optimizations and can be used to model, for example, large commercial and industrial customers enrolled in demand response programs. This load has a target demand profile (set by a max_active_power time series for an operational simulation) that can be reduced to satisfy other system needs. For simpler loads without an operating cost for demand response, see PowerLoad

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial steady state active power demand (MW)
  • reactive_power::Float64: Initial steady state reactive power demand (MVAR)
  • max_active_power::Float64: Maximum active power (MW) that this load can demand
  • max_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand
  • base_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)
  • operation_cost::Union{LoadCost, MarketBidCost}: OperationalCost of interrupting load
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::InterruptiblePowerLoad) -> String
+

Get InterruptiblePowerLoad name.

source
PowerSystems.get_active_power — Method
get_active_power(value::InterruptiblePowerLoad) -> Any
+

Get InterruptiblePowerLoad active_power.

source
PowerSystems.get_available — Method
get_available(value::InterruptiblePowerLoad) -> Bool
+

Get InterruptiblePowerLoad available.

source
PowerSystems.get_base_power — Method
get_base_power(value::InterruptiblePowerLoad) -> Float64
+

Get InterruptiblePowerLoad base_power.

source
PowerSystems.get_bus — Method
get_bus(value::InterruptiblePowerLoad) -> ACBus
+

Get InterruptiblePowerLoad bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::InterruptiblePowerLoad
 ) -> Union{Nothing, DynamicInjection}
-

Get InterruptiblePowerLoad dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::InterruptiblePowerLoad) -> Dict{String, Any}
-

Get InterruptiblePowerLoad ext.

source
PowerSystems.get_max_active_power — Method
get_max_active_power(value::InterruptiblePowerLoad) -> Any
-

Get InterruptiblePowerLoad max_active_power.

source
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(value::InterruptiblePowerLoad) -> Any
-

Get InterruptiblePowerLoad max_reactive_power.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
+

Get InterruptiblePowerLoad dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::InterruptiblePowerLoad) -> Dict{String, Any}
+

Get InterruptiblePowerLoad ext.

source
PowerSystems.get_max_active_power — Method
get_max_active_power(value::InterruptiblePowerLoad) -> Any
+

Get InterruptiblePowerLoad max_active_power.

source
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(value::InterruptiblePowerLoad) -> Any
+

Get InterruptiblePowerLoad max_reactive_power.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
     value::InterruptiblePowerLoad
 ) -> Union{LoadCost, MarketBidCost}
-

Get InterruptiblePowerLoad operation_cost.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::InterruptiblePowerLoad) -> Any
-

Get InterruptiblePowerLoad reactive_power.

source
PowerSystems.get_services — Method
get_services(
+

Get InterruptiblePowerLoad operation_cost.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::InterruptiblePowerLoad) -> Any
+

Get InterruptiblePowerLoad reactive_power.

source
PowerSystems.get_services — Method
get_services(
     value::InterruptiblePowerLoad
 ) -> Vector{Service}
-

Get InterruptiblePowerLoad services.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::InterruptiblePowerLoad, val) -> Any
-

Set InterruptiblePowerLoad active_power.

source
PowerSystems.set_available! — Method
set_available!(value::InterruptiblePowerLoad, val) -> Any
-

Set InterruptiblePowerLoad available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::InterruptiblePowerLoad, val) -> Any
-

Set InterruptiblePowerLoad base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::InterruptiblePowerLoad, val) -> Any
-

Set InterruptiblePowerLoad bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::InterruptiblePowerLoad, val) -> Any
-

Set InterruptiblePowerLoad ext.

source
PowerSystems.set_max_active_power! — Method
set_max_active_power!(
+

Get InterruptiblePowerLoad services.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::InterruptiblePowerLoad, val) -> Any
+

Set InterruptiblePowerLoad active_power.

source
PowerSystems.set_available! — Method
set_available!(value::InterruptiblePowerLoad, val) -> Any
+

Set InterruptiblePowerLoad available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::InterruptiblePowerLoad, val) -> Any
+

Set InterruptiblePowerLoad base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::InterruptiblePowerLoad, val) -> Any
+

Set InterruptiblePowerLoad bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::InterruptiblePowerLoad, val) -> Any
+

Set InterruptiblePowerLoad ext.

source
PowerSystems.set_max_active_power! — Method
set_max_active_power!(
     value::InterruptiblePowerLoad,
     val
 ) -> Any
-

Set InterruptiblePowerLoad max_active_power.

source
PowerSystems.set_max_reactive_power! — Method
set_max_reactive_power!(
+

Set InterruptiblePowerLoad max_active_power.

source
PowerSystems.set_max_reactive_power! — Method
set_max_reactive_power!(
     value::InterruptiblePowerLoad,
     val
 ) -> Any
-

Set InterruptiblePowerLoad max_reactive_power.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(
+

Set InterruptiblePowerLoad max_reactive_power.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(
     value::InterruptiblePowerLoad,
     val
 ) -> Any
-

Set InterruptiblePowerLoad operation_cost.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(
+

Set InterruptiblePowerLoad operation_cost.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(
     value::InterruptiblePowerLoad,
     val
 ) -> Any
-

Set InterruptiblePowerLoad reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::InterruptiblePowerLoad, val) -> Any
-

Set InterruptiblePowerLoad services.

source
+

Set InterruptiblePowerLoad reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::InterruptiblePowerLoad, val) -> Any
+

Set InterruptiblePowerLoad services.

source
diff --git a/dev/model_library/generated_Line/index.html b/dev/model_library/generated_Line/index.html index 38e8747bc9..89e086463f 100644 --- a/dev/model_library/generated_Line/index.html +++ b/dev/model_library/generated_Line/index.html @@ -13,31 +13,31 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

An AC transmission line

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::Line) -> String
-

Get Line name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::Line) -> Any
-

Get Line active_power_flow.

source
PowerSystems.get_angle_limits — Method
get_angle_limits(
+end

An AC transmission line

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • active_power_flow::Float64: Initial condition of active power flow on the line (MW)
  • reactive_power_flow::Float64: Initial condition of reactive power flow on the line (MVAR)
  • arc::Arc: An Arc defining this line from a bus to another bus
  • r::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)
  • x::Float64: Reactance in pu (SYSTEM_BASE), validation range: (0, 4)
  • b::FromTo: Shunt susceptance in pu (SYSTEM_BASE), 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
  • angle_limits::MinMax: Minimum and maximum angle limits (radians), validation range: (-1.571, 1.571)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::Line) -> String
+

Get Line name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::Line) -> Any
+

Get Line active_power_flow.

source
PowerSystems.get_angle_limits — Method
get_angle_limits(
     value::Line
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get Line angle_limits.

source
PowerSystems.get_arc — Method
get_arc(value::Line) -> Arc
-

Get Line arc.

source
PowerSystems.get_available — Method
get_available(value::Line) -> Bool
-

Get Line available.

source
PowerSystems.get_b — Method
get_b(
+

Get Line angle_limits.

source
PowerSystems.get_arc — Method
get_arc(value::Line) -> Arc
+

Get Line arc.

source
PowerSystems.get_available — Method
get_available(value::Line) -> Bool
+

Get Line available.

source
PowerSystems.get_b — Method
get_b(
     value::Line
 ) -> @NamedTuple{from::Float64, to::Float64}
-

Get Line b.

source
PowerSystems.get_ext — Method
get_ext(value::Line) -> Dict{String, Any}
-

Get Line ext.

source
PowerSystems.get_r — Method
get_r(value::Line) -> Float64
-

Get Line r.

source
PowerSystems.get_rating — Method
get_rating(value::Line) -> Any
-

Get Line rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(value::Line) -> Any
-

Get Line reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(value::Line) -> Vector{Service}
-

Get Line services.

source
PowerSystems.get_x — Method
get_x(value::Line) -> Float64
-

Get Line x.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::Line, val) -> Any
-

Set Line active_power_flow.

source
PowerSystems.set_angle_limits! — Method
set_angle_limits!(value::Line, val) -> Any
-

Set Line angle_limits.

source
PowerSystems.set_arc! — Method
set_arc!(value::Line, val) -> Any
-

Set Line arc.

source
PowerSystems.set_available! — Method
set_available!(value::Line, val) -> Any
-

Set Line available.

source
PowerSystems.set_b! — Method
set_b!(value::Line, val) -> Any
-

Set Line b.

source
PowerSystems.set_ext! — Method
set_ext!(value::Line, val) -> Any
-

Set Line ext.

source
PowerSystems.set_r! — Method
set_r!(value::Line, val) -> Any
-

Set Line r.

source
PowerSystems.set_rating! — Method
set_rating!(value::Line, val) -> Any
-

Set Line rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(value::Line, val) -> Any
-

Set Line reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::Line, val) -> Any
-

Set Line services.

source
PowerSystems.set_x! — Method
set_x!(value::Line, val) -> Any
-

Set Line x.

source
+

Get Line b.

source
PowerSystems.get_ext — Method
get_ext(value::Line) -> Dict{String, Any}
+

Get Line ext.

source
PowerSystems.get_r — Method
get_r(value::Line) -> Float64
+

Get Line r.

source
PowerSystems.get_rating — Method
get_rating(value::Line) -> Any
+

Get Line rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(value::Line) -> Any
+

Get Line reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(value::Line) -> Vector{Service}
+

Get Line services.

source
PowerSystems.get_x — Method
get_x(value::Line) -> Float64
+

Get Line x.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::Line, val) -> Any
+

Set Line active_power_flow.

source
PowerSystems.set_angle_limits! — Method
set_angle_limits!(value::Line, val) -> Any
+

Set Line angle_limits.

source
PowerSystems.set_arc! — Method
set_arc!(value::Line, val) -> Any
+

Set Line arc.

source
PowerSystems.set_available! — Method
set_available!(value::Line, val) -> Any
+

Set Line available.

source
PowerSystems.set_b! — Method
set_b!(value::Line, val) -> Any
+

Set Line b.

source
PowerSystems.set_ext! — Method
set_ext!(value::Line, val) -> Any
+

Set Line ext.

source
PowerSystems.set_r! — Method
set_r!(value::Line, val) -> Any
+

Set Line r.

source
PowerSystems.set_rating! — Method
set_rating!(value::Line, val) -> Any
+

Set Line rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(value::Line, val) -> Any
+

Set Line reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::Line, val) -> Any
+

Set Line services.

source
PowerSystems.set_x! — Method
set_x!(value::Line, val) -> Any
+

Set Line x.

source
diff --git a/dev/model_library/generated_LoadZone/index.html b/dev/model_library/generated_LoadZone/index.html index 1ea159fc6d..8cd6cf1fed 100644 --- a/dev/model_library/generated_LoadZone/index.html +++ b/dev/model_library/generated_LoadZone/index.html @@ -5,11 +5,11 @@ peak_reactive_power::Float64 ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A load zone for electricity price analysis.

The load zone can be specified when defining each ACBus or DCBus in the zone

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::LoadZone) -> String
-

Get LoadZone name.

source
PowerSystems.get_ext — Method
get_ext(value::LoadZone) -> Dict{String, Any}
-

Get LoadZone ext.

source
PowerSystems.get_peak_active_power — Method
get_peak_active_power(value::LoadZone) -> Any
-

Get LoadZone peak_active_power.

source
PowerSystems.get_peak_reactive_power — Method
get_peak_reactive_power(value::LoadZone) -> Any
-

Get LoadZone peak_reactive_power.

source
PowerSystems.set_ext! — Method
set_ext!(value::LoadZone, val) -> Any
-

Set LoadZone ext.

source
PowerSystems.set_peak_active_power! — Method
set_peak_active_power!(value::LoadZone, val) -> Any
-

Set LoadZone peak_active_power.

source
PowerSystems.set_peak_reactive_power! — Method
set_peak_reactive_power!(value::LoadZone, val) -> Any
-

Set LoadZone peak_reactive_power.

source
+end

A load zone for electricity price analysis.

The load zone can be specified when defining each ACBus or DCBus in the zone

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::LoadZone) -> String
+

Get LoadZone name.

source
PowerSystems.get_ext — Method
get_ext(value::LoadZone) -> Dict{String, Any}
+

Get LoadZone ext.

source
PowerSystems.get_peak_active_power — Method
get_peak_active_power(value::LoadZone) -> Any
+

Get LoadZone peak_active_power.

source
PowerSystems.get_peak_reactive_power — Method
get_peak_reactive_power(value::LoadZone) -> Any
+

Get LoadZone peak_reactive_power.

source
PowerSystems.set_ext! — Method
set_ext!(value::LoadZone, val) -> Any
+

Set LoadZone ext.

source
PowerSystems.set_peak_active_power! — Method
set_peak_active_power!(value::LoadZone, val) -> Any
+

Set LoadZone peak_active_power.

source
PowerSystems.set_peak_reactive_power! — Method
set_peak_reactive_power!(value::LoadZone, val) -> Any
+

Set LoadZone peak_reactive_power.

source
diff --git a/dev/model_library/generated_Machine/index.html b/dev/model_library/generated_Machine/index.html index 3e5746bf34..c53ec01cae 100644 --- a/dev/model_library/generated_Machine/index.html +++ b/dev/model_library/generated_Machine/index.html @@ -20,33 +20,33 @@ eq_p: q-axis transient voltage, ed_p: d-axis transient voltage, eq_pp: q-axis subtransient voltage, -ed_pp: d-axis subtransient voltagesource
PowerSystems.get_R — Method
get_R(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine R.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Xd_pp.

source
PowerSystems.get_Xq — Method
get_Xq(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::AndersonFouadMachine) -> Float64
-

Get AndersonFouadMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::AndersonFouadMachine) -> Dict{String, Any}
-

Get AndersonFouadMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AndersonFouadMachine) -> Int64
-

Get AndersonFouadMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::AndersonFouadMachine) -> Vector{Symbol}
-

Get AndersonFouadMachine states.

source
PowerSystems.set_R! — Method
set_R!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine R.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Xd_pp.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::AndersonFouadMachine, val) -> Any
-

Set AndersonFouadMachine ext.

source

BaseMachine

PowerSystems.BaseMachine — Type
mutable struct BaseMachine <: Machine
+ed_pp: d-axis subtransient voltage
  • n_states::Int: (Do not modify.) The states AndersonFouadMachine has 6 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine R.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Xd_pp.

source
PowerSystems.get_Xq — Method
get_Xq(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::AndersonFouadMachine) -> Float64
+

Get AndersonFouadMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::AndersonFouadMachine) -> Dict{String, Any}
+

Get AndersonFouadMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::AndersonFouadMachine) -> Int64
+

Get AndersonFouadMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::AndersonFouadMachine) -> Vector{Symbol}
+

Get AndersonFouadMachine states.

source
PowerSystems.set_R! — Method
set_R!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine R.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Xd_pp.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::AndersonFouadMachine, val) -> Any
+

Set AndersonFouadMachine ext.

source

BaseMachine

PowerSystems.BaseMachine — Type
mutable struct BaseMachine <: Machine
     R::Float64
     Xd_p::Float64
     eq_p::Float64
@@ -54,17 +54,17 @@
     states::Vector{Symbol}
     n_states::Int
     internal::InfrastructureSystemsInternal
-end

Parameters of a Classic Machine: GENCLS in PSSE and PSLF

Arguments

  • R::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)
  • Xd_p::Float64: Reactance after EMF in machine per unit, validation range: (0, nothing)
  • eq_p::Float64: Fixed EMF behind the impedance, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) BaseMachine has no states
  • n_states::Int: (Do not modify.) BaseMachine has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::BaseMachine) -> Float64
-

Get BaseMachine R.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::BaseMachine) -> Float64
-

Get BaseMachine Xd_p.

source
PowerSystems.get_eq_p — Method
get_eq_p(value::BaseMachine) -> Float64
-

Get BaseMachine eq_p.

source
PowerSystems.get_ext — Method
get_ext(value::BaseMachine) -> Dict{String, Any}
-

Get BaseMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::BaseMachine) -> Int64
-

Get BaseMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::BaseMachine) -> Vector{Symbol}
-

Get BaseMachine states.

source
PowerSystems.set_R! — Method
set_R!(value::BaseMachine, val) -> Any
-

Set BaseMachine R.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::BaseMachine, val) -> Any
-

Set BaseMachine Xd_p.

source
PowerSystems.set_eq_p! — Method
set_eq_p!(value::BaseMachine, val) -> Any
-

Set BaseMachine eq_p.

source
PowerSystems.set_ext! — Method
set_ext!(value::BaseMachine, val) -> Any
-

Set BaseMachine ext.

source

FullMachine

PowerSystems.FullMachine — Type
mutable struct FullMachine <: Machine
+end

Parameters of a Classic Machine: GENCLS in PSSE and PSLF

Arguments

  • R::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)
  • Xd_p::Float64: Reactance after EMF in machine per unit, validation range: (0, nothing)
  • eq_p::Float64: Fixed EMF behind the impedance, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) BaseMachine has no states
  • n_states::Int: (Do not modify.) BaseMachine has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::BaseMachine) -> Float64
+

Get BaseMachine R.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::BaseMachine) -> Float64
+

Get BaseMachine Xd_p.

source
PowerSystems.get_eq_p — Method
get_eq_p(value::BaseMachine) -> Float64
+

Get BaseMachine eq_p.

source
PowerSystems.get_ext — Method
get_ext(value::BaseMachine) -> Dict{String, Any}
+

Get BaseMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::BaseMachine) -> Int64
+

Get BaseMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::BaseMachine) -> Vector{Symbol}
+

Get BaseMachine states.

source
PowerSystems.set_R! — Method
set_R!(value::BaseMachine, val) -> Any
+

Set BaseMachine R.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::BaseMachine, val) -> Any
+

Set BaseMachine Xd_p.

source
PowerSystems.set_eq_p! — Method
set_eq_p!(value::BaseMachine, val) -> Any
+

Set BaseMachine eq_p.

source
PowerSystems.set_ext! — Method
set_ext!(value::BaseMachine, val) -> Any
+

Set BaseMachine ext.

source

FullMachine

PowerSystems.FullMachine — Type
mutable struct FullMachine <: Machine
     R::Float64
     R_f::Float64
     R_1d::Float64
@@ -87,39 +87,39 @@
 ψq: q-axis stator flux,
 ψf: field rotor flux,
 ψ1d: d-axis rotor damping flux,
-ψ1q: q-axis rotor damping flux
  • n_states::Int: (Do not modify.) FullMachine has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_L_1d — Method
get_L_1d(value::FullMachine) -> Float64
-

Get FullMachine L_1d.

source
PowerSystems.get_L_1q — Method
get_L_1q(value::FullMachine) -> Float64
-

Get FullMachine L_1q.

source
PowerSystems.get_L_ad — Method
get_L_ad(value::FullMachine) -> Float64
-

Get FullMachine L_ad.

source
PowerSystems.get_L_aq — Method
get_L_aq(value::FullMachine) -> Float64
-

Get FullMachine L_aq.

source
PowerSystems.get_L_d — Method
get_L_d(value::FullMachine) -> Float64
-

Get FullMachine L_d.

source
PowerSystems.get_L_f1d — Method
get_L_f1d(value::FullMachine) -> Float64
-

Get FullMachine L_f1d.

source
PowerSystems.get_L_ff — Method
get_L_ff(value::FullMachine) -> Float64
-

Get FullMachine L_ff.

source
PowerSystems.get_L_q — Method
get_L_q(value::FullMachine) -> Float64
-

Get FullMachine L_q.

source
PowerSystems.get_R — Method
get_R(value::FullMachine) -> Float64
-

Get FullMachine R.

source
PowerSystems.get_R_1d — Method
get_R_1d(value::FullMachine) -> Float64
-

Get FullMachine R_1d.

source
PowerSystems.get_R_1q — Method
get_R_1q(value::FullMachine) -> Float64
-

Get FullMachine R_1q.

source
PowerSystems.get_R_f — Method
get_R_f(value::FullMachine) -> Float64
-

Get FullMachine R_f.

source
PowerSystems.get_ext — Method
get_ext(value::FullMachine) -> Dict{String, Any}
-

Get FullMachine ext.

source
PowerSystems.get_inv_d_fluxlink — Method
get_inv_d_fluxlink(value::FullMachine) -> Matrix{Float64}
-

Get FullMachine inv_d_fluxlink.

source
PowerSystems.get_inv_q_fluxlink — Method
get_inv_q_fluxlink(value::FullMachine) -> Matrix{Float64}
-

Get FullMachine inv_q_fluxlink.

source
PowerSystems.get_n_states — Method
get_n_states(value::FullMachine) -> Int64
-

Get FullMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::FullMachine) -> Vector{Symbol}
-

Get FullMachine states.

source
PowerSystems.set_L_1d! — Method
set_L_1d!(value::FullMachine, val) -> Any
-

Set FullMachine L_1d.

source
PowerSystems.set_L_1q! — Method
set_L_1q!(value::FullMachine, val) -> Any
-

Set FullMachine L_1q.

source
PowerSystems.set_L_ad! — Method
set_L_ad!(value::FullMachine, val) -> Any
-

Set FullMachine L_ad.

source
PowerSystems.set_L_aq! — Method
set_L_aq!(value::FullMachine, val) -> Any
-

Set FullMachine L_aq.

source
PowerSystems.set_L_d! — Method
set_L_d!(value::FullMachine, val) -> Any
-

Set FullMachine L_d.

source
PowerSystems.set_L_f1d! — Method
set_L_f1d!(value::FullMachine, val) -> Any
-

Set FullMachine L_f1d.

source
PowerSystems.set_L_ff! — Method
set_L_ff!(value::FullMachine, val) -> Any
-

Set FullMachine L_ff.

source
PowerSystems.set_L_q! — Method
set_L_q!(value::FullMachine, val) -> Any
-

Set FullMachine L_q.

source
PowerSystems.set_R! — Method
set_R!(value::FullMachine, val) -> Any
-

Set FullMachine R.

source
PowerSystems.set_R_1d! — Method
set_R_1d!(value::FullMachine, val) -> Any
-

Set FullMachine R_1d.

source
PowerSystems.set_R_1q! — Method
set_R_1q!(value::FullMachine, val) -> Any
-

Set FullMachine R_1q.

source
PowerSystems.set_R_f! — Method
set_R_f!(value::FullMachine, val) -> Any
-

Set FullMachine R_f.

source
PowerSystems.set_ext! — Method
set_ext!(value::FullMachine, val) -> Any
-

Set FullMachine ext.

source
PowerSystems.set_inv_d_fluxlink! — Method
set_inv_d_fluxlink!(value::FullMachine, val) -> Any
-

Set FullMachine inv_d_fluxlink.

source
PowerSystems.set_inv_q_fluxlink! — Method
set_inv_q_fluxlink!(value::FullMachine, val) -> Any
-

Set FullMachine inv_q_fluxlink.

source

MarconatoMachine

PowerSystems.MarconatoMachine — Type
mutable struct MarconatoMachine <: Machine
+ψ1q: q-axis rotor damping flux
  • n_states::Int: (Do not modify.) FullMachine has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_L_1d — Method
get_L_1d(value::FullMachine) -> Float64
+

Get FullMachine L_1d.

source
PowerSystems.get_L_1q — Method
get_L_1q(value::FullMachine) -> Float64
+

Get FullMachine L_1q.

source
PowerSystems.get_L_ad — Method
get_L_ad(value::FullMachine) -> Float64
+

Get FullMachine L_ad.

source
PowerSystems.get_L_aq — Method
get_L_aq(value::FullMachine) -> Float64
+

Get FullMachine L_aq.

source
PowerSystems.get_L_d — Method
get_L_d(value::FullMachine) -> Float64
+

Get FullMachine L_d.

source
PowerSystems.get_L_f1d — Method
get_L_f1d(value::FullMachine) -> Float64
+

Get FullMachine L_f1d.

source
PowerSystems.get_L_ff — Method
get_L_ff(value::FullMachine) -> Float64
+

Get FullMachine L_ff.

source
PowerSystems.get_L_q — Method
get_L_q(value::FullMachine) -> Float64
+

Get FullMachine L_q.

source
PowerSystems.get_R — Method
get_R(value::FullMachine) -> Float64
+

Get FullMachine R.

source
PowerSystems.get_R_1d — Method
get_R_1d(value::FullMachine) -> Float64
+

Get FullMachine R_1d.

source
PowerSystems.get_R_1q — Method
get_R_1q(value::FullMachine) -> Float64
+

Get FullMachine R_1q.

source
PowerSystems.get_R_f — Method
get_R_f(value::FullMachine) -> Float64
+

Get FullMachine R_f.

source
PowerSystems.get_ext — Method
get_ext(value::FullMachine) -> Dict{String, Any}
+

Get FullMachine ext.

source
PowerSystems.get_inv_d_fluxlink — Method
get_inv_d_fluxlink(value::FullMachine) -> Matrix{Float64}
+

Get FullMachine inv_d_fluxlink.

source
PowerSystems.get_inv_q_fluxlink — Method
get_inv_q_fluxlink(value::FullMachine) -> Matrix{Float64}
+

Get FullMachine inv_q_fluxlink.

source
PowerSystems.get_n_states — Method
get_n_states(value::FullMachine) -> Int64
+

Get FullMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::FullMachine) -> Vector{Symbol}
+

Get FullMachine states.

source
PowerSystems.set_L_1d! — Method
set_L_1d!(value::FullMachine, val) -> Any
+

Set FullMachine L_1d.

source
PowerSystems.set_L_1q! — Method
set_L_1q!(value::FullMachine, val) -> Any
+

Set FullMachine L_1q.

source
PowerSystems.set_L_ad! — Method
set_L_ad!(value::FullMachine, val) -> Any
+

Set FullMachine L_ad.

source
PowerSystems.set_L_aq! — Method
set_L_aq!(value::FullMachine, val) -> Any
+

Set FullMachine L_aq.

source
PowerSystems.set_L_d! — Method
set_L_d!(value::FullMachine, val) -> Any
+

Set FullMachine L_d.

source
PowerSystems.set_L_f1d! — Method
set_L_f1d!(value::FullMachine, val) -> Any
+

Set FullMachine L_f1d.

source
PowerSystems.set_L_ff! — Method
set_L_ff!(value::FullMachine, val) -> Any
+

Set FullMachine L_ff.

source
PowerSystems.set_L_q! — Method
set_L_q!(value::FullMachine, val) -> Any
+

Set FullMachine L_q.

source
PowerSystems.set_R! — Method
set_R!(value::FullMachine, val) -> Any
+

Set FullMachine R.

source
PowerSystems.set_R_1d! — Method
set_R_1d!(value::FullMachine, val) -> Any
+

Set FullMachine R_1d.

source
PowerSystems.set_R_1q! — Method
set_R_1q!(value::FullMachine, val) -> Any
+

Set FullMachine R_1q.

source
PowerSystems.set_R_f! — Method
set_R_f!(value::FullMachine, val) -> Any
+

Set FullMachine R_f.

source
PowerSystems.set_ext! — Method
set_ext!(value::FullMachine, val) -> Any
+

Set FullMachine ext.

source
PowerSystems.set_inv_d_fluxlink! — Method
set_inv_d_fluxlink!(value::FullMachine, val) -> Any
+

Set FullMachine inv_d_fluxlink.

source
PowerSystems.set_inv_q_fluxlink! — Method
set_inv_q_fluxlink!(value::FullMachine, val) -> Any
+

Set FullMachine inv_q_fluxlink.

source

MarconatoMachine

PowerSystems.MarconatoMachine — Type
mutable struct MarconatoMachine <: Machine
     R::Float64
     Xd::Float64
     Xq::Float64
@@ -143,39 +143,39 @@
 eq_p: q-axis transient voltage,
 ed_p: d-axis transient voltage,
 eq_pp: q-axis subtransient voltage,
-ed_pp: d-axis subtransient voltage
  • n_states::Int: (Do not modify.) MarconatoMachine has 6 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine R.

source
PowerSystems.get_T_AA — Method
get_T_AA(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine T_AA.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Xd_pp.

source
PowerSystems.get_Xq — Method
get_Xq(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::MarconatoMachine) -> Dict{String, Any}
-

Get MarconatoMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::MarconatoMachine) -> Int64
-

Get MarconatoMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::MarconatoMachine) -> Vector{Symbol}
-

Get MarconatoMachine states.

source
PowerSystems.get_γd — Method
get_γd(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine γd.

source
PowerSystems.get_γq — Method
get_γq(value::MarconatoMachine) -> Float64
-

Get MarconatoMachine γq.

source
PowerSystems.set_R! — Method
set_R!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine R.

source
PowerSystems.set_T_AA! — Method
set_T_AA!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine T_AA.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Xd_pp.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine ext.

source
PowerSystems.set_γd! — Method
set_γd!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine γd.

source
PowerSystems.set_γq! — Method
set_γq!(value::MarconatoMachine, val) -> Any
-

Set MarconatoMachine γq.

source

OneDOneQMachine

PowerSystems.OneDOneQMachine — Type
mutable struct OneDOneQMachine <: Machine
+ed_pp: d-axis subtransient voltage
  • n_states::Int: (Do not modify.) MarconatoMachine has 6 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine R.

source
PowerSystems.get_T_AA — Method
get_T_AA(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine T_AA.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Xd_pp.

source
PowerSystems.get_Xq — Method
get_Xq(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::MarconatoMachine) -> Dict{String, Any}
+

Get MarconatoMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::MarconatoMachine) -> Int64
+

Get MarconatoMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::MarconatoMachine) -> Vector{Symbol}
+

Get MarconatoMachine states.

source
PowerSystems.get_γd — Method
get_γd(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine γd.

source
PowerSystems.get_γq — Method
get_γq(value::MarconatoMachine) -> Float64
+

Get MarconatoMachine γq.

source
PowerSystems.set_R! — Method
set_R!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine R.

source
PowerSystems.set_T_AA! — Method
set_T_AA!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine T_AA.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Xd_pp.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine ext.

source
PowerSystems.set_γd! — Method
set_γd!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine γd.

source
PowerSystems.set_γq! — Method
set_γq!(value::MarconatoMachine, val) -> Any
+

Set MarconatoMachine γq.

source

OneDOneQMachine

PowerSystems.OneDOneQMachine — Type
mutable struct OneDOneQMachine <: Machine
     R::Float64
     Xd::Float64
     Xq::Float64
@@ -188,27 +188,27 @@
     n_states::Int
     internal::InfrastructureSystemsInternal
 end

Parameters of 4-states synchronous machine: Simplified Marconato model The derivative of stator fluxes (ψd and ψq) is neglected and ωψd = ψd and ωψq = ψq is assumed (i.e. ω=1.0). This is standard when transmission network dynamics is neglected

Arguments

  • R::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)
  • Xd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Xd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Td0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)
  • Tq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
eq_p: q-axis transient voltage,
-ed_p: d-axis transient voltage
  • n_states::Int: (Do not modify.) OneDOneQMachine has 2 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::OneDOneQMachine) -> Float64
-

Get OneDOneQMachine R.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::OneDOneQMachine) -> Float64
-

Get OneDOneQMachine Td0_p.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::OneDOneQMachine) -> Float64
-

Get OneDOneQMachine Tq0_p.

source
PowerSystems.get_Xd — Method
get_Xd(value::OneDOneQMachine) -> Float64
-

Get OneDOneQMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::OneDOneQMachine) -> Float64
-

Get OneDOneQMachine Xd_p.

source
PowerSystems.get_Xq — Method
get_Xq(value::OneDOneQMachine) -> Float64
-

Get OneDOneQMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::OneDOneQMachine) -> Float64
-

Get OneDOneQMachine Xq_p.

source
PowerSystems.get_ext — Method
get_ext(value::OneDOneQMachine) -> Dict{String, Any}
-

Get OneDOneQMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::OneDOneQMachine) -> Int64
-

Get OneDOneQMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::OneDOneQMachine) -> Vector{Symbol}
-

Get OneDOneQMachine states.

source
PowerSystems.set_R! — Method
set_R!(value::OneDOneQMachine, val) -> Any
-

Set OneDOneQMachine R.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::OneDOneQMachine, val) -> Any
-

Set OneDOneQMachine Td0_p.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::OneDOneQMachine, val) -> Any
-

Set OneDOneQMachine Tq0_p.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::OneDOneQMachine, val) -> Any
-

Set OneDOneQMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::OneDOneQMachine, val) -> Any
-

Set OneDOneQMachine Xd_p.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::OneDOneQMachine, val) -> Any
-

Set OneDOneQMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::OneDOneQMachine, val) -> Any
-

Set OneDOneQMachine Xq_p.

source
PowerSystems.set_ext! — Method
set_ext!(value::OneDOneQMachine, val) -> Any
-

Set OneDOneQMachine ext.

source

RoundRotorExponential

PowerSystems.RoundRotorExponential — Type
mutable struct RoundRotorExponential <: Machine
+ed_p: d-axis transient voltage
  • n_states::Int: (Do not modify.) OneDOneQMachine has 2 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::OneDOneQMachine) -> Float64
+

Get OneDOneQMachine R.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::OneDOneQMachine) -> Float64
+

Get OneDOneQMachine Td0_p.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::OneDOneQMachine) -> Float64
+

Get OneDOneQMachine Tq0_p.

source
PowerSystems.get_Xd — Method
get_Xd(value::OneDOneQMachine) -> Float64
+

Get OneDOneQMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::OneDOneQMachine) -> Float64
+

Get OneDOneQMachine Xd_p.

source
PowerSystems.get_Xq — Method
get_Xq(value::OneDOneQMachine) -> Float64
+

Get OneDOneQMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::OneDOneQMachine) -> Float64
+

Get OneDOneQMachine Xq_p.

source
PowerSystems.get_ext — Method
get_ext(value::OneDOneQMachine) -> Dict{String, Any}
+

Get OneDOneQMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::OneDOneQMachine) -> Int64
+

Get OneDOneQMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::OneDOneQMachine) -> Vector{Symbol}
+

Get OneDOneQMachine states.

source
PowerSystems.set_R! — Method
set_R!(value::OneDOneQMachine, val) -> Any
+

Set OneDOneQMachine R.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::OneDOneQMachine, val) -> Any
+

Set OneDOneQMachine Td0_p.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::OneDOneQMachine, val) -> Any
+

Set OneDOneQMachine Tq0_p.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::OneDOneQMachine, val) -> Any
+

Set OneDOneQMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::OneDOneQMachine, val) -> Any
+

Set OneDOneQMachine Xd_p.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::OneDOneQMachine, val) -> Any
+

Set OneDOneQMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::OneDOneQMachine, val) -> Any
+

Set OneDOneQMachine Xq_p.

source
PowerSystems.set_ext! — Method
set_ext!(value::OneDOneQMachine, val) -> Any
+

Set OneDOneQMachine ext.

source

RoundRotorExponential

PowerSystems.RoundRotorExponential — Type
mutable struct RoundRotorExponential <: Machine
     base_machine::RoundRotorMachine
-    saturation_coeffs::Tuple{Float64, Float64}

4-states round-rotor synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROE model in PSSE and PSLF.

Arguments

  • base_machine::RoundRotorMachine: Round Rotor Machine model.
  • saturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for exponential model.
source

RoundRotorMachine

PowerSystems.RoundRotorMachine — Type
mutable struct RoundRotorMachine <: Machine
+    saturation_coeffs::Tuple{Float64, Float64}

4-states round-rotor synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROE model in PSSE and PSLF.

Arguments

  • base_machine::RoundRotorMachine: Round Rotor Machine model.
  • saturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for exponential model.
source

RoundRotorMachine

PowerSystems.RoundRotorMachine — Type
mutable struct RoundRotorMachine <: Machine
     R::Float64
     Td0_p::Float64
     Td0_pp::Float64
@@ -233,49 +233,49 @@
 end

Parameters of 4-states round-rotor synchronous machine with quadratic/exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROU or GENROE model in PSSE and PSLF

Arguments

  • R::Float64: Armature resistance, validation range: (0, nothing)
  • Td0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)
  • Td0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)
  • Tq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)
  • Tq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)
  • Xd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Xd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Xd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit. Note: Xdpp = Xqpp, validation range: (0, nothing)
  • Xl::Float64: Stator leakage reactance, validation range: (0, nothing)
  • Se::Tuple{Float64, Float64}: Saturation factor at 1 and 1.2 pu flux: S(1.0) = B(|ψ_pp|-A)^2
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • γ_d1::Float64: (Do not modify.) γ_d1 parameter
  • γ_q1::Float64: (Do not modify.) γ_q1 parameter
  • γ_d2::Float64: (Do not modify.) γ_d2 parameter
  • γ_q2::Float64: (Do not modify.) γ_q2 parameter
  • γ_qd::Float64: (Do not modify.) γ_qd parameter
  • states::Vector{Symbol}: (Do not modify.) The states are:
eq_p: q-axis generator voltage behind the transient reactance,
 ed_p: d-axis generator voltage behind the transient reactance,
 ψ_kd: flux linkage in the first equivalent damping circuit in the d-axis,
-ψ_kq: flux linkage in the first equivalent damping circuit in the d-axis
  • n_states::Int: (Do not modify.) RoundRotorMachine has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine R.

source
PowerSystems.get_Se — Method
get_Se(value::RoundRotorMachine) -> Tuple{Float64, Float64}
-

Get RoundRotorMachine Se.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Xd_pp.

source
PowerSystems.get_Xl — Method
get_Xl(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Xl.

source
PowerSystems.get_Xq — Method
get_Xq(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine Xq_p.

source
PowerSystems.get_ext — Method
get_ext(value::RoundRotorMachine) -> Dict{String, Any}
-

Get RoundRotorMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::RoundRotorMachine) -> Int64
-

Get RoundRotorMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::RoundRotorMachine) -> Vector{Symbol}
-

Get RoundRotorMachine states.

source
PowerSystems.get_γ_d1 — Method
get_γ_d1(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine γ_d1.

source
PowerSystems.get_γ_d2 — Method
get_γ_d2(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine γ_d2.

source
PowerSystems.get_γ_q1 — Method
get_γ_q1(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine γ_q1.

source
PowerSystems.get_γ_q2 — Method
get_γ_q2(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine γ_q2.

source
PowerSystems.get_γ_qd — Method
get_γ_qd(value::RoundRotorMachine) -> Float64
-

Get RoundRotorMachine γ_qd.

source
PowerSystems.set_R! — Method
set_R!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine R.

source
PowerSystems.set_Se! — Method
set_Se!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Se.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Xd_pp.

source
PowerSystems.set_Xl! — Method
set_Xl!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Xl.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine Xq_p.

source
PowerSystems.set_ext! — Method
set_ext!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine ext.

source
PowerSystems.set_γ_d1! — Method
set_γ_d1!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine γ_d1.

source
PowerSystems.set_γ_d2! — Method
set_γ_d2!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine γ_d2.

source
PowerSystems.set_γ_q1! — Method
set_γ_q1!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine γ_q1.

source
PowerSystems.set_γ_q2! — Method
set_γ_q2!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine γ_q2.

source
PowerSystems.set_γ_qd! — Method
set_γ_qd!(value::RoundRotorMachine, val) -> Any
-

Set RoundRotorMachine γ_qd.

source

RoundRotorQuadratic

PowerSystems.RoundRotorQuadratic — Type
mutable struct RoundRotorQuadratic <: Machine
+ψ_kq: flux linkage in the first equivalent damping circuit in the d-axis
  • n_states::Int: (Do not modify.) RoundRotorMachine has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine R.

source
PowerSystems.get_Se — Method
get_Se(value::RoundRotorMachine) -> Tuple{Float64, Float64}
+

Get RoundRotorMachine Se.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Xd_pp.

source
PowerSystems.get_Xl — Method
get_Xl(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Xl.

source
PowerSystems.get_Xq — Method
get_Xq(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine Xq_p.

source
PowerSystems.get_ext — Method
get_ext(value::RoundRotorMachine) -> Dict{String, Any}
+

Get RoundRotorMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::RoundRotorMachine) -> Int64
+

Get RoundRotorMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::RoundRotorMachine) -> Vector{Symbol}
+

Get RoundRotorMachine states.

source
PowerSystems.get_γ_d1 — Method
get_γ_d1(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine γ_d1.

source
PowerSystems.get_γ_d2 — Method
get_γ_d2(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine γ_d2.

source
PowerSystems.get_γ_q1 — Method
get_γ_q1(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine γ_q1.

source
PowerSystems.get_γ_q2 — Method
get_γ_q2(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine γ_q2.

source
PowerSystems.get_γ_qd — Method
get_γ_qd(value::RoundRotorMachine) -> Float64
+

Get RoundRotorMachine γ_qd.

source
PowerSystems.set_R! — Method
set_R!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine R.

source
PowerSystems.set_Se! — Method
set_Se!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Se.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Xd_pp.

source
PowerSystems.set_Xl! — Method
set_Xl!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Xl.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine Xq_p.

source
PowerSystems.set_ext! — Method
set_ext!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine ext.

source
PowerSystems.set_γ_d1! — Method
set_γ_d1!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine γ_d1.

source
PowerSystems.set_γ_d2! — Method
set_γ_d2!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine γ_d2.

source
PowerSystems.set_γ_q1! — Method
set_γ_q1!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine γ_q1.

source
PowerSystems.set_γ_q2! — Method
set_γ_q2!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine γ_q2.

source
PowerSystems.set_γ_qd! — Method
set_γ_qd!(value::RoundRotorMachine, val) -> Any
+

Set RoundRotorMachine γ_qd.

source

RoundRotorQuadratic

PowerSystems.RoundRotorQuadratic — Type
mutable struct RoundRotorQuadratic <: Machine
     base_machine::RoundRotorMachine
-    saturation_coeffs::Tuple{Float64, Float64}

4-states round-rotor synchronous machine with quadratic saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROU model in PSSE and PSLF.

Arguments

  • base_machine::RoundRotorMachine: Round Rotor Machine model.
  • saturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for quadratic model.
source

SalientPoleExponential

PowerSystems.SalientPoleExponential — Type
mutable struct SalientPoleExponential <: Machine
+    saturation_coeffs::Tuple{Float64, Float64}

4-states round-rotor synchronous machine with quadratic saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROU model in PSSE and PSLF.

Arguments

  • base_machine::RoundRotorMachine: Round Rotor Machine model.
  • saturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for quadratic model.
source

SalientPoleExponential

PowerSystems.SalientPoleExponential — Type
mutable struct SalientPoleExponential <: Machine
     base_machine::SalientPoleMachine
-    saturation_coeffs::Tuple{Float64, Float64}

3-states salient-pole synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.1). GENSAE in PSSE and PSLF.

Arguments:

  • base_machine::SalientPoleMachine: Salient Pole Machine model.
  • saturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for exponential model.
source

SalientPoleMachine

PowerSystems.SalientPoleMachine — Type
mutable struct SalientPoleMachine <: Machine
+    saturation_coeffs::Tuple{Float64, Float64}

3-states salient-pole synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.1). GENSAE in PSSE and PSLF.

Arguments:

  • base_machine::SalientPoleMachine: Salient Pole Machine model.
  • saturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for exponential model.
source

SalientPoleMachine

PowerSystems.SalientPoleMachine — Type
mutable struct SalientPoleMachine <: Machine
     R::Float64
     Td0_p::Float64
     Td0_pp::Float64
@@ -295,39 +295,39 @@
     internal::InfrastructureSystemsInternal
 end

Parameters of 3-states salient-pole synchronous machine with quadratic/exponential saturation: IEEE Std 1110 §5.3.1 (Model 2.1). GENSAL or GENSAE model in PSSE and PSLF

Arguments

  • R::Float64: Armature resistance, validation range: (0, nothing)
  • Td0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)
  • Td0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)
  • Tq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)
  • Xd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Xd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit. Note: Xdpp = Xqpp, validation range: (0, nothing)
  • Xl::Float64: Stator leakage reactance, validation range: (0, nothing)
  • Se::Tuple{Float64, Float64}: Saturation factor at 1 and 1.2 pu flux: Se(eqp) = B(eqp-A)^2
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • γ_d1::Float64: (Do not modify.) γ_d1 parameter
  • γ_q1::Float64: (Do not modify.) γ_q1 parameter
  • γ_d2::Float64: (Do not modify.) γ_d2 parameter
  • states::Vector{Symbol}: (Do not modify.) The states are:
eq_p: q-axis generator voltage behind the transient reactance,
 ψ_kd: flux linkage in the first equivalent damping circuit in the d-axis,
-ψq_pp: phasonf of the subtransient flux linkage in the q-axis
  • n_states::Int: (Do not modify.) SalientPoleMachine has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine R.

source
PowerSystems.get_Se — Method
get_Se(value::SalientPoleMachine) -> Tuple{Float64, Float64}
-

Get SalientPoleMachine Se.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine Td0_pp.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine Xd_pp.

source
PowerSystems.get_Xl — Method
get_Xl(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine Xl.

source
PowerSystems.get_Xq — Method
get_Xq(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine Xq.

source
PowerSystems.get_ext — Method
get_ext(value::SalientPoleMachine) -> Dict{String, Any}
-

Get SalientPoleMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SalientPoleMachine) -> Int64
-

Get SalientPoleMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SalientPoleMachine) -> Vector{Symbol}
-

Get SalientPoleMachine states.

source
PowerSystems.get_γ_d1 — Method
get_γ_d1(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine γ_d1.

source
PowerSystems.get_γ_d2 — Method
get_γ_d2(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine γ_d2.

source
PowerSystems.get_γ_q1 — Method
get_γ_q1(value::SalientPoleMachine) -> Float64
-

Get SalientPoleMachine γ_q1.

source
PowerSystems.set_R! — Method
set_R!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine R.

source
PowerSystems.set_Se! — Method
set_Se!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Se.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Td0_pp.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Xd_pp.

source
PowerSystems.set_Xl! — Method
set_Xl!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Xl.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine Xq.

source
PowerSystems.set_ext! — Method
set_ext!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine ext.

source
PowerSystems.set_γ_d1! — Method
set_γ_d1!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine γ_d1.

source
PowerSystems.set_γ_d2! — Method
set_γ_d2!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine γ_d2.

source
PowerSystems.set_γ_q1! — Method
set_γ_q1!(value::SalientPoleMachine, val) -> Any
-

Set SalientPoleMachine γ_q1.

source

SalientPoleQuadratic

PowerSystems.SalientPoleQuadratic — Type
mutable struct SalientPoleQuadratic <: Machine
+ψq_pp: phasonf of the subtransient flux linkage in the q-axis
  • n_states::Int: (Do not modify.) SalientPoleMachine has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine R.

source
PowerSystems.get_Se — Method
get_Se(value::SalientPoleMachine) -> Tuple{Float64, Float64}
+

Get SalientPoleMachine Se.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine Td0_pp.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine Xd_pp.

source
PowerSystems.get_Xl — Method
get_Xl(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine Xl.

source
PowerSystems.get_Xq — Method
get_Xq(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine Xq.

source
PowerSystems.get_ext — Method
get_ext(value::SalientPoleMachine) -> Dict{String, Any}
+

Get SalientPoleMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SalientPoleMachine) -> Int64
+

Get SalientPoleMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SalientPoleMachine) -> Vector{Symbol}
+

Get SalientPoleMachine states.

source
PowerSystems.get_γ_d1 — Method
get_γ_d1(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine γ_d1.

source
PowerSystems.get_γ_d2 — Method
get_γ_d2(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine γ_d2.

source
PowerSystems.get_γ_q1 — Method
get_γ_q1(value::SalientPoleMachine) -> Float64
+

Get SalientPoleMachine γ_q1.

source
PowerSystems.set_R! — Method
set_R!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine R.

source
PowerSystems.set_Se! — Method
set_Se!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Se.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Td0_pp.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Xd_pp.

source
PowerSystems.set_Xl! — Method
set_Xl!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Xl.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine Xq.

source
PowerSystems.set_ext! — Method
set_ext!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine ext.

source
PowerSystems.set_γ_d1! — Method
set_γ_d1!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine γ_d1.

source
PowerSystems.set_γ_d2! — Method
set_γ_d2!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine γ_d2.

source
PowerSystems.set_γ_q1! — Method
set_γ_q1!(value::SalientPoleMachine, val) -> Any
+

Set SalientPoleMachine γ_q1.

source

SalientPoleQuadratic

PowerSystems.SalientPoleQuadratic — Type
mutable struct SalientPoleQuadratic <: Machine
     base_machine::SalientPoleMachine
-    saturation_coeffs::Tuple{Float64, Float64}

3-states salient-pole synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.1). GENSAL in PSSE and PSLF.

Arguments:

  • base_machine::SalientPoleMachine: Salient Pole Machine model.
  • saturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for quadratic model.
source

SauerPaiMachine

PowerSystems.SauerPaiMachine — Type
mutable struct SauerPaiMachine <: Machine
+    saturation_coeffs::Tuple{Float64, Float64}

3-states salient-pole synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.1). GENSAL in PSSE and PSLF.

Arguments:

  • base_machine::SalientPoleMachine: Salient Pole Machine model.
  • saturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for quadratic model.
source

SauerPaiMachine

PowerSystems.SauerPaiMachine — Type
mutable struct SauerPaiMachine <: Machine
     R::Float64
     Xd::Float64
     Xq::Float64
@@ -353,43 +353,43 @@
 eq_p: q-axis transient voltage,
 ed_p: d-axis transient voltage
 ψd_pp: subtransient flux linkage in the d-axis
-ψq_pp: subtransient flux linkage in the q-axis
  • n_states::Int: (Do not modify.) SauerPaiMachine has 6 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine R.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Xd_pp.

source
PowerSystems.get_Xl — Method
get_Xl(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Xl.

source
PowerSystems.get_Xq — Method
get_Xq(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::SauerPaiMachine) -> Dict{String, Any}
-

Get SauerPaiMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SauerPaiMachine) -> Int64
-

Get SauerPaiMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SauerPaiMachine) -> Vector{Symbol}
-

Get SauerPaiMachine states.

source
PowerSystems.get_γ_d1 — Method
get_γ_d1(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine γ_d1.

source
PowerSystems.get_γ_d2 — Method
get_γ_d2(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine γ_d2.

source
PowerSystems.get_γ_q1 — Method
get_γ_q1(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine γ_q1.

source
PowerSystems.get_γ_q2 — Method
get_γ_q2(value::SauerPaiMachine) -> Float64
-

Get SauerPaiMachine γ_q2.

source
PowerSystems.set_R! — Method
set_R!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine R.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Xd_pp.

source
PowerSystems.set_Xl! — Method
set_Xl!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Xl.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine ext.

source
PowerSystems.set_γ_d1! — Method
set_γ_d1!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine γ_d1.

source
PowerSystems.set_γ_d2! — Method
set_γ_d2!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine γ_d2.

source
PowerSystems.set_γ_q1! — Method
set_γ_q1!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine γ_q1.

source
PowerSystems.set_γ_q2! — Method
set_γ_q2!(value::SauerPaiMachine, val) -> Any
-

Set SauerPaiMachine γ_q2.

source

SimpleAFMachine

PowerSystems.SimpleAFMachine — Type
mutable struct SimpleAFMachine <: Machine
+ψq_pp: subtransient flux linkage in the q-axis
  • n_states::Int: (Do not modify.) SauerPaiMachine has 6 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine R.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Xd_pp.

source
PowerSystems.get_Xl — Method
get_Xl(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Xl.

source
PowerSystems.get_Xq — Method
get_Xq(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::SauerPaiMachine) -> Dict{String, Any}
+

Get SauerPaiMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SauerPaiMachine) -> Int64
+

Get SauerPaiMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SauerPaiMachine) -> Vector{Symbol}
+

Get SauerPaiMachine states.

source
PowerSystems.get_γ_d1 — Method
get_γ_d1(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine γ_d1.

source
PowerSystems.get_γ_d2 — Method
get_γ_d2(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine γ_d2.

source
PowerSystems.get_γ_q1 — Method
get_γ_q1(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine γ_q1.

source
PowerSystems.get_γ_q2 — Method
get_γ_q2(value::SauerPaiMachine) -> Float64
+

Get SauerPaiMachine γ_q2.

source
PowerSystems.set_R! — Method
set_R!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine R.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Xd_pp.

source
PowerSystems.set_Xl! — Method
set_Xl!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Xl.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine ext.

source
PowerSystems.set_γ_d1! — Method
set_γ_d1!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine γ_d1.

source
PowerSystems.set_γ_d2! — Method
set_γ_d2!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine γ_d2.

source
PowerSystems.set_γ_q1! — Method
set_γ_q1!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine γ_q1.

source
PowerSystems.set_γ_q2! — Method
set_γ_q2!(value::SauerPaiMachine, val) -> Any
+

Set SauerPaiMachine γ_q2.

source

SimpleAFMachine

PowerSystems.SimpleAFMachine — Type
mutable struct SimpleAFMachine <: Machine
     R::Float64
     Xd::Float64
     Xq::Float64
@@ -408,33 +408,33 @@
 end

Parameters of 4-states simplified Anderson-Fouad (SimpleAFMachine) model. The derivative of stator fluxes (ψd and ψq) is neglected and ωψd = ψd and ωψq = ψq is assumed (i.e. ω=1.0). This is standard when transmission network dynamics is neglected. If transmission dynamics is considered use the full order Anderson Fouad model

Arguments

  • R::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)
  • Xd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Xd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Xd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Td0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)
  • Tq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)
  • Td0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)
  • Tq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
eq_p: q-axis transient voltage,
 ed_p: d-axis transient voltage,
 eq_pp: q-axis subtransient voltage,
-ed_pp: d-axis subtransient voltage
  • n_states::Int: (Do not modify.) SimpleAFMachine has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine R.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Xd_pp.

source
PowerSystems.get_Xq — Method
get_Xq(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::SimpleAFMachine) -> Float64
-

Get SimpleAFMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::SimpleAFMachine) -> Dict{String, Any}
-

Get SimpleAFMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SimpleAFMachine) -> Int64
-

Get SimpleAFMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SimpleAFMachine) -> Vector{Symbol}
-

Get SimpleAFMachine states.

source
PowerSystems.set_R! — Method
set_R!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine R.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Xd_pp.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::SimpleAFMachine, val) -> Any
-

Set SimpleAFMachine ext.

source

SimpleFullMachine

PowerSystems.SimpleFullMachine — Type
mutable struct SimpleFullMachine <: Machine
+ed_pp: d-axis subtransient voltage
  • n_states::Int: (Do not modify.) SimpleAFMachine has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine R.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Xd_pp.

source
PowerSystems.get_Xq — Method
get_Xq(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::SimpleAFMachine) -> Float64
+

Get SimpleAFMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::SimpleAFMachine) -> Dict{String, Any}
+

Get SimpleAFMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SimpleAFMachine) -> Int64
+

Get SimpleAFMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SimpleAFMachine) -> Vector{Symbol}
+

Get SimpleAFMachine states.

source
PowerSystems.set_R! — Method
set_R!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine R.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Xd_pp.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::SimpleAFMachine, val) -> Any
+

Set SimpleAFMachine ext.

source

SimpleFullMachine

PowerSystems.SimpleFullMachine — Type
mutable struct SimpleFullMachine <: Machine
     R::Float64
     R_f::Float64
     R_1d::Float64
@@ -455,43 +455,43 @@
     internal::InfrastructureSystemsInternal
 end

Parameter of a full order flux stator-rotor model without zero sequence flux in the stator. The derivative of stator fluxes (ψd and ψq) is neglected. This is standard when transmission network dynamics is neglected. Only one q-axis damping circuit is considered. All per unit are in machine per unit. Refer to Chapter 3 of Power System Stability and Control by P. Kundur or Chapter 11 of Power System Dynamics: Stability and Control, by J. Machowski, J. Bialek and J. Bumby, for more details. Note that the models are somewhat different (but equivalent) due to the different Park Transformation used in both books

Arguments

  • R::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)
  • R_f::Float64: Field rotor winding resistance in per unit, validation range: (0, nothing)
  • R_1d::Float64: Damping rotor winding resistance on d-axis in per unit. This value is denoted as RD in Machowski, validation range: (0, nothing)
  • R_1q::Float64: Damping rotor winding resistance on q-axis in per unit. This value is denoted as RQ in Machowski, validation range: (0, nothing)
  • L_d::Float64: Inductance of fictitious damping that represent the effect of the three-phase stator winding in the d-axis of the rotor, in per unit. This value is denoted as Lad + Ll in Kundur (and Ld in Machowski), validation range: (0, nothing)
  • L_q::Float64: Inductance of fictitious damping that represent the effect of the three-phase stator winding in the q-axis of the rotor, in per unit. This value is denoted as Laq + Ll in Kundur, validation range: (0, nothing)
  • L_ad::Float64: Mutual inductance between stator winding and rotor field (and damping) winding inductance on d-axis, in per unit, validation range: (0, nothing)
  • L_aq::Float64: Mutual inductance between stator winding and rotor damping winding inductance on q-axis, in per unit, validation range: (0, nothing)
  • L_f1d::Float64: Mutual inductance between rotor field winding and rotor damping winding inductance on d-axis, in per unit, validation range: (0, nothing)
  • L_ff::Float64: Field rotor winding inductance, in per unit, validation range: (0, nothing)
  • L_1d::Float64: Inductance of the d-axis rotor damping circuit, in per unit, validation range: (0, nothing)
  • L_1q::Float64: Inductance of the q-axis rotor damping circuit, in per unit, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • inv_d_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.127, 3.130, 3.131 From Kundur
  • inv_q_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.128, 3.132 From Kundur
  • states::Vector{Symbol}: (Do not modify.) The states are:
ψf: field rotor flux,
 ψ1d: d-axis rotor damping flux,
-ψ1q: q-axis rotor damping flux
  • n_states::Int: (Do not modify.) SimpleFullMachine has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_L_1d — Method
get_L_1d(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine L_1d.

source
PowerSystems.get_L_1q — Method
get_L_1q(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine L_1q.

source
PowerSystems.get_L_ad — Method
get_L_ad(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine L_ad.

source
PowerSystems.get_L_aq — Method
get_L_aq(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine L_aq.

source
PowerSystems.get_L_d — Method
get_L_d(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine L_d.

source
PowerSystems.get_L_f1d — Method
get_L_f1d(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine L_f1d.

source
PowerSystems.get_L_ff — Method
get_L_ff(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine L_ff.

source
PowerSystems.get_L_q — Method
get_L_q(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine L_q.

source
PowerSystems.get_R — Method
get_R(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine R.

source
PowerSystems.get_R_1d — Method
get_R_1d(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine R_1d.

source
PowerSystems.get_R_1q — Method
get_R_1q(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine R_1q.

source
PowerSystems.get_R_f — Method
get_R_f(value::SimpleFullMachine) -> Float64
-

Get SimpleFullMachine R_f.

source
PowerSystems.get_ext — Method
get_ext(value::SimpleFullMachine) -> Dict{String, Any}
-

Get SimpleFullMachine ext.

source
PowerSystems.get_inv_d_fluxlink — Method
get_inv_d_fluxlink(
+ψ1q: q-axis rotor damping flux
  • n_states::Int: (Do not modify.) SimpleFullMachine has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_L_1d — Method
get_L_1d(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine L_1d.

source
PowerSystems.get_L_1q — Method
get_L_1q(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine L_1q.

source
PowerSystems.get_L_ad — Method
get_L_ad(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine L_ad.

source
PowerSystems.get_L_aq — Method
get_L_aq(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine L_aq.

source
PowerSystems.get_L_d — Method
get_L_d(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine L_d.

source
PowerSystems.get_L_f1d — Method
get_L_f1d(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine L_f1d.

source
PowerSystems.get_L_ff — Method
get_L_ff(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine L_ff.

source
PowerSystems.get_L_q — Method
get_L_q(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine L_q.

source
PowerSystems.get_R — Method
get_R(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine R.

source
PowerSystems.get_R_1d — Method
get_R_1d(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine R_1d.

source
PowerSystems.get_R_1q — Method
get_R_1q(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine R_1q.

source
PowerSystems.get_R_f — Method
get_R_f(value::SimpleFullMachine) -> Float64
+

Get SimpleFullMachine R_f.

source
PowerSystems.get_ext — Method
get_ext(value::SimpleFullMachine) -> Dict{String, Any}
+

Get SimpleFullMachine ext.

source
PowerSystems.get_inv_d_fluxlink — Method
get_inv_d_fluxlink(
     value::SimpleFullMachine
 ) -> Matrix{Float64}
-

Get SimpleFullMachine inv_d_fluxlink.

source
PowerSystems.get_inv_q_fluxlink — Method
get_inv_q_fluxlink(
+

Get SimpleFullMachine inv_d_fluxlink.

source
PowerSystems.get_inv_q_fluxlink — Method
get_inv_q_fluxlink(
     value::SimpleFullMachine
 ) -> Matrix{Float64}
-

Get SimpleFullMachine inv_q_fluxlink.

source
PowerSystems.get_n_states — Method
get_n_states(value::SimpleFullMachine) -> Int64
-

Get SimpleFullMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SimpleFullMachine) -> Vector{Symbol}
-

Get SimpleFullMachine states.

source
PowerSystems.set_L_1d! — Method
set_L_1d!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine L_1d.

source
PowerSystems.set_L_1q! — Method
set_L_1q!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine L_1q.

source
PowerSystems.set_L_ad! — Method
set_L_ad!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine L_ad.

source
PowerSystems.set_L_aq! — Method
set_L_aq!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine L_aq.

source
PowerSystems.set_L_d! — Method
set_L_d!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine L_d.

source
PowerSystems.set_L_f1d! — Method
set_L_f1d!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine L_f1d.

source
PowerSystems.set_L_ff! — Method
set_L_ff!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine L_ff.

source
PowerSystems.set_L_q! — Method
set_L_q!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine L_q.

source
PowerSystems.set_R! — Method
set_R!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine R.

source
PowerSystems.set_R_1d! — Method
set_R_1d!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine R_1d.

source
PowerSystems.set_R_1q! — Method
set_R_1q!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine R_1q.

source
PowerSystems.set_R_f! — Method
set_R_f!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine R_f.

source
PowerSystems.set_ext! — Method
set_ext!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine ext.

source
PowerSystems.set_inv_d_fluxlink! — Method
set_inv_d_fluxlink!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine inv_d_fluxlink.

source
PowerSystems.set_inv_q_fluxlink! — Method
set_inv_q_fluxlink!(value::SimpleFullMachine, val) -> Any
-

Set SimpleFullMachine inv_q_fluxlink.

source

SimpleMarconatoMachine

PowerSystems.SimpleMarconatoMachine — Type
mutable struct SimpleMarconatoMachine <: Machine
+

Get SimpleFullMachine inv_q_fluxlink.

source
PowerSystems.get_n_states — Method
get_n_states(value::SimpleFullMachine) -> Int64
+

Get SimpleFullMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SimpleFullMachine) -> Vector{Symbol}
+

Get SimpleFullMachine states.

source
PowerSystems.set_L_1d! — Method
set_L_1d!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine L_1d.

source
PowerSystems.set_L_1q! — Method
set_L_1q!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine L_1q.

source
PowerSystems.set_L_ad! — Method
set_L_ad!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine L_ad.

source
PowerSystems.set_L_aq! — Method
set_L_aq!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine L_aq.

source
PowerSystems.set_L_d! — Method
set_L_d!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine L_d.

source
PowerSystems.set_L_f1d! — Method
set_L_f1d!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine L_f1d.

source
PowerSystems.set_L_ff! — Method
set_L_ff!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine L_ff.

source
PowerSystems.set_L_q! — Method
set_L_q!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine L_q.

source
PowerSystems.set_R! — Method
set_R!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine R.

source
PowerSystems.set_R_1d! — Method
set_R_1d!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine R_1d.

source
PowerSystems.set_R_1q! — Method
set_R_1q!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine R_1q.

source
PowerSystems.set_R_f! — Method
set_R_f!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine R_f.

source
PowerSystems.set_ext! — Method
set_ext!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine ext.

source
PowerSystems.set_inv_d_fluxlink! — Method
set_inv_d_fluxlink!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine inv_d_fluxlink.

source
PowerSystems.set_inv_q_fluxlink! — Method
set_inv_q_fluxlink!(value::SimpleFullMachine, val) -> Any
+

Set SimpleFullMachine inv_q_fluxlink.

source

SimpleMarconatoMachine

PowerSystems.SimpleMarconatoMachine — Type
mutable struct SimpleMarconatoMachine <: Machine
     R::Float64
     Xd::Float64
     Xq::Float64
@@ -513,36 +513,36 @@
 end

Parameters of 4-states synchronous machine: Simplified Marconato model The derivative of stator fluxes (ψd and ψq) is neglected and ωψd = ψd and ωψq = ψq is assumed (i.e. ω=1.0). This is standard when transmission network dynamics is neglected

Arguments

  • R::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)
  • Xd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Xd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Xd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)
  • Xq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)
  • Td0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)
  • Tq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)
  • Td0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)
  • Tq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)
  • T_AA::Float64: Time constant of d-axis additional leakage, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • γd::Float64: (Do not modify.) Internal equation
  • γq::Float64: (Do not modify.) Internal equation
  • states::Vector{Symbol}: (Do not modify.) The states are:
eq_p: q-axis transient voltage,
 ed_p: d-axis transient voltage,
 eq_pp: q-axis subtransient voltage,
-ed_pp: d-axis subtransient voltage
  • n_states::Int: (Do not modify.) SimpleMarconatoMachine has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_R — Method
get_R(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine R.

source
PowerSystems.get_T_AA — Method
get_T_AA(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine T_AA.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Xd_pp.

source
PowerSystems.get_Xq — Method
get_Xq(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::SimpleMarconatoMachine) -> Dict{String, Any}
-

Get SimpleMarconatoMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SimpleMarconatoMachine) -> Int64
-

Get SimpleMarconatoMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SimpleMarconatoMachine) -> Vector{Symbol}
-

Get SimpleMarconatoMachine states.

source
PowerSystems.get_γd — Method
get_γd(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine γd.

source
PowerSystems.get_γq — Method
get_γq(value::SimpleMarconatoMachine) -> Float64
-

Get SimpleMarconatoMachine γq.

source
PowerSystems.set_R! — Method
set_R!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine R.

source
PowerSystems.set_T_AA! — Method
set_T_AA!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine T_AA.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Xd_pp.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine ext.

source
PowerSystems.set_γd! — Method
set_γd!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine γd.

source
PowerSystems.set_γq! — Method
set_γq!(value::SimpleMarconatoMachine, val) -> Any
-

Set SimpleMarconatoMachine γq.

source
+ed_pp: d-axis subtransient voltagesource
PowerSystems.get_R — Method
get_R(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine R.

source
PowerSystems.get_T_AA — Method
get_T_AA(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine T_AA.

source
PowerSystems.get_Td0_p — Method
get_Td0_p(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Td0_p.

source
PowerSystems.get_Td0_pp — Method
get_Td0_pp(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Td0_pp.

source
PowerSystems.get_Tq0_p — Method
get_Tq0_p(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Tq0_p.

source
PowerSystems.get_Tq0_pp — Method
get_Tq0_pp(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Tq0_pp.

source
PowerSystems.get_Xd — Method
get_Xd(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Xd.

source
PowerSystems.get_Xd_p — Method
get_Xd_p(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Xd_p.

source
PowerSystems.get_Xd_pp — Method
get_Xd_pp(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Xd_pp.

source
PowerSystems.get_Xq — Method
get_Xq(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Xq.

source
PowerSystems.get_Xq_p — Method
get_Xq_p(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Xq_p.

source
PowerSystems.get_Xq_pp — Method
get_Xq_pp(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine Xq_pp.

source
PowerSystems.get_ext — Method
get_ext(value::SimpleMarconatoMachine) -> Dict{String, Any}
+

Get SimpleMarconatoMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SimpleMarconatoMachine) -> Int64
+

Get SimpleMarconatoMachine n_states.

source
PowerSystems.get_states — Method
get_states(value::SimpleMarconatoMachine) -> Vector{Symbol}
+

Get SimpleMarconatoMachine states.

source
PowerSystems.get_γd — Method
get_γd(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine γd.

source
PowerSystems.get_γq — Method
get_γq(value::SimpleMarconatoMachine) -> Float64
+

Get SimpleMarconatoMachine γq.

source
PowerSystems.set_R! — Method
set_R!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine R.

source
PowerSystems.set_T_AA! — Method
set_T_AA!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine T_AA.

source
PowerSystems.set_Td0_p! — Method
set_Td0_p!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Td0_p.

source
PowerSystems.set_Td0_pp! — Method
set_Td0_pp!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Td0_pp.

source
PowerSystems.set_Tq0_p! — Method
set_Tq0_p!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Tq0_p.

source
PowerSystems.set_Tq0_pp! — Method
set_Tq0_pp!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Tq0_pp.

source
PowerSystems.set_Xd! — Method
set_Xd!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Xd.

source
PowerSystems.set_Xd_p! — Method
set_Xd_p!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Xd_p.

source
PowerSystems.set_Xd_pp! — Method
set_Xd_pp!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Xd_pp.

source
PowerSystems.set_Xq! — Method
set_Xq!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Xq.

source
PowerSystems.set_Xq_p! — Method
set_Xq_p!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Xq_p.

source
PowerSystems.set_Xq_pp! — Method
set_Xq_pp!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine Xq_pp.

source
PowerSystems.set_ext! — Method
set_ext!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine ext.

source
PowerSystems.set_γd! — Method
set_γd!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine γd.

source
PowerSystems.set_γq! — Method
set_γq!(value::SimpleMarconatoMachine, val) -> Any
+

Set SimpleMarconatoMachine γq.

source
diff --git a/dev/model_library/generated_MonitoredLine/index.html b/dev/model_library/generated_MonitoredLine/index.html index 9018d7762f..6663fc2b6a 100644 --- a/dev/model_library/generated_MonitoredLine/index.html +++ b/dev/model_library/generated_MonitoredLine/index.html @@ -14,35 +14,35 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

An AC transmission line with additional power flow constraints specified by the system operator, more restrictive than the line's thermal limits.

For example, monitored lines can be used to restrict line flow following a contingency elsewhere in the network. See the flow_limits parameter. If monitoring is not needed, see Line

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::MonitoredLine) -> String
-

Get MonitoredLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::MonitoredLine) -> Any
-

Get MonitoredLine active_power_flow.

source
PowerSystems.get_angle_limits — Method
get_angle_limits(
+end

An AC transmission line with additional power flow constraints specified by the system operator, more restrictive than the line's thermal limits.

For example, monitored lines can be used to restrict line flow following a contingency elsewhere in the network. See the flow_limits parameter. If monitoring is not needed, see Line

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • active_power_flow::Float64: Initial condition of active power flow on the line (MW)
  • reactive_power_flow::Float64: Initial condition of reactive power flow on the line (MVAR)
  • arc::Arc: An Arc defining this line from a bus to another bus
  • r::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)
  • x::Float64: Reactance in pu (SYSTEM_BASE), validation range: (0, 4)
  • b::FromTo: Shunt susceptance in pu (SYSTEM_BASE), specified both on the from and to ends of the line. These are commonly modeled with the same value, validation range: (0, 2)
  • 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
  • angle_limits::MinMax: Minimum and maximum angle limits (radians), validation range: (-1.571, 1.571)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::MonitoredLine) -> String
+

Get MonitoredLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::MonitoredLine) -> Any
+

Get MonitoredLine active_power_flow.

source
PowerSystems.get_angle_limits — Method
get_angle_limits(
     value::MonitoredLine
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get MonitoredLine angle_limits.

source
PowerSystems.get_arc — Method
get_arc(value::MonitoredLine) -> Arc
-

Get MonitoredLine arc.

source
PowerSystems.get_available — Method
get_available(value::MonitoredLine) -> Bool
-

Get MonitoredLine available.

source
PowerSystems.get_b — Method
get_b(
+

Get MonitoredLine angle_limits.

source
PowerSystems.get_arc — Method
get_arc(value::MonitoredLine) -> Arc
+

Get MonitoredLine arc.

source
PowerSystems.get_available — Method
get_available(value::MonitoredLine) -> Bool
+

Get MonitoredLine available.

source
PowerSystems.get_b — Method
get_b(
     value::MonitoredLine
 ) -> @NamedTuple{from::Float64, to::Float64}
-

Get MonitoredLine b.

source
PowerSystems.get_ext — Method
get_ext(value::MonitoredLine) -> Dict{String, Any}
-

Get MonitoredLine ext.

source
PowerSystems.get_flow_limits — Method
get_flow_limits(
+

Get MonitoredLine b.

source
PowerSystems.get_ext — Method
get_ext(value::MonitoredLine) -> Dict{String, Any}
+

Get MonitoredLine ext.

source
PowerSystems.get_flow_limits — Method
get_flow_limits(
     value::MonitoredLine
 ) -> NamedTuple{(:from_to, :to_from), <:Tuple{Any, Any}}
-

Get MonitoredLine flow_limits.

source
PowerSystems.get_r — Method
get_r(value::MonitoredLine) -> Float64
-

Get MonitoredLine r.

source
PowerSystems.get_rating — Method
get_rating(value::MonitoredLine) -> Any
-

Get MonitoredLine rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(value::MonitoredLine) -> Any
-

Get MonitoredLine reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(value::MonitoredLine) -> Vector{Service}
-

Get MonitoredLine services.

source
PowerSystems.get_x — Method
get_x(value::MonitoredLine) -> Float64
-

Get MonitoredLine x.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine active_power_flow.

source
PowerSystems.set_angle_limits! — Method
set_angle_limits!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine angle_limits.

source
PowerSystems.set_arc! — Method
set_arc!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine arc.

source
PowerSystems.set_available! — Method
set_available!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine available.

source
PowerSystems.set_b! — Method
set_b!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine b.

source
PowerSystems.set_ext! — Method
set_ext!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine ext.

source
PowerSystems.set_flow_limits! — Method
set_flow_limits!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine flow_limits.

source
PowerSystems.set_r! — Method
set_r!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine r.

source
PowerSystems.set_rating! — Method
set_rating!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine services.

source
PowerSystems.set_x! — Method
set_x!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine x.

source
+

Get MonitoredLine flow_limits.

source
PowerSystems.get_r — Method
get_r(value::MonitoredLine) -> Float64
+

Get MonitoredLine r.

source
PowerSystems.get_rating — Method
get_rating(value::MonitoredLine) -> Any
+

Get MonitoredLine rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(value::MonitoredLine) -> Any
+

Get MonitoredLine reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(value::MonitoredLine) -> Vector{Service}
+

Get MonitoredLine services.

source
PowerSystems.get_x — Method
get_x(value::MonitoredLine) -> Float64
+

Get MonitoredLine x.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine active_power_flow.

source
PowerSystems.set_angle_limits! — Method
set_angle_limits!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine angle_limits.

source
PowerSystems.set_arc! — Method
set_arc!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine arc.

source
PowerSystems.set_available! — Method
set_available!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine available.

source
PowerSystems.set_b! — Method
set_b!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine b.

source
PowerSystems.set_ext! — Method
set_ext!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine ext.

source
PowerSystems.set_flow_limits! — Method
set_flow_limits!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine flow_limits.

source
PowerSystems.set_r! — Method
set_r!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine r.

source
PowerSystems.set_rating! — Method
set_rating!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine services.

source
PowerSystems.set_x! — Method
set_x!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine x.

source
diff --git a/dev/model_library/generated_OutputCurrentLimiter/index.html b/dev/model_library/generated_OutputCurrentLimiter/index.html index 8f2d99ede0..bb3ad457d6 100644 --- a/dev/model_library/generated_OutputCurrentLimiter/index.html +++ b/dev/model_library/generated_OutputCurrentLimiter/index.html @@ -4,75 +4,75 @@ rv::Float64 lv::Float64 ext::Dict{String, Any} -end

Parameters of Hybrid Current Controller Limiter. Regulates the magnitude of the inverter output current, but with a closed loop feedback regulated by a virtual impedance which provides ant-windup. Described in: Novel Hybrid Current Limiter for Grid-Forming Inverter Control During Unbalanced Faults by Baeckland and Seo, 2023

Arguments

source
PowerSystems.get_I_max — Method
get_I_max(value::HybridOutputCurrentLimiter) -> Float64
-

Get HybridOutputCurrentLimiter I_max.

source
PowerSystems.get_ext — Method
get_ext(
+end

Parameters of Hybrid Current Controller Limiter. Regulates the magnitude of the inverter output current, but with a closed loop feedback regulated by a virtual impedance which provides ant-windup. Described in: Novel Hybrid Current Limiter for Grid-Forming Inverter Control During Unbalanced Faults by Baeckland and Seo, 2023

Arguments

  • I_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)
  • rv::Float64: Real part of the virtual impedance, validation range: (0, nothing)
  • lv::Float64: Imaginary part of the virtual impedance, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}())
source
PowerSystems.get_I_max — Method
get_I_max(value::HybridOutputCurrentLimiter) -> Float64
+

Get HybridOutputCurrentLimiter I_max.

source
PowerSystems.get_ext — Method
get_ext(
     value::HybridOutputCurrentLimiter
 ) -> Dict{String, Any}
-

Get HybridOutputCurrentLimiter ext.

source
PowerSystems.get_lv — Method
get_lv(value::HybridOutputCurrentLimiter) -> Float64
-

Get HybridOutputCurrentLimiter lv.

source
PowerSystems.get_rv — Method
get_rv(value::HybridOutputCurrentLimiter) -> Float64
-

Get HybridOutputCurrentLimiter rv.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::HybridOutputCurrentLimiter, val) -> Any
-

Set HybridOutputCurrentLimiter I_max.

source
PowerSystems.set_ext! — Method
set_ext!(value::HybridOutputCurrentLimiter, val) -> Any
-

Set HybridOutputCurrentLimiter ext.

source
PowerSystems.set_lv! — Method
set_lv!(value::HybridOutputCurrentLimiter, val) -> Any
-

Set HybridOutputCurrentLimiter lv.

source
PowerSystems.set_rv! — Method
set_rv!(value::HybridOutputCurrentLimiter, val) -> Any
-

Set HybridOutputCurrentLimiter rv.

source

InstantaneousOutputCurrentLimiter

PowerSystems.InstantaneousOutputCurrentLimiter — Type
mutable struct InstantaneousOutputCurrentLimiter <: OutputCurrentLimiter
+

Get HybridOutputCurrentLimiter ext.

source
PowerSystems.get_lv — Method
get_lv(value::HybridOutputCurrentLimiter) -> Float64
+

Get HybridOutputCurrentLimiter lv.

source
PowerSystems.get_rv — Method
get_rv(value::HybridOutputCurrentLimiter) -> Float64
+

Get HybridOutputCurrentLimiter rv.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::HybridOutputCurrentLimiter, val) -> Any
+

Set HybridOutputCurrentLimiter I_max.

source
PowerSystems.set_ext! — Method
set_ext!(value::HybridOutputCurrentLimiter, val) -> Any
+

Set HybridOutputCurrentLimiter ext.

source
PowerSystems.set_lv! — Method
set_lv!(value::HybridOutputCurrentLimiter, val) -> Any
+

Set HybridOutputCurrentLimiter lv.

source
PowerSystems.set_rv! — Method
set_rv!(value::HybridOutputCurrentLimiter, val) -> Any
+

Set HybridOutputCurrentLimiter rv.

source

InstantaneousOutputCurrentLimiter

PowerSystems.InstantaneousOutputCurrentLimiter — Type
mutable struct InstantaneousOutputCurrentLimiter <: OutputCurrentLimiter
     Id_max::Float64
     Iq_max::Float64
     ext::Dict{String, Any}
-end

Parameters of Instantaneous (Square) Current Controller Limiter. Regulates inverter output current on the d and q axis separately

Arguments

  • Id_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
  • Iq_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
source
PowerSystems.get_Id_max — Method
get_Id_max(
+end

Parameters of Instantaneous (Square) Current Controller Limiter. Regulates inverter output current on the d and q axis separately

Arguments

  • Id_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
  • Iq_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
source
PowerSystems.get_Id_max — Method
get_Id_max(
     value::InstantaneousOutputCurrentLimiter
 ) -> Float64
-

Get InstantaneousOutputCurrentLimiter Id_max.

source
PowerSystems.get_Iq_max — Method
get_Iq_max(
+

Get InstantaneousOutputCurrentLimiter Id_max.

source
PowerSystems.get_Iq_max — Method
get_Iq_max(
     value::InstantaneousOutputCurrentLimiter
 ) -> Float64
-

Get InstantaneousOutputCurrentLimiter Iq_max.

source
PowerSystems.get_ext — Method
get_ext(
+

Get InstantaneousOutputCurrentLimiter Iq_max.

source
PowerSystems.get_ext — Method
get_ext(
     value::InstantaneousOutputCurrentLimiter
 ) -> Dict{String, Any}
-

Get InstantaneousOutputCurrentLimiter ext.

source
PowerSystems.set_Id_max! — Method
set_Id_max!(
+

Get InstantaneousOutputCurrentLimiter ext.

source
PowerSystems.set_Id_max! — Method
set_Id_max!(
     value::InstantaneousOutputCurrentLimiter,
     val
 ) -> Any
-

Set InstantaneousOutputCurrentLimiter Id_max.

source
PowerSystems.set_Iq_max! — Method
set_Iq_max!(
+

Set InstantaneousOutputCurrentLimiter Id_max.

source
PowerSystems.set_Iq_max! — Method
set_Iq_max!(
     value::InstantaneousOutputCurrentLimiter,
     val
 ) -> Any
-

Set InstantaneousOutputCurrentLimiter Iq_max.

source
PowerSystems.set_ext! — Method
set_ext!(
+

Set InstantaneousOutputCurrentLimiter Iq_max.

source
PowerSystems.set_ext! — Method
set_ext!(
     value::InstantaneousOutputCurrentLimiter,
     val
 ) -> Any
-

Set InstantaneousOutputCurrentLimiter ext.

source

MagnitudeOutputCurrentLimiter

PowerSystems.MagnitudeOutputCurrentLimiter — Type
mutable struct MagnitudeOutputCurrentLimiter <: OutputCurrentLimiter
+

Set InstantaneousOutputCurrentLimiter ext.

source

MagnitudeOutputCurrentLimiter

PowerSystems.MagnitudeOutputCurrentLimiter — Type
mutable struct MagnitudeOutputCurrentLimiter <: OutputCurrentLimiter
     I_max::Float64
     ext::Dict{String, Any}
-end

Parameters of Magnitude (Circular) Current Controller Limiter. Regulates only the magnitude of the inverter output current

Arguments

  • I_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
source
PowerSystems.get_I_max — Method
get_I_max(value::MagnitudeOutputCurrentLimiter) -> Float64
-

Get MagnitudeOutputCurrentLimiter I_max.

source
PowerSystems.get_ext — Method
get_ext(
+end

Parameters of Magnitude (Circular) Current Controller Limiter. Regulates only the magnitude of the inverter output current

Arguments

  • I_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
source
PowerSystems.get_I_max — Method
get_I_max(value::MagnitudeOutputCurrentLimiter) -> Float64
+

Get MagnitudeOutputCurrentLimiter I_max.

source
PowerSystems.get_ext — Method
get_ext(
     value::MagnitudeOutputCurrentLimiter
 ) -> Dict{String, Any}
-

Get MagnitudeOutputCurrentLimiter ext.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::MagnitudeOutputCurrentLimiter, val) -> Any
-

Set MagnitudeOutputCurrentLimiter I_max.

source
PowerSystems.set_ext! — Method
set_ext!(value::MagnitudeOutputCurrentLimiter, val) -> Any
-

Set MagnitudeOutputCurrentLimiter ext.

source

PriorityOutputCurrentLimiter

PowerSystems.PriorityOutputCurrentLimiter — Type
mutable struct PriorityOutputCurrentLimiter <: OutputCurrentLimiter
+

Get MagnitudeOutputCurrentLimiter ext.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::MagnitudeOutputCurrentLimiter, val) -> Any
+

Set MagnitudeOutputCurrentLimiter I_max.

source
PowerSystems.set_ext! — Method
set_ext!(value::MagnitudeOutputCurrentLimiter, val) -> Any
+

Set MagnitudeOutputCurrentLimiter ext.

source

PriorityOutputCurrentLimiter

PowerSystems.PriorityOutputCurrentLimiter — Type
mutable struct PriorityOutputCurrentLimiter <: OutputCurrentLimiter
     I_max::Float64
     ϕ_I::Float64
     ext::Dict{String, Any}
-end

Parameters of Priority-Based Current Controller Limiter. Regulates the magnitude of the inverter output current and prioritizes a specific angle for the resultant current signal

Arguments

  • I_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
  • ϕ_I::Float64: Pre-defined angle (measured against the d-axis) for Iref once limit Imax is hit, validation range: (-1.571, 1.571)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
source
PowerSystems.get_I_max — Method
get_I_max(value::PriorityOutputCurrentLimiter) -> Float64
-

Get PriorityOutputCurrentLimiter I_max.

source
PowerSystems.get_ext — Method
get_ext(
+end

Parameters of Priority-Based Current Controller Limiter. Regulates the magnitude of the inverter output current and prioritizes a specific angle for the resultant current signal

Arguments

  • I_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
  • ϕ_I::Float64: Pre-defined angle (measured against the d-axis) for Iref once limit Imax is hit, validation range: (-1.571, 1.571)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
source
PowerSystems.get_I_max — Method
get_I_max(value::PriorityOutputCurrentLimiter) -> Float64
+

Get PriorityOutputCurrentLimiter I_max.

source
PowerSystems.get_ext — Method
get_ext(
     value::PriorityOutputCurrentLimiter
 ) -> Dict{String, Any}
-

Get PriorityOutputCurrentLimiter ext.

source
PowerSystems.get_ϕ_I — Method
get_ϕ_I(value::PriorityOutputCurrentLimiter) -> Float64
-

Get PriorityOutputCurrentLimiter ϕ_I.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::PriorityOutputCurrentLimiter, val) -> Any
-

Set PriorityOutputCurrentLimiter I_max.

source
PowerSystems.set_ext! — Method
set_ext!(value::PriorityOutputCurrentLimiter, val) -> Any
-

Set PriorityOutputCurrentLimiter ext.

source
PowerSystems.set_ϕ_I! — Method
set_ϕ_I!(value::PriorityOutputCurrentLimiter, val) -> Any
-

Set PriorityOutputCurrentLimiter ϕ_I.

source

SaturationOutputCurrentLimiter

PowerSystems.SaturationOutputCurrentLimiter — Type
mutable struct SaturationOutputCurrentLimiter <: OutputCurrentLimiter
+

Get PriorityOutputCurrentLimiter ext.

source
PowerSystems.get_ϕ_I — Method
get_ϕ_I(value::PriorityOutputCurrentLimiter) -> Float64
+

Get PriorityOutputCurrentLimiter ϕ_I.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::PriorityOutputCurrentLimiter, val) -> Any
+

Set PriorityOutputCurrentLimiter I_max.

source
PowerSystems.set_ext! — Method
set_ext!(value::PriorityOutputCurrentLimiter, val) -> Any
+

Set PriorityOutputCurrentLimiter ext.

source
PowerSystems.set_ϕ_I! — Method
set_ϕ_I!(value::PriorityOutputCurrentLimiter, val) -> Any
+

Set PriorityOutputCurrentLimiter ϕ_I.

source

SaturationOutputCurrentLimiter

PowerSystems.SaturationOutputCurrentLimiter — Type
mutable struct SaturationOutputCurrentLimiter <: OutputCurrentLimiter
     I_max::Float64
     kw::Float64
     ext::Dict{String, Any}
-end

Parameters of Saturation Current Controller Limiter. Regulates the magnitude of the inverter output current, and applies a closed loop feedback regulated by a static gain which provides ant-windup

Arguments

  • I_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)
  • kw::Float64: Defined feedback gain, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}())
source
PowerSystems.get_I_max — Method
get_I_max(value::SaturationOutputCurrentLimiter) -> Float64
-

Get SaturationOutputCurrentLimiter I_max.

source
PowerSystems.get_ext — Method
get_ext(
+end

Parameters of Saturation Current Controller Limiter. Regulates the magnitude of the inverter output current, and applies a closed loop feedback regulated by a static gain which provides ant-windup

Arguments

  • I_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)
  • kw::Float64: Defined feedback gain, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}())
source
PowerSystems.get_I_max — Method
get_I_max(value::SaturationOutputCurrentLimiter) -> Float64
+

Get SaturationOutputCurrentLimiter I_max.

source
PowerSystems.get_ext — Method
get_ext(
     value::SaturationOutputCurrentLimiter
 ) -> Dict{String, Any}
-

Get SaturationOutputCurrentLimiter ext.

source
PowerSystems.get_kw — Method
get_kw(value::SaturationOutputCurrentLimiter) -> Float64
-

Get SaturationOutputCurrentLimiter kw.

source
PowerSystems.set_I_max! — Method
set_I_max!(
+

Get SaturationOutputCurrentLimiter ext.

source
PowerSystems.get_kw — Method
get_kw(value::SaturationOutputCurrentLimiter) -> Float64
+

Get SaturationOutputCurrentLimiter kw.

source
PowerSystems.set_I_max! — Method
set_I_max!(
     value::SaturationOutputCurrentLimiter,
     val
 ) -> Any
-

Set SaturationOutputCurrentLimiter I_max.

source
PowerSystems.set_ext! — Method
set_ext!(value::SaturationOutputCurrentLimiter, val) -> Any
-

Set SaturationOutputCurrentLimiter ext.

source
PowerSystems.set_kw! — Method
set_kw!(value::SaturationOutputCurrentLimiter, val) -> Any
-

Set SaturationOutputCurrentLimiter kw.

source
+

Set SaturationOutputCurrentLimiter I_max.

source
PowerSystems.set_ext! — Method
set_ext!(value::SaturationOutputCurrentLimiter, val) -> Any
+

Set SaturationOutputCurrentLimiter ext.

source
PowerSystems.set_kw! — Method
set_kw!(value::SaturationOutputCurrentLimiter, val) -> Any
+

Set SaturationOutputCurrentLimiter kw.

source
diff --git a/dev/model_library/generated_PSS/index.html b/dev/model_library/generated_PSS/index.html index ba79cf2e0d..62a9462185 100644 --- a/dev/model_library/generated_PSS/index.html +++ b/dev/model_library/generated_PSS/index.html @@ -29,49 +29,49 @@ x_p4: 4rd filter integration, x_p5: T1/T2 lead-lag integrator, x_p6: T3/T4 lead-lag integrator, -:x_p7 last integer,source
PowerSystems.get_A1 — Method
get_A1(value::IEEEST) -> Float64
-

Get IEEEST A1.

source
PowerSystems.get_A2 — Method
get_A2(value::IEEEST) -> Float64
-

Get IEEEST A2.

source
PowerSystems.get_A3 — Method
get_A3(value::IEEEST) -> Float64
-

Get IEEEST A3.

source
PowerSystems.get_A4 — Method
get_A4(value::IEEEST) -> Float64
-

Get IEEEST A4.

source
PowerSystems.get_A5 — Method
get_A5(value::IEEEST) -> Float64
-

Get IEEEST A5.

source
PowerSystems.get_A6 — Method
get_A6(value::IEEEST) -> Float64
-

Get IEEEST A6.

source
PowerSystems.get_Ks — Method
get_Ks(value::IEEEST) -> Float64
-

Get IEEEST Ks.

source
PowerSystems.get_Ls_lim — Method
get_Ls_lim(value::IEEEST) -> Tuple{Float64, Float64}
-

Get IEEEST Ls_lim.

source
PowerSystems.get_T1 — Method
get_T1(value::IEEEST) -> Float64
-

Get IEEEST T1.

source
PowerSystems.get_T2 — Method
get_T2(value::IEEEST) -> Float64
-

Get IEEEST T2.

source
PowerSystems.get_T3 — Method
get_T3(value::IEEEST) -> Float64
-

Get IEEEST T3.

source
PowerSystems.get_T4 — Method
get_T4(value::IEEEST) -> Float64
-

Get IEEEST T4.

source
PowerSystems.get_T5 — Method
get_T5(value::IEEEST) -> Float64
-

Get IEEEST T5.

source
PowerSystems.get_T6 — Method
get_T6(value::IEEEST) -> Float64
-

Get IEEEST T6.

source
PowerSystems.get_Vcl — Method
get_Vcl(value::IEEEST) -> Float64
-

Get IEEEST Vcl.

source
PowerSystems.get_Vcu — Method
get_Vcu(value::IEEEST) -> Float64
-

Get IEEEST Vcu.

source
PowerSystems.get_ext — Method
get_ext(value::IEEEST) -> Dict{String, Any}
-

Get IEEEST ext.

source
PowerSystems.get_input_code — Method
get_input_code(value::IEEEST) -> Int64
-

Get IEEEST input_code.

source
PowerSystems.get_n_states — Method
get_n_states(value::IEEEST) -> Int64
-

Get IEEEST n_states.

source
PowerSystems.get_remote_bus_control — Method
get_remote_bus_control(value::IEEEST) -> Int64
-

Get IEEEST remote_bus_control.

source
PowerSystems.get_states — Method
get_states(value::IEEEST) -> Vector{Symbol}
-

Get IEEEST states.

source
PowerSystems.get_states_types — Method
get_states_types(value::IEEEST) -> Vector{StateTypes}
-

Get IEEEST states_types.

source
PowerSystems.set_A1! — Method
set_A1!(value::IEEEST, val) -> Any
-

Set IEEEST A1.

source
PowerSystems.set_A2! — Method
set_A2!(value::IEEEST, val) -> Any
-

Set IEEEST A2.

source
PowerSystems.set_A3! — Method
set_A3!(value::IEEEST, val) -> Any
-

Set IEEEST A3.

source
PowerSystems.set_A4! — Method
set_A4!(value::IEEEST, val) -> Any
-

Set IEEEST A4.

source
PowerSystems.set_A5! — Method
set_A5!(value::IEEEST, val) -> Any
-

Set IEEEST A5.

source
PowerSystems.set_A6! — Method
set_A6!(value::IEEEST, val) -> Any
-

Set IEEEST A6.

source
PowerSystems.set_Ks! — Method
set_Ks!(value::IEEEST, val) -> Any
-

Set IEEEST Ks.

source
PowerSystems.set_Ls_lim! — Method
set_Ls_lim!(value::IEEEST, val) -> Any
-

Set IEEEST Ls_lim.

source
PowerSystems.set_T1! — Method
set_T1!(value::IEEEST, val) -> Any
-

Set IEEEST T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::IEEEST, val) -> Any
-

Set IEEEST T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::IEEEST, val) -> Any
-

Set IEEEST T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::IEEEST, val) -> Any
-

Set IEEEST T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::IEEEST, val) -> Any
-

Set IEEEST T5.

source
PowerSystems.set_T6! — Method
set_T6!(value::IEEEST, val) -> Any
-

Set IEEEST T6.

source
PowerSystems.set_Vcl! — Method
set_Vcl!(value::IEEEST, val) -> Any
-

Set IEEEST Vcl.

source
PowerSystems.set_Vcu! — Method
set_Vcu!(value::IEEEST, val) -> Any
-

Set IEEEST Vcu.

source
PowerSystems.set_ext! — Method
set_ext!(value::IEEEST, val) -> Any
-

Set IEEEST ext.

source
PowerSystems.set_input_code! — Method
set_input_code!(value::IEEEST, val) -> Any
-

Set IEEEST input_code.

source
PowerSystems.set_remote_bus_control! — Method
set_remote_bus_control!(value::IEEEST, val) -> Any
-

Set IEEEST remote_bus_control.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::IEEEST, val) -> Any
-

Set IEEEST states_types.

source

PSS2A

PowerSystems.PSS2A — Type
mutable struct PSS2A <: PSS
+:x_p7 last integer,
  • n_states::Int: (Do not modify.) IEEEST has 7 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEST has 7 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_A1 — Method
get_A1(value::IEEEST) -> Float64
+

Get IEEEST A1.

source
PowerSystems.get_A2 — Method
get_A2(value::IEEEST) -> Float64
+

Get IEEEST A2.

source
PowerSystems.get_A3 — Method
get_A3(value::IEEEST) -> Float64
+

Get IEEEST A3.

source
PowerSystems.get_A4 — Method
get_A4(value::IEEEST) -> Float64
+

Get IEEEST A4.

source
PowerSystems.get_A5 — Method
get_A5(value::IEEEST) -> Float64
+

Get IEEEST A5.

source
PowerSystems.get_A6 — Method
get_A6(value::IEEEST) -> Float64
+

Get IEEEST A6.

source
PowerSystems.get_Ks — Method
get_Ks(value::IEEEST) -> Float64
+

Get IEEEST Ks.

source
PowerSystems.get_Ls_lim — Method
get_Ls_lim(value::IEEEST) -> Tuple{Float64, Float64}
+

Get IEEEST Ls_lim.

source
PowerSystems.get_T1 — Method
get_T1(value::IEEEST) -> Float64
+

Get IEEEST T1.

source
PowerSystems.get_T2 — Method
get_T2(value::IEEEST) -> Float64
+

Get IEEEST T2.

source
PowerSystems.get_T3 — Method
get_T3(value::IEEEST) -> Float64
+

Get IEEEST T3.

source
PowerSystems.get_T4 — Method
get_T4(value::IEEEST) -> Float64
+

Get IEEEST T4.

source
PowerSystems.get_T5 — Method
get_T5(value::IEEEST) -> Float64
+

Get IEEEST T5.

source
PowerSystems.get_T6 — Method
get_T6(value::IEEEST) -> Float64
+

Get IEEEST T6.

source
PowerSystems.get_Vcl — Method
get_Vcl(value::IEEEST) -> Float64
+

Get IEEEST Vcl.

source
PowerSystems.get_Vcu — Method
get_Vcu(value::IEEEST) -> Float64
+

Get IEEEST Vcu.

source
PowerSystems.get_ext — Method
get_ext(value::IEEEST) -> Dict{String, Any}
+

Get IEEEST ext.

source
PowerSystems.get_input_code — Method
get_input_code(value::IEEEST) -> Int64
+

Get IEEEST input_code.

source
PowerSystems.get_n_states — Method
get_n_states(value::IEEEST) -> Int64
+

Get IEEEST n_states.

source
PowerSystems.get_remote_bus_control — Method
get_remote_bus_control(value::IEEEST) -> Int64
+

Get IEEEST remote_bus_control.

source
PowerSystems.get_states — Method
get_states(value::IEEEST) -> Vector{Symbol}
+

Get IEEEST states.

source
PowerSystems.get_states_types — Method
get_states_types(value::IEEEST) -> Vector{StateTypes}
+

Get IEEEST states_types.

source
PowerSystems.set_A1! — Method
set_A1!(value::IEEEST, val) -> Any
+

Set IEEEST A1.

source
PowerSystems.set_A2! — Method
set_A2!(value::IEEEST, val) -> Any
+

Set IEEEST A2.

source
PowerSystems.set_A3! — Method
set_A3!(value::IEEEST, val) -> Any
+

Set IEEEST A3.

source
PowerSystems.set_A4! — Method
set_A4!(value::IEEEST, val) -> Any
+

Set IEEEST A4.

source
PowerSystems.set_A5! — Method
set_A5!(value::IEEEST, val) -> Any
+

Set IEEEST A5.

source
PowerSystems.set_A6! — Method
set_A6!(value::IEEEST, val) -> Any
+

Set IEEEST A6.

source
PowerSystems.set_Ks! — Method
set_Ks!(value::IEEEST, val) -> Any
+

Set IEEEST Ks.

source
PowerSystems.set_Ls_lim! — Method
set_Ls_lim!(value::IEEEST, val) -> Any
+

Set IEEEST Ls_lim.

source
PowerSystems.set_T1! — Method
set_T1!(value::IEEEST, val) -> Any
+

Set IEEEST T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::IEEEST, val) -> Any
+

Set IEEEST T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::IEEEST, val) -> Any
+

Set IEEEST T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::IEEEST, val) -> Any
+

Set IEEEST T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::IEEEST, val) -> Any
+

Set IEEEST T5.

source
PowerSystems.set_T6! — Method
set_T6!(value::IEEEST, val) -> Any
+

Set IEEEST T6.

source
PowerSystems.set_Vcl! — Method
set_Vcl!(value::IEEEST, val) -> Any
+

Set IEEEST Vcl.

source
PowerSystems.set_Vcu! — Method
set_Vcu!(value::IEEEST, val) -> Any
+

Set IEEEST Vcu.

source
PowerSystems.set_ext! — Method
set_ext!(value::IEEEST, val) -> Any
+

Set IEEEST ext.

source
PowerSystems.set_input_code! — Method
set_input_code!(value::IEEEST, val) -> Any
+

Set IEEEST input_code.

source
PowerSystems.set_remote_bus_control! — Method
set_remote_bus_control!(value::IEEEST, val) -> Any
+

Set IEEEST remote_bus_control.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::IEEEST, val) -> Any
+

Set IEEEST states_types.

source

PSS2A

PowerSystems.PSS2A — Type
mutable struct PSS2A <: PSS
     input_code_1::Int
     remote_bus_control_1::Int
     input_code_2::Int
@@ -114,57 +114,57 @@
 x_p13: ramp tracking filter state 7, 
 x_p14: ramp tracking filter state 8, 
 x_p15: 1st lead-lag, 
-x_p16: 2nd lead-lag,
  • n_states::Int: (Do not modify.) IEEEST has 16 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEST has 16 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ks1 — Method
get_Ks1(value::PSS2A) -> Float64
-

Get PSS2A Ks1.

source
PowerSystems.get_Ks2 — Method
get_Ks2(value::PSS2A) -> Float64
-

Get PSS2A Ks2.

source
PowerSystems.get_Ks3 — Method
get_Ks3(value::PSS2A) -> Float64
-

Get PSS2A Ks3.

source
PowerSystems.get_M_rtf — Method
get_M_rtf(value::PSS2A) -> Int64
-

Get PSS2A M_rtf.

source
PowerSystems.get_N_rtf — Method
get_N_rtf(value::PSS2A) -> Int64
-

Get PSS2A N_rtf.

source
PowerSystems.get_T1 — Method
get_T1(value::PSS2A) -> Float64
-

Get PSS2A T1.

source
PowerSystems.get_T2 — Method
get_T2(value::PSS2A) -> Float64
-

Get PSS2A T2.

source
PowerSystems.get_T3 — Method
get_T3(value::PSS2A) -> Float64
-

Get PSS2A T3.

source
PowerSystems.get_T4 — Method
get_T4(value::PSS2A) -> Float64
-

Get PSS2A T4.

source
PowerSystems.get_T6 — Method
get_T6(value::PSS2A) -> Float64
-

Get PSS2A T6.

source
PowerSystems.get_T7 — Method
get_T7(value::PSS2A) -> Float64
-

Get PSS2A T7.

source
PowerSystems.get_T8 — Method
get_T8(value::PSS2A) -> Float64
-

Get PSS2A T8.

source
PowerSystems.get_T9 — Method
get_T9(value::PSS2A) -> Float64
-

Get PSS2A T9.

source
PowerSystems.get_Tw1 — Method
get_Tw1(value::PSS2A) -> Float64
-

Get PSS2A Tw1.

source
PowerSystems.get_Tw2 — Method
get_Tw2(value::PSS2A) -> Float64
-

Get PSS2A Tw2.

source
PowerSystems.get_Tw3 — Method
get_Tw3(value::PSS2A) -> Float64
-

Get PSS2A Tw3.

source
PowerSystems.get_Tw4 — Method
get_Tw4(value::PSS2A) -> Float64
-

Get PSS2A Tw4.

source
PowerSystems.get_Vst_lim — Method
get_Vst_lim(value::PSS2A) -> Tuple{Float64, Float64}
-

Get PSS2A Vst_lim.

source
PowerSystems.get_ext — Method
get_ext(value::PSS2A) -> Dict{String, Any}
-

Get PSS2A ext.

source
PowerSystems.get_input_code_1 — Method
get_input_code_1(value::PSS2A) -> Int64
-

Get PSS2A input_code_1.

source
PowerSystems.get_input_code_2 — Method
get_input_code_2(value::PSS2A) -> Int64
-

Get PSS2A input_code_2.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSS2A) -> Int64
-

Get PSS2A n_states.

source
PowerSystems.get_remote_bus_control_1 — Method
get_remote_bus_control_1(value::PSS2A) -> Int64
-

Get PSS2A remote_bus_control_1.

source
PowerSystems.get_remote_bus_control_2 — Method
get_remote_bus_control_2(value::PSS2A) -> Int64
-

Get PSS2A remote_bus_control_2.

source
PowerSystems.get_states — Method
get_states(value::PSS2A) -> Vector{Symbol}
-

Get PSS2A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::PSS2A) -> Vector{StateTypes}
-

Get PSS2A states_types.

source
PowerSystems.set_Ks1! — Method
set_Ks1!(value::PSS2A, val) -> Any
-

Set PSS2A Ks1.

source
PowerSystems.set_Ks2! — Method
set_Ks2!(value::PSS2A, val) -> Any
-

Set PSS2A Ks2.

source
PowerSystems.set_Ks3! — Method
set_Ks3!(value::PSS2A, val) -> Any
-

Set PSS2A Ks3.

source
PowerSystems.set_M_rtf! — Method
set_M_rtf!(value::PSS2A, val) -> Any
-

Set PSS2A M_rtf.

source
PowerSystems.set_N_rtf! — Method
set_N_rtf!(value::PSS2A, val) -> Any
-

Set PSS2A N_rtf.

source
PowerSystems.set_T1! — Method
set_T1!(value::PSS2A, val) -> Any
-

Set PSS2A T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::PSS2A, val) -> Any
-

Set PSS2A T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::PSS2A, val) -> Any
-

Set PSS2A T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::PSS2A, val) -> Any
-

Set PSS2A T4.

source
PowerSystems.set_T6! — Method
set_T6!(value::PSS2A, val) -> Any
-

Set PSS2A T6.

source
PowerSystems.set_T7! — Method
set_T7!(value::PSS2A, val) -> Any
-

Set PSS2A T7.

source
PowerSystems.set_T8! — Method
set_T8!(value::PSS2A, val) -> Any
-

Set PSS2A T8.

source
PowerSystems.set_T9! — Method
set_T9!(value::PSS2A, val) -> Any
-

Set PSS2A T9.

source
PowerSystems.set_Tw1! — Method
set_Tw1!(value::PSS2A, val) -> Any
-

Set PSS2A Tw1.

source
PowerSystems.set_Tw2! — Method
set_Tw2!(value::PSS2A, val) -> Any
-

Set PSS2A Tw2.

source
PowerSystems.set_Tw3! — Method
set_Tw3!(value::PSS2A, val) -> Any
-

Set PSS2A Tw3.

source
PowerSystems.set_Tw4! — Method
set_Tw4!(value::PSS2A, val) -> Any
-

Set PSS2A Tw4.

source
PowerSystems.set_Vst_lim! — Method
set_Vst_lim!(value::PSS2A, val) -> Any
-

Set PSS2A Vst_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSS2A, val) -> Any
-

Set PSS2A ext.

source
PowerSystems.set_input_code_1! — Method
set_input_code_1!(value::PSS2A, val) -> Any
-

Set PSS2A input_code_1.

source
PowerSystems.set_input_code_2! — Method
set_input_code_2!(value::PSS2A, val) -> Any
-

Set PSS2A input_code_2.

source
PowerSystems.set_remote_bus_control_1! — Method
set_remote_bus_control_1!(value::PSS2A, val) -> Any
-

Set PSS2A remote_bus_control_1.

source
PowerSystems.set_remote_bus_control_2! — Method
set_remote_bus_control_2!(value::PSS2A, val) -> Any
-

Set PSS2A remote_bus_control_2.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::PSS2A, val) -> Any
-

Set PSS2A states_types.

source

PSS2B

PowerSystems.PSS2B — Type
mutable struct PSS2B <: PSS
+x_p16: 2nd lead-lag,
  • n_states::Int: (Do not modify.) IEEEST has 16 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEST has 16 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ks1 — Method
get_Ks1(value::PSS2A) -> Float64
+

Get PSS2A Ks1.

source
PowerSystems.get_Ks2 — Method
get_Ks2(value::PSS2A) -> Float64
+

Get PSS2A Ks2.

source
PowerSystems.get_Ks3 — Method
get_Ks3(value::PSS2A) -> Float64
+

Get PSS2A Ks3.

source
PowerSystems.get_M_rtf — Method
get_M_rtf(value::PSS2A) -> Int64
+

Get PSS2A M_rtf.

source
PowerSystems.get_N_rtf — Method
get_N_rtf(value::PSS2A) -> Int64
+

Get PSS2A N_rtf.

source
PowerSystems.get_T1 — Method
get_T1(value::PSS2A) -> Float64
+

Get PSS2A T1.

source
PowerSystems.get_T2 — Method
get_T2(value::PSS2A) -> Float64
+

Get PSS2A T2.

source
PowerSystems.get_T3 — Method
get_T3(value::PSS2A) -> Float64
+

Get PSS2A T3.

source
PowerSystems.get_T4 — Method
get_T4(value::PSS2A) -> Float64
+

Get PSS2A T4.

source
PowerSystems.get_T6 — Method
get_T6(value::PSS2A) -> Float64
+

Get PSS2A T6.

source
PowerSystems.get_T7 — Method
get_T7(value::PSS2A) -> Float64
+

Get PSS2A T7.

source
PowerSystems.get_T8 — Method
get_T8(value::PSS2A) -> Float64
+

Get PSS2A T8.

source
PowerSystems.get_T9 — Method
get_T9(value::PSS2A) -> Float64
+

Get PSS2A T9.

source
PowerSystems.get_Tw1 — Method
get_Tw1(value::PSS2A) -> Float64
+

Get PSS2A Tw1.

source
PowerSystems.get_Tw2 — Method
get_Tw2(value::PSS2A) -> Float64
+

Get PSS2A Tw2.

source
PowerSystems.get_Tw3 — Method
get_Tw3(value::PSS2A) -> Float64
+

Get PSS2A Tw3.

source
PowerSystems.get_Tw4 — Method
get_Tw4(value::PSS2A) -> Float64
+

Get PSS2A Tw4.

source
PowerSystems.get_Vst_lim — Method
get_Vst_lim(value::PSS2A) -> Tuple{Float64, Float64}
+

Get PSS2A Vst_lim.

source
PowerSystems.get_ext — Method
get_ext(value::PSS2A) -> Dict{String, Any}
+

Get PSS2A ext.

source
PowerSystems.get_input_code_1 — Method
get_input_code_1(value::PSS2A) -> Int64
+

Get PSS2A input_code_1.

source
PowerSystems.get_input_code_2 — Method
get_input_code_2(value::PSS2A) -> Int64
+

Get PSS2A input_code_2.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSS2A) -> Int64
+

Get PSS2A n_states.

source
PowerSystems.get_remote_bus_control_1 — Method
get_remote_bus_control_1(value::PSS2A) -> Int64
+

Get PSS2A remote_bus_control_1.

source
PowerSystems.get_remote_bus_control_2 — Method
get_remote_bus_control_2(value::PSS2A) -> Int64
+

Get PSS2A remote_bus_control_2.

source
PowerSystems.get_states — Method
get_states(value::PSS2A) -> Vector{Symbol}
+

Get PSS2A states.

source
PowerSystems.get_states_types — Method
get_states_types(value::PSS2A) -> Vector{StateTypes}
+

Get PSS2A states_types.

source
PowerSystems.set_Ks1! — Method
set_Ks1!(value::PSS2A, val) -> Any
+

Set PSS2A Ks1.

source
PowerSystems.set_Ks2! — Method
set_Ks2!(value::PSS2A, val) -> Any
+

Set PSS2A Ks2.

source
PowerSystems.set_Ks3! — Method
set_Ks3!(value::PSS2A, val) -> Any
+

Set PSS2A Ks3.

source
PowerSystems.set_M_rtf! — Method
set_M_rtf!(value::PSS2A, val) -> Any
+

Set PSS2A M_rtf.

source
PowerSystems.set_N_rtf! — Method
set_N_rtf!(value::PSS2A, val) -> Any
+

Set PSS2A N_rtf.

source
PowerSystems.set_T1! — Method
set_T1!(value::PSS2A, val) -> Any
+

Set PSS2A T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::PSS2A, val) -> Any
+

Set PSS2A T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::PSS2A, val) -> Any
+

Set PSS2A T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::PSS2A, val) -> Any
+

Set PSS2A T4.

source
PowerSystems.set_T6! — Method
set_T6!(value::PSS2A, val) -> Any
+

Set PSS2A T6.

source
PowerSystems.set_T7! — Method
set_T7!(value::PSS2A, val) -> Any
+

Set PSS2A T7.

source
PowerSystems.set_T8! — Method
set_T8!(value::PSS2A, val) -> Any
+

Set PSS2A T8.

source
PowerSystems.set_T9! — Method
set_T9!(value::PSS2A, val) -> Any
+

Set PSS2A T9.

source
PowerSystems.set_Tw1! — Method
set_Tw1!(value::PSS2A, val) -> Any
+

Set PSS2A Tw1.

source
PowerSystems.set_Tw2! — Method
set_Tw2!(value::PSS2A, val) -> Any
+

Set PSS2A Tw2.

source
PowerSystems.set_Tw3! — Method
set_Tw3!(value::PSS2A, val) -> Any
+

Set PSS2A Tw3.

source
PowerSystems.set_Tw4! — Method
set_Tw4!(value::PSS2A, val) -> Any
+

Set PSS2A Tw4.

source
PowerSystems.set_Vst_lim! — Method
set_Vst_lim!(value::PSS2A, val) -> Any
+

Set PSS2A Vst_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSS2A, val) -> Any
+

Set PSS2A ext.

source
PowerSystems.set_input_code_1! — Method
set_input_code_1!(value::PSS2A, val) -> Any
+

Set PSS2A input_code_1.

source
PowerSystems.set_input_code_2! — Method
set_input_code_2!(value::PSS2A, val) -> Any
+

Set PSS2A input_code_2.

source
PowerSystems.set_remote_bus_control_1! — Method
set_remote_bus_control_1!(value::PSS2A, val) -> Any
+

Set PSS2A remote_bus_control_1.

source
PowerSystems.set_remote_bus_control_2! — Method
set_remote_bus_control_2!(value::PSS2A, val) -> Any
+

Set PSS2A remote_bus_control_2.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::PSS2A, val) -> Any
+

Set PSS2A states_types.

source

PSS2B

PowerSystems.PSS2B — Type
mutable struct PSS2B <: PSS
     input_code_1::Int
     remote_bus_control_1::Int
     input_code_2::Int
@@ -212,65 +212,65 @@
 x_p14: ramp tracking filter state 8, 
 x_p15: 1st lead-lag, 
 x_p16: 2nd lead-lag, 
-x_p17: 3rd lead-lag,
  • n_states::Int: (Do not modify.) IEEEST has 17 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEST has 17 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ks1 — Method
get_Ks1(value::PSS2B) -> Float64
-

Get PSS2B Ks1.

source
PowerSystems.get_Ks2 — Method
get_Ks2(value::PSS2B) -> Float64
-

Get PSS2B Ks2.

source
PowerSystems.get_Ks3 — Method
get_Ks3(value::PSS2B) -> Float64
-

Get PSS2B Ks3.

source
PowerSystems.get_M_rtf — Method
get_M_rtf(value::PSS2B) -> Int64
-

Get PSS2B M_rtf.

source
PowerSystems.get_N_rtf — Method
get_N_rtf(value::PSS2B) -> Int64
-

Get PSS2B N_rtf.

source
PowerSystems.get_T1 — Method
get_T1(value::PSS2B) -> Float64
-

Get PSS2B T1.

source
PowerSystems.get_T10 — Method
get_T10(value::PSS2B) -> Float64
-

Get PSS2B T10.

source
PowerSystems.get_T11 — Method
get_T11(value::PSS2B) -> Float64
-

Get PSS2B T11.

source
PowerSystems.get_T2 — Method
get_T2(value::PSS2B) -> Float64
-

Get PSS2B T2.

source
PowerSystems.get_T3 — Method
get_T3(value::PSS2B) -> Float64
-

Get PSS2B T3.

source
PowerSystems.get_T4 — Method
get_T4(value::PSS2B) -> Float64
-

Get PSS2B T4.

source
PowerSystems.get_T6 — Method
get_T6(value::PSS2B) -> Float64
-

Get PSS2B T6.

source
PowerSystems.get_T7 — Method
get_T7(value::PSS2B) -> Float64
-

Get PSS2B T7.

source
PowerSystems.get_T8 — Method
get_T8(value::PSS2B) -> Float64
-

Get PSS2B T8.

source
PowerSystems.get_T9 — Method
get_T9(value::PSS2B) -> Float64
-

Get PSS2B T9.

source
PowerSystems.get_Tw1 — Method
get_Tw1(value::PSS2B) -> Float64
-

Get PSS2B Tw1.

source
PowerSystems.get_Tw2 — Method
get_Tw2(value::PSS2B) -> Float64
-

Get PSS2B Tw2.

source
PowerSystems.get_Tw3 — Method
get_Tw3(value::PSS2B) -> Float64
-

Get PSS2B Tw3.

source
PowerSystems.get_Tw4 — Method
get_Tw4(value::PSS2B) -> Float64
-

Get PSS2B Tw4.

source
PowerSystems.get_Vs1_lim — Method
get_Vs1_lim(value::PSS2B) -> Tuple{Float64, Float64}
-

Get PSS2B Vs1_lim.

source
PowerSystems.get_Vs2_lim — Method
get_Vs2_lim(value::PSS2B) -> Tuple{Float64, Float64}
-

Get PSS2B Vs2_lim.

source
PowerSystems.get_Vst_lim — Method
get_Vst_lim(value::PSS2B) -> Tuple{Float64, Float64}
-

Get PSS2B Vst_lim.

source
PowerSystems.get_ext — Method
get_ext(value::PSS2B) -> Dict{String, Any}
-

Get PSS2B ext.

source
PowerSystems.get_input_code_1 — Method
get_input_code_1(value::PSS2B) -> Int64
-

Get PSS2B input_code_1.

source
PowerSystems.get_input_code_2 — Method
get_input_code_2(value::PSS2B) -> Int64
-

Get PSS2B input_code_2.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSS2B) -> Int64
-

Get PSS2B n_states.

source
PowerSystems.get_remote_bus_control_1 — Method
get_remote_bus_control_1(value::PSS2B) -> Int64
-

Get PSS2B remote_bus_control_1.

source
PowerSystems.get_remote_bus_control_2 — Method
get_remote_bus_control_2(value::PSS2B) -> Int64
-

Get PSS2B remote_bus_control_2.

source
PowerSystems.get_states — Method
get_states(value::PSS2B) -> Vector{Symbol}
-

Get PSS2B states.

source
PowerSystems.get_states_types — Method
get_states_types(value::PSS2B) -> Vector{StateTypes}
-

Get PSS2B states_types.

source
PowerSystems.set_Ks1! — Method
set_Ks1!(value::PSS2B, val) -> Any
-

Set PSS2B Ks1.

source
PowerSystems.set_Ks2! — Method
set_Ks2!(value::PSS2B, val) -> Any
-

Set PSS2B Ks2.

source
PowerSystems.set_Ks3! — Method
set_Ks3!(value::PSS2B, val) -> Any
-

Set PSS2B Ks3.

source
PowerSystems.set_M_rtf! — Method
set_M_rtf!(value::PSS2B, val) -> Any
-

Set PSS2B M_rtf.

source
PowerSystems.set_N_rtf! — Method
set_N_rtf!(value::PSS2B, val) -> Any
-

Set PSS2B N_rtf.

source
PowerSystems.set_T1! — Method
set_T1!(value::PSS2B, val) -> Any
-

Set PSS2B T1.

source
PowerSystems.set_T10! — Method
set_T10!(value::PSS2B, val) -> Any
-

Set PSS2B T10.

source
PowerSystems.set_T11! — Method
set_T11!(value::PSS2B, val) -> Any
-

Set PSS2B T11.

source
PowerSystems.set_T2! — Method
set_T2!(value::PSS2B, val) -> Any
-

Set PSS2B T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::PSS2B, val) -> Any
-

Set PSS2B T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::PSS2B, val) -> Any
-

Set PSS2B T4.

source
PowerSystems.set_T6! — Method
set_T6!(value::PSS2B, val) -> Any
-

Set PSS2B T6.

source
PowerSystems.set_T7! — Method
set_T7!(value::PSS2B, val) -> Any
-

Set PSS2B T7.

source
PowerSystems.set_T8! — Method
set_T8!(value::PSS2B, val) -> Any
-

Set PSS2B T8.

source
PowerSystems.set_T9! — Method
set_T9!(value::PSS2B, val) -> Any
-

Set PSS2B T9.

source
PowerSystems.set_Tw1! — Method
set_Tw1!(value::PSS2B, val) -> Any
-

Set PSS2B Tw1.

source
PowerSystems.set_Tw2! — Method
set_Tw2!(value::PSS2B, val) -> Any
-

Set PSS2B Tw2.

source
PowerSystems.set_Tw3! — Method
set_Tw3!(value::PSS2B, val) -> Any
-

Set PSS2B Tw3.

source
PowerSystems.set_Tw4! — Method
set_Tw4!(value::PSS2B, val) -> Any
-

Set PSS2B Tw4.

source
PowerSystems.set_Vs1_lim! — Method
set_Vs1_lim!(value::PSS2B, val) -> Any
-

Set PSS2B Vs1_lim.

source
PowerSystems.set_Vs2_lim! — Method
set_Vs2_lim!(value::PSS2B, val) -> Any
-

Set PSS2B Vs2_lim.

source
PowerSystems.set_Vst_lim! — Method
set_Vst_lim!(value::PSS2B, val) -> Any
-

Set PSS2B Vst_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSS2B, val) -> Any
-

Set PSS2B ext.

source
PowerSystems.set_input_code_1! — Method
set_input_code_1!(value::PSS2B, val) -> Any
-

Set PSS2B input_code_1.

source
PowerSystems.set_input_code_2! — Method
set_input_code_2!(value::PSS2B, val) -> Any
-

Set PSS2B input_code_2.

source
PowerSystems.set_remote_bus_control_1! — Method
set_remote_bus_control_1!(value::PSS2B, val) -> Any
-

Set PSS2B remote_bus_control_1.

source
PowerSystems.set_remote_bus_control_2! — Method
set_remote_bus_control_2!(value::PSS2B, val) -> Any
-

Set PSS2B remote_bus_control_2.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::PSS2B, val) -> Any
-

Set PSS2B states_types.

source

PSS2C

PowerSystems.PSS2C — Type
mutable struct PSS2C <: PSS
+x_p17: 3rd lead-lag,
  • n_states::Int: (Do not modify.) IEEEST has 17 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEST has 17 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ks1 — Method
get_Ks1(value::PSS2B) -> Float64
+

Get PSS2B Ks1.

source
PowerSystems.get_Ks2 — Method
get_Ks2(value::PSS2B) -> Float64
+

Get PSS2B Ks2.

source
PowerSystems.get_Ks3 — Method
get_Ks3(value::PSS2B) -> Float64
+

Get PSS2B Ks3.

source
PowerSystems.get_M_rtf — Method
get_M_rtf(value::PSS2B) -> Int64
+

Get PSS2B M_rtf.

source
PowerSystems.get_N_rtf — Method
get_N_rtf(value::PSS2B) -> Int64
+

Get PSS2B N_rtf.

source
PowerSystems.get_T1 — Method
get_T1(value::PSS2B) -> Float64
+

Get PSS2B T1.

source
PowerSystems.get_T10 — Method
get_T10(value::PSS2B) -> Float64
+

Get PSS2B T10.

source
PowerSystems.get_T11 — Method
get_T11(value::PSS2B) -> Float64
+

Get PSS2B T11.

source
PowerSystems.get_T2 — Method
get_T2(value::PSS2B) -> Float64
+

Get PSS2B T2.

source
PowerSystems.get_T3 — Method
get_T3(value::PSS2B) -> Float64
+

Get PSS2B T3.

source
PowerSystems.get_T4 — Method
get_T4(value::PSS2B) -> Float64
+

Get PSS2B T4.

source
PowerSystems.get_T6 — Method
get_T6(value::PSS2B) -> Float64
+

Get PSS2B T6.

source
PowerSystems.get_T7 — Method
get_T7(value::PSS2B) -> Float64
+

Get PSS2B T7.

source
PowerSystems.get_T8 — Method
get_T8(value::PSS2B) -> Float64
+

Get PSS2B T8.

source
PowerSystems.get_T9 — Method
get_T9(value::PSS2B) -> Float64
+

Get PSS2B T9.

source
PowerSystems.get_Tw1 — Method
get_Tw1(value::PSS2B) -> Float64
+

Get PSS2B Tw1.

source
PowerSystems.get_Tw2 — Method
get_Tw2(value::PSS2B) -> Float64
+

Get PSS2B Tw2.

source
PowerSystems.get_Tw3 — Method
get_Tw3(value::PSS2B) -> Float64
+

Get PSS2B Tw3.

source
PowerSystems.get_Tw4 — Method
get_Tw4(value::PSS2B) -> Float64
+

Get PSS2B Tw4.

source
PowerSystems.get_Vs1_lim — Method
get_Vs1_lim(value::PSS2B) -> Tuple{Float64, Float64}
+

Get PSS2B Vs1_lim.

source
PowerSystems.get_Vs2_lim — Method
get_Vs2_lim(value::PSS2B) -> Tuple{Float64, Float64}
+

Get PSS2B Vs2_lim.

source
PowerSystems.get_Vst_lim — Method
get_Vst_lim(value::PSS2B) -> Tuple{Float64, Float64}
+

Get PSS2B Vst_lim.

source
PowerSystems.get_ext — Method
get_ext(value::PSS2B) -> Dict{String, Any}
+

Get PSS2B ext.

source
PowerSystems.get_input_code_1 — Method
get_input_code_1(value::PSS2B) -> Int64
+

Get PSS2B input_code_1.

source
PowerSystems.get_input_code_2 — Method
get_input_code_2(value::PSS2B) -> Int64
+

Get PSS2B input_code_2.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSS2B) -> Int64
+

Get PSS2B n_states.

source
PowerSystems.get_remote_bus_control_1 — Method
get_remote_bus_control_1(value::PSS2B) -> Int64
+

Get PSS2B remote_bus_control_1.

source
PowerSystems.get_remote_bus_control_2 — Method
get_remote_bus_control_2(value::PSS2B) -> Int64
+

Get PSS2B remote_bus_control_2.

source
PowerSystems.get_states — Method
get_states(value::PSS2B) -> Vector{Symbol}
+

Get PSS2B states.

source
PowerSystems.get_states_types — Method
get_states_types(value::PSS2B) -> Vector{StateTypes}
+

Get PSS2B states_types.

source
PowerSystems.set_Ks1! — Method
set_Ks1!(value::PSS2B, val) -> Any
+

Set PSS2B Ks1.

source
PowerSystems.set_Ks2! — Method
set_Ks2!(value::PSS2B, val) -> Any
+

Set PSS2B Ks2.

source
PowerSystems.set_Ks3! — Method
set_Ks3!(value::PSS2B, val) -> Any
+

Set PSS2B Ks3.

source
PowerSystems.set_M_rtf! — Method
set_M_rtf!(value::PSS2B, val) -> Any
+

Set PSS2B M_rtf.

source
PowerSystems.set_N_rtf! — Method
set_N_rtf!(value::PSS2B, val) -> Any
+

Set PSS2B N_rtf.

source
PowerSystems.set_T1! — Method
set_T1!(value::PSS2B, val) -> Any
+

Set PSS2B T1.

source
PowerSystems.set_T10! — Method
set_T10!(value::PSS2B, val) -> Any
+

Set PSS2B T10.

source
PowerSystems.set_T11! — Method
set_T11!(value::PSS2B, val) -> Any
+

Set PSS2B T11.

source
PowerSystems.set_T2! — Method
set_T2!(value::PSS2B, val) -> Any
+

Set PSS2B T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::PSS2B, val) -> Any
+

Set PSS2B T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::PSS2B, val) -> Any
+

Set PSS2B T4.

source
PowerSystems.set_T6! — Method
set_T6!(value::PSS2B, val) -> Any
+

Set PSS2B T6.

source
PowerSystems.set_T7! — Method
set_T7!(value::PSS2B, val) -> Any
+

Set PSS2B T7.

source
PowerSystems.set_T8! — Method
set_T8!(value::PSS2B, val) -> Any
+

Set PSS2B T8.

source
PowerSystems.set_T9! — Method
set_T9!(value::PSS2B, val) -> Any
+

Set PSS2B T9.

source
PowerSystems.set_Tw1! — Method
set_Tw1!(value::PSS2B, val) -> Any
+

Set PSS2B Tw1.

source
PowerSystems.set_Tw2! — Method
set_Tw2!(value::PSS2B, val) -> Any
+

Set PSS2B Tw2.

source
PowerSystems.set_Tw3! — Method
set_Tw3!(value::PSS2B, val) -> Any
+

Set PSS2B Tw3.

source
PowerSystems.set_Tw4! — Method
set_Tw4!(value::PSS2B, val) -> Any
+

Set PSS2B Tw4.

source
PowerSystems.set_Vs1_lim! — Method
set_Vs1_lim!(value::PSS2B, val) -> Any
+

Set PSS2B Vs1_lim.

source
PowerSystems.set_Vs2_lim! — Method
set_Vs2_lim!(value::PSS2B, val) -> Any
+

Set PSS2B Vs2_lim.

source
PowerSystems.set_Vst_lim! — Method
set_Vst_lim!(value::PSS2B, val) -> Any
+

Set PSS2B Vst_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSS2B, val) -> Any
+

Set PSS2B ext.

source
PowerSystems.set_input_code_1! — Method
set_input_code_1!(value::PSS2B, val) -> Any
+

Set PSS2B input_code_1.

source
PowerSystems.set_input_code_2! — Method
set_input_code_2!(value::PSS2B, val) -> Any
+

Set PSS2B input_code_2.

source
PowerSystems.set_remote_bus_control_1! — Method
set_remote_bus_control_1!(value::PSS2B, val) -> Any
+

Set PSS2B remote_bus_control_1.

source
PowerSystems.set_remote_bus_control_2! — Method
set_remote_bus_control_2!(value::PSS2B, val) -> Any
+

Set PSS2B remote_bus_control_2.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::PSS2B, val) -> Any
+

Set PSS2B states_types.

source

PSS2C

PowerSystems.PSS2C — Type
mutable struct PSS2C <: PSS
     input_code_1::Int
     remote_bus_control_1::Int
     input_code_2::Int
@@ -326,106 +326,106 @@
 x_p16: 2nd lead-lag, 
 x_p17: 3rd lead-lag, 
 x_p18: 4th lead-lag, 
-x_p19: washout block for compensated frequency,
  • n_states::Int: (Do not modify.) IEEEST has 19 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEST has 19 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ks1 — Method
get_Ks1(value::PSS2C) -> Float64
-

Get PSS2C Ks1.

source
PowerSystems.get_Ks2 — Method
get_Ks2(value::PSS2C) -> Float64
-

Get PSS2C Ks2.

source
PowerSystems.get_Ks3 — Method
get_Ks3(value::PSS2C) -> Float64
-

Get PSS2C Ks3.

source
PowerSystems.get_M_rtf — Method
get_M_rtf(value::PSS2C) -> Int64
-

Get PSS2C M_rtf.

source
PowerSystems.get_N_rtf — Method
get_N_rtf(value::PSS2C) -> Int64
-

Get PSS2C N_rtf.

source
PowerSystems.get_PSS_Hysteresis_param — Method
get_PSS_Hysteresis_param(
+x_p19: washout block for compensated frequency,
  • n_states::Int: (Do not modify.) IEEEST has 19 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEST has 19 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ks1 — Method
get_Ks1(value::PSS2C) -> Float64
+

Get PSS2C Ks1.

source
PowerSystems.get_Ks2 — Method
get_Ks2(value::PSS2C) -> Float64
+

Get PSS2C Ks2.

source
PowerSystems.get_Ks3 — Method
get_Ks3(value::PSS2C) -> Float64
+

Get PSS2C Ks3.

source
PowerSystems.get_M_rtf — Method
get_M_rtf(value::PSS2C) -> Int64
+

Get PSS2C M_rtf.

source
PowerSystems.get_N_rtf — Method
get_N_rtf(value::PSS2C) -> Int64
+

Get PSS2C N_rtf.

source
PowerSystems.get_PSS_Hysteresis_param — Method
get_PSS_Hysteresis_param(
     value::PSS2C
 ) -> Tuple{Float64, Float64}
-

Get PSS2C PSS_Hysteresis_param.

source
PowerSystems.get_T1 — Method
get_T1(value::PSS2C) -> Float64
-

Get PSS2C T1.

source
PowerSystems.get_T10 — Method
get_T10(value::PSS2C) -> Float64
-

Get PSS2C T10.

source
PowerSystems.get_T11 — Method
get_T11(value::PSS2C) -> Float64
-

Get PSS2C T11.

source
PowerSystems.get_T12 — Method
get_T12(value::PSS2C) -> Float64
-

Get PSS2C T12.

source
PowerSystems.get_T13 — Method
get_T13(value::PSS2C) -> Float64
-

Get PSS2C T13.

source
PowerSystems.get_T2 — Method
get_T2(value::PSS2C) -> Float64
-

Get PSS2C T2.

source
PowerSystems.get_T3 — Method
get_T3(value::PSS2C) -> Float64
-

Get PSS2C T3.

source
PowerSystems.get_T4 — Method
get_T4(value::PSS2C) -> Float64
-

Get PSS2C T4.

source
PowerSystems.get_T6 — Method
get_T6(value::PSS2C) -> Float64
-

Get PSS2C T6.

source
PowerSystems.get_T7 — Method
get_T7(value::PSS2C) -> Float64
-

Get PSS2C T7.

source
PowerSystems.get_T8 — Method
get_T8(value::PSS2C) -> Float64
-

Get PSS2C T8.

source
PowerSystems.get_T9 — Method
get_T9(value::PSS2C) -> Float64
-

Get PSS2C T9.

source
PowerSystems.get_Tcomp — Method
get_Tcomp(value::PSS2C) -> Float64
-

Get PSS2C Tcomp.

source
PowerSystems.get_Tw1 — Method
get_Tw1(value::PSS2C) -> Float64
-

Get PSS2C Tw1.

source
PowerSystems.get_Tw2 — Method
get_Tw2(value::PSS2C) -> Float64
-

Get PSS2C Tw2.

source
PowerSystems.get_Tw3 — Method
get_Tw3(value::PSS2C) -> Float64
-

Get PSS2C Tw3.

source
PowerSystems.get_Tw4 — Method
get_Tw4(value::PSS2C) -> Float64
-

Get PSS2C Tw4.

source
PowerSystems.get_Vs1_lim — Method
get_Vs1_lim(value::PSS2C) -> Tuple{Float64, Float64}
-

Get PSS2C Vs1_lim.

source
PowerSystems.get_Vs2_lim — Method
get_Vs2_lim(value::PSS2C) -> Tuple{Float64, Float64}
-

Get PSS2C Vs2_lim.

source
PowerSystems.get_Vst_lim — Method
get_Vst_lim(value::PSS2C) -> Tuple{Float64, Float64}
-

Get PSS2C Vst_lim.

source
PowerSystems.get_Xcomp — Method
get_Xcomp(value::PSS2C) -> Float64
-

Get PSS2C Xcomp.

source
PowerSystems.get_ext — Method
get_ext(value::PSS2C) -> Dict{String, Any}
-

Get PSS2C ext.

source
PowerSystems.get_hysteresis_binary_logic — Method
get_hysteresis_binary_logic(value::PSS2C) -> Int64
-

Get PSS2C hysteresis_binary_logic.

source
PowerSystems.get_input_code_1 — Method
get_input_code_1(value::PSS2C) -> Int64
-

Get PSS2C input_code_1.

source
PowerSystems.get_input_code_2 — Method
get_input_code_2(value::PSS2C) -> Int64
-

Get PSS2C input_code_2.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSS2C) -> Int64
-

Get PSS2C n_states.

source
PowerSystems.get_remote_bus_control_1 — Method
get_remote_bus_control_1(value::PSS2C) -> Int64
-

Get PSS2C remote_bus_control_1.

source
PowerSystems.get_remote_bus_control_2 — Method
get_remote_bus_control_2(value::PSS2C) -> Int64
-

Get PSS2C remote_bus_control_2.

source
PowerSystems.get_states — Method
get_states(value::PSS2C) -> Vector{Symbol}
-

Get PSS2C states.

source
PowerSystems.get_states_types — Method
get_states_types(value::PSS2C) -> Vector{StateTypes}
-

Get PSS2C states_types.

source
PowerSystems.set_Ks1! — Method
set_Ks1!(value::PSS2C, val) -> Any
-

Set PSS2C Ks1.

source
PowerSystems.set_Ks2! — Method
set_Ks2!(value::PSS2C, val) -> Any
-

Set PSS2C Ks2.

source
PowerSystems.set_Ks3! — Method
set_Ks3!(value::PSS2C, val) -> Any
-

Set PSS2C Ks3.

source
PowerSystems.set_M_rtf! — Method
set_M_rtf!(value::PSS2C, val) -> Any
-

Set PSS2C M_rtf.

source
PowerSystems.set_N_rtf! — Method
set_N_rtf!(value::PSS2C, val) -> Any
-

Set PSS2C N_rtf.

source
PowerSystems.set_PSS_Hysteresis_param! — Method
set_PSS_Hysteresis_param!(value::PSS2C, val) -> Any
-

Set PSS2C PSS_Hysteresis_param.

source
PowerSystems.set_T1! — Method
set_T1!(value::PSS2C, val) -> Any
-

Set PSS2C T1.

source
PowerSystems.set_T10! — Method
set_T10!(value::PSS2C, val) -> Any
-

Set PSS2C T10.

source
PowerSystems.set_T11! — Method
set_T11!(value::PSS2C, val) -> Any
-

Set PSS2C T11.

source
PowerSystems.set_T12! — Method
set_T12!(value::PSS2C, val) -> Any
-

Set PSS2C T12.

source
PowerSystems.set_T13! — Method
set_T13!(value::PSS2C, val) -> Any
-

Set PSS2C T13.

source
PowerSystems.set_T2! — Method
set_T2!(value::PSS2C, val) -> Any
-

Set PSS2C T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::PSS2C, val) -> Any
-

Set PSS2C T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::PSS2C, val) -> Any
-

Set PSS2C T4.

source
PowerSystems.set_T6! — Method
set_T6!(value::PSS2C, val) -> Any
-

Set PSS2C T6.

source
PowerSystems.set_T7! — Method
set_T7!(value::PSS2C, val) -> Any
-

Set PSS2C T7.

source
PowerSystems.set_T8! — Method
set_T8!(value::PSS2C, val) -> Any
-

Set PSS2C T8.

source
PowerSystems.set_T9! — Method
set_T9!(value::PSS2C, val) -> Any
-

Set PSS2C T9.

source
PowerSystems.set_Tcomp! — Method
set_Tcomp!(value::PSS2C, val) -> Any
-

Set PSS2C Tcomp.

source
PowerSystems.set_Tw1! — Method
set_Tw1!(value::PSS2C, val) -> Any
-

Set PSS2C Tw1.

source
PowerSystems.set_Tw2! — Method
set_Tw2!(value::PSS2C, val) -> Any
-

Set PSS2C Tw2.

source
PowerSystems.set_Tw3! — Method
set_Tw3!(value::PSS2C, val) -> Any
-

Set PSS2C Tw3.

source
PowerSystems.set_Tw4! — Method
set_Tw4!(value::PSS2C, val) -> Any
-

Set PSS2C Tw4.

source
PowerSystems.set_Vs1_lim! — Method
set_Vs1_lim!(value::PSS2C, val) -> Any
-

Set PSS2C Vs1_lim.

source
PowerSystems.set_Vs2_lim! — Method
set_Vs2_lim!(value::PSS2C, val) -> Any
-

Set PSS2C Vs2_lim.

source
PowerSystems.set_Vst_lim! — Method
set_Vst_lim!(value::PSS2C, val) -> Any
-

Set PSS2C Vst_lim.

source
PowerSystems.set_Xcomp! — Method
set_Xcomp!(value::PSS2C, val) -> Any
-

Set PSS2C Xcomp.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSS2C, val) -> Any
-

Set PSS2C ext.

source
PowerSystems.set_hysteresis_binary_logic! — Method
set_hysteresis_binary_logic!(value::PSS2C, val) -> Any
-

Set PSS2C hysteresis_binary_logic.

source
PowerSystems.set_input_code_1! — Method
set_input_code_1!(value::PSS2C, val) -> Any
-

Set PSS2C input_code_1.

source
PowerSystems.set_input_code_2! — Method
set_input_code_2!(value::PSS2C, val) -> Any
-

Set PSS2C input_code_2.

source
PowerSystems.set_remote_bus_control_1! — Method
set_remote_bus_control_1!(value::PSS2C, val) -> Any
-

Set PSS2C remote_bus_control_1.

source
PowerSystems.set_remote_bus_control_2! — Method
set_remote_bus_control_2!(value::PSS2C, val) -> Any
-

Set PSS2C remote_bus_control_2.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::PSS2C, val) -> Any
-

Set PSS2C states_types.

source

PSSFixed

PowerSystems.PSSFixed — Type
mutable struct PSSFixed <: PSS
+

Get PSS2C PSS_Hysteresis_param.

source
PowerSystems.get_T1 — Method
get_T1(value::PSS2C) -> Float64
+

Get PSS2C T1.

source
PowerSystems.get_T10 — Method
get_T10(value::PSS2C) -> Float64
+

Get PSS2C T10.

source
PowerSystems.get_T11 — Method
get_T11(value::PSS2C) -> Float64
+

Get PSS2C T11.

source
PowerSystems.get_T12 — Method
get_T12(value::PSS2C) -> Float64
+

Get PSS2C T12.

source
PowerSystems.get_T13 — Method
get_T13(value::PSS2C) -> Float64
+

Get PSS2C T13.

source
PowerSystems.get_T2 — Method
get_T2(value::PSS2C) -> Float64
+

Get PSS2C T2.

source
PowerSystems.get_T3 — Method
get_T3(value::PSS2C) -> Float64
+

Get PSS2C T3.

source
PowerSystems.get_T4 — Method
get_T4(value::PSS2C) -> Float64
+

Get PSS2C T4.

source
PowerSystems.get_T6 — Method
get_T6(value::PSS2C) -> Float64
+

Get PSS2C T6.

source
PowerSystems.get_T7 — Method
get_T7(value::PSS2C) -> Float64
+

Get PSS2C T7.

source
PowerSystems.get_T8 — Method
get_T8(value::PSS2C) -> Float64
+

Get PSS2C T8.

source
PowerSystems.get_T9 — Method
get_T9(value::PSS2C) -> Float64
+

Get PSS2C T9.

source
PowerSystems.get_Tcomp — Method
get_Tcomp(value::PSS2C) -> Float64
+

Get PSS2C Tcomp.

source
PowerSystems.get_Tw1 — Method
get_Tw1(value::PSS2C) -> Float64
+

Get PSS2C Tw1.

source
PowerSystems.get_Tw2 — Method
get_Tw2(value::PSS2C) -> Float64
+

Get PSS2C Tw2.

source
PowerSystems.get_Tw3 — Method
get_Tw3(value::PSS2C) -> Float64
+

Get PSS2C Tw3.

source
PowerSystems.get_Tw4 — Method
get_Tw4(value::PSS2C) -> Float64
+

Get PSS2C Tw4.

source
PowerSystems.get_Vs1_lim — Method
get_Vs1_lim(value::PSS2C) -> Tuple{Float64, Float64}
+

Get PSS2C Vs1_lim.

source
PowerSystems.get_Vs2_lim — Method
get_Vs2_lim(value::PSS2C) -> Tuple{Float64, Float64}
+

Get PSS2C Vs2_lim.

source
PowerSystems.get_Vst_lim — Method
get_Vst_lim(value::PSS2C) -> Tuple{Float64, Float64}
+

Get PSS2C Vst_lim.

source
PowerSystems.get_Xcomp — Method
get_Xcomp(value::PSS2C) -> Float64
+

Get PSS2C Xcomp.

source
PowerSystems.get_ext — Method
get_ext(value::PSS2C) -> Dict{String, Any}
+

Get PSS2C ext.

source
PowerSystems.get_hysteresis_binary_logic — Method
get_hysteresis_binary_logic(value::PSS2C) -> Int64
+

Get PSS2C hysteresis_binary_logic.

source
PowerSystems.get_input_code_1 — Method
get_input_code_1(value::PSS2C) -> Int64
+

Get PSS2C input_code_1.

source
PowerSystems.get_input_code_2 — Method
get_input_code_2(value::PSS2C) -> Int64
+

Get PSS2C input_code_2.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSS2C) -> Int64
+

Get PSS2C n_states.

source
PowerSystems.get_remote_bus_control_1 — Method
get_remote_bus_control_1(value::PSS2C) -> Int64
+

Get PSS2C remote_bus_control_1.

source
PowerSystems.get_remote_bus_control_2 — Method
get_remote_bus_control_2(value::PSS2C) -> Int64
+

Get PSS2C remote_bus_control_2.

source
PowerSystems.get_states — Method
get_states(value::PSS2C) -> Vector{Symbol}
+

Get PSS2C states.

source
PowerSystems.get_states_types — Method
get_states_types(value::PSS2C) -> Vector{StateTypes}
+

Get PSS2C states_types.

source
PowerSystems.set_Ks1! — Method
set_Ks1!(value::PSS2C, val) -> Any
+

Set PSS2C Ks1.

source
PowerSystems.set_Ks2! — Method
set_Ks2!(value::PSS2C, val) -> Any
+

Set PSS2C Ks2.

source
PowerSystems.set_Ks3! — Method
set_Ks3!(value::PSS2C, val) -> Any
+

Set PSS2C Ks3.

source
PowerSystems.set_M_rtf! — Method
set_M_rtf!(value::PSS2C, val) -> Any
+

Set PSS2C M_rtf.

source
PowerSystems.set_N_rtf! — Method
set_N_rtf!(value::PSS2C, val) -> Any
+

Set PSS2C N_rtf.

source
PowerSystems.set_PSS_Hysteresis_param! — Method
set_PSS_Hysteresis_param!(value::PSS2C, val) -> Any
+

Set PSS2C PSS_Hysteresis_param.

source
PowerSystems.set_T1! — Method
set_T1!(value::PSS2C, val) -> Any
+

Set PSS2C T1.

source
PowerSystems.set_T10! — Method
set_T10!(value::PSS2C, val) -> Any
+

Set PSS2C T10.

source
PowerSystems.set_T11! — Method
set_T11!(value::PSS2C, val) -> Any
+

Set PSS2C T11.

source
PowerSystems.set_T12! — Method
set_T12!(value::PSS2C, val) -> Any
+

Set PSS2C T12.

source
PowerSystems.set_T13! — Method
set_T13!(value::PSS2C, val) -> Any
+

Set PSS2C T13.

source
PowerSystems.set_T2! — Method
set_T2!(value::PSS2C, val) -> Any
+

Set PSS2C T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::PSS2C, val) -> Any
+

Set PSS2C T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::PSS2C, val) -> Any
+

Set PSS2C T4.

source
PowerSystems.set_T6! — Method
set_T6!(value::PSS2C, val) -> Any
+

Set PSS2C T6.

source
PowerSystems.set_T7! — Method
set_T7!(value::PSS2C, val) -> Any
+

Set PSS2C T7.

source
PowerSystems.set_T8! — Method
set_T8!(value::PSS2C, val) -> Any
+

Set PSS2C T8.

source
PowerSystems.set_T9! — Method
set_T9!(value::PSS2C, val) -> Any
+

Set PSS2C T9.

source
PowerSystems.set_Tcomp! — Method
set_Tcomp!(value::PSS2C, val) -> Any
+

Set PSS2C Tcomp.

source
PowerSystems.set_Tw1! — Method
set_Tw1!(value::PSS2C, val) -> Any
+

Set PSS2C Tw1.

source
PowerSystems.set_Tw2! — Method
set_Tw2!(value::PSS2C, val) -> Any
+

Set PSS2C Tw2.

source
PowerSystems.set_Tw3! — Method
set_Tw3!(value::PSS2C, val) -> Any
+

Set PSS2C Tw3.

source
PowerSystems.set_Tw4! — Method
set_Tw4!(value::PSS2C, val) -> Any
+

Set PSS2C Tw4.

source
PowerSystems.set_Vs1_lim! — Method
set_Vs1_lim!(value::PSS2C, val) -> Any
+

Set PSS2C Vs1_lim.

source
PowerSystems.set_Vs2_lim! — Method
set_Vs2_lim!(value::PSS2C, val) -> Any
+

Set PSS2C Vs2_lim.

source
PowerSystems.set_Vst_lim! — Method
set_Vst_lim!(value::PSS2C, val) -> Any
+

Set PSS2C Vst_lim.

source
PowerSystems.set_Xcomp! — Method
set_Xcomp!(value::PSS2C, val) -> Any
+

Set PSS2C Xcomp.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSS2C, val) -> Any
+

Set PSS2C ext.

source
PowerSystems.set_hysteresis_binary_logic! — Method
set_hysteresis_binary_logic!(value::PSS2C, val) -> Any
+

Set PSS2C hysteresis_binary_logic.

source
PowerSystems.set_input_code_1! — Method
set_input_code_1!(value::PSS2C, val) -> Any
+

Set PSS2C input_code_1.

source
PowerSystems.set_input_code_2! — Method
set_input_code_2!(value::PSS2C, val) -> Any
+

Set PSS2C input_code_2.

source
PowerSystems.set_remote_bus_control_1! — Method
set_remote_bus_control_1!(value::PSS2C, val) -> Any
+

Set PSS2C remote_bus_control_1.

source
PowerSystems.set_remote_bus_control_2! — Method
set_remote_bus_control_2!(value::PSS2C, val) -> Any
+

Set PSS2C remote_bus_control_2.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::PSS2C, val) -> Any
+

Set PSS2C states_types.

source

PSSFixed

PowerSystems.PSSFixed — Type
mutable struct PSSFixed <: PSS
     V_pss::Float64
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
     internal::InfrastructureSystemsInternal
-end

Parameters of a PSS that returns a fixed voltage to add to the reference for the AVR

Arguments

  • V_pss::Float64: Fixed voltage stabilization signal in pu (DEVICE_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) PSSFixed has no states
  • n_states::Int: (Do not modify.) PSSFixed has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_V_pss — Method
get_V_pss(value::PSSFixed) -> Float64
-

Get PSSFixed V_pss.

source
PowerSystems.get_ext — Method
get_ext(value::PSSFixed) -> Dict{String, Any}
-

Get PSSFixed ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSSFixed) -> Int64
-

Get PSSFixed n_states.

source
PowerSystems.get_states — Method
get_states(value::PSSFixed) -> Vector{Symbol}
-

Get PSSFixed states.

source
PowerSystems.set_V_pss! — Method
set_V_pss!(value::PSSFixed, val) -> Any
-

Set PSSFixed V_pss.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSSFixed, val) -> Any
-

Set PSSFixed ext.

source

PSSSimple

PowerSystems.PSSSimple — Type
mutable struct PSSSimple <: PSS
+end

Parameters of a PSS that returns a fixed voltage to add to the reference for the AVR

Arguments

  • V_pss::Float64: Fixed voltage stabilization signal in pu (DEVICE_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) PSSFixed has no states
  • n_states::Int: (Do not modify.) PSSFixed has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_V_pss — Method
get_V_pss(value::PSSFixed) -> Float64
+

Get PSSFixed V_pss.

source
PowerSystems.get_ext — Method
get_ext(value::PSSFixed) -> Dict{String, Any}
+

Get PSSFixed ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSSFixed) -> Int64
+

Get PSSFixed n_states.

source
PowerSystems.get_states — Method
get_states(value::PSSFixed) -> Vector{Symbol}
+

Get PSSFixed states.

source
PowerSystems.set_V_pss! — Method
set_V_pss!(value::PSSFixed, val) -> Any
+

Set PSSFixed V_pss.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSSFixed, val) -> Any
+

Set PSSFixed ext.

source

PSSSimple

PowerSystems.PSSSimple — Type
mutable struct PSSSimple <: PSS
     K_ω::Float64
     K_p::Float64
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
     internal::InfrastructureSystemsInternal
-end

Parameters of a PSS that returns a proportional droop voltage to add to the reference for the AVR

Arguments

  • K_ω::Float64: Proportional gain for frequency, validation range: (0, nothing)
  • K_p::Float64: Proportional gain for active power, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) PSSSimple has no states
  • n_states::Int: (Do not modify.) PSSSimple has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K_p — Method
get_K_p(value::PSSSimple) -> Float64
-

Get PSSSimple K_p.

source
PowerSystems.get_K_ω — Method
get_K_ω(value::PSSSimple) -> Float64
-

Get PSSSimple K_ω.

source
PowerSystems.get_ext — Method
get_ext(value::PSSSimple) -> Dict{String, Any}
-

Get PSSSimple ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSSSimple) -> Int64
-

Get PSSSimple n_states.

source
PowerSystems.get_states — Method
get_states(value::PSSSimple) -> Vector{Symbol}
-

Get PSSSimple states.

source
PowerSystems.set_K_p! — Method
set_K_p!(value::PSSSimple, val) -> Any
-

Set PSSSimple K_p.

source
PowerSystems.set_K_ω! — Method
set_K_ω!(value::PSSSimple, val) -> Any
-

Set PSSSimple K_ω.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSSSimple, val) -> Any
-

Set PSSSimple ext.

source

STAB1

PowerSystems.STAB1 — Type
mutable struct STAB1 <: PSS
+end

Parameters of a PSS that returns a proportional droop voltage to add to the reference for the AVR

Arguments

  • K_ω::Float64: Proportional gain for frequency, validation range: (0, nothing)
  • K_p::Float64: Proportional gain for active power, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) PSSSimple has no states
  • n_states::Int: (Do not modify.) PSSSimple has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K_p — Method
get_K_p(value::PSSSimple) -> Float64
+

Get PSSSimple K_p.

source
PowerSystems.get_K_ω — Method
get_K_ω(value::PSSSimple) -> Float64
+

Get PSSSimple K_ω.

source
PowerSystems.get_ext — Method
get_ext(value::PSSSimple) -> Dict{String, Any}
+

Get PSSSimple ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::PSSSimple) -> Int64
+

Get PSSSimple n_states.

source
PowerSystems.get_states — Method
get_states(value::PSSSimple) -> Vector{Symbol}
+

Get PSSSimple states.

source
PowerSystems.set_K_p! — Method
set_K_p!(value::PSSSimple, val) -> Any
+

Set PSSSimple K_p.

source
PowerSystems.set_K_ω! — Method
set_K_ω!(value::PSSSimple, val) -> Any
+

Set PSSSimple K_ω.

source
PowerSystems.set_ext! — Method
set_ext!(value::PSSSimple, val) -> Any
+

Set PSSSimple ext.

source

STAB1

PowerSystems.STAB1 — Type
mutable struct STAB1 <: PSS
     KT::Float64
     T::Float64
     T1T3::Float64
@@ -440,24 +440,24 @@
     internal::InfrastructureSystemsInternal
 end

Speed-Sensitive Stabilizing Model

Arguments

  • KT::Float64: K/T for washout filter, validation range: (0, nothing)
  • T::Float64: Time constant for washout filter, validation range: (0.01, nothing)
  • T1T3::Float64: Time constant division T1/T3, validation range: (0, nothing)
  • T3::Float64: Time constant, validation range: (0.01, nothing)
  • T2T4::Float64: Time constant division T2/T4, validation range: (0, nothing)
  • T4::Float64: Time constant, validation range: (0.01, nothing)
  • H_lim::Float64: PSS output limit, validation range: (0, 0.5)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
x_p1: washout filter,
 x_p2: T1/T3 lead-lag block, 
-x_p3: T2/T4 lead-lag block,
  • n_states::Int: (Do not modify.) STAB1 has 3 states
  • states_types::Vector{StateTypes}: (Do not modify.) STAB1 has 3 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_H_lim — Method
get_H_lim(value::STAB1) -> Float64
-

Get STAB1 H_lim.

source
PowerSystems.get_KT — Method
get_KT(value::STAB1) -> Float64
-

Get STAB1 KT.

source
PowerSystems.get_T — Method
get_T(value::STAB1) -> Float64
-

Get STAB1 T.

source
PowerSystems.get_T1T3 — Method
get_T1T3(value::STAB1) -> Float64
-

Get STAB1 T1T3.

source
PowerSystems.get_T2T4 — Method
get_T2T4(value::STAB1) -> Float64
-

Get STAB1 T2T4.

source
PowerSystems.get_T3 — Method
get_T3(value::STAB1) -> Float64
-

Get STAB1 T3.

source
PowerSystems.get_T4 — Method
get_T4(value::STAB1) -> Float64
-

Get STAB1 T4.

source
PowerSystems.get_ext — Method
get_ext(value::STAB1) -> Dict{String, Any}
-

Get STAB1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::STAB1) -> Int64
-

Get STAB1 n_states.

source
PowerSystems.get_states — Method
get_states(value::STAB1) -> Vector{Symbol}
-

Get STAB1 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::STAB1) -> Vector{StateTypes}
-

Get STAB1 states_types.

source
PowerSystems.set_H_lim! — Method
set_H_lim!(value::STAB1, val) -> Any
-

Set STAB1 H_lim.

source
PowerSystems.set_KT! — Method
set_KT!(value::STAB1, val) -> Any
-

Set STAB1 KT.

source
PowerSystems.set_T! — Method
set_T!(value::STAB1, val) -> Any
-

Set STAB1 T.

source
PowerSystems.set_T1T3! — Method
set_T1T3!(value::STAB1, val) -> Any
-

Set STAB1 T1T3.

source
PowerSystems.set_T2T4! — Method
set_T2T4!(value::STAB1, val) -> Any
-

Set STAB1 T2T4.

source
PowerSystems.set_T3! — Method
set_T3!(value::STAB1, val) -> Any
-

Set STAB1 T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::STAB1, val) -> Any
-

Set STAB1 T4.

source
PowerSystems.set_ext! — Method
set_ext!(value::STAB1, val) -> Any
-

Set STAB1 ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::STAB1, val) -> Any
-

Set STAB1 states_types.

source
+x_p3: T2/T4 lead-lag block,source
PowerSystems.get_H_lim — Method
get_H_lim(value::STAB1) -> Float64
+

Get STAB1 H_lim.

source
PowerSystems.get_KT — Method
get_KT(value::STAB1) -> Float64
+

Get STAB1 KT.

source
PowerSystems.get_T — Method
get_T(value::STAB1) -> Float64
+

Get STAB1 T.

source
PowerSystems.get_T1T3 — Method
get_T1T3(value::STAB1) -> Float64
+

Get STAB1 T1T3.

source
PowerSystems.get_T2T4 — Method
get_T2T4(value::STAB1) -> Float64
+

Get STAB1 T2T4.

source
PowerSystems.get_T3 — Method
get_T3(value::STAB1) -> Float64
+

Get STAB1 T3.

source
PowerSystems.get_T4 — Method
get_T4(value::STAB1) -> Float64
+

Get STAB1 T4.

source
PowerSystems.get_ext — Method
get_ext(value::STAB1) -> Dict{String, Any}
+

Get STAB1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::STAB1) -> Int64
+

Get STAB1 n_states.

source
PowerSystems.get_states — Method
get_states(value::STAB1) -> Vector{Symbol}
+

Get STAB1 states.

source
PowerSystems.get_states_types — Method
get_states_types(value::STAB1) -> Vector{StateTypes}
+

Get STAB1 states_types.

source
PowerSystems.set_H_lim! — Method
set_H_lim!(value::STAB1, val) -> Any
+

Set STAB1 H_lim.

source
PowerSystems.set_KT! — Method
set_KT!(value::STAB1, val) -> Any
+

Set STAB1 KT.

source
PowerSystems.set_T! — Method
set_T!(value::STAB1, val) -> Any
+

Set STAB1 T.

source
PowerSystems.set_T1T3! — Method
set_T1T3!(value::STAB1, val) -> Any
+

Set STAB1 T1T3.

source
PowerSystems.set_T2T4! — Method
set_T2T4!(value::STAB1, val) -> Any
+

Set STAB1 T2T4.

source
PowerSystems.set_T3! — Method
set_T3!(value::STAB1, val) -> Any
+

Set STAB1 T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::STAB1, val) -> Any
+

Set STAB1 T4.

source
PowerSystems.set_ext! — Method
set_ext!(value::STAB1, val) -> Any
+

Set STAB1 ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::STAB1, val) -> Any
+

Set STAB1 states_types.

source
diff --git a/dev/model_library/generated_PhaseShiftingTransformer/index.html b/dev/model_library/generated_PhaseShiftingTransformer/index.html index 17a9646ab7..3e81f96f59 100644 --- a/dev/model_library/generated_PhaseShiftingTransformer/index.html +++ b/dev/model_library/generated_PhaseShiftingTransformer/index.html @@ -15,55 +15,55 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A phase-shifting transformer regulating the phase angle between two buses to control active power flow in the system.

The model uses an equivalent circuit assuming the impedance is on the High Voltage Side of the transformer. The model allocates the iron losses and magnetizing susceptance to the primary side

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::PhaseShiftingTransformer) -> String
-

Get PhaseShiftingTransformer name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(
+end

A phase-shifting transformer regulating the phase angle between two buses to control active power flow in the system.

The model uses an equivalent circuit assuming the impedance is on the High Voltage Side of the transformer. The model allocates the iron losses and magnetizing susceptance to the primary side

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • active_power_flow::Float64: Initial condition of active power flow through the transformer (MW)
  • reactive_power_flow::Float64: Initial condition of reactive power flow through the transformer (MVAR)
  • arc::Arc: An Arc defining this transformer from a bus to another bus
  • r::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)
  • x::Float64: Reactance in pu (SYSTEM_BASE), validation range: (-2, 4)
  • primary_shunt::Float64:, validation range: (0, 2)
  • tap::Float64: Normalized tap changer position for voltage control, varying between 0 and 2, with 1 centered at the nominal voltage, validation range: (0, 2)
  • α::Float64: Initial condition of phase shift (radians) between the from and to buses , validation range: (-1.571, 1.571)
  • rating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating and rating, validation range: (0, nothing)
  • phase_angle_limits::MinMax: (default: (min=-1.571, max=1.571)) Minimum and maximum phase angle limits (radians), validation range: (-1.571, 1.571)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::PhaseShiftingTransformer) -> String
+

Get PhaseShiftingTransformer name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(
     value::PhaseShiftingTransformer
 ) -> Any
-

Get PhaseShiftingTransformer active_power_flow.

source
PowerSystems.get_arc — Method
get_arc(value::PhaseShiftingTransformer) -> Arc
-

Get PhaseShiftingTransformer arc.

source
PowerSystems.get_available — Method
get_available(value::PhaseShiftingTransformer) -> Bool
-

Get PhaseShiftingTransformer available.

source
PowerSystems.get_ext — Method
get_ext(
+

Get PhaseShiftingTransformer active_power_flow.

source
PowerSystems.get_arc — Method
get_arc(value::PhaseShiftingTransformer) -> Arc
+

Get PhaseShiftingTransformer arc.

source
PowerSystems.get_available — Method
get_available(value::PhaseShiftingTransformer) -> Bool
+

Get PhaseShiftingTransformer available.

source
PowerSystems.get_ext — Method
get_ext(
     value::PhaseShiftingTransformer
 ) -> Dict{String, Any}
-

Get PhaseShiftingTransformer ext.

source
PowerSystems.get_phase_angle_limits — Method
get_phase_angle_limits(
+

Get PhaseShiftingTransformer ext.

source
PowerSystems.get_phase_angle_limits — Method
get_phase_angle_limits(
     value::PhaseShiftingTransformer
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get PhaseShiftingTransformer phase_angle_limits.

source
PowerSystems.get_primary_shunt — Method
get_primary_shunt(
+

Get PhaseShiftingTransformer phase_angle_limits.

source
PowerSystems.get_primary_shunt — Method
get_primary_shunt(
     value::PhaseShiftingTransformer
 ) -> Float64
-

Get PhaseShiftingTransformer primary_shunt.

source
PowerSystems.get_r — Method
get_r(value::PhaseShiftingTransformer) -> Float64
-

Get PhaseShiftingTransformer r.

source
PowerSystems.get_rating — Method
get_rating(value::PhaseShiftingTransformer) -> Any
-

Get PhaseShiftingTransformer rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(
+

Get PhaseShiftingTransformer primary_shunt.

source
PowerSystems.get_r — Method
get_r(value::PhaseShiftingTransformer) -> Float64
+

Get PhaseShiftingTransformer r.

source
PowerSystems.get_rating — Method
get_rating(value::PhaseShiftingTransformer) -> Any
+

Get PhaseShiftingTransformer rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(
     value::PhaseShiftingTransformer
 ) -> Any
-

Get PhaseShiftingTransformer reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(
+

Get PhaseShiftingTransformer reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(
     value::PhaseShiftingTransformer
 ) -> Vector{Service}
-

Get PhaseShiftingTransformer services.

source
PowerSystems.get_tap — Method
get_tap(value::PhaseShiftingTransformer) -> Float64
-

Get PhaseShiftingTransformer tap.

source
PowerSystems.get_x — Method
get_x(value::PhaseShiftingTransformer) -> Float64
-

Get PhaseShiftingTransformer x.

source
PowerSystems.get_α — Method
get_α(value::PhaseShiftingTransformer) -> Float64
-

Get PhaseShiftingTransformer α.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(
+

Get PhaseShiftingTransformer services.

source
PowerSystems.get_tap — Method
get_tap(value::PhaseShiftingTransformer) -> Float64
+

Get PhaseShiftingTransformer tap.

source
PowerSystems.get_x — Method
get_x(value::PhaseShiftingTransformer) -> Float64
+

Get PhaseShiftingTransformer x.

source
PowerSystems.get_α — Method
get_α(value::PhaseShiftingTransformer) -> Float64
+

Get PhaseShiftingTransformer α.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(
     value::PhaseShiftingTransformer,
     val
 ) -> Any
-

Set PhaseShiftingTransformer active_power_flow.

source
PowerSystems.set_arc! — Method
set_arc!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer arc.

source
PowerSystems.set_available! — Method
set_available!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer available.

source
PowerSystems.set_ext! — Method
set_ext!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer ext.

source
PowerSystems.set_phase_angle_limits! — Method
set_phase_angle_limits!(
+

Set PhaseShiftingTransformer active_power_flow.

source
PowerSystems.set_arc! — Method
set_arc!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer arc.

source
PowerSystems.set_available! — Method
set_available!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer available.

source
PowerSystems.set_ext! — Method
set_ext!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer ext.

source
PowerSystems.set_phase_angle_limits! — Method
set_phase_angle_limits!(
     value::PhaseShiftingTransformer,
     val
 ) -> Any
-

Set PhaseShiftingTransformer phase_angle_limits.

source
PowerSystems.set_primary_shunt! — Method
set_primary_shunt!(
+

Set PhaseShiftingTransformer phase_angle_limits.

source
PowerSystems.set_primary_shunt! — Method
set_primary_shunt!(
     value::PhaseShiftingTransformer,
     val
 ) -> Any
-

Set PhaseShiftingTransformer primary_shunt.

source
PowerSystems.set_r! — Method
set_r!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer r.

source
PowerSystems.set_rating! — Method
set_rating!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(
+

Set PhaseShiftingTransformer primary_shunt.

source
PowerSystems.set_r! — Method
set_r!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer r.

source
PowerSystems.set_rating! — Method
set_rating!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(
     value::PhaseShiftingTransformer,
     val
 ) -> Any
-

Set PhaseShiftingTransformer reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer services.

source
PowerSystems.set_tap! — Method
set_tap!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer tap.

source
PowerSystems.set_x! — Method
set_x!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer x.

source
PowerSystems.set_α! — Method
set_α!(value::PhaseShiftingTransformer, val) -> Any
-

Set PhaseShiftingTransformer α.

source
+

Set PhaseShiftingTransformer reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer services.

source
PowerSystems.set_tap! — Method
set_tap!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer tap.

source
PowerSystems.set_x! — Method
set_x!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer x.

source
PowerSystems.set_α! — Method
set_α!(value::PhaseShiftingTransformer, val) -> Any
+

Set PhaseShiftingTransformer α.

source
diff --git a/dev/model_library/generated_PowerLoad/index.html b/dev/model_library/generated_PowerLoad/index.html index bde5a778f6..59273084b5 100644 --- a/dev/model_library/generated_PowerLoad/index.html +++ b/dev/model_library/generated_PowerLoad/index.html @@ -12,26 +12,26 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A static power load, most commonly used for operational models such as power flow and operational optimizations.

This load consumes a set amount of power (set by active_power for a power flow simulation or a max_active_power time series for an operational simulation). For loads that can be compensated for load interruptions through demand response programs, see InterruptiblePowerLoad. For voltage-dependent loads used in dynamics modeling, see StandardLoad

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::PowerLoad) -> String
-

Get PowerLoad name.

source
PowerSystems.get_active_power — Method
get_active_power(value::PowerLoad) -> Any
-

Get PowerLoad active_power.

source
PowerSystems.get_available — Method
get_available(value::PowerLoad) -> Bool
-

Get PowerLoad available.

source
PowerSystems.get_base_power — Method
get_base_power(value::PowerLoad) -> Float64
-

Get PowerLoad base_power.

source
PowerSystems.get_bus — Method
get_bus(value::PowerLoad) -> ACBus
-

Get PowerLoad bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A static power load, most commonly used for operational models such as power flow and operational optimizations.

This load consumes a set amount of power (set by active_power for a power flow simulation or a max_active_power time series for an operational simulation). For loads that can be compensated for load interruptions through demand response programs, see InterruptiblePowerLoad. For voltage-dependent loads used in dynamics modeling, see StandardLoad

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial steady-state active power demand (MW)
  • reactive_power::Float64: Initial steady-state reactive power demand (MVAR)
  • base_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)
  • max_active_power::Float64: Maximum active power (MW) that this load can demand
  • max_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::PowerLoad) -> String
+

Get PowerLoad name.

source
PowerSystems.get_active_power — Method
get_active_power(value::PowerLoad) -> Any
+

Get PowerLoad active_power.

source
PowerSystems.get_available — Method
get_available(value::PowerLoad) -> Bool
+

Get PowerLoad available.

source
PowerSystems.get_base_power — Method
get_base_power(value::PowerLoad) -> Float64
+

Get PowerLoad base_power.

source
PowerSystems.get_bus — Method
get_bus(value::PowerLoad) -> ACBus
+

Get PowerLoad bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::PowerLoad
 ) -> Union{Nothing, DynamicInjection}
-

Get PowerLoad dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::PowerLoad) -> Dict{String, Any}
-

Get PowerLoad ext.

source
PowerSystems.get_max_active_power — Method
get_max_active_power(value::PowerLoad) -> Any
-

Get PowerLoad max_active_power.

source
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(value::PowerLoad) -> Any
-

Get PowerLoad max_reactive_power.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::PowerLoad) -> Any
-

Get PowerLoad reactive_power.

source
PowerSystems.get_services — Method
get_services(value::PowerLoad) -> Vector{Service}
-

Get PowerLoad services.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::PowerLoad, val) -> Any
-

Set PowerLoad active_power.

source
PowerSystems.set_available! — Method
set_available!(value::PowerLoad, val) -> Any
-

Set PowerLoad available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::PowerLoad, val) -> Any
-

Set PowerLoad base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::PowerLoad, val) -> Any
-

Set PowerLoad bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::PowerLoad, val) -> Any
-

Set PowerLoad ext.

source
PowerSystems.set_max_active_power! — Method
set_max_active_power!(value::PowerLoad, val) -> Any
-

Set PowerLoad max_active_power.

source
PowerSystems.set_max_reactive_power! — Method
set_max_reactive_power!(value::PowerLoad, val) -> Any
-

Set PowerLoad max_reactive_power.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::PowerLoad, val) -> Any
-

Set PowerLoad reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::PowerLoad, val) -> Any
-

Set PowerLoad services.

source
+

Get PowerLoad dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::PowerLoad) -> Dict{String, Any}
+

Get PowerLoad ext.

source
PowerSystems.get_max_active_power — Method
get_max_active_power(value::PowerLoad) -> Any
+

Get PowerLoad max_active_power.

source
PowerSystems.get_max_reactive_power — Method
get_max_reactive_power(value::PowerLoad) -> Any
+

Get PowerLoad max_reactive_power.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::PowerLoad) -> Any
+

Get PowerLoad reactive_power.

source
PowerSystems.get_services — Method
get_services(value::PowerLoad) -> Vector{Service}
+

Get PowerLoad services.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::PowerLoad, val) -> Any
+

Set PowerLoad active_power.

source
PowerSystems.set_available! — Method
set_available!(value::PowerLoad, val) -> Any
+

Set PowerLoad available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::PowerLoad, val) -> Any
+

Set PowerLoad base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::PowerLoad, val) -> Any
+

Set PowerLoad bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::PowerLoad, val) -> Any
+

Set PowerLoad ext.

source
PowerSystems.set_max_active_power! — Method
set_max_active_power!(value::PowerLoad, val) -> Any
+

Set PowerLoad max_active_power.

source
PowerSystems.set_max_reactive_power! — Method
set_max_reactive_power!(value::PowerLoad, val) -> Any
+

Set PowerLoad max_reactive_power.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::PowerLoad, val) -> Any
+

Set PowerLoad reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::PowerLoad, val) -> Any
+

Set PowerLoad services.

source
diff --git a/dev/model_library/generated_RenewableDispatch/index.html b/dev/model_library/generated_RenewableDispatch/index.html index bf3a18223e..3a445a9fd0 100644 --- a/dev/model_library/generated_RenewableDispatch/index.html +++ b/dev/model_library/generated_RenewableDispatch/index.html @@ -15,41 +15,41 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A renewable (e.g., wind or solar) generator whose output can be curtailed to satisfy power system constraints.

These generators can also participate in reserves markets, including upwards reserves by proactively curtailing some available power (based on its max_active_power time series). Example uses include: a utility-scale wind or solar generator whose PPA allows curtailment. For non-curtailable or must-take renewables, see RenewableNonDispatch.

Renewable generators do not have a max_active_power parameter, which is instead calculated when calling get_max_active_power()

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::RenewableDispatch) -> String
-

Get RenewableDispatch name.

source
PowerSystems.get_active_power — Method
get_active_power(value::RenewableDispatch) -> Any
-

Get RenewableDispatch active_power.

source
PowerSystems.get_available — Method
get_available(value::RenewableDispatch) -> Bool
-

Get RenewableDispatch available.

source
PowerSystems.get_base_power — Method
get_base_power(value::RenewableDispatch) -> Float64
-

Get RenewableDispatch base_power.

source
PowerSystems.get_bus — Method
get_bus(value::RenewableDispatch) -> ACBus
-

Get RenewableDispatch bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A renewable (e.g., wind or solar) generator whose output can be curtailed to satisfy power system constraints.

These generators can also participate in reserves markets, including upwards reserves by proactively curtailing some available power (based on its max_active_power time series). Example uses include: a utility-scale wind or solar generator whose PPA allows curtailment. For non-curtailable or must-take renewables, see RenewableNonDispatch.

Renewable generators do not have a max_active_power parameter, which is instead calculated when calling get_max_active_power()

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR)
  • rating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)
  • prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here
  • reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable
  • power_factor::Float64:, validation range: (0, 1)
  • operation_cost::Union{RenewableGenerationCost, MarketBidCost}: OperationalCost of generation
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating, validation range: (0, nothing)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::RenewableDispatch) -> String
+

Get RenewableDispatch name.

source
PowerSystems.get_active_power — Method
get_active_power(value::RenewableDispatch) -> Any
+

Get RenewableDispatch active_power.

source
PowerSystems.get_available — Method
get_available(value::RenewableDispatch) -> Bool
+

Get RenewableDispatch available.

source
PowerSystems.get_base_power — Method
get_base_power(value::RenewableDispatch) -> Float64
+

Get RenewableDispatch base_power.

source
PowerSystems.get_bus — Method
get_bus(value::RenewableDispatch) -> ACBus
+

Get RenewableDispatch bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::RenewableDispatch
 ) -> Union{Nothing, DynamicInjection}
-

Get RenewableDispatch dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::RenewableDispatch) -> Dict{String, Any}
-

Get RenewableDispatch ext.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
+

Get RenewableDispatch dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::RenewableDispatch) -> Dict{String, Any}
+

Get RenewableDispatch ext.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
     value::RenewableDispatch
 ) -> Union{MarketBidCost, RenewableGenerationCost}
-

Get RenewableDispatch operation_cost.

source
PowerSystems.get_power_factor — Method
get_power_factor(value::RenewableDispatch) -> Float64
-

Get RenewableDispatch power_factor.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
+

Get RenewableDispatch operation_cost.

source
PowerSystems.get_power_factor — Method
get_power_factor(value::RenewableDispatch) -> Float64
+

Get RenewableDispatch power_factor.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
     value::RenewableDispatch
 ) -> PrimeMovers
-

Get RenewableDispatch prime_mover_type.

source
PowerSystems.get_rating — Method
get_rating(value::RenewableDispatch) -> Any
-

Get RenewableDispatch rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::RenewableDispatch) -> Any
-

Get RenewableDispatch reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
+

Get RenewableDispatch prime_mover_type.

source
PowerSystems.get_rating — Method
get_rating(value::RenewableDispatch) -> Any
+

Get RenewableDispatch rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::RenewableDispatch) -> Any
+

Get RenewableDispatch reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
     value::RenewableDispatch
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get RenewableDispatch reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::RenewableDispatch) -> Vector{Service}
-

Get RenewableDispatch services.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch active_power.

source
PowerSystems.set_available! — Method
set_available!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch ext.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch operation_cost.

source
PowerSystems.set_power_factor! — Method
set_power_factor!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch power_factor.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch prime_mover_type.

source
PowerSystems.set_rating! — Method
set_rating!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
+

Get RenewableDispatch reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::RenewableDispatch) -> Vector{Service}
+

Get RenewableDispatch services.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch active_power.

source
PowerSystems.set_available! — Method
set_available!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch ext.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch operation_cost.

source
PowerSystems.set_power_factor! — Method
set_power_factor!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch power_factor.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch prime_mover_type.

source
PowerSystems.set_rating! — Method
set_rating!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
     value::RenewableDispatch,
     val
 ) -> Any
-

Set RenewableDispatch reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::RenewableDispatch, val) -> Any
-

Set RenewableDispatch services.

source
+

Set RenewableDispatch reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::RenewableDispatch, val) -> Any
+

Set RenewableDispatch services.

source
diff --git a/dev/model_library/generated_RenewableNonDispatch/index.html b/dev/model_library/generated_RenewableNonDispatch/index.html index 2266e78b29..7f05519664 100644 --- a/dev/model_library/generated_RenewableNonDispatch/index.html +++ b/dev/model_library/generated_RenewableNonDispatch/index.html @@ -13,33 +13,33 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A non-dispatchable (i.e., non-curtailable or must-take) renewable generator.

Its output is equal to its max_active_power time series by default. Example use: an aggregation of behind-the-meter distributed energy resources like rooftop solar. For curtailable or downward dispatachable generation, see RenewableDispatch.

Renewable generators do not have a max_active_power parameter, which is instead calculated when calling get_max_active_power()

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::RenewableNonDispatch) -> String
-

Get RenewableNonDispatch name.

source
PowerSystems.get_active_power — Method
get_active_power(value::RenewableNonDispatch) -> Any
-

Get RenewableNonDispatch active_power.

source
PowerSystems.get_available — Method
get_available(value::RenewableNonDispatch) -> Bool
-

Get RenewableNonDispatch available.

source
PowerSystems.get_base_power — Method
get_base_power(value::RenewableNonDispatch) -> Float64
-

Get RenewableNonDispatch base_power.

source
PowerSystems.get_bus — Method
get_bus(value::RenewableNonDispatch) -> ACBus
-

Get RenewableNonDispatch bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A non-dispatchable (i.e., non-curtailable or must-take) renewable generator.

Its output is equal to its max_active_power time series by default. Example use: an aggregation of behind-the-meter distributed energy resources like rooftop solar. For curtailable or downward dispatachable generation, see RenewableDispatch.

Renewable generators do not have a max_active_power parameter, which is instead calculated when calling get_max_active_power()

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR)
  • rating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)
  • prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here
  • power_factor::Float64:, validation range: (0, 1)
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating, validation range: (0, nothing)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::RenewableNonDispatch) -> String
+

Get RenewableNonDispatch name.

source
PowerSystems.get_active_power — Method
get_active_power(value::RenewableNonDispatch) -> Any
+

Get RenewableNonDispatch active_power.

source
PowerSystems.get_available — Method
get_available(value::RenewableNonDispatch) -> Bool
+

Get RenewableNonDispatch available.

source
PowerSystems.get_base_power — Method
get_base_power(value::RenewableNonDispatch) -> Float64
+

Get RenewableNonDispatch base_power.

source
PowerSystems.get_bus — Method
get_bus(value::RenewableNonDispatch) -> ACBus
+

Get RenewableNonDispatch bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::RenewableNonDispatch
 ) -> Union{Nothing, DynamicInjection}
-

Get RenewableNonDispatch dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::RenewableNonDispatch) -> Dict{String, Any}
-

Get RenewableNonDispatch ext.

source
PowerSystems.get_power_factor — Method
get_power_factor(value::RenewableNonDispatch) -> Float64
-

Get RenewableNonDispatch power_factor.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
+

Get RenewableNonDispatch dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::RenewableNonDispatch) -> Dict{String, Any}
+

Get RenewableNonDispatch ext.

source
PowerSystems.get_power_factor — Method
get_power_factor(value::RenewableNonDispatch) -> Float64
+

Get RenewableNonDispatch power_factor.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
     value::RenewableNonDispatch
 ) -> PrimeMovers
-

Get RenewableNonDispatch prime_mover_type.

source
PowerSystems.get_rating — Method
get_rating(value::RenewableNonDispatch) -> Any
-

Get RenewableNonDispatch rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::RenewableNonDispatch) -> Any
-

Get RenewableNonDispatch reactive_power.

source
PowerSystems.get_services — Method
get_services(value::RenewableNonDispatch) -> Vector{Service}
-

Get RenewableNonDispatch services.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch active_power.

source
PowerSystems.set_available! — Method
set_available!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch ext.

source
PowerSystems.set_power_factor! — Method
set_power_factor!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch power_factor.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(
+

Get RenewableNonDispatch prime_mover_type.

source
PowerSystems.get_rating — Method
get_rating(value::RenewableNonDispatch) -> Any
+

Get RenewableNonDispatch rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::RenewableNonDispatch) -> Any
+

Get RenewableNonDispatch reactive_power.

source
PowerSystems.get_services — Method
get_services(value::RenewableNonDispatch) -> Vector{Service}
+

Get RenewableNonDispatch services.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch active_power.

source
PowerSystems.set_available! — Method
set_available!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch ext.

source
PowerSystems.set_power_factor! — Method
set_power_factor!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch power_factor.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(
     value::RenewableNonDispatch,
     val
 ) -> Any
-

Set RenewableNonDispatch prime_mover_type.

source
PowerSystems.set_rating! — Method
set_rating!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::RenewableNonDispatch, val) -> Any
-

Set RenewableNonDispatch services.

source
+

Set RenewableNonDispatch prime_mover_type.

source
PowerSystems.set_rating! — Method
set_rating!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::RenewableNonDispatch, val) -> Any
+

Set RenewableNonDispatch services.

source
diff --git a/dev/model_library/generated_Shaft/index.html b/dev/model_library/generated_Shaft/index.html index 2884d2c55f..27d0a94dad 100644 --- a/dev/model_library/generated_Shaft/index.html +++ b/dev/model_library/generated_Shaft/index.html @@ -31,47 +31,47 @@ δ_lp: rotor angle of low pressure turbine, ω_lp: rotor speed of low pressure turbine, δ_ex: rotor angle of exciter, -ω_lp: rotor speed of excitersource
PowerSystems.get_D — Method
get_D(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D.

source
PowerSystems.get_D_12 — Method
get_D_12(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D_12.

source
PowerSystems.get_D_23 — Method
get_D_23(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D_23.

source
PowerSystems.get_D_34 — Method
get_D_34(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D_34.

source
PowerSystems.get_D_45 — Method
get_D_45(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D_45.

source
PowerSystems.get_D_ex — Method
get_D_ex(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D_ex.

source
PowerSystems.get_D_hp — Method
get_D_hp(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D_hp.

source
PowerSystems.get_D_ip — Method
get_D_ip(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D_ip.

source
PowerSystems.get_D_lp — Method
get_D_lp(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft D_lp.

source
PowerSystems.get_H — Method
get_H(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft H.

source
PowerSystems.get_H_ex — Method
get_H_ex(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft H_ex.

source
PowerSystems.get_H_hp — Method
get_H_hp(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft H_hp.

source
PowerSystems.get_H_ip — Method
get_H_ip(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft H_ip.

source
PowerSystems.get_H_lp — Method
get_H_lp(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft H_lp.

source
PowerSystems.get_K_ex — Method
get_K_ex(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft K_ex.

source
PowerSystems.get_K_hp — Method
get_K_hp(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft K_hp.

source
PowerSystems.get_K_ip — Method
get_K_ip(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft K_ip.

source
PowerSystems.get_K_lp — Method
get_K_lp(value::FiveMassShaft) -> Float64
-

Get FiveMassShaft K_lp.

source
PowerSystems.get_ext — Method
get_ext(value::FiveMassShaft) -> Dict{String, Any}
-

Get FiveMassShaft ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::FiveMassShaft) -> Int64
-

Get FiveMassShaft n_states.

source
PowerSystems.get_states — Method
get_states(value::FiveMassShaft) -> Vector{Symbol}
-

Get FiveMassShaft states.

source
PowerSystems.set_D! — Method
set_D!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D.

source
PowerSystems.set_D_12! — Method
set_D_12!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D_12.

source
PowerSystems.set_D_23! — Method
set_D_23!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D_23.

source
PowerSystems.set_D_34! — Method
set_D_34!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D_34.

source
PowerSystems.set_D_45! — Method
set_D_45!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D_45.

source
PowerSystems.set_D_ex! — Method
set_D_ex!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D_ex.

source
PowerSystems.set_D_hp! — Method
set_D_hp!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D_hp.

source
PowerSystems.set_D_ip! — Method
set_D_ip!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D_ip.

source
PowerSystems.set_D_lp! — Method
set_D_lp!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft D_lp.

source
PowerSystems.set_H! — Method
set_H!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft H.

source
PowerSystems.set_H_ex! — Method
set_H_ex!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft H_ex.

source
PowerSystems.set_H_hp! — Method
set_H_hp!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft H_hp.

source
PowerSystems.set_H_ip! — Method
set_H_ip!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft H_ip.

source
PowerSystems.set_H_lp! — Method
set_H_lp!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft H_lp.

source
PowerSystems.set_K_ex! — Method
set_K_ex!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft K_ex.

source
PowerSystems.set_K_hp! — Method
set_K_hp!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft K_hp.

source
PowerSystems.set_K_ip! — Method
set_K_ip!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft K_ip.

source
PowerSystems.set_K_lp! — Method
set_K_lp!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft K_lp.

source
PowerSystems.set_ext! — Method
set_ext!(value::FiveMassShaft, val) -> Any
-

Set FiveMassShaft ext.

source

SingleMass

PowerSystems.SingleMass — Type
mutable struct SingleMass <: Shaft
+ω_lp: rotor speed of exciter
  • n_states::Int: (Do not modify.) FiveMassShaft has 10 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_D — Method
get_D(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D.

source
PowerSystems.get_D_12 — Method
get_D_12(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D_12.

source
PowerSystems.get_D_23 — Method
get_D_23(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D_23.

source
PowerSystems.get_D_34 — Method
get_D_34(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D_34.

source
PowerSystems.get_D_45 — Method
get_D_45(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D_45.

source
PowerSystems.get_D_ex — Method
get_D_ex(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D_ex.

source
PowerSystems.get_D_hp — Method
get_D_hp(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D_hp.

source
PowerSystems.get_D_ip — Method
get_D_ip(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D_ip.

source
PowerSystems.get_D_lp — Method
get_D_lp(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft D_lp.

source
PowerSystems.get_H — Method
get_H(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft H.

source
PowerSystems.get_H_ex — Method
get_H_ex(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft H_ex.

source
PowerSystems.get_H_hp — Method
get_H_hp(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft H_hp.

source
PowerSystems.get_H_ip — Method
get_H_ip(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft H_ip.

source
PowerSystems.get_H_lp — Method
get_H_lp(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft H_lp.

source
PowerSystems.get_K_ex — Method
get_K_ex(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft K_ex.

source
PowerSystems.get_K_hp — Method
get_K_hp(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft K_hp.

source
PowerSystems.get_K_ip — Method
get_K_ip(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft K_ip.

source
PowerSystems.get_K_lp — Method
get_K_lp(value::FiveMassShaft) -> Float64
+

Get FiveMassShaft K_lp.

source
PowerSystems.get_ext — Method
get_ext(value::FiveMassShaft) -> Dict{String, Any}
+

Get FiveMassShaft ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::FiveMassShaft) -> Int64
+

Get FiveMassShaft n_states.

source
PowerSystems.get_states — Method
get_states(value::FiveMassShaft) -> Vector{Symbol}
+

Get FiveMassShaft states.

source
PowerSystems.set_D! — Method
set_D!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D.

source
PowerSystems.set_D_12! — Method
set_D_12!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D_12.

source
PowerSystems.set_D_23! — Method
set_D_23!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D_23.

source
PowerSystems.set_D_34! — Method
set_D_34!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D_34.

source
PowerSystems.set_D_45! — Method
set_D_45!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D_45.

source
PowerSystems.set_D_ex! — Method
set_D_ex!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D_ex.

source
PowerSystems.set_D_hp! — Method
set_D_hp!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D_hp.

source
PowerSystems.set_D_ip! — Method
set_D_ip!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D_ip.

source
PowerSystems.set_D_lp! — Method
set_D_lp!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft D_lp.

source
PowerSystems.set_H! — Method
set_H!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft H.

source
PowerSystems.set_H_ex! — Method
set_H_ex!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft H_ex.

source
PowerSystems.set_H_hp! — Method
set_H_hp!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft H_hp.

source
PowerSystems.set_H_ip! — Method
set_H_ip!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft H_ip.

source
PowerSystems.set_H_lp! — Method
set_H_lp!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft H_lp.

source
PowerSystems.set_K_ex! — Method
set_K_ex!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft K_ex.

source
PowerSystems.set_K_hp! — Method
set_K_hp!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft K_hp.

source
PowerSystems.set_K_ip! — Method
set_K_ip!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft K_ip.

source
PowerSystems.set_K_lp! — Method
set_K_lp!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft K_lp.

source
PowerSystems.set_ext! — Method
set_ext!(value::FiveMassShaft, val) -> Any
+

Set FiveMassShaft ext.

source

SingleMass

PowerSystems.SingleMass — Type
mutable struct SingleMass <: Shaft
     H::Float64
     D::Float64
     ext::Dict{String, Any}
@@ -79,12 +79,12 @@
     n_states::Int
     internal::InfrastructureSystemsInternal
 end

Parameters of single mass shaft model. Typically represents the rotor mass

Arguments

  • H::Float64: Rotor inertia constant in MWs/MVA, validation range: (0, nothing)
  • D::Float64: Rotor natural damping in pu, validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states are:
δ: rotor angle,
-ω: rotor speed
  • n_states::Int: (Do not modify.) SingleMass has 1 state
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_D — Method
get_D(value::SingleMass) -> Float64
-

Get SingleMass D.

source
PowerSystems.get_H — Method
get_H(value::SingleMass) -> Float64
-

Get SingleMass H.

source
PowerSystems.get_ext — Method
get_ext(value::SingleMass) -> Dict{String, Any}
-

Get SingleMass ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SingleMass) -> Int64
-

Get SingleMass n_states.

source
PowerSystems.get_states — Method
get_states(value::SingleMass) -> Vector{Symbol}
-

Get SingleMass states.

source
PowerSystems.set_D! — Method
set_D!(value::SingleMass, val) -> Any
-

Set SingleMass D.

source
PowerSystems.set_H! — Method
set_H!(value::SingleMass, val) -> Any
-

Set SingleMass H.

source
PowerSystems.set_ext! — Method
set_ext!(value::SingleMass, val) -> Any
-

Set SingleMass ext.

source
+ω: rotor speedsource
PowerSystems.get_D — Method
get_D(value::SingleMass) -> Float64
+

Get SingleMass D.

source
PowerSystems.get_H — Method
get_H(value::SingleMass) -> Float64
+

Get SingleMass H.

source
PowerSystems.get_ext — Method
get_ext(value::SingleMass) -> Dict{String, Any}
+

Get SingleMass ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SingleMass) -> Int64
+

Get SingleMass n_states.

source
PowerSystems.get_states — Method
get_states(value::SingleMass) -> Vector{Symbol}
+

Get SingleMass states.

source
PowerSystems.set_D! — Method
set_D!(value::SingleMass, val) -> Any
+

Set SingleMass D.

source
PowerSystems.set_H! — Method
set_H!(value::SingleMass, val) -> Any
+

Set SingleMass H.

source
PowerSystems.set_ext! — Method
set_ext!(value::SingleMass, val) -> Any
+

Set SingleMass ext.

source
diff --git a/dev/model_library/generated_Source/index.html b/dev/model_library/generated_Source/index.html index 40a1bf2915..409c19f21f 100644 --- a/dev/model_library/generated_Source/index.html +++ b/dev/model_library/generated_Source/index.html @@ -13,28 +13,28 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

An infinite bus with a constant voltage output.

Commonly used in dynamics simulations to represent a very large machine on a single bus

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::Source) -> String
-

Get Source name.

source
PowerSystems.get_R_th — Method
get_R_th(value::Source) -> Float64
-

Get Source R_th.

source
PowerSystems.get_X_th — Method
get_X_th(value::Source) -> Float64
-

Get Source X_th.

source
PowerSystems.get_active_power — Method
get_active_power(value::Source) -> Float64
-

Get Source active_power.

source
PowerSystems.get_available — Method
get_available(value::Source) -> Bool
-

Get Source available.

source
PowerSystems.get_bus — Method
get_bus(value::Source) -> ACBus
-

Get Source bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

An infinite bus with a constant voltage output.

Commonly used in dynamics simulations to represent a very large machine on a single bus

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR)
  • R_th::Float64: Source Thevenin resistance, validation range: (0, nothing)
  • X_th::Float64: Source Thevenin reactance, validation range: (0, nothing)
  • internal_voltage::Float64: (default: 1.0) Internal Voltage (pu), validation range: (0, nothing)
  • internal_angle::Float64: (default: 0.0) Internal Angle
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::Source) -> String
+

Get Source name.

source
PowerSystems.get_R_th — Method
get_R_th(value::Source) -> Float64
+

Get Source R_th.

source
PowerSystems.get_X_th — Method
get_X_th(value::Source) -> Float64
+

Get Source X_th.

source
PowerSystems.get_active_power — Method
get_active_power(value::Source) -> Float64
+

Get Source active_power.

source
PowerSystems.get_available — Method
get_available(value::Source) -> Bool
+

Get Source available.

source
PowerSystems.get_bus — Method
get_bus(value::Source) -> ACBus
+

Get Source bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::Source
 ) -> Union{Nothing, DynamicInjection}
-

Get Source dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::Source) -> Dict{String, Any}
-

Get Source ext.

source
PowerSystems.get_internal_angle — Method
get_internal_angle(value::Source) -> Float64
-

Get Source internal_angle.

source
PowerSystems.get_internal_voltage — Method
get_internal_voltage(value::Source) -> Float64
-

Get Source internal_voltage.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::Source) -> Float64
-

Get Source reactive_power.

source
PowerSystems.get_services — Method
get_services(value::Source) -> Vector{Service}
-

Get Source services.

source
PowerSystems.set_R_th! — Method
set_R_th!(value::Source, val) -> Any
-

Set Source R_th.

source
PowerSystems.set_X_th! — Method
set_X_th!(value::Source, val) -> Any
-

Set Source X_th.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::Source, val) -> Any
-

Set Source active_power.

source
PowerSystems.set_available! — Method
set_available!(value::Source, val) -> Any
-

Set Source available.

source
PowerSystems.set_bus! — Method
set_bus!(value::Source, val) -> Any
-

Set Source bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::Source, val) -> Any
-

Set Source ext.

source
PowerSystems.set_internal_angle! — Method
set_internal_angle!(value::Source, val) -> Any
-

Set Source internal_angle.

source
PowerSystems.set_internal_voltage! — Method
set_internal_voltage!(value::Source, val) -> Any
-

Set Source internal_voltage.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::Source, val) -> Any
-

Set Source reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::Source, val) -> Any
-

Set Source services.

source
+

Get Source dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::Source) -> Dict{String, Any}
+

Get Source ext.

source
PowerSystems.get_internal_angle — Method
get_internal_angle(value::Source) -> Float64
+

Get Source internal_angle.

source
PowerSystems.get_internal_voltage — Method
get_internal_voltage(value::Source) -> Float64
+

Get Source internal_voltage.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::Source) -> Float64
+

Get Source reactive_power.

source
PowerSystems.get_services — Method
get_services(value::Source) -> Vector{Service}
+

Get Source services.

source
PowerSystems.set_R_th! — Method
set_R_th!(value::Source, val) -> Any
+

Set Source R_th.

source
PowerSystems.set_X_th! — Method
set_X_th!(value::Source, val) -> Any
+

Set Source X_th.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::Source, val) -> Any
+

Set Source active_power.

source
PowerSystems.set_available! — Method
set_available!(value::Source, val) -> Any
+

Set Source available.

source
PowerSystems.set_bus! — Method
set_bus!(value::Source, val) -> Any
+

Set Source bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::Source, val) -> Any
+

Set Source ext.

source
PowerSystems.set_internal_angle! — Method
set_internal_angle!(value::Source, val) -> Any
+

Set Source internal_angle.

source
PowerSystems.set_internal_voltage! — Method
set_internal_voltage!(value::Source, val) -> Any
+

Set Source internal_voltage.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::Source, val) -> Any
+

Set Source reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::Source, val) -> Any
+

Set Source services.

source
diff --git a/dev/model_library/generated_StandardLoad/index.html b/dev/model_library/generated_StandardLoad/index.html index c1a96412a3..fee095d926 100644 --- a/dev/model_library/generated_StandardLoad/index.html +++ b/dev/model_library/generated_StandardLoad/index.html @@ -20,66 +20,66 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A voltage-dependent ZIP load, most commonly used for dynamics modeling.

A StandardLoad breaks the ZIP into three pieces: Z (constant impedance), I (constant current), and P (constant power), according to P = P_P * V^0 + P_I * V^1 + P_Z * V^2 for active power and Q = Q_P * V^0 + Q_I * V^1 + Q_Z * V^2 for reactive power. (Voltage V is in per unit.)

For an alternative exponential formulation of the ZIP model, see ExponentialLoad. For a simpler load model with no voltage dependency, see PowerLoad

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::StandardLoad) -> String
-

Get StandardLoad name.

source
PowerSystems.get_available — Method
get_available(value::StandardLoad) -> Bool
-

Get StandardLoad available.

source
PowerSystems.get_base_power — Method
get_base_power(value::StandardLoad) -> Float64
-

Get StandardLoad base_power.

source
PowerSystems.get_bus — Method
get_bus(value::StandardLoad) -> ACBus
-

Get StandardLoad bus.

source
PowerSystems.get_constant_active_power — Method
get_constant_active_power(value::StandardLoad) -> Any
-

Get StandardLoad constant_active_power.

source
PowerSystems.get_constant_reactive_power — Method
get_constant_reactive_power(value::StandardLoad) -> Any
-

Get StandardLoad constant_reactive_power.

source
PowerSystems.get_current_active_power — Method
get_current_active_power(value::StandardLoad) -> Any
-

Get StandardLoad current_active_power.

source
PowerSystems.get_current_reactive_power — Method
get_current_reactive_power(value::StandardLoad) -> Any
-

Get StandardLoad current_reactive_power.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A voltage-dependent ZIP load, most commonly used for dynamics modeling.

A StandardLoad breaks the ZIP into three pieces: Z (constant impedance), I (constant current), and P (constant power), according to P = P_P * V^0 + P_I * V^1 + P_Z * V^2 for active power and Q = Q_P * V^0 + Q_I * V^1 + Q_Z * V^2 for reactive power. (Voltage V is in per unit.)

For an alternative exponential formulation of the ZIP model, see ExponentialLoad. For a simpler load model with no voltage dependency, see PowerLoad

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • base_power::Float64: Base power of the load (MVA) for per unitization, validation range: (0, nothing)
  • constant_active_power::Float64: (default: 0.0) Constant active power demand in MW (P_P)
  • constant_reactive_power::Float64: (default: 0.0) Constant reactive power demand in MVAR (Q_P)
  • impedance_active_power::Float64: (default: 0.0) Active power coefficient in MW for constant impedance load (P_Z)
  • impedance_reactive_power::Float64: (default: 0.0) Reactive power coefficient in MVAR for constant impedance load (Q_Z)
  • current_active_power::Float64: (default: 0.0) Active power coefficient in MW for constant current load (P_I)
  • current_reactive_power::Float64: (default: 0.0) Reactive power coefficient in MVAR for constant current load (Q_I)
  • max_constant_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant power load
  • max_constant_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant power load
  • max_impedance_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant impedance load
  • max_impedance_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant impedance load
  • max_current_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant current load
  • max_current_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant current load
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::StandardLoad) -> String
+

Get StandardLoad name.

source
PowerSystems.get_available — Method
get_available(value::StandardLoad) -> Bool
+

Get StandardLoad available.

source
PowerSystems.get_base_power — Method
get_base_power(value::StandardLoad) -> Float64
+

Get StandardLoad base_power.

source
PowerSystems.get_bus — Method
get_bus(value::StandardLoad) -> ACBus
+

Get StandardLoad bus.

source
PowerSystems.get_constant_active_power — Method
get_constant_active_power(value::StandardLoad) -> Any
+

Get StandardLoad constant_active_power.

source
PowerSystems.get_constant_reactive_power — Method
get_constant_reactive_power(value::StandardLoad) -> Any
+

Get StandardLoad constant_reactive_power.

source
PowerSystems.get_current_active_power — Method
get_current_active_power(value::StandardLoad) -> Any
+

Get StandardLoad current_active_power.

source
PowerSystems.get_current_reactive_power — Method
get_current_reactive_power(value::StandardLoad) -> Any
+

Get StandardLoad current_reactive_power.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::StandardLoad
 ) -> Union{Nothing, DynamicInjection}
-

Get StandardLoad dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::StandardLoad) -> Dict{String, Any}
-

Get StandardLoad ext.

source
PowerSystems.get_impedance_active_power — Method
get_impedance_active_power(value::StandardLoad) -> Any
-

Get StandardLoad impedance_active_power.

source
PowerSystems.get_impedance_reactive_power — Method
get_impedance_reactive_power(value::StandardLoad) -> Any
-

Get StandardLoad impedance_reactive_power.

source
PowerSystems.get_max_constant_active_power — Method
get_max_constant_active_power(value::StandardLoad) -> Any
-

Get StandardLoad max_constant_active_power.

source
PowerSystems.get_max_constant_reactive_power — Method
get_max_constant_reactive_power(value::StandardLoad) -> Any
-

Get StandardLoad max_constant_reactive_power.

source
PowerSystems.get_max_current_active_power — Method
get_max_current_active_power(value::StandardLoad) -> Any
-

Get StandardLoad max_current_active_power.

source
PowerSystems.get_max_current_reactive_power — Method
get_max_current_reactive_power(value::StandardLoad) -> Any
-

Get StandardLoad max_current_reactive_power.

source
PowerSystems.get_max_impedance_active_power — Method
get_max_impedance_active_power(value::StandardLoad) -> Any
-

Get StandardLoad max_impedance_active_power.

source
PowerSystems.get_max_impedance_reactive_power — Method
get_max_impedance_reactive_power(value::StandardLoad) -> Any
-

Get StandardLoad max_impedance_reactive_power.

source
PowerSystems.get_services — Method
get_services(value::StandardLoad) -> Vector{Service}
-

Get StandardLoad services.

source
PowerSystems.set_available! — Method
set_available!(value::StandardLoad, val) -> Any
-

Set StandardLoad available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::StandardLoad, val) -> Any
-

Set StandardLoad base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::StandardLoad, val) -> Any
-

Set StandardLoad bus.

source
PowerSystems.set_constant_active_power! — Method
set_constant_active_power!(value::StandardLoad, val) -> Any
-

Set StandardLoad constant_active_power.

source
PowerSystems.set_constant_reactive_power! — Method
set_constant_reactive_power!(
+

Get StandardLoad dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::StandardLoad) -> Dict{String, Any}
+

Get StandardLoad ext.

source
PowerSystems.get_impedance_active_power — Method
get_impedance_active_power(value::StandardLoad) -> Any
+

Get StandardLoad impedance_active_power.

source
PowerSystems.get_impedance_reactive_power — Method
get_impedance_reactive_power(value::StandardLoad) -> Any
+

Get StandardLoad impedance_reactive_power.

source
PowerSystems.get_max_constant_active_power — Method
get_max_constant_active_power(value::StandardLoad) -> Any
+

Get StandardLoad max_constant_active_power.

source
PowerSystems.get_max_constant_reactive_power — Method
get_max_constant_reactive_power(value::StandardLoad) -> Any
+

Get StandardLoad max_constant_reactive_power.

source
PowerSystems.get_max_current_active_power — Method
get_max_current_active_power(value::StandardLoad) -> Any
+

Get StandardLoad max_current_active_power.

source
PowerSystems.get_max_current_reactive_power — Method
get_max_current_reactive_power(value::StandardLoad) -> Any
+

Get StandardLoad max_current_reactive_power.

source
PowerSystems.get_max_impedance_active_power — Method
get_max_impedance_active_power(value::StandardLoad) -> Any
+

Get StandardLoad max_impedance_active_power.

source
PowerSystems.get_max_impedance_reactive_power — Method
get_max_impedance_reactive_power(value::StandardLoad) -> Any
+

Get StandardLoad max_impedance_reactive_power.

source
PowerSystems.get_services — Method
get_services(value::StandardLoad) -> Vector{Service}
+

Get StandardLoad services.

source
PowerSystems.set_available! — Method
set_available!(value::StandardLoad, val) -> Any
+

Set StandardLoad available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::StandardLoad, val) -> Any
+

Set StandardLoad base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::StandardLoad, val) -> Any
+

Set StandardLoad bus.

source
PowerSystems.set_constant_active_power! — Method
set_constant_active_power!(value::StandardLoad, val) -> Any
+

Set StandardLoad constant_active_power.

source
PowerSystems.set_constant_reactive_power! — Method
set_constant_reactive_power!(
     value::StandardLoad,
     val
 ) -> Any
-

Set StandardLoad constant_reactive_power.

source
PowerSystems.set_current_active_power! — Method
set_current_active_power!(value::StandardLoad, val) -> Any
-

Set StandardLoad current_active_power.

source
PowerSystems.set_current_reactive_power! — Method
set_current_reactive_power!(value::StandardLoad, val) -> Any
-

Set StandardLoad current_reactive_power.

source
PowerSystems.set_ext! — Method
set_ext!(value::StandardLoad, val) -> Any
-

Set StandardLoad ext.

source
PowerSystems.set_impedance_active_power! — Method
set_impedance_active_power!(value::StandardLoad, val) -> Any
-

Set StandardLoad impedance_active_power.

source
PowerSystems.set_impedance_reactive_power! — Method
set_impedance_reactive_power!(
+

Set StandardLoad constant_reactive_power.

source
PowerSystems.set_current_active_power! — Method
set_current_active_power!(value::StandardLoad, val) -> Any
+

Set StandardLoad current_active_power.

source
PowerSystems.set_current_reactive_power! — Method
set_current_reactive_power!(value::StandardLoad, val) -> Any
+

Set StandardLoad current_reactive_power.

source
PowerSystems.set_ext! — Method
set_ext!(value::StandardLoad, val) -> Any
+

Set StandardLoad ext.

source
PowerSystems.set_impedance_active_power! — Method
set_impedance_active_power!(value::StandardLoad, val) -> Any
+

Set StandardLoad impedance_active_power.

source
PowerSystems.set_impedance_reactive_power! — Method
set_impedance_reactive_power!(
     value::StandardLoad,
     val
 ) -> Any
-

Set StandardLoad impedance_reactive_power.

source
PowerSystems.set_max_constant_active_power! — Method
set_max_constant_active_power!(
+

Set StandardLoad impedance_reactive_power.

source
PowerSystems.set_max_constant_active_power! — Method
set_max_constant_active_power!(
     value::StandardLoad,
     val
 ) -> Any
-

Set StandardLoad max_constant_active_power.

source
PowerSystems.set_max_constant_reactive_power! — Method
set_max_constant_reactive_power!(
+

Set StandardLoad max_constant_active_power.

source
PowerSystems.set_max_constant_reactive_power! — Method
set_max_constant_reactive_power!(
     value::StandardLoad,
     val
 ) -> Any
-

Set StandardLoad max_constant_reactive_power.

source
PowerSystems.set_max_current_active_power! — Method
set_max_current_active_power!(
+

Set StandardLoad max_constant_reactive_power.

source
PowerSystems.set_max_current_active_power! — Method
set_max_current_active_power!(
     value::StandardLoad,
     val
 ) -> Any
-

Set StandardLoad max_current_active_power.

source
PowerSystems.set_max_current_reactive_power! — Method
set_max_current_reactive_power!(
+

Set StandardLoad max_current_active_power.

source
PowerSystems.set_max_current_reactive_power! — Method
set_max_current_reactive_power!(
     value::StandardLoad,
     val
 ) -> Any
-

Set StandardLoad max_current_reactive_power.

source
PowerSystems.set_max_impedance_active_power! — Method
set_max_impedance_active_power!(
+

Set StandardLoad max_current_reactive_power.

source
PowerSystems.set_max_impedance_active_power! — Method
set_max_impedance_active_power!(
     value::StandardLoad,
     val
 ) -> Any
-

Set StandardLoad max_impedance_active_power.

source
PowerSystems.set_max_impedance_reactive_power! — Method
set_max_impedance_reactive_power!(
+

Set StandardLoad max_impedance_active_power.

source
PowerSystems.set_max_impedance_reactive_power! — Method
set_max_impedance_reactive_power!(
     value::StandardLoad,
     val
 ) -> Any
-

Set StandardLoad max_impedance_reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::StandardLoad, val) -> Any
-

Set StandardLoad services.

source
+

Set StandardLoad max_impedance_reactive_power.

source
PowerSystems.set_services! — Method
set_services!(value::StandardLoad, val) -> Any
+

Set StandardLoad services.

source
diff --git a/dev/model_library/generated_SwitchedAdmittance/index.html b/dev/model_library/generated_SwitchedAdmittance/index.html index 9b452067f2..bfc857765c 100644 --- a/dev/model_library/generated_SwitchedAdmittance/index.html +++ b/dev/model_library/generated_SwitchedAdmittance/index.html @@ -10,22 +10,22 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A switched admittance, with discrete steps to adjust the admittance.

Most often used in power flow studies, iterating over the steps to see impacts of admittance on the results. Total admittance is calculated as: Y + number_of_steps * Y_increase

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::SwitchedAdmittance) -> String
-

Get SwitchedAdmittance name.

source
PowerSystems.get_Y — Method
get_Y(value::SwitchedAdmittance) -> ComplexF64
-

Get SwitchedAdmittance Y.

source
PowerSystems.get_Y_increase — Method
get_Y_increase(value::SwitchedAdmittance) -> ComplexF64
-

Get SwitchedAdmittance Y_increase.

source
PowerSystems.get_available — Method
get_available(value::SwitchedAdmittance) -> Bool
-

Get SwitchedAdmittance available.

source
PowerSystems.get_bus — Method
get_bus(value::SwitchedAdmittance) -> ACBus
-

Get SwitchedAdmittance bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A switched admittance, with discrete steps to adjust the admittance.

Most often used in power flow studies, iterating over the steps to see impacts of admittance on the results. Total admittance is calculated as: Y + number_of_steps * Y_increase

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • bus::ACBus: Bus that this component is connected to
  • Y::Complex{Float64}: Initial admittance at N = 0
  • number_of_steps::Int: (default: 0) Number of steps for adjustable shunt
  • Y_increase::Complex{Float64}: (default: 0) Admittance increment for each of step increase
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection model for admittance
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::SwitchedAdmittance) -> String
+

Get SwitchedAdmittance name.

source
PowerSystems.get_Y — Method
get_Y(value::SwitchedAdmittance) -> ComplexF64
+

Get SwitchedAdmittance Y.

source
PowerSystems.get_Y_increase — Method
get_Y_increase(value::SwitchedAdmittance) -> ComplexF64
+

Get SwitchedAdmittance Y_increase.

source
PowerSystems.get_available — Method
get_available(value::SwitchedAdmittance) -> Bool
+

Get SwitchedAdmittance available.

source
PowerSystems.get_bus — Method
get_bus(value::SwitchedAdmittance) -> ACBus
+

Get SwitchedAdmittance bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::SwitchedAdmittance
 ) -> Union{Nothing, DynamicInjection}
-

Get SwitchedAdmittance dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::SwitchedAdmittance) -> Dict{String, Any}
-

Get SwitchedAdmittance ext.

source
PowerSystems.get_number_of_steps — Method
get_number_of_steps(value::SwitchedAdmittance) -> Int64
-

Get SwitchedAdmittance number_of_steps.

source
PowerSystems.get_services — Method
get_services(value::SwitchedAdmittance) -> Vector{Service}
-

Get SwitchedAdmittance services.

source
PowerSystems.set_Y! — Method
set_Y!(value::SwitchedAdmittance, val) -> Any
-

Set SwitchedAdmittance Y.

source
PowerSystems.set_Y_increase! — Method
set_Y_increase!(value::SwitchedAdmittance, val) -> Any
-

Set SwitchedAdmittance Y_increase.

source
PowerSystems.set_available! — Method
set_available!(value::SwitchedAdmittance, val) -> Any
-

Set SwitchedAdmittance available.

source
PowerSystems.set_bus! — Method
set_bus!(value::SwitchedAdmittance, val) -> Any
-

Set SwitchedAdmittance bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::SwitchedAdmittance, val) -> Any
-

Set SwitchedAdmittance ext.

source
PowerSystems.set_number_of_steps! — Method
set_number_of_steps!(value::SwitchedAdmittance, val) -> Any
-

Set SwitchedAdmittance number_of_steps.

source
PowerSystems.set_services! — Method
set_services!(value::SwitchedAdmittance, val) -> Any
-

Set SwitchedAdmittance services.

source
+

Get SwitchedAdmittance dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::SwitchedAdmittance) -> Dict{String, Any}
+

Get SwitchedAdmittance ext.

source
PowerSystems.get_number_of_steps — Method
get_number_of_steps(value::SwitchedAdmittance) -> Int64
+

Get SwitchedAdmittance number_of_steps.

source
PowerSystems.get_services — Method
get_services(value::SwitchedAdmittance) -> Vector{Service}
+

Get SwitchedAdmittance services.

source
PowerSystems.set_Y! — Method
set_Y!(value::SwitchedAdmittance, val) -> Any
+

Set SwitchedAdmittance Y.

source
PowerSystems.set_Y_increase! — Method
set_Y_increase!(value::SwitchedAdmittance, val) -> Any
+

Set SwitchedAdmittance Y_increase.

source
PowerSystems.set_available! — Method
set_available!(value::SwitchedAdmittance, val) -> Any
+

Set SwitchedAdmittance available.

source
PowerSystems.set_bus! — Method
set_bus!(value::SwitchedAdmittance, val) -> Any
+

Set SwitchedAdmittance bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::SwitchedAdmittance, val) -> Any
+

Set SwitchedAdmittance ext.

source
PowerSystems.set_number_of_steps! — Method
set_number_of_steps!(value::SwitchedAdmittance, val) -> Any
+

Set SwitchedAdmittance number_of_steps.

source
PowerSystems.set_services! — Method
set_services!(value::SwitchedAdmittance, val) -> Any
+

Set SwitchedAdmittance services.

source
diff --git a/dev/model_library/generated_TModelHVDCLine/index.html b/dev/model_library/generated_TModelHVDCLine/index.html index db0d3cd31f..f9a05b4235 100644 --- a/dev/model_library/generated_TModelHVDCLine/index.html +++ b/dev/model_library/generated_TModelHVDCLine/index.html @@ -12,35 +12,35 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A High Voltage DC transmission line for modeling DC transmission networks.

This line must be connected to a DCBus on each end. It uses a T-Model of the line impedance. This is suitable for operational simulations with a multi-terminal DC network

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::TModelHVDCLine) -> String
-

Get TModelHVDCLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::TModelHVDCLine) -> Any
-

Get TModelHVDCLine active_power_flow.

source
PowerSystems.get_active_power_limits_from — Method
get_active_power_limits_from(
+end

A High Voltage DC transmission line for modeling DC transmission networks.

This line must be connected to a DCBus on each end. It uses a T-Model of the line impedance. This is suitable for operational simulations with a multi-terminal DC network

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • active_power_flow::Float64: Initial condition of active power flow on the line (MW)
  • arc::Arc: An Arc defining this line from a bus to another bus
  • r::Float64: Total series Resistance in p.u. (SYSTEM_BASE), split equally on both sides of the shunt capacitance
  • l::Float64: Total series Inductance in p.u. (SYSTEM_BASE), split equally on both sides of the shunt capacitance
  • c::Float64: Shunt capacitance in p.u. (SYSTEM_BASE)
  • active_power_limits_from::MinMax: Minimum and maximum active power flows to the FROM node (MW)
  • active_power_limits_to::MinMax: Minimum and maximum active power flows to the TO node (MW)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::TModelHVDCLine) -> String
+

Get TModelHVDCLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::TModelHVDCLine) -> Any
+

Get TModelHVDCLine active_power_flow.

source
PowerSystems.get_active_power_limits_from — Method
get_active_power_limits_from(
     value::TModelHVDCLine
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get TModelHVDCLine active_power_limits_from.

source
PowerSystems.get_active_power_limits_to — Method
get_active_power_limits_to(
+

Get TModelHVDCLine active_power_limits_from.

source
PowerSystems.get_active_power_limits_to — Method
get_active_power_limits_to(
     value::TModelHVDCLine
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get TModelHVDCLine active_power_limits_to.

source
PowerSystems.get_arc — Method
get_arc(value::TModelHVDCLine) -> Arc
-

Get TModelHVDCLine arc.

source
PowerSystems.get_available — Method
get_available(value::TModelHVDCLine) -> Bool
-

Get TModelHVDCLine available.

source
PowerSystems.get_c — Method
get_c(value::TModelHVDCLine) -> Float64
-

Get TModelHVDCLine c.

source
PowerSystems.get_ext — Method
get_ext(value::TModelHVDCLine) -> Dict{String, Any}
-

Get TModelHVDCLine ext.

source
PowerSystems.get_l — Method
get_l(value::TModelHVDCLine) -> Float64
-

Get TModelHVDCLine l.

source
PowerSystems.get_r — Method
get_r(value::TModelHVDCLine) -> Float64
-

Get TModelHVDCLine r.

source
PowerSystems.get_services — Method
get_services(value::TModelHVDCLine) -> Vector{Service}
-

Get TModelHVDCLine services.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::TModelHVDCLine, val) -> Any
-

Set TModelHVDCLine active_power_flow.

source
PowerSystems.set_active_power_limits_from! — Method
set_active_power_limits_from!(
+

Get TModelHVDCLine active_power_limits_to.

source
PowerSystems.get_arc — Method
get_arc(value::TModelHVDCLine) -> Arc
+

Get TModelHVDCLine arc.

source
PowerSystems.get_available — Method
get_available(value::TModelHVDCLine) -> Bool
+

Get TModelHVDCLine available.

source
PowerSystems.get_c — Method
get_c(value::TModelHVDCLine) -> Float64
+

Get TModelHVDCLine c.

source
PowerSystems.get_ext — Method
get_ext(value::TModelHVDCLine) -> Dict{String, Any}
+

Get TModelHVDCLine ext.

source
PowerSystems.get_l — Method
get_l(value::TModelHVDCLine) -> Float64
+

Get TModelHVDCLine l.

source
PowerSystems.get_r — Method
get_r(value::TModelHVDCLine) -> Float64
+

Get TModelHVDCLine r.

source
PowerSystems.get_services — Method
get_services(value::TModelHVDCLine) -> Vector{Service}
+

Get TModelHVDCLine services.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::TModelHVDCLine, val) -> Any
+

Set TModelHVDCLine active_power_flow.

source
PowerSystems.set_active_power_limits_from! — Method
set_active_power_limits_from!(
     value::TModelHVDCLine,
     val
 ) -> Any
-

Set TModelHVDCLine active_power_limits_from.

source
PowerSystems.set_active_power_limits_to! — Method
set_active_power_limits_to!(
+

Set TModelHVDCLine active_power_limits_from.

source
PowerSystems.set_active_power_limits_to! — Method
set_active_power_limits_to!(
     value::TModelHVDCLine,
     val
 ) -> Any
-

Set TModelHVDCLine active_power_limits_to.

source
PowerSystems.set_arc! — Method
set_arc!(value::TModelHVDCLine, val) -> Any
-

Set TModelHVDCLine arc.

source
PowerSystems.set_available! — Method
set_available!(value::TModelHVDCLine, val) -> Any
-

Set TModelHVDCLine available.

source
PowerSystems.set_c! — Method
set_c!(value::TModelHVDCLine, val) -> Any
-

Set TModelHVDCLine c.

source
PowerSystems.set_ext! — Method
set_ext!(value::TModelHVDCLine, val) -> Any
-

Set TModelHVDCLine ext.

source
PowerSystems.set_l! — Method
set_l!(value::TModelHVDCLine, val) -> Any
-

Set TModelHVDCLine l.

source
PowerSystems.set_r! — Method
set_r!(value::TModelHVDCLine, val) -> Any
-

Set TModelHVDCLine r.

source
PowerSystems.set_services! — Method
set_services!(value::TModelHVDCLine, val) -> Any
-

Set TModelHVDCLine services.

source
+

Set TModelHVDCLine active_power_limits_to.

source
PowerSystems.set_arc! — Method
set_arc!(value::TModelHVDCLine, val) -> Any
+

Set TModelHVDCLine arc.

source
PowerSystems.set_available! — Method
set_available!(value::TModelHVDCLine, val) -> Any
+

Set TModelHVDCLine available.

source
PowerSystems.set_c! — Method
set_c!(value::TModelHVDCLine, val) -> Any
+

Set TModelHVDCLine c.

source
PowerSystems.set_ext! — Method
set_ext!(value::TModelHVDCLine, val) -> Any
+

Set TModelHVDCLine ext.

source
PowerSystems.set_l! — Method
set_l!(value::TModelHVDCLine, val) -> Any
+

Set TModelHVDCLine l.

source
PowerSystems.set_r! — Method
set_r!(value::TModelHVDCLine, val) -> Any
+

Set TModelHVDCLine r.

source
PowerSystems.set_services! — Method
set_services!(value::TModelHVDCLine, val) -> Any
+

Set TModelHVDCLine services.

source
diff --git a/dev/model_library/generated_TapTransformer/index.html b/dev/model_library/generated_TapTransformer/index.html index 6e583732b4..85e62b9006 100644 --- a/dev/model_library/generated_TapTransformer/index.html +++ b/dev/model_library/generated_TapTransformer/index.html @@ -13,27 +13,27 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A 2-winding transformer, with a tap changer for variable turns ratio.

The model uses an equivalent circuit assuming the impedance is on the High Voltage Side of the transformer. The model allocates the iron losses and magnetizing susceptance to the primary side

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::TapTransformer) -> String
-

Get TapTransformer name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::TapTransformer) -> Any
-

Get TapTransformer active_power_flow.

source
PowerSystems.get_arc — Method
get_arc(value::TapTransformer) -> Arc
-

Get TapTransformer arc.

source
PowerSystems.get_available — Method
get_available(value::TapTransformer) -> Bool
-

Get TapTransformer available.

source
PowerSystems.get_ext — Method
get_ext(value::TapTransformer) -> Dict{String, Any}
-

Get TapTransformer ext.

source
PowerSystems.get_primary_shunt — Method
get_primary_shunt(value::TapTransformer) -> Float64
-

Get TapTransformer primary_shunt.

source
PowerSystems.get_r — Method
get_r(value::TapTransformer) -> Float64
-

Get TapTransformer r.

source
PowerSystems.get_rating — Method
get_rating(value::TapTransformer) -> Any
-

Get TapTransformer rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(value::TapTransformer) -> Any
-

Get TapTransformer reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(value::TapTransformer) -> Vector{Service}
-

Get TapTransformer services.

source
PowerSystems.get_tap — Method
get_tap(value::TapTransformer) -> Float64
-

Get TapTransformer tap.

source
PowerSystems.get_x — Method
get_x(value::TapTransformer) -> Float64
-

Get TapTransformer x.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::TapTransformer, val) -> Any
-

Set TapTransformer active_power_flow.

source
PowerSystems.set_arc! — Method
set_arc!(value::TapTransformer, val) -> Any
-

Set TapTransformer arc.

source
PowerSystems.set_available! — Method
set_available!(value::TapTransformer, val) -> Any
-

Set TapTransformer available.

source
PowerSystems.set_ext! — Method
set_ext!(value::TapTransformer, val) -> Any
-

Set TapTransformer ext.

source
PowerSystems.set_primary_shunt! — Method
set_primary_shunt!(value::TapTransformer, val) -> Any
-

Set TapTransformer primary_shunt.

source
PowerSystems.set_r! — Method
set_r!(value::TapTransformer, val) -> Any
-

Set TapTransformer r.

source
PowerSystems.set_rating! — Method
set_rating!(value::TapTransformer, val) -> Any
-

Set TapTransformer rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(value::TapTransformer, val) -> Any
-

Set TapTransformer reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::TapTransformer, val) -> Any
-

Set TapTransformer services.

source
PowerSystems.set_tap! — Method
set_tap!(value::TapTransformer, val) -> Any
-

Set TapTransformer tap.

source
PowerSystems.set_x! — Method
set_x!(value::TapTransformer, val) -> Any
-

Set TapTransformer x.

source
+end

A 2-winding transformer, with a tap changer for variable turns ratio.

The model uses an equivalent circuit assuming the impedance is on the High Voltage Side of the transformer. The model allocates the iron losses and magnetizing susceptance to the primary side

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::TapTransformer) -> String
+

Get TapTransformer name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::TapTransformer) -> Any
+

Get TapTransformer active_power_flow.

source
PowerSystems.get_arc — Method
get_arc(value::TapTransformer) -> Arc
+

Get TapTransformer arc.

source
PowerSystems.get_available — Method
get_available(value::TapTransformer) -> Bool
+

Get TapTransformer available.

source
PowerSystems.get_ext — Method
get_ext(value::TapTransformer) -> Dict{String, Any}
+

Get TapTransformer ext.

source
PowerSystems.get_primary_shunt — Method
get_primary_shunt(value::TapTransformer) -> Float64
+

Get TapTransformer primary_shunt.

source
PowerSystems.get_r — Method
get_r(value::TapTransformer) -> Float64
+

Get TapTransformer r.

source
PowerSystems.get_rating — Method
get_rating(value::TapTransformer) -> Any
+

Get TapTransformer rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(value::TapTransformer) -> Any
+

Get TapTransformer reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(value::TapTransformer) -> Vector{Service}
+

Get TapTransformer services.

source
PowerSystems.get_tap — Method
get_tap(value::TapTransformer) -> Float64
+

Get TapTransformer tap.

source
PowerSystems.get_x — Method
get_x(value::TapTransformer) -> Float64
+

Get TapTransformer x.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::TapTransformer, val) -> Any
+

Set TapTransformer active_power_flow.

source
PowerSystems.set_arc! — Method
set_arc!(value::TapTransformer, val) -> Any
+

Set TapTransformer arc.

source
PowerSystems.set_available! — Method
set_available!(value::TapTransformer, val) -> Any
+

Set TapTransformer available.

source
PowerSystems.set_ext! — Method
set_ext!(value::TapTransformer, val) -> Any
+

Set TapTransformer ext.

source
PowerSystems.set_primary_shunt! — Method
set_primary_shunt!(value::TapTransformer, val) -> Any
+

Set TapTransformer primary_shunt.

source
PowerSystems.set_r! — Method
set_r!(value::TapTransformer, val) -> Any
+

Set TapTransformer r.

source
PowerSystems.set_rating! — Method
set_rating!(value::TapTransformer, val) -> Any
+

Set TapTransformer rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(value::TapTransformer, val) -> Any
+

Set TapTransformer reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::TapTransformer, val) -> Any
+

Set TapTransformer services.

source
PowerSystems.set_tap! — Method
set_tap!(value::TapTransformer, val) -> Any
+

Set TapTransformer tap.

source
PowerSystems.set_x! — Method
set_x!(value::TapTransformer, val) -> Any
+

Set TapTransformer x.

source
diff --git a/dev/model_library/generated_ThermalMultiStart/index.html b/dev/model_library/generated_ThermalMultiStart/index.html index 8d53953653..880b12be9f 100644 --- a/dev/model_library/generated_ThermalMultiStart/index.html +++ b/dev/model_library/generated_ThermalMultiStart/index.html @@ -24,72 +24,72 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A thermal generator, such as a fossil fuel or nuclear generator, that can start-up again from a hot, warm, or cold state.

ThermalMultiStart has a detailed representation of the start-up process based on the time elapsed since the last shut down, as well as a detailed shut-down process. The model is based on "Tight and Compact MILP Formulation for the Thermal Unit Commitment Problem.". For a simplified representation of the start-up and shut-down processes, see ThermalStandard

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::ThermalMultiStart) -> String
-

Get ThermalMultiStart name.

source
PowerSystems.get_active_power — Method
get_active_power(value::ThermalMultiStart) -> Any
-

Get ThermalMultiStart active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
+end

A thermal generator, such as a fossil fuel or nuclear generator, that can start-up again from a hot, warm, or cold state.

ThermalMultiStart has a detailed representation of the start-up process based on the time elapsed since the last shut down, as well as a detailed shut-down process. The model is based on "Tight and Compact MILP Formulation for the Thermal Unit Commitment Problem.". For a simplified representation of the start-up and shut-down processes, see ThermalStandard

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • status::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used, validation range: active_power_limits
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits
  • rating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)
  • prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here
  • fuel::ThermalFuels: Prime mover fuel according to EIA 923. Options are listed here
  • active_power_limits::MinMax: Minimum and maximum stable active power levels (MW)
  • reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable
  • ramp_limits::Union{Nothing, UpDown}:, validation range: (0, nothing)
  • power_trajectory::Union{Nothing, StartUpShutDown}: Power trajectory the unit will take during the start-up and shut-down ramp process, validation range: (0, nothing)
  • time_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)
  • start_time_limits::Union{Nothing, StartUpStages}: Time limits for start-up based on turbine temperature in hours
  • start_types::Int: Number of start-up based on turbine temperature, where 1 = hot, 2 = warm, and 3 = cold, validation range: (1, 3)
  • operation_cost::Union{ThermalGenerationCost, MarketBidCost}: OperationalCost of generation
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating, validation range: (0, nothing)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • time_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status
  • must_run::Bool: (default: false) Set to true if the unit is must run
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ThermalMultiStart) -> String
+

Get ThermalMultiStart name.

source
PowerSystems.get_active_power — Method
get_active_power(value::ThermalMultiStart) -> Any
+

Get ThermalMultiStart active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
     value::ThermalMultiStart
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get ThermalMultiStart active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::ThermalMultiStart) -> Bool
-

Get ThermalMultiStart available.

source
PowerSystems.get_base_power — Method
get_base_power(value::ThermalMultiStart) -> Float64
-

Get ThermalMultiStart base_power.

source
PowerSystems.get_bus — Method
get_bus(value::ThermalMultiStart) -> ACBus
-

Get ThermalMultiStart bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+

Get ThermalMultiStart active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::ThermalMultiStart) -> Bool
+

Get ThermalMultiStart available.

source
PowerSystems.get_base_power — Method
get_base_power(value::ThermalMultiStart) -> Float64
+

Get ThermalMultiStart base_power.

source
PowerSystems.get_bus — Method
get_bus(value::ThermalMultiStart) -> ACBus
+

Get ThermalMultiStart bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::ThermalMultiStart
 ) -> Union{Nothing, DynamicInjection}
-

Get ThermalMultiStart dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::ThermalMultiStart) -> Dict{String, Any}
-

Get ThermalMultiStart ext.

source
PowerSystems.get_fuel — Method
get_fuel(value::ThermalMultiStart) -> ThermalFuels
-

Get ThermalMultiStart fuel.

source
PowerSystems.get_must_run — Method
get_must_run(value::ThermalMultiStart) -> Bool
-

Get ThermalMultiStart must_run.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
+

Get ThermalMultiStart dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::ThermalMultiStart) -> Dict{String, Any}
+

Get ThermalMultiStart ext.

source
PowerSystems.get_fuel — Method
get_fuel(value::ThermalMultiStart) -> ThermalFuels
+

Get ThermalMultiStart fuel.

source
PowerSystems.get_must_run — Method
get_must_run(value::ThermalMultiStart) -> Bool
+

Get ThermalMultiStart must_run.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
     value::ThermalMultiStart
 ) -> Union{MarketBidCost, ThermalGenerationCost}
-

Get ThermalMultiStart operation_cost.

source
PowerSystems.get_power_trajectory — Method
get_power_trajectory(
+

Get ThermalMultiStart operation_cost.

source
PowerSystems.get_power_trajectory — Method
get_power_trajectory(
     value::ThermalMultiStart
 ) -> Union{Nothing, NamedTuple{(:startup, :shutdown), <:Tuple{Any, Any}}}
-

Get ThermalMultiStart power_trajectory.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
+

Get ThermalMultiStart power_trajectory.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(
     value::ThermalMultiStart
 ) -> PrimeMovers
-

Get ThermalMultiStart prime_mover_type.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
+

Get ThermalMultiStart prime_mover_type.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
     value::ThermalMultiStart
 ) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}
-

Get ThermalMultiStart ramp_limits.

source
PowerSystems.get_rating — Method
get_rating(value::ThermalMultiStart) -> Any
-

Get ThermalMultiStart rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::ThermalMultiStart) -> Any
-

Get ThermalMultiStart reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
+

Get ThermalMultiStart ramp_limits.

source
PowerSystems.get_rating — Method
get_rating(value::ThermalMultiStart) -> Any
+

Get ThermalMultiStart rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::ThermalMultiStart) -> Any
+

Get ThermalMultiStart reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
     value::ThermalMultiStart
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get ThermalMultiStart reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::ThermalMultiStart) -> Vector{Service}
-

Get ThermalMultiStart services.

source
PowerSystems.get_start_time_limits — Method
get_start_time_limits(
+

Get ThermalMultiStart reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::ThermalMultiStart) -> Vector{Service}
+

Get ThermalMultiStart services.

source
PowerSystems.get_start_time_limits — Method
get_start_time_limits(
     value::ThermalMultiStart
 ) -> Union{Nothing, @NamedTuple{hot::Float64, warm::Float64, cold::Float64}}
-

Get ThermalMultiStart start_time_limits.

source
PowerSystems.get_start_types — Method
get_start_types(value::ThermalMultiStart) -> Int64
-

Get ThermalMultiStart start_types.

source
PowerSystems.get_status — Method
get_status(value::ThermalMultiStart) -> Bool
-

Get ThermalMultiStart status.

source
PowerSystems.get_time_at_status — Method
get_time_at_status(value::ThermalMultiStart) -> Float64
-

Get ThermalMultiStart time_at_status.

source
PowerSystems.get_time_limits — Method
get_time_limits(
+

Get ThermalMultiStart start_time_limits.

source
PowerSystems.get_start_types — Method
get_start_types(value::ThermalMultiStart) -> Int64
+

Get ThermalMultiStart start_types.

source
PowerSystems.get_status — Method
get_status(value::ThermalMultiStart) -> Bool
+

Get ThermalMultiStart status.

source
PowerSystems.get_time_at_status — Method
get_time_at_status(value::ThermalMultiStart) -> Float64
+

Get ThermalMultiStart time_at_status.

source
PowerSystems.get_time_limits — Method
get_time_limits(
     value::ThermalMultiStart
 ) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}
-

Get ThermalMultiStart time_limits.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
+

Get ThermalMultiStart time_limits.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
     value::ThermalMultiStart,
     val
 ) -> Any
-

Set ThermalMultiStart active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart ext.

source
PowerSystems.set_fuel! — Method
set_fuel!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart fuel.

source
PowerSystems.set_must_run! — Method
set_must_run!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart must_run.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart operation_cost.

source
PowerSystems.set_power_trajectory! — Method
set_power_trajectory!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart power_trajectory.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart prime_mover_type.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart ramp_limits.

source
PowerSystems.set_rating! — Method
set_rating!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
+

Set ThermalMultiStart active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart ext.

source
PowerSystems.set_fuel! — Method
set_fuel!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart fuel.

source
PowerSystems.set_must_run! — Method
set_must_run!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart must_run.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart operation_cost.

source
PowerSystems.set_power_trajectory! — Method
set_power_trajectory!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart power_trajectory.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart prime_mover_type.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart ramp_limits.

source
PowerSystems.set_rating! — Method
set_rating!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
     value::ThermalMultiStart,
     val
 ) -> Any
-

Set ThermalMultiStart reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart services.

source
PowerSystems.set_start_time_limits! — Method
set_start_time_limits!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart start_time_limits.

source
PowerSystems.set_start_types! — Method
set_start_types!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart start_types.

source
PowerSystems.set_status! — Method
set_status!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart status.

source
PowerSystems.set_time_at_status! — Method
set_time_at_status!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart time_at_status.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::ThermalMultiStart, val) -> Any
-

Set ThermalMultiStart time_limits.

source
+

Set ThermalMultiStart reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart services.

source
PowerSystems.set_start_time_limits! — Method
set_start_time_limits!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart start_time_limits.

source
PowerSystems.set_start_types! — Method
set_start_types!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart start_types.

source
PowerSystems.set_status! — Method
set_status!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart status.

source
PowerSystems.set_time_at_status! — Method
set_time_at_status!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart time_at_status.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::ThermalMultiStart, val) -> Any
+

Set ThermalMultiStart time_limits.

source
diff --git a/dev/model_library/generated_ThermalStandard/index.html b/dev/model_library/generated_ThermalStandard/index.html index ccb8315e4b..ab3a2c87f2 100644 --- a/dev/model_library/generated_ThermalStandard/index.html +++ b/dev/model_library/generated_ThermalStandard/index.html @@ -21,57 +21,57 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A thermal generator, such as a fossil fuel and nuclear generator.

This is a standard representation with options to include a minimum up time, minimum down time, and ramp limits. For a more detailed representation the start-up and shut-down processes, including hot starts, see ThermalMultiStart

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::ThermalStandard) -> String
-

Get ThermalStandard name.

source
PowerSystems.get_active_power — Method
get_active_power(value::ThermalStandard) -> Any
-

Get ThermalStandard active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
+end

A thermal generator, such as a fossil fuel and nuclear generator.

This is a standard representation with options to include a minimum up time, minimum down time, and ramp limits. For a more detailed representation the start-up and shut-down processes, including hot starts, see ThermalMultiStart

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • status::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used, validation range: active_power_limits
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits
  • rating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)
  • active_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)
  • reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable
  • ramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)
  • operation_cost::Union{ThermalGenerationCost, MarketBidCost}: OperationalCost of generation
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating, validation range: (0, nothing)
  • time_limits::Union{Nothing, UpDown}: (default: nothing) Minimum up and Minimum down time limits in hours, validation range: (0, nothing)
  • must_run::Bool: (default: false) Set to true if the unit is must run
  • prime_mover_type::PrimeMovers: (default: PrimeMovers.OT) Prime mover technology according to EIA 923. Options are listed here
  • fuel::ThermalFuels: (default: ThermalFuels.OTHER) Prime mover fuel according to EIA 923. Options are listed here
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • time_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status
  • dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ThermalStandard) -> String
+

Get ThermalStandard name.

source
PowerSystems.get_active_power — Method
get_active_power(value::ThermalStandard) -> Any
+

Get ThermalStandard active_power.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
     value::ThermalStandard
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get ThermalStandard active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::ThermalStandard) -> Bool
-

Get ThermalStandard available.

source
PowerSystems.get_base_power — Method
get_base_power(value::ThermalStandard) -> Float64
-

Get ThermalStandard base_power.

source
PowerSystems.get_bus — Method
get_bus(value::ThermalStandard) -> ACBus
-

Get ThermalStandard bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+

Get ThermalStandard active_power_limits.

source
PowerSystems.get_available — Method
get_available(value::ThermalStandard) -> Bool
+

Get ThermalStandard available.

source
PowerSystems.get_base_power — Method
get_base_power(value::ThermalStandard) -> Float64
+

Get ThermalStandard base_power.

source
PowerSystems.get_bus — Method
get_bus(value::ThermalStandard) -> ACBus
+

Get ThermalStandard bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::ThermalStandard
 ) -> Union{Nothing, DynamicInjection}
-

Get ThermalStandard dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::ThermalStandard) -> Dict{String, Any}
-

Get ThermalStandard ext.

source
PowerSystems.get_fuel — Method
get_fuel(value::ThermalStandard) -> ThermalFuels
-

Get ThermalStandard fuel.

source
PowerSystems.get_must_run — Method
get_must_run(value::ThermalStandard) -> Bool
-

Get ThermalStandard must_run.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
+

Get ThermalStandard dynamic_injector.

source
PowerSystems.get_ext — Method
get_ext(value::ThermalStandard) -> Dict{String, Any}
+

Get ThermalStandard ext.

source
PowerSystems.get_fuel — Method
get_fuel(value::ThermalStandard) -> ThermalFuels
+

Get ThermalStandard fuel.

source
PowerSystems.get_must_run — Method
get_must_run(value::ThermalStandard) -> Bool
+

Get ThermalStandard must_run.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(
     value::ThermalStandard
 ) -> Union{MarketBidCost, ThermalGenerationCost}
-

Get ThermalStandard operation_cost.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(value::ThermalStandard) -> PrimeMovers
-

Get ThermalStandard prime_mover_type.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
+

Get ThermalStandard operation_cost.

source
PowerSystems.get_prime_mover_type — Method
get_prime_mover_type(value::ThermalStandard) -> PrimeMovers
+

Get ThermalStandard prime_mover_type.

source
PowerSystems.get_ramp_limits — Method
get_ramp_limits(
     value::ThermalStandard
 ) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}
-

Get ThermalStandard ramp_limits.

source
PowerSystems.get_rating — Method
get_rating(value::ThermalStandard) -> Any
-

Get ThermalStandard rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::ThermalStandard) -> Any
-

Get ThermalStandard reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
+

Get ThermalStandard ramp_limits.

source
PowerSystems.get_rating — Method
get_rating(value::ThermalStandard) -> Any
+

Get ThermalStandard rating.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::ThermalStandard) -> Any
+

Get ThermalStandard reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
     value::ThermalStandard
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get ThermalStandard reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::ThermalStandard) -> Vector{Service}
-

Get ThermalStandard services.

source
PowerSystems.get_status — Method
get_status(value::ThermalStandard) -> Bool
-

Get ThermalStandard status.

source
PowerSystems.get_time_at_status — Method
get_time_at_status(value::ThermalStandard) -> Float64
-

Get ThermalStandard time_at_status.

source
PowerSystems.get_time_limits — Method
get_time_limits(
+

Get ThermalStandard reactive_power_limits.

source
PowerSystems.get_services — Method
get_services(value::ThermalStandard) -> Vector{Service}
+

Get ThermalStandard services.

source
PowerSystems.get_status — Method
get_status(value::ThermalStandard) -> Bool
+

Get ThermalStandard status.

source
PowerSystems.get_time_at_status — Method
get_time_at_status(value::ThermalStandard) -> Float64
+

Get ThermalStandard time_at_status.

source
PowerSystems.get_time_limits — Method
get_time_limits(
     value::ThermalStandard
 ) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}
-

Get ThermalStandard time_limits.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard ext.

source
PowerSystems.set_fuel! — Method
set_fuel!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard fuel.

source
PowerSystems.set_must_run! — Method
set_must_run!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard must_run.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard operation_cost.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard prime_mover_type.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard ramp_limits.

source
PowerSystems.set_rating! — Method
set_rating!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
+

Get ThermalStandard time_limits.

source
PowerSystems.set_active_power! — Method
set_active_power!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard active_power.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard active_power_limits.

source
PowerSystems.set_available! — Method
set_available!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard ext.

source
PowerSystems.set_fuel! — Method
set_fuel!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard fuel.

source
PowerSystems.set_must_run! — Method
set_must_run!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard must_run.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard operation_cost.

source
PowerSystems.set_prime_mover_type! — Method
set_prime_mover_type!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard prime_mover_type.

source
PowerSystems.set_ramp_limits! — Method
set_ramp_limits!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard ramp_limits.

source
PowerSystems.set_rating! — Method
set_rating!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard rating.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(
     value::ThermalStandard,
     val
 ) -> Any
-

Set ThermalStandard reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard services.

source
PowerSystems.set_status! — Method
set_status!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard status.

source
PowerSystems.set_time_at_status! — Method
set_time_at_status!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard time_at_status.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::ThermalStandard, val) -> Any
-

Set ThermalStandard time_limits.

source
+

Set ThermalStandard reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard services.

source
PowerSystems.set_status! — Method
set_status!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard status.

source
PowerSystems.set_time_at_status! — Method
set_time_at_status!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard time_at_status.

source
PowerSystems.set_time_limits! — Method
set_time_limits!(value::ThermalStandard, val) -> Any
+

Set ThermalStandard time_limits.

source
diff --git a/dev/model_library/generated_Transformer2W/index.html b/dev/model_library/generated_Transformer2W/index.html index 4e245b4fa4..6256d92c4d 100644 --- a/dev/model_library/generated_Transformer2W/index.html +++ b/dev/model_library/generated_Transformer2W/index.html @@ -12,25 +12,25 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A basic 2-winding transformer.

The model uses an equivalent circuit assuming the impedance is on the High Voltage Side of the transformer. The model allocates the iron losses and magnetizing susceptance to the primary side

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::Transformer2W) -> String
-

Get Transformer2W name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::Transformer2W) -> Any
-

Get Transformer2W active_power_flow.

source
PowerSystems.get_arc — Method
get_arc(value::Transformer2W) -> Arc
-

Get Transformer2W arc.

source
PowerSystems.get_available — Method
get_available(value::Transformer2W) -> Bool
-

Get Transformer2W available.

source
PowerSystems.get_ext — Method
get_ext(value::Transformer2W) -> Dict{String, Any}
-

Get Transformer2W ext.

source
PowerSystems.get_primary_shunt — Method
get_primary_shunt(value::Transformer2W) -> Float64
-

Get Transformer2W primary_shunt.

source
PowerSystems.get_r — Method
get_r(value::Transformer2W) -> Float64
-

Get Transformer2W r.

source
PowerSystems.get_rating — Method
get_rating(value::Transformer2W) -> Any
-

Get Transformer2W rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(value::Transformer2W) -> Any
-

Get Transformer2W reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(value::Transformer2W) -> Vector{Service}
-

Get Transformer2W services.

source
PowerSystems.get_x — Method
get_x(value::Transformer2W) -> Float64
-

Get Transformer2W x.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::Transformer2W, val) -> Any
-

Set Transformer2W active_power_flow.

source
PowerSystems.set_arc! — Method
set_arc!(value::Transformer2W, val) -> Any
-

Set Transformer2W arc.

source
PowerSystems.set_available! — Method
set_available!(value::Transformer2W, val) -> Any
-

Set Transformer2W available.

source
PowerSystems.set_ext! — Method
set_ext!(value::Transformer2W, val) -> Any
-

Set Transformer2W ext.

source
PowerSystems.set_primary_shunt! — Method
set_primary_shunt!(value::Transformer2W, val) -> Any
-

Set Transformer2W primary_shunt.

source
PowerSystems.set_r! — Method
set_r!(value::Transformer2W, val) -> Any
-

Set Transformer2W r.

source
PowerSystems.set_rating! — Method
set_rating!(value::Transformer2W, val) -> Any
-

Set Transformer2W rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(value::Transformer2W, val) -> Any
-

Set Transformer2W reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::Transformer2W, val) -> Any
-

Set Transformer2W services.

source
PowerSystems.set_x! — Method
set_x!(value::Transformer2W, val) -> Any
-

Set Transformer2W x.

source
+end

A basic 2-winding transformer.

The model uses an equivalent circuit assuming the impedance is on the High Voltage Side of the transformer. The model allocates the iron losses and magnetizing susceptance to the primary side

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::Transformer2W) -> String
+

Get Transformer2W name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::Transformer2W) -> Any
+

Get Transformer2W active_power_flow.

source
PowerSystems.get_arc — Method
get_arc(value::Transformer2W) -> Arc
+

Get Transformer2W arc.

source
PowerSystems.get_available — Method
get_available(value::Transformer2W) -> Bool
+

Get Transformer2W available.

source
PowerSystems.get_ext — Method
get_ext(value::Transformer2W) -> Dict{String, Any}
+

Get Transformer2W ext.

source
PowerSystems.get_primary_shunt — Method
get_primary_shunt(value::Transformer2W) -> Float64
+

Get Transformer2W primary_shunt.

source
PowerSystems.get_r — Method
get_r(value::Transformer2W) -> Float64
+

Get Transformer2W r.

source
PowerSystems.get_rating — Method
get_rating(value::Transformer2W) -> Any
+

Get Transformer2W rating.

source
PowerSystems.get_reactive_power_flow — Method
get_reactive_power_flow(value::Transformer2W) -> Any
+

Get Transformer2W reactive_power_flow.

source
PowerSystems.get_services — Method
get_services(value::Transformer2W) -> Vector{Service}
+

Get Transformer2W services.

source
PowerSystems.get_x — Method
get_x(value::Transformer2W) -> Float64
+

Get Transformer2W x.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(value::Transformer2W, val) -> Any
+

Set Transformer2W active_power_flow.

source
PowerSystems.set_arc! — Method
set_arc!(value::Transformer2W, val) -> Any
+

Set Transformer2W arc.

source
PowerSystems.set_available! — Method
set_available!(value::Transformer2W, val) -> Any
+

Set Transformer2W available.

source
PowerSystems.set_ext! — Method
set_ext!(value::Transformer2W, val) -> Any
+

Set Transformer2W ext.

source
PowerSystems.set_primary_shunt! — Method
set_primary_shunt!(value::Transformer2W, val) -> Any
+

Set Transformer2W primary_shunt.

source
PowerSystems.set_r! — Method
set_r!(value::Transformer2W, val) -> Any
+

Set Transformer2W r.

source
PowerSystems.set_rating! — Method
set_rating!(value::Transformer2W, val) -> Any
+

Set Transformer2W rating.

source
PowerSystems.set_reactive_power_flow! — Method
set_reactive_power_flow!(value::Transformer2W, val) -> Any
+

Set Transformer2W reactive_power_flow.

source
PowerSystems.set_services! — Method
set_services!(value::Transformer2W, val) -> Any
+

Set Transformer2W services.

source
PowerSystems.set_x! — Method
set_x!(value::Transformer2W, val) -> Any
+

Set Transformer2W x.

source
diff --git a/dev/model_library/generated_TransmissionInterface/index.html b/dev/model_library/generated_TransmissionInterface/index.html index fbd9a3d78f..83b22e200e 100644 --- a/dev/model_library/generated_TransmissionInterface/index.html +++ b/dev/model_library/generated_TransmissionInterface/index.html @@ -6,28 +6,28 @@ violation_penalty::Float64 direction_mapping::Dict{String, Int} internal::InfrastructureSystemsInternal -end

A collection of branches that make up an interface or corridor for the transfer of power, such as between different Areas or LoadZones.

The interface can be used to constrain the power flow across it

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::TransmissionInterface) -> String
-

Get TransmissionInterface name.

source
PowerSystems.get_active_power_flow_limits — Method
get_active_power_flow_limits(
+end

A collection of branches that make up an interface or corridor for the transfer of power, such as between different Areas or LoadZones.

The interface can be used to constrain the power flow across it

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • active_power_flow_limits::MinMax: Minimum and maximum active power flow limits on the interface (MW)
  • violation_penalty::Float64: (default: INFINITE_COST) Penalty cost for violating the flow limits in the interface
  • direction_mapping::Dict{String, Int}: (default: Dict{String, Int}()) Dictionary of the line names in the interface and their direction of flow (1 or -1) relative to the flow of the interface
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::TransmissionInterface) -> String
+

Get TransmissionInterface name.

source
PowerSystems.get_active_power_flow_limits — Method
get_active_power_flow_limits(
     value::TransmissionInterface
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get TransmissionInterface active_power_flow_limits.

source
PowerSystems.get_available — Method
get_available(value::TransmissionInterface) -> Bool
-

Get TransmissionInterface available.

source
PowerSystems.get_direction_mapping — Method
get_direction_mapping(
+

Get TransmissionInterface active_power_flow_limits.

source
PowerSystems.get_available — Method
get_available(value::TransmissionInterface) -> Bool
+

Get TransmissionInterface available.

source
PowerSystems.get_direction_mapping — Method
get_direction_mapping(
     value::TransmissionInterface
 ) -> Dict{String, Int64}
-

Get TransmissionInterface direction_mapping.

source
PowerSystems.get_violation_penalty — Method
get_violation_penalty(
+

Get TransmissionInterface direction_mapping.

source
PowerSystems.get_violation_penalty — Method
get_violation_penalty(
     value::TransmissionInterface
 ) -> Float64
-

Get TransmissionInterface violation_penalty.

source
PowerSystems.set_active_power_flow_limits! — Method
set_active_power_flow_limits!(
+

Get TransmissionInterface violation_penalty.

source
PowerSystems.set_active_power_flow_limits! — Method
set_active_power_flow_limits!(
     value::TransmissionInterface,
     val
 ) -> Any
-

Set TransmissionInterface active_power_flow_limits.

source
PowerSystems.set_available! — Method
set_available!(value::TransmissionInterface, val) -> Any
-

Set TransmissionInterface available.

source
PowerSystems.set_direction_mapping! — Method
set_direction_mapping!(
+

Set TransmissionInterface active_power_flow_limits.

source
PowerSystems.set_available! — Method
set_available!(value::TransmissionInterface, val) -> Any
+

Set TransmissionInterface available.

source
PowerSystems.set_direction_mapping! — Method
set_direction_mapping!(
     value::TransmissionInterface,
     val
 ) -> Any
-

Set TransmissionInterface direction_mapping.

source
PowerSystems.set_violation_penalty! — Method
set_violation_penalty!(
+

Set TransmissionInterface direction_mapping.

source
PowerSystems.set_violation_penalty! — Method
set_violation_penalty!(
     value::TransmissionInterface,
     val
 ) -> Any
-

Set TransmissionInterface violation_penalty.

source
+

Set TransmissionInterface violation_penalty.

source diff --git a/dev/model_library/generated_TurbineGov/index.html b/dev/model_library/generated_TurbineGov/index.html index 5dcfe28e92..2e7d18dda3 100644 --- a/dev/model_library/generated_TurbineGov/index.html +++ b/dev/model_library/generated_TurbineGov/index.html @@ -18,31 +18,31 @@ x_ecb2: Electric control box 2, x_a1: Actuator 1, x_a2: Actuator 2, -x_a3: Actuator 3,source
PowerSystems.get_K — Method
get_K(value::DEGOV) -> Float64
-

Get DEGOV K.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::DEGOV) -> Float64
-

Get DEGOV P_ref.

source
PowerSystems.get_T1 — Method
get_T1(value::DEGOV) -> Float64
-

Get DEGOV T1.

source
PowerSystems.get_T2 — Method
get_T2(value::DEGOV) -> Float64
-

Get DEGOV T2.

source
PowerSystems.get_T3 — Method
get_T3(value::DEGOV) -> Float64
-

Get DEGOV T3.

source
PowerSystems.get_T4 — Method
get_T4(value::DEGOV) -> Float64
-

Get DEGOV T4.

source
PowerSystems.get_T5 — Method
get_T5(value::DEGOV) -> Float64
-

Get DEGOV T5.

source
PowerSystems.get_T6 — Method
get_T6(value::DEGOV) -> Float64
-

Get DEGOV T6.

source
PowerSystems.get_Td — Method
get_Td(value::DEGOV) -> Float64
-

Get DEGOV Td.

source
PowerSystems.get_ext — Method
get_ext(value::DEGOV) -> Dict{String, Any}
-

Get DEGOV ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::DEGOV) -> Int64
-

Get DEGOV n_states.

source
PowerSystems.get_states — Method
get_states(value::DEGOV) -> Vector{Symbol}
-

Get DEGOV states.

source
PowerSystems.get_states_types — Method
get_states_types(value::DEGOV) -> Vector{StateTypes}
-

Get DEGOV states_types.

source
PowerSystems.set_K! — Method
set_K!(value::DEGOV, val) -> Any
-

Set DEGOV K.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::DEGOV, val) -> Any
-

Set DEGOV P_ref.

source
PowerSystems.set_T1! — Method
set_T1!(value::DEGOV, val) -> Any
-

Set DEGOV T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::DEGOV, val) -> Any
-

Set DEGOV T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::DEGOV, val) -> Any
-

Set DEGOV T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::DEGOV, val) -> Any
-

Set DEGOV T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::DEGOV, val) -> Any
-

Set DEGOV T5.

source
PowerSystems.set_T6! — Method
set_T6!(value::DEGOV, val) -> Any
-

Set DEGOV T6.

source
PowerSystems.set_Td! — Method
set_Td!(value::DEGOV, val) -> Any
-

Set DEGOV Td.

source
PowerSystems.set_ext! — Method
set_ext!(value::DEGOV, val) -> Any
-

Set DEGOV ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::DEGOV, val) -> Any
-

Set DEGOV states_types.

source

GasTG

PowerSystems.GasTG — Type
mutable struct GasTG <: TurbineGov
+x_a3: Actuator 3,
  • n_states::Int: (Do not modify.) DEGOV has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) DEGOV has 5 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K — Method
get_K(value::DEGOV) -> Float64
+

Get DEGOV K.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::DEGOV) -> Float64
+

Get DEGOV P_ref.

source
PowerSystems.get_T1 — Method
get_T1(value::DEGOV) -> Float64
+

Get DEGOV T1.

source
PowerSystems.get_T2 — Method
get_T2(value::DEGOV) -> Float64
+

Get DEGOV T2.

source
PowerSystems.get_T3 — Method
get_T3(value::DEGOV) -> Float64
+

Get DEGOV T3.

source
PowerSystems.get_T4 — Method
get_T4(value::DEGOV) -> Float64
+

Get DEGOV T4.

source
PowerSystems.get_T5 — Method
get_T5(value::DEGOV) -> Float64
+

Get DEGOV T5.

source
PowerSystems.get_T6 — Method
get_T6(value::DEGOV) -> Float64
+

Get DEGOV T6.

source
PowerSystems.get_Td — Method
get_Td(value::DEGOV) -> Float64
+

Get DEGOV Td.

source
PowerSystems.get_ext — Method
get_ext(value::DEGOV) -> Dict{String, Any}
+

Get DEGOV ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::DEGOV) -> Int64
+

Get DEGOV n_states.

source
PowerSystems.get_states — Method
get_states(value::DEGOV) -> Vector{Symbol}
+

Get DEGOV states.

source
PowerSystems.get_states_types — Method
get_states_types(value::DEGOV) -> Vector{StateTypes}
+

Get DEGOV states_types.

source
PowerSystems.set_K! — Method
set_K!(value::DEGOV, val) -> Any
+

Set DEGOV K.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::DEGOV, val) -> Any
+

Set DEGOV P_ref.

source
PowerSystems.set_T1! — Method
set_T1!(value::DEGOV, val) -> Any
+

Set DEGOV T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::DEGOV, val) -> Any
+

Set DEGOV T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::DEGOV, val) -> Any
+

Set DEGOV T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::DEGOV, val) -> Any
+

Set DEGOV T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::DEGOV, val) -> Any
+

Set DEGOV T5.

source
PowerSystems.set_T6! — Method
set_T6!(value::DEGOV, val) -> Any
+

Set DEGOV T6.

source
PowerSystems.set_Td! — Method
set_Td!(value::DEGOV, val) -> Any
+

Set DEGOV Td.

source
PowerSystems.set_ext! — Method
set_ext!(value::DEGOV, val) -> Any
+

Set DEGOV ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::DEGOV, val) -> Any
+

Set DEGOV states_types.

source

GasTG

PowerSystems.GasTG — Type
mutable struct GasTG <: TurbineGov
     R::Float64
     T1::Float64
     T2::Float64
@@ -59,31 +59,31 @@
     internal::InfrastructureSystemsInternal
 end

Parameters of Gas Turbine-Governor. GAST in PSSE and GAST_PTI in PowerWorld

Arguments

  • R::Float64: Speed droop parameter, validation range: (eps(), 0.1)
  • T1::Float64: Governor time constant in s, validation range: (eps(), 0.5)
  • T2::Float64: Combustion chamber time constant, validation range: (eps(), 0.5)
  • T3::Float64: Load limit time constant (exhaust gas measurement time), validation range: (eps(), 5)
  • AT::Float64: Ambient temperature load limit, validation range: (0, 1)
  • Kt::Float64: Load limit feedback gain, validation range: (0, 5)
  • V_lim::Tuple{Float64, Float64}: Operational control limits on fuel valve opening (Vmin, Vmax)
  • D_turb::Float64: Speed damping coefficient of gas turbine rotor, validation range: (0, 0.5)
  • P_ref::Float64: (default: 1.0) Reference Load Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the GAST model are:
x_g1: Fuel valve opening,
 x_g2: Fuel flow,
-x_g3: Exhaust temperature load
  • n_states::Int: (Do not modify.) GasTG has 3 states
  • states_types::Vector{StateTypes}: (Do not modify.) GAST has 3 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_AT — Method
get_AT(value::GasTG) -> Float64
-

Get GasTG AT.

source
PowerSystems.get_D_turb — Method
get_D_turb(value::GasTG) -> Float64
-

Get GasTG D_turb.

source
PowerSystems.get_Kt — Method
get_Kt(value::GasTG) -> Float64
-

Get GasTG Kt.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::GasTG) -> Float64
-

Get GasTG P_ref.

source
PowerSystems.get_R — Method
get_R(value::GasTG) -> Float64
-

Get GasTG R.

source
PowerSystems.get_T1 — Method
get_T1(value::GasTG) -> Float64
-

Get GasTG T1.

source
PowerSystems.get_T2 — Method
get_T2(value::GasTG) -> Float64
-

Get GasTG T2.

source
PowerSystems.get_T3 — Method
get_T3(value::GasTG) -> Float64
-

Get GasTG T3.

source
PowerSystems.get_V_lim — Method
get_V_lim(value::GasTG) -> Tuple{Float64, Float64}
-

Get GasTG V_lim.

source
PowerSystems.get_ext — Method
get_ext(value::GasTG) -> Dict{String, Any}
-

Get GasTG ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::GasTG) -> Int64
-

Get GasTG n_states.

source
PowerSystems.get_states — Method
get_states(value::GasTG) -> Vector{Symbol}
-

Get GasTG states.

source
PowerSystems.get_states_types — Method
get_states_types(value::GasTG) -> Vector{StateTypes}
-

Get GasTG states_types.

source
PowerSystems.set_AT! — Method
set_AT!(value::GasTG, val) -> Any
-

Set GasTG AT.

source
PowerSystems.set_D_turb! — Method
set_D_turb!(value::GasTG, val) -> Any
-

Set GasTG D_turb.

source
PowerSystems.set_Kt! — Method
set_Kt!(value::GasTG, val) -> Any
-

Set GasTG Kt.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::GasTG, val) -> Any
-

Set GasTG P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::GasTG, val) -> Any
-

Set GasTG R.

source
PowerSystems.set_T1! — Method
set_T1!(value::GasTG, val) -> Any
-

Set GasTG T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::GasTG, val) -> Any
-

Set GasTG T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::GasTG, val) -> Any
-

Set GasTG T3.

source
PowerSystems.set_V_lim! — Method
set_V_lim!(value::GasTG, val) -> Any
-

Set GasTG V_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::GasTG, val) -> Any
-

Set GasTG ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::GasTG, val) -> Any
-

Set GasTG states_types.

source

GeneralGovModel

PowerSystems.GeneralGovModel — Type
mutable struct GeneralGovModel <: TurbineGov
+x_g3: Exhaust temperature load
  • n_states::Int: (Do not modify.) GasTG has 3 states
  • states_types::Vector{StateTypes}: (Do not modify.) GAST has 3 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_AT — Method
get_AT(value::GasTG) -> Float64
+

Get GasTG AT.

source
PowerSystems.get_D_turb — Method
get_D_turb(value::GasTG) -> Float64
+

Get GasTG D_turb.

source
PowerSystems.get_Kt — Method
get_Kt(value::GasTG) -> Float64
+

Get GasTG Kt.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::GasTG) -> Float64
+

Get GasTG P_ref.

source
PowerSystems.get_R — Method
get_R(value::GasTG) -> Float64
+

Get GasTG R.

source
PowerSystems.get_T1 — Method
get_T1(value::GasTG) -> Float64
+

Get GasTG T1.

source
PowerSystems.get_T2 — Method
get_T2(value::GasTG) -> Float64
+

Get GasTG T2.

source
PowerSystems.get_T3 — Method
get_T3(value::GasTG) -> Float64
+

Get GasTG T3.

source
PowerSystems.get_V_lim — Method
get_V_lim(value::GasTG) -> Tuple{Float64, Float64}
+

Get GasTG V_lim.

source
PowerSystems.get_ext — Method
get_ext(value::GasTG) -> Dict{String, Any}
+

Get GasTG ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::GasTG) -> Int64
+

Get GasTG n_states.

source
PowerSystems.get_states — Method
get_states(value::GasTG) -> Vector{Symbol}
+

Get GasTG states.

source
PowerSystems.get_states_types — Method
get_states_types(value::GasTG) -> Vector{StateTypes}
+

Get GasTG states_types.

source
PowerSystems.set_AT! — Method
set_AT!(value::GasTG, val) -> Any
+

Set GasTG AT.

source
PowerSystems.set_D_turb! — Method
set_D_turb!(value::GasTG, val) -> Any
+

Set GasTG D_turb.

source
PowerSystems.set_Kt! — Method
set_Kt!(value::GasTG, val) -> Any
+

Set GasTG Kt.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::GasTG, val) -> Any
+

Set GasTG P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::GasTG, val) -> Any
+

Set GasTG R.

source
PowerSystems.set_T1! — Method
set_T1!(value::GasTG, val) -> Any
+

Set GasTG T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::GasTG, val) -> Any
+

Set GasTG T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::GasTG, val) -> Any
+

Set GasTG T3.

source
PowerSystems.set_V_lim! — Method
set_V_lim!(value::GasTG, val) -> Any
+

Set GasTG V_lim.

source
PowerSystems.set_ext! — Method
set_ext!(value::GasTG, val) -> Any
+

Set GasTG ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::GasTG, val) -> Any
+

Set GasTG states_types.

source

GeneralGovModel

PowerSystems.GeneralGovModel — Type
mutable struct GeneralGovModel <: TurbineGov
     Rselect::Int
     fuel_flag::Int
     R::Float64
@@ -131,90 +131,90 @@
 x_g6: Turbine Load Limiter Integral Control, 
 x_g7: Supervisory Load Control, 
 x_g8: Acceleration Control, 
-x_g9 Temperature Detection Lead - Lag:
  • n_states::Int: (Do not modify.) GeneralGovModel has 10 states
  • states_types::Vector{StateTypes}: (Do not modify.) GGOV1 has 10 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_A_set — Method
get_A_set(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel A_set.

source
PowerSystems.get_Dm — Method
get_Dm(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Dm.

source
PowerSystems.get_K_turb — Method
get_K_turb(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel K_turb.

source
PowerSystems.get_Ka — Method
get_Ka(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Ka.

source
PowerSystems.get_Kd_gov — Method
get_Kd_gov(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Kd_gov.

source
PowerSystems.get_Ki_gov — Method
get_Ki_gov(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Ki_gov.

source
PowerSystems.get_Ki_load — Method
get_Ki_load(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Ki_load.

source
PowerSystems.get_Ki_mw — Method
get_Ki_mw(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Ki_mw.

source
PowerSystems.get_Kp_gov — Method
get_Kp_gov(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Kp_gov.

source
PowerSystems.get_Kp_load — Method
get_Kp_load(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Kp_load.

source
PowerSystems.get_Ld_ref — Method
get_Ld_ref(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Ld_ref.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel P_ref.

source
PowerSystems.get_R — Method
get_R(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel R.

source
PowerSystems.get_R_close — Method
get_R_close(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel R_close.

source
PowerSystems.get_R_lim — Method
get_R_lim(
+x_g9 Temperature Detection Lead - Lag:
  • n_states::Int: (Do not modify.) GeneralGovModel has 10 states
  • states_types::Vector{StateTypes}: (Do not modify.) GGOV1 has 10 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_A_set — Method
get_A_set(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel A_set.

source
PowerSystems.get_Dm — Method
get_Dm(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Dm.

source
PowerSystems.get_K_turb — Method
get_K_turb(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel K_turb.

source
PowerSystems.get_Ka — Method
get_Ka(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Ka.

source
PowerSystems.get_Kd_gov — Method
get_Kd_gov(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Kd_gov.

source
PowerSystems.get_Ki_gov — Method
get_Ki_gov(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Ki_gov.

source
PowerSystems.get_Ki_load — Method
get_Ki_load(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Ki_load.

source
PowerSystems.get_Ki_mw — Method
get_Ki_mw(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Ki_mw.

source
PowerSystems.get_Kp_gov — Method
get_Kp_gov(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Kp_gov.

source
PowerSystems.get_Kp_load — Method
get_Kp_load(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Kp_load.

source
PowerSystems.get_Ld_ref — Method
get_Ld_ref(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Ld_ref.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel P_ref.

source
PowerSystems.get_R — Method
get_R(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel R.

source
PowerSystems.get_R_close — Method
get_R_close(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel R_close.

source
PowerSystems.get_R_lim — Method
get_R_lim(
     value::GeneralGovModel
 ) -> @NamedTuple{up::Float64, down::Float64}
-

Get GeneralGovModel R_lim.

source
PowerSystems.get_R_open — Method
get_R_open(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel R_open.

source
PowerSystems.get_Rselect — Method
get_Rselect(value::GeneralGovModel) -> Int64
-

Get GeneralGovModel Rselect.

source
PowerSystems.get_T_act — Method
get_T_act(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel T_act.

source
PowerSystems.get_T_eng — Method
get_T_eng(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel T_eng.

source
PowerSystems.get_T_rate — Method
get_T_rate(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel T_rate.

source
PowerSystems.get_Ta — Method
get_Ta(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Tc.

source
PowerSystems.get_Td_gov — Method
get_Td_gov(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Td_gov.

source
PowerSystems.get_Tf_load — Method
get_Tf_load(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Tf_load.

source
PowerSystems.get_Tpelec — Method
get_Tpelec(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Tpelec.

source
PowerSystems.get_Tsa — Method
get_Tsa(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Tsa.

source
PowerSystems.get_Tsb — Method
get_Tsb(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Tsb.

source
PowerSystems.get_Wf_nl — Method
get_Wf_nl(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel Wf_nl.

source
PowerSystems.get_db — Method
get_db(value::GeneralGovModel) -> Float64
-

Get GeneralGovModel db.

source
PowerSystems.get_ext — Method
get_ext(value::GeneralGovModel) -> Dict{String, Any}
-

Get GeneralGovModel ext.

source
PowerSystems.get_fuel_flag — Method
get_fuel_flag(value::GeneralGovModel) -> Int64
-

Get GeneralGovModel fuel_flag.

source
PowerSystems.get_n_states — Method
get_n_states(value::GeneralGovModel) -> Int64
-

Get GeneralGovModel n_states.

source
PowerSystems.get_speed_error_signal — Method
get_speed_error_signal(
+

Get GeneralGovModel R_lim.

source
PowerSystems.get_R_open — Method
get_R_open(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel R_open.

source
PowerSystems.get_Rselect — Method
get_Rselect(value::GeneralGovModel) -> Int64
+

Get GeneralGovModel Rselect.

source
PowerSystems.get_T_act — Method
get_T_act(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel T_act.

source
PowerSystems.get_T_eng — Method
get_T_eng(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel T_eng.

source
PowerSystems.get_T_rate — Method
get_T_rate(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel T_rate.

source
PowerSystems.get_Ta — Method
get_Ta(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Ta.

source
PowerSystems.get_Tb — Method
get_Tb(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Tb.

source
PowerSystems.get_Tc — Method
get_Tc(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Tc.

source
PowerSystems.get_Td_gov — Method
get_Td_gov(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Td_gov.

source
PowerSystems.get_Tf_load — Method
get_Tf_load(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Tf_load.

source
PowerSystems.get_Tpelec — Method
get_Tpelec(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Tpelec.

source
PowerSystems.get_Tsa — Method
get_Tsa(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Tsa.

source
PowerSystems.get_Tsb — Method
get_Tsb(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Tsb.

source
PowerSystems.get_Wf_nl — Method
get_Wf_nl(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel Wf_nl.

source
PowerSystems.get_db — Method
get_db(value::GeneralGovModel) -> Float64
+

Get GeneralGovModel db.

source
PowerSystems.get_ext — Method
get_ext(value::GeneralGovModel) -> Dict{String, Any}
+

Get GeneralGovModel ext.

source
PowerSystems.get_fuel_flag — Method
get_fuel_flag(value::GeneralGovModel) -> Int64
+

Get GeneralGovModel fuel_flag.

source
PowerSystems.get_n_states — Method
get_n_states(value::GeneralGovModel) -> Int64
+

Get GeneralGovModel n_states.

source
PowerSystems.get_speed_error_signal — Method
get_speed_error_signal(
     value::GeneralGovModel
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get GeneralGovModel speed_error_signal.

source
PowerSystems.get_states — Method
get_states(value::GeneralGovModel) -> Vector{Symbol}
-

Get GeneralGovModel states.

source
PowerSystems.get_states_types — Method
get_states_types(
+

Get GeneralGovModel speed_error_signal.

source
PowerSystems.get_states — Method
get_states(value::GeneralGovModel) -> Vector{Symbol}
+

Get GeneralGovModel states.

source
PowerSystems.get_states_types — Method
get_states_types(
     value::GeneralGovModel
 ) -> Vector{StateTypes}
-

Get GeneralGovModel states_types.

source
PowerSystems.get_valve_position_limits — Method
get_valve_position_limits(
+

Get GeneralGovModel states_types.

source
PowerSystems.get_valve_position_limits — Method
get_valve_position_limits(
     value::GeneralGovModel
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get GeneralGovModel valve_position_limits.

source
PowerSystems.set_A_set! — Method
set_A_set!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel A_set.

source
PowerSystems.set_Dm! — Method
set_Dm!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Dm.

source
PowerSystems.set_K_turb! — Method
set_K_turb!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel K_turb.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Ka.

source
PowerSystems.set_Kd_gov! — Method
set_Kd_gov!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Kd_gov.

source
PowerSystems.set_Ki_gov! — Method
set_Ki_gov!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Ki_gov.

source
PowerSystems.set_Ki_load! — Method
set_Ki_load!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Ki_load.

source
PowerSystems.set_Ki_mw! — Method
set_Ki_mw!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Ki_mw.

source
PowerSystems.set_Kp_gov! — Method
set_Kp_gov!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Kp_gov.

source
PowerSystems.set_Kp_load! — Method
set_Kp_load!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Kp_load.

source
PowerSystems.set_Ld_ref! — Method
set_Ld_ref!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Ld_ref.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel R.

source
PowerSystems.set_R_close! — Method
set_R_close!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel R_close.

source
PowerSystems.set_R_lim! — Method
set_R_lim!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel R_lim.

source
PowerSystems.set_R_open! — Method
set_R_open!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel R_open.

source
PowerSystems.set_Rselect! — Method
set_Rselect!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Rselect.

source
PowerSystems.set_T_act! — Method
set_T_act!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel T_act.

source
PowerSystems.set_T_eng! — Method
set_T_eng!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel T_eng.

source
PowerSystems.set_T_rate! — Method
set_T_rate!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel T_rate.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Tc.

source
PowerSystems.set_Td_gov! — Method
set_Td_gov!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Td_gov.

source
PowerSystems.set_Tf_load! — Method
set_Tf_load!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Tf_load.

source
PowerSystems.set_Tpelec! — Method
set_Tpelec!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Tpelec.

source
PowerSystems.set_Tsa! — Method
set_Tsa!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Tsa.

source
PowerSystems.set_Tsb! — Method
set_Tsb!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Tsb.

source
PowerSystems.set_Wf_nl! — Method
set_Wf_nl!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel Wf_nl.

source
PowerSystems.set_db! — Method
set_db!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel db.

source
PowerSystems.set_ext! — Method
set_ext!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel ext.

source
PowerSystems.set_fuel_flag! — Method
set_fuel_flag!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel fuel_flag.

source
PowerSystems.set_speed_error_signal! — Method
set_speed_error_signal!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel speed_error_signal.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::GeneralGovModel, val) -> Any
-

Set GeneralGovModel states_types.

source
PowerSystems.set_valve_position_limits! — Method
set_valve_position_limits!(
+

Get GeneralGovModel valve_position_limits.

source
PowerSystems.set_A_set! — Method
set_A_set!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel A_set.

source
PowerSystems.set_Dm! — Method
set_Dm!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Dm.

source
PowerSystems.set_K_turb! — Method
set_K_turb!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel K_turb.

source
PowerSystems.set_Ka! — Method
set_Ka!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Ka.

source
PowerSystems.set_Kd_gov! — Method
set_Kd_gov!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Kd_gov.

source
PowerSystems.set_Ki_gov! — Method
set_Ki_gov!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Ki_gov.

source
PowerSystems.set_Ki_load! — Method
set_Ki_load!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Ki_load.

source
PowerSystems.set_Ki_mw! — Method
set_Ki_mw!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Ki_mw.

source
PowerSystems.set_Kp_gov! — Method
set_Kp_gov!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Kp_gov.

source
PowerSystems.set_Kp_load! — Method
set_Kp_load!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Kp_load.

source
PowerSystems.set_Ld_ref! — Method
set_Ld_ref!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Ld_ref.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel R.

source
PowerSystems.set_R_close! — Method
set_R_close!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel R_close.

source
PowerSystems.set_R_lim! — Method
set_R_lim!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel R_lim.

source
PowerSystems.set_R_open! — Method
set_R_open!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel R_open.

source
PowerSystems.set_Rselect! — Method
set_Rselect!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Rselect.

source
PowerSystems.set_T_act! — Method
set_T_act!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel T_act.

source
PowerSystems.set_T_eng! — Method
set_T_eng!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel T_eng.

source
PowerSystems.set_T_rate! — Method
set_T_rate!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel T_rate.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Ta.

source
PowerSystems.set_Tb! — Method
set_Tb!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Tb.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Tc.

source
PowerSystems.set_Td_gov! — Method
set_Td_gov!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Td_gov.

source
PowerSystems.set_Tf_load! — Method
set_Tf_load!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Tf_load.

source
PowerSystems.set_Tpelec! — Method
set_Tpelec!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Tpelec.

source
PowerSystems.set_Tsa! — Method
set_Tsa!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Tsa.

source
PowerSystems.set_Tsb! — Method
set_Tsb!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Tsb.

source
PowerSystems.set_Wf_nl! — Method
set_Wf_nl!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel Wf_nl.

source
PowerSystems.set_db! — Method
set_db!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel db.

source
PowerSystems.set_ext! — Method
set_ext!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel ext.

source
PowerSystems.set_fuel_flag! — Method
set_fuel_flag!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel fuel_flag.

source
PowerSystems.set_speed_error_signal! — Method
set_speed_error_signal!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel speed_error_signal.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::GeneralGovModel, val) -> Any
+

Set GeneralGovModel states_types.

source
PowerSystems.set_valve_position_limits! — Method
set_valve_position_limits!(
     value::GeneralGovModel,
     val
 ) -> Any
-

Set GeneralGovModel valve_position_limits.

source

HydroTurbineGov

PowerSystems.HydroTurbineGov — Type
mutable struct HydroTurbineGov <: TurbineGov
+

Set GeneralGovModel valve_position_limits.

source

HydroTurbineGov

PowerSystems.HydroTurbineGov — Type
mutable struct HydroTurbineGov <: TurbineGov
     R::Float64
     r::Float64
     Tr::Float64
@@ -235,44 +235,44 @@
 end

Hydro Turbine-Governor

Arguments

  • R::Float64: Permanent droop parameter, validation range: (0, 0.1)
  • r::Float64: Temporary Droop, validation range: (0, 2)
  • Tr::Float64: Governor time constant, validation range: (eps(), 30)
  • Tf::Float64: Filter Time constant, validation range: (eps(), 0.1)
  • Tg::Float64: Servo time constant, validation range: (eps(), 1)
  • VELM::Float64: gate velocity limit, validation range: (eps(), 0.3)
  • gate_position_limits::MinMax: Gate position limits
  • Tw::Float64: water time constant, validation range: (eps(), 3)
  • At::Float64: Turbine gain, validation range: (0.8, 1.5)
  • D_T::Float64: Turbine Damping, validation range: (0, 0.5)
  • q_nl::Float64: No-power flow, 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 extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the HydroTurbineGov model are:
x_g1: filter_output,
 x_g2: desired gate, 
 x_g3: gate opening, 
-x_g4: turbine flow
  • n_states::Int: (Do not modify.) HYGOV has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) HYGOV has 4 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_At — Method
get_At(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov At.

source
PowerSystems.get_D_T — Method
get_D_T(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov D_T.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov P_ref.

source
PowerSystems.get_R — Method
get_R(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov R.

source
PowerSystems.get_Tf — Method
get_Tf(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov Tf.

source
PowerSystems.get_Tg — Method
get_Tg(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov Tg.

source
PowerSystems.get_Tr — Method
get_Tr(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov Tr.

source
PowerSystems.get_Tw — Method
get_Tw(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov Tw.

source
PowerSystems.get_VELM — Method
get_VELM(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov VELM.

source
PowerSystems.get_ext — Method
get_ext(value::HydroTurbineGov) -> Dict{String, Any}
-

Get HydroTurbineGov ext.

source
PowerSystems.get_gate_position_limits — Method
get_gate_position_limits(
+x_g4: turbine flow
  • n_states::Int: (Do not modify.) HYGOV has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) HYGOV has 4 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_At — Method
get_At(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov At.

source
PowerSystems.get_D_T — Method
get_D_T(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov D_T.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov P_ref.

source
PowerSystems.get_R — Method
get_R(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov R.

source
PowerSystems.get_Tf — Method
get_Tf(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov Tf.

source
PowerSystems.get_Tg — Method
get_Tg(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov Tg.

source
PowerSystems.get_Tr — Method
get_Tr(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov Tr.

source
PowerSystems.get_Tw — Method
get_Tw(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov Tw.

source
PowerSystems.get_VELM — Method
get_VELM(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov VELM.

source
PowerSystems.get_ext — Method
get_ext(value::HydroTurbineGov) -> Dict{String, Any}
+

Get HydroTurbineGov ext.

source
PowerSystems.get_gate_position_limits — Method
get_gate_position_limits(
     value::HydroTurbineGov
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get HydroTurbineGov gate_position_limits.

source
PowerSystems.get_n_states — Method
get_n_states(value::HydroTurbineGov) -> Int64
-

Get HydroTurbineGov n_states.

source
PowerSystems.get_q_nl — Method
get_q_nl(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov q_nl.

source
PowerSystems.get_r — Method
get_r(value::HydroTurbineGov) -> Float64
-

Get HydroTurbineGov r.

source
PowerSystems.get_states — Method
get_states(value::HydroTurbineGov) -> Vector{Symbol}
-

Get HydroTurbineGov states.

source
PowerSystems.get_states_types — Method
get_states_types(
+

Get HydroTurbineGov gate_position_limits.

source
PowerSystems.get_n_states — Method
get_n_states(value::HydroTurbineGov) -> Int64
+

Get HydroTurbineGov n_states.

source
PowerSystems.get_q_nl — Method
get_q_nl(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov q_nl.

source
PowerSystems.get_r — Method
get_r(value::HydroTurbineGov) -> Float64
+

Get HydroTurbineGov r.

source
PowerSystems.get_states — Method
get_states(value::HydroTurbineGov) -> Vector{Symbol}
+

Get HydroTurbineGov states.

source
PowerSystems.get_states_types — Method
get_states_types(
     value::HydroTurbineGov
 ) -> Vector{StateTypes}
-

Get HydroTurbineGov states_types.

source
PowerSystems.set_At! — Method
set_At!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov At.

source
PowerSystems.set_D_T! — Method
set_D_T!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov D_T.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov R.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov Tf.

source
PowerSystems.set_Tg! — Method
set_Tg!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov Tg.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov Tr.

source
PowerSystems.set_Tw! — Method
set_Tw!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov Tw.

source
PowerSystems.set_VELM! — Method
set_VELM!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov VELM.

source
PowerSystems.set_ext! — Method
set_ext!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov ext.

source
PowerSystems.set_gate_position_limits! — Method
set_gate_position_limits!(
+

Get HydroTurbineGov states_types.

source
PowerSystems.set_At! — Method
set_At!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov At.

source
PowerSystems.set_D_T! — Method
set_D_T!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov D_T.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov R.

source
PowerSystems.set_Tf! — Method
set_Tf!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov Tf.

source
PowerSystems.set_Tg! — Method
set_Tg!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov Tg.

source
PowerSystems.set_Tr! — Method
set_Tr!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov Tr.

source
PowerSystems.set_Tw! — Method
set_Tw!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov Tw.

source
PowerSystems.set_VELM! — Method
set_VELM!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov VELM.

source
PowerSystems.set_ext! — Method
set_ext!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov ext.

source
PowerSystems.set_gate_position_limits! — Method
set_gate_position_limits!(
     value::HydroTurbineGov,
     val
 ) -> Any
-

Set HydroTurbineGov gate_position_limits.

source
PowerSystems.set_q_nl! — Method
set_q_nl!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov q_nl.

source
PowerSystems.set_r! — Method
set_r!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov r.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::HydroTurbineGov, val) -> Any
-

Set HydroTurbineGov states_types.

source

IEEETurbineGov1

PowerSystems.IEEETurbineGov1 — Type
mutable struct IEEETurbineGov1 <: TurbineGov
+

Set HydroTurbineGov gate_position_limits.

source
PowerSystems.set_q_nl! — Method
set_q_nl!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov q_nl.

source
PowerSystems.set_r! — Method
set_r!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov r.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::HydroTurbineGov, val) -> Any
+

Set HydroTurbineGov states_types.

source

IEEETurbineGov1

PowerSystems.IEEETurbineGov1 — Type
mutable struct IEEETurbineGov1 <: TurbineGov
     K::Float64
     T1::Float64
     T2::Float64
@@ -303,60 +303,60 @@
 x_g3: First Turbine integrator, 
 x_g4: Second Turbine Integrator, 
 x_g5: Third Turbine Integrator, 
-x_g6: Fourth Turbine Integrator,
  • n_states::Int: (Do not modify.) IEEEG1 has 6 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEG1 has 6 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K — Method
get_K(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K.

source
PowerSystems.get_K1 — Method
get_K1(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K1.

source
PowerSystems.get_K2 — Method
get_K2(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K2.

source
PowerSystems.get_K3 — Method
get_K3(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K3.

source
PowerSystems.get_K4 — Method
get_K4(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K4.

source
PowerSystems.get_K5 — Method
get_K5(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K5.

source
PowerSystems.get_K6 — Method
get_K6(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K6.

source
PowerSystems.get_K7 — Method
get_K7(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K7.

source
PowerSystems.get_K8 — Method
get_K8(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 K8.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 P_ref.

source
PowerSystems.get_T1 — Method
get_T1(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 T1.

source
PowerSystems.get_T2 — Method
get_T2(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 T2.

source
PowerSystems.get_T3 — Method
get_T3(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 T3.

source
PowerSystems.get_T4 — Method
get_T4(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 T4.

source
PowerSystems.get_T5 — Method
get_T5(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 T5.

source
PowerSystems.get_T6 — Method
get_T6(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 T6.

source
PowerSystems.get_T7 — Method
get_T7(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 T7.

source
PowerSystems.get_U0 — Method
get_U0(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 U0.

source
PowerSystems.get_U_c — Method
get_U_c(value::IEEETurbineGov1) -> Float64
-

Get IEEETurbineGov1 U_c.

source
PowerSystems.get_ext — Method
get_ext(value::IEEETurbineGov1) -> Dict{String, Any}
-

Get IEEETurbineGov1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::IEEETurbineGov1) -> Int64
-

Get IEEETurbineGov1 n_states.

source
PowerSystems.get_states — Method
get_states(value::IEEETurbineGov1) -> Vector{Symbol}
-

Get IEEETurbineGov1 states.

source
PowerSystems.get_states_types — Method
get_states_types(
+x_g6: Fourth Turbine Integrator,
  • n_states::Int: (Do not modify.) IEEEG1 has 6 states
  • states_types::Vector{StateTypes}: (Do not modify.) IEEEG1 has 6 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K — Method
get_K(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K.

source
PowerSystems.get_K1 — Method
get_K1(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K1.

source
PowerSystems.get_K2 — Method
get_K2(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K2.

source
PowerSystems.get_K3 — Method
get_K3(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K3.

source
PowerSystems.get_K4 — Method
get_K4(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K4.

source
PowerSystems.get_K5 — Method
get_K5(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K5.

source
PowerSystems.get_K6 — Method
get_K6(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K6.

source
PowerSystems.get_K7 — Method
get_K7(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K7.

source
PowerSystems.get_K8 — Method
get_K8(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 K8.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 P_ref.

source
PowerSystems.get_T1 — Method
get_T1(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 T1.

source
PowerSystems.get_T2 — Method
get_T2(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 T2.

source
PowerSystems.get_T3 — Method
get_T3(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 T3.

source
PowerSystems.get_T4 — Method
get_T4(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 T4.

source
PowerSystems.get_T5 — Method
get_T5(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 T5.

source
PowerSystems.get_T6 — Method
get_T6(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 T6.

source
PowerSystems.get_T7 — Method
get_T7(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 T7.

source
PowerSystems.get_U0 — Method
get_U0(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 U0.

source
PowerSystems.get_U_c — Method
get_U_c(value::IEEETurbineGov1) -> Float64
+

Get IEEETurbineGov1 U_c.

source
PowerSystems.get_ext — Method
get_ext(value::IEEETurbineGov1) -> Dict{String, Any}
+

Get IEEETurbineGov1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::IEEETurbineGov1) -> Int64
+

Get IEEETurbineGov1 n_states.

source
PowerSystems.get_states — Method
get_states(value::IEEETurbineGov1) -> Vector{Symbol}
+

Get IEEETurbineGov1 states.

source
PowerSystems.get_states_types — Method
get_states_types(
     value::IEEETurbineGov1
 ) -> Vector{StateTypes}
-

Get IEEETurbineGov1 states_types.

source
PowerSystems.get_valve_position_limits — Method
get_valve_position_limits(
+

Get IEEETurbineGov1 states_types.

source
PowerSystems.get_valve_position_limits — Method
get_valve_position_limits(
     value::IEEETurbineGov1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get IEEETurbineGov1 valve_position_limits.

source
PowerSystems.set_K! — Method
set_K!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K.

source
PowerSystems.set_K1! — Method
set_K1!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K1.

source
PowerSystems.set_K2! — Method
set_K2!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K2.

source
PowerSystems.set_K3! — Method
set_K3!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K3.

source
PowerSystems.set_K4! — Method
set_K4!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K4.

source
PowerSystems.set_K5! — Method
set_K5!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K5.

source
PowerSystems.set_K6! — Method
set_K6!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K6.

source
PowerSystems.set_K7! — Method
set_K7!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K7.

source
PowerSystems.set_K8! — Method
set_K8!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 K8.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 P_ref.

source
PowerSystems.set_T1! — Method
set_T1!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 T5.

source
PowerSystems.set_T6! — Method
set_T6!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 T6.

source
PowerSystems.set_T7! — Method
set_T7!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 T7.

source
PowerSystems.set_U0! — Method
set_U0!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 U0.

source
PowerSystems.set_U_c! — Method
set_U_c!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 U_c.

source
PowerSystems.set_ext! — Method
set_ext!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::IEEETurbineGov1, val) -> Any
-

Set IEEETurbineGov1 states_types.

source
PowerSystems.set_valve_position_limits! — Method
set_valve_position_limits!(
+

Get IEEETurbineGov1 valve_position_limits.

source
PowerSystems.set_K! — Method
set_K!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K.

source
PowerSystems.set_K1! — Method
set_K1!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K1.

source
PowerSystems.set_K2! — Method
set_K2!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K2.

source
PowerSystems.set_K3! — Method
set_K3!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K3.

source
PowerSystems.set_K4! — Method
set_K4!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K4.

source
PowerSystems.set_K5! — Method
set_K5!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K5.

source
PowerSystems.set_K6! — Method
set_K6!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K6.

source
PowerSystems.set_K7! — Method
set_K7!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K7.

source
PowerSystems.set_K8! — Method
set_K8!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 K8.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 P_ref.

source
PowerSystems.set_T1! — Method
set_T1!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 T5.

source
PowerSystems.set_T6! — Method
set_T6!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 T6.

source
PowerSystems.set_T7! — Method
set_T7!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 T7.

source
PowerSystems.set_U0! — Method
set_U0!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 U0.

source
PowerSystems.set_U_c! — Method
set_U_c!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 U_c.

source
PowerSystems.set_ext! — Method
set_ext!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::IEEETurbineGov1, val) -> Any
+

Set IEEETurbineGov1 states_types.

source
PowerSystems.set_valve_position_limits! — Method
set_valve_position_limits!(
     value::IEEETurbineGov1,
     val
 ) -> Any
-

Set IEEETurbineGov1 valve_position_limits.

source

SteamTurbineGov1

PowerSystems.SteamTurbineGov1 — Type
mutable struct SteamTurbineGov1 <: TurbineGov
+

Set IEEETurbineGov1 valve_position_limits.

source

SteamTurbineGov1

PowerSystems.SteamTurbineGov1 — Type
mutable struct SteamTurbineGov1 <: TurbineGov
     R::Float64
     T1::Float64
     valve_position_limits::MinMax
@@ -373,55 +373,55 @@
     states_types::Vector{StateTypes}
     internal::InfrastructureSystemsInternal
 end

Steam Turbine-Governor. This model considers both TGOV1 or TGOV1DU in PSS/E

Arguments

  • R::Float64: Droop parameter, validation range: (0, 0.1)
  • T1::Float64: Governor time constant, validation range: (eps(), 0.5)
  • valve_position_limits::MinMax: Valve position limits
  • T2::Float64: Lead Lag Lead Time constant , validation range: (0, nothing)
  • T3::Float64: Lead Lag Lag Time constant , validation range: (eps(), 10)
  • D_T::Float64: Turbine Damping, validation range: (0, 0.5)
  • DB_h::Float64: Deadband for overspeed, validation range: (0, nothing)
  • DB_l::Float64: Deadband for underspeed, validation range: (nothing, 0)
  • T_rate::Float64: Turbine Rate (MW). If zero, generator base is used, 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 extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the SteamTurbineGov1 model are:
x_g1: Valve Opening,
-x_g2: Lead-lag state
  • n_states::Int: (Do not modify.) TGOV1 has 2 states
  • states_types::Vector{StateTypes}: (Do not modify.) TGOV1 has 2 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_DB_h — Method
get_DB_h(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 DB_h.

source
PowerSystems.get_DB_l — Method
get_DB_l(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 DB_l.

source
PowerSystems.get_D_T — Method
get_D_T(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 D_T.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 P_ref.

source
PowerSystems.get_R — Method
get_R(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 R.

source
PowerSystems.get_T1 — Method
get_T1(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 T1.

source
PowerSystems.get_T2 — Method
get_T2(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 T2.

source
PowerSystems.get_T3 — Method
get_T3(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 T3.

source
PowerSystems.get_T_rate — Method
get_T_rate(value::SteamTurbineGov1) -> Float64
-

Get SteamTurbineGov1 T_rate.

source
PowerSystems.get_ext — Method
get_ext(value::SteamTurbineGov1) -> Dict{String, Any}
-

Get SteamTurbineGov1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SteamTurbineGov1) -> Int64
-

Get SteamTurbineGov1 n_states.

source
PowerSystems.get_states — Method
get_states(value::SteamTurbineGov1) -> Vector{Symbol}
-

Get SteamTurbineGov1 states.

source
PowerSystems.get_states_types — Method
get_states_types(
+x_g2: Lead-lag state
  • n_states::Int: (Do not modify.) TGOV1 has 2 states
  • states_types::Vector{StateTypes}: (Do not modify.) TGOV1 has 2 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_DB_h — Method
get_DB_h(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 DB_h.

source
PowerSystems.get_DB_l — Method
get_DB_l(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 DB_l.

source
PowerSystems.get_D_T — Method
get_D_T(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 D_T.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 P_ref.

source
PowerSystems.get_R — Method
get_R(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 R.

source
PowerSystems.get_T1 — Method
get_T1(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 T1.

source
PowerSystems.get_T2 — Method
get_T2(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 T2.

source
PowerSystems.get_T3 — Method
get_T3(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 T3.

source
PowerSystems.get_T_rate — Method
get_T_rate(value::SteamTurbineGov1) -> Float64
+

Get SteamTurbineGov1 T_rate.

source
PowerSystems.get_ext — Method
get_ext(value::SteamTurbineGov1) -> Dict{String, Any}
+

Get SteamTurbineGov1 ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::SteamTurbineGov1) -> Int64
+

Get SteamTurbineGov1 n_states.

source
PowerSystems.get_states — Method
get_states(value::SteamTurbineGov1) -> Vector{Symbol}
+

Get SteamTurbineGov1 states.

source
PowerSystems.get_states_types — Method
get_states_types(
     value::SteamTurbineGov1
 ) -> Vector{StateTypes}
-

Get SteamTurbineGov1 states_types.

source
PowerSystems.get_valve_position_limits — Method
get_valve_position_limits(
+

Get SteamTurbineGov1 states_types.

source
PowerSystems.get_valve_position_limits — Method
get_valve_position_limits(
     value::SteamTurbineGov1
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get SteamTurbineGov1 valve_position_limits.

source
PowerSystems.set_DB_h! — Method
set_DB_h!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 DB_h.

source
PowerSystems.set_DB_l! — Method
set_DB_l!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 DB_l.

source
PowerSystems.set_D_T! — Method
set_D_T!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 D_T.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 R.

source
PowerSystems.set_T1! — Method
set_T1!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 T3.

source
PowerSystems.set_T_rate! — Method
set_T_rate!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 T_rate.

source
PowerSystems.set_ext! — Method
set_ext!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::SteamTurbineGov1, val) -> Any
-

Set SteamTurbineGov1 states_types.

source
PowerSystems.set_valve_position_limits! — Method
set_valve_position_limits!(
+

Get SteamTurbineGov1 valve_position_limits.

source
PowerSystems.set_DB_h! — Method
set_DB_h!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 DB_h.

source
PowerSystems.set_DB_l! — Method
set_DB_l!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 DB_l.

source
PowerSystems.set_D_T! — Method
set_D_T!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 D_T.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 R.

source
PowerSystems.set_T1! — Method
set_T1!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 T2.

source
PowerSystems.set_T3! — Method
set_T3!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 T3.

source
PowerSystems.set_T_rate! — Method
set_T_rate!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 T_rate.

source
PowerSystems.set_ext! — Method
set_ext!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 ext.

source
PowerSystems.set_states_types! — Method
set_states_types!(value::SteamTurbineGov1, val) -> Any
+

Set SteamTurbineGov1 states_types.

source
PowerSystems.set_valve_position_limits! — Method
set_valve_position_limits!(
     value::SteamTurbineGov1,
     val
 ) -> Any
-

Set SteamTurbineGov1 valve_position_limits.

source

TGFixed

PowerSystems.TGFixed — Type
mutable struct TGFixed <: TurbineGov
+

Set SteamTurbineGov1 valve_position_limits.

source

TGFixed

PowerSystems.TGFixed — Type
mutable struct TGFixed <: TurbineGov
     efficiency::Float64
     P_ref::Float64
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
     internal::InfrastructureSystemsInternal
-end

Parameters of a fixed Turbine Governor that returns a fixed mechanical torque given by the product of P_ref*efficiency

Arguments

  • efficiency::Float64: Efficiency factor that multiplies P_ref, 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 extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) TGFixed has no states
  • n_states::Int: (Do not modify.) TGFixed has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_P_ref — Method
get_P_ref(value::TGFixed) -> Float64
-

Get TGFixed P_ref.

source
PowerSystems.get_efficiency — Method
get_efficiency(value::TGFixed) -> Float64
-

Get TGFixed efficiency.

source
PowerSystems.get_ext — Method
get_ext(value::TGFixed) -> Dict{String, Any}
-

Get TGFixed ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::TGFixed) -> Int64
-

Get TGFixed n_states.

source
PowerSystems.get_states — Method
get_states(value::TGFixed) -> Vector{Symbol}
-

Get TGFixed states.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::TGFixed, val) -> Any
-

Set TGFixed P_ref.

source
PowerSystems.set_efficiency! — Method
set_efficiency!(value::TGFixed, val) -> Any
-

Set TGFixed efficiency.

source
PowerSystems.set_ext! — Method
set_ext!(value::TGFixed, val) -> Any
-

Set TGFixed ext.

source

TGTypeI

PowerSystems.TGTypeI — Type
mutable struct TGTypeI <: TurbineGov
+end

Parameters of a fixed Turbine Governor that returns a fixed mechanical torque given by the product of P_ref*efficiency

Arguments

  • efficiency::Float64: Efficiency factor that multiplies P_ref, 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 extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) TGFixed has no states
  • n_states::Int: (Do not modify.) TGFixed has no states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_P_ref — Method
get_P_ref(value::TGFixed) -> Float64
+

Get TGFixed P_ref.

source
PowerSystems.get_efficiency — Method
get_efficiency(value::TGFixed) -> Float64
+

Get TGFixed efficiency.

source
PowerSystems.get_ext — Method
get_ext(value::TGFixed) -> Dict{String, Any}
+

Get TGFixed ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::TGFixed) -> Int64
+

Get TGFixed n_states.

source
PowerSystems.get_states — Method
get_states(value::TGFixed) -> Vector{Symbol}
+

Get TGFixed states.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::TGFixed, val) -> Any
+

Set TGFixed P_ref.

source
PowerSystems.set_efficiency! — Method
set_efficiency!(value::TGFixed, val) -> Any
+

Set TGFixed efficiency.

source
PowerSystems.set_ext! — Method
set_ext!(value::TGFixed, val) -> Any
+

Set TGFixed ext.

source

TGTypeI

PowerSystems.TGTypeI — Type
mutable struct TGTypeI <: TurbineGov
     R::Float64
     Ts::Float64
     Tc::Float64
@@ -436,29 +436,29 @@
     internal::InfrastructureSystemsInternal
 end

Parameters of a Turbine Governor Type I

Arguments

  • R::Float64: Droop parameter, validation range: (0, nothing)
  • Ts::Float64: Governor time constant, validation range: (0, nothing)
  • Tc::Float64: Servo time constant, validation range: (0, nothing)
  • T3::Float64: Transient gain time constant, validation range: (0, nothing)
  • T4::Float64: Power fraction time constant, validation range: (0, nothing)
  • T5::Float64: Reheat time constant, validation range: (0, nothing)
  • valve_position_limits::MinMax: Valve position limits in MW
  • P_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the TGTypeI model are:
x_g1: Governor state,
 x_g2: Servo state,
-x_g3: Reheat state
  • n_states::Int: (Do not modify.) TGTypeI has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_P_ref — Method
get_P_ref(value::TGTypeI) -> Float64
-

Get TGTypeI P_ref.

source
PowerSystems.get_R — Method
get_R(value::TGTypeI) -> Float64
-

Get TGTypeI R.

source
PowerSystems.get_T3 — Method
get_T3(value::TGTypeI) -> Float64
-

Get TGTypeI T3.

source
PowerSystems.get_T4 — Method
get_T4(value::TGTypeI) -> Float64
-

Get TGTypeI T4.

source
PowerSystems.get_T5 — Method
get_T5(value::TGTypeI) -> Float64
-

Get TGTypeI T5.

source
PowerSystems.get_Tc — Method
get_Tc(value::TGTypeI) -> Float64
-

Get TGTypeI Tc.

source
PowerSystems.get_Ts — Method
get_Ts(value::TGTypeI) -> Float64
-

Get TGTypeI Ts.

source
PowerSystems.get_ext — Method
get_ext(value::TGTypeI) -> Dict{String, Any}
-

Get TGTypeI ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::TGTypeI) -> Int64
-

Get TGTypeI n_states.

source
PowerSystems.get_states — Method
get_states(value::TGTypeI) -> Vector{Symbol}
-

Get TGTypeI states.

source
PowerSystems.get_valve_position_limits — Method
get_valve_position_limits(
+x_g3: Reheat state
  • n_states::Int: (Do not modify.) TGTypeI has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_P_ref — Method
get_P_ref(value::TGTypeI) -> Float64
+

Get TGTypeI P_ref.

source
PowerSystems.get_R — Method
get_R(value::TGTypeI) -> Float64
+

Get TGTypeI R.

source
PowerSystems.get_T3 — Method
get_T3(value::TGTypeI) -> Float64
+

Get TGTypeI T3.

source
PowerSystems.get_T4 — Method
get_T4(value::TGTypeI) -> Float64
+

Get TGTypeI T4.

source
PowerSystems.get_T5 — Method
get_T5(value::TGTypeI) -> Float64
+

Get TGTypeI T5.

source
PowerSystems.get_Tc — Method
get_Tc(value::TGTypeI) -> Float64
+

Get TGTypeI Tc.

source
PowerSystems.get_Ts — Method
get_Ts(value::TGTypeI) -> Float64
+

Get TGTypeI Ts.

source
PowerSystems.get_ext — Method
get_ext(value::TGTypeI) -> Dict{String, Any}
+

Get TGTypeI ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::TGTypeI) -> Int64
+

Get TGTypeI n_states.

source
PowerSystems.get_states — Method
get_states(value::TGTypeI) -> Vector{Symbol}
+

Get TGTypeI states.

source
PowerSystems.get_valve_position_limits — Method
get_valve_position_limits(
     value::TGTypeI
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get TGTypeI valve_position_limits.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::TGTypeI, val) -> Any
-

Set TGTypeI P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::TGTypeI, val) -> Any
-

Set TGTypeI R.

source
PowerSystems.set_T3! — Method
set_T3!(value::TGTypeI, val) -> Any
-

Set TGTypeI T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::TGTypeI, val) -> Any
-

Set TGTypeI T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::TGTypeI, val) -> Any
-

Set TGTypeI T5.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::TGTypeI, val) -> Any
-

Set TGTypeI Tc.

source
PowerSystems.set_Ts! — Method
set_Ts!(value::TGTypeI, val) -> Any
-

Set TGTypeI Ts.

source
PowerSystems.set_ext! — Method
set_ext!(value::TGTypeI, val) -> Any
-

Set TGTypeI ext.

source
PowerSystems.set_valve_position_limits! — Method
set_valve_position_limits!(value::TGTypeI, val) -> Any
-

Set TGTypeI valve_position_limits.

source

TGTypeII

PowerSystems.TGTypeII — Type
mutable struct TGTypeII <: TurbineGov
+

Get TGTypeI valve_position_limits.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::TGTypeI, val) -> Any
+

Set TGTypeI P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::TGTypeI, val) -> Any
+

Set TGTypeI R.

source
PowerSystems.set_T3! — Method
set_T3!(value::TGTypeI, val) -> Any
+

Set TGTypeI T3.

source
PowerSystems.set_T4! — Method
set_T4!(value::TGTypeI, val) -> Any
+

Set TGTypeI T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::TGTypeI, val) -> Any
+

Set TGTypeI T5.

source
PowerSystems.set_Tc! — Method
set_Tc!(value::TGTypeI, val) -> Any
+

Set TGTypeI Tc.

source
PowerSystems.set_Ts! — Method
set_Ts!(value::TGTypeI, val) -> Any
+

Set TGTypeI Ts.

source
PowerSystems.set_ext! — Method
set_ext!(value::TGTypeI, val) -> Any
+

Set TGTypeI ext.

source
PowerSystems.set_valve_position_limits! — Method
set_valve_position_limits!(value::TGTypeI, val) -> Any
+

Set TGTypeI valve_position_limits.

source

TGTypeII

PowerSystems.TGTypeII — Type
mutable struct TGTypeII <: TurbineGov
     R::Float64
     T1::Float64
     T2::Float64
@@ -468,20 +468,20 @@
     states::Vector{Symbol}
     n_states::Int
     internal::InfrastructureSystemsInternal
-end

Parameters of a Turbine Governor Type II

Arguments

  • R::Float64: Droop parameter, validation range: (0, nothing)
  • T1::Float64: Transient gain time constant, validation range: (0, nothing)
  • T2::Float64: Power fraction time constant, validation range: (0, nothing)
  • τ_limits::MinMax: Power into the governor limits
  • P_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the TGTypeI model are:
x_g1: lead-lag state
  • n_states::Int: (Do not modify.) TGTypeII has 1 state
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_P_ref — Method
get_P_ref(value::TGTypeII) -> Float64
-

Get TGTypeII P_ref.

source
PowerSystems.get_R — Method
get_R(value::TGTypeII) -> Float64
-

Get TGTypeII R.

source
PowerSystems.get_T1 — Method
get_T1(value::TGTypeII) -> Float64
-

Get TGTypeII T1.

source
PowerSystems.get_T2 — Method
get_T2(value::TGTypeII) -> Float64
-

Get TGTypeII T2.

source
PowerSystems.get_ext — Method
get_ext(value::TGTypeII) -> Dict{String, Any}
-

Get TGTypeII ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::TGTypeII) -> Int64
-

Get TGTypeII n_states.

source
PowerSystems.get_states — Method
get_states(value::TGTypeII) -> Vector{Symbol}
-

Get TGTypeII states.

source
PowerSystems.get_τ_limits — Method
get_τ_limits(
+end

Parameters of a Turbine Governor Type II

Arguments

  • R::Float64: Droop parameter, validation range: (0, nothing)
  • T1::Float64: Transient gain time constant, validation range: (0, nothing)
  • T2::Float64: Power fraction time constant, validation range: (0, nothing)
  • τ_limits::MinMax: Power into the governor limits
  • P_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the TGTypeI model are:
x_g1: lead-lag state
  • n_states::Int: (Do not modify.) TGTypeII has 1 state
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_P_ref — Method
get_P_ref(value::TGTypeII) -> Float64
+

Get TGTypeII P_ref.

source
PowerSystems.get_R — Method
get_R(value::TGTypeII) -> Float64
+

Get TGTypeII R.

source
PowerSystems.get_T1 — Method
get_T1(value::TGTypeII) -> Float64
+

Get TGTypeII T1.

source
PowerSystems.get_T2 — Method
get_T2(value::TGTypeII) -> Float64
+

Get TGTypeII T2.

source
PowerSystems.get_ext — Method
get_ext(value::TGTypeII) -> Dict{String, Any}
+

Get TGTypeII ext.

source
PowerSystems.get_n_states — Method
get_n_states(value::TGTypeII) -> Int64
+

Get TGTypeII n_states.

source
PowerSystems.get_states — Method
get_states(value::TGTypeII) -> Vector{Symbol}
+

Get TGTypeII states.

source
PowerSystems.get_τ_limits — Method
get_τ_limits(
     value::TGTypeII
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get TGTypeII τ_limits.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::TGTypeII, val) -> Any
-

Set TGTypeII P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::TGTypeII, val) -> Any
-

Set TGTypeII R.

source
PowerSystems.set_T1! — Method
set_T1!(value::TGTypeII, val) -> Any
-

Set TGTypeII T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::TGTypeII, val) -> Any
-

Set TGTypeII T2.

source
PowerSystems.set_ext! — Method
set_ext!(value::TGTypeII, val) -> Any
-

Set TGTypeII ext.

source
PowerSystems.set_τ_limits! — Method
set_τ_limits!(value::TGTypeII, val) -> Any
-

Set TGTypeII τ_limits.

source
+

Get TGTypeII τ_limits.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::TGTypeII, val) -> Any
+

Set TGTypeII P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::TGTypeII, val) -> Any
+

Set TGTypeII R.

source
PowerSystems.set_T1! — Method
set_T1!(value::TGTypeII, val) -> Any
+

Set TGTypeII T1.

source
PowerSystems.set_T2! — Method
set_T2!(value::TGTypeII, val) -> Any
+

Set TGTypeII T2.

source
PowerSystems.set_ext! — Method
set_ext!(value::TGTypeII, val) -> Any
+

Set TGTypeII ext.

source
PowerSystems.set_τ_limits! — Method
set_τ_limits!(value::TGTypeII, val) -> Any
+

Set TGTypeII τ_limits.

source
diff --git a/dev/model_library/generated_TwoTerminalHVDCLine/index.html b/dev/model_library/generated_TwoTerminalHVDCLine/index.html index c2581544ee..dce589bc02 100644 --- a/dev/model_library/generated_TwoTerminalHVDCLine/index.html +++ b/dev/model_library/generated_TwoTerminalHVDCLine/index.html @@ -12,50 +12,50 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A High Voltage DC line, which must be connected to an ACBus on each end.

This model is appropriate for operational simulations with a linearized DC power flow approximation with losses proportional to the power flow. For modeling a DC network, see TModelHVDCLine

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::TwoTerminalHVDCLine) -> String
-

Get TwoTerminalHVDCLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::TwoTerminalHVDCLine) -> Any
-

Get TwoTerminalHVDCLine active_power_flow.

source
PowerSystems.get_active_power_limits_from — Method
get_active_power_limits_from(
+end

A High Voltage DC line, which must be connected to an ACBus on each end.

This model is appropriate for operational simulations with a linearized DC power flow approximation with losses proportional to the power flow. For modeling a DC network, see TModelHVDCLine

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • active_power_flow::Float64: Initial condition of active power flow on the line (MW)
  • arc::Arc: An Arc defining this line from a bus to another bus
  • active_power_limits_from::MinMax: Minimum and maximum active power flows to the FROM node (MW)
  • active_power_limits_to::MinMax: Minimum and maximum active power flows to the TO node (MW)
  • reactive_power_limits_from::MinMax: Minimum and maximum reactive power limits to the FROM node (MVAR)
  • reactive_power_limits_to::MinMax: Minimum and maximum reactive power limits to the TO node (MVAR)
  • loss::NamedTuple{(:l0, :l1), Tuple{Float64, Float64}}: Linear loss model coefficients, where l0 = constant loss (MW) and l1 = linearly proportional loss rate (MW of loss per MW of flow)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::TwoTerminalHVDCLine) -> String
+

Get TwoTerminalHVDCLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::TwoTerminalHVDCLine) -> Any
+

Get TwoTerminalHVDCLine active_power_flow.

source
PowerSystems.get_active_power_limits_from — Method
get_active_power_limits_from(
     value::TwoTerminalHVDCLine
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get TwoTerminalHVDCLine active_power_limits_from.

source
PowerSystems.get_active_power_limits_to — Method
get_active_power_limits_to(
+

Get TwoTerminalHVDCLine active_power_limits_from.

source
PowerSystems.get_active_power_limits_to — Method
get_active_power_limits_to(
     value::TwoTerminalHVDCLine
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get TwoTerminalHVDCLine active_power_limits_to.

source
PowerSystems.get_arc — Method
get_arc(value::TwoTerminalHVDCLine) -> Arc
-

Get TwoTerminalHVDCLine arc.

source
PowerSystems.get_available — Method
get_available(value::TwoTerminalHVDCLine) -> Bool
-

Get TwoTerminalHVDCLine available.

source
PowerSystems.get_ext — Method
get_ext(value::TwoTerminalHVDCLine) -> Dict{String, Any}
-

Get TwoTerminalHVDCLine ext.

source
PowerSystems.get_loss — Method
get_loss(
+

Get TwoTerminalHVDCLine active_power_limits_to.

source
PowerSystems.get_arc — Method
get_arc(value::TwoTerminalHVDCLine) -> Arc
+

Get TwoTerminalHVDCLine arc.

source
PowerSystems.get_available — Method
get_available(value::TwoTerminalHVDCLine) -> Bool
+

Get TwoTerminalHVDCLine available.

source
PowerSystems.get_ext — Method
get_ext(value::TwoTerminalHVDCLine) -> Dict{String, Any}
+

Get TwoTerminalHVDCLine ext.

source
PowerSystems.get_loss — Method
get_loss(
     value::TwoTerminalHVDCLine
 ) -> @NamedTuple{l0::Float64, l1::Float64}
-

Get TwoTerminalHVDCLine loss.

source
PowerSystems.get_reactive_power_limits_from — Method
get_reactive_power_limits_from(
+

Get TwoTerminalHVDCLine loss.

source
PowerSystems.get_reactive_power_limits_from — Method
get_reactive_power_limits_from(
     value::TwoTerminalHVDCLine
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get TwoTerminalHVDCLine reactive_power_limits_from.

source
PowerSystems.get_reactive_power_limits_to — Method
get_reactive_power_limits_to(
+

Get TwoTerminalHVDCLine reactive_power_limits_from.

source
PowerSystems.get_reactive_power_limits_to — Method
get_reactive_power_limits_to(
     value::TwoTerminalHVDCLine
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get TwoTerminalHVDCLine reactive_power_limits_to.

source
PowerSystems.get_services — Method
get_services(value::TwoTerminalHVDCLine) -> Vector{Service}
-

Get TwoTerminalHVDCLine services.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(
+

Get TwoTerminalHVDCLine reactive_power_limits_to.

source
PowerSystems.get_services — Method
get_services(value::TwoTerminalHVDCLine) -> Vector{Service}
+

Get TwoTerminalHVDCLine services.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(
     value::TwoTerminalHVDCLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCLine active_power_flow.

source
PowerSystems.set_active_power_limits_from! — Method
set_active_power_limits_from!(
+

Set TwoTerminalHVDCLine active_power_flow.

source
PowerSystems.set_active_power_limits_from! — Method
set_active_power_limits_from!(
     value::TwoTerminalHVDCLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCLine active_power_limits_from.

source
PowerSystems.set_active_power_limits_to! — Method
set_active_power_limits_to!(
+

Set TwoTerminalHVDCLine active_power_limits_from.

source
PowerSystems.set_active_power_limits_to! — Method
set_active_power_limits_to!(
     value::TwoTerminalHVDCLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCLine active_power_limits_to.

source
PowerSystems.set_arc! — Method
set_arc!(value::TwoTerminalHVDCLine, val) -> Any
-

Set TwoTerminalHVDCLine arc.

source
PowerSystems.set_available! — Method
set_available!(value::TwoTerminalHVDCLine, val) -> Any
-

Set TwoTerminalHVDCLine available.

source
PowerSystems.set_ext! — Method
set_ext!(value::TwoTerminalHVDCLine, val) -> Any
-

Set TwoTerminalHVDCLine ext.

source
PowerSystems.set_loss! — Method
set_loss!(value::TwoTerminalHVDCLine, val) -> Any
-

Set TwoTerminalHVDCLine loss.

source
PowerSystems.set_reactive_power_limits_from! — Method
set_reactive_power_limits_from!(
+

Set TwoTerminalHVDCLine active_power_limits_to.

source
PowerSystems.set_arc! — Method
set_arc!(value::TwoTerminalHVDCLine, val) -> Any
+

Set TwoTerminalHVDCLine arc.

source
PowerSystems.set_available! — Method
set_available!(value::TwoTerminalHVDCLine, val) -> Any
+

Set TwoTerminalHVDCLine available.

source
PowerSystems.set_ext! — Method
set_ext!(value::TwoTerminalHVDCLine, val) -> Any
+

Set TwoTerminalHVDCLine ext.

source
PowerSystems.set_loss! — Method
set_loss!(value::TwoTerminalHVDCLine, val) -> Any
+

Set TwoTerminalHVDCLine loss.

source
PowerSystems.set_reactive_power_limits_from! — Method
set_reactive_power_limits_from!(
     value::TwoTerminalHVDCLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCLine reactive_power_limits_from.

source
PowerSystems.set_reactive_power_limits_to! — Method
set_reactive_power_limits_to!(
+

Set TwoTerminalHVDCLine reactive_power_limits_from.

source
PowerSystems.set_reactive_power_limits_to! — Method
set_reactive_power_limits_to!(
     value::TwoTerminalHVDCLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCLine reactive_power_limits_to.

source
PowerSystems.set_services! — Method
set_services!(value::TwoTerminalHVDCLine, val) -> Any
-

Set TwoTerminalHVDCLine services.

source
+

Set TwoTerminalHVDCLine reactive_power_limits_to.

source
PowerSystems.set_services! — Method
set_services!(value::TwoTerminalHVDCLine, val) -> Any
+

Set TwoTerminalHVDCLine services.

source
diff --git a/dev/model_library/generated_TwoTerminalVSCDCLine/index.html b/dev/model_library/generated_TwoTerminalVSCDCLine/index.html index 9ee48f2407..82de497041 100644 --- a/dev/model_library/generated_TwoTerminalVSCDCLine/index.html +++ b/dev/model_library/generated_TwoTerminalVSCDCLine/index.html @@ -13,50 +13,50 @@ services::Vector{Service} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A Voltage Sourced Converter (VSC)-HVDC transmission line.

As implemented in "Power System Modelling and Scripting" by Federico Milano, Chapter 18, Page 397. This model is suitable for dynamic simulations

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::TwoTerminalVSCDCLine) -> String
-

Get TwoTerminalVSCDCLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::TwoTerminalVSCDCLine) -> Any
-

Get TwoTerminalVSCDCLine active_power_flow.

source
PowerSystems.get_arc — Method
get_arc(value::TwoTerminalVSCDCLine) -> Arc
-

Get TwoTerminalVSCDCLine arc.

source
PowerSystems.get_available — Method
get_available(value::TwoTerminalVSCDCLine) -> Bool
-

Get TwoTerminalVSCDCLine available.

source
PowerSystems.get_ext — Method
get_ext(value::TwoTerminalVSCDCLine) -> Dict{String, Any}
-

Get TwoTerminalVSCDCLine ext.

source
PowerSystems.get_inverter_extinction_angle — Method
get_inverter_extinction_angle(
+end

A Voltage Sourced Converter (VSC)-HVDC transmission line.

As implemented in "Power System Modelling and Scripting" by Federico Milano, Chapter 18, Page 397. This model is suitable for dynamic simulations

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • active_power_flow::Float64: Initial condition of active power flow on the line (MW)
  • arc::Arc: An Arc defining this line from a bus to another bus
  • rectifier_tap_limits::MinMax: Minimum and maximum rectifier tap limits as a ratio between the primary and secondary side voltages
  • rectifier_xrc::Float64: Rectifier commutation reactance in p.u. (DEVICE_BASE)
  • rectifier_firing_angle::MinMax: Minimum and maximum rectifier firing angle (α) (radians)
  • inverter_tap_limits::MinMax: Minimum and maximum inverter tap limits as a ratio between the primary and secondary side voltages
  • inverter_xrc::Float64: Inverter commutation reactance in p.u. (DEVICE_BASE)
  • inverter_extinction_angle::MinMax: Minimum and maximum inverter extinction angle (γ) (radians)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::TwoTerminalVSCDCLine) -> String
+

Get TwoTerminalVSCDCLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(value::TwoTerminalVSCDCLine) -> Any
+

Get TwoTerminalVSCDCLine active_power_flow.

source
PowerSystems.get_arc — Method
get_arc(value::TwoTerminalVSCDCLine) -> Arc
+

Get TwoTerminalVSCDCLine arc.

source
PowerSystems.get_available — Method
get_available(value::TwoTerminalVSCDCLine) -> Bool
+

Get TwoTerminalVSCDCLine available.

source
PowerSystems.get_ext — Method
get_ext(value::TwoTerminalVSCDCLine) -> Dict{String, Any}
+

Get TwoTerminalVSCDCLine ext.

source
PowerSystems.get_inverter_extinction_angle — Method
get_inverter_extinction_angle(
     value::TwoTerminalVSCDCLine
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get TwoTerminalVSCDCLine inverter_extinction_angle.

source
PowerSystems.get_inverter_tap_limits — Method
get_inverter_tap_limits(
+

Get TwoTerminalVSCDCLine inverter_extinction_angle.

source
PowerSystems.get_inverter_tap_limits — Method
get_inverter_tap_limits(
     value::TwoTerminalVSCDCLine
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get TwoTerminalVSCDCLine inverter_tap_limits.

source
PowerSystems.get_inverter_xrc — Method
get_inverter_xrc(value::TwoTerminalVSCDCLine) -> Float64
-

Get TwoTerminalVSCDCLine inverter_xrc.

source
PowerSystems.get_rectifier_firing_angle — Method
get_rectifier_firing_angle(
+

Get TwoTerminalVSCDCLine inverter_tap_limits.

source
PowerSystems.get_inverter_xrc — Method
get_inverter_xrc(value::TwoTerminalVSCDCLine) -> Float64
+

Get TwoTerminalVSCDCLine inverter_xrc.

source
PowerSystems.get_rectifier_firing_angle — Method
get_rectifier_firing_angle(
     value::TwoTerminalVSCDCLine
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get TwoTerminalVSCDCLine rectifier_firing_angle.

source
PowerSystems.get_rectifier_tap_limits — Method
get_rectifier_tap_limits(
+

Get TwoTerminalVSCDCLine rectifier_firing_angle.

source
PowerSystems.get_rectifier_tap_limits — Method
get_rectifier_tap_limits(
     value::TwoTerminalVSCDCLine
 ) -> @NamedTuple{min::Float64, max::Float64}
-

Get TwoTerminalVSCDCLine rectifier_tap_limits.

source
PowerSystems.get_rectifier_xrc — Method
get_rectifier_xrc(value::TwoTerminalVSCDCLine) -> Float64
-

Get TwoTerminalVSCDCLine rectifier_xrc.

source
PowerSystems.get_services — Method
get_services(value::TwoTerminalVSCDCLine) -> Vector{Service}
-

Get TwoTerminalVSCDCLine services.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(
+

Get TwoTerminalVSCDCLine rectifier_tap_limits.

source
PowerSystems.get_rectifier_xrc — Method
get_rectifier_xrc(value::TwoTerminalVSCDCLine) -> Float64
+

Get TwoTerminalVSCDCLine rectifier_xrc.

source
PowerSystems.get_services — Method
get_services(value::TwoTerminalVSCDCLine) -> Vector{Service}
+

Get TwoTerminalVSCDCLine services.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(
     value::TwoTerminalVSCDCLine,
     val
 ) -> Any
-

Set TwoTerminalVSCDCLine active_power_flow.

source
PowerSystems.set_arc! — Method
set_arc!(value::TwoTerminalVSCDCLine, val) -> Any
-

Set TwoTerminalVSCDCLine arc.

source
PowerSystems.set_available! — Method
set_available!(value::TwoTerminalVSCDCLine, val) -> Any
-

Set TwoTerminalVSCDCLine available.

source
PowerSystems.set_ext! — Method
set_ext!(value::TwoTerminalVSCDCLine, val) -> Any
-

Set TwoTerminalVSCDCLine ext.

source
PowerSystems.set_inverter_extinction_angle! — Method
set_inverter_extinction_angle!(
+

Set TwoTerminalVSCDCLine active_power_flow.

source
PowerSystems.set_arc! — Method
set_arc!(value::TwoTerminalVSCDCLine, val) -> Any
+

Set TwoTerminalVSCDCLine arc.

source
PowerSystems.set_available! — Method
set_available!(value::TwoTerminalVSCDCLine, val) -> Any
+

Set TwoTerminalVSCDCLine available.

source
PowerSystems.set_ext! — Method
set_ext!(value::TwoTerminalVSCDCLine, val) -> Any
+

Set TwoTerminalVSCDCLine ext.

source
PowerSystems.set_inverter_extinction_angle! — Method
set_inverter_extinction_angle!(
     value::TwoTerminalVSCDCLine,
     val
 ) -> Any
-

Set TwoTerminalVSCDCLine inverter_extinction_angle.

source
PowerSystems.set_inverter_tap_limits! — Method
set_inverter_tap_limits!(
+

Set TwoTerminalVSCDCLine inverter_extinction_angle.

source
PowerSystems.set_inverter_tap_limits! — Method
set_inverter_tap_limits!(
     value::TwoTerminalVSCDCLine,
     val
 ) -> Any
-

Set TwoTerminalVSCDCLine inverter_tap_limits.

source
PowerSystems.set_inverter_xrc! — Method
set_inverter_xrc!(value::TwoTerminalVSCDCLine, val) -> Any
-

Set TwoTerminalVSCDCLine inverter_xrc.

source
PowerSystems.set_rectifier_firing_angle! — Method
set_rectifier_firing_angle!(
+

Set TwoTerminalVSCDCLine inverter_tap_limits.

source
PowerSystems.set_inverter_xrc! — Method
set_inverter_xrc!(value::TwoTerminalVSCDCLine, val) -> Any
+

Set TwoTerminalVSCDCLine inverter_xrc.

source
PowerSystems.set_rectifier_firing_angle! — Method
set_rectifier_firing_angle!(
     value::TwoTerminalVSCDCLine,
     val
 ) -> Any
-

Set TwoTerminalVSCDCLine rectifier_firing_angle.

source
PowerSystems.set_rectifier_tap_limits! — Method
set_rectifier_tap_limits!(
+

Set TwoTerminalVSCDCLine rectifier_firing_angle.

source
PowerSystems.set_rectifier_tap_limits! — Method
set_rectifier_tap_limits!(
     value::TwoTerminalVSCDCLine,
     val
 ) -> Any
-

Set TwoTerminalVSCDCLine rectifier_tap_limits.

source
PowerSystems.set_rectifier_xrc! — Method
set_rectifier_xrc!(value::TwoTerminalVSCDCLine, val) -> Any
-

Set TwoTerminalVSCDCLine rectifier_xrc.

source
PowerSystems.set_services! — Method
set_services!(value::TwoTerminalVSCDCLine, val) -> Any
-

Set TwoTerminalVSCDCLine services.

source
+

Set TwoTerminalVSCDCLine rectifier_tap_limits.

source
PowerSystems.set_rectifier_xrc! — Method
set_rectifier_xrc!(value::TwoTerminalVSCDCLine, val) -> Any
+

Set TwoTerminalVSCDCLine rectifier_xrc.

source
PowerSystems.set_services! — Method
set_services!(value::TwoTerminalVSCDCLine, val) -> Any
+

Set TwoTerminalVSCDCLine services.

source
diff --git a/dev/model_library/generated_VariableReserveNonSpinning/index.html b/dev/model_library/generated_VariableReserveNonSpinning/index.html index a0d2019943..0f258c95e8 100644 --- a/dev/model_library/generated_VariableReserveNonSpinning/index.html +++ b/dev/model_library/generated_VariableReserveNonSpinning/index.html @@ -10,52 +10,52 @@ deployed_fraction::Float64 ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A non-spinning reserve product with a time-varying procurement requirement, such as a higher requirement during hours with an expected high load or high ramp.

This reserve product includes back-up generators that might not be currently synchronized with the power system, but can come online quickly after an unexpected contingency, such as a transmission line or generator outage. To model the time varying requirement, a "requirement" time series should be added to this reserve.

This is only an upwards reserve. For faster-responding upwards or downwards reserves from components already synchronized with the system, see VariableReserve

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::VariableReserveNonSpinning) -> String
-

Get VariableReserveNonSpinning name.

source
PowerSystems.get_available — Method
get_available(value::VariableReserveNonSpinning) -> Bool
-

Get VariableReserveNonSpinning available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(
+end

A non-spinning reserve product with a time-varying procurement requirement, such as a higher requirement during hours with an expected high load or high ramp.

This reserve product includes back-up generators that might not be currently synchronized with the power system, but can come online quickly after an unexpected contingency, such as a transmission line or generator outage. To model the time varying requirement, a "requirement" time series should be added to this reserve.

This is only an upwards reserve. For faster-responding upwards or downwards reserves from components already synchronized with the system, see VariableReserve

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)
  • requirement::Float64: the required quantity of the product should be scaled by a TimeSeriesData
  • sustained_time::Float64: (default: 14400.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)
  • max_output_fraction::Float64: (default: 1.0) the maximum fraction of each device's output that can be assigned to the service, validation range: (0, 1)
  • max_participation_factor::Float64: (default: 1.0) the maximum portion [0, 1.0] of the reserve that can be contributed per device, validation range: (0, 1)
  • deployed_fraction::Float64: (default: 0.0) Fraction of service procurement that is assumed to be actually deployed. Most commonly, this is assumed to be either 0.0 or 1.0, validation range: (0, 1)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::VariableReserveNonSpinning) -> String
+

Get VariableReserveNonSpinning name.

source
PowerSystems.get_available — Method
get_available(value::VariableReserveNonSpinning) -> Bool
+

Get VariableReserveNonSpinning available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(
     value::VariableReserveNonSpinning
 ) -> Float64
-

Get VariableReserveNonSpinning deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(
+

Get VariableReserveNonSpinning deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(
     value::VariableReserveNonSpinning
 ) -> Dict{String, Any}
-

Get VariableReserveNonSpinning ext.

source
PowerSystems.get_max_output_fraction — Method
get_max_output_fraction(
+

Get VariableReserveNonSpinning ext.

source
PowerSystems.get_max_output_fraction — Method
get_max_output_fraction(
     value::VariableReserveNonSpinning
 ) -> Float64
-

Get VariableReserveNonSpinning max_output_fraction.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
+

Get VariableReserveNonSpinning max_output_fraction.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
     value::VariableReserveNonSpinning
 ) -> Float64
-

Get VariableReserveNonSpinning max_participation_factor.

source
PowerSystems.get_requirement — Method
get_requirement(value::VariableReserveNonSpinning) -> Any
-

Get VariableReserveNonSpinning requirement.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(
+

Get VariableReserveNonSpinning max_participation_factor.

source
PowerSystems.get_requirement — Method
get_requirement(value::VariableReserveNonSpinning) -> Any
+

Get VariableReserveNonSpinning requirement.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(
     value::VariableReserveNonSpinning
 ) -> Float64
-

Get VariableReserveNonSpinning sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::VariableReserveNonSpinning) -> Float64
-

Get VariableReserveNonSpinning time_frame.

source
PowerSystems.set_available! — Method
set_available!(
+

Get VariableReserveNonSpinning sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::VariableReserveNonSpinning) -> Float64
+

Get VariableReserveNonSpinning time_frame.

source
PowerSystems.set_available! — Method
set_available!(
     value::VariableReserveNonSpinning,
     val
 ) -> Any
-

Set VariableReserveNonSpinning available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(
+

Set VariableReserveNonSpinning available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(
     value::VariableReserveNonSpinning,
     val
 ) -> Any
-

Set VariableReserveNonSpinning deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::VariableReserveNonSpinning, val) -> Any
-

Set VariableReserveNonSpinning ext.

source
PowerSystems.set_max_output_fraction! — Method
set_max_output_fraction!(
+

Set VariableReserveNonSpinning deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::VariableReserveNonSpinning, val) -> Any
+

Set VariableReserveNonSpinning ext.

source
PowerSystems.set_max_output_fraction! — Method
set_max_output_fraction!(
     value::VariableReserveNonSpinning,
     val
 ) -> Any
-

Set VariableReserveNonSpinning max_output_fraction.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
+

Set VariableReserveNonSpinning max_output_fraction.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
     value::VariableReserveNonSpinning,
     val
 ) -> Any
-

Set VariableReserveNonSpinning max_participation_factor.

source
PowerSystems.set_requirement! — Method
set_requirement!(
+

Set VariableReserveNonSpinning max_participation_factor.

source
PowerSystems.set_requirement! — Method
set_requirement!(
     value::VariableReserveNonSpinning,
     val
 ) -> Any
-

Set VariableReserveNonSpinning requirement.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(
+

Set VariableReserveNonSpinning requirement.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(
     value::VariableReserveNonSpinning,
     val
 ) -> Any
-

Set VariableReserveNonSpinning sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(
+

Set VariableReserveNonSpinning sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(
     value::VariableReserveNonSpinning,
     val
 ) -> Any
-

Set VariableReserveNonSpinning time_frame.

source
+

Set VariableReserveNonSpinning time_frame.

source diff --git a/dev/model_library/hybrid_system/index.html b/dev/model_library/hybrid_system/index.html index f874bccaff..ff648469ad 100644 --- a/dev/model_library/hybrid_system/index.html +++ b/dev/model_library/hybrid_system/index.html @@ -25,61 +25,61 @@ dynamic_injector::Union{Nothing, DynamicInjection} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A Hybrid System that includes a combination of renewable generation, load, thermal generation and/or energy storage.

Arguments

source
PowerSystems.get_active_power — Method
get_active_power(value::HybridSystem) -> Any
-

Get HybridSystem active_power.

source
PowerSystems.get_available — Method
get_available(value::HybridSystem) -> Bool
-

Get HybridSystem available.

source
PowerSystems.get_base_power — Method
get_base_power(value::HybridSystem) -> Float64
-

Get HybridSystem base_power.

source
PowerSystems.get_bus — Method
get_bus(value::HybridSystem) -> ACBus
-

Get HybridSystem bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
+end

A Hybrid System that includes a combination of renewable generation, load, thermal generation and/or energy storage.

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • status::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)
  • bus::ACBus: Bus that this component is connected to
  • active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
  • reactive_power::Float64: Initial reactive power set point of the unit (MVAR)
  • base_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating
  • operation_cost::MarketBidCost: Market bid cost to operate, MarketBidCost
  • thermal_unit::Union{Nothing, ThermalGen}: A thermal generator with supertype ThermalGen
  • electric_load::Union{Nothing, ElectricLoad}: A load with supertype ElectricLoad
  • storage::Union{Nothing, Storage}: An energy storage system with supertype Storage
  • renewable_unit::Union{Nothing, RenewableGen}: A renewable generator with supertype RenewableGen
  • interconnection_impedance::ComplexF64: Impedance (typically in p.u.) between the hybrid system and the grid interconnection
  • interconnection_rating::Union{Nothing, Float64}: Maximum rating of the hybrid system's interconnection with the transmission network (MVA)
  • input_active_power_limits::MinMax: Minimum and maximum stable input active power levels (MW)
  • output_active_power_limits::MinMax: Minimum and maximum stable output active power levels (MW)
  • reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits (MVAR). Set to Nothing if not applicable.
  • interconnection_efficiency::Union{Nothing, NamedTuple{(:in, :out), Tuple{Float64, Float64}},}: Efficiency [0, 1.0] at the grid interconnection to model losses in and out of the common DC-side conversion
  • services::Vector{Service}: (optional) Services that this device contributes to
  • dynamic_injector::Union{Nothing, DynamicInjection}: (optional) corresponding dynamic injection device
  • ext::Dict{String, Any}: (optional) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields.
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference.
source
PowerSystems.get_active_power — Method
get_active_power(value::HybridSystem) -> Any
+

Get HybridSystem active_power.

source
PowerSystems.get_available — Method
get_available(value::HybridSystem) -> Bool
+

Get HybridSystem available.

source
PowerSystems.get_base_power — Method
get_base_power(value::HybridSystem) -> Float64
+

Get HybridSystem base_power.

source
PowerSystems.get_bus — Method
get_bus(value::HybridSystem) -> ACBus
+

Get HybridSystem bus.

source
PowerSystems.get_dynamic_injector — Method
get_dynamic_injector(
     value::HybridSystem
 ) -> Union{Nothing, DynamicInjection}
-

Get HybridSystem dynamic_injector.

source
PowerSystems.get_electric_load — Method
get_electric_load(
+

Get HybridSystem dynamic_injector.

source
PowerSystems.get_electric_load — Method
get_electric_load(
     value::HybridSystem
 ) -> Union{Nothing, ElectricLoad}
-

Get HybridSystem load

source
PowerSystems.get_ext — Method
get_ext(value::HybridSystem) -> Dict{String, Any}
-

Get HybridSystem ext.

source
PowerSystems.get_input_active_power_limits — Method
get_input_active_power_limits(
+

Get HybridSystem load

source
PowerSystems.get_ext — Method
get_ext(value::HybridSystem) -> Dict{String, Any}
+

Get HybridSystem ext.

source
PowerSystems.get_input_active_power_limits — Method
get_input_active_power_limits(
     value::HybridSystem
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get HybridSystem input_active_power_limits.

source
PowerSystems.get_interconnection_impedance — Method
get_interconnection_impedance(
+

Get HybridSystem input_active_power_limits.

source
PowerSystems.get_interconnection_impedance — Method
get_interconnection_impedance(
     value::HybridSystem
 ) -> ComplexF64
-

get HybridSystem interconnection impedance

source
PowerSystems.get_interconnection_rating — Method
get_interconnection_rating(value::HybridSystem) -> Any
-

Get HybridSystem interconnection_rating.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(value::HybridSystem) -> MarketBidCost
-

Get HybridSystem operation_cost.

source
PowerSystems.get_output_active_power_limits — Method
get_output_active_power_limits(
+

get HybridSystem interconnection impedance

source
PowerSystems.get_interconnection_rating — Method
get_interconnection_rating(value::HybridSystem) -> Any
+

Get HybridSystem interconnection_rating.

source
PowerSystems.get_operation_cost — Method
get_operation_cost(value::HybridSystem) -> MarketBidCost
+

Get HybridSystem operation_cost.

source
PowerSystems.get_output_active_power_limits — Method
get_output_active_power_limits(
     value::HybridSystem
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get HybridSystem output_active_power_limits.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::HybridSystem) -> Any
-

Get HybridSystem reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
+

Get HybridSystem output_active_power_limits.

source
PowerSystems.get_reactive_power — Method
get_reactive_power(value::HybridSystem) -> Any
+

Get HybridSystem reactive_power.

source
PowerSystems.get_reactive_power_limits — Method
get_reactive_power_limits(
     value::HybridSystem
 ) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}
-

Get HybridSystem reactive_power_limits.

source
PowerSystems.get_renewable_unit — Method
get_renewable_unit(
+

Get HybridSystem reactive_power_limits.

source
PowerSystems.get_renewable_unit — Method
get_renewable_unit(
     value::HybridSystem
 ) -> Union{Nothing, RenewableGen}
-

Get HybridSystem renewable unit

source
PowerSystems.get_services — Method
get_services(value::HybridSystem) -> Vector{Service}
-

Get HybridSystem services.

source
PowerSystems.get_status — Method
get_status(value::HybridSystem) -> Bool
-

Get HybridSystem status.

source
PowerSystems.get_storage — Method
get_storage(value::HybridSystem) -> Union{Nothing, Storage}
-

Get HybridSystem storage unit

source
PowerSystems.get_subcomponents — Method
get_subcomponents(hybrid::HybridSystem) -> Channel{Any}
+

Get HybridSystem renewable unit

source
PowerSystems.get_services — Method
get_services(value::HybridSystem) -> Vector{Service}
+

Get HybridSystem services.

source
PowerSystems.get_status — Method
get_status(value::HybridSystem) -> Bool
+

Get HybridSystem status.

source
PowerSystems.get_storage — Method
get_storage(value::HybridSystem) -> Union{Nothing, Storage}
+

Get HybridSystem storage unit

source
PowerSystems.get_subcomponents — Method
get_subcomponents(hybrid::HybridSystem) -> Channel{Any}

Return an iterator over the subcomponents in the HybridSystem.

Examples

for subcomponent in get_subcomponents(hybrid_sys)
     @show subcomponent
 end
-subcomponents = collect(get_subcomponents(hybrid_sys))
source
PowerSystems.get_thermal_unit — Method
get_thermal_unit(
+subcomponents = collect(get_subcomponents(hybrid_sys))
source
PowerSystems.get_thermal_unit — Method
get_thermal_unit(
     value::HybridSystem
 ) -> Union{Nothing, ThermalGen}
-

Get HybridSystem thermal unit

source
PowerSystems.set_active_power! — Method
set_active_power!(value::HybridSystem, val) -> Any
-

Set HybridSystem active_power.

source
PowerSystems.set_available! — Method
set_available!(value::HybridSystem, val) -> Any
-

Set HybridSystem available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::HybridSystem, val) -> Any
-

Set HybridSystem base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::HybridSystem, val) -> Any
-

Set HybridSystem bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::HybridSystem, val) -> Any
-

Set HybridSystem ext.

source
PowerSystems.set_input_active_power_limits! — Method
set_input_active_power_limits!(
+

Get HybridSystem thermal unit

source
PowerSystems.set_active_power! — Method
set_active_power!(value::HybridSystem, val) -> Any
+

Set HybridSystem active_power.

source
PowerSystems.set_available! — Method
set_available!(value::HybridSystem, val) -> Any
+

Set HybridSystem available.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::HybridSystem, val) -> Any
+

Set HybridSystem base_power.

source
PowerSystems.set_bus! — Method
set_bus!(value::HybridSystem, val) -> Any
+

Set HybridSystem bus.

source
PowerSystems.set_ext! — Method
set_ext!(value::HybridSystem, val) -> Any
+

Set HybridSystem ext.

source
PowerSystems.set_input_active_power_limits! — Method
set_input_active_power_limits!(
     value::HybridSystem,
     val
 ) -> Any
-

Set HybridSystem input_active_power_limits.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::HybridSystem, val) -> Any
-

Set HybridSystem operation_cost.

source
PowerSystems.set_output_active_power_limits! — Method
set_output_active_power_limits!(
+

Set HybridSystem input_active_power_limits.

source
PowerSystems.set_operation_cost! — Method
set_operation_cost!(value::HybridSystem, val) -> Any
+

Set HybridSystem operation_cost.

source
PowerSystems.set_output_active_power_limits! — Method
set_output_active_power_limits!(
     value::HybridSystem,
     val
 ) -> Any
-

Set HybridSystem output_active_power_limits.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::HybridSystem, val) -> Any
-

Set HybridSystem reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(value::HybridSystem, val) -> Any
-

Set HybridSystem reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::HybridSystem, val) -> Any
-

Set HybridSystem services.

source
PowerSystems.set_status! — Method
set_status!(value::HybridSystem, val) -> Any
-

Get HybridSystem status.

source
+

Set HybridSystem output_active_power_limits.

source
PowerSystems.set_reactive_power! — Method
set_reactive_power!(value::HybridSystem, val) -> Any
+

Set HybridSystem reactive_power.

source
PowerSystems.set_reactive_power_limits! — Method
set_reactive_power_limits!(value::HybridSystem, val) -> Any
+

Set HybridSystem reactive_power_limits.

source
PowerSystems.set_services! — Method
set_services!(value::HybridSystem, val) -> Any
+

Set HybridSystem services.

source
PowerSystems.set_status! — Method
set_status!(value::HybridSystem, val) -> Any
+

Get HybridSystem status.

source
diff --git a/dev/model_library/hydro_generation_cost/index.html b/dev/model_library/hydro_generation_cost/index.html index 011dedf7d4..99d5bcb6f0 100644 --- a/dev/model_library/hydro_generation_cost/index.html +++ b/dev/model_library/hydro_generation_cost/index.html @@ -1,9 +1,9 @@ HydroGenerationCost · PowerSystems.jl
Edit on GitHub

HydroGenerationCost

PowerSystems.HydroGenerationCost — Type
mutable struct HydroGenerationCost <: OperationalCost

  • variable::ProductionVariableCostCurve: Production variable cost represented by a FuelCurve, where the fuel is water, or a CostCurve in currency.

  • fixed::Float64: (default: 0) Fixed cost of keeping the unit online. For some cost represenations this field can be duplicative

HydroGenerationCost(variable, fixed)
-HydroGenerationCost(; variable, fixed)

An operational cost of a hydropower generator which includes fixed and variable cost. Variable costs can be used to represent the cost of curtailment if negative values are used or the opportunity cost of water if the costs are positive. It also supports fuel curves to model specific water intake.

The variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.

source
PowerSystems.get_variable — Method
get_variable(
+HydroGenerationCost(; variable, fixed)

An operational cost of a hydropower generator which includes fixed and variable cost. Variable costs can be used to represent the cost of curtailment if negative values are used or the opportunity cost of water if the costs are positive. It also supports fuel curves to model specific water intake.

The variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.

source
+

Get HydroGenerationCost variable.

source
PowerSystems.set_fixed! — Method
set_fixed!(value::HydroGenerationCost, val) -> Any
+

Set HydroGenerationCost fixed.

source
PowerSystems.set_variable! — Method
set_variable!(value::HydroGenerationCost, val) -> Any
+

Set HydroGenerationCost variable.

source
diff --git a/dev/model_library/load_cost/index.html b/dev/model_library/load_cost/index.html index 2d4ad1a35a..cebc3fa8a8 100644 --- a/dev/model_library/load_cost/index.html +++ b/dev/model_library/load_cost/index.html @@ -1,7 +1,7 @@ LoadCost · PowerSystems.jl
Edit on GitHub

LoadCost

PowerSystems.LoadCost — Type
mutable struct LoadCost <: OperationalCost

  • variable::CostCurve: Variable cost represented as a CostCurve

  • fixed::Float64: (default: 0) Fixed cost. For some cost represenations this field can be duplicative

LoadCost(variable, fixed)
-LoadCost(; variable, fixed)

An operational cost for controllable loads (e.g., InterruptiblePowerLoad), including fixed and variable cost components.

The variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.

source
+LoadCost(; variable, fixed)

An operational cost for controllable loads (e.g., InterruptiblePowerLoad), including fixed and variable cost components.

The variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.

source
PowerSystems.get_fixed — Method
get_fixed(value::LoadCost) -> Float64
+

Get LoadCost fixed.

source
PowerSystems.get_variable — Method
get_variable(value::LoadCost) -> CostCurve
+

Get LoadCost variable.

source
PowerSystems.set_fixed! — Method
set_fixed!(value::LoadCost, val) -> Any
+

Set LoadCost fixed.

source
PowerSystems.set_variable! — Method
set_variable!(value::LoadCost, val) -> Any
+

Set LoadCost variable.

source
diff --git a/dev/model_library/market_bid_cost/index.html b/dev/model_library/market_bid_cost/index.html index a44416b617..7e44f2bb16 100644 --- a/dev/model_library/market_bid_cost/index.html +++ b/dev/model_library/market_bid_cost/index.html @@ -25,46 +25,46 @@ decremental_offer_curves, ancillary_service_offers ) -> MarketBidCost -

Accepts a single start_up value to use as the hot value, with warm and cold set to 0.0.

source
PowerSystems.MarketBidCost — Type
mutable struct MarketBidCost <: OperationalCost

  • no_load_cost::Union{Float64, TimeSeriesKey}: No load cost

  • start_up::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}: Start-up cost at different stages of the thermal cycle as the unit cools after a shutdown (e.g., hot, warm, or cold starts). Warm is also referred to as intermediate in some markets. Can also accept a single value if there is only one start-up cost

  • shut_down::Float64: Shut-down cost

  • incremental_offer_curves::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}: Sell Offer Curves data, which can be a time series or a CostCurve using PiecewiseIncrementalCurve

  • decremental_offer_curves::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}: Buy Offer Curves data, can be a time series or a CostCurve using PiecewiseIncrementalCurve

  • ancillary_service_offers::Vector{Service}: Bids for the ancillary services

MarketBidCost(no_load_cost, start_up, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)
+

Accepts a single start_up value to use as the hot value, with warm and cold set to 0.0.

source
PowerSystems.MarketBidCost — Type
mutable struct MarketBidCost <: OperationalCost

  • no_load_cost::Union{Float64, TimeSeriesKey}: No load cost

  • start_up::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}: Start-up cost at different stages of the thermal cycle as the unit cools after a shutdown (e.g., hot, warm, or cold starts). Warm is also referred to as intermediate in some markets. Can also accept a single value if there is only one start-up cost

  • shut_down::Float64: Shut-down cost

  • incremental_offer_curves::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}: Sell Offer Curves data, which can be a time series or a CostCurve using PiecewiseIncrementalCurve

  • decremental_offer_curves::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}: Buy Offer Curves data, can be a time series or a CostCurve using PiecewiseIncrementalCurve

  • ancillary_service_offers::Vector{Service}: Bids for the ancillary services

MarketBidCost(no_load_cost, start_up, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)
 MarketBidCost(; no_load_cost, start_up, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)
-MarketBidCost(no_load_cost, start_up::Real, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)

An operating cost for market bids of energy and ancilliary services for any asset. Compatible with most US Market bidding mechanisms that support demand and generation side.

source
PowerSystems.get_ancillary_service_offers — Method
get_ancillary_service_offers(
+MarketBidCost(no_load_cost, start_up::Real, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)

An operating cost for market bids of energy and ancilliary services for any asset. Compatible with most US Market bidding mechanisms that support demand and generation side.

source
PowerSystems.get_ancillary_service_offers — Method
get_ancillary_service_offers(
     value::MarketBidCost
 ) -> Vector{Service}
-

Get MarketBidCost ancillary_service_offers.

source
PowerSystems.get_decremental_offer_curves — Method
get_decremental_offer_curves(
+

Get MarketBidCost ancillary_service_offers.

source
PowerSystems.get_decremental_offer_curves — Method
get_decremental_offer_curves(
     value::MarketBidCost
 ) -> Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}
-

Get MarketBidCost incremental_offer_curves.

source
PowerSystems.get_incremental_offer_curves — Method
get_incremental_offer_curves(
+

Get MarketBidCost incremental_offer_curves.

source
PowerSystems.get_incremental_offer_curves — Method
get_incremental_offer_curves(
     value::MarketBidCost
 ) -> Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}
-

Get MarketBidCost incremental_offer_curves.

source
PowerSystems.get_no_load_cost — Method
get_no_load_cost(
+

Get MarketBidCost incremental_offer_curves.

source
PowerSystems.get_no_load_cost — Method
get_no_load_cost(
     value::MarketBidCost
 ) -> Union{Float64, TimeSeriesKey}
-

Get MarketBidCost no_load_cost.

source
PowerSystems.get_shut_down — Method
get_shut_down(value::MarketBidCost) -> Float64
-

Get MarketBidCost shut_down.

source
PowerSystems.get_start_up — Method
get_start_up(
+

Get MarketBidCost no_load_cost.

source
PowerSystems.get_shut_down — Method
get_shut_down(value::MarketBidCost) -> Float64
+

Get MarketBidCost shut_down.

source
PowerSystems.get_start_up — Method
get_start_up(
     value::MarketBidCost
 ) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}
-

Get MarketBidCost start_up.

source
PowerSystems.make_market_bid_curve — Method
make_market_bid_curve(
+

Get MarketBidCost start_up.

source
PowerSystems.make_market_bid_curve — Method
make_market_bid_curve(
     data::PiecewiseStepData;
     power_units
 ) -> CostCurve{PiecewiseIncrementalCurve}
-

Make a CostCurve{PiecewiseIncrementalCurve} suitable for inclusion in a MarketBidCost from the FunctionData that might be used to store such a cost curve in a time series.

source
PowerSystems.make_market_bid_curve — Method
make_market_bid_curve(
+

Make a CostCurve{PiecewiseIncrementalCurve} suitable for inclusion in a MarketBidCost from the FunctionData that might be used to store such a cost curve in a time series.

source
PowerSystems.make_market_bid_curve — Method
make_market_bid_curve(
     powers::Vector{Float64},
     marginal_costs::Vector{Float64};
     power_units
 ) -> CostCurve{PiecewiseIncrementalCurve}
-

Make a CostCurve{PiecewiseIncrementalCurve} suitable for inclusion in a MarketBidCost from a vector of power values, a vector of marginal costs, and an optional units system. The minimum power, and cost at minimum power, are not represented.

source
PowerSystems.set_ancillary_service_offers! — Method
set_ancillary_service_offers!(
+

Make a CostCurve{PiecewiseIncrementalCurve} suitable for inclusion in a MarketBidCost from a vector of power values, a vector of marginal costs, and an optional units system. The minimum power, and cost at minimum power, are not represented.

source
PowerSystems.set_ancillary_service_offers! — Method
set_ancillary_service_offers!(
     value::MarketBidCost,
     val
 ) -> Any
-

Set MarketBidCost ancillary_service_offers.

source
PowerSystems.set_decremental_offer_curves! — Method
set_decremental_offer_curves!(
+

Set MarketBidCost ancillary_service_offers.

source
PowerSystems.set_decremental_offer_curves! — Method
set_decremental_offer_curves!(
     value::MarketBidCost,
     val
 ) -> Any
-

Set MarketBidCost incremental_offer_curves.

source
PowerSystems.set_incremental_offer_curves! — Method
set_incremental_offer_curves!(
+

Set MarketBidCost incremental_offer_curves.

source
PowerSystems.set_incremental_offer_curves! — Method
set_incremental_offer_curves!(
     value::MarketBidCost,
     val
 ) -> Any
-

Set MarketBidCost incremental_offer_curves.

source
PowerSystems.set_no_load_cost! — Method
set_no_load_cost!(value::MarketBidCost, val) -> Any
-

Set MarketBidCost no_load_cost.

source
PowerSystems.set_shut_down! — Method
set_shut_down!(value::MarketBidCost, val) -> Any
-

Set MarketBidCost shut_down.

source
PowerSystems.set_start_up! — Method
set_start_up!(value::MarketBidCost, val) -> Any
-

Set MarketBidCost start_up.

source
+

Set MarketBidCost incremental_offer_curves.

source
PowerSystems.set_no_load_cost! — Method
set_no_load_cost!(value::MarketBidCost, val) -> Any
+

Set MarketBidCost no_load_cost.

source
PowerSystems.set_shut_down! — Method
set_shut_down!(value::MarketBidCost, val) -> Any
+

Set MarketBidCost shut_down.

source
PowerSystems.set_start_up! — Method
set_start_up!(value::MarketBidCost, val) -> Any
+

Set MarketBidCost start_up.

source
diff --git a/dev/model_library/outer_control/index.html b/dev/model_library/outer_control/index.html index 0dc0c19914..865c791055 100644 --- a/dev/model_library/outer_control/index.html +++ b/dev/model_library/outer_control/index.html @@ -8,7 +8,7 @@ ext::Dict{String, Any} states::Vector{Symbol} n_states::Int -end

Parameters of a Outer-Loop controller using a active power controller and a reactive power droop controller.

Arguments

source

Virtual Inertia

PowerSystems.VirtualInertia — Type
mutable struct VirtualInertia <: ActivePowerControl
+end

Parameters of a Outer-Loop controller using a active power controller and a reactive power droop controller.

Arguments

  • A <: ActivePowerControl: Active power controller (typically droop or virtual inertia).
  • R <: ReactivePowerControl: Reactive power controller (typically droop).
  • ext::Dict{String, Any}
  • states::Vector{Symbol}: Vector of states (will depend on the components).
  • n_states::Int: Number of states (will depend on the components).
source

Virtual Inertia

PowerSystems.VirtualInertia — Type
mutable struct VirtualInertia <: ActivePowerControl
     Ta::Float64
     kd::Float64
     kω::Float64
@@ -17,33 +17,33 @@
     states::Vector{Symbol}
     n_states::Int
 end

Parameters of a Virtual Inertia with SRF using VSM for active power controller

Arguments

  • Ta::Float64: VSM inertia constant, validation range: (0, nothing)
  • kd::Float64: VSM damping constant, validation range: (0, nothing)
  • kω::Float64: frequency droop gain, 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 extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the VirtualInertia model are:
θ_oc: Phase angle displacement of the virtual synchronous generator model
-ω_oc: Speed of the rotating reference frame of the virtual synchronous generator model
  • n_states::Int: (Do not modify.) VirtualInertia has two states
source
PowerSystems.get_P_ref — Method
get_P_ref(value::VirtualInertia) -> Float64
-

Get VirtualInertia P_ref.

source
PowerSystems.get_Ta — Method
get_Ta(value::VirtualInertia) -> Float64
-

Get VirtualInertia Ta.

source
PowerSystems.get_ext — Method
get_ext(value::VirtualInertia) -> Dict{String, Any}
-

Get VirtualInertia ext.

source
PowerSystems.get_kd — Method
get_kd(value::VirtualInertia) -> Float64
-

Get VirtualInertia kd.

source
PowerSystems.get_kω — Method
get_kω(value::VirtualInertia) -> Float64
-

Get VirtualInertia kω.

source
PowerSystems.get_n_states — Method
get_n_states(value::VirtualInertia) -> Int64
-

Get VirtualInertia n_states.

source
PowerSystems.get_states — Method
get_states(value::VirtualInertia) -> Vector{Symbol}
-

Get VirtualInertia states.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::VirtualInertia, val) -> Any
-

Set VirtualInertia P_ref.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::VirtualInertia, val) -> Any
-

Set VirtualInertia Ta.

source
PowerSystems.set_ext! — Method
set_ext!(value::VirtualInertia, val) -> Any
-

Set VirtualInertia ext.

source
PowerSystems.set_kd! — Method
set_kd!(value::VirtualInertia, val) -> Any
-

Set VirtualInertia kd.

source
PowerSystems.set_kω! — Method
set_kω!(value::VirtualInertia, val) -> Any
-

Set VirtualInertia kω.

source

Reactive Power Droop

PowerSystems.ReactivePowerDroop — Type
mutable struct ReactivePowerDroop <: ReactivePowerControl
+ω_oc: Speed of the rotating reference frame of the virtual synchronous generator model
  • n_states::Int: (Do not modify.) VirtualInertia has two states
source
PowerSystems.get_P_ref — Method
get_P_ref(value::VirtualInertia) -> Float64
+

Get VirtualInertia P_ref.

source
PowerSystems.get_Ta — Method
get_Ta(value::VirtualInertia) -> Float64
+

Get VirtualInertia Ta.

source
PowerSystems.get_ext — Method
get_ext(value::VirtualInertia) -> Dict{String, Any}
+

Get VirtualInertia ext.

source
PowerSystems.get_kd — Method
get_kd(value::VirtualInertia) -> Float64
+

Get VirtualInertia kd.

source
PowerSystems.get_kω — Method
get_kω(value::VirtualInertia) -> Float64
+

Get VirtualInertia kω.

source
PowerSystems.get_n_states — Method
get_n_states(value::VirtualInertia) -> Int64
+

Get VirtualInertia n_states.

source
PowerSystems.get_states — Method
get_states(value::VirtualInertia) -> Vector{Symbol}
+

Get VirtualInertia states.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::VirtualInertia, val) -> Any
+

Set VirtualInertia P_ref.

source
PowerSystems.set_Ta! — Method
set_Ta!(value::VirtualInertia, val) -> Any
+

Set VirtualInertia Ta.

source
PowerSystems.set_ext! — Method
set_ext!(value::VirtualInertia, val) -> Any
+

Set VirtualInertia ext.

source
PowerSystems.set_kd! — Method
set_kd!(value::VirtualInertia, val) -> Any
+

Set VirtualInertia kd.

source
PowerSystems.set_kω! — Method
set_kω!(value::VirtualInertia, val) -> Any
+

Set VirtualInertia kω.

source

Reactive Power Droop

PowerSystems.ReactivePowerDroop — Type
mutable struct ReactivePowerDroop <: ReactivePowerControl
     kq::Float64
     ωf::Float64
     V_ref::Float64
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of a Reactive Power droop controller

Arguments

  • kq::Float64: frequency droop gain, validation range: (0, nothing)
  • ωf::Float64: filter frequency cutoff, validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • states::Vector{Symbol}: (Do not modify.) The states of the ReactivePowerDroop model are:
q_oc: Filtered reactive output power
  • n_states::Int: (Do not modify.) ReactivePowerDroop has 1 state
source
PowerSystems.get_V_ref — Method
get_V_ref(value::ReactivePowerDroop) -> Float64
-

Get ReactivePowerDroop V_ref.

source
PowerSystems.get_ext — Method
get_ext(value::ReactivePowerDroop) -> Dict{String, Any}
-

Get ReactivePowerDroop ext.

source
PowerSystems.get_kq — Method
get_kq(value::ReactivePowerDroop) -> Float64
-

Get ReactivePowerDroop kq.

source
PowerSystems.get_n_states — Method
get_n_states(value::ReactivePowerDroop) -> Int64
-

Get ReactivePowerDroop n_states.

source
PowerSystems.get_states — Method
get_states(value::ReactivePowerDroop) -> Vector{Symbol}
-

Get ReactivePowerDroop states.

source
PowerSystems.get_ωf — Method
get_ωf(value::ReactivePowerDroop) -> Float64
-

Get ReactivePowerDroop ωf.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ReactivePowerDroop, val) -> Any
-

Set ReactivePowerDroop V_ref.

source
PowerSystems.set_ext! — Method
set_ext!(value::ReactivePowerDroop, val) -> Any
-

Set ReactivePowerDroop ext.

source
PowerSystems.set_kq! — Method
set_kq!(value::ReactivePowerDroop, val) -> Any
-

Set ReactivePowerDroop kq.

source
PowerSystems.set_ωf! — Method
set_ωf!(value::ReactivePowerDroop, val) -> Any
-

Set ReactivePowerDroop ωf.

source
+end

Parameters of a Reactive Power droop controller

Arguments

q_oc: Filtered reactive output power
source
PowerSystems.get_V_ref — Method
get_V_ref(value::ReactivePowerDroop) -> Float64
+

Get ReactivePowerDroop V_ref.

source
PowerSystems.get_ext — Method
get_ext(value::ReactivePowerDroop) -> Dict{String, Any}
+

Get ReactivePowerDroop ext.

source
PowerSystems.get_kq — Method
get_kq(value::ReactivePowerDroop) -> Float64
+

Get ReactivePowerDroop kq.

source
PowerSystems.get_n_states — Method
get_n_states(value::ReactivePowerDroop) -> Int64
+

Get ReactivePowerDroop n_states.

source
PowerSystems.get_states — Method
get_states(value::ReactivePowerDroop) -> Vector{Symbol}
+

Get ReactivePowerDroop states.

source
PowerSystems.get_ωf — Method
get_ωf(value::ReactivePowerDroop) -> Float64
+

Get ReactivePowerDroop ωf.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(value::ReactivePowerDroop, val) -> Any
+

Set ReactivePowerDroop V_ref.

source
PowerSystems.set_ext! — Method
set_ext!(value::ReactivePowerDroop, val) -> Any
+

Set ReactivePowerDroop ext.

source
PowerSystems.set_kq! — Method
set_kq!(value::ReactivePowerDroop, val) -> Any
+

Set ReactivePowerDroop kq.

source
PowerSystems.set_ωf! — Method
set_ωf!(value::ReactivePowerDroop, val) -> Any
+

Set ReactivePowerDroop ωf.

source
diff --git a/dev/model_library/renewable_generation_cost/index.html b/dev/model_library/renewable_generation_cost/index.html index b3b1ba7d36..1e56effe0b 100644 --- a/dev/model_library/renewable_generation_cost/index.html +++ b/dev/model_library/renewable_generation_cost/index.html @@ -1,13 +1,13 @@ RenewableGenerationCost · PowerSystems.jl
Edit on GitHub

RenewableGenerationCost

PowerSystems.RenewableGenerationCost — Type
mutable struct RenewableGenerationCost <: OperationalCost

  • variable::CostCurve: Variable cost represented as a CostCurve

  • curtailment_cost::CostCurve: (default of 0) Cost of curtailing power represented as a CostCurve

RenewableGenerationCost(variable, curtailment_cost)
 RenewableGenerationCost(variable; curtailment_cost)
-RenewableGenerationCost(; variable, curtailment_cost)

An operational cost of renewable generators which includes the variable cost of energy (like a PPA) and the cost of curtailing power. For example, curtailment costs can be used to represent the loss of tax incentives.

The variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.

source
PowerSystems.get_curtailment_cost — Method
get_curtailment_cost(
+RenewableGenerationCost(; variable, curtailment_cost)

An operational cost of renewable generators which includes the variable cost of energy (like a PPA) and the cost of curtailing power. For example, curtailment costs can be used to represent the loss of tax incentives.

The variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.

source
+

Set RenewableGenerationCost curtailment_cost.

source
PowerSystems.set_variable! — Method
set_variable!(value::RenewableGenerationCost, val) -> Any
+

Set RenewableGenerationCost variable.

source
diff --git a/dev/model_library/reserves/index.html b/dev/model_library/reserves/index.html index 31fbe6cb90..0f96fd7fcd 100644 --- a/dev/model_library/reserves/index.html +++ b/dev/model_library/reserves/index.html @@ -10,46 +10,46 @@ deployed_fraction::Float64 ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A reserve product with a constant procurement requirement, such as 3% of the system base power at all times.

This reserve product includes online generators that can respond right away after an unexpected contingency, such as a transmission line or generator outage. When defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric

Arguments

source
InfrastructureSystems.get_name — Method
get_name(value::ConstantReserve) -> String
-

Get ConstantReserve name.

source
PowerSystems.get_available — Method
get_available(value::ConstantReserve) -> Bool
-

Get ConstantReserve available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(value::ConstantReserve) -> Float64
-

Get ConstantReserve deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(value::ConstantReserve) -> Dict{String, Any}
-

Get ConstantReserve ext.

source
PowerSystems.get_max_output_fraction — Method
get_max_output_fraction(value::ConstantReserve) -> Float64
-

Get ConstantReserve max_output_fraction.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
+end

A reserve product with a constant procurement requirement, such as 3% of the system base power at all times.

This reserve product includes online generators that can respond right away after an unexpected contingency, such as a transmission line or generator outage. When defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)
  • requirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)
  • sustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)
  • max_output_fraction::Float64: (default: 1.0) the maximum fraction of each device's output that can be assigned to the service, validation range: (0, 1)
  • max_participation_factor::Float64: (default: 1.0) the maximum portion [0, 1.0] of the reserve that can be contributed per device, validation range: (0, 1)
  • deployed_fraction::Float64: (default: 0.0) Fraction of service procurement that is assumed to be actually deployed. Most commonly, this is assumed to be either 0.0 or 1.0, validation range: (0, 1)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ConstantReserve) -> String
+

Get ConstantReserve name.

source
PowerSystems.get_available — Method
get_available(value::ConstantReserve) -> Bool
+

Get ConstantReserve available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(value::ConstantReserve) -> Float64
+

Get ConstantReserve deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(value::ConstantReserve) -> Dict{String, Any}
+

Get ConstantReserve ext.

source
PowerSystems.get_max_output_fraction — Method
get_max_output_fraction(value::ConstantReserve) -> Float64
+

Get ConstantReserve max_output_fraction.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
     value::ConstantReserve
 ) -> Float64
-

Get ConstantReserve max_participation_factor.

source
PowerSystems.get_requirement — Method
get_requirement(value::ConstantReserve) -> Any
-

Get ConstantReserve requirement.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(value::ConstantReserve) -> Float64
-

Get ConstantReserve sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::ConstantReserve) -> Float64
-

Get ConstantReserve time_frame.

source
PowerSystems.set_available! — Method
set_available!(value::ConstantReserve, val) -> Any
-

Set ConstantReserve available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(value::ConstantReserve, val) -> Any
-

Set ConstantReserve deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::ConstantReserve, val) -> Any
-

Set ConstantReserve ext.

source
PowerSystems.set_max_output_fraction! — Method
set_max_output_fraction!(value::ConstantReserve, val) -> Any
-

Set ConstantReserve max_output_fraction.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
+

Get ConstantReserve max_participation_factor.

source
PowerSystems.get_requirement — Method
get_requirement(value::ConstantReserve) -> Any
+

Get ConstantReserve requirement.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(value::ConstantReserve) -> Float64
+

Get ConstantReserve sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::ConstantReserve) -> Float64
+

Get ConstantReserve time_frame.

source
PowerSystems.set_available! — Method
set_available!(value::ConstantReserve, val) -> Any
+

Set ConstantReserve available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(value::ConstantReserve, val) -> Any
+

Set ConstantReserve deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::ConstantReserve, val) -> Any
+

Set ConstantReserve ext.

source
PowerSystems.set_max_output_fraction! — Method
set_max_output_fraction!(value::ConstantReserve, val) -> Any
+

Set ConstantReserve max_output_fraction.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
     value::ConstantReserve,
     val
 ) -> Any
-

Set ConstantReserve max_participation_factor.

source
PowerSystems.set_requirement! — Method
set_requirement!(value::ConstantReserve, val) -> Any
-

Set ConstantReserve requirement.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(value::ConstantReserve, val) -> Any
-

Set ConstantReserve sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(value::ConstantReserve, val) -> Any
-

Set ConstantReserve time_frame.

source

Constant Reserve Group

PowerSystems.ConstantReserveGroup — Type
mutable struct ConstantReserveGroup{T <: ReserveDirection} <: Service
+

Set ConstantReserve max_participation_factor.

source
PowerSystems.set_requirement! — Method
set_requirement!(value::ConstantReserve, val) -> Any
+

Set ConstantReserve requirement.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(value::ConstantReserve, val) -> Any
+

Set ConstantReserve sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(value::ConstantReserve, val) -> Any
+

Set ConstantReserve time_frame.

source

Constant Reserve Group

PowerSystems.ConstantReserveGroup — Type
mutable struct ConstantReserveGroup{T <: ReserveDirection} <: Service
     name::String
     available::Bool
     requirement::Float64
     ext::Dict{String, Any}
     contributing_services::Vector{Service}
     internal::InfrastructureSystemsInternal
-end

A reserve product met by a group of individual reserves.

The group reserve requirement is added in addition to any individual reserve requirements, and devices that contribute to individual reserves within the group can also contribute to the overarching group reserve requirement. Example: A group of spinning and non-spinning reserves, where online generators providing spinning reserves can also contribute to the non-spinning reserve requirement.

This model has a constant procurement requirement, such as 3% of the system base power at all times. When defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • requirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • contributing_services::Vector{Service}: (default: Vector{Service}()) Services that contribute to this group requirement. Services must be added for this constraint to have an effect when conducting simulations in PowerSimulations.jl
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ConstantReserveGroup) -> String
-

Get ConstantReserveGroup name.

source
PowerSystems.get_available — Method
get_available(value::ConstantReserveGroup) -> Bool
-

Get ConstantReserveGroup available.

source
PowerSystems.get_contributing_services — Method
get_contributing_services(
+end

A reserve product met by a group of individual reserves.

The group reserve requirement is added in addition to any individual reserve requirements, and devices that contribute to individual reserves within the group can also contribute to the overarching group reserve requirement. Example: A group of spinning and non-spinning reserves, where online generators providing spinning reserves can also contribute to the non-spinning reserve requirement.

This model has a constant procurement requirement, such as 3% of the system base power at all times. When defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • requirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • contributing_services::Vector{Service}: (default: Vector{Service}()) Services that contribute to this group requirement. Services must be added for this constraint to have an effect when conducting simulations in PowerSimulations.jl
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ConstantReserveGroup) -> String
+

Get ConstantReserveGroup name.

source
PowerSystems.get_available — Method
get_available(value::ConstantReserveGroup) -> Bool
+

Get ConstantReserveGroup available.

source
PowerSystems.get_contributing_services — Method
get_contributing_services(
     value::ConstantReserveGroup
 ) -> Vector{Service}
-

Get ConstantReserveGroup contributing_services.

source
PowerSystems.get_ext — Method
get_ext(value::ConstantReserveGroup) -> Dict{String, Any}
-

Get ConstantReserveGroup ext.

source
PowerSystems.get_requirement — Method
get_requirement(value::ConstantReserveGroup) -> Any
-

Get ConstantReserveGroup requirement.

source
PowerSystems.set_available! — Method
set_available!(value::ConstantReserveGroup, val) -> Any
-

Set ConstantReserveGroup available.

source
PowerSystems.set_ext! — Method
set_ext!(value::ConstantReserveGroup, val) -> Any
-

Set ConstantReserveGroup ext.

source
PowerSystems.set_requirement! — Method
set_requirement!(value::ConstantReserveGroup, val) -> Any
-

Set ConstantReserveGroup requirement.

source

Variable Reserve

PowerSystems.VariableReserve — Type
mutable struct VariableReserve{T <: ReserveDirection} <: Reserve{T}
+

Get ConstantReserveGroup contributing_services.

source
PowerSystems.get_ext — Method
get_ext(value::ConstantReserveGroup) -> Dict{String, Any}
+

Get ConstantReserveGroup ext.

source
PowerSystems.get_requirement — Method
get_requirement(value::ConstantReserveGroup) -> Any
+

Get ConstantReserveGroup requirement.

source
PowerSystems.set_available! — Method
set_available!(value::ConstantReserveGroup, val) -> Any
+

Set ConstantReserveGroup available.

source
PowerSystems.set_ext! — Method
set_ext!(value::ConstantReserveGroup, val) -> Any
+

Set ConstantReserveGroup ext.

source
PowerSystems.set_requirement! — Method
set_requirement!(value::ConstantReserveGroup, val) -> Any
+

Set ConstantReserveGroup requirement.

source

Variable Reserve

PowerSystems.VariableReserve — Type
mutable struct VariableReserve{T <: ReserveDirection} <: Reserve{T}
     name::String
     available::Bool
     time_frame::Float64
@@ -60,29 +60,29 @@
     deployed_fraction::Float64
     ext::Dict{String, Any}
     internal::InfrastructureSystemsInternal
-end

A reserve product with a time-varying procurement requirement, such as a higher requirement during hours with an expected high load or high ramp.

This reserve product includes online generators that can respond right away after an unexpected contingency, such as a transmission line or generator outage. When defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric. To model the time varying requirement, a "requirement" time series should be added to this reserve

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)
  • requirement::Float64: the required quantity of the product should be scaled by a TimeSeriesData
  • sustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)
  • max_output_fraction::Float64: (default: 1.0) the maximum fraction of each device's output that can be assigned to the service, validation range: (0, 1)
  • max_participation_factor::Float64: (default: 1.0) the maximum portion [0, 1.0] of the reserve that can be contributed per device, validation range: (0, 1)
  • deployed_fraction::Float64: (default: 0.0) Fraction of service procurement that is assumed to be actually deployed. Most commonly, this is assumed to be either 0.0 or 1.0, validation range: (0, 1)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::VariableReserve) -> String
-

Get VariableReserve name.

source
PowerSystems.get_available — Method
get_available(value::VariableReserve) -> Bool
-

Get VariableReserve available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(value::VariableReserve) -> Float64
-

Get VariableReserve deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(value::VariableReserve) -> Dict{String, Any}
-

Get VariableReserve ext.

source
PowerSystems.get_max_output_fraction — Method
get_max_output_fraction(value::VariableReserve) -> Float64
-

Get VariableReserve max_output_fraction.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
+end

A reserve product with a time-varying procurement requirement, such as a higher requirement during hours with an expected high load or high ramp.

This reserve product includes online generators that can respond right away after an unexpected contingency, such as a transmission line or generator outage. When defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric. To model the time varying requirement, a "requirement" time series should be added to this reserve

Arguments

  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)
  • requirement::Float64: the required quantity of the product should be scaled by a TimeSeriesData
  • sustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)
  • max_output_fraction::Float64: (default: 1.0) the maximum fraction of each device's output that can be assigned to the service, validation range: (0, 1)
  • max_participation_factor::Float64: (default: 1.0) the maximum portion [0, 1.0] of the reserve that can be contributed per device, validation range: (0, 1)
  • deployed_fraction::Float64: (default: 0.0) Fraction of service procurement that is assumed to be actually deployed. Most commonly, this is assumed to be either 0.0 or 1.0, validation range: (0, 1)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::VariableReserve) -> String
+

Get VariableReserve name.

source
PowerSystems.get_available — Method
get_available(value::VariableReserve) -> Bool
+

Get VariableReserve available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(value::VariableReserve) -> Float64
+

Get VariableReserve deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(value::VariableReserve) -> Dict{String, Any}
+

Get VariableReserve ext.

source
PowerSystems.get_max_output_fraction — Method
get_max_output_fraction(value::VariableReserve) -> Float64
+

Get VariableReserve max_output_fraction.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
     value::VariableReserve
 ) -> Float64
-

Get VariableReserve max_participation_factor.

source
PowerSystems.get_requirement — Method
get_requirement(value::VariableReserve) -> Float64
-

Get VariableReserve requirement.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(value::VariableReserve) -> Float64
-

Get VariableReserve sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::VariableReserve) -> Float64
-

Get VariableReserve time_frame.

source
PowerSystems.set_available! — Method
set_available!(value::VariableReserve, val) -> Any
-

Set VariableReserve available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(value::VariableReserve, val) -> Any
-

Set VariableReserve deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::VariableReserve, val) -> Any
-

Set VariableReserve ext.

source
PowerSystems.set_max_output_fraction! — Method
set_max_output_fraction!(value::VariableReserve, val) -> Any
-

Set VariableReserve max_output_fraction.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
+

Get VariableReserve max_participation_factor.

source
PowerSystems.get_requirement — Method
get_requirement(value::VariableReserve) -> Float64
+

Get VariableReserve requirement.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(value::VariableReserve) -> Float64
+

Get VariableReserve sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::VariableReserve) -> Float64
+

Get VariableReserve time_frame.

source
PowerSystems.set_available! — Method
set_available!(value::VariableReserve, val) -> Any
+

Set VariableReserve available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(value::VariableReserve, val) -> Any
+

Set VariableReserve deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::VariableReserve, val) -> Any
+

Set VariableReserve ext.

source
PowerSystems.set_max_output_fraction! — Method
set_max_output_fraction!(value::VariableReserve, val) -> Any
+

Set VariableReserve max_output_fraction.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
     value::VariableReserve,
     val
 ) -> Any
-

Set VariableReserve max_participation_factor.

source
PowerSystems.set_requirement! — Method
set_requirement!(value::VariableReserve, val) -> Any
-

Set VariableReserve requirement.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(value::VariableReserve, val) -> Any
-

Set VariableReserve sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(value::VariableReserve, val) -> Any
-

Set VariableReserve time_frame.

source

Reserve Demand Curve

PowerSystems.ReserveDemandCurve — Type
mutable struct ReserveDemandCurve{T <: ReserveDirection} <: Reserve{T}
+

Set VariableReserve max_participation_factor.

source
PowerSystems.set_requirement! — Method
set_requirement!(value::VariableReserve, val) -> Any
+

Set VariableReserve requirement.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(value::VariableReserve, val) -> Any
+

Set VariableReserve sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(value::VariableReserve, val) -> Any
+

Set VariableReserve time_frame.

source

Reserve Demand Curve

PowerSystems.ReserveDemandCurve — Type
mutable struct ReserveDemandCurve{T <: ReserveDirection} <: Reserve{T}
     variable::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}
     name::String
     available::Bool
@@ -92,29 +92,29 @@
     deployed_fraction::Float64
     ext::Dict{String, Any}
     internal::InfrastructureSystemsInternal
-end

A reserve product with an Operating Reserve Demand Curve (ORDC) for operational simulations.

The ORDC is modeled as a discretized set of (Reserve capacity (MW), Price ($/MWh)) steps, which can vary with time. Use set_variable_cost! to define the ORDCs.

When defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric

Arguments

  • variable::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}: Create this object with variable = nothing, then add assign a cost curve or time-series of variable_cost using the set_variable_cost! function, which will automatically update this parameter
  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)
  • sustained_time::Float64: (default: 3600.0) the time in seconds that the reserve contribution must sustained at a specified level, validation range: (0, nothing)
  • max_participation_factor::Float64: (default: 1.0) the maximum portion [0, 1.0] of the reserve that can be contributed per device, validation range: (0, 1)
  • deployed_fraction::Float64: (default: 0.0) Fraction of service procurement that is assumed to be actually deployed. Most commonly, this is assumed to be either 0.0 or 1.0, validation range: (0, 1)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ReserveDemandCurve) -> String
-

Get ReserveDemandCurve name.

source
PowerSystems.get_available — Method
get_available(value::ReserveDemandCurve) -> Bool
-

Get ReserveDemandCurve available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(value::ReserveDemandCurve) -> Float64
-

Get ReserveDemandCurve deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(value::ReserveDemandCurve) -> Dict{String, Any}
-

Get ReserveDemandCurve ext.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
+end

A reserve product with an Operating Reserve Demand Curve (ORDC) for operational simulations.

The ORDC is modeled as a discretized set of (Reserve capacity (MW), Price ($/MWh)) steps, which can vary with time. Use set_variable_cost! to define the ORDCs.

When defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric

Arguments

  • variable::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}: Create this object with variable = nothing, then add assign a cost curve or time-series of variable_cost using the set_variable_cost! function, which will automatically update this parameter
  • name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
  • available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
  • time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)
  • sustained_time::Float64: (default: 3600.0) the time in seconds that the reserve contribution must sustained at a specified level, validation range: (0, nothing)
  • max_participation_factor::Float64: (default: 1.0) the maximum portion [0, 1.0] of the reserve that can be contributed per device, validation range: (0, 1)
  • deployed_fraction::Float64: (default: 0.0) Fraction of service procurement that is assumed to be actually deployed. Most commonly, this is assumed to be either 0.0 or 1.0, validation range: (0, 1)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See Adding additional fields
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ReserveDemandCurve) -> String
+

Get ReserveDemandCurve name.

source
PowerSystems.get_available — Method
get_available(value::ReserveDemandCurve) -> Bool
+

Get ReserveDemandCurve available.

source
PowerSystems.get_deployed_fraction — Method
get_deployed_fraction(value::ReserveDemandCurve) -> Float64
+

Get ReserveDemandCurve deployed_fraction.

source
PowerSystems.get_ext — Method
get_ext(value::ReserveDemandCurve) -> Dict{String, Any}
+

Get ReserveDemandCurve ext.

source
PowerSystems.get_max_participation_factor — Method
get_max_participation_factor(
     value::ReserveDemandCurve
 ) -> Float64
-

Get ReserveDemandCurve max_participation_factor.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(value::ReserveDemandCurve) -> Float64
-

Get ReserveDemandCurve sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::ReserveDemandCurve) -> Float64
-

Get ReserveDemandCurve time_frame.

source
PowerSystems.get_variable — Method
get_variable(
+

Get ReserveDemandCurve max_participation_factor.

source
PowerSystems.get_sustained_time — Method
get_sustained_time(value::ReserveDemandCurve) -> Float64
+

Get ReserveDemandCurve sustained_time.

source
PowerSystems.get_time_frame — Method
get_time_frame(value::ReserveDemandCurve) -> Float64
+

Get ReserveDemandCurve time_frame.

source
PowerSystems.get_variable — Method
get_variable(
     value::ReserveDemandCurve
 ) -> Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}
-

Get ReserveDemandCurve variable.

source
PowerSystems.set_available! — Method
set_available!(value::ReserveDemandCurve, val) -> Any
-

Set ReserveDemandCurve available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(
+

Get ReserveDemandCurve variable.

source
PowerSystems.set_available! — Method
set_available!(value::ReserveDemandCurve, val) -> Any
+

Set ReserveDemandCurve available.

source
PowerSystems.set_deployed_fraction! — Method
set_deployed_fraction!(
     value::ReserveDemandCurve,
     val
 ) -> Any
-

Set ReserveDemandCurve deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::ReserveDemandCurve, val) -> Any
-

Set ReserveDemandCurve ext.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
+

Set ReserveDemandCurve deployed_fraction.

source
PowerSystems.set_ext! — Method
set_ext!(value::ReserveDemandCurve, val) -> Any
+

Set ReserveDemandCurve ext.

source
PowerSystems.set_max_participation_factor! — Method
set_max_participation_factor!(
     value::ReserveDemandCurve,
     val
 ) -> Any
-

Set ReserveDemandCurve max_participation_factor.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(value::ReserveDemandCurve, val) -> Any
-

Set ReserveDemandCurve sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(value::ReserveDemandCurve, val) -> Any
-

Set ReserveDemandCurve time_frame.

source
PowerSystems.set_variable! — Method
set_variable!(value::ReserveDemandCurve, val) -> Any
-

Set ReserveDemandCurve variable.

source
+

Set ReserveDemandCurve max_participation_factor.

source
PowerSystems.set_sustained_time! — Method
set_sustained_time!(value::ReserveDemandCurve, val) -> Any
+

Set ReserveDemandCurve sustained_time.

source
PowerSystems.set_time_frame! — Method
set_time_frame!(value::ReserveDemandCurve, val) -> Any
+

Set ReserveDemandCurve time_frame.

source
PowerSystems.set_variable! — Method
set_variable!(value::ReserveDemandCurve, val) -> Any
+

Set ReserveDemandCurve variable.

source
diff --git a/dev/model_library/storage_cost/index.html b/dev/model_library/storage_cost/index.html index 0df9a66fa3..ab01ab8c03 100644 --- a/dev/model_library/storage_cost/index.html +++ b/dev/model_library/storage_cost/index.html @@ -1,19 +1,19 @@ StorageCost · PowerSystems.jl
Edit on GitHub

StorageCost

PowerSystems.StorageCost — Type
mutable struct StorageCost <: OperationalCost

  • charge_variable_cost::CostCurve: (default of 0) Variable cost of charging represented as a CostCurve

  • discharge_variable_cost::CostCurve: (default of 0) Variable cost of discharging represented as a CostCurve

  • fixed::Float64: (default: 0) Fixed cost of operating the storage system

  • start_up::Union{Float64, @NamedTuple{charge::Float64, discharge::Float64}}: (default: 0) Start-up cost

  • shut_down::Float64: (default: 0) Shut-down cost

  • energy_shortage_cost::Float64: (default: 0) Cost incurred by the model for being short of the energy target

  • energy_surplus_cost::Float64: (default: 0) Cost incurred by the model for surplus energy stored

StorageCost(charge_variable_cost, discharge_variable_cost, fixed, start_up, shut_down, energy_shortage_cost, energy_surplus_cost)
-StorageCost(; charge_variable_cost, discharge_variable_cost, fixed, start_up, shut_down, energy_shortage_cost, energy_surplus_cost)

An operational cost for storage units including fixed costs and variable costs to charge or discharge.

This data structure is not intended to represent market storage systems market operations like the submission of buy/sell bids – see MarketBidCost instead.

source
PowerSystems.get_start_up — Method
get_start_up(
+StorageCost(; charge_variable_cost, discharge_variable_cost, fixed, start_up, shut_down, energy_shortage_cost, energy_surplus_cost)

An operational cost for storage units including fixed costs and variable costs to charge or discharge.

This data structure is not intended to represent market storage systems market operations like the submission of buy/sell bids – see MarketBidCost instead.

source
+

Get StorageCost start_up.

source
PowerSystems.set_charge_variable_cost! — Method
set_charge_variable_cost!(value::StorageCost, val) -> Any
+

Set StorageCost charge_variable_cost.

source
PowerSystems.set_discharge_variable_cost! — Method
set_discharge_variable_cost!(value::StorageCost, val) -> Any
+

Set StorageCost discharge_variable_cost.

source
PowerSystems.set_energy_shortage_cost! — Method
set_energy_shortage_cost!(value::StorageCost, val) -> Any
+

Set StorageCost energy_shortage_cost.

source
PowerSystems.set_energy_surplus_cost! — Method
set_energy_surplus_cost!(value::StorageCost, val) -> Any
+

Set StorageCost energy_surplus_cost.

source
PowerSystems.set_fixed! — Method
set_fixed!(value::StorageCost, val) -> Any
+

Set StorageCost fixed.

source
PowerSystems.set_shut_down! — Method
set_shut_down!(value::StorageCost, val) -> Any
+

Set StorageCost shut_down.

source
PowerSystems.set_start_up! — Method
set_start_up!(value::StorageCost, val) -> Any
+

Set StorageCost start_up.

source
diff --git a/dev/model_library/thermal_generation_cost/index.html b/dev/model_library/thermal_generation_cost/index.html index 82c6736f9e..85628c6b68 100644 --- a/dev/model_library/thermal_generation_cost/index.html +++ b/dev/model_library/thermal_generation_cost/index.html @@ -1,15 +1,15 @@ ThermalGenerationCost · PowerSystems.jl
Edit on GitHub

ThermalGenerationCost

PowerSystems.ThermalGenerationCost — Type
mutable struct ThermalGenerationCost <: OperationalCost

  • variable::ProductionVariableCostCurve: Variable production cost. Can take a CostCurve or FuelCurve

  • fixed::Float64: Fixed cost of keeping the unit online. For some cost represenations this field can be duplicative

  • start_up::Union{Float64, @NamedTuple{hot::Float64, warm::Float64, cold::Float64}}: Start-up cost can take linear or multi-stage cost

  • shut_down::Float64: Cost to turn the unit off

ThermalGenerationCost(variable, fixed, start_up, shut_down)
-ThermalGenerationCost(; variable, fixed, start_up, shut_down)

An operational cost for thermal generators which includes fixed cost, variable cost, shut-down cost, and multiple options for start up costs.

source
PowerSystems.get_start_up — Method
get_start_up(
+ThermalGenerationCost(; variable, fixed, start_up, shut_down)

An operational cost for thermal generators which includes fixed cost, variable cost, shut-down cost, and multiple options for start up costs.

source
+

Get ThermalGenerationCost variable.

source
PowerSystems.set_fixed! — Method
set_fixed!(value::ThermalGenerationCost, val) -> Any
+

Set ThermalGenerationCost fixed.

source
PowerSystems.set_shut_down! — Method
set_shut_down!(value::ThermalGenerationCost, val) -> Any
+

Set ThermalGenerationCost shut_down.

source
PowerSystems.set_start_up! — Method
set_start_up!(value::ThermalGenerationCost, val) -> Any
+

Set ThermalGenerationCost start_up.

source
PowerSystems.set_variable! — Method
set_variable!(value::ThermalGenerationCost, val) -> Any
+

Set ThermalGenerationCost variable.

source
diff --git a/dev/model_library/value_curves/index.html b/dev/model_library/value_curves/index.html index ed829b6498..0f597b5a9d 100644 --- a/dev/model_library/value_curves/index.html +++ b/dev/model_library/value_curves/index.html @@ -1,4 +1,4 @@ Value Curves · PowerSystems.jl
Edit on GitHub

ValueCurves

PowerSystems.LinearCurve — Type
LinearCurve(proportional_term::Float64)
-LinearCurve(proportional_term::Float64, constant_term::Float64)

A linear input-output curve, representing a constant marginal rate. May have zero no-load cost (i.e., constant average rate) or not.

Arguments

  • proportional_term::Float64: marginal rate
  • constant_term::Float64: optional, cost at zero production, defaults to 0.0
source
PowerSystems.QuadraticCurve — Type
QuadraticCurve(quadratic_term::Float64, proportional_term::Float64, constant_term::Float64)

A quadratic input-output curve, may have nonzero no-load cost.

Arguments

  • quadratic_term::Float64: quadratic term of the curve
  • proportional_term::Float64: proportional term of the curve
  • constant_term::Float64: constant term of the curve
source
PowerSystems.PiecewisePointCurve — Type
PiecewisePointCurve(points::Vector{Tuple{Float64, Float64}})

A piecewise linear curve specified by cost values at production points.

Arguments

  • points::Vector{Tuple{Float64, Float64}} or similar: vector of (production, cost) pairs
source
PowerSystems.PiecewiseIncrementalCurve — Type
PiecewiseIncrementalCurve(initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})
-PiecewiseIncrementalCurve(input_at_zero::Union{Nothing, Float64}, initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})

A piecewise linear curve specified by marginal rates (slopes) between production points. May have nonzero initial value.

Arguments

  • input_at_zero::Union{Nothing, Float64}: (optional, defaults to nothing) cost at zero production, does NOT represent a part of the curve
  • initial_input::Union{Float64, Nothing}: cost at minimum production point first(x_coords) (NOT at zero production), defines the start of the curve
  • x_coords::Vector{Float64}: vector of n production points
  • slopes::Vector{Float64}: vector of n-1 marginal rates/slopes of the curve segments between the points
source
PowerSystems.PiecewiseAverageCurve — Type
PiecewiseAverageCurve(initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})

A piecewise linear curve specified by average rates between production points. May have nonzero initial value.

Arguments

  • initial_input::Union{Float64, Nothing}: cost at minimum production point first(x_coords) (NOT at zero production), defines the start of the curve
  • x_coords::Vector{Float64}: vector of n production points
  • slopes::Vector{Float64}: vector of n-1 average rates/slopes of the curve segments between the points
source
+LinearCurve(proportional_term::Float64, constant_term::Float64)

A linear input-output curve, representing a constant marginal rate. May have zero no-load cost (i.e., constant average rate) or not.

Arguments

source
PowerSystems.QuadraticCurve — Type
QuadraticCurve(quadratic_term::Float64, proportional_term::Float64, constant_term::Float64)

A quadratic input-output curve, may have nonzero no-load cost.

Arguments

  • quadratic_term::Float64: quadratic term of the curve
  • proportional_term::Float64: proportional term of the curve
  • constant_term::Float64: constant term of the curve
source
PowerSystems.PiecewisePointCurve — Type
PiecewisePointCurve(points::Vector{Tuple{Float64, Float64}})

A piecewise linear curve specified by cost values at production points.

Arguments

  • points::Vector{Tuple{Float64, Float64}} or similar: vector of (production, cost) pairs
source
PowerSystems.PiecewiseIncrementalCurve — Type
PiecewiseIncrementalCurve(initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})
+PiecewiseIncrementalCurve(input_at_zero::Union{Nothing, Float64}, initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})

A piecewise linear curve specified by marginal rates (slopes) between production points. May have nonzero initial value.

Arguments

  • input_at_zero::Union{Nothing, Float64}: (optional, defaults to nothing) cost at zero production, does NOT represent a part of the curve
  • initial_input::Union{Float64, Nothing}: cost at minimum production point first(x_coords) (NOT at zero production), defines the start of the curve
  • x_coords::Vector{Float64}: vector of n production points
  • slopes::Vector{Float64}: vector of n-1 marginal rates/slopes of the curve segments between the points
source
PowerSystems.PiecewiseAverageCurve — Type
PiecewiseAverageCurve(initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})

A piecewise linear curve specified by average rates between production points. May have nonzero initial value.

Arguments

  • initial_input::Union{Float64, Nothing}: cost at minimum production point first(x_coords) (NOT at zero production), defines the start of the curve
  • x_coords::Vector{Float64}: vector of n production points
  • slopes::Vector{Float64}: vector of n-1 average rates/slopes of the curve segments between the points
source
diff --git a/dev/modeler_guide/cost_functions/index.html b/dev/modeler_guide/cost_functions/index.html index 0e6381d23d..059d1904f7 100644 --- a/dev/modeler_guide/cost_functions/index.html +++ b/dev/modeler_guide/cost_functions/index.html @@ -1,2 +1,2 @@ -Variable Costs · PowerSystems.jl
Edit on GitHub

Variable Costs

Operating cost data typically includes both fixed and variable costs. See the how-to on Adding an Operating Cost for a demonstration of defining an operating cost.

In PowerSystems.jl, the variable portion of the operating cost can be represented as linear, quadratic, or piecewise input-output curves, potentially piecewise marginal heat rates, average heat rates, and more, as best fits the input data.

This table shows each variable cost ValueCurve with an example. Each ValueCurve makes no assumption about units. The "Example interpretation" shown here, with currency units, assumes that the variable cost ValueCurve will be input to a CostCurve. Note that all three Piecewise options here fundamentally represent the same curve.

Type aliasDescriptionConstructor parametersExampleExample interpretation
LinearCurveLinear input-output curve with zero no-load cost (constant average rate)Average/marginal rateLinearCurve(3.0)$3/MWh
LinearCurveLinear input-output curve with nonzero no-load cost (constant marginal rate)Marginal rate, cost at zero productionLinearCurve(3.0, 5.0)$3/MWh + $5/hr
QuadraticCurveQuadratic input-output curve, may have nonzero no-load costQuadratic, proportional, and constant terms of input-output curveQuadraticCurve(1.0, 1.0, 18.0)$C(P) = 1 P^2 + 1 P + 18$ where $C$ is $/hr, $P$ is MW
PiecewisePointCurvePiecewise linear curve specified by cost values at production pointsVector of (production, cost) pairsPiecewisePointCurve([(1.0, 20.0), (2.0, 24.0), (3.0, 30.0)])$20/hr @ 1 MW, $24/hr @ 2 MW, $30/hr @ 3 MW, linear $/hr interpolation between these points
PiecewiseIncrementalCurvePiecewise linear curve specified by marginal rates (slopes) between production points, may have nonzero initial valueCost at minimum production point, vector of $n$ production points, vector of $n-1$ marginal rates/slopes of the curve segments between the pointsPiecewiseIncrementalCurve(20., [1.0, 2.0, 3.0], [4.0, 6.0])$20/hr @ 1 MW plus additional $4/MWh from 1 MW to 2 MW plus additional $6/MWh from 2 MW to 3 MW
PiecewiseAverageCurvePiecewise linear curve specified by average rates between production points, may have nonzero initial valueCost at minimum production point, vector of $n$ production points, vector of average rates at the $n-1$ latter pointsPiecewiseAverageCurve(20., [1.0, 2.0, 3.0], [12.0, 10.0])$20/hr @ 1 MW, $12/MWh @ 2 MW, $10/MWh @ 3 MW, linear $/hr interpolation between these points
+Variable Costs · PowerSystems.jl
Edit on GitHub

Variable Costs

Operating cost data typically includes both fixed and variable costs. See the how-to on Adding an Operating Cost for a demonstration of defining an operating cost.

In PowerSystems.jl, the variable portion of the operating cost can be represented as linear, quadratic, or piecewise input-output curves, potentially piecewise marginal heat rates, average heat rates, and more, as best fits the input data.

This table shows each variable cost ValueCurve with an example. Each ValueCurve makes no assumption about units. The "Example interpretation" shown here, with currency units, assumes that the variable cost ValueCurve will be input to a CostCurve. Note that all three Piecewise options here fundamentally represent the same curve.

Type aliasDescriptionConstructor parametersExampleExample interpretation
LinearCurveLinear input-output curve with zero no-load cost (constant average rate)Average/marginal rateLinearCurve(3.0)$3/MWh
LinearCurveLinear input-output curve with nonzero no-load cost (constant marginal rate)Marginal rate, cost at zero productionLinearCurve(3.0, 5.0)$3/MWh + $5/hr
QuadraticCurveQuadratic input-output curve, may have nonzero no-load costQuadratic, proportional, and constant terms of input-output curveQuadraticCurve(1.0, 1.0, 18.0)$C(P) = 1 P^2 + 1 P + 18$ where $C$ is $/hr, $P$ is MW
PiecewisePointCurvePiecewise linear curve specified by cost values at production pointsVector of (production, cost) pairsPiecewisePointCurve([(1.0, 20.0), (2.0, 24.0), (3.0, 30.0)])$20/hr @ 1 MW, $24/hr @ 2 MW, $30/hr @ 3 MW, linear $/hr interpolation between these points
PiecewiseIncrementalCurvePiecewise linear curve specified by marginal rates (slopes) between production points, may have nonzero initial valueCost at minimum production point, vector of $n$ production points, vector of $n-1$ marginal rates/slopes of the curve segments between the pointsPiecewiseIncrementalCurve(20., [1.0, 2.0, 3.0], [4.0, 6.0])$20/hr @ 1 MW plus additional $4/MWh from 1 MW to 2 MW plus additional $6/MWh from 2 MW to 3 MW
PiecewiseAverageCurvePiecewise linear curve specified by average rates between production points, may have nonzero initial valueCost at minimum production point, vector of $n$ production points, vector of average rates at the $n-1$ latter pointsPiecewiseAverageCurve(20., [1.0, 2.0, 3.0], [12.0, 10.0])$20/hr @ 1 MW, $12/MWh @ 2 MW, $10/MWh @ 3 MW, linear $/hr interpolation between these points
diff --git a/dev/modeler_guide/enumerated_types/index.html b/dev/modeler_guide/enumerated_types/index.html index 3d5737e7e6..3bef98bf39 100644 --- a/dev/modeler_guide/enumerated_types/index.html +++ b/dev/modeler_guide/enumerated_types/index.html @@ -1,2 +1,2 @@ -Enumerated Types · PowerSystems.jl
Edit on GitHub

Enumerated Types

To specify fields representing an option from a pre-defined list, some of the fields of Component structs are specified with IS.scoped_enums (e.g. set_fuel!(gen, ThermalFuels.COAL)). Below are the enumerated types contained in PowerSystems.

ThermalFuels

Each ThermalGen generator struct contains a field for fuel::ThermalFuels where ThermalFuels are intended to reflect the options denoted by the Aggregated Fuel Codes from the EIA Annual Energy Review. Specifically, ThermalFuels is an enumerated type with the following options:

EnumNameEIA Fuel CodeDescription
COALCOLAnthracite Coal and Bituminous Coal
WASTE_COALWOCWaste/Other Coal (includes anthracite culm, gob, fine coal, lignite waste, waste coal)
DISTILLATE_FUEL_OILDFODistillate Fuel Oil (Diesel, No. 1, No. 2, and No. 4)
WASTE_OILWOOWaste Oil Kerosene and JetFuel Butane, Propane
PETROLEUM_COKEPCPetroleum Coke
RESIDUAL_FUEL_OILRFOResidual Fuel Oil (No. 5, No. 6 Fuel Oils, and Bunker Oil)
NATURAL_GASNGNatural Gas
OTHER_GASOOGOther Gas and blast furnace gas
NUCLEARNUCNuclear Fission (Uranium, Plutonium, Thorium)
AG_BIPRODUCTORWAgricultural Crop Byproducts/Straw/Energy Crops
MUNICIPAL_WASTEMLGMunicipal Solid Waste – Biogenic component
WOOD_WASTEWWWWood Waste Liquids excluding Black Liquor (BLQ) (Includes red liquor, sludge wood, spent sulfite liquor, and other wood-based liquids)
GEOTHERMALGEOGeothermal
OTHEROTHOther

PrimeMovers

Each generator struct contains a field for prime_mover::PrimeMovers where PrimeMovers are intended to reflect the options denoted by EIA form 923. Specifically, PrimeMovers is an enumerated type with the following options:

EnumNameDescription
BAEnergy Storage, Battery
BTTurbines Used in a Binary Cycle (including those used for geothermal applications)
CACombined-Cycle – Steam Part
CCCombined-Cycle - Aggregated Plant *augmentation of EIA
CEEnergy Storage, Compressed Air
CPEnergy Storage, Concentrated Solar Power
CSCombined-Cycle Single-Shaft Combustion turbine and steam turbine share a single generator
CTCombined-Cycle Combustion Turbine Part
ESEnergy Storage, Other
FCFuel Cell
FWEnergy Storage, Flywheel
GTCombustion (Gas) Turbine (including jet engine design)
HAHydrokinetic, Axial Flow Turbine
HBHydrokinetic, Wave Buoy
HKHydrokinetic, Other
HYHydraulic Turbine (including turbines associated with delivery of water by pipeline)
ICInternal Combustion (diesel, piston, reciprocating) Engine
PSEnergy Storage, Reversible Hydraulic Turbine (Pumped Storage)
OTOther
STSteam Turbine (including nuclear, geothermal and solar steam; does not include combined-cycle turbine)
PVPhotovoltaic *renaming from EIA PV to PVe to avoid conflict with ACBusType.PV
WTWind Turbine, Onshore
WSWind Turbine, Offshore

ACBusTypes

ACBusTypes is used to denote which quantities are specified for load flow calculations and to otherwise categorize buses for modeling activities.

EnumNameDescription
ISOLATEDDisconnected from network
PQActive and reactive power defined (load bus)
PVActive power and voltage magnitude defined (generator bus)
REFReference bus (θ = 0)
SLACKSlack bus

AngleUnits

EnumName
DEGREES
RADIANS

StateTypes

StateTypes are used to denote the type of dynamic equation a specific state is subject to in PowerSimulationsDynamics.jl

EnumNameDescription
DifferentialState evolves over time via a differential equation $\dot{x} = f(x)$
AlgebraicState evolves over time by satisfying an algebraic equation $0 = g(x)$
HybridDepending on specific parameters, the state can be Differential or Algebraic
+Enumerated Types · PowerSystems.jl
Edit on GitHub

Enumerated Types

To specify fields representing an option from a pre-defined list, some of the fields of Component structs are specified with IS.scoped_enums (e.g. set_fuel!(gen, ThermalFuels.COAL)). Below are the enumerated types contained in PowerSystems.

ThermalFuels

Each ThermalGen generator struct contains a field for fuel::ThermalFuels where ThermalFuels are intended to reflect the options denoted by the Aggregated Fuel Codes from the EIA Annual Energy Review. Specifically, ThermalFuels is an enumerated type with the following options:

EnumNameEIA Fuel CodeDescription
COALCOLAnthracite Coal and Bituminous Coal
WASTE_COALWOCWaste/Other Coal (includes anthracite culm, gob, fine coal, lignite waste, waste coal)
DISTILLATE_FUEL_OILDFODistillate Fuel Oil (Diesel, No. 1, No. 2, and No. 4)
WASTE_OILWOOWaste Oil Kerosene and JetFuel Butane, Propane
PETROLEUM_COKEPCPetroleum Coke
RESIDUAL_FUEL_OILRFOResidual Fuel Oil (No. 5, No. 6 Fuel Oils, and Bunker Oil)
NATURAL_GASNGNatural Gas
OTHER_GASOOGOther Gas and blast furnace gas
NUCLEARNUCNuclear Fission (Uranium, Plutonium, Thorium)
AG_BIPRODUCTORWAgricultural Crop Byproducts/Straw/Energy Crops
MUNICIPAL_WASTEMLGMunicipal Solid Waste – Biogenic component
WOOD_WASTEWWWWood Waste Liquids excluding Black Liquor (BLQ) (Includes red liquor, sludge wood, spent sulfite liquor, and other wood-based liquids)
GEOTHERMALGEOGeothermal
OTHEROTHOther

PrimeMovers

Each generator struct contains a field for prime_mover::PrimeMovers where PrimeMovers are intended to reflect the options denoted by EIA form 923. Specifically, PrimeMovers is an enumerated type with the following options:

EnumNameDescription
BAEnergy Storage, Battery
BTTurbines Used in a Binary Cycle (including those used for geothermal applications)
CACombined-Cycle – Steam Part
CCCombined-Cycle - Aggregated Plant *augmentation of EIA
CEEnergy Storage, Compressed Air
CPEnergy Storage, Concentrated Solar Power
CSCombined-Cycle Single-Shaft Combustion turbine and steam turbine share a single generator
CTCombined-Cycle Combustion Turbine Part
ESEnergy Storage, Other
FCFuel Cell
FWEnergy Storage, Flywheel
GTCombustion (Gas) Turbine (including jet engine design)
HAHydrokinetic, Axial Flow Turbine
HBHydrokinetic, Wave Buoy
HKHydrokinetic, Other
HYHydraulic Turbine (including turbines associated with delivery of water by pipeline)
ICInternal Combustion (diesel, piston, reciprocating) Engine
PSEnergy Storage, Reversible Hydraulic Turbine (Pumped Storage)
OTOther
STSteam Turbine (including nuclear, geothermal and solar steam; does not include combined-cycle turbine)
PVPhotovoltaic *renaming from EIA PV to PVe to avoid conflict with ACBusType.PV
WTWind Turbine, Onshore
WSWind Turbine, Offshore

ACBusTypes

ACBusTypes is used to denote which quantities are specified for load flow calculations and to otherwise categorize buses for modeling activities.

EnumNameDescription
ISOLATEDDisconnected from network
PQActive and reactive power defined (load bus)
PVActive power and voltage magnitude defined (generator bus)
REFReference bus (θ = 0)
SLACKSlack bus

AngleUnits

EnumName
DEGREES
RADIANS

StateTypes

StateTypes are used to denote the type of dynamic equation a specific state is subject to in PowerSimulationsDynamics.jl

EnumNameDescription
DifferentialState evolves over time via a differential equation $\dot{x} = f(x)$
AlgebraicState evolves over time by satisfying an algebraic equation $0 = g(x)$
HybridDepending on specific parameters, the state can be Differential or Algebraic
diff --git a/dev/modeler_guide/example_dynamic_data/index.html b/dev/modeler_guide/example_dynamic_data/index.html index bbbc5c1f2d..c2afe8e62e 100644 --- a/dev/modeler_guide/example_dynamic_data/index.html +++ b/dev/modeler_guide/example_dynamic_data/index.html @@ -1,2 +1,2 @@ -Dynamic Devices · PowerSystems.jl
Edit on GitHub

Dynamic Devices

Each sub-type is composed of the corresponding dynamic components that define the model. As a result, it is possible to flexibly define dynamic data models and methods according to the analysis requirements. DynamicInjection components use parametric a parametric type pattern to materialize the full specification of the dynamic injection model with parameters. This design enable the use of parametric methods to specify the mathematical model of the dynamic components separately.

DynamicInjection components also implement some additional information useful for the modeling like the usual states assumed by the model and the number. These values are derived from the documentation associated with the model, for instance PSS/e models provide parameters, states and variables. Although PowerSystems.jl doesn't assume a specific mathematical model for the components, the default values for these parameters are derived directly from the data model source.

Dynamic Generator

Each generator is a data structure that is defined by the following components:

Each inverter is a data structure that is defined by the following components:

  • DC Source: Defines the dynamics of the DC side of the converter.
  • Frequency Estimator: That describes how the frequency of the grid can be estimated using the grid voltages. Typically a phase-locked loop (PLL).
  • Outer Loop Control: That describes the active and reactive power control dynamics.
  • Inner Loop Control: That can describe virtual impedance, voltage control and current control dynamics.
  • Converter: That describes the dynamics of the pulse width modulation (PWM) or space vector modulation (SVM).
  • Filter: Used to connect the converter output to the grid.

⠀

+Dynamic Devices · PowerSystems.jl
Edit on GitHub

Dynamic Devices

Each sub-type is composed of the corresponding dynamic components that define the model. As a result, it is possible to flexibly define dynamic data models and methods according to the analysis requirements. DynamicInjection components use parametric a parametric type pattern to materialize the full specification of the dynamic injection model with parameters. This design enable the use of parametric methods to specify the mathematical model of the dynamic components separately.

DynamicInjection components also implement some additional information useful for the modeling like the usual states assumed by the model and the number. These values are derived from the documentation associated with the model, for instance PSS/e models provide parameters, states and variables. Although PowerSystems.jl doesn't assume a specific mathematical model for the components, the default values for these parameters are derived directly from the data model source.

Dynamic Generator

Each generator is a data structure that is defined by the following components:

Each inverter is a data structure that is defined by the following components:

  • DC Source: Defines the dynamics of the DC side of the converter.
  • Frequency Estimator: That describes how the frequency of the grid can be estimated using the grid voltages. Typically a phase-locked loop (PLL).
  • Outer Loop Control: That describes the active and reactive power control dynamics.
  • Inner Loop Control: That can describe virtual impedance, voltage control and current control dynamics.
  • Converter: That describes the dynamics of the pulse width modulation (PWM) or space vector modulation (SVM).
  • Filter: Used to connect the converter output to the grid.

⠀

diff --git a/dev/modeler_guide/glossary/index.html b/dev/modeler_guide/glossary/index.html index 92dee67a45..26685fddbe 100644 --- a/dev/modeler_guide/glossary/index.html +++ b/dev/modeler_guide/glossary/index.html @@ -1,2 +1,2 @@ -Glossary and Acronyms · PowerSystems.jl
Edit on GitHub

Glossary and Acronyms

A | D | E | F | H | I | O | P | R | S | V | Z

A

  • AC: Alternating current

  • ACE: Area control error

  • AGC: Automatic generation control

  • AVR: Automatic Voltage Regulator

D

  • DC: Direct current

  • DERA1:

  • Dynamic: Refers to data and simulations for power system transient simulations using differential equations. Common examples include signal stability analysis to verify the power system will maintain stability in the few seconds following an unexpected fault or generator trip. For contrast, see the definition for Static data.

E

  • EMF: Electromotive force

  • ESAC: IEEE Type AC Excitation System model

  • ESDC: IEEE Type DC Excitation System model

  • EXAC: IEEE Type AC Excitation System (modified) model

  • EXPIC: Proportional/Integral Excitation System from PSS/E

  • EXST: IEEE Type ST (Static) Excitation System model

  • EX4VSA: IEEE Excitation System for Voltage Security Assessment with Over-Excitation Limits.

F

  • Forecast: Predicted values of a time-varying quantity that commonly features a look-ahead and can have multiple data values representing each time period. This data is used in simulation with receding horizons or data generated from forecasting algorithms. See the article on Time Series Data.

  • Forecast window: Represents the forecasted value starting at a particular initial time. See the article on Time Series Data.

H

  • Horizon: Is the count of discrete values in a forecast, all horizons in PowerSystems.jl are represented with Int. For instance, many Day-ahead markets will have a forecast with a horizon 24. See the article on Time Series Data.

  • HVDC: High-voltage DC

I

  • IEEET: IEEE Type I Excitation System.

  • Injector or Injection: Injectors refer to models that represent how a generator or storage device injects power or current into the power system. Loads are negative injectors. In PowerSystems.jl, some components can accept data for both StaticInjection and DynamicInjection models for both static and dynamic modeling.

  • Interval: The period of time between forecast initial times. In PowerSystems.jl all intervals are represented using Dates.Period types. For instance, in a Day-Ahead market simulation, the interval is usually Hour(24).

  • Initial time: The first time-stamp in a forecast. See the article on Time Series Data.

  • IPC: Interconnecting power converter

O

  • OEL:

P

  • PLL: Phase-locked loop

  • PSS: Power System Stabilizer

  • PSSE or PSS/E: Siemen's PSS&reg;E Power Simulator

  • PPA: Power purchase agreement

  • PSID:

  • PSLF:

  • pu or p.u.: Per-unit

R

  • REECB1:

  • REPCA1:

  • Resolution: The period of time between each discrete value in a time series. All resolutions are represented using Dates.Period types. For instance, a Day-ahead market data set usually has a resolution of Hour(1), a Real-Time market data set usually has a resolution of Minute(5).

S

  • SCRX: Bus Fed or Solid Fed Static Exciter

  • SEXS: Simplified Excitation System model from PSS/E

  • SIL: Surge impedance loading

  • States: Correspond to the set of inputs, outputs or variables, that evolve dynamically in PowerSimulationsDynamics.jl, commonly via a differential-algebraic system of equations. In PowerSystems.jl, a component associated to a DynamicInjector (for example an AVR) specifies the set of states that specific component requires to be modeled accurately.

  • Static: Typically refers to steady state data or models where the power system and each of its components are assumed to be operating at a steady state equilibrium point. This includes both power flow data for a single time point simulation as well as quasi-static time series data and models, where the power system is at an equilibrium point at each time step. Static data can be used as the input to single time point power flow models and production cost models with, for example, 5-minute, 15-minute, or 1-hour Resolution. For contrast, see the definition for Dynamic data.

  • STAB: Speed Sensitive Stabilizing PSS Model

V

  • VSCDCLine: Voltage-Source Converter Direct Current Line

  • VSM:

Z

  • ZIP load: A ZIP load model accounts for the voltage-dependency of a load and is primarily used for dynamics modeling. It includes three kinds of load: constant impedance (Z), constant current (I), and constant power (P), though many dynamics models just use the constant impedance model. StandardLoad and ExponentialLoad are both ZIP load models: StandardLoad breaks up the load into each of its three components, while ExponentialLoad expresses the load as an exponential equation.
+Glossary and Acronyms · PowerSystems.jl
Edit on GitHub

Glossary and Acronyms

A | D | E | F | H | I | O | P | R | S | V | Z

A

  • AC: Alternating current

  • ACE: Area control error

  • AGC: Automatic generation control

  • AVR: Automatic Voltage Regulator

D

  • DC: Direct current

  • DERA1:

  • Dynamic: Refers to data and simulations for power system transient simulations using differential equations. Common examples include signal stability analysis to verify the power system will maintain stability in the few seconds following an unexpected fault or generator trip. For contrast, see the definition for Static data.

E

  • EMF: Electromotive force

  • ESAC: IEEE Type AC Excitation System model

  • ESDC: IEEE Type DC Excitation System model

  • EXAC: IEEE Type AC Excitation System (modified) model

  • EXPIC: Proportional/Integral Excitation System from PSS/E

  • EXST: IEEE Type ST (Static) Excitation System model

  • EX4VSA: IEEE Excitation System for Voltage Security Assessment with Over-Excitation Limits.

F

  • Forecast: Predicted values of a time-varying quantity that commonly features a look-ahead and can have multiple data values representing each time period. This data is used in simulation with receding horizons or data generated from forecasting algorithms. See the article on Time Series Data.

  • Forecast window: Represents the forecasted value starting at a particular initial time. See the article on Time Series Data.

H

  • Horizon: Is the count of discrete values in a forecast, all horizons in PowerSystems.jl are represented with Int. For instance, many Day-ahead markets will have a forecast with a horizon 24. See the article on Time Series Data.

  • HVDC: High-voltage DC

I

  • IEEET: IEEE Type I Excitation System.

  • Injector or Injection: Injectors refer to models that represent how a generator or storage device injects power or current into the power system. Loads are negative injectors. In PowerSystems.jl, some components can accept data for both StaticInjection and DynamicInjection models for both static and dynamic modeling.

  • Interval: The period of time between forecast initial times. In PowerSystems.jl all intervals are represented using Dates.Period types. For instance, in a Day-Ahead market simulation, the interval is usually Hour(24).

  • Initial time: The first time-stamp in a forecast. See the article on Time Series Data.

  • IPC: Interconnecting power converter

O

  • OEL:

P

  • PLL: Phase-locked loop

  • PSS: Power System Stabilizer

  • PSSE or PSS/E: Siemen's PSS&reg;E Power Simulator

  • PPA: Power purchase agreement

  • PSID:

  • PSLF:

  • pu or p.u.: Per-unit

R

  • REECB1:

  • REPCA1:

  • Resolution: The period of time between each discrete value in a time series. All resolutions are represented using Dates.Period types. For instance, a Day-ahead market data set usually has a resolution of Hour(1), a Real-Time market data set usually has a resolution of Minute(5).

S

  • SCRX: Bus Fed or Solid Fed Static Exciter

  • SEXS: Simplified Excitation System model from PSS/E

  • SIL: Surge impedance loading

  • States: Correspond to the set of inputs, outputs or variables, that evolve dynamically in PowerSimulationsDynamics.jl, commonly via a differential-algebraic system of equations. In PowerSystems.jl, a component associated to a DynamicInjector (for example an AVR) specifies the set of states that specific component requires to be modeled accurately.

  • Static: Typically refers to steady state data or models where the power system and each of its components are assumed to be operating at a steady state equilibrium point. This includes both power flow data for a single time point simulation as well as quasi-static time series data and models, where the power system is at an equilibrium point at each time step. Static data can be used as the input to single time point power flow models and production cost models with, for example, 5-minute, 15-minute, or 1-hour Resolution. For contrast, see the definition for Dynamic data.

  • STAB: Speed Sensitive Stabilizing PSS Model

V

  • VSCDCLine: Voltage-Source Converter Direct Current Line

  • VSM:

Z

  • ZIP load: A ZIP load model accounts for the voltage-dependency of a load and is primarily used for dynamics modeling. It includes three kinds of load: constant impedance (Z), constant current (I), and constant power (P), though many dynamics models just use the constant impedance model. StandardLoad and ExponentialLoad are both ZIP load models: StandardLoad breaks up the load into each of its three components, while ExponentialLoad expresses the load as an exponential equation.
diff --git a/dev/modeler_guide/market_bid_cost/index.html b/dev/modeler_guide/market_bid_cost/index.html index 1cbcd1829d..5172de3aa0 100644 --- a/dev/modeler_guide/market_bid_cost/index.html +++ b/dev/modeler_guide/market_bid_cost/index.html @@ -66,7 +66,7 @@ name = "variable_cost", data = data, resolution = Dates.Hour(1) - )Deterministic("variable_cost", DataStructures.SortedDict(Dates.DateTime("2020-01-01T00:00:00") => [[(0.0, 0.05), (290.1, 0.0733), (582.72, 0.0967), (894.1, 0.12)], [(0.0, 0.05), (300.1, 0.0733), (600.72, 0.0967), (900.1, 0.12)]]), Dates.Hour(1), nothing, InfrastructureSystems.InfrastructureSystemsInternal(UUID("122d277a-4cf4-46f9-8772-62bb16e2a96a"), nothing, nothing, nothing))

NOTE: Due to limitations in DataStructures.jl, in PowerSystems.jl when creating Forecasts or TimeSeries for your MarketBidCost, you need to define your data as in the example or with a very explicit container. Otherwise, it won't discern the types properly in the constructor and will return SortedDict{Any,Any,Base.Order.ForwardOrdering} which causes the constructor in PowerSystems.jl to fail. For instance, you need to define the Dict with the data as follows:

    # Very verbose dict definition
+       )Deterministic("variable_cost", DataStructures.SortedDict(Dates.DateTime("2020-01-01T00:00:00") => [[(0.0, 0.05), (290.1, 0.0733), (582.72, 0.0967), (894.1, 0.12)], [(0.0, 0.05), (300.1, 0.0733), (600.72, 0.0967), (900.1, 0.12)]]), Dates.Hour(1), nothing, InfrastructureSystems.InfrastructureSystemsInternal(UUID("f24f58de-7889-401a-8472-115616301ea2"), nothing, nothing, nothing))

NOTE: Due to limitations in DataStructures.jl, in PowerSystems.jl when creating Forecasts or TimeSeries for your MarketBidCost, you need to define your data as in the example or with a very explicit container. Otherwise, it won't discern the types properly in the constructor and will return SortedDict{Any,Any,Base.Order.ForwardOrdering} which causes the constructor in PowerSystems.jl to fail. For instance, you need to define the Dict with the data as follows:

    # Very verbose dict definition
     data = Dict{DateTime,Array{Array{Tuple{Float64,Float64},1},1}}()
     for t in range(initial_time_sys; step = Hour(1), length = window_count)
         data[t] = MY_BID_DATA
@@ -109,4 +109,4 @@
            name = get_name(service),
            data = data,
            resolution = Dates.Hour(1)
-       )Deterministic("example_reserve", DataStructures.SortedDict(Dates.DateTime("2020-01-01T00:00:00") => [650.3, 750.0]), Dates.Hour(1), nothing, InfrastructureSystems.InfrastructureSystemsInternal(UUID("89a2c646-9589-4f08-a1db-6e0590ccbff7"), nothing, nothing, nothing))
julia> set_service_bid!(sys, generator, service, time_series_data)ERROR: TypeError: in set_service_bid!, expected PiecewiseStepData, got Type{Float64}
+ )Deterministic("example_reserve", DataStructures.SortedDict(Dates.DateTime("2020-01-01T00:00:00") => [650.3, 750.0]), Dates.Hour(1), nothing, InfrastructureSystems.InfrastructureSystemsInternal(UUID("ceb8a459-03e0-44a0-b853-fc3ac3bdc2e7"), nothing, nothing, nothing))
julia> set_service_bid!(sys, generator, service, time_series_data)ERROR: TypeError: in set_service_bid!, expected PiecewiseStepData, got Type{Float64} diff --git a/dev/modeler_guide/modeling_with_JuMP/index.html b/dev/modeler_guide/modeling_with_JuMP/index.html index e234e65243..3a397e3c8d 100644 --- a/dev/modeler_guide/modeling_with_JuMP/index.html +++ b/dev/modeler_guide/modeling_with_JuMP/index.html @@ -1,9 +1,9 @@ Modeling with JuMP · PowerSystems.jl
Edit on GitHub

Modeling with JuMP

This page shows a minimal example of PowerSystems.jl used to develop and Economic Dispatch model. The code shows the stages to develop modeling code

  1. Make the data set from power flow and time series data,
  2. Serialize the data,
  3. Pass the data and algorithm to the model.

One of the main uses of `PowerSystems.jl is not having re-run the data generation for every model execution. The model code shows an example of populating the constraints and cost functions using accessor functions inside the model function. The example concludes by reading the data created earlier and passing the algorithm with the data.

julia> using PowerSystems
julia> const PSY = PowerSystemsPowerSystems
julia> using JuMP
julia> using Ipopt
julia> using PowerSystemCaseBuilder

The first step is to load the test data used throughout the rest of these tutorials (or set DATA_DIR as appropriate if it already exists).

julia> system_data =  build_system(PSISystems, "c_sys5_pjm")┌ Info: Building new system c_sys5_pjm from raw data
 └   sys_descriptor.raw_data = "/home/runner/.julia/artifacts/906591a156d0f786940f105e4f6aeceffefa7a2e/PowerSystemsTestData-3.0/psy_data/data_5bus_pu.jl"
-[ Info: Serialized time series data to /home/runner/.julia/packages/PowerSystemCaseBuilder/2fYQI/data/serialized_system/614e094ea985a55912fc1321256a49b755f9fc451c0f264f24d6d04af20e84d7/c_sys5_pjm_time_series_storage.h5.
-[ Info: Serialized System to /home/runner/.julia/packages/PowerSystemCaseBuilder/2fYQI/data/serialized_system/614e094ea985a55912fc1321256a49b755f9fc451c0f264f24d6d04af20e84d7/c_sys5_pjm.json
-[ Info: Serialized System metadata to /home/runner/.julia/packages/PowerSystemCaseBuilder/2fYQI/data/serialized_system/614e094ea985a55912fc1321256a49b755f9fc451c0f264f24d6d04af20e84d7/c_sys5_pjm_metadata.json
+[ Info: Serialized time series data to /home/runner/.julia/packages/PowerSystemCaseBuilder/FfGSY/data/serialized_system/614e094ea985a55912fc1321256a49b755f9fc451c0f264f24d6d04af20e84d7/c_sys5_pjm_time_series_storage.h5.
+[ Info: Serialized System to /home/runner/.julia/packages/PowerSystemCaseBuilder/FfGSY/data/serialized_system/614e094ea985a55912fc1321256a49b755f9fc451c0f264f24d6d04af20e84d7/c_sys5_pjm.json
+[ Info: Serialized System metadata to /home/runner/.julia/packages/PowerSystemCaseBuilder/FfGSY/data/serialized_system/614e094ea985a55912fc1321256a49b755f9fc451c0f264f24d6d04af20e84d7/c_sys5_pjm_metadata.json
 System
 ┌───────────────────┬─────────────┐
 │ Property          │ Value       │
@@ -69,4 +69,4 @@
                    )
            optimize!(ed_m)
            return ed_m
-       ended_model (generic function with 1 method)
julia> results = ed_model(system_data, Ipopt.Optimizer)ERROR: UndefVarError: `get_cost` not defined
+ ended_model (generic function with 1 method)
julia> results = ed_model(system_data, Ipopt.Optimizer)ERROR: UndefVarError: `get_cost` not defined diff --git a/dev/modeler_guide/parsing/index.html b/dev/modeler_guide/parsing/index.html index ebed7cf8f2..85e9f61f9b 100644 --- a/dev/modeler_guide/parsing/index.html +++ b/dev/modeler_guide/parsing/index.html @@ -223,4 +223,4 @@ timeseries_metadata_file = timeseries_metadata_file, generator_mapping_file = generator_mapping_file, ) -sys = System(data, time_series_in_memory = true)

Examples configuration files can be found in the RTS-GMLC repo:

CSV Data Configurations

Custom construction of generators

PowerSystems supports custom construction of subtypes of the abstract type Generator based on fuel and type. The parsing code detects these fields in the raw data and then constructs the concrete type listed in the passed generator mapping file. The default file is src/parsers/generator_mapping.yaml. You can override this behavior by specifying your own file when constructing PowerSystemTableData.

Column names

PowerSystems provides am input mapping capability that allows you to keep your own column names.

For example, when parsing raw data for a generator the code expects a column called name. If the raw data instead defines that column as GEN UID then you can change the custom_name field under the generator category to GEN UID in your YAML file.

To enable the parsing of a custom set of csv files, you can generate a configuration file (such as user_descriptors.yaml) from the defaults, which are stored in src/descriptors/power_system_inputs.json.

python ./bin/generate_config_file.py ./user_descriptors.yaml

Next, edit this file with your customizations.

Note that the user-specific customizations are stored in YAML rather than JSON to allow for easier editing. The next few sections describe changes you can make to this YAML file. Do not edit the default JSON file.

Per-unit conversion

For more info on the per-unit conventions in PowerSystems.jl, refer to the per-unit section of the system documentation.

PowerSystems defines whether it expects a column value to be per-unit system base, per-unit device base, or natural units in power_system_inputs.json. If it expects a per-unit convention that differs from your values then you can set the unit_system in user_descriptors.yaml and PowerSystems will automatically convert the values. For example, if you have a max_active_power value stored in natural units (MW), but power_system_inputs.json specifies unit_system: device_base, you can enter unit_system: natural_units in user_descriptors.yaml and PowerSystems will divide the value by the value of the corresponding entry in the column identified by the base_reference field in power_system_inputs.json. You can also override the base_reference setting by adding base_reference: My Column to make device base per-unit conversion by dividing the value by the entry in My Column. System base per-unit conversions always divide the value by the system base_power value instantiated when constructing a System.

Unit conversion

PowerSystems provides a limited set of unit conversions. For example, if power_system_inputs.json indicates that a value's unit is degrees but your values are in radians then you can set unit: radian in your YAML file. Other valid unit entries include GW, GWh, MW, MWh, kW, and kWh.

+sys = System(data, time_series_in_memory = true)

Examples configuration files can be found in the RTS-GMLC repo:

CSV Data Configurations

Custom construction of generators

PowerSystems supports custom construction of subtypes of the abstract type Generator based on fuel and type. The parsing code detects these fields in the raw data and then constructs the concrete type listed in the passed generator mapping file. The default file is src/parsers/generator_mapping.yaml. You can override this behavior by specifying your own file when constructing PowerSystemTableData.

Column names

PowerSystems provides am input mapping capability that allows you to keep your own column names.

For example, when parsing raw data for a generator the code expects a column called name. If the raw data instead defines that column as GEN UID then you can change the custom_name field under the generator category to GEN UID in your YAML file.

To enable the parsing of a custom set of csv files, you can generate a configuration file (such as user_descriptors.yaml) from the defaults, which are stored in src/descriptors/power_system_inputs.json.

python ./bin/generate_config_file.py ./user_descriptors.yaml

Next, edit this file with your customizations.

Note that the user-specific customizations are stored in YAML rather than JSON to allow for easier editing. The next few sections describe changes you can make to this YAML file. Do not edit the default JSON file.

Per-unit conversion

For more info on the per-unit conventions in PowerSystems.jl, refer to the per-unit section of the system documentation.

PowerSystems defines whether it expects a column value to be per-unit system base, per-unit device base, or natural units in power_system_inputs.json. If it expects a per-unit convention that differs from your values then you can set the unit_system in user_descriptors.yaml and PowerSystems will automatically convert the values. For example, if you have a max_active_power value stored in natural units (MW), but power_system_inputs.json specifies unit_system: device_base, you can enter unit_system: natural_units in user_descriptors.yaml and PowerSystems will divide the value by the value of the corresponding entry in the column identified by the base_reference field in power_system_inputs.json. You can also override the base_reference setting by adding base_reference: My Column to make device base per-unit conversion by dividing the value by the entry in My Column. System base per-unit conversions always divide the value by the system base_power value instantiated when constructing a System.

Unit conversion

PowerSystems provides a limited set of unit conversions. For example, if power_system_inputs.json indicates that a value's unit is degrees but your values are in radians then you can set unit: radian in your YAML file. Other valid unit entries include GW, GWh, MW, MWh, kW, and kWh.

diff --git a/dev/modeler_guide/system/index.html b/dev/modeler_guide/system/index.html index 13fd2f8e10..b31cd566df 100644 --- a/dev/modeler_guide/system/index.html +++ b/dev/modeler_guide/system/index.html @@ -502,4 +502,4 @@ └─────────────────┴───────────┴──────────────┴────────────────┘

Per-unit conventions and data conversions

It is often useful to express power systems data in relative terms using per-unit conventions. PowerSystems.jl supports the automatic conversion of data between three different unit systems:

  1. Natural Units: The naturally defined units of each parameter (typically MW).
  2. System Base: Parameter values are divided by the system base_power.
  3. Device Base: Parameter values are divided by the device base_mva.

To see the unit system setting of a System:

julia> get_units_base(system)"SYSTEM_BASE"

To change the unit system setting of a System:

julia> set_units_base_system!(system, "DEVICE_BASE")[ Info: Unit System changed to UnitSystem.DEVICE_BASE = 1

The units of the parameter values stored in each struct are defined in src/descriptors/power_system_structs.json. Conversion between unit systems does not change the stored parameter values. Instead, unit system conversions are made when accessing parameters using the accessor functions (see above), thus making it imperative to utilize the accessor functions instead of the "dot" accessor methods to ensure the return of the correct values.

JSON Serialization

PowerSystems.jl provides functionality to serialize an entire system to a JSON file and then deserialize it back to a system. The main benefit is that deserializing is significantly faster than reconstructing the system from raw data files.

The function that serializes the system to_json requires the system and a file name

to_json(system, "system.json")

The serialization process stores 3 files

  1. System data file (*.json file)
  2. Validation data file (*.json file)
  3. Time Series data file (*.h5 file)

To deserialize:

system2 = System("system.json")

PowerSystems generates UUIDs for the System and all components in order to have a way to uniquely identify objects. During deserialization it restores the same UUIDs. If you will modify the System or components after deserialization then it is recommended that you set this flag to generate new UUIDs.

system2 = System("system.json", assign_new_uuids = true)

Reducing REPL printing

By default PowerSystems.jl outputs to the REPL all Logging values, this can be overwhelming in some cases. Use configure_logging to create a logger with your preferences (console and/or file, levels, etc.). For more detail refer to Logging.

Example: Set log output to only error messages

using PowerSystems
 using Logging
 configure_logging(console_level = Logging.Error)

Note: log messages are not automatically flushed to files. Call flush(logger) to make this happen.

Refer to this page for more logging configuration options. Note that it describes how to enable debug logging for some log messages but not others.

Viewing PowerSystems Data in JSON Format

PowerSystems data can be serialized and deserialized in JSON. This section shows how to explore the data outside of Julia using.

system = System("system.json")

It can be useful to view and filter the PowerSystems data in this format. There are many tools available to browse JSON data.

Here is an example GUI tool that is available online in a browser.

The command line utility jq offers even more features. The rest of this document provides example commands.

jq . system.json
jq '.data.components | .[] | .__metadata__ | .type' system.json | sort | uniq
jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard")' system.json
# There is almost certainly a better way.
-jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard")' system.json | grep -c ThermalStandard
jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard" and .name == "107_CC_1")' system.json
jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard" and .active_power > 2.3)' system.json
+jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard")' system.json | grep -c ThermalStandard
jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard" and .name == "107_CC_1")' system.json
jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard" and .active_power > 2.3)' system.json
diff --git a/dev/modeler_guide/system_dynamic_data/index.html b/dev/modeler_guide/system_dynamic_data/index.html index 53944c2839..16892c5476 100644 --- a/dev/modeler_guide/system_dynamic_data/index.html +++ b/dev/modeler_guide/system_dynamic_data/index.html @@ -80,16 +80,16 @@ eq_p = 0.7087, ) - #ShaftBaseMachine(0.0, 0.2995, 0.7087, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(UUID("4cfaaeef-974a-4f1a-b93d-622a4939e646"), nothing, nothing, nothing))
julia> shaft_damping = SingleMass( + #ShaftBaseMachine(0.0, 0.2995, 0.7087, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(UUID("5555c3d9-e1b0-4b10-8718-1774230c5acc"), nothing, nothing, nothing))
julia> shaft_damping = SingleMass( H = 3.148, D = 2.0, ) - #AVRSingleMass(3.148, 2.0, Dict{String, Any}(), [:δ, :ω], 2, InfrastructureSystems.InfrastructureSystemsInternal(UUID("4e5c11c3-334c-4326-96fa-b6ce21f1c26d"), nothing, nothing, nothing))
julia> avr_none = AVRFixed(Vf = 0.0) + #AVRSingleMass(3.148, 2.0, Dict{String, Any}(), [:δ, :ω], 2, InfrastructureSystems.InfrastructureSystemsInternal(UUID("772d7b49-d053-4a17-a0f4-b2c4dbf17e8f"), nothing, nothing, nothing))
julia> avr_none = AVRFixed(Vf = 0.0) - #TurbineGovernorAVRFixed(0.0, 1.0, Dict{String, Any}(), Symbol[], 0, StateTypes[], InfrastructureSystems.InfrastructureSystemsInternal(UUID("30187787-f874-4b56-a30c-abaf33fc7295"), nothing, nothing, nothing))
julia> tg_none = TGFixed(efficiency = 1.0) + #TurbineGovernorAVRFixed(0.0, 1.0, Dict{String, Any}(), Symbol[], 0, StateTypes[], InfrastructureSystems.InfrastructureSystemsInternal(UUID("44ddeb6e-dddf-4e05-878b-573bfa2b7f02"), nothing, nothing, nothing))
julia> tg_none = TGFixed(efficiency = 1.0) - #PSSTGFixed(1.0, 1.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(UUID("2cba7236-01a6-4663-9397-b8b100fda030"), nothing, nothing, nothing))
julia> pss_none = PSSFixed(V_pss = 0.0);

Then we can collect all the dynamic components and create the dynamic generator and assign it to a static generator of choice. In this example we will add it to the generator "generator-102-1" as follows:

julia> #Collect the static gen in the system
+       #PSSTGFixed(1.0, 1.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(UUID("e8f82110-2027-4606-aa7e-0722d0e3c432"), nothing, nothing, nothing))
julia> pss_none = PSSFixed(V_pss = 0.0);

Then we can collect all the dynamic components and create the dynamic generator and assign it to a static generator of choice. In this example we will add it to the generator "generator-102-1" as follows:

julia> #Collect the static gen in the system
        static_gen = get_component(Generator, omib_sys, "generator-102-1")
        #Creates the dynamic generatorThermalStandard: generator-102-1:
    name: generator-102-1
@@ -246,7 +246,7 @@
        
        #Define DC Source as a FixedSource:VoltageModeControl(0.59, 736.0, 0.0, 0.0, 0.2, 1.27, 14.3, 0.0, 50.0, 0.2, Dict{String, Any}(), [:ξd_ic, :ξq_ic, :γd_ic, :γq_ic, :ϕd_ic, :ϕq_ic], 6)
julia> dc_source_lv = FixedDCSource(voltage = 600.0)
        
-       #Define a Frequency Estimator as a PLL based on Vikram Kaura and Vladimir Blaskoc 1997 paper:FixedDCSource(600.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(UUID("72eadc90-c6eb-413d-b352-cbd732d53507"), nothing, nothing, nothing))
julia> pll = KauraPLL(
+       #Define a Frequency Estimator as a PLL based on Vikram Kaura and Vladimir Blaskoc 1997 paper:FixedDCSource(600.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(UUID("f8614ce7-a047-4312-a9cf-ad28d24ef7bc"), nothing, nothing, nothing))
julia> pll = KauraPLL(
            ω_lp = 500.0, #Cut-off frequency for LowPass filter of PLL filter.
            kp_pll = 0.084,  #PLL proportional gain
            ki_pll = 4.69,   #PLL integral gain
@@ -263,12 +263,12 @@
            Tq0_p = 0.6,
        )
        
-       #ShaftOneDOneQMachine(0.0, 1.3125, 1.2578, 0.1813, 0.25, 5.89, 0.6, Dict{String, Any}(), [:eq_p, :ed_p], 2, InfrastructureSystems.InfrastructureSystemsInternal(UUID("d15a1473-a82d-4cc6-8fd7-1863edb9057f"), nothing, nothing, nothing))
julia> shaft_no_damping = SingleMass(
+       #ShaftOneDOneQMachine(0.0, 1.3125, 1.2578, 0.1813, 0.25, 5.89, 0.6, Dict{String, Any}(), [:eq_p, :ed_p], 2, InfrastructureSystems.InfrastructureSystemsInternal(UUID("260407a5-40a4-40a8-914f-db551e547efa"), nothing, nothing, nothing))
julia> shaft_no_damping = SingleMass(
            H = 3.01,
            D = 0.0,
        )
        
-       #AVR: Type I: Resembles a DC1 AVRSingleMass(3.01, 0.0, Dict{String, Any}(), [:δ, :ω], 2, InfrastructureSystems.InfrastructureSystemsInternal(UUID("d0e8e1b5-62dc-42ac-85f4-bb7ee0bbbe21"), nothing, nothing, nothing))
julia> avr_type1 = AVRTypeI(
+       #AVR: Type I: Resembles a DC1 AVRSingleMass(3.01, 0.0, Dict{String, Any}(), [:δ, :ω], 2, InfrastructureSystems.InfrastructureSystemsInternal(UUID("b83058c1-a86c-4742-b4ec-916fbb3d8c67"), nothing, nothing, nothing))
julia> avr_type1 = AVRTypeI(
            Ka = 20.0,
            Ke = 0.01,
            Kf = 0.063,
@@ -281,9 +281,9 @@
            Be = 1.555, #2nd ceiling coefficient
        )
        
-       #No TGAVRTypeI(20.0, 0.01, 0.063, 0.2, 0.314, 0.35, 0.001, (min = -5.0, max = 5.0), 0.0039, 1.555, 1.0, Dict{String, Any}(), [:Vf, :Vr1, :Vr2, :Vm], 4, StateTypes[StateTypes.Differential = 1, StateTypes.Differential = 1, StateTypes.Differential = 1, StateTypes.Differential = 1], InfrastructureSystems.InfrastructureSystemsInternal(UUID("8864ed48-f87f-4544-bf89-33b7bc7e3707"), nothing, nothing, nothing))
julia> tg_none = TGFixed(efficiency = 1.0)
+       #No TGAVRTypeI(20.0, 0.01, 0.063, 0.2, 0.314, 0.35, 0.001, (min = -5.0, max = 5.0), 0.0039, 1.555, 1.0, Dict{String, Any}(), [:Vf, :Vr1, :Vr2, :Vm], 4, StateTypes[StateTypes.Differential = 1, StateTypes.Differential = 1, StateTypes.Differential = 1, StateTypes.Differential = 1], InfrastructureSystems.InfrastructureSystemsInternal(UUID("d841976b-69a3-4e23-9744-f6fc3301aecc"), nothing, nothing, nothing))
julia> tg_none = TGFixed(efficiency = 1.0)
        
-       #No PSSTGFixed(1.0, 1.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(UUID("022f3b95-8f49-4e97-9648-bfad1119020b"), nothing, nothing, nothing))
julia> pss_none = PSSFixed(V_pss = 0.0);

Add the components to the System

julia> for g in get_components(Generator, threebus_sys)
+       #No PSSTGFixed(1.0, 1.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(UUID("f8a8cf96-5930-4de5-b269-07150862a666"), nothing, nothing, nothing))
julia> pss_none = PSSFixed(V_pss = 0.0);

Add the components to the System

julia> for g in get_components(Generator, threebus_sys)
            #Find the generator at bus 102
            if get_number(get_bus(g)) == 102
                #Create the dynamic generator
@@ -348,4 +348,4 @@
 │ DynamicGenerator{OneDOneQMachine, SingleMass, AVRTypeI, TGFixed, PSSFixed}   ⋯
 │ DynamicInverter{AverageConverter, OuterControl{VirtualInertia, ReactivePower ⋯
 └───────────────────────────────────────────────────────────────────────────────
-                                                               2 columns omitted

Finally we can seraliaze the system data for later reloading

to_json(threebus_sys, "YOUR_DIR/threebus_sys.json")
+ 2 columns omitted

Finally we can seraliaze the system data for later reloading

to_json(threebus_sys, "YOUR_DIR/threebus_sys.json")
diff --git a/dev/modeler_guide/time_series/index.html b/dev/modeler_guide/time_series/index.html index 18c4726357..1ff1af819b 100644 --- a/dev/modeler_guide/time_series/index.html +++ b/dev/modeler_guide/time_series/index.html @@ -99,4 +99,4 @@ "max_active_power", start_time = DateTime("2020-01-01T00:00:00"), ) - ta_static = get_time_series_array(SingleTimeSeries, component, "max_active_power")

Note: The actual type of the returned forecast will be DeterministicSingleTimeSeries. This type and Deterministic are subtypes of AbstractDeterministic and implement all of the same methods (i.e., they behave identically).

Time Series Validation

PowerSystems applies validation rules whenever users add time series to a System. It will throw an exception if any rule is violated.

  1. All time series data, static or forecasts, must have the same resolution.
  2. All forecasts must have identical parameters: initial timestamp, horizon, interval, look-ahead window count.

Static time series instances may have different start times and lengths.

Data Format

Refer to this page for details on how the time series data is stored in HDF5 files.

+ ta_static = get_time_series_array(SingleTimeSeries, component, "max_active_power")

Note: The actual type of the returned forecast will be DeterministicSingleTimeSeries. This type and Deterministic are subtypes of AbstractDeterministic and implement all of the same methods (i.e., they behave identically).

Time Series Validation

PowerSystems applies validation rules whenever users add time series to a System. It will throw an exception if any rule is violated.

  1. All time series data, static or forecasts, must have the same resolution.
  2. All forecasts must have identical parameters: initial timestamp, horizon, interval, look-ahead window count.

Static time series instances may have different start times and lengths.

Data Format

Refer to this page for details on how the time series data is stored in HDF5 files.

diff --git a/dev/modeler_guide/type_structure/index.html b/dev/modeler_guide/type_structure/index.html index 8ddefd10c2..c095cd4b04 100644 --- a/dev/modeler_guide/type_structure/index.html +++ b/dev/modeler_guide/type_structure/index.html @@ -1,2 +1,2 @@ -Type Structure · PowerSystems.jl
Edit on GitHub

Type Structure

The abstract hierarchy enables categorization of the devices by their operational characteristics and modeling requirements.

For instance, generation is classified by the distinctive data requirements for modeling in three categories: ThermalGen, RenewableGen, and HydroGen.

As a result of this design, developers can define model logic entirely based on abstract types and create generic code to support modeling technologies that are not yet implemented in the package.

PowerSystems.jl has a category Topology of topological components (e.g., ACBus, Arc), separate from the physical components.

The hierarchy also includes components absent in standard data models, such as services. The services category includes reserves, transfers and AGC. The power of PowerSystems.jl lies in providing the abstraction without an implicit mathematical representation of the component.

In the Basics tutorial, you can find a more detailed introduction to the type system and how to manipulate data.

⠀

+Type Structure · PowerSystems.jl
Edit on GitHub

Type Structure

The abstract hierarchy enables categorization of the devices by their operational characteristics and modeling requirements.

For instance, generation is classified by the distinctive data requirements for modeling in three categories: ThermalGen, RenewableGen, and HydroGen.

As a result of this design, developers can define model logic entirely based on abstract types and create generic code to support modeling technologies that are not yet implemented in the package.

PowerSystems.jl has a category Topology of topological components (e.g., ACBus, Arc), separate from the physical components.

The hierarchy also includes components absent in standard data models, such as services. The services category includes reserves, transfers and AGC. The power of PowerSystems.jl lies in providing the abstraction without an implicit mathematical representation of the component.

In the Basics tutorial, you can find a more detailed introduction to the type system and how to manipulate data.

⠀

diff --git a/dev/quick_start_guide/index.html b/dev/quick_start_guide/index.html index a7c558ee36..317828e924 100644 --- a/dev/quick_start_guide/index.html +++ b/dev/quick_start_guide/index.html @@ -379,4 +379,4 @@ └─────────────────────┴──────┘ 9 rows omitted
julia> time_series = SingleTimeSeries(name = "active_power", data = time_series_data_raw) - #Add the forecast to the system and componentSingleTimeSeries("active_power", 24×1 TimeSeries.TimeArray{Float64, 1, Dates.DateTime, Vector{Float64}} 2020-01-01T00:00:00 to 2020-01-01T23:00:00, Dates.Millisecond(3600000), nothing, InfrastructureSystems.InfrastructureSystemsInternal(UUID("7c2f9111-2bdf-4216-8b94-7b7192e0a7dd"), nothing, nothing, nothing))
julia> add_time_series!(system, new_renewable, time_series)ERROR: UndefVarError: `new_renewable` not defined + #Add the forecast to the system and componentSingleTimeSeries("active_power", 24×1 TimeSeries.TimeArray{Float64, 1, Dates.DateTime, Vector{Float64}} 2020-01-01T00:00:00 to 2020-01-01T23:00:00, Dates.Millisecond(3600000), nothing, InfrastructureSystems.InfrastructureSystemsInternal(UUID("03895e69-c921-41b3-a6e7-96388ed6f600"), nothing, nothing, nothing))
julia> add_time_series!(system, new_renewable, time_series)ERROR: UndefVarError: `new_renewable` not defined diff --git a/dev/search/index.html b/dev/search/index.html index 51acd74b08..57af41cddc 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · PowerSystems.jl

Loading search...

    +Search · PowerSystems.jl

    Loading search...

      diff --git a/dev/tutorials/add_cost_curve/index.html b/dev/tutorials/add_cost_curve/index.html index 09465bdc91..52bf0dddd6 100644 --- a/dev/tutorials/add_cost_curve/index.html +++ b/dev/tutorials/add_cost_curve/index.html @@ -25,4 +25,4 @@ vom_cost: LinearCurve (a type of InputOutputCurve) where function is: f(x) = 0.0 x + 0.0 fixed: 6.0 start_up: 2000.0 - shut_down: 1000.0

      This OperationalCost can be used when defining a component or added to an existing component using set_operation_cost!.

      + shut_down: 1000.0

      This OperationalCost can be used when defining a component or added to an existing component using set_operation_cost!.

      diff --git a/dev/tutorials/add_forecasts/index.html b/dev/tutorials/add_forecasts/index.html index c0b25f37ad..0023389fed 100644 --- a/dev/tutorials/add_forecasts/index.html +++ b/dev/tutorials/add_forecasts/index.html @@ -161,4 +161,4 @@ │ PowerLoad │ Component │ SingleTimeSeries │ StaticTimeSeries ⋯ │ RenewableDispatch │ Component │ SingleTimeSeries │ StaticTimeSeries ⋯ └───────────────────┴────────────────┴──────────────────┴─────────────────────── - 3 columns omitted + 3 columns omitted diff --git a/dev/tutorials/basics/index.html b/dev/tutorials/basics/index.html index f3beedce8f..74d3b19171 100644 --- a/dev/tutorials/basics/index.html +++ b/dev/tutorials/basics/index.html @@ -221,4 +221,4 @@ │ String │ String │ Dates.DateTime │ Dates.Millisecond │ Dates.Millisecond │ Dates.Second │ Int64 │ Dict{String, Any} │ ├──────────────────┼─────────────┼─────────────────────┼──────────────────────┼───────────────────────┼──────────────┼───────┼─────────────────────┤ │ Deterministic │ activepower │ 2024-01-02T00:00:00 │ 3600000 milliseconds │ 86400000 milliseconds │ 0 seconds │ 1 │ Dict{String, Any}() │ -└──────────────────┴─────────────┴─────────────────────┴──────────────────────┴───────────────────────┴──────────────┴───────┴─────────────────────┘

      We can access a specific time series for a specific component:

      julia> ta = get_time_series_array(Deterministic, loads[1], ts_names[1])ERROR: UndefVarError: `ts_names` not defined

      Or, we can just get the values of the time series:

      julia> ts = get_time_series_values(Deterministic, loads[1], ts_names[1])ERROR: UndefVarError: `ts_names` not defined
      +└──────────────────┴─────────────┴─────────────────────┴──────────────────────┴───────────────────────┴──────────────┴───────┴─────────────────────┘

      We can access a specific time series for a specific component:

      julia> ta = get_time_series_array(Deterministic, loads[1], ts_names[1])ERROR: UndefVarError: `ts_names` not defined

      Or, we can just get the values of the time series:

      julia> ts = get_time_series_values(Deterministic, loads[1], ts_names[1])ERROR: UndefVarError: `ts_names` not defined
      diff --git a/dev/tutorials/dynamic_data/index.html b/dev/tutorials/dynamic_data/index.html index 0b06540815..3f468a6dc7 100644 --- a/dev/tutorials/dynamic_data/index.html +++ b/dev/tutorials/dynamic_data/index.html @@ -1,2 +1,2 @@ -Use Dynamic Data · PowerSystems.jl
      Edit on GitHub
      +Use Dynamic Data · PowerSystems.jl
      Edit on GitHub
      diff --git a/dev/tutorials/modifying_data/index.html b/dev/tutorials/modifying_data/index.html index d0a83537e2..40387ec572 100644 --- a/dev/tutorials/modifying_data/index.html +++ b/dev/tutorials/modifying_data/index.html @@ -52,4 +52,4 @@ end to_json(c_sys5_pjm_da, "c_sys5_pjm_da.json") -to_json(c_sys5_pjm_rt, "c_sys5_pjm_rt.json") +to_json(c_sys5_pjm_rt, "c_sys5_pjm_rt.json") diff --git a/dev/tutorials/parse_powerflow_cases/index.html b/dev/tutorials/parse_powerflow_cases/index.html index 7e6c129189..cfae09b76b 100644 --- a/dev/tutorials/parse_powerflow_cases/index.html +++ b/dev/tutorials/parse_powerflow_cases/index.html @@ -268,4 +268,4 @@ │ StandardLoad │ 51 │ │ TapTransformer │ 15 │ │ ThermalStandard │ 160 │ -└─────────────────┴───────┘

      This data set does not contain any time series data. For this, check the next tutorial.

      +└─────────────────┴───────┘

      This data set does not contain any time series data. For this, check the next tutorial.

      diff --git a/dev/tutorials/parse_tabular_data/index.html b/dev/tutorials/parse_tabular_data/index.html index 73f8f7563c..d276187ec0 100644 --- a/dev/tutorials/parse_tabular_data/index.html +++ b/dev/tutorials/parse_tabular_data/index.html @@ -39,37 +39,32 @@ directory: /home/runner/.julia/artifacts/906591a156d0f786940f105e4f6aeceffefa7a2e/PowerSystemsTestData-3.0/RTS_GMLC timeseries_metadata_file: /home/runner/.julia/artifacts/906591a156d0f786940f105e4f6aeceffefa7a2e/PowerSystemsTestData-3.0/RTS_GMLC/timeseries_pointers.json base_power: 100.0 - PowerSystems.InputCategoryModule.InputCategory.BUS = 2: 73×15 DataFrame - PowerSystems.InputCategoryModule.InputCategory.BRANCH = 1: 120×14 DataFrame PowerSystems.InputCategoryModule.InputCategory.DC_BRANCH = 3: 1×60 DataFrame PowerSystems.InputCategoryModule.InputCategory.GENERATOR = 4: 158×58 DataFrame + PowerSystems.InputCategoryModule.InputCategory.RESERVE = 6: 7×7 DataFrame PowerSystems.InputCategoryModule.InputCategory.STORAGE = 8: 22×8 DataFrame - PowerSystems.InputCategoryModule.InputCategory.RESERVE = 6: 7×7 DataFrame

      Create a System

      Next, we'll create a System from the rawsys data. Since a System is predicated on a time series resolution and the rawsys data includes both 5-minute and 1-hour resolution time series, we also need to specify which time series we want to include in the System. The time_series_resolution kwarg filters to only include time series with a matching resolution.

      julia> sys = System(rawsys; time_series_resolution = Dates.Hour(1));[ Info: Unit System changed to UnitSystem.DEVICE_BASE = 1
+  PowerSystems.InputCategoryModule.InputCategory.BUS = 2:  73×15 DataFrame
+  PowerSystems.InputCategoryModule.InputCategory.BRANCH = 1:  120×14 DataFrame

      Create a System

      Next, we'll create a System from the rawsys data. Since a System is predicated on a time series resolution and the rawsys data includes both 5-minute and 1-hour resolution time series, we also need to specify which time series we want to include in the System. The time_series_resolution kwarg filters to only include time series with a matching resolution.

      julia> sys = System(rawsys; time_series_resolution = Dates.Hour(1));[ Info: Unit System changed to UnitSystem.DEVICE_BASE = 1
 ┌ Warning: Missing PowerSystems.InputCategoryModule.InputCategory.LOAD = 5 data.
 └ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:212
 ┌ Warning: User-defined column name Startup Ramp Rate MW/min is not in dataframe.
-└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1433
+└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1492
 ┌ Warning: User-defined column name Shutdown Ramp Rate MW/min is not in dataframe.
-└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1433
+└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1492
 ┌ Warning: User-defined column name Status at Start is not in dataframe.
-└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1433
+└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1492
 ┌ Warning: User-defined column name Time at Status is not in dataframe.
-└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1433
+└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1492
 ┌ Warning: User-defined column name Start Cost Cold is not in dataframe.
-└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1433
+└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1492
 ┌ Warning: User-defined column name Start Cost Warm is not in dataframe.
-└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1433
+└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1492
 ┌ Warning: User-defined column name Start Cost Hot is not in dataframe.
-└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1433
+└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1492
 ┌ Warning: User-defined column name Must Run is not in dataframe.
-└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1433
-ERROR: MethodError: no method matching iterate(::PiecewiseLinearData)
+└ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:1492
+ERROR: MethodError: no method matching create_pwl_cost(::PowerSystemTableData, ::@NamedTuple{name::InlineStrings.String15, available::Bool, bus_id::Int64, fuel::InlineStrings.String15, fuel_price::Float64, active_power::Float64, reactive_power::Float64, active_power_limits_max::Float64, active_power_limits_min::Float64, reactive_power_limits_max::Float64, reactive_power_limits_min::Float64, min_down_time::Float64, min_up_time::Float64, ramp_limits::Float64, ramp_up::Nothing, ramp_down::Nothing, startup_heat_cold_cost::Float64, heat_rate_avg_0::Float64, heat_rate_incr_1::Float64, heat_rate_incr_2::Float64, heat_rate_incr_3::Float64, heat_rate_incr_4::Nothing, heat_rate_incr_5::Nothing, heat_rate_incr_6::Nothing, heat_rate_incr_7::Nothing, heat_rate_incr_8::Nothing, heat_rate_incr_9::Nothing, heat_rate_incr_10::Nothing, heat_rate_incr_11::Nothing, heat_rate_incr_12::Nothing, cost_point_0::Nothing, cost_point_1::Nothing, cost_point_2::Nothing, cost_point_3::Nothing, cost_point_4::Nothing, cost_point_5::Nothing, cost_point_6::Nothing, cost_point_7::Nothing, cost_point_8::Nothing, cost_point_9::Nothing, cost_point_10::Nothing, cost_point_11::Nothing, cost_point_12::Nothing, output_point_0::Float64, output_point_1::Float64, output_point_2::Float64, output_point_3::Float64, output_point_4::Nothing, output_point_5::Nothing, output_point_6::Nothing, output_point_7::Nothing, output_point_8::Nothing, output_point_9::Nothing, output_point_10::Nothing, output_point_11::Nothing, output_point_12::Nothing, base_mva::Float64, variable_cost::Nothing, fixed_cost::Float64, startup_cost::Nothing, shutdown_cost::Int64, curtailment_cost::Nothing, power_factor::Float64, unit_type::InlineStrings.String15, category::InlineStrings.String15, cold_start_time::Int64, warm_start_time::Int64, hot_start_time::Int64, startup_ramp::Nothing, shutdown_ramp::Nothing, status_at_start::Bool, time_at_status::Nothing, cold_start_cost::Nothing, warm_start_cost::Nothing, hot_start_cost::Nothing, must_run::Bool, pump_load::Nothing, pump_active_power_limits_max::Float64, pump_active_power_limits_min::Float64, pump_reactive_power_limits_max::Nothing, pump_reactive_power_limits_min::Nothing, pump_min_down_time::Nothing, pump_min_up_time::Nothing, pump_ramp_limits::Nothing, pump_ramp_up::Nothing, pump_ramp_down::Nothing, generator_category::String}, ::PowerSystems._HeatRateColumns, ::Float64)
 
 Closest candidates are:
-  iterate(!Matched::MathOptInterface.Utilities.IndexMap, Any...)
-   @ MathOptInterface ~/.julia/packages/MathOptInterface/aJZbq/src/Utilities/copy/index_map.jl:104
-  iterate(!Matched::MathOptInterface.Bridges.Constraint.Map)
-   @ MathOptInterface ~/.julia/packages/MathOptInterface/aJZbq/src/Bridges/Constraint/map.jl:136
-  iterate(!Matched::MathOptInterface.Bridges.Constraint.Map, !Matched::Any)
-   @ MathOptInterface ~/.julia/packages/MathOptInterface/aJZbq/src/Bridges/Constraint/map.jl:138
-  ...
      julia> horizon = Dates.Hour(24);
      julia> interval = Dates.Hour(24);
      julia> transform_single_time_series!(sys, horizon, interval);ERROR: UndefVarError: `sys` not defined
      julia> sysERROR: UndefVarError: `sys` not defined
      + create_pwl_cost(::Any) + @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/parsers/power_system_table_data.jl:935
      julia> horizon = Dates.Hour(24);
      julia> interval = Dates.Hour(24);
      julia> transform_single_time_series!(sys, horizon, interval);ERROR: UndefVarError: `sys` not defined
      julia> sysERROR: UndefVarError: `sys` not defined diff --git a/dev/tutorials/powersystembuilder/index.html b/dev/tutorials/powersystembuilder/index.html index 68c4401a7b..3b8db08f66 100644 --- a/dev/tutorials/powersystembuilder/index.html +++ b/dev/tutorials/powersystembuilder/index.html @@ -234,9 +234,9 @@ PowerSystemCaseBuilder.PSSEParsingTestSystems PowerSystemCaseBuilder.PSYTestSystems

      Create a System

      The first time this is run, it will parse csv data. Subsequent executions will rely on serialized data and will execute much faster since the employ deserialization

      julia> sys = build_system(PSITestSystems, "c_sys5_uc")┌ Info: Building new system c_sys5_uc from raw data
 └   sys_descriptor.raw_data = "/home/runner/.julia/artifacts/906591a156d0f786940f105e4f6aeceffefa7a2e/PowerSystemsTestData-3.0/psy_data/data_5bus_pu.jl"
-[ Info: Serialized time series data to /home/runner/.julia/packages/PowerSystemCaseBuilder/2fYQI/data/serialized_system/4e67b70ea6977dbe21c7731d72cdc1494adf072a7f3f08d921db740cf264ce79/c_sys5_uc_time_series_storage.h5.
-[ Info: Serialized System to /home/runner/.julia/packages/PowerSystemCaseBuilder/2fYQI/data/serialized_system/4e67b70ea6977dbe21c7731d72cdc1494adf072a7f3f08d921db740cf264ce79/c_sys5_uc.json
-[ Info: Serialized System metadata to /home/runner/.julia/packages/PowerSystemCaseBuilder/2fYQI/data/serialized_system/4e67b70ea6977dbe21c7731d72cdc1494adf072a7f3f08d921db740cf264ce79/c_sys5_uc_metadata.json
+[ Info: Serialized time series data to /home/runner/.julia/packages/PowerSystemCaseBuilder/FfGSY/data/serialized_system/4e67b70ea6977dbe21c7731d72cdc1494adf072a7f3f08d921db740cf264ce79/c_sys5_uc_time_series_storage.h5.
+[ Info: Serialized System to /home/runner/.julia/packages/PowerSystemCaseBuilder/FfGSY/data/serialized_system/4e67b70ea6977dbe21c7731d72cdc1494adf072a7f3f08d921db740cf264ce79/c_sys5_uc.json
+[ Info: Serialized System metadata to /home/runner/.julia/packages/PowerSystemCaseBuilder/FfGSY/data/serialized_system/4e67b70ea6977dbe21c7731d72cdc1494adf072a7f3f08d921db740cf264ce79/c_sys5_uc_metadata.json
 System
 ┌───────────────────┬─────────────┐
 │ Property          │ Value       │
@@ -267,4 +267,4 @@
 ├────────────┼────────────────┼──────────────────┼──────────────────────┼───────
 │ PowerLoad  │ Component      │ Deterministic    │ Forecast             │ 2024 ⋯
 └────────────┴────────────────┴──────────────────┴──────────────────────┴───────
-                                                               3 columns omitted
      + 3 columns omitted diff --git a/dev/tutorials/serialize_data/index.html b/dev/tutorials/serialize_data/index.html index 52da89a859..8592306381 100644 --- a/dev/tutorials/serialize_data/index.html +++ b/dev/tutorials/serialize_data/index.html @@ -53,8 +53,8 @@ │ PowerLoad │ 3 │ │ RenewableDispatch │ 2 │ │ ThermalStandard │ 5 │ -└──────────────────────────┴───────┘

      Write data to a temporary directory

      julia> folder = mktempdir();
      julia> path = joinpath(folder, "system.json")"/tmp/jl_JOD6gd/system.json"
      julia> println("Serializing to $path")Serializing to /tmp/jl_JOD6gd/system.json
      julia> to_json(sys, path)[ Info: Serialized System to /tmp/jl_JOD6gd/system.json
-[ Info: Serialized System metadata to /tmp/jl_JOD6gd/system_metadata.json

      Read the JSON file and create a new System

      julia> sys2 = System(path)System
+└──────────────────────────┴───────┘

      Write data to a temporary directory

      julia> folder = mktempdir();
      julia> path = joinpath(folder, "system.json")"/tmp/jl_SB1fzQ/system.json"
      julia> println("Serializing to $path")Serializing to /tmp/jl_SB1fzQ/system.json
      julia> to_json(sys, path)[ Info: Serialized System to /tmp/jl_SB1fzQ/system.json
+[ Info: Serialized System metadata to /tmp/jl_SB1fzQ/system_metadata.json

      Read the JSON file and create a new System

      julia> sys2 = System(path)System
 ┌───────────────────┬─────────────┐
 │ Property          │ Value       │
 ├───────────────────┼─────────────┤
@@ -79,4 +79,4 @@
 │ PowerLoad                │ 3     │
 │ RenewableDispatch        │ 2     │
 │ ThermalStandard          │ 5     │
-└──────────────────────────┴───────┘
      +└──────────────────────────┴───────┘