diff --git a/previews/PR1205/.documenter-siteinfo.json b/previews/PR1205/.documenter-siteinfo.json index ff07bf0460..13ec6dcc88 100644 --- a/previews/PR1205/.documenter-siteinfo.json +++ b/previews/PR1205/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-22T22:02:00","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-24T18:12:12","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/previews/PR1205/api/citation/index.html b/previews/PR1205/api/citation/index.html index c401c53491..62095461c4 100644 --- a/previews/PR1205/api/citation/index.html +++ b/previews/PR1205/api/citation/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 Sienna platform by 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 Sienna platform by the U.S. Department of Energy's National Renewable Energy Laboratory (NREL).

diff --git a/previews/PR1205/api/developer_guidelines/index.html b/previews/PR1205/api/developer_guidelines/index.html index 7c633f710b..a2c68bbfd1 100644 --- a/previews/PR1205/api/developer_guidelines/index.html +++ b/previews/PR1205/api/developer_guidelines/index.html @@ -1,2 +1,2 @@ -Developer Guidelines · PowerSystems.jl
GitHub
+Developer Guidelines · PowerSystems.jl
GitHub
diff --git a/previews/PR1205/api/enumerated_types/index.html b/previews/PR1205/api/enumerated_types/index.html index dc51503a55..f119bbc58b 100644 --- a/previews/PR1205/api/enumerated_types/index.html +++ b/previews/PR1205/api/enumerated_types/index.html @@ -1,2 +1,2 @@ -Specifying the category of... · PowerSystems.jl
GitHub

Specifying the type of...

Some fields in PowerSystems.jl are specified with an option from a pre-defined list (Specified with IS.scoped_enums).

Example syntax:

set_fuel!(gen, ThermalFuels.COAL)

These predefined lists are below:

AC Buses

ACBusTypes categorize buses for modeling activities and denote which quantities are specified for load flow calculations. ACBusTypes has the options:

NameDescription
ISOLATEDDisconnected from network
PQActive and reactive power defined (load bus)
PVActive power and voltage magnitude defined (generator bus)
REFReference bus (θ = 0)
SLACKSlack bus

Prime Movers

Each generator contains a field for prime_mover::PrimeMovers, based on the options in EIA form 923. PrimeMovers has the options:

NameDescription
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)
PVePhotovoltaic (Note: renaming from EIA PV to PVe to avoid conflict with ACBusType.PV)
WTWind Turbine, Onshore
WSWind Turbine, Offshore

Fuels for Thermal Generators

Each ThermalGen generator has a field for fuel::ThermalFuels where ThermalFuels are intended to reflect the options in the Aggregated Fuel Codes from the EIA Annual Energy Review. ThermalFuels has the options:

NameEIA 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

Energy Storage

StorageTech defines the storage technology used in an energy Storage system, based on the options in EIA form 923. StorageTech has the options:

NameDescription
PTESPumped thermal energy storage
LIBLiON Battery
LABLead Acid Battery
FLWBRedox Flow Battery
SIBSodium Ion Battery
ZIBZinc Ion Battery
HGSHydrogen Gas Storage
LAESLiquid Air Storage
OTHER_CHEMOther Chemical Storage
OTHER_MECHOther Mechanical Storage
OTHER_THERMOther Thermal Storage

Dynamic States

StateTypes are used to denote the type of dynamic equation a specific state is subject to in PowerSimulationsDynamics.jl. StateTypes has the options:

NameDescription
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

Angle Units

AngleUnits can be specified in:

Name
DEGREES
RADIANS
+Specifying the category of... · PowerSystems.jl
GitHub

Specifying the type of...

Some fields in PowerSystems.jl are specified with an option from a pre-defined list (Specified with IS.scoped_enums).

Example syntax:

set_fuel!(gen, ThermalFuels.COAL)

These predefined lists are below:

AC Buses

ACBusTypes categorize buses for modeling activities and denote which quantities are specified for load flow calculations. ACBusTypes has the options:

NameDescription
ISOLATEDDisconnected from network
PQActive and reactive power defined (load bus)
PVActive power and voltage magnitude defined (generator bus)
REFReference bus (θ = 0)
SLACKSlack bus

Prime Movers

Each generator contains a field for prime_mover::PrimeMovers, based on the options in EIA form 923. PrimeMovers has the options:

NameDescription
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)
PVePhotovoltaic (Note: renaming from EIA PV to PVe to avoid conflict with ACBusType.PV)
WTWind Turbine, Onshore
WSWind Turbine, Offshore

Fuels for Thermal Generators

Each ThermalGen generator has a field for fuel::ThermalFuels where ThermalFuels are intended to reflect the options in the Aggregated Fuel Codes from the EIA Annual Energy Review. ThermalFuels has the options:

NameEIA 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

Energy Storage

StorageTech defines the storage technology used in an energy Storage system, based on the options in EIA form 923. StorageTech has the options:

NameDescription
PTESPumped thermal energy storage
LIBLiON Battery
LABLead Acid Battery
FLWBRedox Flow Battery
SIBSodium Ion Battery
ZIBZinc Ion Battery
HGSHydrogen Gas Storage
LAESLiquid Air Storage
OTHER_CHEMOther Chemical Storage
OTHER_MECHOther Mechanical Storage
OTHER_THERMOther Thermal Storage

Dynamic States

StateTypes are used to denote the type of dynamic equation a specific state is subject to in PowerSimulationsDynamics.jl. StateTypes has the options:

NameDescription
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

Angle Units

AngleUnits can be specified in:

Name
DEGREES
RADIANS
diff --git a/previews/PR1205/api/glossary/index.html b/previews/PR1205/api/glossary/index.html index bd85a5b19b..bf76e546ce 100644 --- a/previews/PR1205/api/glossary/index.html +++ b/previews/PR1205/api/glossary/index.html @@ -1,2 +1,2 @@ -Glossary and Acronyms · PowerSystems.jl
GitHub

Glossary and Acronyms

A | D | E | F | H | I | O | P | R | S | V | W | 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 duration of all time steps in one forecast. As of PowerSystems.jl version 4.0, all horizons in PowerSystems.jl are represented as a Dates.Period. For instance, many Day-ahead markets will have an hourly-resolution forecast for the next day, which would have a horizon of Dates.Hour(24) or Dates.Day(1). If the forecast included the next day plus a 24-hour lookahead window, the horizon would be Dates.Hour(48) or Dates.Day(2). 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 window. See the article on Time Series Data.

  • IPC: Interconnecting power converter

O

  • OEL: Over Excitation Limiter

P

  • PLL: Phase-locked loop

  • PSS: Power System Stabilizer

  • PSSE or PSS/E: Siemens' PSS®E Power System Simulator for Engineering

  • PPA: Power purchase agreement

  • PSI: PowerSimulations.jl

  • PSID: PowerSimulationsDynamics.jl

  • PSLF: GE Vernova's Positive Sequence Load Flow Software

  • PSY: PowerSystems.jl (this package)

  • pu or p.u.: Per-unit

R

  • REECB1: Renewable Energy Electric Controller Type B1
  • REPCA1: REPCA1: Renewable Energy Power Controller Type A1
  • 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: Virtual Synchronous Machine

W

  • Window: A forecast window is one forecast run that starts at one initial time and extends through the forecast horizon. Typically, a forecast data set contains multiple forecast windows, with sequential initial times. For example, a year-long data set of day-ahead forecasts contains 365 forecast windows

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
GitHub

Glossary and Acronyms

A | D | E | F | H | I | O | P | R | S | V | W | 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 duration of all time steps in one forecast. As of PowerSystems.jl version 4.0, all horizons in PowerSystems.jl are represented as a Dates.Period. For instance, many Day-ahead markets will have an hourly-resolution forecast for the next day, which would have a horizon of Dates.Hour(24) or Dates.Day(1). If the forecast included the next day plus a 24-hour lookahead window, the horizon would be Dates.Hour(48) or Dates.Day(2). 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 window. See the article on Time Series Data.

  • IPC: Interconnecting power converter

O

  • OEL: Over Excitation Limiter

P

  • PLL: Phase-locked loop

  • PSS: Power System Stabilizer

  • PSSE or PSS/E: Siemens' PSS®E Power System Simulator for Engineering

  • PPA: Power purchase agreement

  • PSI: PowerSimulations.jl

  • PSID: PowerSimulationsDynamics.jl

  • PSLF: GE Vernova's Positive Sequence Load Flow Software

  • PSY: PowerSystems.jl (this package)

  • pu or p.u.: Per-unit

R

  • REECB1: Renewable Energy Electric Controller Type B1
  • REPCA1: REPCA1: Renewable Energy Power Controller Type A1
  • 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: Virtual Synchronous Machine

W

  • Window: A forecast window is one forecast run that starts at one initial time and extends through the forecast horizon. Typically, a forecast data set contains multiple forecast windows, with sequential initial times. For example, a year-long data set of day-ahead forecasts contains 365 forecast windows

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/previews/PR1205/api/internal/index.html b/previews/PR1205/api/internal/index.html index ba09ce455a..5ce5392c85 100644 --- a/previews/PR1205/api/internal/index.html +++ b/previews/PR1205/api/internal/index.html @@ -1,5 +1,5 @@ -Internals · PowerSystems.jl
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
+Internals · PowerSystems.jl
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.
  • 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,491 +38,491 @@
 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.
  • 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
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
 ) -> Any
-
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{Array{SubString{T}, 1} where T<:AbstractString, 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._make_market_bid_curve — Method
_make_market_bid_curve(
     data::PiecewiseStepData;
     initial_input,
     power_units,
     input_at_zero
 ) -> CostCurve{PiecewiseIncrementalCurve}
-
Auxiliary make market bid curve for timeseries with nothing inputs. 
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._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(
     _::Type{T},
     _,
     cost,
@@ -530,301 +530,301 @@
     start_time::Union{Nothing, Dates.DateTime},
     len::Union{Nothing, Int64}
 ) -> TimeSeries.TimeArray
-
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!(
+
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
 ) -> Union{Float64, Int64, InlineStrings.InlineString, SubString}
-
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.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_reactive_power_control — Method
get_reactive_power_control(
+
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.isafield — Method
isafield(component::Component, field::Symbol) -> Any
-
Checks if a PowerSystemDevice has a field or subfield name.
source
PowerSystems.is_attached — Method
is_attached(component::Component, sys::System) -> Bool
+
Return true if the component is attached to the system.
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
 ) -> Union{Nothing, EnergyReservoirStorage, HydroDispatch, HydroEnergyReservoir, HydroPumpedStorage, RenewableDispatch, RenewableNonDispatch, ThermalStandard}
-
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
@@ -846,60 +846,60 @@
     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/previews/PR1205/api/public/index.html b/previews/PR1205/api/public/index.html index 869a831d80..eeaf463216 100644 --- a/previews/PR1205/api/public/index.html +++ b/previews/PR1205/api/public/index.html @@ -1,208 +1,208 @@ -Public API · PowerSystems.jl
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 · PowerSystems.jl
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.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.get_subsystem_components — Method
get_subsystem_components(
     sys::System,
     subsystem_name::AbstractString
 ) -> Base.Generator{Set{Base.UUID}, InfrastructureSystems.var"#419#420"{InfrastructureSystems.SystemData}}
-
Return a Generator of all components in the subsystem.
Throws ArgumentError if the subsystem name is not stored.
source
PowerSystems.get_subsystems — Method
get_subsystems(
+
Return a Generator of all components in the subsystem.
Throws ArgumentError if the subsystem name is not stored.
source
PowerSystems.get_subsystems — Method
get_subsystems(
     sys::System
 ) -> Base.KeySet{String, Dict{String, Set{Base.UUID}}}
-
Return an iterator of all subsystem names in the system.
source
PowerSystems.has_component — Method
has_component(
     sys::System,
     subsystem_name::AbstractString,
     component::Component
 ) -> Bool
-
Return true if the component is in the subsystem.
source
PowerSystems.is_assigned_to_subsystem — Method
is_assigned_to_subsystem(
     sys::System,
     component::Component,
     subsystem_name::AbstractString
 ) -> Bool
-
Return true if the component is assigned to the subsystem.
source
PowerSystems.remove_component_from_subsystem! — Method
remove_component_from_subsystem!(
     sys::System,
     subsystem_name::AbstractString,
     component::Component
 )
-
Remove a component from a subsystem.
Throws ArgumentError if the subsystem name or component is not stored.
source
PowerSystems.remove_subsystem! — Method
remove_subsystem!(
     sys::System,
     subsystem_name::AbstractString
 )
-
Remove a subsystem from the system.
Throws ArgumentError if the subsystem name is not stored.
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.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
InfrastructureSystems.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_decremental_initial_input — Method
get_decremental_initial_input(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{Nothing, TimeSeries.TimeArray}
-
Retrieve the decremental_initial_input for a StaticInjection device with a MarketBidCost.
source
PowerSystems.get_decremental_offer_curves — Method
get_decremental_offer_curves(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}
-
Retrieve the decremental_offer_curves 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 or Nothing.
source
PowerSystems.get_decremental_variable_cost — Method
get_decremental_variable_cost(
+
Retrieve the decremental_offer_curves 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 or Nothing.
source
PowerSystems.get_decremental_variable_cost — Method
get_decremental_variable_cost(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}
-
Retrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (decremental_offer_curves, initial_input, no_load_cost) are 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.get_incremental_initial_input — Method
get_incremental_initial_input(
+
Retrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (decremental_offer_curves, initial_input, no_load_cost) are 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.get_incremental_initial_input — Method
get_incremental_initial_input(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{Nothing, TimeSeries.TimeArray}
-
Retrieve the incremental_initial_input for a StaticInjection device with a MarketBidCost.
source
PowerSystems.get_incremental_offer_curves — Method
get_incremental_offer_curves(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}
-
Retrieve the incremental_offer_curves 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 or Nothing.
source
PowerSystems.get_incremental_variable_cost — Method
get_incremental_variable_cost(
+
Retrieve the incremental_offer_curves 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 or Nothing.
source
PowerSystems.get_incremental_variable_cost — Method
get_incremental_variable_cost(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}
-
Retrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (incremental_offer_curves, initial_input, no_load_cost) are 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.get_no_load_cost — Method
get_no_load_cost(
+
Retrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (incremental_offer_curves, initial_input, no_load_cost) are 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.get_no_load_cost — Method
get_no_load_cost(
     device::StaticInjection,
     cost::MarketBidCost;
     start_time,
     len
 ) -> Union{Nothing, 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 or Nothing.
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 or Nothing.
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 startup 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 startup 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{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}
-
Retrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (incremental_offer_curves, initial_input, no_load_cost) are 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_decremental_initial_input! — Method
set_decremental_initial_input!(
+
Retrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (incremental_offer_curves, initial_input, no_load_cost) are 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_decremental_initial_input! — Method
set_decremental_initial_input!(
     sys::System,
     component::StaticInjection,
     data::Union{Float64, TimeSeriesData}
 ) -> TimeSeriesKey
-
Set the decremental_initial_input for a StaticInjection device with a MarketBidCost to either a scalar 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_decremental_variable_cost! — Method
set_decremental_variable_cost!(
+
Set the decremental_initial_input for a StaticInjection device with a MarketBidCost to either a scalar 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_decremental_variable_cost! — Method
set_decremental_variable_cost!(
     sys::System,
     component::StaticInjection,
     data::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},
     power_units::UnitSystem
 )
-
Set the decremental 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 using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.
  • power_units::UnitSystem: Units to be used for data.
source
PowerSystems.set_fuel_cost! — Method
set_fuel_cost!(
+
Set the decremental 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 using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.
  • power_units::UnitSystem: Units to be used for data.
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_incremental_initial_input! — Method
set_incremental_initial_input!(
     sys::System,
     component::StaticInjection,
     data::Union{Float64, TimeSeriesData}
 ) -> TimeSeriesKey
-
Set the incremental_initial_input for a StaticInjection device with a MarketBidCost to either a scalar 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_incremental_variable_cost! — Method
set_incremental_variable_cost!(
+
Set the incremental_initial_input for a StaticInjection device with a MarketBidCost to either a scalar 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_incremental_variable_cost! — Method
set_incremental_variable_cost!(
     sys::System,
     component::StaticInjection,
     data::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},
     power_units::UnitSystem
 )
-
Set the incremental 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 using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.
  • power_units::UnitSystem: Units to be used for data.
source
PowerSystems.set_no_load_cost! — Method
set_no_load_cost!(
+
Set the incremental 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 using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.
  • power_units::UnitSystem: Units to be used for data.
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 scalar 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 scalar 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,
     power_units::UnitSystem
 )
-
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, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},
     power_units::UnitSystem
 )
-
Set the incremental 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 using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.
  • power_units::UnitSystem: Units to be used for data. Must be NATURAL_UNITS.
source
Operating Costs
InfrastructureSystems.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)
+
Set the incremental 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 using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.
  • power_units::UnitSystem: Units to be used for data. Must be NATURAL_UNITS.
source
Operating Costs
InfrastructureSystems.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
InfrastructureSystems.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 TimeSeriesKey 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)
@@ -617,31 +617,31 @@
     level = 3,
     shuffle = true)
 )
-sys = System(100.0; time_series_in_memory = true)
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,
@@ -652,20 +652,20 @@
     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
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
@@ -676,7 +676,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;
@@ -687,20 +687,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,
@@ -708,13 +708,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.
A component cannot be added to more than one System. Throws ArgumentError if the name does not match the static_injector name. Throws ArgumentError if the static_injector 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.
A component cannot be added to more than one System. Throws ArgumentError if the name does not match the static_injector name. Throws ArgumentError if the static_injector 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,
@@ -728,65 +728,65 @@
 # Add many at once.
 buses = [bus1, bus2, bus3]
 generators = [gen1, gen2, gen3]
-foreach(x -> add_component!(sys, x), Iterators.flatten((buses, generators)))
See also add_components!.
source
PowerSystems.add_components! — Method
add_components!(sys::System, components)
 
Add many components to the system at once.
A component cannot be added to more than one System. 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]
-add_components!(sys, 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 function stores a single copy of the data. Each component will store a reference to that data. 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 function stores a single copy of the data. Each component will store a reference to that data. 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
@@ -804,87 +804,87 @@
     )
     for gen in get_components(ThermalStandard, sys)
 )
-bulk_add_time_series!(sys, associations)
See also: open_time_series_store! to minimize HDF5 file handle overhead if you must add time series arrays one at a time
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_available_components — Method
get_available_components(
     _::Type{T<:Component},
     sys::System
 ) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:Component, I<:(Vector)}
-
Gets components availability. Requires type T to have the method get_available implemented.
source
PowerSystems.get_bus — Method
get_bus(
+
Gets components availability. Requires type T to have the method get_available implemented.
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.get_forecast_initial_times — Method
get_forecast_initial_times(
     sys::System
 ) -> Union{Vector{Any}, Vector{Dates.DateTime}, StepRangeLen{T, R, S, Int64} where {T, R>:Dates.DateTime, S}}
-
Return the initial times for all forecasts.
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"#110#111"}}
 
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"#110#111"}}
 
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;
     ...
@@ -973,56 +973,56 @@
     for (component, ts) in zip(components, single_time_series)
         add_time_series!(sys, component, ts)
     end
-end
You can also use this function to make reads faster. Change the mode from "r+" to "r" to open the file read-only.
See also: bulk_add_time_series!
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.remove_time_series! — Method
remove_time_series!(sys::System, _::Type{T<:TimeSeriesData})
-
Remove all the time series data for a time series type.
See also: clear_time_series!
If you are storing time series data in an HDF5 file, remove_time_series! does not actually free up file space (HDF5 behavior). If you want to remove all or most time series instances then consider using clear_time_series!. It will delete the HDF5 file and create a new one. PowerSystems has plans to automate this type of workflow.
source
PowerSystems.remove_time_series! — Method
remove_time_series!(sys::System, _::Type{T<:TimeSeriesData})
+
Remove all the time series data for a time series type.
See also: clear_time_series!
If you are storing time series data in an HDF5 file, remove_time_series! does not actually free up file space (HDF5 behavior). If you want to remove all or most time series instances then consider using clear_time_series!. It will delete the HDF5 file and create a new one. PowerSystems has plans to automate this type of workflow.
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 in a System to DeterministicSingleTimeSeries
This can be used to generate a perfect forecast from historical measurements or realizations when actual forecasts are unavailable, without unnecessarily duplicating data.
If all SingleTimeSeries instances cannot be transformed then none will be.
Any existing DeterministicSingleTimeSeries forecasts will be deleted even if the inputs are invalid.
Arguments
  • sys::System: System containing the components.
  • horizon::Dates.Period: desired horizon of each forecast window
  • interval::Dates.Period: desired interval between forecast windows
source
PowerSystems.validate_component_with_system — Method
validate_component_with_system(
+
Transform all instances of SingleTimeSeries in a System to DeterministicSingleTimeSeries
This can be used to generate a perfect forecast from historical measurements or realizations when actual forecasts are unavailable, without unnecessarily duplicating data.
If all SingleTimeSeries instances cannot be transformed then none will be.
Any existing DeterministicSingleTimeSeries forecasts will be deleted even if the inputs are invalid.
Arguments
  • sys::System: System containing the components.
  • horizon::Dates.Period: desired horizon of each forecast window
  • interval::Dates.Period: desired interval between forecast windows
source
PowerSystems.show_components — Function
show_components(
     sys::System,
     component_type::Type{<:Component};
     ...
@@ -1035,20 +1035,20 @@
 )
 
Show all components of the given type in a table.
Arguments
  • sys::System: System containing the components.
  • component_type::Type{<:Component}: Type to display. Must be a concrete type.
  • additional_columns::Union{Dict, Vector}: Additional columns to display. The Dict option is a mapping of column name to function. The function must accept a component. The Vector option is an array of field names for the component_type.
Extra keyword arguments are forwarded to PrettyTables.pretty_table.
Examples
show_components(sys, ThermalStandard)
 show_components(sys, ThermalStandard, Dict("has_time_series" => x -> has_time_series(x)))
-show_components(sys, ThermalStandard, [:active_power, :reactive_power])
source
PowerSystems.generate_struct_file — Method
generate_struct_file(
     definition::StructDefinition;
     filename,
     output_directory
 )
-
Generate a Julia source code file for one struct from a StructDefinition.
Refer to StructDefinition and StructField for descriptions of the available fields.
Arguments
  • definition::StructDefinition: Defines the struct and all fields.
  • filename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json
  • output_directory::AbstractString: Generate the files in this directory. Defaults to src/models/generated
source
PowerSystems.generate_struct_files — Method
generate_struct_files(
+
Generate a Julia source code file for one struct from a StructDefinition.
Refer to StructDefinition and StructField for descriptions of the available fields.
Arguments
  • definition::StructDefinition: Defines the struct and all fields.
  • filename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json
  • output_directory::AbstractString: Generate the files in this directory. Defaults to src/models/generated
source
PowerSystems.generate_struct_files — Method
generate_struct_files(
     definitions;
     filename,
     output_directory
 )
-
Generate Julia source code files for multiple structs from a iterable of StructDefinition instances.
Refer to StructDefinition and StructField for descriptions of the available fields.
Arguments
  • definitions: Defines the structs and all fields.
  • filename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json
  • output_directory::AbstractString: Generate the files in this directory. Defaults to src/models/generated
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
Parsing
PowerSystems.PowerSystemTableData — Method
PowerSystemTableData(
+
Generate Julia source code files for multiple structs from a iterable of StructDefinition instances.
Refer to StructDefinition and StructField for descriptions of the available fields.
Arguments
  • definitions: Defines the structs and all fields.
  • filename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json
  • output_directory::AbstractString: Generate the files in this directory. Defaults to src/models/generated
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
Parsing
PowerSystems.PowerSystemTableData — Method
PowerSystemTableData(
     directory::AbstractString,
     base_power::Float64,
     user_descriptor_file::AbstractString;
@@ -1056,30 +1056,30 @@
     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.create_poly_cost — Method
create_poly_cost(
+
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.create_poly_cost — Method
create_poly_cost(
     gen,
     cost_colnames
 ) -> Union{Tuple{LinearCurve, Float64}, Tuple{QuadraticCurve, Float64}}
-
create_poly_cost(gen, cost_colnames)
Return a Polynomial function cost based on the coeffiecients provided on gen.
Three supported cases,
  1. If three values are passed then we have data looking like: a2 * x^2 + a1 * x + a0,
  2. If a1 and a0 are passed then we have data looking like: a1 * x + a0,
  3. If only a1 is passed then we have data looking like: a1 * x.
source
PowerSystems.PowerModelsData — Method
PowerModelsData(
+
create_poly_cost(gen, cost_colnames)
Return a Polynomial function cost based on the coeffiecients provided on gen.
Three supported cases,
  1. If three values are passed then we have data looking like: a2 * x^2 + a1 * x + a0,
  2. If a1 and a0 are passed then we have data looking like: a1 * x + a0,
  3. If only a1 is passed then we have data looking like: a1 * x.
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
PowerSystems.parse_file — Method
parse_file(
     io::IO;
     import_all,
     validate,
     correct_branch_rating,
     filetype
 ) -> Any
-
Parses the iostream from a file
source
PowerSystems.parse_file — Method
parse_file(
     file::String;
     import_all,
     validate,
@@ -1090,7 +1090,7 @@
     import_all = false,
     validate = true,
     correct_branch_rating = true,
-)
Parses a Matpower .m file or PTI (PSS(R)E-v33) .raw file into a PowerModels data structure. All fields from PTI files will be imported if import_all is true (Default: false).
source
Logging
PowerSystems.configure_logging — Method
configure_logging(
+)
Parses a Matpower .m file or PTI (PSS(R)E-v33) .raw file into a PowerModels data structure. All fields from PTI files will be imported if import_all is true (Default: false).
source
Logging
PowerSystems.configure_logging — Method
configure_logging(
 ;
     console_level,
     file_level,
@@ -1098,4 +1098,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/previews/PR1205/api/type_tree/index.html b/previews/PR1205/api/type_tree/index.html index 9c7db0b427..6b681bc48b 100644 --- a/previews/PR1205/api/type_tree/index.html +++ b/previews/PR1205/api/type_tree/index.html @@ -230,4 +230,4 @@ │ └─ SingleTimeSeries └─ TimeSeriesKey ├─ ForecastKey - └─ StaticTimeSeriesKey + └─ StaticTimeSeriesKey diff --git a/previews/PR1205/api/valuecurve_options/index.html b/previews/PR1205/api/valuecurve_options/index.html index 2c233431f9..dd1fae32c1 100644 --- a/previews/PR1205/api/valuecurve_options/index.html +++ b/previews/PR1205/api/valuecurve_options/index.html @@ -1,2 +1,2 @@ -ValueCurve Options · PowerSystems.jl
GitHub

ValueCurve Options

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 is done by constructing various subtypes of ValueCurve.

This summary table shows each way to construct a ValueCurve with the user-friendly subtype aliases. The ValueCurves make no assumption about units; the example interpretation given here assumes that the variable cost ValueCurve will be wrapped in a CostCurve with natural units. Note that all four Piecewise options here fundamentally represent the same curve. More information and explanatory plots are provided for each subtype alias in the subheadings below.

DescriptionExampleExample interpretation
Linear input-output curve with zero no-load cost (constant average rate)LinearCurve(5.0)$5/MWh
Linear input-output curve with potentially nonzero no-load cost (constant marginal rate)LinearCurve(5.0, 15.0)$5/MWh + $15/hr
Quadratic input-output curve with potentially nonzero no-load costQuadraticCurve(1.0, 1.0, 18.0)$C(P) = 1 P^2 + 1 P + 18$ where $C$ is $/hr, $P$ is MW
Piecewise linear curve specified by cost values at production pointsPiecewisePointCurve([(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
Piecewise linear curve specified by initial value and marginal rates (slopes) between production pointsPiecewiseIncrementalCurve(20.0, [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
No-load cost plus piecewise linear curve specified by initial value and marginal rates (slopes) between production pointsPiecewiseIncrementalCurve(18.0, 20.0, [1.0, 2.0, 3.0], [4.0, 6.0])$18/hr no-load cost; $20/hr @ 1 MW plus additional $4/MWh from 1 MW to 2 MW plus additional $6/MWh from 2 MW to 3 MW
Piecewise linear curve specified by initial value and average rates between production pointsPiecewiseAverageCurve(20.0, [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

LinearCurve

Specify the marginal cost of production $M$ and optionally the no-load cost $C$, which defaults to zero. Here is a graphical representation:

QuadraticCurve

Specify the quadratic ($Q$), proportional ($M$), and constant ($C$) terms of a function that defines the input-output curve:

PiecewisePointCurve

Specify a vector of $K$ (production, cost) pairs (i.e., $(P_k, C_k)$ for $k = 1, \dots, K$) to define the input-output curve:

PiecewiseIncrementalCurve

Specify the cost $C_1$ at the least production point given (NOT the cost at zero production), a vector of $K$ production points $P_1, \dots, P_k$, and a vector of $K-1$ marginal rates $M_1, \dots, M_{k-1}$, that represent the slopes of the curve segments between the points. $C_1$ may be nothing, which results in a not-fully-defined curve. The no-load cost $C_0$ can optionally be specified as a first argument; it is not part of the representation of the curve, just another piece of data that may be stored:

PiecewiseAverageCurve

Specify the cost $C_1$ at the least production point given (NOT the cost at zero production), a vector of $K$ production points $P_1, \dots, P_k$, and a vector of $K-1$ average rates $R_1, \dots, R_{k-1}$ at the $K-1$ latter production points:

+ValueCurve Options · PowerSystems.jl
GitHub

ValueCurve Options

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 is done by constructing various subtypes of ValueCurve.

This summary table shows each way to construct a ValueCurve with the user-friendly subtype aliases. The ValueCurves make no assumption about units; the example interpretation given here assumes that the variable cost ValueCurve will be wrapped in a CostCurve with natural units. Note that all four Piecewise options here fundamentally represent the same curve. More information and explanatory plots are provided for each subtype alias in the subheadings below.

DescriptionExampleExample interpretation
Linear input-output curve with zero no-load cost (constant average rate)LinearCurve(5.0)$5/MWh
Linear input-output curve with potentially nonzero no-load cost (constant marginal rate)LinearCurve(5.0, 15.0)$5/MWh + $15/hr
Quadratic input-output curve with potentially nonzero no-load costQuadraticCurve(1.0, 1.0, 18.0)$C(P) = 1 P^2 + 1 P + 18$ where $C$ is $/hr, $P$ is MW
Piecewise linear curve specified by cost values at production pointsPiecewisePointCurve([(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
Piecewise linear curve specified by initial value and marginal rates (slopes) between production pointsPiecewiseIncrementalCurve(20.0, [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
No-load cost plus piecewise linear curve specified by initial value and marginal rates (slopes) between production pointsPiecewiseIncrementalCurve(18.0, 20.0, [1.0, 2.0, 3.0], [4.0, 6.0])$18/hr no-load cost; $20/hr @ 1 MW plus additional $4/MWh from 1 MW to 2 MW plus additional $6/MWh from 2 MW to 3 MW
Piecewise linear curve specified by initial value and average rates between production pointsPiecewiseAverageCurve(20.0, [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

LinearCurve

Specify the marginal cost of production $M$ and optionally the no-load cost $C$, which defaults to zero. Here is a graphical representation:

QuadraticCurve

Specify the quadratic ($Q$), proportional ($M$), and constant ($C$) terms of a function that defines the input-output curve:

PiecewisePointCurve

Specify a vector of $K$ (production, cost) pairs (i.e., $(P_k, C_k)$ for $k = 1, \dots, K$) to define the input-output curve:

PiecewiseIncrementalCurve

Specify the cost $C_1$ at the least production point given (NOT the cost at zero production), a vector of $K$ production points $P_1, \dots, P_k$, and a vector of $K-1$ marginal rates $M_1, \dots, M_{k-1}$, that represent the slopes of the curve segments between the points. $C_1$ may be nothing, which results in a not-fully-defined curve. The no-load cost $C_0$ can optionally be specified as a first argument; it is not part of the representation of the curve, just another piece of data that may be stored:

PiecewiseAverageCurve

Specify the cost $C_1$ at the least production point given (NOT the cost at zero production), a vector of $K$ production points $P_1, \dots, P_k$, and a vector of $K-1$ average rates $R_1, \dots, R_{k-1}$ at the $K-1$ latter production points:

diff --git a/previews/PR1205/explanation/dynamic_data/index.html b/previews/PR1205/explanation/dynamic_data/index.html index 5e185e90e1..5b61dd813b 100644 --- a/previews/PR1205/explanation/dynamic_data/index.html +++ b/previews/PR1205/explanation/dynamic_data/index.html @@ -1,2 +1,2 @@ -Dynamic Devices · PowerSystems.jl
GitHub

Dynamic Devices

Static and Dynamic Data Layers

PowerSystems.jl uses two categories to define data for dynamic simulations:

  1. Static components, which includes the data needed to run a power flow problem
  2. Dynamic components are those that define differential equations to run a transient simulation. These dynamic data are attached to the static components.

Although PowerSystems.jl is not constrained to only PSS/e files, commonly the data for a dynamic simulation comes in a pair of files: One for the static data power flow case (e.g., .raw file) and a second one with the dynamic components information (e.g., .dyr file). However, PowerSystems.jl is able to take any power flow case and specify dynamic components to it. The two data layers in PowerSystems.jl are similar to the data division between those two files.

Layer 1: Static Components

The first data layer contains all the information necessary to run a power flow problem:

  • Vector of Bus elements, that define all the buses in the network.
  • Vector of Branch elements, that define all the branches elements (that connect two buses) in the network.
  • Vector of StaticInjection elements, that define all the devices connected to buses that can inject (or withdraw) power. These static devices, typically generators, in PowerSimulationsDynamics are used to solve the Power Flow problem that determines the active and reactive power provided for each device.
  • Vector of PowerLoad elements, that define all the loads connected to buses that can withdraw current. These are also used to solve the Power Flow.
  • Vector of Source elements, that define source components behind a reactance that can inject or withdraw current.
  • The base of power used to define per unit values, in MVA as a Float64 value.
  • The base frequency used in the system, in Hz as a Float64 value.

Layer 2: Dynamic Components

The second data layer contains the additional information describing the dynamic response of certain components in the System. This data is all attached to components defined in the static data layer:

  • (Optional) Selecting which of the Lines (of the Branch vector) elements must be modeled of DynamicLines elements, that can be used to model lines with differential equations.
  • Vector of DynamicInjection elements. These components must be attached to a StaticInjection that connects the power flow solution to the dynamic formulation of such device.

DynamicInjection can be DynamicGenerator or DynamicInverter, and its specific formulation (i.e. differential equations) will depend on the specific components that define each device (see the sections below). As a result, it is possible to flexibly define dynamic data models and methods according to the analysis requirements. DynamicInjection components use 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 of states. 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 Structure

Each generator is a data structure that is defined by the following components:

Dynamic Inverter Structure

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
GitHub

Dynamic Devices

Static and Dynamic Data Layers

PowerSystems.jl uses two categories to define data for dynamic simulations:

  1. Static components, which includes the data needed to run a power flow problem
  2. Dynamic components are those that define differential equations to run a transient simulation. These dynamic data are attached to the static components.

Although PowerSystems.jl is not constrained to only PSS/e files, commonly the data for a dynamic simulation comes in a pair of files: One for the static data power flow case (e.g., .raw file) and a second one with the dynamic components information (e.g., .dyr file). However, PowerSystems.jl is able to take any power flow case and specify dynamic components to it. The two data layers in PowerSystems.jl are similar to the data division between those two files.

Layer 1: Static Components

The first data layer contains all the information necessary to run a power flow problem:

  • Vector of Bus elements, that define all the buses in the network.
  • Vector of Branch elements, that define all the branches elements (that connect two buses) in the network.
  • Vector of StaticInjection elements, that define all the devices connected to buses that can inject (or withdraw) power. These static devices, typically generators, in PowerSimulationsDynamics are used to solve the Power Flow problem that determines the active and reactive power provided for each device.
  • Vector of PowerLoad elements, that define all the loads connected to buses that can withdraw current. These are also used to solve the Power Flow.
  • Vector of Source elements, that define source components behind a reactance that can inject or withdraw current.
  • The base of power used to define per unit values, in MVA as a Float64 value.
  • The base frequency used in the system, in Hz as a Float64 value.

Layer 2: Dynamic Components

The second data layer contains the additional information describing the dynamic response of certain components in the System. This data is all attached to components defined in the static data layer:

  • (Optional) Selecting which of the Lines (of the Branch vector) elements must be modeled of DynamicLines elements, that can be used to model lines with differential equations.
  • Vector of DynamicInjection elements. These components must be attached to a StaticInjection that connects the power flow solution to the dynamic formulation of such device.

DynamicInjection can be DynamicGenerator or DynamicInverter, and its specific formulation (i.e. differential equations) will depend on the specific components that define each device (see the sections below). As a result, it is possible to flexibly define dynamic data models and methods according to the analysis requirements. DynamicInjection components use 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 of states. 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 Structure

Each generator is a data structure that is defined by the following components:

Dynamic Inverter Structure

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/previews/PR1205/explanation/per_unit/index.html b/previews/PR1205/explanation/per_unit/index.html index eaacbd4b56..3065c3fdb6 100644 --- a/previews/PR1205/explanation/per_unit/index.html +++ b/previews/PR1205/explanation/per_unit/index.html @@ -1,2 +1,2 @@ -Per-unit Conventions · PowerSystems.jl
GitHub

Per-unit Conventions

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_power.

PowerSystems.jl supports these unit systems because different power system tools and data sets use different units systems by convention, such as:

  • Dynamics data is often defined in device base
  • Network data (e.g., reactance, resistance) is often defined in system base
  • Production cost modeling data is often gathered from variety of data sources, which are typically defined in natural units

These three unit bases allow easy conversion between unit systems. This allows PowerSystems.jl users to input data in the formats they have available, as well as view data in the unit system that is most intuitive to them.

You can get and set the unit system setting of a System with get_units_base and set_units_base_system!.

Conversion between unit systems does not change the stored parameter values. Instead, unit system conversions are made when accessing parameters using the accessor functions, thus making it imperative to utilize the accessor functions instead of the "dot" accessor methods to ensure the return of the correct values. The units of the parameter values stored in each struct are defined in src/descriptors/power_system_structs.json.

There are some unit system conventions in PowerSystems.jl when defining new components. Currently, when you define components that aren't attached to a System, you must define all fields in "DEVICE_BASE", except for certain components that don't have their own base_power rating, such as Lines, where the rating must be defined in "SYSTEM_BASE".

In the future, PowerSystems.jl hopes to support defining components in natural units. For now, if you want to define data in natural units, you must first set the system units to "NATURAL_UNITS", define an empty component, and then use the accessor functions (e.g., getters and setters), to define each field within the component. The accessor functions will then do the data conversion from your input data in natural units (e.g., MW or MVA) to per-unit.

By default, PowerSystems.jl uses "SYSTEM_BASE" because many optimization problems won't converge when using natural units. If you change the unit setting, it's suggested that you switch back to "SYSTEM_BASE" before solving an optimization problem (for example in PowerSimulations.jl).

+Per-unit Conventions · PowerSystems.jl
GitHub

Per-unit Conventions

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_power.

PowerSystems.jl supports these unit systems because different power system tools and data sets use different units systems by convention, such as:

  • Dynamics data is often defined in device base
  • Network data (e.g., reactance, resistance) is often defined in system base
  • Production cost modeling data is often gathered from variety of data sources, which are typically defined in natural units

These three unit bases allow easy conversion between unit systems. This allows PowerSystems.jl users to input data in the formats they have available, as well as view data in the unit system that is most intuitive to them.

You can get and set the unit system setting of a System with get_units_base and set_units_base_system!.

Conversion between unit systems does not change the stored parameter values. Instead, unit system conversions are made when accessing parameters using the accessor functions, thus making it imperative to utilize the accessor functions instead of the "dot" accessor methods to ensure the return of the correct values. The units of the parameter values stored in each struct are defined in src/descriptors/power_system_structs.json.

There are some unit system conventions in PowerSystems.jl when defining new components. Currently, when you define components that aren't attached to a System, you must define all fields in "DEVICE_BASE", except for certain components that don't have their own base_power rating, such as Lines, where the rating must be defined in "SYSTEM_BASE".

In the future, PowerSystems.jl hopes to support defining components in natural units. For now, if you want to define data in natural units, you must first set the system units to "NATURAL_UNITS", define an empty component, and then use the accessor functions (e.g., getters and setters), to define each field within the component. The accessor functions will then do the data conversion from your input data in natural units (e.g., MW or MVA) to per-unit.

By default, PowerSystems.jl uses "SYSTEM_BASE" because many optimization problems won't converge when using natural units. If you change the unit setting, it's suggested that you switch back to "SYSTEM_BASE" before solving an optimization problem (for example in PowerSimulations.jl).

diff --git a/previews/PR1205/explanation/system/index.html b/previews/PR1205/explanation/system/index.html index 2ae7b756d2..286b0043ce 100644 --- a/previews/PR1205/explanation/system/index.html +++ b/previews/PR1205/explanation/system/index.html @@ -1,2 +1,2 @@ -System · PowerSystems.jl
GitHub

System

The System is the main container of components and the time series data references. PowerSystems.jl uses a hybrid approach to data storage, where the component data and time series references are stored in volatile memory while the actual time series data is stored in an HDF5 file. This design loads into memory the portions of the data that are relevant at time of the query, and so avoids overwhelming the memory resources.

Accessing components stored in the System

PowerSystems.jl implements a wide variety of methods to search for components to aid in data manipulation. Most of these use the Type Structure to retrieve all components of a certain Type.

For example, the most common search function is get_components, which takes a desired device Type (concrete or abstract) and retrieves all components in that category from the System. It also accepts filter functions for a more refined search.

Given the potential size of the return, PowerSystems.jl returns Julia iterators in order to avoid unnecessary memory allocations. The container is optimized for iteration over abstract or concrete component types as described by the Type Structure.

Accessing data stored in a component

Using the "dot" access to get a parameter value from a component is actively discouraged, use "getter" functions instead

Using code autogeneration, PowerSystems.jl implements accessor (or "getter") functions to enable the retrieval of parameters defined in the component struct fields. Julia syntax enables access to this data using the "dot" access (e.g. component.field), however this is actively discouraged for two reasons:

  1. We make no guarantees on the stability of component structure definitions. We will maintain version stability on the accessor methods.
  2. Per-unit conversions are made in the return of data from the accessor functions. (see the per-unit section for more details)
+System · PowerSystems.jl
GitHub

System

The System is the main container of components and the time series data references. PowerSystems.jl uses a hybrid approach to data storage, where the component data and time series references are stored in volatile memory while the actual time series data is stored in an HDF5 file. This design loads into memory the portions of the data that are relevant at time of the query, and so avoids overwhelming the memory resources.

Accessing components stored in the System

PowerSystems.jl implements a wide variety of methods to search for components to aid in data manipulation. Most of these use the Type Structure to retrieve all components of a certain Type.

For example, the most common search function is get_components, which takes a desired device Type (concrete or abstract) and retrieves all components in that category from the System. It also accepts filter functions for a more refined search.

Given the potential size of the return, PowerSystems.jl returns Julia iterators in order to avoid unnecessary memory allocations. The container is optimized for iteration over abstract or concrete component types as described by the Type Structure.

Accessing data stored in a component

Using the "dot" access to get a parameter value from a component is actively discouraged, use "getter" functions instead

Using code autogeneration, PowerSystems.jl implements accessor (or "getter") functions to enable the retrieval of parameters defined in the component struct fields. Julia syntax enables access to this data using the "dot" access (e.g. component.field), however this is actively discouraged for two reasons:

  1. We make no guarantees on the stability of component structure definitions. We will maintain version stability on the accessor methods.
  2. Per-unit conversions are made in the return of data from the accessor functions. (see the per-unit section for more details)
diff --git a/previews/PR1205/explanation/time_series/index.html b/previews/PR1205/explanation/time_series/index.html index c89d62061a..8dcf60b7ff 100644 --- a/previews/PR1205/explanation/time_series/index.html +++ b/previews/PR1205/explanation/time_series/index.html @@ -7,4 +7,4 @@ │ ├─ Probabilistic │ └─ Scenarios └─ StaticTimeSeries - └─ SingleTimeSeries

Static Time Series Data

A static time series data is a single column of data where each time period has a single value assigned to a component field, such as its maximum active power. This data commonly is obtained from historical information or the realization of a time-varying quantity.

Static time series usually comes in the following format, with a set resolution between the time-stamps:

DateTimeValue
2020-09-01T00:00:00100.0
2020-09-01T01:00:00101.0
2020-09-01T02:00:0099.0

This example is a 1-hour resolution static time-series.

In PowerSystems, a static time series is represented using SingleTimeSeries.

Forecasts

A forecast time series includes predicted values of a time-varying quantity that commonly includes a look-ahead window 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.

Key forecast format parameters are the forecast resolution, the interval of time between forecast initial times, and the number of forecast windows (or forecasted values) in the forecast horizon.

Forecast data usually comes in the following format, where a column represents the time stamp associated with the initial time of the forecast, and the remaining columns represent the forecasted values at each step in the forecast horizon.

DateTime01234567
2020-09-01T00:00:00100.0101.0101.390.098.087.088.067.0
2020-09-01T01:00:00101.0101.399.098.088.988.367.189.4
2020-09-01T02:00:0099.067.089.099.9100.0101.0112.0101.3

This example forecast has a interval of 1 hour and a horizon of 8.

PowerSystems defines the following Julia structs to represent forecasts:

Data Storage

By default PowerSystems stores time series data in an HDF5 file. This prevents large datasets from overwhelming system memory. Refer to this page for details on how the time series data is stored in HDF5 files.

Time series data can be stored actual component values (for instance MW) or scaling factors intended to be multiplied by a scalar to generate the component values. By default PowerSystems treats the values in the time series data as physical units. In order to specify them as scaling factors, you must pass the accessor function that provides the multiplier value (e.g., get_time_series_array). The scaling factor multiplier must be passed into the forecast when you create it to use this option.

The time series contains fields for scaling_factor_multiplier and data to identify the details of th Component field that the time series describes, and the time series data. For example: we commonly want to use a time series to describe the maximum active power capability of a renewable generator. In this case, we can create a SingleTimeSeries with a TimeArray and an accessor function to the maximum active power field in the struct describing the generator. In this way, we can store a scaling factor time series that will get multiplied by the maximum active power rather than the magnitudes of the maximum active power time series.

Examples of how to create and add time series to system can be found in the Add Time Series Example

+ └─ SingleTimeSeries

Static Time Series Data

A static time series data is a single column of data where each time period has a single value assigned to a component field, such as its maximum active power. This data commonly is obtained from historical information or the realization of a time-varying quantity.

Static time series usually comes in the following format, with a set resolution between the time-stamps:

DateTimeValue
2020-09-01T00:00:00100.0
2020-09-01T01:00:00101.0
2020-09-01T02:00:0099.0

This example is a 1-hour resolution static time-series.

In PowerSystems, a static time series is represented using SingleTimeSeries.

Forecasts

A forecast time series includes predicted values of a time-varying quantity that commonly includes a look-ahead window 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.

Key forecast format parameters are the forecast resolution, the interval of time between forecast initial times, and the number of forecast windows (or forecasted values) in the forecast horizon.

Forecast data usually comes in the following format, where a column represents the time stamp associated with the initial time of the forecast, and the remaining columns represent the forecasted values at each step in the forecast horizon.

DateTime01234567
2020-09-01T00:00:00100.0101.0101.390.098.087.088.067.0
2020-09-01T01:00:00101.0101.399.098.088.988.367.189.4
2020-09-01T02:00:0099.067.089.099.9100.0101.0112.0101.3

This example forecast has a interval of 1 hour and a horizon of 8.

PowerSystems defines the following Julia structs to represent forecasts:

Data Storage

By default PowerSystems stores time series data in an HDF5 file. This prevents large datasets from overwhelming system memory. Refer to this page for details on how the time series data is stored in HDF5 files.

Time series data can be stored actual component values (for instance MW) or scaling factors intended to be multiplied by a scalar to generate the component values. By default PowerSystems treats the values in the time series data as physical units. In order to specify them as scaling factors, you must pass the accessor function that provides the multiplier value (e.g., get_time_series_array). The scaling factor multiplier must be passed into the forecast when you create it to use this option.

The time series contains fields for scaling_factor_multiplier and data to identify the details of th Component field that the time series describes, and the time series data. For example: we commonly want to use a time series to describe the maximum active power capability of a renewable generator. In this case, we can create a SingleTimeSeries with a TimeArray and an accessor function to the maximum active power field in the struct describing the generator. In this way, we can store a scaling factor time series that will get multiplied by the maximum active power rather than the magnitudes of the maximum active power time series.

Examples of how to create and add time series to system can be found in the Add Time Series Example

diff --git a/previews/PR1205/explanation/type_structure/index.html b/previews/PR1205/explanation/type_structure/index.html index 672af7b9c6..3462b6b74f 100644 --- a/previews/PR1205/explanation/type_structure/index.html +++ b/previews/PR1205/explanation/type_structure/index.html @@ -11,4 +11,4 @@ load_zone::Union{Nothing, LoadZone} ext::Dict{String, Any} internal::InfrastructureSystems.InfrastructureSystemsInternal -end

Type Hierarchy

PowerSystems is intended to organize data by the behavior of the devices that the data represents. A type hierarchy has been defined with several levels of abstract types starting with InfrastructureSystemsType. There are a bunch of subtypes of InfrastructureSystemsType, but the important ones to know about are:

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.

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.

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.

⠀ ```

+end

Type Hierarchy

PowerSystems is intended to organize data by the behavior of the devices that the data represents. A type hierarchy has been defined with several levels of abstract types starting with InfrastructureSystemsType. There are a bunch of subtypes of InfrastructureSystemsType, but the important ones to know about are:

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.

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.

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.

⠀ ```

diff --git a/previews/PR1205/how_to/add_component_natural_units/index.html b/previews/PR1205/how_to/add_component_natural_units/index.html index be828aab5e..39c26b8cba 100644 --- a/previews/PR1205/how_to/add_component_natural_units/index.html +++ b/previews/PR1205/how_to/add_component_natural_units/index.html @@ -16,4 +16,4 @@ must_run = false, prime_mover_type = PrimeMovers.CC, fuel = ThermalFuels.NATURAL_GAS, - );

Step 3: Attach the Component

Attach the component to your System:

julia> add_component!(system, gas1)

Step 4: Add Data with "setter" Functions

Use individual "setter" functions to set each the value of each numeric field in natural units:

julia> set_rating!(gas1, 30.0) #MVA1.0
julia> set_active_power_limits!(gas1, (min = 6.0, max = 30.0)) # MW(min = 0.2, max = 1.0)
julia> set_reactive_power_limits!(gas1, (min = 6.0, max = 30.0)) # MVAR(min = 0.2, max = 1.0)
julia> set_ramp_limits!(gas1, (up = 6.0, down = 6.0)) #MW/min(up = 0.2, down = 0.2)

Notice the return values are divided by the base_power of 30 MW, showing the setters have done the per-unit conversion into "DEVICE_BASE" behind the scenes.

Tip

Steps 2-4 can be called within a for loop to define many components at once (or step 3 can be replaced with add_components! to add all components at once).

See Also

+ );

Step 3: Attach the Component

Attach the component to your System:

julia> add_component!(system, gas1)

Step 4: Add Data with "setter" Functions

Use individual "setter" functions to set each the value of each numeric field in natural units:

julia> set_rating!(gas1, 30.0) #MVA1.0
julia> set_active_power_limits!(gas1, (min = 6.0, max = 30.0)) # MW(min = 0.2, max = 1.0)
julia> set_reactive_power_limits!(gas1, (min = 6.0, max = 30.0)) # MVAR(min = 0.2, max = 1.0)
julia> set_ramp_limits!(gas1, (up = 6.0, down = 6.0)) #MW/min(up = 0.2, down = 0.2)

Notice the return values are divided by the base_power of 30 MW, showing the setters have done the per-unit conversion into "DEVICE_BASE" behind the scenes.

Tip

Steps 2-4 can be called within a for loop to define many components at once (or step 3 can be replaced with add_components! to add all components at once).

See Also

diff --git a/previews/PR1205/how_to/add_cost_curve/index.html b/previews/PR1205/how_to/add_cost_curve/index.html index a0b84d1fab..09807fc89d 100644 --- a/previews/PR1205/how_to/add_cost_curve/index.html +++ b/previews/PR1205/how_to/add_cost_curve/index.html @@ -30,4 +30,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/previews/PR1205/how_to/add_new_types/index.html b/previews/PR1205/how_to/add_new_types/index.html index f2d41ff4b3..79b85bda59 100644 --- a/previews/PR1205/how_to/add_new_types/index.html +++ b/previews/PR1205/how_to/add_new_types/index.html @@ -36,4 +36,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/previews/PR1205/how_to/adding_additional_fields/index.html b/previews/PR1205/how_to/adding_additional_fields/index.html index 66a244f5bd..f73d9ca22a 100644 --- a/previews/PR1205/how_to/adding_additional_fields/index.html +++ b/previews/PR1205/how_to/adding_additional_fields/index.html @@ -2,4 +2,4 @@ ...add additional data to a component · PowerSystems.jl
GitHub

Adding additional data to a component

All PowerSystems.jl components have an ext field that contains an empty Dictionary. This Dictionary is useful to contain additional required data where there is no need to create new behaviors with that data. A simple example is the addition of geographic information, if needed.

Example

Step 1: Use get_ext to get the ext field of the desired components and assign your data:

julia> for g in get_components(ThermalStandard, system)
            external_field = get_ext(g)
            external_field["my_data"] = 1.0
-       end

Here, we added additional data called my_data to the ThermalStandard generators in a previously defined System.

Step 2: Retrieve your data using get_ext again

First, retrieve the first ThermalStandard generator:

julia> gen = collect(get_components(ThermalStandard, system))[1];

Then, retrieve my_data from the generator and verify it is 1.0, as assigned.

julia> retrieved_data = get_ext(gen)["my_data"]1.0
+ end

Here, we added additional data called my_data to the ThermalStandard generators in a previously defined System.

Step 2: Retrieve your data using get_ext again

First, retrieve the first ThermalStandard generator:

julia> gen = collect(get_components(ThermalStandard, system))[1];

Then, retrieve my_data from the generator and verify it is 1.0, as assigned.

julia> retrieved_data = get_ext(gen)["my_data"]1.0
diff --git a/previews/PR1205/how_to/get_available_generators/index.html b/previews/PR1205/how_to/get_available_generators/index.html index 845159d864..d8bcf16ede 100644 --- a/previews/PR1205/how_to/get_available_generators/index.html +++ b/previews/PR1205/how_to/get_available_generators/index.html @@ -15,17 +15,17 @@ "101_PV_2" "309_WIND_1" ⋮ - "118_RTPV_10" - "313_RTPV_10" - "118_RTPV_5" - "118_RTPV_1" - "118_RTPV_9" - "118_RTPV_6" - "313_RTPV_8" - "118_RTPV_4" - "201_HYDRO_4"
Tip

Above, we use the abstract supertype Generator to get all components that are subtypes of it. You can instead get all the components of a concrete type, such as:

julia> gen_iter = get_available_components(RenewableDispatch, system)RenewableDispatch Counts:
+ "301_CT_3"
+ "316_STEAM_1"
+ "216_STEAM_1"
+ "315_CT_6"
+ "201_STEAM_3"
+ "302_CT_4"
+ "307_CT_1"
+ "102_STEAM_4"
+ "107_CC_1"
Tip

Above, we use the abstract supertype Generator to get all components that are subtypes of it. You can instead get all the components of a concrete type, such as:

julia> gen_iter = get_available_components(RenewableDispatch, system)RenewableDispatch Counts:
 RenewableDispatch: 29

Option 1b: Using get_available_components to get a vector

Use collect to get a vector of the generators instead of an iterator, which could require a lot of memory:

julia> gens = collect(get_available_components(Generator, system));

Option 2: Using get_components to get an iterator

Alternatively, use get_components with a filter to check for availability:

julia> gen_iter = get_components(get_available, Generator, system)Generator Counts:
 HydroDispatch: 1
 RenewableDispatch: 29
 RenewableNonDispatch: 31
-ThermalStandard: 54

collect can also be used to turn this iterator into a vector.

See Also

+ThermalStandard: 54

collect can also be used to turn this iterator into a vector.

See Also

diff --git a/previews/PR1205/how_to/get_buses/index.html b/previews/PR1205/how_to/get_buses/index.html index 6e3d440695..3844c22071 100644 --- a/previews/PR1205/how_to/get_buses/index.html +++ b/previews/PR1205/how_to/get_buses/index.html @@ -79,4 +79,4 @@ 212 113 203 - 112

See Also

+ 112

See Also

diff --git a/previews/PR1205/how_to/improve_ts_performance/index.html b/previews/PR1205/how_to/improve_ts_performance/index.html index 27feed1fce..c11c3ddc43 100644 --- a/previews/PR1205/how_to/improve_ts_performance/index.html +++ b/previews/PR1205/how_to/improve_ts_performance/index.html @@ -46,4 +46,4 @@ # or for window in cache @show window -end

Each iteration of on the cache object will deliver the next forecast window (see get_next_time_series_array!).

+end

Each iteration of on the cache object will deliver the next forecast window (see get_next_time_series_array!).

diff --git a/previews/PR1205/how_to/install/index.html b/previews/PR1205/how_to/install/index.html index d42cebddda..09fad9fe3f 100644 --- a/previews/PR1205/how_to/install/index.html +++ b/previews/PR1205/how_to/install/index.html @@ -8,4 +8,4 @@ _/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release |__/ | -julia>

If not, go back to check the Julia installation steps.

Step 3: Install PowerSystems.jl

Install the latest stable release of PowerSystems.jl using the Julia package manager with:

] add PowerSystems

Once you type ], you will see the prompt change color as it activates the Julia package manager. This command may take a few minutes to download the packages and compile them.

Press the delete or backspace key to return to the REPL.

Install is complete!

Alternate

To use the current development version instead, "checkout" the main branch of this package with:

] add PowerSystems#main
Note

PowerSystems.jl uses InfrastructureSystems.jl as a utility library. Many methods are re-exported from InfrastructureSystems.jl. For most users there is no need to import InfrastructureSystems.jl.

+julia>

If not, go back to check the Julia installation steps.

Step 3: Install PowerSystems.jl

Install the latest stable release of PowerSystems.jl using the Julia package manager with:

] add PowerSystems

Once you type ], you will see the prompt change color as it activates the Julia package manager. This command may take a few minutes to download the packages and compile them.

Press the delete or backspace key to return to the REPL.

Install is complete!

Alternate

To use the current development version instead, "checkout" the main branch of this package with:

] add PowerSystems#main
Note

PowerSystems.jl uses InfrastructureSystems.jl as a utility library. Many methods are re-exported from InfrastructureSystems.jl. For most users there is no need to import InfrastructureSystems.jl.

diff --git a/previews/PR1205/how_to/market_bid_cost/index.html b/previews/PR1205/how_to/market_bid_cost/index.html index 6b2752f095..512a1c17df 100644 --- a/previews/PR1205/how_to/market_bid_cost/index.html +++ b/previews/PR1205/how_to/market_bid_cost/index.html @@ -149,7 +149,7 @@ name = "variable_cost", data = data, resolution = Dates.Hour(1), - )Deterministic("variable_cost", DataStructures.SortedDict{Dates.DateTime, Vector{PiecewiseStepData}, Base.Order.ForwardOrdering}(Dates.DateTime("2020-01-01T00:00:00") => [PiecewiseStepData([5.0, 7.33, 9.67, 12.0], [2.901, 5.8272, 8.941]), PiecewiseStepData([5.0, 7.33, 9.67, 12.0], [3.001, 6.0072, 9.001])]), Dates.Hour(1), nothing, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("261759ff-a032-4e9d-a39e-564e7e64d084"), nothing, nothing, nothing))

Step 3a: Adding Energy Bid TimeSeriesData to the device

To add energy market bids time-series to the MarketBidCost, use set_variable_cost!. The arguments for set_variable_cost! are:

Currently, time series data only supports natural units for time series data, i.e. MW for power and /MWh for marginal costs.

julia> sys = System(100.0, [bus], [generator])┌ Warning: There are no ElectricLoad Components in the System
+       )Deterministic("variable_cost", DataStructures.SortedDict{Dates.DateTime, Vector{PiecewiseStepData}, Base.Order.ForwardOrdering}(Dates.DateTime("2020-01-01T00:00:00") => [PiecewiseStepData([5.0, 7.33, 9.67, 12.0], [2.901, 5.8272, 8.941]), PiecewiseStepData([5.0, 7.33, 9.67, 12.0], [3.001, 6.0072, 9.001])]), Dates.Hour(1), nothing, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("6dced6d8-5b66-4733-8120-31454bee7303"), nothing, nothing, nothing))

Step 3a: Adding Energy Bid TimeSeriesData to the device

To add energy market bids time-series to the MarketBidCost, use set_variable_cost!. The arguments for set_variable_cost! are:

Currently, time series data only supports natural units for time series data, i.e. MW for power and /MWh for marginal costs.

julia> sys = System(100.0, [bus], [generator])┌ Warning: There are no ElectricLoad Components in the System
 └ @ PowerSystems ~/work/PowerSystems.jl/PowerSystems.jl/src/utils/IO/system_checks.jl:59
 System
 ┌───────────────────┬─────────────┐
@@ -189,4 +189,4 @@
            name = get_name(service),
            data = data,
            resolution = Dates.Hour(1),
-       )Deterministic("example_reserve", DataStructures.SortedDict{Dates.DateTime, Vector{PiecewiseStepData}, Base.Order.ForwardOrdering}(Dates.DateTime("2020-01-01T00:00:00") => [PiecewiseStepData([0.0, 10.0], [650.3]), PiecewiseStepData([0.0, 10.0], [750.0])]), Dates.Hour(1), nothing, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("d0a2999f-8d25-4c9c-ab7b-64c2e7029643"), nothing, nothing, nothing))
julia> set_service_bid!(sys, generator, service, time_series_data, UnitSystem.NATURAL_UNITS)
+ )Deterministic("example_reserve", DataStructures.SortedDict{Dates.DateTime, Vector{PiecewiseStepData}, Base.Order.ForwardOrdering}(Dates.DateTime("2020-01-01T00:00:00") => [PiecewiseStepData([0.0, 10.0], [650.3]), PiecewiseStepData([0.0, 10.0], [750.0])]), Dates.Hour(1), nothing, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("172f5ab7-ff24-4795-8f2b-7530b0bd3130"), nothing, nothing, nothing))
julia> set_service_bid!(sys, generator, service, time_series_data, UnitSystem.NATURAL_UNITS) diff --git a/previews/PR1205/how_to/migrating_to_psy4/index.html b/previews/PR1205/how_to/migrating_to_psy4/index.html index 13e26a42b5..54fa7b8f3a 100644 --- a/previews/PR1205/how_to/migrating_to_psy4/index.html +++ b/previews/PR1205/how_to/migrating_to_psy4/index.html @@ -1,2 +1,2 @@ -...migrate from version 3.0 to 4.0 · PowerSystems.jl
GitHub

Migrating from version 3.0 to 4.0

This guide outlines the code updates required to upgrade from PowerSystems.jl version 3.0 to 4.0, which was released in June 2024 and includes breaking changes. These are:

Renamed Types and Parameters

Some Types and fields were renamed, which should require a trivial search and replace:

Renamed Types:

Renamed parameters:

New and Eliminated Types

In addition to cost-related types detailed in New Cost Functions, these new types have been added:

These types are no longer part of PowerSystems.jl, although there are future plans to rework some of them:

Updates to Energy Storage Parameters

EnergyReservoirStorage is now the default battery and energy storage model, replacing GenericBattery.

There are also changes to the data fields compared to GenericBattery to improve clarity and modeling flexibility.

New data fields:

  • storage_capacity for the maximum storage capacity (can be in units of, e.g., MWh for batteries or liters for hydrogen)

    • Example: 10000.0 for 10,000 liters hydrogen

  • storage_level_limits for the minimum and maximum allowable storage levels on [0, 1], which can be used to model derates or other restrictions, such as state-of-charge restrictions on battery cycling

    • Example: Minimum of 0.2 and maximum of 1.0 to restrict the storage from dropping below 20% capacity to keep some reserve margin available at all times

  • initial_storage_capacity_level for the initial storage capacity level as a ratio [0, 1.0] of storage_capacity

    • Example: 0.5 to start the storage at 50% full

  • conversion_factor is the (optional) conversion factor of storage_capacity to MWh, if different than 1.0 (i.e., no conversion is needed if the storage_capacity is in MWh)

    • Example: 0.0005 for 0.5 kWh/l hydrogen

Removed data fields:

  • state_of_charge_limits with units of p.u.-hr
  • initial_energy with units of p.u.-hr

Hydropower status added

A new required parameter, status, was added to HydroEnergyReservoir and HydroPumpedStorage, for the initial condition of the generator.

New Cost Functions

New Time Series Horizon Format

The horizon for a forecast has changed from a count of time steps (as an Int) to a duration, as a Dates.Period

Example day-ahead forecast: A forecast with hourly resolution for the next 24 hours, with a new forecast available every 24 hours (i.e., 24-hour interval)

  • The horizon is now Dates.Hour(24) or Dates.Day(1)
  • Previously in version 3.0, the horizon would have been 24 for the 24 1-hour time-steps in each forecast

Example hour-ahead forecast: A forecast with 5-minute resolution for the next 1 hour, with a new forecast available every hour (i.e., 1-hour interval)

  • The horizon is now Dates.Hour(1)
  • Previously in version 3.0, the horizon would have been 12 for the 12 5-minute time-steps in each forecast

Minor Type Hierarchy Change

The vast majority of users are not expected to be impacted by this change.

(Temporary) Use Version 3.0 for HybridSystem (+ new parameter)

The HybridSystem is currently not supported in the rest of the Sienna ecosystem, such as PowerSimulations.jl. To use HybridSystem in simulation, revert to version 3.0. There are plans to update HybridSystem for version 4.0, but they have not been completed.

In addition, HybridSystem has a new required parameter: interconnection_efficiency

+...migrate from version 3.0 to 4.0 · PowerSystems.jl
GitHub

Migrating from version 3.0 to 4.0

This guide outlines the code updates required to upgrade from PowerSystems.jl version 3.0 to 4.0, which was released in June 2024 and includes breaking changes. These are:

Renamed Types and Parameters

Some Types and fields were renamed, which should require a trivial search and replace:

Renamed Types:

Renamed parameters:

New and Eliminated Types

In addition to cost-related types detailed in New Cost Functions, these new types have been added:

These types are no longer part of PowerSystems.jl, although there are future plans to rework some of them:

Updates to Energy Storage Parameters

EnergyReservoirStorage is now the default battery and energy storage model, replacing GenericBattery.

There are also changes to the data fields compared to GenericBattery to improve clarity and modeling flexibility.

New data fields:

  • storage_capacity for the maximum storage capacity (can be in units of, e.g., MWh for batteries or liters for hydrogen)

    • Example: 10000.0 for 10,000 liters hydrogen

  • storage_level_limits for the minimum and maximum allowable storage levels on [0, 1], which can be used to model derates or other restrictions, such as state-of-charge restrictions on battery cycling

    • Example: Minimum of 0.2 and maximum of 1.0 to restrict the storage from dropping below 20% capacity to keep some reserve margin available at all times

  • initial_storage_capacity_level for the initial storage capacity level as a ratio [0, 1.0] of storage_capacity

    • Example: 0.5 to start the storage at 50% full

  • conversion_factor is the (optional) conversion factor of storage_capacity to MWh, if different than 1.0 (i.e., no conversion is needed if the storage_capacity is in MWh)

    • Example: 0.0005 for 0.5 kWh/l hydrogen

Removed data fields:

  • state_of_charge_limits with units of p.u.-hr
  • initial_energy with units of p.u.-hr

Hydropower status added

A new required parameter, status, was added to HydroEnergyReservoir and HydroPumpedStorage, for the initial condition of the generator.

New Cost Functions

New Time Series Horizon Format

The horizon for a forecast has changed from a count of time steps (as an Int) to a duration, as a Dates.Period

Example day-ahead forecast: A forecast with hourly resolution for the next 24 hours, with a new forecast available every 24 hours (i.e., 24-hour interval)

  • The horizon is now Dates.Hour(24) or Dates.Day(1)
  • Previously in version 3.0, the horizon would have been 24 for the 24 1-hour time-steps in each forecast

Example hour-ahead forecast: A forecast with 5-minute resolution for the next 1 hour, with a new forecast available every hour (i.e., 1-hour interval)

  • The horizon is now Dates.Hour(1)
  • Previously in version 3.0, the horizon would have been 12 for the 12 5-minute time-steps in each forecast

Minor Type Hierarchy Change

The vast majority of users are not expected to be impacted by this change.

(Temporary) Use Version 3.0 for HybridSystem (+ new parameter)

The HybridSystem is currently not supported in the rest of the Sienna ecosystem, such as PowerSimulations.jl. To use HybridSystem in simulation, revert to version 3.0. There are plans to update HybridSystem for version 4.0, but they have not been completed.

In addition, HybridSystem has a new required parameter: interconnection_efficiency

diff --git a/previews/PR1205/how_to/parse_dynamic_data/index.html b/previews/PR1205/how_to/parse_dynamic_data/index.html index 745d791a69..ec20b54c84 100644 --- a/previews/PR1205/how_to/parse_dynamic_data/index.html +++ b/previews/PR1205/how_to/parse_dynamic_data/index.html @@ -169,4 +169,4 @@ │ DynamicGenerator{BaseMachine, SingleMass, AVRFixed, TGFixed, PSSFixed} ⋯ │ DynamicGenerator{RoundRotorExponential, SingleMass, ESST1A, TGFixed, PSSFixe ⋯ └─────────────────────────────────────────────────────────────────────────────── - 2 columns omitted

In this example the anonymous function x -> strip(string(x["name"])) * "-" * string(x["index"]) takes the bus name and index from PSSe and concatenates them to produce the name.

See also:

+ 2 columns omitted

In this example the anonymous function x -> strip(string(x["name"])) * "-" * string(x["index"]) takes the bus name and index from PSSe and concatenates them to produce the name.

See also:

diff --git a/previews/PR1205/how_to/parse_matpower_psse/index.html b/previews/PR1205/how_to/parse_matpower_psse/index.html index 3ffc7208c9..c32f3fd3db 100644 --- a/previews/PR1205/how_to/parse_matpower_psse/index.html +++ b/previews/PR1205/how_to/parse_matpower_psse/index.html @@ -45,4 +45,4 @@ │ PhaseShiftingTransformer │ 2 │ │ PowerLoad │ 3 │ │ ThermalStandard │ 5 │ -└──────────────────────────┴───────┘

This parsing code was copied with permission from PowerModels.jl.

See also:

+└──────────────────────────┴───────┘

This parsing code was copied with permission from PowerModels.jl.

See also:

diff --git a/previews/PR1205/how_to/parse_tabular_data/index.html b/previews/PR1205/how_to/parse_tabular_data/index.html index fc3d045433..677056edd6 100644 --- a/previews/PR1205/how_to/parse_tabular_data/index.html +++ b/previews/PR1205/how_to/parse_tabular_data/index.html @@ -15,4 +15,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.

See also:

+end

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

See also:

diff --git a/previews/PR1205/how_to/parse_ts_from_csvs/index.html b/previews/PR1205/how_to/parse_ts_from_csvs/index.html index a099ba54bc..4971583b45 100644 --- a/previews/PR1205/how_to/parse_ts_from_csvs/index.html +++ b/previews/PR1205/how_to/parse_ts_from_csvs/index.html @@ -91,11 +91,11 @@ "data_file": "./load/da_load5.csv" } ]

Read and assign time series to System using these parameters.

julia> fname = joinpath(FORECASTS_DIR, "timeseries_pointers_da.json")"/home/runner/.julia/artifacts/afb608473cf4d5eb22147856de1a1a651f36d40b/PowerSystemsTestData-3.1/5-Bus/5bus_ts/timeseries_pointers_da.json"
julia> add_time_series!(sys, fname)5-element Vector{TimeSeriesKey}:
- StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-22T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())
- StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-22T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())
- StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-22T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())
- StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-22T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())
- StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-22T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())

You can print the System to see a new table summarizing the time series data that has been added:

julia> sysSystem
+ StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-24T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())
+ StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-24T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())
+ StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-24T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())
+ StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-24T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())
+ StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2024-10-24T00:00:00"), Dates.Millisecond(3600000), 24, Dict{String, Any}())

You can print the System to see a new table summarizing the time series data that has been added:

julia> sysSystem
 ┌───────────────────┬─────────────┐
 │ Property          │ Value       │
 ├───────────────────┼─────────────┤
@@ -130,4 +130,4 @@
 │ PowerLoad         │ Component      │ SingleTimeSeries │ StaticTimeSeries     ⋯
 │ RenewableDispatch │ Component      │ SingleTimeSeries │ StaticTimeSeries     ⋯
 └───────────────────┴────────────────┴──────────────────┴───────────────────────
-                                                               3 columns omitted

See also:

+ 3 columns omitted

See also:

diff --git a/previews/PR1205/how_to/powersystembuilder/index.html b/previews/PR1205/how_to/powersystembuilder/index.html index d3dee94224..41f7fefe5a 100644 --- a/previews/PR1205/how_to/powersystembuilder/index.html +++ b/previews/PR1205/how_to/powersystembuilder/index.html @@ -269,4 +269,4 @@ ├────────────┼────────────────┼──────────────────┼──────────────────────┼─────── │ PowerLoad │ Component │ Deterministic │ Forecast │ 2024 ⋯ └────────────┴────────────────┴──────────────────┴──────────────────────┴─────── - 3 columns omitted + 3 columns omitted diff --git a/previews/PR1205/how_to/reduce_repl_printing/index.html b/previews/PR1205/how_to/reduce_repl_printing/index.html index 0b695986b7..1e601d40b1 100644 --- a/previews/PR1205/how_to/reduce_repl_printing/index.html +++ b/previews/PR1205/how_to/reduce_repl_printing/index.html @@ -1,4 +1,4 @@ ...reduce REPL printing · PowerSystems.jl
GitHub

Reduce REPL printing

By default PowerSystems.jl outputs to the REPL all Logging statements, which can be overwhelming in some cases.

Use configure_logging to create a logger with your preferences for which logging statements should be printed to the console or a log file:

Example: Set log output to only see error messages in the console

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.

+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.

diff --git a/previews/PR1205/how_to/serialize_data/index.html b/previews/PR1205/how_to/serialize_data/index.html index 62d1832895..90875975d1 100644 --- a/previews/PR1205/how_to/serialize_data/index.html +++ b/previews/PR1205/how_to/serialize_data/index.html @@ -39,7 +39,7 @@ 3 columns omitted

Set up your target path, for example in a "mysystems" subfolder:

julia> folder = mkdir("mysystems");
julia> path = joinpath(folder, "system.json")"mysystems/system.json"

Now write the system to JSON:

julia> to_json(sys, path)[ Info: Serialized time series data to mysystems/system_time_series_storage.h5.
 [ Info: Serialized System to mysystems/system.json
 [ Info: Serialized System metadata to mysystems/system_metadata.json

Notice in the Info statements that 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)

Viewing PowerSystems Data in JSON Format

Some users prefer to view and filter the PowerSystems.jl data while it is in JSON 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. Below are some example commands, called from the command line within the "mysystems" subfolder:

View the entire file pretty-printed:

jq . system.json

View the PowerSystems component types:

jq '.data.components | .[] | .__metadata__ | .type' system.json | sort | uniq

View specific components:

jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard")' system.json

Get the count of a component type:

# There is almost certainly a better way.
-jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard")' system.json | grep -c ThermalStandard

View specific component by name:

jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard" and .name == "107_CC_1")' system.json

Filter on a field value:

jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard" and .active_power > 2.3)' system.json

Read the JSON file and create a new System

Finally, you can read the file back in, and verify the new system has the same data as above:

julia> sys2 = System(path)[ Info: Loaded time series from storage file existing=mysystems/system_time_series_storage.h5 new=/tmp/jl_UCRyxP compression=CompressionSettings(false, CompressionTypes.DEFLATE = 1, 3, true)
+jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard")' system.json | grep -c ThermalStandard

View specific component by name:

jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard" and .name == "107_CC_1")' system.json

Filter on a field value:

jq '.data.components | .[] | select(.__metadata__.type == "ThermalStandard" and .active_power > 2.3)' system.json

Read the JSON file and create a new System

Finally, you can read the file back in, and verify the new system has the same data as above:

julia> sys2 = System(path)[ Info: Loaded time series from storage file existing=mysystems/system_time_series_storage.h5 new=/tmp/jl_mvpfm6 compression=CompressionSettings(false, CompressionTypes.DEFLATE = 1, 3, true)
 System
 ┌───────────────────┬─────────────┐
 │ Property          │ Value       │
@@ -72,4 +72,4 @@
 │ PowerLoad         │ Component      │ SingleTimeSeries │ StaticTimeSeries     ⋯
 │ RenewableDispatch │ Component      │ SingleTimeSeries │ StaticTimeSeries     ⋯
 └───────────────────┴────────────────┴──────────────────┴───────────────────────
-                                                               3 columns omitted
Tip

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(path; assign_new_uuids = true)
+ 3 columns omitted
Tip

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(path; assign_new_uuids = true)
diff --git a/previews/PR1205/index.html b/previews/PR1205/index.html index 3c0684621f..f8abeb1734 100644 --- a/previews/PR1205/index.html +++ b/previews/PR1205/index.html @@ -1,2 +1,2 @@ -Welcome Page · PowerSystems.jl
GitHub

Welcome to PowerSystems.jl

Announcement

PowerSystems.jl upgraded to version 4.0 in June 2024, which included breaking changes. Visit the v4.0 migration guide for information on how to update your existing code.

We also have re-organized and updated this documentation, including new tutorials! Check out How To Use This Documentation below to orient yourself.

About

PowerSystems.jl is part of the National Renewable Energy Laboratory's Sienna ecosystem, an open source framework for scheduling problems and dynamic simulations for power systems. The Sienna ecosystem can be found on github. It contains three applications:

  • Sienna\Data enables efficient data input, analysis, and transformation
  • Sienna\Ops enables enables system scheduling simulations by formulating and solving optimization problems
  • Sienna\Dyn enables system transient analysis including small signal stability and full system dynamic simulations

Each application uses multiple packages in the Julia programming language.

PowerSystems.jl is the foundation of Sienna\Data, and it is used with all three applications. It provides a rigorous data model using Julia structures to enable power systems modeling. PowerSystems.jl is agnostic to a specific mathematical model and can be used for many model categories.

PowerSystems.jl provides tools to prepare and process data useful for electric energy systems modeling. This package serves two purposes:

  1. It facilitates the development and open sharing of large data sets for Power Systems modeling
  2. It provides a data model that imposes discipline on model specification, addressing the challenge of design and terminology choices when sharing code and data.

The main features include:

  • Comprehensive and extensible library of data structures for electric systems modeling.
  • Large scale data set development tools based on common text based data formats (PSS/e .raw and .dyr, and MATPOWER) and configurable tabular data (e.g. CSV) parsing capabilities.
  • Optimized container for component data and time series supporting serialization to portable file formats and configurable validation routines.

How To Use This Documentation

There are five main sections containing different information:

  • Tutorials - Detailed walk-throughs to help you learn how to use PowerSystems.jl
  • How to... - Directions to help guide your work for a particular task
  • Explanation - Additional details and background information to help you understand PowerSystems.jl, its structure, and how it works behind the scenes
  • Reference - Technical references and API for a quick look-up during your work
  • Model Library - Technical references of the data types and their functions that PowerSystems.jl uses to model power system components

PowerSystems.jl strives to follow the Diataxis documentation framework.

Getting Started

If you are new to PowerSystems.jl, here's how we suggest getting started:

  1. Install

  2. Work through the introductory tutorial: Create and Explore a Power System to familiarize yourself with how PowerSystems.jl works

  3. Work through the other basic tutorials based on your interests

  4. Then, see the how-to's on parsing Matpower or PSS/e files or CSV files to begin loading your own data into PowerSystems.jl

+Welcome Page · PowerSystems.jl
GitHub

Welcome to PowerSystems.jl

Announcement

PowerSystems.jl upgraded to version 4.0 in June 2024, which included breaking changes. Visit the v4.0 migration guide for information on how to update your existing code.

We also have re-organized and updated this documentation, including new tutorials! Check out How To Use This Documentation below to orient yourself.

About

PowerSystems.jl is part of the National Renewable Energy Laboratory's Sienna ecosystem, an open source framework for scheduling problems and dynamic simulations for power systems. The Sienna ecosystem can be found on github. It contains three applications:

  • Sienna\Data enables efficient data input, analysis, and transformation
  • Sienna\Ops enables enables system scheduling simulations by formulating and solving optimization problems
  • Sienna\Dyn enables system transient analysis including small signal stability and full system dynamic simulations

Each application uses multiple packages in the Julia programming language.

PowerSystems.jl is the foundation of Sienna\Data, and it is used with all three applications. It provides a rigorous data model using Julia structures to enable power systems modeling. PowerSystems.jl is agnostic to a specific mathematical model and can be used for many model categories.

PowerSystems.jl provides tools to prepare and process data useful for electric energy systems modeling. This package serves two purposes:

  1. It facilitates the development and open sharing of large data sets for Power Systems modeling
  2. It provides a data model that imposes discipline on model specification, addressing the challenge of design and terminology choices when sharing code and data.

The main features include:

  • Comprehensive and extensible library of data structures for electric systems modeling.
  • Large scale data set development tools based on common text based data formats (PSS/e .raw and .dyr, and MATPOWER) and configurable tabular data (e.g. CSV) parsing capabilities.
  • Optimized container for component data and time series supporting serialization to portable file formats and configurable validation routines.

How To Use This Documentation

There are five main sections containing different information:

  • Tutorials - Detailed walk-throughs to help you learn how to use PowerSystems.jl
  • How to... - Directions to help guide your work for a particular task
  • Explanation - Additional details and background information to help you understand PowerSystems.jl, its structure, and how it works behind the scenes
  • Reference - Technical references and API for a quick look-up during your work
  • Model Library - Technical references of the data types and their functions that PowerSystems.jl uses to model power system components

PowerSystems.jl strives to follow the Diataxis documentation framework.

Getting Started

If you are new to PowerSystems.jl, here's how we suggest getting started:

  1. Install

  2. Work through the introductory tutorial: Create and Explore a Power System to familiarize yourself with how PowerSystems.jl works

  3. Work through the other basic tutorials based on your interests

  4. Then, see the how-to's on parsing Matpower or PSS/e files or CSV files to begin loading your own data into PowerSystems.jl

diff --git a/previews/PR1205/model_library/dynamic_branch/index.html b/previews/PR1205/model_library/dynamic_branch/index.html index 03fe283008..8063e7aaad 100644 --- a/previews/PR1205/model_library/dynamic_branch/index.html +++ b/previews/PR1205/model_library/dynamic_branch/index.html @@ -1,50 +1,50 @@ -Dynamic Lines · PowerSystems.jl
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
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/previews/PR1205/model_library/dynamic_generator/index.html b/previews/PR1205/model_library/dynamic_generator/index.html index 14b1bfca08..939d3c93bc 100644 --- a/previews/PR1205/model_library/dynamic_generator/index.html +++ b/previews/PR1205/model_library/dynamic_generator/index.html @@ -18,4 +18,4 @@ states::Vector{Symbol} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A dynamic generator with the necessary data for modeling the dynamic response of a generator in a phasor or electromagnetic transient simulation.

Dynamic generator is composed by 5 components, namely a Machine, a Shaft, an Automatic Voltage Regulator (AVR), a Prime Mover and Turbine Governor, and Power System Stabilizer (PSS). It must be attached to a StaticInjection device using add_component!, which contains all the rest of the generator's data that isn't specific to its dynamic response.

Arguments

source +end

A dynamic generator with the necessary data for modeling the dynamic response of a generator in a phasor or electromagnetic transient simulation.

Dynamic generator is composed by 5 components, namely a Machine, a Shaft, an Automatic Voltage Regulator (AVR), a Prime Mover and Turbine Governor, and Power System Stabilizer (PSS). It must be attached to a StaticInjection device using add_component!, which contains all the rest of the generator's data that isn't specific to its dynamic response.

Arguments

source diff --git a/previews/PR1205/model_library/dynamic_inverter/index.html b/previews/PR1205/model_library/dynamic_inverter/index.html index 3ae44aa8d9..ef5d8a9474 100644 --- a/previews/PR1205/model_library/dynamic_inverter/index.html +++ b/previews/PR1205/model_library/dynamic_inverter/index.html @@ -21,4 +21,4 @@ states::Vector{Symbol} ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

A dynamic inverter with the necessary data for modeling the dynamic response of an inverter in a phasor or electromagnetic transient simulation.

A dynamic inverter is composed by 6 components, namely a Converter, Outer Loop Control, Inner Loop Control, a DC Source, a Frequency Estimator and a Filter.

It must be attached to a StaticInjection device using add_component!, which contains all the rest of the generator's data that isn't specific to its dynamic response.

Arguments

source +end

A dynamic inverter with the necessary data for modeling the dynamic response of an inverter in a phasor or electromagnetic transient simulation.

A dynamic inverter is composed by 6 components, namely a Converter, Outer Loop Control, Inner Loop Control, a DC Source, a Frequency Estimator and a Filter.

It must be attached to a StaticInjection device using add_component!, which contains all the rest of the generator's data that isn't specific to its dynamic response.

Arguments

source diff --git a/previews/PR1205/model_library/generated_ACBus/index.html b/previews/PR1205/model_library/generated_ACBus/index.html index 7484f0e89b..60f9305ce1 100644 --- a/previews/PR1205/model_library/generated_ACBus/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_AGC/index.html b/previews/PR1205/model_library/generated_AGC/index.html index 3908f4ea70..2ba033594f 100644 --- a/previews/PR1205/model_library/generated_AGC/index.html +++ b/previews/PR1205/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/previews/PR1205/model_library/generated_AVR/index.html b/previews/PR1205/model_library/generated_AVR/index.html index a81d105359..0af3213177 100644 --- a/previews/PR1205/model_library/generated_AVR/index.html +++ b/previews/PR1205/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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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

ESAC8B

PowerSystems.ESAC8B — Type
mutable struct ESAC8B <: 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

ESAC8B

PowerSystems.ESAC8B — Type
mutable struct ESAC8B <: AVR
     Tr::Float64
     Kp::Float64
     Ki::Float64
@@ -317,45 +317,45 @@
 x_i: Internal PI-block state,
 x_d: Internal Derivative-block state,
 Vr: Voltage regulator state,
-Efd: Exciter output state
  • n_states::Int: (Do not modify.) ESAC8B has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ESAC8B has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_E_sat — Method
get_E_sat(value::ESAC8B) -> Tuple{Float64, Float64}
-

Get ESAC8B E_sat.

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

Get ESAC8B Ka.

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

Get ESAC8B Kd.

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

Get ESAC8B Ke.

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

Get ESAC8B Ki.

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

Get ESAC8B Kp.

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

Get ESAC8B Se.

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

Get ESAC8B Ta.

source
PowerSystems.get_Td — Method
get_Td(value::ESAC8B) -> Float64
-

Get ESAC8B Td.

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

Get ESAC8B Te.

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

Get ESAC8B Tr.

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

Get ESAC8B V_ref.

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

Get ESAC8B E_sat.

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

Get ESAC8B Ka.

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

Get ESAC8B Kd.

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

Get ESAC8B Ke.

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

Get ESAC8B Ki.

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

Get ESAC8B Kp.

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

Get ESAC8B Se.

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

Get ESAC8B Ta.

source
PowerSystems.get_Td — Method
get_Td(value::ESAC8B) -> Float64
+

Get ESAC8B Td.

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

Get ESAC8B Te.

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

Get ESAC8B Tr.

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

Get ESAC8B V_ref.

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

Get ESAC8B Vr_lim.

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

Get ESAC8B ext.

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

Get ESAC8B n_states.

source
PowerSystems.get_saturation_coeffs — Method
get_saturation_coeffs(
+

Get ESAC8B Vr_lim.

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

Get ESAC8B ext.

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

Get ESAC8B n_states.

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

Get ESAC8B saturation_coeffs.

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

Get ESAC8B states.

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

Get ESAC8B states_types.

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

Set ESAC8B E_sat.

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

Set ESAC8B Ka.

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

Set ESAC8B Kd.

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

Set ESAC8B Ke.

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

Set ESAC8B Ki.

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

Set ESAC8B Kp.

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

Set ESAC8B Se.

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

Set ESAC8B Ta.

source
PowerSystems.set_Td! — Method
set_Td!(value::ESAC8B, val) -> Any
-

Set ESAC8B Td.

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

Set ESAC8B Te.

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

Set ESAC8B Tr.

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

Set ESAC8B V_ref.

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

Set ESAC8B Vr_lim.

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

Set ESAC8B ext.

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

Set ESAC8B saturation_coeffs.

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

Set ESAC8B states_types.

source

ESDC1A

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

Get ESAC8B saturation_coeffs.

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

Get ESAC8B states.

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

Get ESAC8B states_types.

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

Set ESAC8B E_sat.

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

Set ESAC8B Ka.

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

Set ESAC8B Kd.

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

Set ESAC8B Ke.

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

Set ESAC8B Ki.

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

Set ESAC8B Kp.

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

Set ESAC8B Se.

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

Set ESAC8B Ta.

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

Set ESAC8B Td.

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

Set ESAC8B Te.

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

Set ESAC8B Tr.

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

Set ESAC8B V_ref.

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

Set ESAC8B Vr_lim.

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

Set ESAC8B ext.

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

Set ESAC8B saturation_coeffs.

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

Set ESAC8B states_types.

source

ESDC1A

PowerSystems.ESDC1A — Type
mutable struct ESDC1A <: AVR
     Tr::Float64
     Ka::Float64
     Ta::Float64
@@ -380,47 +380,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
@@ -445,47 +445,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
@@ -513,53 +513,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
@@ -586,51 +586,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
@@ -656,49 +656,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
@@ -725,53 +725,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
@@ -802,61 +802,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
@@ -889,63 +889,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
@@ -967,107 +967,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.
  • 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
@@ -1082,31 +1082,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.
  • 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
@@ -1118,27 +1118,27 @@
     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.
  • 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.
  • 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

ST6B

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

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

ST6B

PowerSystems.ST6B — Type
mutable struct ST6B <: AVR
     OEL_Flag::Int
     Tr::Float64
     K_pa::Float64
@@ -1163,49 +1163,49 @@
 end

In these excitation systems, voltage (and also current in compounded systems) is transformed to an appropriate level. Rectifiers, either controlled or non-controlled, provide the necessary direct current for the generator field. Parameters of IEEE Std 421.5 Type ST6B Excitacion System. ST6B in PSSE and PSLF

Arguments

  • OEL_Flag::Int: OEL Flag for ST6B: 1: before HV gate, 2: after HV gate, validation range: (0, 2)
  • Tr::Float64: Regulator input filter time constant in s, validation range: (0, nothing)
  • K_pa::Float64: Regulator proportional gain, validation range: (0, nothing)
  • K_ia::Float64: Regulator integral gain, validation range: (0, nothing)
  • K_da::Float64: Regulator derivative gain, validation range: (0, nothing)
  • T_da::Float64: Voltage regulator derivative channel time constant in s, validation range: (0, nothing)
  • Va_lim::MinMax: Regulator output limits (Vimin, Vimax)
  • K_ff::Float64: Pre-control gain of the inner loop field regulator, validation range: (0, nothing)
  • K_m::Float64: Forward gain of the inner loop field regulator, validation range: (0, nothing)
  • K_ci::Float64: Exciter output current limit adjustment gain, validation range: (0, nothing)
  • K_lr::Float64: Exciter output current limiter gain, validation range: (0, nothing)
  • I_lr::Float64: Exciter current limiter reference, validation range: (0, nothing)
  • Vr_lim::MinMax: Voltage regulator limits (Vimin, Vimax)
  • Kg::Float64: Feedback gain constant of the inner loop field regulator, validation range: (0, nothing)
  • Tg::Float64: Feedback time constant of the inner loop field voltage regulator in s, 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.
  • states::Vector{Symbol}: (Do not modify.) The states are:
Vm: Sensed terminal voltage,
 x_i: Regulator Integrator,
 x_d: Regulator Derivative,
-Vg: Regulator Feedback
  • n_states::Int: (Do not modify.) ST6B has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) ST6B has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_I_lr — Method
get_I_lr(value::ST6B) -> Float64
-

Get ST6B I_lr.

source
PowerSystems.get_K_ci — Method
get_K_ci(value::ST6B) -> Float64
-

Get ST6B K_ci.

source
PowerSystems.get_K_da — Method
get_K_da(value::ST6B) -> Float64
-

Get ST6B K_da.

source
PowerSystems.get_K_ff — Method
get_K_ff(value::ST6B) -> Float64
-

Get ST6B K_ff.

source
PowerSystems.get_K_ia — Method
get_K_ia(value::ST6B) -> Float64
-

Get ST6B K_ia.

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

Get ST6B K_lr.

source
PowerSystems.get_K_m — Method
get_K_m(value::ST6B) -> Float64
-

Get ST6B K_m.

source
PowerSystems.get_K_pa — Method
get_K_pa(value::ST6B) -> Float64
-

Get ST6B K_pa.

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

Get ST6B Kg.

source
PowerSystems.get_OEL_Flag — Method
get_OEL_Flag(value::ST6B) -> Int64
-

Get ST6B OEL_Flag.

source
PowerSystems.get_T_da — Method
get_T_da(value::ST6B) -> Float64
-

Get ST6B T_da.

source
PowerSystems.get_Tg — Method
get_Tg(value::ST6B) -> Float64
-

Get ST6B Tg.

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

Get ST6B Tr.

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

Get ST6B V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+Vg: Regulator Feedback
  • n_states::Int: (Do not modify.) ST6B has 4 states
  • states_types::Vector{StateTypes}: (Do not modify.) ST6B has 4 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_I_lr — Method
get_I_lr(value::ST6B) -> Float64
+

Get ST6B I_lr.

source
PowerSystems.get_K_ci — Method
get_K_ci(value::ST6B) -> Float64
+

Get ST6B K_ci.

source
PowerSystems.get_K_da — Method
get_K_da(value::ST6B) -> Float64
+

Get ST6B K_da.

source
PowerSystems.get_K_ff — Method
get_K_ff(value::ST6B) -> Float64
+

Get ST6B K_ff.

source
PowerSystems.get_K_ia — Method
get_K_ia(value::ST6B) -> Float64
+

Get ST6B K_ia.

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

Get ST6B K_lr.

source
PowerSystems.get_K_m — Method
get_K_m(value::ST6B) -> Float64
+

Get ST6B K_m.

source
PowerSystems.get_K_pa — Method
get_K_pa(value::ST6B) -> Float64
+

Get ST6B K_pa.

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

Get ST6B Kg.

source
PowerSystems.get_OEL_Flag — Method
get_OEL_Flag(value::ST6B) -> Int64
+

Get ST6B OEL_Flag.

source
PowerSystems.get_T_da — Method
get_T_da(value::ST6B) -> Float64
+

Get ST6B T_da.

source
PowerSystems.get_Tg — Method
get_Tg(value::ST6B) -> Float64
+

Get ST6B Tg.

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

Get ST6B Tr.

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

Get ST6B V_ref.

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

Get ST6B Va_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get ST6B Va_lim.

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

Get ST6B Vr_lim.

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

Get ST6B ext.

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

Get ST6B n_states.

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

Get ST6B states.

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

Get ST6B states_types.

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

Set ST6B I_lr.

source
PowerSystems.set_K_ci! — Method
set_K_ci!(value::ST6B, val) -> Any
-

Set ST6B K_ci.

source
PowerSystems.set_K_da! — Method
set_K_da!(value::ST6B, val) -> Any
-

Set ST6B K_da.

source
PowerSystems.set_K_ff! — Method
set_K_ff!(value::ST6B, val) -> Any
-

Set ST6B K_ff.

source
PowerSystems.set_K_ia! — Method
set_K_ia!(value::ST6B, val) -> Any
-

Set ST6B K_ia.

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

Set ST6B K_lr.

source
PowerSystems.set_K_m! — Method
set_K_m!(value::ST6B, val) -> Any
-

Set ST6B K_m.

source
PowerSystems.set_K_pa! — Method
set_K_pa!(value::ST6B, val) -> Any
-

Set ST6B K_pa.

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

Set ST6B Kg.

source
PowerSystems.set_OEL_Flag! — Method
set_OEL_Flag!(value::ST6B, val) -> Any
-

Set ST6B OEL_Flag.

source
PowerSystems.set_T_da! — Method
set_T_da!(value::ST6B, val) -> Any
-

Set ST6B T_da.

source
PowerSystems.set_Tg! — Method
set_Tg!(value::ST6B, val) -> Any
-

Set ST6B Tg.

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

Set ST6B Tr.

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

Set ST6B V_ref.

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

Set ST6B Va_lim.

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

Set ST6B Vr_lim.

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

Set ST6B ext.

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

Set ST6B states_types.

source

ST8C

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

Get ST6B Vr_lim.

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

Get ST6B ext.

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

Get ST6B n_states.

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

Get ST6B states.

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

Get ST6B states_types.

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

Set ST6B I_lr.

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

Set ST6B K_ci.

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

Set ST6B K_da.

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

Set ST6B K_ff.

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

Set ST6B K_ia.

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

Set ST6B K_lr.

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

Set ST6B K_m.

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

Set ST6B K_pa.

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

Set ST6B Kg.

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

Set ST6B OEL_Flag.

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

Set ST6B T_da.

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

Set ST6B Tg.

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

Set ST6B Tr.

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

Set ST6B V_ref.

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

Set ST6B Va_lim.

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

Set ST6B Vr_lim.

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

Set ST6B ext.

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

Set ST6B states_types.

source

ST8C

PowerSystems.ST8C — Type
mutable struct ST8C <: AVR
     OEL_Flag::Int
     UEL_Flag::Int
     SCL_Flag::Int
@@ -1242,70 +1242,70 @@
 x_a1: Regulator Integrator state,
 x_a2: Field Current regulator state,
 x_a3: Controller rectifier bridge state,
-x_a4: Regulator Feedback state
  • n_states::Int: (Do not modify.) ST8C has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ST8C has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ifd_ref — Method
get_Ifd_ref(value::ST8C) -> Float64
-

Get ST8C Ifd_ref.

source
PowerSystems.get_K_a — Method
get_K_a(value::ST8C) -> Float64
-

Get ST8C K_a.

source
PowerSystems.get_K_c1 — Method
get_K_c1(value::ST8C) -> Float64
-

Get ST8C K_c1.

source
PowerSystems.get_K_c2 — Method
get_K_c2(value::ST8C) -> Float64
-

Get ST8C K_c2.

source
PowerSystems.get_K_f — Method
get_K_f(value::ST8C) -> Float64
-

Get ST8C K_f.

source
PowerSystems.get_K_i1 — Method
get_K_i1(value::ST8C) -> Float64
-

Get ST8C K_i1.

source
PowerSystems.get_K_i2 — Method
get_K_i2(value::ST8C) -> Float64
-

Get ST8C K_i2.

source
PowerSystems.get_K_ia — Method
get_K_ia(value::ST8C) -> Float64
-

Get ST8C K_ia.

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

Get ST8C K_ir.

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

Get ST8C K_p.

source
PowerSystems.get_K_pa — Method
get_K_pa(value::ST8C) -> Float64
-

Get ST8C K_pa.

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

Get ST8C K_pr.

source
PowerSystems.get_OEL_Flag — Method
get_OEL_Flag(value::ST8C) -> Int64
-

Get ST8C OEL_Flag.

source
PowerSystems.get_SCL_Flag — Method
get_SCL_Flag(value::ST8C) -> Int64
-

Get ST8C SCL_Flag.

source
PowerSystems.get_SW1_Flag — Method
get_SW1_Flag(value::ST8C) -> Int64
-

Get ST8C SW1_Flag.

source
PowerSystems.get_T_a — Method
get_T_a(value::ST8C) -> Float64
-

Get ST8C T_a.

source
PowerSystems.get_T_f — Method
get_T_f(value::ST8C) -> Float64
-

Get ST8C T_f.

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

Get ST8C Tr.

source
PowerSystems.get_UEL_Flag — Method
get_UEL_Flag(value::ST8C) -> Int64
-

Get ST8C UEL_Flag.

source
PowerSystems.get_VB1_max — Method
get_VB1_max(value::ST8C) -> Float64
-

Get ST8C VB1_max.

source
PowerSystems.get_VB2_max — Method
get_VB2_max(value::ST8C) -> Float64
-

Get ST8C VB2_max.

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

Get ST8C V_ref.

source
PowerSystems.get_Va_lim — Method
get_Va_lim(
+x_a4: Regulator Feedback state
  • n_states::Int: (Do not modify.) ST8C has 5 states
  • states_types::Vector{StateTypes}: (Do not modify.) ST8C has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_Ifd_ref — Method
get_Ifd_ref(value::ST8C) -> Float64
+

Get ST8C Ifd_ref.

source
PowerSystems.get_K_a — Method
get_K_a(value::ST8C) -> Float64
+

Get ST8C K_a.

source
PowerSystems.get_K_c1 — Method
get_K_c1(value::ST8C) -> Float64
+

Get ST8C K_c1.

source
PowerSystems.get_K_c2 — Method
get_K_c2(value::ST8C) -> Float64
+

Get ST8C K_c2.

source
PowerSystems.get_K_f — Method
get_K_f(value::ST8C) -> Float64
+

Get ST8C K_f.

source
PowerSystems.get_K_i1 — Method
get_K_i1(value::ST8C) -> Float64
+

Get ST8C K_i1.

source
PowerSystems.get_K_i2 — Method
get_K_i2(value::ST8C) -> Float64
+

Get ST8C K_i2.

source
PowerSystems.get_K_ia — Method
get_K_ia(value::ST8C) -> Float64
+

Get ST8C K_ia.

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

Get ST8C K_ir.

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

Get ST8C K_p.

source
PowerSystems.get_K_pa — Method
get_K_pa(value::ST8C) -> Float64
+

Get ST8C K_pa.

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

Get ST8C K_pr.

source
PowerSystems.get_OEL_Flag — Method
get_OEL_Flag(value::ST8C) -> Int64
+

Get ST8C OEL_Flag.

source
PowerSystems.get_SCL_Flag — Method
get_SCL_Flag(value::ST8C) -> Int64
+

Get ST8C SCL_Flag.

source
PowerSystems.get_SW1_Flag — Method
get_SW1_Flag(value::ST8C) -> Int64
+

Get ST8C SW1_Flag.

source
PowerSystems.get_T_a — Method
get_T_a(value::ST8C) -> Float64
+

Get ST8C T_a.

source
PowerSystems.get_T_f — Method
get_T_f(value::ST8C) -> Float64
+

Get ST8C T_f.

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

Get ST8C Tr.

source
PowerSystems.get_UEL_Flag — Method
get_UEL_Flag(value::ST8C) -> Int64
+

Get ST8C UEL_Flag.

source
PowerSystems.get_VB1_max — Method
get_VB1_max(value::ST8C) -> Float64
+

Get ST8C VB1_max.

source
PowerSystems.get_VB2_max — Method
get_VB2_max(value::ST8C) -> Float64
+

Get ST8C VB2_max.

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

Get ST8C V_ref.

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

Get ST8C Va_lim.

source
PowerSystems.get_Vpi_lim — Method
get_Vpi_lim(
+

Get ST8C Va_lim.

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

Get ST8C Vpi_lim.

source
PowerSystems.get_Vr_lim — Method
get_Vr_lim(
+

Get ST8C Vpi_lim.

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

Get ST8C Vr_lim.

source
PowerSystems.get_X_l — Method
get_X_l(value::ST8C) -> Float64
-

Get ST8C X_l.

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

Get ST8C ext.

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

Get ST8C n_states.

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

Get ST8C states.

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

Get ST8C states_types.

source
PowerSystems.get_θ_p — Method
get_θ_p(value::ST8C) -> Float64
-

Get ST8C θ_p.

source
PowerSystems.set_Ifd_ref! — Method
set_Ifd_ref!(value::ST8C, val) -> Any
-

Set ST8C Ifd_ref.

source
PowerSystems.set_K_a! — Method
set_K_a!(value::ST8C, val) -> Any
-

Set ST8C K_a.

source
PowerSystems.set_K_c1! — Method
set_K_c1!(value::ST8C, val) -> Any
-

Set ST8C K_c1.

source
PowerSystems.set_K_c2! — Method
set_K_c2!(value::ST8C, val) -> Any
-

Set ST8C K_c2.

source
PowerSystems.set_K_f! — Method
set_K_f!(value::ST8C, val) -> Any
-

Set ST8C K_f.

source
PowerSystems.set_K_i1! — Method
set_K_i1!(value::ST8C, val) -> Any
-

Set ST8C K_i1.

source
PowerSystems.set_K_i2! — Method
set_K_i2!(value::ST8C, val) -> Any
-

Set ST8C K_i2.

source
PowerSystems.set_K_ia! — Method
set_K_ia!(value::ST8C, val) -> Any
-

Set ST8C K_ia.

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

Set ST8C K_ir.

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

Set ST8C K_p.

source
PowerSystems.set_K_pa! — Method
set_K_pa!(value::ST8C, val) -> Any
-

Set ST8C K_pa.

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

Set ST8C K_pr.

source
PowerSystems.set_OEL_Flag! — Method
set_OEL_Flag!(value::ST8C, val) -> Any
-

Set ST8C OEL_Flag.

source
PowerSystems.set_SCL_Flag! — Method
set_SCL_Flag!(value::ST8C, val) -> Any
-

Set ST8C SCL_Flag.

source
PowerSystems.set_SW1_Flag! — Method
set_SW1_Flag!(value::ST8C, val) -> Any
-

Set ST8C SW1_Flag.

source
PowerSystems.set_T_a! — Method
set_T_a!(value::ST8C, val) -> Any
-

Set ST8C T_a.

source
PowerSystems.set_T_f! — Method
set_T_f!(value::ST8C, val) -> Any
-

Set ST8C T_f.

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

Set ST8C Tr.

source
PowerSystems.set_UEL_Flag! — Method
set_UEL_Flag!(value::ST8C, val) -> Any
-

Set ST8C UEL_Flag.

source
PowerSystems.set_VB1_max! — Method
set_VB1_max!(value::ST8C, val) -> Any
-

Set ST8C VB1_max.

source
PowerSystems.set_VB2_max! — Method
set_VB2_max!(value::ST8C, val) -> Any
-

Set ST8C VB2_max.

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

Set ST8C V_ref.

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

Set ST8C Va_lim.

source
PowerSystems.set_Vpi_lim! — Method
set_Vpi_lim!(value::ST8C, val) -> Any
-

Set ST8C Vpi_lim.

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

Set ST8C Vr_lim.

source
PowerSystems.set_X_l! — Method
set_X_l!(value::ST8C, val) -> Any
-

Set ST8C X_l.

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

Set ST8C ext.

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

Set ST8C states_types.

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

Set ST8C θ_p.

source
+

Get ST8C Vr_lim.

source
PowerSystems.get_X_l — Method
get_X_l(value::ST8C) -> Float64
+

Get ST8C X_l.

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

Get ST8C ext.

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

Get ST8C n_states.

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

Get ST8C states.

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

Get ST8C states_types.

source
PowerSystems.get_θ_p — Method
get_θ_p(value::ST8C) -> Float64
+

Get ST8C θ_p.

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

Set ST8C Ifd_ref.

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

Set ST8C K_a.

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

Set ST8C K_c1.

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

Set ST8C K_c2.

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

Set ST8C K_f.

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

Set ST8C K_i1.

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

Set ST8C K_i2.

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

Set ST8C K_ia.

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

Set ST8C K_ir.

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

Set ST8C K_p.

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

Set ST8C K_pa.

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

Set ST8C K_pr.

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

Set ST8C OEL_Flag.

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

Set ST8C SCL_Flag.

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

Set ST8C SW1_Flag.

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

Set ST8C T_a.

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

Set ST8C T_f.

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

Set ST8C Tr.

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

Set ST8C UEL_Flag.

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

Set ST8C VB1_max.

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

Set ST8C VB2_max.

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

Set ST8C V_ref.

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

Set ST8C Va_lim.

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

Set ST8C Vpi_lim.

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

Set ST8C Vr_lim.

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

Set ST8C X_l.

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

Set ST8C ext.

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

Set ST8C states_types.

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

Set ST8C θ_p.

source
diff --git a/previews/PR1205/model_library/generated_ActiveConstantPowerLoad/index.html b/previews/PR1205/model_library/generated_ActiveConstantPowerLoad/index.html index 92403597fb..7ca459d1d5 100644 --- a/previews/PR1205/model_library/generated_ActiveConstantPowerLoad/index.html +++ b/previews/PR1205/model_library/generated_ActiveConstantPowerLoad/index.html @@ -35,52 +35,52 @@ 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 filtersource
InfrastructureSystems.get_name — Method
get_name(value::ActiveConstantPowerLoad) -> String
-

Get ActiveConstantPowerLoad name.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad P_ref.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad Q_ref.

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

Get ActiveConstantPowerLoad V_ref.

source
PowerSystems.get_base_power — Method
get_base_power(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad base_power.

source
PowerSystems.get_c_dc — Method
get_c_dc(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad c_dc.

source
PowerSystems.get_cf — Method
get_cf(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad cf.

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

Get ActiveConstantPowerLoad ext.

source
PowerSystems.get_is_filter_differential — Method
get_is_filter_differential(
+ii_filter: Imaginary current out of the filter
  • n_states::Int: (Do not modify.) ActiveConstantPowerLoad has 12 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::ActiveConstantPowerLoad) -> String
+

Get ActiveConstantPowerLoad name.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad P_ref.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad Q_ref.

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

Get ActiveConstantPowerLoad V_ref.

source
PowerSystems.get_base_power — Method
get_base_power(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad base_power.

source
PowerSystems.get_c_dc — Method
get_c_dc(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad c_dc.

source
PowerSystems.get_cf — Method
get_cf(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad cf.

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

Get ActiveConstantPowerLoad ext.

source
PowerSystems.get_is_filter_differential — Method
get_is_filter_differential(
     value::ActiveConstantPowerLoad
 ) -> Int64
-

Get ActiveConstantPowerLoad is_filter_differential.

source
PowerSystems.get_ki_pll — Method
get_ki_pll(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad ki_pll.

source
PowerSystems.get_kic — Method
get_kic(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad kic.

source
PowerSystems.get_kiv — Method
get_kiv(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad kiv.

source
PowerSystems.get_kp_pll — Method
get_kp_pll(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad kp_pll.

source
PowerSystems.get_kpc — Method
get_kpc(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad kpc.

source
PowerSystems.get_kpv — Method
get_kpv(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad kpv.

source
PowerSystems.get_lf — Method
get_lf(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad lf.

source
PowerSystems.get_lg — Method
get_lg(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad lg.

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

Get ActiveConstantPowerLoad n_states.

source
PowerSystems.get_r_load — Method
get_r_load(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad r_load.

source
PowerSystems.get_rf — Method
get_rf(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad rf.

source
PowerSystems.get_rg — Method
get_rg(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad rg.

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

Get ActiveConstantPowerLoad states.

source
PowerSystems.get_ω_ref — Method
get_ω_ref(value::ActiveConstantPowerLoad) -> Float64
-

Get ActiveConstantPowerLoad ω_ref.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad P_ref.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad Q_ref.

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

Set ActiveConstantPowerLoad V_ref.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad base_power.

source
PowerSystems.set_c_dc! — Method
set_c_dc!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad c_dc.

source
PowerSystems.set_cf! — Method
set_cf!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad cf.

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

Set ActiveConstantPowerLoad ext.

source
PowerSystems.set_is_filter_differential! — Method
set_is_filter_differential!(
+

Get ActiveConstantPowerLoad is_filter_differential.

source
PowerSystems.get_ki_pll — Method
get_ki_pll(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad ki_pll.

source
PowerSystems.get_kic — Method
get_kic(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad kic.

source
PowerSystems.get_kiv — Method
get_kiv(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad kiv.

source
PowerSystems.get_kp_pll — Method
get_kp_pll(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad kp_pll.

source
PowerSystems.get_kpc — Method
get_kpc(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad kpc.

source
PowerSystems.get_kpv — Method
get_kpv(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad kpv.

source
PowerSystems.get_lf — Method
get_lf(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad lf.

source
PowerSystems.get_lg — Method
get_lg(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad lg.

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

Get ActiveConstantPowerLoad n_states.

source
PowerSystems.get_r_load — Method
get_r_load(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad r_load.

source
PowerSystems.get_rf — Method
get_rf(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad rf.

source
PowerSystems.get_rg — Method
get_rg(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad rg.

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

Get ActiveConstantPowerLoad states.

source
PowerSystems.get_ω_ref — Method
get_ω_ref(value::ActiveConstantPowerLoad) -> Float64
+

Get ActiveConstantPowerLoad ω_ref.

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

Set ActiveConstantPowerLoad P_ref.

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

Set ActiveConstantPowerLoad Q_ref.

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

Set ActiveConstantPowerLoad V_ref.

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

Set ActiveConstantPowerLoad base_power.

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

Set ActiveConstantPowerLoad c_dc.

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

Set ActiveConstantPowerLoad cf.

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

Set ActiveConstantPowerLoad ext.

source
PowerSystems.set_is_filter_differential! — Method
set_is_filter_differential!(
     value::ActiveConstantPowerLoad,
     val
 ) -> Any
-

Set ActiveConstantPowerLoad is_filter_differential.

source
PowerSystems.set_ki_pll! — Method
set_ki_pll!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad ki_pll.

source
PowerSystems.set_kic! — Method
set_kic!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad kic.

source
PowerSystems.set_kiv! — Method
set_kiv!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad kiv.

source
PowerSystems.set_kp_pll! — Method
set_kp_pll!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad kp_pll.

source
PowerSystems.set_kpc! — Method
set_kpc!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad kpc.

source
PowerSystems.set_kpv! — Method
set_kpv!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad kpv.

source
PowerSystems.set_lf! — Method
set_lf!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad lf.

source
PowerSystems.set_lg! — Method
set_lg!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad lg.

source
PowerSystems.set_r_load! — Method
set_r_load!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad r_load.

source
PowerSystems.set_rf! — Method
set_rf!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad rf.

source
PowerSystems.set_rg! — Method
set_rg!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad rg.

source
PowerSystems.set_ω_ref! — Method
set_ω_ref!(value::ActiveConstantPowerLoad, val) -> Any
-

Set ActiveConstantPowerLoad ω_ref.

source
+

Set ActiveConstantPowerLoad is_filter_differential.

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

Set ActiveConstantPowerLoad ki_pll.

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

Set ActiveConstantPowerLoad kic.

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

Set ActiveConstantPowerLoad kiv.

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

Set ActiveConstantPowerLoad kp_pll.

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

Set ActiveConstantPowerLoad kpc.

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

Set ActiveConstantPowerLoad kpv.

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

Set ActiveConstantPowerLoad lf.

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

Set ActiveConstantPowerLoad lg.

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

Set ActiveConstantPowerLoad r_load.

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

Set ActiveConstantPowerLoad rf.

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

Set ActiveConstantPowerLoad rg.

source
PowerSystems.set_ω_ref! — Method
set_ω_ref!(value::ActiveConstantPowerLoad, val) -> Any
+

Set ActiveConstantPowerLoad ω_ref.

source
diff --git a/previews/PR1205/model_library/generated_AggregateDistributedGenerationA/index.html b/previews/PR1205/model_library/generated_AggregateDistributedGenerationA/index.html index 2d652c8e2f..e0df869ca6 100644 --- a/previews/PR1205/model_library/generated_AggregateDistributedGenerationA/index.html +++ b/previews/PR1205/model_library/generated_AggregateDistributedGenerationA/index.html @@ -45,212 +45,212 @@ states::Vector{Symbol} n_states::Int internal::InfrastructureSystemsInternal -end

Parameters of the DERA1 model in PSS/E

Arguments

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

Get AggregateDistributedGenerationA name.

source
PowerSystems.get_D_dn — Method
get_D_dn(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA D_dn.

source
PowerSystems.get_D_up — Method
get_D_up(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA D_up.

source
PowerSystems.get_Freq_Flag — Method
get_Freq_Flag(
+end

Parameters of the DERA1 model in PSS/E

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
  • Pf_Flag::Int: Flag for Power Factor Control, validation range: (0, 1)
  • Freq_Flag::Int: Flag to enable/disable frequency control, validation range: (0, 1)
  • PQ_Flag::Int: Flag used to enforce maximum current, validation range: (0, 1)
  • Gen_Flag::Int: Flag to specify generator or storage, validation range: (0, 1)
  • Vtrip_Flag::Int: Flag to enable/disable voltage trip logic, validation range: (0, 1)
  • Ftrip_Flag::Int: Flag to enable/disable frequency trip logic, validation range: (0, 1)
  • T_rv::Float64: Voltage measurement transducer time constant, validation range: (0, nothing)
  • Trf::Float64: Frequency measurement transducer time constant, validation range: (0, nothing)
  • dbd_pnts::Tuple{Float64, Float64}: Voltage deadband thresholds (dbd1, dbd2)
  • K_qv::Float64: Proportional voltage control gain (pu), validation range: (0, nothing)
  • Tp::Float64: Power measurement transducer time constant, validation range: (0, nothing)
  • T_iq::Float64: Time constant for low-pass filter for state q_V when QFlag = 0, validation range: (0, nothing)
  • D_dn::Float64: Reciprocal of droop for over-frequency conditions (>0) (pu), validation range: (0, nothing)
  • D_up::Float64: Reciprocal of droop for under-frequency conditions <=0) (pu), validation range: (0, nothing)
  • fdbd_pnts::Tuple{Float64, Float64}: Frequency control deadband thresholds (fdbd1, fdbd2)
  • fe_lim::MinMax: Frequency error limits (femin, femax)
  • P_lim::MinMax: Power limits (Pmin, Pmax)
  • dP_lim::MinMax: Power reference ramp rate limits (dPmin, dPmax)
  • Tpord::Float64: Power filter time constant, validation range: (0, nothing)
  • Kpg::Float64: PI controller proportional gain (pu), validation range: (0, nothing)
  • Kig::Float64: PI controller integral gain (pu), validation range: (0, nothing)
  • I_max::Float64: Maximum limit on total converter current (pu), validation range: (0, nothing)
  • vl_pnts::Vector{Tuple{Float64,Float64}}: Low voltage cutout points [(tv10, vl0), (tv11, vl1)]
  • vh_pnts::Vector{Tuple{Float64,Float64}}: High voltage cutout points [(tvh0, vh0), (tvh1, vh1)]
  • Vrfrac::Float64: Fraction of device that recovers after voltage comes back to within vl1 < V < vh1 (0 <= Vrfrac <= 1), validation range: (0, 1)
  • fl::Float64: Inverter frequency break-point for low frequency cut-out (Hz), validation range: (0, nothing)
  • fh::Float64: Inverter frequency break-point for high frequency cut-out (Hz), validation range: (0, nothing)
  • tfl::Float64: Low frequency cut-out timer corresponding to frequency fl (s), validation range: (0, nothing)
  • tfh::Float64: High frequency cut-out timer corresponding to frequency fh (s), validation range: (0, nothing)
  • Tg::Float64: Current control time constant (to represent behavior of inner control loops) (> 0) (s), validation range: (0, nothing)
  • rrpwr::Float64: Ramp rate for real power increase following a fault (pu/s), validation range: (0, nothing)
  • Tv::Float64: Time constant on the output of the multiplier (s), validation range: (0, nothing)
  • Vpr::Float64: Voltage below which frequency tripping is disabled (pu), validation range: (0, nothing)
  • Iq_lim::MinMax: Reactive current injection limits (Iqll, Iqhl)
  • V_ref::Float64: (default: 1.0) User defined voltage reference. If 0, PowerSimulationsDynamics.jl initializes to initial terminal voltage, validation range: (0, nothing)
  • Pfa_ref::Float64: (default: 0.0) Reference power factor, validation range: (0, nothing)
  • ω_ref::Float64: (default: 1.0) Reference Frequency (pu), validation range: (0, nothing)
  • Q_ref::Float64: (default: 0.0) Reference reactive power, in pu, validation range: (0, nothing)
  • P_ref::Float64: (default: 1.0) Reference active power, in pu, validation range: (0, nothing)
  • base_power::Float64: (default: 100.0) Base power (MVA) for per unitization
  • 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.
  • states::Vector{Symbol}: (Do not modify.) The states of AggregateDistributedGenerationA depends on the Flags
  • n_states::Int: (Do not modify.) The states of AggregateDistributedGenerationA depends on the Flags
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::AggregateDistributedGenerationA) -> String
+

Get AggregateDistributedGenerationA name.

source
PowerSystems.get_D_dn — Method
get_D_dn(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA D_dn.

source
PowerSystems.get_D_up — Method
get_D_up(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA D_up.

source
PowerSystems.get_Freq_Flag — Method
get_Freq_Flag(
     value::AggregateDistributedGenerationA
 ) -> Int64
-

Get AggregateDistributedGenerationA Freq_Flag.

source
PowerSystems.get_Ftrip_Flag — Method
get_Ftrip_Flag(
+

Get AggregateDistributedGenerationA Freq_Flag.

source
PowerSystems.get_Ftrip_Flag — Method
get_Ftrip_Flag(
     value::AggregateDistributedGenerationA
 ) -> Int64
-

Get AggregateDistributedGenerationA Ftrip_Flag.

source
PowerSystems.get_Gen_Flag — Method
get_Gen_Flag(
+

Get AggregateDistributedGenerationA Ftrip_Flag.

source
PowerSystems.get_Gen_Flag — Method
get_Gen_Flag(
     value::AggregateDistributedGenerationA
 ) -> Int64
-

Get AggregateDistributedGenerationA Gen_Flag.

source
PowerSystems.get_I_max — Method
get_I_max(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA I_max.

source
PowerSystems.get_Iq_lim — Method
get_Iq_lim(
+

Get AggregateDistributedGenerationA Gen_Flag.

source
PowerSystems.get_I_max — Method
get_I_max(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA I_max.

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

Get AggregateDistributedGenerationA Iq_lim.

source
PowerSystems.get_K_qv — Method
get_K_qv(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA K_qv.

source
PowerSystems.get_Kig — Method
get_Kig(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Kig.

source
PowerSystems.get_Kpg — Method
get_Kpg(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Kpg.

source
PowerSystems.get_PQ_Flag — Method
get_PQ_Flag(value::AggregateDistributedGenerationA) -> Int64
-

Get AggregateDistributedGenerationA PQ_Flag.

source
PowerSystems.get_P_lim — Method
get_P_lim(
+

Get AggregateDistributedGenerationA Iq_lim.

source
PowerSystems.get_K_qv — Method
get_K_qv(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA K_qv.

source
PowerSystems.get_Kig — Method
get_Kig(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Kig.

source
PowerSystems.get_Kpg — Method
get_Kpg(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Kpg.

source
PowerSystems.get_PQ_Flag — Method
get_PQ_Flag(value::AggregateDistributedGenerationA) -> Int64
+

Get AggregateDistributedGenerationA PQ_Flag.

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

Get AggregateDistributedGenerationA P_lim.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA P_ref.

source
PowerSystems.get_Pf_Flag — Method
get_Pf_Flag(value::AggregateDistributedGenerationA) -> Int64
-

Get AggregateDistributedGenerationA Pf_Flag.

source
PowerSystems.get_Pfa_ref — Method
get_Pfa_ref(
+

Get AggregateDistributedGenerationA P_lim.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA P_ref.

source
PowerSystems.get_Pf_Flag — Method
get_Pf_Flag(value::AggregateDistributedGenerationA) -> Int64
+

Get AggregateDistributedGenerationA Pf_Flag.

source
PowerSystems.get_Pfa_ref — Method
get_Pfa_ref(
     value::AggregateDistributedGenerationA
 ) -> Float64
-

Get AggregateDistributedGenerationA Pfa_ref.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Q_ref.

source
PowerSystems.get_T_iq — Method
get_T_iq(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA T_iq.

source
PowerSystems.get_T_rv — Method
get_T_rv(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA T_rv.

source
PowerSystems.get_Tg — Method
get_Tg(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Tg.

source
PowerSystems.get_Tp — Method
get_Tp(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Tp.

source
PowerSystems.get_Tpord — Method
get_Tpord(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Tpord.

source
PowerSystems.get_Trf — Method
get_Trf(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Trf.

source
PowerSystems.get_Tv — Method
get_Tv(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Tv.

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

Get AggregateDistributedGenerationA V_ref.

source
PowerSystems.get_Vpr — Method
get_Vpr(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA Vpr.

source
PowerSystems.get_Vrfrac — Method
get_Vrfrac(
+

Get AggregateDistributedGenerationA Pfa_ref.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Q_ref.

source
PowerSystems.get_T_iq — Method
get_T_iq(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA T_iq.

source
PowerSystems.get_T_rv — Method
get_T_rv(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA T_rv.

source
PowerSystems.get_Tg — Method
get_Tg(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Tg.

source
PowerSystems.get_Tp — Method
get_Tp(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Tp.

source
PowerSystems.get_Tpord — Method
get_Tpord(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Tpord.

source
PowerSystems.get_Trf — Method
get_Trf(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Trf.

source
PowerSystems.get_Tv — Method
get_Tv(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Tv.

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

Get AggregateDistributedGenerationA V_ref.

source
PowerSystems.get_Vpr — Method
get_Vpr(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA Vpr.

source
PowerSystems.get_Vrfrac — Method
get_Vrfrac(
     value::AggregateDistributedGenerationA
 ) -> Float64
-

Get AggregateDistributedGenerationA Vrfrac.

source
PowerSystems.get_Vtrip_Flag — Method
get_Vtrip_Flag(
+

Get AggregateDistributedGenerationA Vrfrac.

source
PowerSystems.get_Vtrip_Flag — Method
get_Vtrip_Flag(
     value::AggregateDistributedGenerationA
 ) -> Int64
-

Get AggregateDistributedGenerationA Vtrip_Flag.

source
PowerSystems.get_base_power — Method
get_base_power(
+

Get AggregateDistributedGenerationA Vtrip_Flag.

source
PowerSystems.get_base_power — Method
get_base_power(
     value::AggregateDistributedGenerationA
 ) -> Float64
-

Get AggregateDistributedGenerationA base_power.

source
PowerSystems.get_dP_lim — Method
get_dP_lim(
+

Get AggregateDistributedGenerationA base_power.

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

Get AggregateDistributedGenerationA dP_lim.

source
PowerSystems.get_dbd_pnts — Method
get_dbd_pnts(
+

Get AggregateDistributedGenerationA dP_lim.

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

Get AggregateDistributedGenerationA dbd_pnts.

source
PowerSystems.get_ext — Method
get_ext(
+

Get AggregateDistributedGenerationA dbd_pnts.

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

Get AggregateDistributedGenerationA ext.

source
PowerSystems.get_fdbd_pnts — Method
get_fdbd_pnts(
+

Get AggregateDistributedGenerationA ext.

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

Get AggregateDistributedGenerationA fdbd_pnts.

source
PowerSystems.get_fe_lim — Method
get_fe_lim(
+

Get AggregateDistributedGenerationA fdbd_pnts.

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

Get AggregateDistributedGenerationA fe_lim.

source
PowerSystems.get_fh — Method
get_fh(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA fh.

source
PowerSystems.get_fl — Method
get_fl(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA fl.

source
PowerSystems.get_n_states — Method
get_n_states(
+

Get AggregateDistributedGenerationA fe_lim.

source
PowerSystems.get_fh — Method
get_fh(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA fh.

source
PowerSystems.get_fl — Method
get_fl(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA fl.

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

Get AggregateDistributedGenerationA n_states.

source
PowerSystems.get_rrpwr — Method
get_rrpwr(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA rrpwr.

source
PowerSystems.get_states — Method
get_states(
+

Get AggregateDistributedGenerationA n_states.

source
PowerSystems.get_rrpwr — Method
get_rrpwr(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA rrpwr.

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

Get AggregateDistributedGenerationA states.

source
PowerSystems.get_tfh — Method
get_tfh(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA tfh.

source
PowerSystems.get_tfl — Method
get_tfl(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA tfl.

source
PowerSystems.get_vh_pnts — Method
get_vh_pnts(
+

Get AggregateDistributedGenerationA states.

source
PowerSystems.get_tfh — Method
get_tfh(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA tfh.

source
PowerSystems.get_tfl — Method
get_tfl(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA tfl.

source
PowerSystems.get_vh_pnts — Method
get_vh_pnts(
     value::AggregateDistributedGenerationA
 ) -> Vector{Tuple{Float64, Float64}}
-

Get AggregateDistributedGenerationA vh_pnts.

source
PowerSystems.get_vl_pnts — Method
get_vl_pnts(
+

Get AggregateDistributedGenerationA vh_pnts.

source
PowerSystems.get_vl_pnts — Method
get_vl_pnts(
     value::AggregateDistributedGenerationA
 ) -> Vector{Tuple{Float64, Float64}}
-

Get AggregateDistributedGenerationA vl_pnts.

source
PowerSystems.get_ω_ref — Method
get_ω_ref(value::AggregateDistributedGenerationA) -> Float64
-

Get AggregateDistributedGenerationA ω_ref.

source
PowerSystems.set_D_dn! — Method
set_D_dn!(
+

Get AggregateDistributedGenerationA vl_pnts.

source
PowerSystems.get_ω_ref — Method
get_ω_ref(value::AggregateDistributedGenerationA) -> Float64
+

Get AggregateDistributedGenerationA ω_ref.

source
PowerSystems.set_D_dn! — Method
set_D_dn!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA D_dn.

source
PowerSystems.set_D_up! — Method
set_D_up!(
+

Set AggregateDistributedGenerationA D_dn.

source
PowerSystems.set_D_up! — Method
set_D_up!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA D_up.

source
PowerSystems.set_Freq_Flag! — Method
set_Freq_Flag!(
+

Set AggregateDistributedGenerationA D_up.

source
PowerSystems.set_Freq_Flag! — Method
set_Freq_Flag!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Freq_Flag.

source
PowerSystems.set_Ftrip_Flag! — Method
set_Ftrip_Flag!(
+

Set AggregateDistributedGenerationA Freq_Flag.

source
PowerSystems.set_Ftrip_Flag! — Method
set_Ftrip_Flag!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Ftrip_Flag.

source
PowerSystems.set_Gen_Flag! — Method
set_Gen_Flag!(
+

Set AggregateDistributedGenerationA Ftrip_Flag.

source
PowerSystems.set_Gen_Flag! — Method
set_Gen_Flag!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Gen_Flag.

source
PowerSystems.set_I_max! — Method
set_I_max!(
+

Set AggregateDistributedGenerationA Gen_Flag.

source
PowerSystems.set_I_max! — Method
set_I_max!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA I_max.

source
PowerSystems.set_Iq_lim! — Method
set_Iq_lim!(
+

Set AggregateDistributedGenerationA I_max.

source
PowerSystems.set_Iq_lim! — Method
set_Iq_lim!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Iq_lim.

source
PowerSystems.set_K_qv! — Method
set_K_qv!(
+

Set AggregateDistributedGenerationA Iq_lim.

source
PowerSystems.set_K_qv! — Method
set_K_qv!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA K_qv.

source
PowerSystems.set_Kig! — Method
set_Kig!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA Kig.

source
PowerSystems.set_Kpg! — Method
set_Kpg!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA Kpg.

source
PowerSystems.set_PQ_Flag! — Method
set_PQ_Flag!(
+

Set AggregateDistributedGenerationA K_qv.

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

Set AggregateDistributedGenerationA Kig.

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

Set AggregateDistributedGenerationA Kpg.

source
PowerSystems.set_PQ_Flag! — Method
set_PQ_Flag!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA PQ_Flag.

source
PowerSystems.set_P_lim! — Method
set_P_lim!(
+

Set AggregateDistributedGenerationA PQ_Flag.

source
PowerSystems.set_P_lim! — Method
set_P_lim!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA P_lim.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(
+

Set AggregateDistributedGenerationA P_lim.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA P_ref.

source
PowerSystems.set_Pf_Flag! — Method
set_Pf_Flag!(
+

Set AggregateDistributedGenerationA P_ref.

source
PowerSystems.set_Pf_Flag! — Method
set_Pf_Flag!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Pf_Flag.

source
PowerSystems.set_Pfa_ref! — Method
set_Pfa_ref!(
+

Set AggregateDistributedGenerationA Pf_Flag.

source
PowerSystems.set_Pfa_ref! — Method
set_Pfa_ref!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Pfa_ref.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(
+

Set AggregateDistributedGenerationA Pfa_ref.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Q_ref.

source
PowerSystems.set_T_iq! — Method
set_T_iq!(
+

Set AggregateDistributedGenerationA Q_ref.

source
PowerSystems.set_T_iq! — Method
set_T_iq!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA T_iq.

source
PowerSystems.set_T_rv! — Method
set_T_rv!(
+

Set AggregateDistributedGenerationA T_iq.

source
PowerSystems.set_T_rv! — Method
set_T_rv!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA T_rv.

source
PowerSystems.set_Tg! — Method
set_Tg!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA Tg.

source
PowerSystems.set_Tp! — Method
set_Tp!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA Tp.

source
PowerSystems.set_Tpord! — Method
set_Tpord!(
+

Set AggregateDistributedGenerationA T_rv.

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

Set AggregateDistributedGenerationA Tg.

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

Set AggregateDistributedGenerationA Tp.

source
PowerSystems.set_Tpord! — Method
set_Tpord!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Tpord.

source
PowerSystems.set_Trf! — Method
set_Trf!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA Trf.

source
PowerSystems.set_Tv! — Method
set_Tv!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA Tv.

source
PowerSystems.set_V_ref! — Method
set_V_ref!(
+

Set AggregateDistributedGenerationA Tpord.

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

Set AggregateDistributedGenerationA Trf.

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

Set AggregateDistributedGenerationA Tv.

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

Set AggregateDistributedGenerationA V_ref.

source
PowerSystems.set_Vpr! — Method
set_Vpr!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA Vpr.

source
PowerSystems.set_Vrfrac! — Method
set_Vrfrac!(
+

Set AggregateDistributedGenerationA V_ref.

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

Set AggregateDistributedGenerationA Vpr.

source
PowerSystems.set_Vrfrac! — Method
set_Vrfrac!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Vrfrac.

source
PowerSystems.set_Vtrip_Flag! — Method
set_Vtrip_Flag!(
+

Set AggregateDistributedGenerationA Vrfrac.

source
PowerSystems.set_Vtrip_Flag! — Method
set_Vtrip_Flag!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA Vtrip_Flag.

source
PowerSystems.set_base_power! — Method
set_base_power!(
+

Set AggregateDistributedGenerationA Vtrip_Flag.

source
PowerSystems.set_base_power! — Method
set_base_power!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA base_power.

source
PowerSystems.set_dP_lim! — Method
set_dP_lim!(
+

Set AggregateDistributedGenerationA base_power.

source
PowerSystems.set_dP_lim! — Method
set_dP_lim!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA dP_lim.

source
PowerSystems.set_dbd_pnts! — Method
set_dbd_pnts!(
+

Set AggregateDistributedGenerationA dP_lim.

source
PowerSystems.set_dbd_pnts! — Method
set_dbd_pnts!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA dbd_pnts.

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

Set AggregateDistributedGenerationA ext.

source
PowerSystems.set_fdbd_pnts! — Method
set_fdbd_pnts!(
+

Set AggregateDistributedGenerationA dbd_pnts.

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

Set AggregateDistributedGenerationA ext.

source
PowerSystems.set_fdbd_pnts! — Method
set_fdbd_pnts!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA fdbd_pnts.

source
PowerSystems.set_fe_lim! — Method
set_fe_lim!(
+

Set AggregateDistributedGenerationA fdbd_pnts.

source
PowerSystems.set_fe_lim! — Method
set_fe_lim!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA fe_lim.

source
PowerSystems.set_fh! — Method
set_fh!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA fh.

source
PowerSystems.set_fl! — Method
set_fl!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA fl.

source
PowerSystems.set_rrpwr! — Method
set_rrpwr!(
+

Set AggregateDistributedGenerationA fe_lim.

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

Set AggregateDistributedGenerationA fh.

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

Set AggregateDistributedGenerationA fl.

source
PowerSystems.set_rrpwr! — Method
set_rrpwr!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA rrpwr.

source
PowerSystems.set_tfh! — Method
set_tfh!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA tfh.

source
PowerSystems.set_tfl! — Method
set_tfl!(value::AggregateDistributedGenerationA, val) -> Any
-

Set AggregateDistributedGenerationA tfl.

source
PowerSystems.set_vh_pnts! — Method
set_vh_pnts!(
+

Set AggregateDistributedGenerationA rrpwr.

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

Set AggregateDistributedGenerationA tfh.

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

Set AggregateDistributedGenerationA tfl.

source
PowerSystems.set_vh_pnts! — Method
set_vh_pnts!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA vh_pnts.

source
PowerSystems.set_vl_pnts! — Method
set_vl_pnts!(
+

Set AggregateDistributedGenerationA vh_pnts.

source
PowerSystems.set_vl_pnts! — Method
set_vl_pnts!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA vl_pnts.

source
PowerSystems.set_ω_ref! — Method
set_ω_ref!(
+

Set AggregateDistributedGenerationA vl_pnts.

source
PowerSystems.set_ω_ref! — Method
set_ω_ref!(
     value::AggregateDistributedGenerationA,
     val
 ) -> Any
-

Set AggregateDistributedGenerationA ω_ref.

source
+

Set AggregateDistributedGenerationA ω_ref.

source diff --git a/previews/PR1205/model_library/generated_Arc/index.html b/previews/PR1205/model_library/generated_Arc/index.html index 1a580e1fe7..1b13712f54 100644 --- a/previews/PR1205/model_library/generated_Arc/index.html +++ b/previews/PR1205/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/previews/PR1205/model_library/generated_Area/index.html b/previews/PR1205/model_library/generated_Area/index.html index 5642490e17..bc7b511f4d 100644 --- a/previews/PR1205/model_library/generated_Area/index.html +++ b/previews/PR1205/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/previews/PR1205/model_library/generated_AreaInterchange/index.html b/previews/PR1205/model_library/generated_AreaInterchange/index.html index 71cacc34eb..e5b2bba34b 100644 --- a/previews/PR1205/model_library/generated_AreaInterchange/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_CSVGN1/index.html b/previews/PR1205/model_library/generated_CSVGN1/index.html index ea72cb3aa4..be49788eff 100644 --- a/previews/PR1205/model_library/generated_CSVGN1/index.html +++ b/previews/PR1205/model_library/generated_CSVGN1/index.html @@ -20,35 +20,35 @@ internal::InfrastructureSystemsInternal end

Parameters of static shunt compensator: CSVGN1 in PSSE

Arguments

thy: thyristor,
 vr1: regulator output 1,
-vr2: regulator output 2
source
InfrastructureSystems.get_name — Method
get_name(value::CSVGN1) -> String
-

Get CSVGN1 name.

source
PowerSystems.get_CBase — Method
get_CBase(value::CSVGN1) -> Float64
-

Get CSVGN1 CBase.

source
PowerSystems.get_K — Method
get_K(value::CSVGN1) -> Float64
-

Get CSVGN1 K.

source
PowerSystems.get_R_th — Method
get_R_th(value::CSVGN1) -> Float64
-

Get CSVGN1 R_th.

source
PowerSystems.get_Rmin — Method
get_Rmin(value::CSVGN1) -> Float64
-

Get CSVGN1 Rmin.

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

Get CSVGN1 T1.

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

Get CSVGN1 T2.

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

Get CSVGN1 T3.

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

Get CSVGN1 T4.

source
PowerSystems.get_T5 — Method
get_T5(value::CSVGN1) -> Float64
-

Get CSVGN1 T5.

source
PowerSystems.get_Vmax — Method
get_Vmax(value::CSVGN1) -> Float64
-

Get CSVGN1 Vmax.

source
PowerSystems.get_Vmin — Method
get_Vmin(value::CSVGN1) -> Float64
-

Get CSVGN1 Vmin.

source
PowerSystems.get_X_th — Method
get_X_th(value::CSVGN1) -> Float64
-

Get CSVGN1 X_th.

source
PowerSystems.get_base_power — Method
get_base_power(value::CSVGN1) -> Float64
-

Get CSVGN1 base_power.

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

Get CSVGN1 ext.

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

Get CSVGN1 n_states.

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

Get CSVGN1 states.

source
PowerSystems.set_CBase! — Method
set_CBase!(value::CSVGN1, val) -> Any
-

Set CSVGN1 CBase.

source
PowerSystems.set_K! — Method
set_K!(value::CSVGN1, val) -> Any
-

Set CSVGN1 K.

source
PowerSystems.set_R_th! — Method
set_R_th!(value::CSVGN1, val) -> Any
-

Set CSVGN1 R_th.

source
PowerSystems.set_Rmin! — Method
set_Rmin!(value::CSVGN1, val) -> Any
-

Set CSVGN1 Rmin.

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

Set CSVGN1 T1.

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

Set CSVGN1 T2.

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

Set CSVGN1 T3.

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

Set CSVGN1 T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::CSVGN1, val) -> Any
-

Set CSVGN1 T5.

source
PowerSystems.set_Vmax! — Method
set_Vmax!(value::CSVGN1, val) -> Any
-

Set CSVGN1 Vmax.

source
PowerSystems.set_Vmin! — Method
set_Vmin!(value::CSVGN1, val) -> Any
-

Set CSVGN1 Vmin.

source
PowerSystems.set_X_th! — Method
set_X_th!(value::CSVGN1, val) -> Any
-

Set CSVGN1 X_th.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::CSVGN1, val) -> Any
-

Set CSVGN1 base_power.

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

Set CSVGN1 ext.

source
+vr2: regulator output 2source
InfrastructureSystems.get_name — Method
get_name(value::CSVGN1) -> String
+

Get CSVGN1 name.

source
PowerSystems.get_CBase — Method
get_CBase(value::CSVGN1) -> Float64
+

Get CSVGN1 CBase.

source
PowerSystems.get_K — Method
get_K(value::CSVGN1) -> Float64
+

Get CSVGN1 K.

source
PowerSystems.get_R_th — Method
get_R_th(value::CSVGN1) -> Float64
+

Get CSVGN1 R_th.

source
PowerSystems.get_Rmin — Method
get_Rmin(value::CSVGN1) -> Float64
+

Get CSVGN1 Rmin.

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

Get CSVGN1 T1.

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

Get CSVGN1 T2.

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

Get CSVGN1 T3.

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

Get CSVGN1 T4.

source
PowerSystems.get_T5 — Method
get_T5(value::CSVGN1) -> Float64
+

Get CSVGN1 T5.

source
PowerSystems.get_Vmax — Method
get_Vmax(value::CSVGN1) -> Float64
+

Get CSVGN1 Vmax.

source
PowerSystems.get_Vmin — Method
get_Vmin(value::CSVGN1) -> Float64
+

Get CSVGN1 Vmin.

source
PowerSystems.get_X_th — Method
get_X_th(value::CSVGN1) -> Float64
+

Get CSVGN1 X_th.

source
PowerSystems.get_base_power — Method
get_base_power(value::CSVGN1) -> Float64
+

Get CSVGN1 base_power.

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

Get CSVGN1 ext.

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

Get CSVGN1 n_states.

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

Get CSVGN1 states.

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

Set CSVGN1 CBase.

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

Set CSVGN1 K.

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

Set CSVGN1 R_th.

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

Set CSVGN1 Rmin.

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

Set CSVGN1 T1.

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

Set CSVGN1 T2.

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

Set CSVGN1 T3.

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

Set CSVGN1 T4.

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

Set CSVGN1 T5.

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

Set CSVGN1 Vmax.

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

Set CSVGN1 Vmin.

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

Set CSVGN1 X_th.

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

Set CSVGN1 base_power.

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

Set CSVGN1 ext.

source
diff --git a/previews/PR1205/model_library/generated_ConstantReserveNonSpinning/index.html b/previews/PR1205/model_library/generated_ConstantReserveNonSpinning/index.html index 3ff6f0bac4..4a797e0fb8 100644 --- a/previews/PR1205/model_library/generated_ConstantReserveNonSpinning/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_Converter/index.html b/previews/PR1205/model_library/generated_Converter/index.html index 4f5dcc416e..cd51675d44 100644 --- a/previews/PR1205/model_library/generated_Converter/index.html +++ b/previews/PR1205/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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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/previews/PR1205/model_library/generated_DCBus/index.html b/previews/PR1205/model_library/generated_DCBus/index.html index f916e50d5a..6f26aca218 100644 --- a/previews/PR1205/model_library/generated_DCBus/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_DCSource/index.html b/previews/PR1205/model_library/generated_DCSource/index.html index 6582377228..de418c0221 100644 --- a/previews/PR1205/model_library/generated_DCSource/index.html +++ b/previews/PR1205/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.
  • 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.
  • 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/previews/PR1205/model_library/generated_DynamicExponentialLoad/index.html b/previews/PR1205/model_library/generated_DynamicExponentialLoad/index.html index e8d52a92a0..4384bcf441 100644 --- a/previews/PR1205/model_library/generated_DynamicExponentialLoad/index.html +++ b/previews/PR1205/model_library/generated_DynamicExponentialLoad/index.html @@ -13,23 +13,23 @@ n_states::Int internal::InfrastructureSystemsInternal end

Parameters of 2-states of a generic dynamic load model based on "Voltage stability analysis using generic dynamic load models."

Arguments

x_p: Integrator state of the active power,
-x_q: Integrator state of the reactive power,
source
InfrastructureSystems.get_name — Method
get_name(value::DynamicExponentialLoad) -> String
-

Get DynamicExponentialLoad name.

source
PowerSystems.get_T_p — Method
get_T_p(value::DynamicExponentialLoad) -> Float64
-

Get DynamicExponentialLoad T_p.

source
PowerSystems.get_T_q — Method
get_T_q(value::DynamicExponentialLoad) -> Float64
-

Get DynamicExponentialLoad T_q.

source
PowerSystems.get_a — Method
get_a(value::DynamicExponentialLoad) -> Float64
-

Get DynamicExponentialLoad a.

source
PowerSystems.get_b — Method
get_b(value::DynamicExponentialLoad) -> Float64
-

Get DynamicExponentialLoad b.

source
PowerSystems.get_base_power — Method
get_base_power(value::DynamicExponentialLoad) -> Float64
-

Get DynamicExponentialLoad base_power.

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

Get DynamicExponentialLoad ext.

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

Get DynamicExponentialLoad n_states.

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

Get DynamicExponentialLoad states.

source
PowerSystems.get_α — Method
get_α(value::DynamicExponentialLoad) -> Float64
-

Get DynamicExponentialLoad α.

source
PowerSystems.get_β — Method
get_β(value::DynamicExponentialLoad) -> Float64
-

Get DynamicExponentialLoad β.

source
PowerSystems.set_T_p! — Method
set_T_p!(value::DynamicExponentialLoad, val) -> Any
-

Set DynamicExponentialLoad T_p.

source
PowerSystems.set_T_q! — Method
set_T_q!(value::DynamicExponentialLoad, val) -> Any
-

Set DynamicExponentialLoad T_q.

source
PowerSystems.set_a! — Method
set_a!(value::DynamicExponentialLoad, val) -> Any
-

Set DynamicExponentialLoad a.

source
PowerSystems.set_b! — Method
set_b!(value::DynamicExponentialLoad, val) -> Any
-

Set DynamicExponentialLoad b.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::DynamicExponentialLoad, val) -> Any
-

Set DynamicExponentialLoad base_power.

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

Set DynamicExponentialLoad ext.

source
PowerSystems.set_α! — Method
set_α!(value::DynamicExponentialLoad, val) -> Any
-

Set DynamicExponentialLoad α.

source
PowerSystems.set_β! — Method
set_β!(value::DynamicExponentialLoad, val) -> Any
-

Set DynamicExponentialLoad β.

source
+x_q: Integrator state of the reactive power,source
InfrastructureSystems.get_name — Method
get_name(value::DynamicExponentialLoad) -> String
+

Get DynamicExponentialLoad name.

source
PowerSystems.get_T_p — Method
get_T_p(value::DynamicExponentialLoad) -> Float64
+

Get DynamicExponentialLoad T_p.

source
PowerSystems.get_T_q — Method
get_T_q(value::DynamicExponentialLoad) -> Float64
+

Get DynamicExponentialLoad T_q.

source
PowerSystems.get_a — Method
get_a(value::DynamicExponentialLoad) -> Float64
+

Get DynamicExponentialLoad a.

source
PowerSystems.get_b — Method
get_b(value::DynamicExponentialLoad) -> Float64
+

Get DynamicExponentialLoad b.

source
PowerSystems.get_base_power — Method
get_base_power(value::DynamicExponentialLoad) -> Float64
+

Get DynamicExponentialLoad base_power.

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

Get DynamicExponentialLoad ext.

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

Get DynamicExponentialLoad n_states.

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

Get DynamicExponentialLoad states.

source
PowerSystems.get_α — Method
get_α(value::DynamicExponentialLoad) -> Float64
+

Get DynamicExponentialLoad α.

source
PowerSystems.get_β — Method
get_β(value::DynamicExponentialLoad) -> Float64
+

Get DynamicExponentialLoad β.

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

Set DynamicExponentialLoad T_p.

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

Set DynamicExponentialLoad T_q.

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

Set DynamicExponentialLoad a.

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

Set DynamicExponentialLoad b.

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

Set DynamicExponentialLoad base_power.

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

Set DynamicExponentialLoad ext.

source
PowerSystems.set_α! — Method
set_α!(value::DynamicExponentialLoad, val) -> Any
+

Set DynamicExponentialLoad α.

source
PowerSystems.set_β! — Method
set_β!(value::DynamicExponentialLoad, val) -> Any
+

Set DynamicExponentialLoad β.

source
diff --git a/previews/PR1205/model_library/generated_EnergyReservoirStorage/index.html b/previews/PR1205/model_library/generated_EnergyReservoirStorage/index.html index a4580c0cd4..cd7a464a2c 100644 --- a/previews/PR1205/model_library/generated_EnergyReservoirStorage/index.html +++ b/previews/PR1205/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. Options are listed here
  • 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, 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.
  • 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/previews/PR1205/model_library/generated_ExponentialLoad/index.html b/previews/PR1205/model_library/generated_ExponentialLoad/index.html index 2c12c05a74..a2b33ad6d1 100644 --- a/previews/PR1205/model_library/generated_ExponentialLoad/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_Filter/index.html b/previews/PR1205/model_library/generated_Filter/index.html index 074745714f..ffe725d006 100644 --- a/previews/PR1205/model_library/generated_Filter/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_FixedAdmittance/index.html b/previews/PR1205/model_library/generated_FixedAdmittance/index.html index c45c93716a..7ed39cfe56 100644 --- a/previews/PR1205/model_library/generated_FixedAdmittance/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_FrequencyEstimator/index.html b/previews/PR1205/model_library/generated_FrequencyEstimator/index.html index 9b88d9de78..299a7e701b 100644 --- a/previews/PR1205/model_library/generated_FrequencyEstimator/index.html +++ b/previews/PR1205/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.
  • 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.
  • 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.
  • 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/previews/PR1205/model_library/generated_GenericDER/index.html b/previews/PR1205/model_library/generated_GenericDER/index.html index 2d2990028d..301a3380ca 100644 --- a/previews/PR1205/model_library/generated_GenericDER/index.html +++ b/previews/PR1205/model_library/generated_GenericDER/index.html @@ -46,121 +46,121 @@ n_states::Int ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

Parameters of a Generic Distributed Energy Resource Model. Based on "Modeling Framework and Coordination of DER and Flexible Loads for Ancillary Service Provision."

Arguments

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

Get GenericDER name.

source
PowerSystems.get_D_dn — Method
get_D_dn(value::GenericDER) -> Float64
-

Get GenericDER D_dn.

source
PowerSystems.get_D_up — Method
get_D_up(value::GenericDER) -> Float64
-

Get GenericDER D_up.

source
PowerSystems.get_FES_lim — Method
get_FES_lim(
+end

Parameters of a Generic Distributed Energy Resource Model. Based on "Modeling Framework and Coordination of DER and Flexible Loads for Ancillary Service Provision."

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
  • Qref_Flag::Int: Reactive Power Control Mode. 1 VoltVar Control, 2 Constant Q Control, 3 Constant PF Control, validation range: (1, 3)
  • PQ_Flag::Int: Active and reactive power priority mode. 0 for Q priority, 1 for P priority, validation range: (0, 1)
  • Gen_Flag::Int: Define generator or storage system. 0 unit is a storage device, 1 unit is a generator, validation range: (0, 1)
  • PerOp_Flag::Int: Defines operation of permisible region in VRT characteristic. 0 for cease, 1 for continuous operation, validation range: (0, 1)
  • Recon_Flag::Int: Defines if DER can reconnect after voltage ride-through disconnection, validation range: (0, 1)
  • Trv::Float64: Voltage measurement transducer's time constant, in s, validation range: (0, nothing)
  • VV_pnts::NamedTuple{(:V1, :V2, :V3, :V4), Tuple{Float64, Float64, Float64, Float64}}: Y-axis Volt-var curve points (V1,V2,V3,V4)
  • Q_lim::MinMax: Reactive power limits in pu (Qmin, Qmax)
  • Tp::Float64: Power measurement transducer's time constant, in s, validation range: (0, nothing)
  • e_lim::MinMax: Error limit in PI controller for q control (emin, emax)
  • Kpq::Float64: PI controller proportional gain for q control, validation range: (0, nothing)
  • Kiq::Float64: PI controller integral gain for q control, validation range: (0, nothing)
  • Iqr_lim::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)
  • I_max::Float64: Max. inverter's current, validation range: (0, nothing)
  • Tg::Float64: Current control's time constant, in s, validation range: (0, nothing)
  • kWh_Cap::Float64: BESS capacity in kWh, validation range: (0, nothing)
  • SOC_ini::Float64: Initial state of charge (SOC) in pu, validation range: (0, 1)
  • SOC_lim::MinMax: Battery's SOC limits (SOCmin, SOCmax)
  • Trf::Float64: Time constant to estimate system frequency, in s, validation range: (0, nothing)
  • fdbd_pnts::NamedTuple{(:fdbd1, :fdbd2), Tuple{Float64, Float64}}: Frequency error dead band thresholds (fdbd1, fdbd2)
  • D_dn::Float64: reciprocal of droop for over-frequency conditions, in pu, validation range: (0, nothing)
  • D_up::Float64: reciprocal of droop for under-frequency conditions, in pu, validation range: (0, nothing)
  • fe_lim::MinMax: Frequency error limits in pu (femin, femax)
  • Kpp::Float64: PI controller proportional gain for p control, validation range: (0, nothing)
  • Kip::Float64: PI controller integral gain for p control, validation range: (0, nothing)
  • P_lim::MinMax: Active power limits in pu (Pmin, Pmax)
  • dP_lim::MinMax: Ramp rate limits for active power in pu/s (dPmin, dPmax)
  • T_pord::Float64: Power filter time constant in s, validation range: (0, nothing)
  • rrpwr::Float64: Ramp rate for real power increase following a fault, in pu/s, validation range: (0, nothing)
  • VRT_pnts::NamedTuple{(:vrt1, :vrt2, :vrt3, :vrt4, :vrt5), Tuple{Float64, Float64, Float64, Float64, Float64}}: Voltage ride through v points (vrt1,vrt2,vrt3,vrt4,vrt5)
  • TVRT_pnts::NamedTuple{(:tvrt1, :tvrt2, :tvrt3), Tuple{Float64, Float64, Float64}}: Voltage ride through time points (tvrt1,tvrt2,tvrt3)
  • tV_delay::Float64: Time delay for reconnection after voltage ride-through disconnection, validation range: (0, nothing)
  • VES_lim::MinMax: Min and max voltage for entering service (VESmin,VESmax)
  • FRT_pnts::NamedTuple{(:frt1, :frt2, :frt3, :frt4), Tuple{Float64, Float64, Float64, Float64}}: Frequency ride through v points (frt1,frt2,frt3,frt4)
  • TFRT_pnts::NamedTuple{(:tfrt1, :tfrt2), Tuple{Float64, Float64}}: Frequency ride through time points (tfrt1,tfrt2)
  • tF_delay::Float64: Time delay for reconnection after frequency ride-through disconnection, validation range: (0, nothing)
  • FES_lim::MinMax: Min and max frequency for entering service (FESmin,FESmax)
  • Pfa_ref::Float64: (default: 0.0) Reference power factor, validation range: (0, nothing)
  • Q_ref::Float64: (default: 0.0) Reference reactive power, in pu, validation range: (0, nothing)
  • P_ref::Float64: (default: 1.0) Reference active power, in pu, validation range: (0, nothing)
  • base_power::Float64: (default: 100.0) Base power of the unit (MVA) for per unitization
  • states::Vector{Symbol}: (Do not modify.) The states of GenericDER depend on the Flags
  • n_states::Int: (Do not modify.) The states of GenericDER depend on the Flags
  • 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.
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::GenericDER) -> String
+

Get GenericDER name.

source
PowerSystems.get_D_dn — Method
get_D_dn(value::GenericDER) -> Float64
+

Get GenericDER D_dn.

source
PowerSystems.get_D_up — Method
get_D_up(value::GenericDER) -> Float64
+

Get GenericDER D_up.

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

Get GenericDER FES_lim.

source
PowerSystems.get_FRT_pnts — Method
get_FRT_pnts(
+

Get GenericDER FES_lim.

source
PowerSystems.get_FRT_pnts — Method
get_FRT_pnts(
     value::GenericDER
 ) -> @NamedTuple{frt1::Float64, frt2::Float64, frt3::Float64, frt4::Float64}
-

Get GenericDER FRT_pnts.

source
PowerSystems.get_Gen_Flag — Method
get_Gen_Flag(value::GenericDER) -> Int64
-

Get GenericDER Gen_Flag.

source
PowerSystems.get_I_max — Method
get_I_max(value::GenericDER) -> Float64
-

Get GenericDER I_max.

source
PowerSystems.get_Iqr_lim — Method
get_Iqr_lim(
+

Get GenericDER FRT_pnts.

source
PowerSystems.get_Gen_Flag — Method
get_Gen_Flag(value::GenericDER) -> Int64
+

Get GenericDER Gen_Flag.

source
PowerSystems.get_I_max — Method
get_I_max(value::GenericDER) -> Float64
+

Get GenericDER I_max.

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

Get GenericDER Iqr_lim.

source
PowerSystems.get_Kip — Method
get_Kip(value::GenericDER) -> Float64
-

Get GenericDER Kip.

source
PowerSystems.get_Kiq — Method
get_Kiq(value::GenericDER) -> Float64
-

Get GenericDER Kiq.

source
PowerSystems.get_Kpp — Method
get_Kpp(value::GenericDER) -> Float64
-

Get GenericDER Kpp.

source
PowerSystems.get_Kpq — Method
get_Kpq(value::GenericDER) -> Float64
-

Get GenericDER Kpq.

source
PowerSystems.get_PQ_Flag — Method
get_PQ_Flag(value::GenericDER) -> Int64
-

Get GenericDER PQ_Flag.

source
PowerSystems.get_P_lim — Method
get_P_lim(
+

Get GenericDER Iqr_lim.

source
PowerSystems.get_Kip — Method
get_Kip(value::GenericDER) -> Float64
+

Get GenericDER Kip.

source
PowerSystems.get_Kiq — Method
get_Kiq(value::GenericDER) -> Float64
+

Get GenericDER Kiq.

source
PowerSystems.get_Kpp — Method
get_Kpp(value::GenericDER) -> Float64
+

Get GenericDER Kpp.

source
PowerSystems.get_Kpq — Method
get_Kpq(value::GenericDER) -> Float64
+

Get GenericDER Kpq.

source
PowerSystems.get_PQ_Flag — Method
get_PQ_Flag(value::GenericDER) -> Int64
+

Get GenericDER PQ_Flag.

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

Get GenericDER P_lim.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::GenericDER) -> Float64
-

Get GenericDER P_ref.

source
PowerSystems.get_PerOp_Flag — Method
get_PerOp_Flag(value::GenericDER) -> Int64
-

Get GenericDER PerOp_Flag.

source
PowerSystems.get_Pfa_ref — Method
get_Pfa_ref(value::GenericDER) -> Float64
-

Get GenericDER Pfa_ref.

source
PowerSystems.get_Q_lim — Method
get_Q_lim(
+

Get GenericDER P_lim.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::GenericDER) -> Float64
+

Get GenericDER P_ref.

source
PowerSystems.get_PerOp_Flag — Method
get_PerOp_Flag(value::GenericDER) -> Int64
+

Get GenericDER PerOp_Flag.

source
PowerSystems.get_Pfa_ref — Method
get_Pfa_ref(value::GenericDER) -> Float64
+

Get GenericDER Pfa_ref.

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

Get GenericDER Q_lim.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::GenericDER) -> Float64
-

Get GenericDER Q_ref.

source
PowerSystems.get_Qref_Flag — Method
get_Qref_Flag(value::GenericDER) -> Int64
-

Get GenericDER Qref_Flag.

source
PowerSystems.get_Recon_Flag — Method
get_Recon_Flag(value::GenericDER) -> Int64
-

Get GenericDER Recon_Flag.

source
PowerSystems.get_SOC_ini — Method
get_SOC_ini(value::GenericDER) -> Float64
-

Get GenericDER SOC_ini.

source
PowerSystems.get_SOC_lim — Method
get_SOC_lim(
+

Get GenericDER Q_lim.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::GenericDER) -> Float64
+

Get GenericDER Q_ref.

source
PowerSystems.get_Qref_Flag — Method
get_Qref_Flag(value::GenericDER) -> Int64
+

Get GenericDER Qref_Flag.

source
PowerSystems.get_Recon_Flag — Method
get_Recon_Flag(value::GenericDER) -> Int64
+

Get GenericDER Recon_Flag.

source
PowerSystems.get_SOC_ini — Method
get_SOC_ini(value::GenericDER) -> Float64
+

Get GenericDER SOC_ini.

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

Get GenericDER SOC_lim.

source
PowerSystems.get_TFRT_pnts — Method
get_TFRT_pnts(
+

Get GenericDER SOC_lim.

source
PowerSystems.get_TFRT_pnts — Method
get_TFRT_pnts(
     value::GenericDER
 ) -> @NamedTuple{tfrt1::Float64, tfrt2::Float64}
-

Get GenericDER TFRT_pnts.

source
PowerSystems.get_TVRT_pnts — Method
get_TVRT_pnts(
+

Get GenericDER TFRT_pnts.

source
PowerSystems.get_TVRT_pnts — Method
get_TVRT_pnts(
     value::GenericDER
 ) -> @NamedTuple{tvrt1::Float64, tvrt2::Float64, tvrt3::Float64}
-

Get GenericDER TVRT_pnts.

source
PowerSystems.get_T_pord — Method
get_T_pord(value::GenericDER) -> Float64
-

Get GenericDER T_pord.

source
PowerSystems.get_Tg — Method
get_Tg(value::GenericDER) -> Float64
-

Get GenericDER Tg.

source
PowerSystems.get_Tp — Method
get_Tp(value::GenericDER) -> Float64
-

Get GenericDER Tp.

source
PowerSystems.get_Trf — Method
get_Trf(value::GenericDER) -> Float64
-

Get GenericDER Trf.

source
PowerSystems.get_Trv — Method
get_Trv(value::GenericDER) -> Float64
-

Get GenericDER Trv.

source
PowerSystems.get_VES_lim — Method
get_VES_lim(
+

Get GenericDER TVRT_pnts.

source
PowerSystems.get_T_pord — Method
get_T_pord(value::GenericDER) -> Float64
+

Get GenericDER T_pord.

source
PowerSystems.get_Tg — Method
get_Tg(value::GenericDER) -> Float64
+

Get GenericDER Tg.

source
PowerSystems.get_Tp — Method
get_Tp(value::GenericDER) -> Float64
+

Get GenericDER Tp.

source
PowerSystems.get_Trf — Method
get_Trf(value::GenericDER) -> Float64
+

Get GenericDER Trf.

source
PowerSystems.get_Trv — Method
get_Trv(value::GenericDER) -> Float64
+

Get GenericDER Trv.

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

Get GenericDER VES_lim.

source
PowerSystems.get_VRT_pnts — Method
get_VRT_pnts(
+

Get GenericDER VES_lim.

source
PowerSystems.get_VRT_pnts — Method
get_VRT_pnts(
     value::GenericDER
 ) -> @NamedTuple{vrt1::Float64, vrt2::Float64, vrt3::Float64, vrt4::Float64, vrt5::Float64}
-

Get GenericDER VRT_pnts.

source
PowerSystems.get_VV_pnts — Method
get_VV_pnts(
+

Get GenericDER VRT_pnts.

source
PowerSystems.get_VV_pnts — Method
get_VV_pnts(
     value::GenericDER
 ) -> @NamedTuple{V1::Float64, V2::Float64, V3::Float64, V4::Float64}
-

Get GenericDER VV_pnts.

source
PowerSystems.get_base_power — Method
get_base_power(value::GenericDER) -> Float64
-

Get GenericDER base_power.

source
PowerSystems.get_dP_lim — Method
get_dP_lim(
+

Get GenericDER VV_pnts.

source
PowerSystems.get_base_power — Method
get_base_power(value::GenericDER) -> Float64
+

Get GenericDER base_power.

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

Get GenericDER dP_lim.

source
PowerSystems.get_e_lim — Method
get_e_lim(
+

Get GenericDER dP_lim.

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

Get GenericDER e_lim.

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

Get GenericDER ext.

source
PowerSystems.get_fdbd_pnts — Method
get_fdbd_pnts(
+

Get GenericDER e_lim.

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

Get GenericDER ext.

source
PowerSystems.get_fdbd_pnts — Method
get_fdbd_pnts(
     value::GenericDER
 ) -> @NamedTuple{fdbd1::Float64, fdbd2::Float64}
-

Get GenericDER fdbd_pnts.

source
PowerSystems.get_fe_lim — Method
get_fe_lim(
+

Get GenericDER fdbd_pnts.

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

Get GenericDER fe_lim.

source
PowerSystems.get_kWh_Cap — Method
get_kWh_Cap(value::GenericDER) -> Float64
-

Get GenericDER kWh_Cap.

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

Get GenericDER n_states.

source
PowerSystems.get_rrpwr — Method
get_rrpwr(value::GenericDER) -> Float64
-

Get GenericDER rrpwr.

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

Get GenericDER states.

source
PowerSystems.get_tF_delay — Method
get_tF_delay(value::GenericDER) -> Float64
-

Get GenericDER tF_delay.

source
PowerSystems.get_tV_delay — Method
get_tV_delay(value::GenericDER) -> Float64
-

Get GenericDER tV_delay.

source
PowerSystems.set_D_dn! — Method
set_D_dn!(value::GenericDER, val) -> Any
-

Set GenericDER D_dn.

source
PowerSystems.set_D_up! — Method
set_D_up!(value::GenericDER, val) -> Any
-

Set GenericDER D_up.

source
PowerSystems.set_FES_lim! — Method
set_FES_lim!(value::GenericDER, val) -> Any
-

Set GenericDER FES_lim.

source
PowerSystems.set_FRT_pnts! — Method
set_FRT_pnts!(value::GenericDER, val) -> Any
-

Set GenericDER FRT_pnts.

source
PowerSystems.set_Gen_Flag! — Method
set_Gen_Flag!(value::GenericDER, val) -> Any
-

Set GenericDER Gen_Flag.

source
PowerSystems.set_I_max! — Method
set_I_max!(value::GenericDER, val) -> Any
-

Set GenericDER I_max.

source
PowerSystems.set_Iqr_lim! — Method
set_Iqr_lim!(value::GenericDER, val) -> Any
-

Set GenericDER Iqr_lim.

source
PowerSystems.set_Kip! — Method
set_Kip!(value::GenericDER, val) -> Any
-

Set GenericDER Kip.

source
PowerSystems.set_Kiq! — Method
set_Kiq!(value::GenericDER, val) -> Any
-

Set GenericDER Kiq.

source
PowerSystems.set_Kpp! — Method
set_Kpp!(value::GenericDER, val) -> Any
-

Set GenericDER Kpp.

source
PowerSystems.set_Kpq! — Method
set_Kpq!(value::GenericDER, val) -> Any
-

Set GenericDER Kpq.

source
PowerSystems.set_PQ_Flag! — Method
set_PQ_Flag!(value::GenericDER, val) -> Any
-

Set GenericDER PQ_Flag.

source
PowerSystems.set_P_lim! — Method
set_P_lim!(value::GenericDER, val) -> Any
-

Set GenericDER P_lim.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::GenericDER, val) -> Any
-

Set GenericDER P_ref.

source
PowerSystems.set_PerOp_Flag! — Method
set_PerOp_Flag!(value::GenericDER, val) -> Any
-

Set GenericDER PerOp_Flag.

source
PowerSystems.set_Pfa_ref! — Method
set_Pfa_ref!(value::GenericDER, val) -> Any
-

Set GenericDER Pfa_ref.

source
PowerSystems.set_Q_lim! — Method
set_Q_lim!(value::GenericDER, val) -> Any
-

Set GenericDER Q_lim.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(value::GenericDER, val) -> Any
-

Set GenericDER Q_ref.

source
PowerSystems.set_Qref_Flag! — Method
set_Qref_Flag!(value::GenericDER, val) -> Any
-

Set GenericDER Qref_Flag.

source
PowerSystems.set_Recon_Flag! — Method
set_Recon_Flag!(value::GenericDER, val) -> Any
-

Set GenericDER Recon_Flag.

source
PowerSystems.set_SOC_ini! — Method
set_SOC_ini!(value::GenericDER, val) -> Any
-

Set GenericDER SOC_ini.

source
PowerSystems.set_SOC_lim! — Method
set_SOC_lim!(value::GenericDER, val) -> Any
-

Set GenericDER SOC_lim.

source
PowerSystems.set_TFRT_pnts! — Method
set_TFRT_pnts!(value::GenericDER, val) -> Any
-

Set GenericDER TFRT_pnts.

source
PowerSystems.set_TVRT_pnts! — Method
set_TVRT_pnts!(value::GenericDER, val) -> Any
-

Set GenericDER TVRT_pnts.

source
PowerSystems.set_T_pord! — Method
set_T_pord!(value::GenericDER, val) -> Any
-

Set GenericDER T_pord.

source
PowerSystems.set_Tg! — Method
set_Tg!(value::GenericDER, val) -> Any
-

Set GenericDER Tg.

source
PowerSystems.set_Tp! — Method
set_Tp!(value::GenericDER, val) -> Any
-

Set GenericDER Tp.

source
PowerSystems.set_Trf! — Method
set_Trf!(value::GenericDER, val) -> Any
-

Set GenericDER Trf.

source
PowerSystems.set_Trv! — Method
set_Trv!(value::GenericDER, val) -> Any
-

Set GenericDER Trv.

source
PowerSystems.set_VES_lim! — Method
set_VES_lim!(value::GenericDER, val) -> Any
-

Set GenericDER VES_lim.

source
PowerSystems.set_VRT_pnts! — Method
set_VRT_pnts!(value::GenericDER, val) -> Any
-

Set GenericDER VRT_pnts.

source
PowerSystems.set_VV_pnts! — Method
set_VV_pnts!(value::GenericDER, val) -> Any
-

Set GenericDER VV_pnts.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::GenericDER, val) -> Any
-

Set GenericDER base_power.

source
PowerSystems.set_dP_lim! — Method
set_dP_lim!(value::GenericDER, val) -> Any
-

Set GenericDER dP_lim.

source
PowerSystems.set_e_lim! — Method
set_e_lim!(value::GenericDER, val) -> Any
-

Set GenericDER e_lim.

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

Set GenericDER ext.

source
PowerSystems.set_fdbd_pnts! — Method
set_fdbd_pnts!(value::GenericDER, val) -> Any
-

Set GenericDER fdbd_pnts.

source
PowerSystems.set_fe_lim! — Method
set_fe_lim!(value::GenericDER, val) -> Any
-

Set GenericDER fe_lim.

source
PowerSystems.set_kWh_Cap! — Method
set_kWh_Cap!(value::GenericDER, val) -> Any
-

Set GenericDER kWh_Cap.

source
PowerSystems.set_rrpwr! — Method
set_rrpwr!(value::GenericDER, val) -> Any
-

Set GenericDER rrpwr.

source
PowerSystems.set_tF_delay! — Method
set_tF_delay!(value::GenericDER, val) -> Any
-

Set GenericDER tF_delay.

source
PowerSystems.set_tV_delay! — Method
set_tV_delay!(value::GenericDER, val) -> Any
-

Set GenericDER tV_delay.

source
+

Get GenericDER fe_lim.

source
PowerSystems.get_kWh_Cap — Method
get_kWh_Cap(value::GenericDER) -> Float64
+

Get GenericDER kWh_Cap.

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

Get GenericDER n_states.

source
PowerSystems.get_rrpwr — Method
get_rrpwr(value::GenericDER) -> Float64
+

Get GenericDER rrpwr.

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

Get GenericDER states.

source
PowerSystems.get_tF_delay — Method
get_tF_delay(value::GenericDER) -> Float64
+

Get GenericDER tF_delay.

source
PowerSystems.get_tV_delay — Method
get_tV_delay(value::GenericDER) -> Float64
+

Get GenericDER tV_delay.

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

Set GenericDER D_dn.

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

Set GenericDER D_up.

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

Set GenericDER FES_lim.

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

Set GenericDER FRT_pnts.

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

Set GenericDER Gen_Flag.

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

Set GenericDER I_max.

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

Set GenericDER Iqr_lim.

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

Set GenericDER Kip.

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

Set GenericDER Kiq.

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

Set GenericDER Kpp.

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

Set GenericDER Kpq.

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

Set GenericDER PQ_Flag.

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

Set GenericDER P_lim.

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

Set GenericDER P_ref.

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

Set GenericDER PerOp_Flag.

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

Set GenericDER Pfa_ref.

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

Set GenericDER Q_lim.

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

Set GenericDER Q_ref.

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

Set GenericDER Qref_Flag.

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

Set GenericDER Recon_Flag.

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

Set GenericDER SOC_ini.

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

Set GenericDER SOC_lim.

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

Set GenericDER TFRT_pnts.

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

Set GenericDER TVRT_pnts.

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

Set GenericDER T_pord.

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

Set GenericDER Tg.

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

Set GenericDER Tp.

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

Set GenericDER Trf.

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

Set GenericDER Trv.

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

Set GenericDER VES_lim.

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

Set GenericDER VRT_pnts.

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

Set GenericDER VV_pnts.

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

Set GenericDER base_power.

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

Set GenericDER dP_lim.

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

Set GenericDER e_lim.

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

Set GenericDER ext.

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

Set GenericDER fdbd_pnts.

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

Set GenericDER fe_lim.

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

Set GenericDER kWh_Cap.

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

Set GenericDER rrpwr.

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

Set GenericDER tF_delay.

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

Set GenericDER tV_delay.

source
diff --git a/previews/PR1205/model_library/generated_HydroDispatch/index.html b/previews/PR1205/model_library/generated_HydroDispatch/index.html index 998161126b..6db67b7ab7 100644 --- a/previews/PR1205/model_library/generated_HydroDispatch/index.html +++ b/previews/PR1205/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, 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.
  • 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/previews/PR1205/model_library/generated_HydroEnergyReservoir/index.html b/previews/PR1205/model_library/generated_HydroEnergyReservoir/index.html index 7be076bb9c..f96ad8b163 100644 --- a/previews/PR1205/model_library/generated_HydroEnergyReservoir/index.html +++ b/previews/PR1205/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, 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.
  • 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/previews/PR1205/model_library/generated_HydroPumpedStorage/index.html b/previews/PR1205/model_library/generated_HydroPumpedStorage/index.html index b99c5a6cc6..27f39f0725 100644 --- a/previews/PR1205/model_library/generated_HydroPumpedStorage/index.html +++ b/previews/PR1205/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, 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.
  • 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/previews/PR1205/model_library/generated_InnerControl/index.html b/previews/PR1205/model_library/generated_InnerControl/index.html index c0c8aefec3..c8a124a258 100644 --- a/previews/PR1205/model_library/generated_InnerControl/index.html +++ b/previews/PR1205/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.
  • 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.
  • 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/previews/PR1205/model_library/generated_InterconnectingConverter/index.html b/previews/PR1205/model_library/generated_InterconnectingConverter/index.html index b8114d5451..7a7c50fcbe 100644 --- a/previews/PR1205/model_library/generated_InterconnectingConverter/index.html +++ b/previews/PR1205/model_library/generated_InterconnectingConverter/index.html @@ -15,54 +15,54 @@ 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)
  • dc_current::Float64: (default: 0.0) DC current (A) on the converter
  • max_dc_current::Float64: (default: 1e8) Maximum stable dc current limits (A)
  • 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.
  • 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_dc_current — Method
get_dc_current(value::InterconnectingConverter) -> Float64
-

Get InterconnectingConverter dc_current.

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_dc_current — Method
get_dc_current(value::InterconnectingConverter) -> Float64
+

Get InterconnectingConverter dc_current.

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_max_dc_current — Method
get_max_dc_current(
+

Get InterconnectingConverter loss_function.

source
PowerSystems.get_max_dc_current — Method
get_max_dc_current(
     value::InterconnectingConverter
 ) -> Float64
-

Get InterconnectingConverter max_dc_current.

source
PowerSystems.get_rating — Method
get_rating(value::InterconnectingConverter) -> Any
-

Get InterconnectingConverter rating.

source
PowerSystems.get_services — Method
get_services(
+

Get InterconnectingConverter max_dc_current.

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_dc_current! — Method
set_dc_current!(value::InterconnectingConverter, val) -> Any
-

Set InterconnectingConverter dc_current.

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_dc_current! — Method
set_dc_current!(value::InterconnectingConverter, val) -> Any
+

Set InterconnectingConverter dc_current.

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_max_dc_current! — Method
set_max_dc_current!(
+

Set InterconnectingConverter loss_function.

source
PowerSystems.set_max_dc_current! — Method
set_max_dc_current!(
     value::InterconnectingConverter,
     val
 ) -> Any
-

Set InterconnectingConverter max_dc_current.

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 max_dc_current.

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/previews/PR1205/model_library/generated_InterruptiblePowerLoad/index.html b/previews/PR1205/model_library/generated_InterruptiblePowerLoad/index.html index 64c41a465c..3a413de335 100644 --- a/previews/PR1205/model_library/generated_InterruptiblePowerLoad/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_Line/index.html b/previews/PR1205/model_library/generated_Line/index.html index df67d9f546..55143d55cc 100644 --- a/previews/PR1205/model_library/generated_Line/index.html +++ b/previews/PR1205/model_library/generated_Line/index.html @@ -14,35 +14,35 @@ 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. When defining a line before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to
  • angle_limits::MinMax: Minimum and maximum angle limits (radians), validation range: (-1.571, 1.571)
  • g::FromTo: (default: (from=0.0, to=0.0)) Shunt conductance in pu (SYSTEM_BASE), specified both on the from and to ends of the line. These are commonly modeled with the same value, validation range: (0, 100)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude.
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
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_g — Method
get_g(
+

Get Line b.

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

Get Line ext.

source
PowerSystems.get_g — Method
get_g(
     value::Line
 ) -> @NamedTuple{from::Float64, to::Float64}
-

Get Line g.

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_g! — Method
set_g!(value::Line, val) -> Any
-

Set Line g.

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 g.

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_g! — Method
set_g!(value::Line, val) -> Any
+

Set Line g.

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/previews/PR1205/model_library/generated_LoadZone/index.html b/previews/PR1205/model_library/generated_LoadZone/index.html index 08a9cdd745..edfd04e604 100644 --- a/previews/PR1205/model_library/generated_LoadZone/index.html +++ b/previews/PR1205/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/previews/PR1205/model_library/generated_Machine/index.html b/previews/PR1205/model_library/generated_Machine/index.html index 878f20f72a..5a99f719cf 100644 --- a/previews/PR1205/model_library/generated_Machine/index.html +++ b/previews/PR1205/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.
  • 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.
  • 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.
  • 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.
  • γ_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.
  • γ_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.
  • 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.
  • 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.
  • γ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/previews/PR1205/model_library/generated_MonitoredLine/index.html b/previews/PR1205/model_library/generated_MonitoredLine/index.html index b71c673466..1911596992 100644 --- a/previews/PR1205/model_library/generated_MonitoredLine/index.html +++ b/previews/PR1205/model_library/generated_MonitoredLine/index.html @@ -15,39 +15,39 @@ 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. When defining a line before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to
  • angle_limits::MinMax: Minimum and maximum angle limits (radians), validation range: (-1.571, 1.571)
  • g::FromTo: (default: (from=0.0, to=0.0)) Shunt conductance in pu (SYSTEM_BASE), specified both on the from and to ends of the line. These are commonly modeled with the same value, validation range: (0, 100)
  • services::Vector{Service}: (default: Device[]) Services that this device contributes to
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude.
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
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_g — Method
get_g(
+

Get MonitoredLine flow_limits.

source
PowerSystems.get_g — Method
get_g(
     value::MonitoredLine
 ) -> @NamedTuple{from::Float64, to::Float64}
-

Get MonitoredLine g.

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_g! — Method
set_g!(value::MonitoredLine, val) -> Any
-

Set MonitoredLine g.

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 g.

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_g! — Method
set_g!(value::MonitoredLine, val) -> Any
+

Set MonitoredLine g.

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/previews/PR1205/model_library/generated_OutputCurrentLimiter/index.html b/previews/PR1205/model_library/generated_OutputCurrentLimiter/index.html index b2dd500d30..3e9b1f32be 100644 --- a/previews/PR1205/model_library/generated_OutputCurrentLimiter/index.html +++ b/previews/PR1205/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.
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.
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.
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.
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.
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.
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/previews/PR1205/model_library/generated_PSS/index.html b/previews/PR1205/model_library/generated_PSS/index.html index c3627e0726..bee4cba8f8 100644 --- a/previews/PR1205/model_library/generated_PSS/index.html +++ b/previews/PR1205/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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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/previews/PR1205/model_library/generated_PeriodicVariableSource/index.html b/previews/PR1205/model_library/generated_PeriodicVariableSource/index.html index 9d9b7d3f13..b8f1e20e64 100644 --- a/previews/PR1205/model_library/generated_PeriodicVariableSource/index.html +++ b/previews/PR1205/model_library/generated_PeriodicVariableSource/index.html @@ -14,57 +14,57 @@ n_states::Int ext::Dict{String, Any} internal::InfrastructureSystemsInternal -end

This struct acts as an infinity bus with time varying phasor values magnitude and angle V(t) heta(t). Time varying functions are represented using fourier series

Arguments

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

Get PeriodicVariableSource name.

source
PowerSystems.get_R_th — Method
get_R_th(value::PeriodicVariableSource) -> Float64
-

Get PeriodicVariableSource R_th.

source
PowerSystems.get_X_th — Method
get_X_th(value::PeriodicVariableSource) -> Float64
-

Get PeriodicVariableSource X_th.

source
PowerSystems.get_base_power — Method
get_base_power(value::PeriodicVariableSource) -> Float64
-

Get PeriodicVariableSource base_power.

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

Get PeriodicVariableSource ext.

source
PowerSystems.get_internal_angle_bias — Method
get_internal_angle_bias(
+end

This struct acts as an infinity bus with time varying phasor values magnitude and angle V(t) heta(t). Time varying functions are represented using fourier series

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
  • R_th::Float64: Source Thevenin resistance, validation range: (0, nothing)
  • X_th::Float64: Source Thevenin reactance, validation range: (0, nothing)
  • internal_voltage_bias::Float64: (default: 0.0) a0 term of the Fourier Series for the voltage
  • internal_voltage_frequencies::Vector{Float64}: (default: [0.0]) Frequencies in radians/s
  • internal_voltage_coefficients::Vector{Tuple{Float64,Float64}}: (default: [(0.0, 0.0)]) Coefficients for terms n > 1. First component corresponds to sin and second component to cos
  • internal_angle_bias::Float64: (default: 0.0) a0 term of the Fourier Series for the angle
  • internal_angle_frequencies::Vector{Float64}: (default: [0.0]) Frequencies in radians/s
  • internal_angle_coefficients::Vector{Tuple{Float64,Float64}}: (default: [(0.0, 0.0)]) Coefficients for terms n > 1. First component corresponds to sin and second component to cos
  • base_power::Float64: (default: 100.0) Base power of the source (MVA) for per unitization
  • states::Vector{Symbol}: (Do not modify.) The states for time, voltage and angle
  • n_states::Int: (Do not modify.) PeriodicVariableSource has 2 states
  • 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.
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::PeriodicVariableSource) -> String
+

Get PeriodicVariableSource name.

source
PowerSystems.get_R_th — Method
get_R_th(value::PeriodicVariableSource) -> Float64
+

Get PeriodicVariableSource R_th.

source
PowerSystems.get_X_th — Method
get_X_th(value::PeriodicVariableSource) -> Float64
+

Get PeriodicVariableSource X_th.

source
PowerSystems.get_base_power — Method
get_base_power(value::PeriodicVariableSource) -> Float64
+

Get PeriodicVariableSource base_power.

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

Get PeriodicVariableSource ext.

source
PowerSystems.get_internal_angle_bias — Method
get_internal_angle_bias(
     value::PeriodicVariableSource
 ) -> Float64
-

Get PeriodicVariableSource internal_angle_bias.

source
PowerSystems.get_internal_angle_coefficients — Method
get_internal_angle_coefficients(
+

Get PeriodicVariableSource internal_angle_bias.

source
PowerSystems.get_internal_angle_coefficients — Method
get_internal_angle_coefficients(
     value::PeriodicVariableSource
 ) -> Vector{Tuple{Float64, Float64}}
-

Get PeriodicVariableSource internal_angle_coefficients.

source
PowerSystems.get_internal_angle_frequencies — Method
get_internal_angle_frequencies(
+

Get PeriodicVariableSource internal_angle_coefficients.

source
PowerSystems.get_internal_angle_frequencies — Method
get_internal_angle_frequencies(
     value::PeriodicVariableSource
 ) -> Vector{Float64}
-

Get PeriodicVariableSource internal_angle_frequencies.

source
PowerSystems.get_internal_voltage_bias — Method
get_internal_voltage_bias(
+

Get PeriodicVariableSource internal_angle_frequencies.

source
PowerSystems.get_internal_voltage_bias — Method
get_internal_voltage_bias(
     value::PeriodicVariableSource
 ) -> Float64
-

Get PeriodicVariableSource internal_voltage_bias.

source
PowerSystems.get_internal_voltage_coefficients — Method
get_internal_voltage_coefficients(
+

Get PeriodicVariableSource internal_voltage_bias.

source
PowerSystems.get_internal_voltage_coefficients — Method
get_internal_voltage_coefficients(
     value::PeriodicVariableSource
 ) -> Vector{Tuple{Float64, Float64}}
-

Get PeriodicVariableSource internal_voltage_coefficients.

source
PowerSystems.get_internal_voltage_frequencies — Method
get_internal_voltage_frequencies(
+

Get PeriodicVariableSource internal_voltage_coefficients.

source
PowerSystems.get_internal_voltage_frequencies — Method
get_internal_voltage_frequencies(
     value::PeriodicVariableSource
 ) -> Vector{Float64}
-

Get PeriodicVariableSource internal_voltage_frequencies.

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

Get PeriodicVariableSource n_states.

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

Get PeriodicVariableSource states.

source
PowerSystems.set_R_th! — Method
set_R_th!(value::PeriodicVariableSource, val) -> Any
-

Set PeriodicVariableSource R_th.

source
PowerSystems.set_X_th! — Method
set_X_th!(value::PeriodicVariableSource, val) -> Any
-

Set PeriodicVariableSource X_th.

source
PowerSystems.set_base_power! — Method
set_base_power!(value::PeriodicVariableSource, val) -> Any
-

Set PeriodicVariableSource base_power.

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

Set PeriodicVariableSource ext.

source
PowerSystems.set_internal_angle_bias! — Method
set_internal_angle_bias!(
+

Get PeriodicVariableSource internal_voltage_frequencies.

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

Get PeriodicVariableSource n_states.

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

Get PeriodicVariableSource states.

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

Set PeriodicVariableSource R_th.

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

Set PeriodicVariableSource X_th.

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

Set PeriodicVariableSource base_power.

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

Set PeriodicVariableSource ext.

source
PowerSystems.set_internal_angle_bias! — Method
set_internal_angle_bias!(
     value::PeriodicVariableSource,
     val
 ) -> Any
-

Set PeriodicVariableSource internal_angle_bias.

source
PowerSystems.set_internal_angle_coefficients! — Method
set_internal_angle_coefficients!(
+

Set PeriodicVariableSource internal_angle_bias.

source
PowerSystems.set_internal_angle_coefficients! — Method
set_internal_angle_coefficients!(
     value::PeriodicVariableSource,
     val
 ) -> Any
-

Set PeriodicVariableSource internal_angle_coefficients.

source
PowerSystems.set_internal_angle_frequencies! — Method
set_internal_angle_frequencies!(
+

Set PeriodicVariableSource internal_angle_coefficients.

source
PowerSystems.set_internal_angle_frequencies! — Method
set_internal_angle_frequencies!(
     value::PeriodicVariableSource,
     val
 ) -> Any
-

Set PeriodicVariableSource internal_angle_frequencies.

source
PowerSystems.set_internal_voltage_bias! — Method
set_internal_voltage_bias!(
+

Set PeriodicVariableSource internal_angle_frequencies.

source
PowerSystems.set_internal_voltage_bias! — Method
set_internal_voltage_bias!(
     value::PeriodicVariableSource,
     val
 ) -> Any
-

Set PeriodicVariableSource internal_voltage_bias.

source
PowerSystems.set_internal_voltage_coefficients! — Method
set_internal_voltage_coefficients!(
+

Set PeriodicVariableSource internal_voltage_bias.

source
PowerSystems.set_internal_voltage_coefficients! — Method
set_internal_voltage_coefficients!(
     value::PeriodicVariableSource,
     val
 ) -> Any
-

Set PeriodicVariableSource internal_voltage_coefficients.

source
PowerSystems.set_internal_voltage_frequencies! — Method
set_internal_voltage_frequencies!(
+

Set PeriodicVariableSource internal_voltage_coefficients.

source
PowerSystems.set_internal_voltage_frequencies! — Method
set_internal_voltage_frequencies!(
     value::PeriodicVariableSource,
     val
 ) -> Any
-

Set PeriodicVariableSource internal_voltage_frequencies.

source
+

Set PeriodicVariableSource internal_voltage_frequencies.

source diff --git a/previews/PR1205/model_library/generated_PhaseShiftingTransformer/index.html b/previews/PR1205/model_library/generated_PhaseShiftingTransformer/index.html index cd12fd0c6c..de35b223a5 100644 --- a/previews/PR1205/model_library/generated_PhaseShiftingTransformer/index.html +++ b/previews/PR1205/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. When defining a transformer before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to, 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.
  • 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/previews/PR1205/model_library/generated_PowerLoad/index.html b/previews/PR1205/model_library/generated_PowerLoad/index.html index 232626b5f4..590f1d1e5c 100644 --- a/previews/PR1205/model_library/generated_PowerLoad/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_RenewableDispatch/index.html b/previews/PR1205/model_library/generated_RenewableDispatch/index.html index f5fad6a4e0..fd8f3cc718 100644 --- a/previews/PR1205/model_library/generated_RenewableDispatch/index.html +++ b/previews/PR1205/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), used in some production cost modeling simulations. To set the reactive power in a load flow, use power_factor
  • 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, used in some production cost model simulations and in power flow if the unit is connected to a PV bus. Set to nothing if not applicable
  • power_factor::Float64: Power factor [0, 1] set-point, used in some production cost modeling and in load flow if the unit is connected to a PQ bus, validation range: (0, 1)
  • operation_cost::Union{RenewableGenerationCost, MarketBidCost}: OperationalCost of generation
  • base_power::Float64: Base power of the unit (MVA) for per unitization, 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.
  • 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/previews/PR1205/model_library/generated_RenewableNonDispatch/index.html b/previews/PR1205/model_library/generated_RenewableNonDispatch/index.html index 3fe4bb453a..1860e090ef 100644 --- a/previews/PR1205/model_library/generated_RenewableNonDispatch/index.html +++ b/previews/PR1205/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), used in some production cost modeling simulations. To set the reactive power in a load flow, use power_factor
  • 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: Power factor [0, 1] set-point, used in some production cost modeling and in load flow if the unit is connected to a PQ bus, validation range: (0, 1)
  • base_power::Float64: Base power of the unit (MVA) for per unitization, 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.
  • 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/previews/PR1205/model_library/generated_Shaft/index.html b/previews/PR1205/model_library/generated_Shaft/index.html index f336757e9d..d6e3aa7d2f 100644 --- a/previews/PR1205/model_library/generated_Shaft/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_SimplifiedSingleCageInductionMachine/index.html b/previews/PR1205/model_library/generated_SimplifiedSingleCageInductionMachine/index.html index 5ae52570dd..7a23ee05f0 100644 --- a/previews/PR1205/model_library/generated_SimplifiedSingleCageInductionMachine/index.html +++ b/previews/PR1205/model_library/generated_SimplifiedSingleCageInductionMachine/index.html @@ -22,125 +22,125 @@ internal::InfrastructureSystemsInternal end

Parameters of 3-states three-phase single cage induction machine with quadratic torque-speed relationship

Arguments

ψ_qr: rotor flux in the q-axis,
 ψ_dr: rotor flux in the d-axis, 
-ωr: Rotor speed [pu],
source
InfrastructureSystems.get_name — Method
get_name(
+ωr: Rotor speed [pu],
  • n_states::Int: (Do not modify.) SimplifiedSingleCageInductionMachine has 3 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(
     value::SimplifiedSingleCageInductionMachine
 ) -> String
-

Get SimplifiedSingleCageInductionMachine name.

source
PowerSystems.get_A — Method
get_A(
+

Get SimplifiedSingleCageInductionMachine name.

source
PowerSystems.get_A — Method
get_A(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine A.

source
PowerSystems.get_B — Method
get_B(
+

Get SimplifiedSingleCageInductionMachine A.

source
PowerSystems.get_B — Method
get_B(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine B.

source
PowerSystems.get_B_shunt — Method
get_B_shunt(
+

Get SimplifiedSingleCageInductionMachine B.

source
PowerSystems.get_B_shunt — Method
get_B_shunt(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine B_shunt.

source
PowerSystems.get_C — Method
get_C(
+

Get SimplifiedSingleCageInductionMachine B_shunt.

source
PowerSystems.get_C — Method
get_C(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine C.

source
PowerSystems.get_H — Method
get_H(
+

Get SimplifiedSingleCageInductionMachine C.

source
PowerSystems.get_H — Method
get_H(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine H.

source
PowerSystems.get_R_r — Method
get_R_r(
+

Get SimplifiedSingleCageInductionMachine H.

source
PowerSystems.get_R_r — Method
get_R_r(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine R_r.

source
PowerSystems.get_R_s — Method
get_R_s(
+

Get SimplifiedSingleCageInductionMachine R_r.

source
PowerSystems.get_R_s — Method
get_R_s(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine R_s.

source
PowerSystems.get_X_lr — Method
get_X_lr(
+

Get SimplifiedSingleCageInductionMachine R_s.

source
PowerSystems.get_X_lr — Method
get_X_lr(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine X_lr.

source
PowerSystems.get_X_ls — Method
get_X_ls(
+

Get SimplifiedSingleCageInductionMachine X_lr.

source
PowerSystems.get_X_ls — Method
get_X_ls(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine X_ls.

source
PowerSystems.get_X_m — Method
get_X_m(
+

Get SimplifiedSingleCageInductionMachine X_ls.

source
PowerSystems.get_X_m — Method
get_X_m(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine X_m.

source
PowerSystems.get_X_p — Method
get_X_p(
+

Get SimplifiedSingleCageInductionMachine X_m.

source
PowerSystems.get_X_p — Method
get_X_p(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine X_p.

source
PowerSystems.get_X_rr — Method
get_X_rr(
+

Get SimplifiedSingleCageInductionMachine X_p.

source
PowerSystems.get_X_rr — Method
get_X_rr(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine X_rr.

source
PowerSystems.get_X_ss — Method
get_X_ss(
+

Get SimplifiedSingleCageInductionMachine X_rr.

source
PowerSystems.get_X_ss — Method
get_X_ss(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine X_ss.

source
PowerSystems.get_base_power — Method
get_base_power(
+

Get SimplifiedSingleCageInductionMachine X_ss.

source
PowerSystems.get_base_power — Method
get_base_power(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine base_power.

source
PowerSystems.get_ext — Method
get_ext(
+

Get SimplifiedSingleCageInductionMachine base_power.

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

Get SimplifiedSingleCageInductionMachine ext.

source
PowerSystems.get_n_states — Method
get_n_states(
+

Get SimplifiedSingleCageInductionMachine ext.

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

Get SimplifiedSingleCageInductionMachine n_states.

source
PowerSystems.get_states — Method
get_states(
+

Get SimplifiedSingleCageInductionMachine n_states.

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

Get SimplifiedSingleCageInductionMachine states.

source
PowerSystems.get_τ_ref — Method
get_τ_ref(
+

Get SimplifiedSingleCageInductionMachine states.

source
PowerSystems.get_τ_ref — Method
get_τ_ref(
     value::SimplifiedSingleCageInductionMachine
 ) -> Float64
-

Get SimplifiedSingleCageInductionMachine τ_ref.

source
PowerSystems.set_A! — Method
set_A!(
+

Get SimplifiedSingleCageInductionMachine τ_ref.

source
PowerSystems.set_A! — Method
set_A!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine A.

source
PowerSystems.set_B! — Method
set_B!(
+

Set SimplifiedSingleCageInductionMachine A.

source
PowerSystems.set_B! — Method
set_B!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine B.

source
PowerSystems.set_B_shunt! — Method
set_B_shunt!(
+

Set SimplifiedSingleCageInductionMachine B.

source
PowerSystems.set_B_shunt! — Method
set_B_shunt!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine B_shunt.

source
PowerSystems.set_C! — Method
set_C!(
+

Set SimplifiedSingleCageInductionMachine B_shunt.

source
PowerSystems.set_C! — Method
set_C!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine C.

source
PowerSystems.set_H! — Method
set_H!(
+

Set SimplifiedSingleCageInductionMachine C.

source
PowerSystems.set_H! — Method
set_H!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine H.

source
PowerSystems.set_R_r! — Method
set_R_r!(
+

Set SimplifiedSingleCageInductionMachine H.

source
PowerSystems.set_R_r! — Method
set_R_r!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine R_r.

source
PowerSystems.set_R_s! — Method
set_R_s!(
+

Set SimplifiedSingleCageInductionMachine R_r.

source
PowerSystems.set_R_s! — Method
set_R_s!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine R_s.

source
PowerSystems.set_X_lr! — Method
set_X_lr!(
+

Set SimplifiedSingleCageInductionMachine R_s.

source
PowerSystems.set_X_lr! — Method
set_X_lr!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine X_lr.

source
PowerSystems.set_X_ls! — Method
set_X_ls!(
+

Set SimplifiedSingleCageInductionMachine X_lr.

source
PowerSystems.set_X_ls! — Method
set_X_ls!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine X_ls.

source
PowerSystems.set_X_m! — Method
set_X_m!(
+

Set SimplifiedSingleCageInductionMachine X_ls.

source
PowerSystems.set_X_m! — Method
set_X_m!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine X_m.

source
PowerSystems.set_X_p! — Method
set_X_p!(
+

Set SimplifiedSingleCageInductionMachine X_m.

source
PowerSystems.set_X_p! — Method
set_X_p!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine X_p.

source
PowerSystems.set_X_rr! — Method
set_X_rr!(
+

Set SimplifiedSingleCageInductionMachine X_p.

source
PowerSystems.set_X_rr! — Method
set_X_rr!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine X_rr.

source
PowerSystems.set_X_ss! — Method
set_X_ss!(
+

Set SimplifiedSingleCageInductionMachine X_rr.

source
PowerSystems.set_X_ss! — Method
set_X_ss!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine X_ss.

source
PowerSystems.set_base_power! — Method
set_base_power!(
+

Set SimplifiedSingleCageInductionMachine X_ss.

source
PowerSystems.set_base_power! — Method
set_base_power!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine base_power.

source
PowerSystems.set_ext! — Method
set_ext!(
+

Set SimplifiedSingleCageInductionMachine base_power.

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

Set SimplifiedSingleCageInductionMachine ext.

source
PowerSystems.set_τ_ref! — Method
set_τ_ref!(
+

Set SimplifiedSingleCageInductionMachine ext.

source
PowerSystems.set_τ_ref! — Method
set_τ_ref!(
     value::SimplifiedSingleCageInductionMachine,
     val
 ) -> Any
-

Set SimplifiedSingleCageInductionMachine τ_ref.

source
+

Set SimplifiedSingleCageInductionMachine τ_ref.

source diff --git a/previews/PR1205/model_library/generated_SingleCageInductionMachine/index.html b/previews/PR1205/model_library/generated_SingleCageInductionMachine/index.html index 2eefb25bf2..d11f76d176 100644 --- a/previews/PR1205/model_library/generated_SingleCageInductionMachine/index.html +++ b/previews/PR1205/model_library/generated_SingleCageInductionMachine/index.html @@ -23,44 +23,44 @@ ψ_ds: stator flux in the d-axis, ψ_qr: rotor flux in the q-axis, ψ_dr: rotor flux in the d-axis, -ωr: Rotor speed [pu],source
InfrastructureSystems.get_name — Method
get_name(value::SingleCageInductionMachine) -> String
-

Get SingleCageInductionMachine name.

source
PowerSystems.get_A — Method
get_A(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine A.

source
PowerSystems.get_B — Method
get_B(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine B.

source
PowerSystems.get_B_shunt — Method
get_B_shunt(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine B_shunt.

source
PowerSystems.get_C — Method
get_C(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine C.

source
PowerSystems.get_H — Method
get_H(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine H.

source
PowerSystems.get_R_r — Method
get_R_r(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine R_r.

source
PowerSystems.get_R_s — Method
get_R_s(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine R_s.

source
PowerSystems.get_X_ad — Method
get_X_ad(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine X_ad.

source
PowerSystems.get_X_aq — Method
get_X_aq(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine X_aq.

source
PowerSystems.get_X_lr — Method
get_X_lr(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine X_lr.

source
PowerSystems.get_X_ls — Method
get_X_ls(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine X_ls.

source
PowerSystems.get_X_m — Method
get_X_m(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine X_m.

source
PowerSystems.get_base_power — Method
get_base_power(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine base_power.

source
PowerSystems.get_ext — Method
get_ext(
+ωr: Rotor speed [pu],
  • n_states::Int: (Do not modify.) SingleCageInductionMachine has 5 states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::SingleCageInductionMachine) -> String
+

Get SingleCageInductionMachine name.

source
PowerSystems.get_A — Method
get_A(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine A.

source
PowerSystems.get_B — Method
get_B(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine B.

source
PowerSystems.get_B_shunt — Method
get_B_shunt(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine B_shunt.

source
PowerSystems.get_C — Method
get_C(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine C.

source
PowerSystems.get_H — Method
get_H(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine H.

source
PowerSystems.get_R_r — Method
get_R_r(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine R_r.

source
PowerSystems.get_R_s — Method
get_R_s(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine R_s.

source
PowerSystems.get_X_ad — Method
get_X_ad(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine X_ad.

source
PowerSystems.get_X_aq — Method
get_X_aq(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine X_aq.

source
PowerSystems.get_X_lr — Method
get_X_lr(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine X_lr.

source
PowerSystems.get_X_ls — Method
get_X_ls(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine X_ls.

source
PowerSystems.get_X_m — Method
get_X_m(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine X_m.

source
PowerSystems.get_base_power — Method
get_base_power(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine base_power.

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

Get SingleCageInductionMachine ext.

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

Get SingleCageInductionMachine n_states.

source
PowerSystems.get_states — Method
get_states(
+

Get SingleCageInductionMachine ext.

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

Get SingleCageInductionMachine n_states.

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

Get SingleCageInductionMachine states.

source
PowerSystems.get_τ_ref — Method
get_τ_ref(value::SingleCageInductionMachine) -> Float64
-

Get SingleCageInductionMachine τ_ref.

source
PowerSystems.set_A! — Method
set_A!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine A.

source
PowerSystems.set_B! — Method
set_B!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine B.

source
PowerSystems.set_B_shunt! — Method
set_B_shunt!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine B_shunt.

source
PowerSystems.set_C! — Method
set_C!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine C.

source
PowerSystems.set_H! — Method
set_H!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine H.

source
PowerSystems.set_R_r! — Method
set_R_r!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine R_r.

source
PowerSystems.set_R_s! — Method
set_R_s!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine R_s.

source
PowerSystems.set_X_ad! — Method
set_X_ad!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine X_ad.

source
PowerSystems.set_X_aq! — Method
set_X_aq!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine X_aq.

source
PowerSystems.set_X_lr! — Method
set_X_lr!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine X_lr.

source
PowerSystems.set_X_ls! — Method
set_X_ls!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine X_ls.

source
PowerSystems.set_X_m! — Method
set_X_m!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine X_m.

source
PowerSystems.set_base_power! — Method
set_base_power!(
+

Get SingleCageInductionMachine states.

source
PowerSystems.get_τ_ref — Method
get_τ_ref(value::SingleCageInductionMachine) -> Float64
+

Get SingleCageInductionMachine τ_ref.

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

Set SingleCageInductionMachine A.

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

Set SingleCageInductionMachine B.

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

Set SingleCageInductionMachine B_shunt.

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

Set SingleCageInductionMachine C.

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

Set SingleCageInductionMachine H.

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

Set SingleCageInductionMachine R_r.

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

Set SingleCageInductionMachine R_s.

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

Set SingleCageInductionMachine X_ad.

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

Set SingleCageInductionMachine X_aq.

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

Set SingleCageInductionMachine X_lr.

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

Set SingleCageInductionMachine X_ls.

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

Set SingleCageInductionMachine X_m.

source
PowerSystems.set_base_power! — Method
set_base_power!(
     value::SingleCageInductionMachine,
     val
 ) -> Any
-

Set SingleCageInductionMachine base_power.

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

Set SingleCageInductionMachine ext.

source
PowerSystems.set_τ_ref! — Method
set_τ_ref!(value::SingleCageInductionMachine, val) -> Any
-

Set SingleCageInductionMachine τ_ref.

source
+

Set SingleCageInductionMachine base_power.

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

Set SingleCageInductionMachine ext.

source
PowerSystems.set_τ_ref! — Method
set_τ_ref!(value::SingleCageInductionMachine, val) -> Any
+

Set SingleCageInductionMachine τ_ref.

source
diff --git a/previews/PR1205/model_library/generated_Source/index.html b/previews/PR1205/model_library/generated_Source/index.html index 7df3341d37..5da741292b 100644 --- a/previews/PR1205/model_library/generated_Source/index.html +++ b/previews/PR1205/model_library/generated_Source/index.html @@ -14,30 +14,30 @@ 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_base_power — Method
get_base_power(value::Source) -> Float64
-

Get Source base_power.

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
  • base_power::Float64: (default: 100.0) Base Power in MVA
  • 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.
  • 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_base_power — Method
get_base_power(value::Source) -> Float64
+

Get Source base_power.

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_base_power! — Method
set_base_power!(value::Source, val) -> Any
-

Set Source base_power.

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_base_power! — Method
set_base_power!(value::Source, val) -> Any
+

Set Source base_power.

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/previews/PR1205/model_library/generated_StandardLoad/index.html b/previews/PR1205/model_library/generated_StandardLoad/index.html index 4bd280f91e..01764d08c6 100644 --- a/previews/PR1205/model_library/generated_StandardLoad/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_SwitchedAdmittance/index.html b/previews/PR1205/model_library/generated_SwitchedAdmittance/index.html index 70e2ea3ae5..1ca7746f1a 100644 --- a/previews/PR1205/model_library/generated_SwitchedAdmittance/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_TModelHVDCLine/index.html b/previews/PR1205/model_library/generated_TModelHVDCLine/index.html index 21321dedaa..88c23fa041 100644 --- a/previews/PR1205/model_library/generated_TModelHVDCLine/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_TapTransformer/index.html b/previews/PR1205/model_library/generated_TapTransformer/index.html index 873a37588f..2859647355 100644 --- a/previews/PR1205/model_library/generated_TapTransformer/index.html +++ b/previews/PR1205/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/previews/PR1205/model_library/generated_ThermalMultiStart/index.html b/previews/PR1205/model_library/generated_ThermalMultiStart/index.html index 4b040bc506..3ad1141bde 100644 --- a/previews/PR1205/model_library/generated_ThermalMultiStart/index.html +++ b/previews/PR1205/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, 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.
  • 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/previews/PR1205/model_library/generated_ThermalStandard/index.html b/previews/PR1205/model_library/generated_ThermalStandard/index.html index 4ec65c8077..45742f4b28 100644 --- a/previews/PR1205/model_library/generated_ThermalStandard/index.html +++ b/previews/PR1205/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, 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.
  • 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/previews/PR1205/model_library/generated_Transformer2W/index.html b/previews/PR1205/model_library/generated_Transformer2W/index.html index c45e6d07f6..49e61f2ebb 100644 --- a/previews/PR1205/model_library/generated_Transformer2W/index.html +++ b/previews/PR1205/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/previews/PR1205/model_library/generated_TransmissionInterface/index.html b/previews/PR1205/model_library/generated_TransmissionInterface/index.html index 1404fe70fa..115315dc17 100644 --- a/previews/PR1205/model_library/generated_TransmissionInterface/index.html +++ b/previews/PR1205/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/previews/PR1205/model_library/generated_TurbineGov/index.html b/previews/PR1205/model_library/generated_TurbineGov/index.html index 54c03357ee..fec2055384 100644 --- a/previews/PR1205/model_library/generated_TurbineGov/index.html +++ b/previews/PR1205/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

DEGOV1

PowerSystems.DEGOV1 — Type
mutable struct DEGOV1 <: 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

DEGOV1

PowerSystems.DEGOV1 — Type
mutable struct DEGOV1 <: TurbineGov
     droop_flag::Int
     T1::Float64
     T2::Float64
@@ -60,37 +60,37 @@
     states::Vector{Symbol}
     n_states::Int
     internal::InfrastructureSystemsInternal
-end

Parameters Woodward Diesel Governor Model. DEGOV1 in PSSE

Arguments

  • droop_flag::Int: Droop control Flag. 0 for throttle feedback and 1 for electric power feedback, validation range: (0, 1)
  • T1::Float64: Governor mechanism time constant in s, validation range: (0, 100)
  • T2::Float64: Turbine power time constant in s, validation range: (0, 100)
  • T3::Float64: Turbine exhaust temperature time constant in s, validation range: (0, 100)
  • K::Float64: Governor gain for actuator, validation range: (0, 100)
  • T4::Float64: Governor lead time constant in s, validation range: (0, 100)
  • T5::Float64: Governor lag time constant in s, validation range: (0, 100)
  • T6::Float64: Actuator time constant in s, validation range: (0, 100)
  • Td::Float64: Engine time delay in s, validation range: (0, 100)
  • T_lim::Tuple{Float64, Float64}: Operational control limits on actuator (Tmin, Tmax)
  • R::Float64: Steady state droop parameter, validation range: (0, 100)
  • Te::Float64: Power transducer time constant in s, validation range: (0, 100)
  • 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the DEGOV1 model depends on the droop flag
  • n_states::Int: (Do not modify.) The number of states of the DEGOV1 model depends on the droop flag
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K — Method
get_K(value::DEGOV1) -> Float64
-

Get DEGOV1 K.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::DEGOV1) -> Float64
-

Get DEGOV1 P_ref.

source
PowerSystems.get_R — Method
get_R(value::DEGOV1) -> Float64
-

Get DEGOV1 R.

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

Get DEGOV1 T1.

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

Get DEGOV1 T2.

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

Get DEGOV1 T3.

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

Get DEGOV1 T4.

source
PowerSystems.get_T5 — Method
get_T5(value::DEGOV1) -> Float64
-

Get DEGOV1 T5.

source
PowerSystems.get_T6 — Method
get_T6(value::DEGOV1) -> Float64
-

Get DEGOV1 T6.

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

Get DEGOV1 T_lim.

source
PowerSystems.get_Td — Method
get_Td(value::DEGOV1) -> Float64
-

Get DEGOV1 Td.

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

Get DEGOV1 Te.

source
PowerSystems.get_droop_flag — Method
get_droop_flag(value::DEGOV1) -> Int64
-

Get DEGOV1 droop_flag.

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

Get DEGOV1 ext.

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

Get DEGOV1 n_states.

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

Get DEGOV1 states.

source
PowerSystems.set_K! — Method
set_K!(value::DEGOV1, val) -> Any
-

Set DEGOV1 K.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::DEGOV1, val) -> Any
-

Set DEGOV1 P_ref.

source
PowerSystems.set_R! — Method
set_R!(value::DEGOV1, val) -> Any
-

Set DEGOV1 R.

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

Set DEGOV1 T1.

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

Set DEGOV1 T2.

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

Set DEGOV1 T3.

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

Set DEGOV1 T4.

source
PowerSystems.set_T5! — Method
set_T5!(value::DEGOV1, val) -> Any
-

Set DEGOV1 T5.

source
PowerSystems.set_T6! — Method
set_T6!(value::DEGOV1, val) -> Any
-

Set DEGOV1 T6.

source
PowerSystems.set_T_lim! — Method
set_T_lim!(value::DEGOV1, val) -> Any
-

Set DEGOV1 T_lim.

source
PowerSystems.set_Td! — Method
set_Td!(value::DEGOV1, val) -> Any
-

Set DEGOV1 Td.

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

Set DEGOV1 Te.

source
PowerSystems.set_droop_flag! — Method
set_droop_flag!(value::DEGOV1, val) -> Any
-

Set DEGOV1 droop_flag.

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

Set DEGOV1 ext.

source

GasTG

PowerSystems.GasTG — Type
mutable struct GasTG <: TurbineGov
+end

Parameters Woodward Diesel Governor Model. DEGOV1 in PSSE

Arguments

  • droop_flag::Int: Droop control Flag. 0 for throttle feedback and 1 for electric power feedback, validation range: (0, 1)
  • T1::Float64: Governor mechanism time constant in s, validation range: (0, 100)
  • T2::Float64: Turbine power time constant in s, validation range: (0, 100)
  • T3::Float64: Turbine exhaust temperature time constant in s, validation range: (0, 100)
  • K::Float64: Governor gain for actuator, validation range: (0, 100)
  • T4::Float64: Governor lead time constant in s, validation range: (0, 100)
  • T5::Float64: Governor lag time constant in s, validation range: (0, 100)
  • T6::Float64: Actuator time constant in s, validation range: (0, 100)
  • Td::Float64: Engine time delay in s, validation range: (0, 100)
  • T_lim::Tuple{Float64, Float64}: Operational control limits on actuator (Tmin, Tmax)
  • R::Float64: Steady state droop parameter, validation range: (0, 100)
  • Te::Float64: Power transducer time constant in s, validation range: (0, 100)
  • 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the DEGOV1 model depends on the droop flag
  • n_states::Int: (Do not modify.) The number of states of the DEGOV1 model depends on the droop flag
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_K — Method
get_K(value::DEGOV1) -> Float64
+

Get DEGOV1 K.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::DEGOV1) -> Float64
+

Get DEGOV1 P_ref.

source
PowerSystems.get_R — Method
get_R(value::DEGOV1) -> Float64
+

Get DEGOV1 R.

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

Get DEGOV1 T1.

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

Get DEGOV1 T2.

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

Get DEGOV1 T3.

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

Get DEGOV1 T4.

source
PowerSystems.get_T5 — Method
get_T5(value::DEGOV1) -> Float64
+

Get DEGOV1 T5.

source
PowerSystems.get_T6 — Method
get_T6(value::DEGOV1) -> Float64
+

Get DEGOV1 T6.

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

Get DEGOV1 T_lim.

source
PowerSystems.get_Td — Method
get_Td(value::DEGOV1) -> Float64
+

Get DEGOV1 Td.

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

Get DEGOV1 Te.

source
PowerSystems.get_droop_flag — Method
get_droop_flag(value::DEGOV1) -> Int64
+

Get DEGOV1 droop_flag.

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

Get DEGOV1 ext.

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

Get DEGOV1 n_states.

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

Get DEGOV1 states.

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

Set DEGOV1 K.

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

Set DEGOV1 P_ref.

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

Set DEGOV1 R.

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

Set DEGOV1 T1.

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

Set DEGOV1 T2.

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

Set DEGOV1 T3.

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

Set DEGOV1 T4.

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

Set DEGOV1 T5.

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

Set DEGOV1 T6.

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

Set DEGOV1 T_lim.

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

Set DEGOV1 Td.

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

Set DEGOV1 Te.

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

Set DEGOV1 droop_flag.

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

Set DEGOV1 ext.

source

GasTG

PowerSystems.GasTG — Type
mutable struct GasTG <: TurbineGov
     R::Float64
     T1::Float64
     T2::Float64
@@ -107,31 +107,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.
  • 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
@@ -179,90 +179,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
@@ -283,44 +283,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.
  • 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
@@ -351,60 +351,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

PIDGOV

PowerSystems.PIDGOV — Type
mutable struct PIDGOV <: TurbineGov
+

Set IEEETurbineGov1 valve_position_limits.

source

PIDGOV

PowerSystems.PIDGOV — Type
mutable struct PIDGOV <: TurbineGov
     feedback_flag::Int
     Rperm::Float64
     T_reg::Float64
@@ -432,53 +432,53 @@
 x_g4: Derivative block internal state, 
 x_g5: Second regulator state, 
 x_g6: Gate position state, 
-x_g7: Water inertia state
  • n_states::Int: (Do not modify.) PIDGOV has 7 states
  • states_types::Vector{StateTypes}: (Do not modify.) PIDGOV has 7 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_A_tw — Method
get_A_tw(value::PIDGOV) -> Float64
-

Get PIDGOV A_tw.

source
PowerSystems.get_D_turb — Method
get_D_turb(value::PIDGOV) -> Float64
-

Get PIDGOV D_turb.

source
PowerSystems.get_G_lim — Method
get_G_lim(
+x_g7: Water inertia state
  • n_states::Int: (Do not modify.) PIDGOV has 7 states
  • states_types::Vector{StateTypes}: (Do not modify.) PIDGOV has 7 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_A_tw — Method
get_A_tw(value::PIDGOV) -> Float64
+

Get PIDGOV A_tw.

source
PowerSystems.get_D_turb — Method
get_D_turb(value::PIDGOV) -> Float64
+

Get PIDGOV D_turb.

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

Get PIDGOV G_lim.

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

Get PIDGOV Kd.

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

Get PIDGOV Ki.

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

Get PIDGOV Kp.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::PIDGOV) -> Float64
-

Get PIDGOV P_ref.

source
PowerSystems.get_Rperm — Method
get_Rperm(value::PIDGOV) -> Float64
-

Get PIDGOV Rperm.

source
PowerSystems.get_T_reg — Method
get_T_reg(value::PIDGOV) -> Float64
-

Get PIDGOV T_reg.

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

Get PIDGOV Ta.

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

Get PIDGOV Tb.

source
PowerSystems.get_Tw — Method
get_Tw(value::PIDGOV) -> Float64
-

Get PIDGOV Tw.

source
PowerSystems.get_V_lim — Method
get_V_lim(
+

Get PIDGOV G_lim.

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

Get PIDGOV Kd.

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

Get PIDGOV Ki.

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

Get PIDGOV Kp.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::PIDGOV) -> Float64
+

Get PIDGOV P_ref.

source
PowerSystems.get_Rperm — Method
get_Rperm(value::PIDGOV) -> Float64
+

Get PIDGOV Rperm.

source
PowerSystems.get_T_reg — Method
get_T_reg(value::PIDGOV) -> Float64
+

Get PIDGOV T_reg.

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

Get PIDGOV Ta.

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

Get PIDGOV Tb.

source
PowerSystems.get_Tw — Method
get_Tw(value::PIDGOV) -> Float64
+

Get PIDGOV Tw.

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

Get PIDGOV V_lim.

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

Get PIDGOV ext.

source
PowerSystems.get_feedback_flag — Method
get_feedback_flag(value::PIDGOV) -> Int64
-

Get PIDGOV feedback_flag.

source
PowerSystems.get_gate_openings — Method
get_gate_openings(
+

Get PIDGOV V_lim.

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

Get PIDGOV ext.

source
PowerSystems.get_feedback_flag — Method
get_feedback_flag(value::PIDGOV) -> Int64
+

Get PIDGOV feedback_flag.

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

Get PIDGOV gate_openings.

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

Get PIDGOV n_states.

source
PowerSystems.get_power_gate_openings — Method
get_power_gate_openings(
+

Get PIDGOV gate_openings.

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

Get PIDGOV n_states.

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

Get PIDGOV power_gate_openings.

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

Get PIDGOV states.

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

Get PIDGOV states_types.

source
PowerSystems.set_A_tw! — Method
set_A_tw!(value::PIDGOV, val) -> Any
-

Set PIDGOV A_tw.

source
PowerSystems.set_D_turb! — Method
set_D_turb!(value::PIDGOV, val) -> Any
-

Set PIDGOV D_turb.

source
PowerSystems.set_G_lim! — Method
set_G_lim!(value::PIDGOV, val) -> Any
-

Set PIDGOV G_lim.

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

Set PIDGOV Kd.

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

Set PIDGOV Ki.

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

Set PIDGOV Kp.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::PIDGOV, val) -> Any
-

Set PIDGOV P_ref.

source
PowerSystems.set_Rperm! — Method
set_Rperm!(value::PIDGOV, val) -> Any
-

Set PIDGOV Rperm.

source
PowerSystems.set_T_reg! — Method
set_T_reg!(value::PIDGOV, val) -> Any
-

Set PIDGOV T_reg.

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

Set PIDGOV Ta.

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

Set PIDGOV Tb.

source
PowerSystems.set_Tw! — Method
set_Tw!(value::PIDGOV, val) -> Any
-

Set PIDGOV Tw.

source
PowerSystems.set_V_lim! — Method
set_V_lim!(value::PIDGOV, val) -> Any
-

Set PIDGOV V_lim.

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

Set PIDGOV ext.

source
PowerSystems.set_feedback_flag! — Method
set_feedback_flag!(value::PIDGOV, val) -> Any
-

Set PIDGOV feedback_flag.

source
PowerSystems.set_gate_openings! — Method
set_gate_openings!(value::PIDGOV, val) -> Any
-

Set PIDGOV gate_openings.

source
PowerSystems.set_power_gate_openings! — Method
set_power_gate_openings!(value::PIDGOV, val) -> Any
-

Set PIDGOV power_gate_openings.

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

Set PIDGOV states_types.

source

SteamTurbineGov1

PowerSystems.SteamTurbineGov1 — Type
mutable struct SteamTurbineGov1 <: TurbineGov
+

Get PIDGOV power_gate_openings.

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

Get PIDGOV states.

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

Get PIDGOV states_types.

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

Set PIDGOV A_tw.

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

Set PIDGOV D_turb.

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

Set PIDGOV G_lim.

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

Set PIDGOV Kd.

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

Set PIDGOV Ki.

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

Set PIDGOV Kp.

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

Set PIDGOV P_ref.

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

Set PIDGOV Rperm.

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

Set PIDGOV T_reg.

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

Set PIDGOV Ta.

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

Set PIDGOV Tb.

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

Set PIDGOV Tw.

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

Set PIDGOV V_lim.

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

Set PIDGOV ext.

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

Set PIDGOV feedback_flag.

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

Set PIDGOV gate_openings.

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

Set PIDGOV power_gate_openings.

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

Set PIDGOV states_types.

source

SteamTurbineGov1

PowerSystems.SteamTurbineGov1 — Type
mutable struct SteamTurbineGov1 <: TurbineGov
     R::Float64
     T1::Float64
     valve_position_limits::MinMax
@@ -495,55 +495,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.
  • 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.
  • 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

TGSimple

PowerSystems.TGSimple — Type
mutable struct TGSimple <: 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.
  • 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

TGSimple

PowerSystems.TGSimple — Type
mutable struct TGSimple <: TurbineGov
     d_t::Float64
     Tm::Float64
     P_ref::Float64
@@ -551,17 +551,17 @@
     states::Vector{Symbol}
     n_states::Int
     internal::InfrastructureSystemsInternal
-end

Parameters of a Simple one-state Turbine Governor

Arguments

  • d_t::Float64: Inverse Droop parameter, validation range: (0, nothing)
  • Tm::Float64: Turbine Governor Low-Pass Time Constant [s], validation range: (0, nothing)
  • P_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude.
  • states::Vector{Symbol}: (Do not modify.) The states of the TGSimple model are:
τm: mechanical torque
  • n_states::Int: (Do not modify.) TGSimple has 1 state
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_P_ref — Method
get_P_ref(value::TGSimple) -> Float64
-

Get TGSimple P_ref.

source
PowerSystems.get_Tm — Method
get_Tm(value::TGSimple) -> Float64
-

Get TGSimple Tm.

source
PowerSystems.get_d_t — Method
get_d_t(value::TGSimple) -> Float64
-

Get TGSimple d_t.

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

Get TGSimple ext.

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

Get TGSimple n_states.

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

Get TGSimple states.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::TGSimple, val) -> Any
-

Set TGSimple P_ref.

source
PowerSystems.set_Tm! — Method
set_Tm!(value::TGSimple, val) -> Any
-

Set TGSimple Tm.

source
PowerSystems.set_d_t! — Method
set_d_t!(value::TGSimple, val) -> Any
-

Set TGSimple d_t.

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

Set TGSimple ext.

source

TGTypeI

PowerSystems.TGTypeI — Type
mutable struct TGTypeI <: TurbineGov
+end

Parameters of a Simple one-state Turbine Governor

Arguments

  • d_t::Float64: Inverse Droop parameter, validation range: (0, nothing)
  • Tm::Float64: Turbine Governor Low-Pass Time Constant [s], validation range: (0, nothing)
  • P_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)
  • ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude.
  • states::Vector{Symbol}: (Do not modify.) The states of the TGSimple model are:
τm: mechanical torque
  • n_states::Int: (Do not modify.) TGSimple has 1 state
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_P_ref — Method
get_P_ref(value::TGSimple) -> Float64
+

Get TGSimple P_ref.

source
PowerSystems.get_Tm — Method
get_Tm(value::TGSimple) -> Float64
+

Get TGSimple Tm.

source
PowerSystems.get_d_t — Method
get_d_t(value::TGSimple) -> Float64
+

Get TGSimple d_t.

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

Get TGSimple ext.

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

Get TGSimple n_states.

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

Get TGSimple states.

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

Set TGSimple P_ref.

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

Set TGSimple Tm.

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

Set TGSimple d_t.

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

Set TGSimple ext.

source

TGTypeI

PowerSystems.TGTypeI — Type
mutable struct TGTypeI <: TurbineGov
     R::Float64
     Ts::Float64
     Tc::Float64
@@ -576,29 +576,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.
  • 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
@@ -608,23 +608,23 @@
     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.
  • 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.
  • 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

WPIDHY

PowerSystems.WPIDHY — Type
mutable struct WPIDHY <: TurbineGov
+

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

WPIDHY

PowerSystems.WPIDHY — Type
mutable struct WPIDHY <: TurbineGov
     T_reg::Float64
     reg::Float64
     Kp::Float64
@@ -651,50 +651,50 @@
 x_g4: Derivative block internal state, 
 x_g5: Second regulator state, 
 x_g6: Gate position state, 
-x_g7: Water inertia state
  • n_states::Int: (Do not modify.) PIDGOV has 7 states
  • states_types::Vector{StateTypes}: (Do not modify.) PIDGOV has 7 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_D — Method
get_D(value::WPIDHY) -> Float64
-

Get WPIDHY D.

source
PowerSystems.get_G_lim — Method
get_G_lim(
+x_g7: Water inertia state
  • n_states::Int: (Do not modify.) PIDGOV has 7 states
  • states_types::Vector{StateTypes}: (Do not modify.) PIDGOV has 7 differential states
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
PowerSystems.get_D — Method
get_D(value::WPIDHY) -> Float64
+

Get WPIDHY D.

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

Get WPIDHY G_lim.

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

Get WPIDHY Kd.

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

Get WPIDHY Ki.

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

Get WPIDHY Kp.

source
PowerSystems.get_P_lim — Method
get_P_lim(
+

Get WPIDHY G_lim.

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

Get WPIDHY Kd.

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

Get WPIDHY Ki.

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

Get WPIDHY Kp.

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

Get WPIDHY P_lim.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::WPIDHY) -> Float64
-

Get WPIDHY P_ref.

source
PowerSystems.get_T_reg — Method
get_T_reg(value::WPIDHY) -> Float64
-

Get WPIDHY T_reg.

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

Get WPIDHY Ta.

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

Get WPIDHY Tb.

source
PowerSystems.get_Tw — Method
get_Tw(value::WPIDHY) -> Float64
-

Get WPIDHY Tw.

source
PowerSystems.get_V_lim — Method
get_V_lim(
+

Get WPIDHY P_lim.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::WPIDHY) -> Float64
+

Get WPIDHY P_ref.

source
PowerSystems.get_T_reg — Method
get_T_reg(value::WPIDHY) -> Float64
+

Get WPIDHY T_reg.

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

Get WPIDHY Ta.

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

Get WPIDHY Tb.

source
PowerSystems.get_Tw — Method
get_Tw(value::WPIDHY) -> Float64
+

Get WPIDHY Tw.

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

Get WPIDHY V_lim.

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

Get WPIDHY ext.

source
PowerSystems.get_gate_openings — Method
get_gate_openings(
+

Get WPIDHY V_lim.

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

Get WPIDHY ext.

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

Get WPIDHY gate_openings.

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

Get WPIDHY n_states.

source
PowerSystems.get_power_gate_openings — Method
get_power_gate_openings(
+

Get WPIDHY gate_openings.

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

Get WPIDHY n_states.

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

Get WPIDHY power_gate_openings.

source
PowerSystems.get_reg — Method
get_reg(value::WPIDHY) -> Float64
-

Get WPIDHY reg.

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

Get WPIDHY states.

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

Get WPIDHY states_types.

source
PowerSystems.set_D! — Method
set_D!(value::WPIDHY, val) -> Any
-

Set WPIDHY D.

source
PowerSystems.set_G_lim! — Method
set_G_lim!(value::WPIDHY, val) -> Any
-

Set WPIDHY G_lim.

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

Set WPIDHY Kd.

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

Set WPIDHY Ki.

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

Set WPIDHY Kp.

source
PowerSystems.set_P_lim! — Method
set_P_lim!(value::WPIDHY, val) -> Any
-

Set WPIDHY P_lim.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::WPIDHY, val) -> Any
-

Set WPIDHY P_ref.

source
PowerSystems.set_T_reg! — Method
set_T_reg!(value::WPIDHY, val) -> Any
-

Set WPIDHY T_reg.

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

Set WPIDHY Ta.

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

Set WPIDHY Tb.

source
PowerSystems.set_Tw! — Method
set_Tw!(value::WPIDHY, val) -> Any
-

Set WPIDHY Tw.

source
PowerSystems.set_V_lim! — Method
set_V_lim!(value::WPIDHY, val) -> Any
-

Set WPIDHY V_lim.

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

Set WPIDHY ext.

source
PowerSystems.set_gate_openings! — Method
set_gate_openings!(value::WPIDHY, val) -> Any
-

Set WPIDHY gate_openings.

source
PowerSystems.set_power_gate_openings! — Method
set_power_gate_openings!(value::WPIDHY, val) -> Any
-

Set WPIDHY power_gate_openings.

source
PowerSystems.set_reg! — Method
set_reg!(value::WPIDHY, val) -> Any
-

Set WPIDHY reg.

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

Set WPIDHY states_types.

source
+

Get WPIDHY power_gate_openings.

source
PowerSystems.get_reg — Method
get_reg(value::WPIDHY) -> Float64
+

Get WPIDHY reg.

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

Get WPIDHY states.

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

Get WPIDHY states_types.

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

Set WPIDHY D.

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

Set WPIDHY G_lim.

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

Set WPIDHY Kd.

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

Set WPIDHY Ki.

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

Set WPIDHY Kp.

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

Set WPIDHY P_lim.

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

Set WPIDHY P_ref.

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

Set WPIDHY T_reg.

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

Set WPIDHY Ta.

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

Set WPIDHY Tb.

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

Set WPIDHY Tw.

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

Set WPIDHY V_lim.

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

Set WPIDHY ext.

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

Set WPIDHY gate_openings.

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

Set WPIDHY power_gate_openings.

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

Set WPIDHY reg.

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

Set WPIDHY states_types.

source
diff --git a/previews/PR1205/model_library/generated_TwoTerminalHVDCDetailedLine/index.html b/previews/PR1205/model_library/generated_TwoTerminalHVDCDetailedLine/index.html index 0ae2a5e5e2..a2b9040be2 100644 --- a/previews/PR1205/model_library/generated_TwoTerminalHVDCDetailedLine/index.html +++ b/previews/PR1205/model_library/generated_TwoTerminalHVDCDetailedLine/index.html @@ -4,7 +4,8 @@ available::Bool active_power_flow::Float64 rating::Float64 - active_power_limits::MinMax + active_power_limits_from::MinMax + active_power_limits_to::MinMax arc::Arc converter_loss::Union{LinearCurve, QuadraticCurve} dc_current::Float64 @@ -14,69 +15,76 @@ 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 using a voltage-current model. For modeling a DC network, see TModelHVDCLine

Arguments

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

Get TwoTerminalHVDCDetailedLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(
+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 using a voltage-current model. 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 flowing from the from-bus to the to-bus in DC.
  • rating::Float64: Maximum output power rating of the converter (MVA), validation range: (0, nothing)
  • 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)
  • arc::Arc: An Arc defining this line from a bus to another bus
  • converter_loss::Union{LinearCurve, QuadraticCurve}: (default: LinearCurve(0.0)) Loss model coefficients. It accepts a linear model or quadratic. Same converter data is used in both ends.
  • dc_current::Float64: (default: 0.0) DC current (A) on the converter on the from-bus DC side.
  • max_dc_current::Float64: (default: 1e8) Maximum stable dc current limits (A). Includes converter and DC line.
  • g::Float64: (default: 0.0) Series conductance of the DC line in pu (SYSTEM_BASE)
  • voltage_limits::MinMax: (default: (min=0.0, max=999.9)) Limits on the Voltage at the DC Bus.
  • 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.
  • internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
source
InfrastructureSystems.get_name — Method
get_name(value::TwoTerminalHVDCDetailedLine) -> String
+

Get TwoTerminalHVDCDetailedLine name.

source
PowerSystems.get_active_power_flow — Method
get_active_power_flow(
     value::TwoTerminalHVDCDetailedLine
 ) -> Any
-

Get TwoTerminalHVDCDetailedLine active_power_flow.

source
PowerSystems.get_active_power_limits — Method
get_active_power_limits(
+

Get TwoTerminalHVDCDetailedLine active_power_flow.

source
PowerSystems.get_active_power_limits_from — Method
get_active_power_limits_from(
     value::TwoTerminalHVDCDetailedLine
 ) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
-

Get TwoTerminalHVDCDetailedLine active_power_limits.

source
PowerSystems.get_arc — Method
get_arc(value::TwoTerminalHVDCDetailedLine) -> Arc
-

Get TwoTerminalHVDCDetailedLine arc.

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

Get TwoTerminalHVDCDetailedLine available.

source
PowerSystems.get_converter_loss — Method
get_converter_loss(
+

Get TwoTerminalHVDCDetailedLine active_power_limits_from.

source
PowerSystems.get_active_power_limits_to — Method
get_active_power_limits_to(
+    value::TwoTerminalHVDCDetailedLine
+) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}
+

Get TwoTerminalHVDCDetailedLine active_power_limits_to.

source
PowerSystems.get_arc — Method
get_arc(value::TwoTerminalHVDCDetailedLine) -> Arc
+

Get TwoTerminalHVDCDetailedLine arc.

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

Get TwoTerminalHVDCDetailedLine available.

source
PowerSystems.get_converter_loss — Method
get_converter_loss(
     value::TwoTerminalHVDCDetailedLine
 ) -> Union{LinearCurve, QuadraticCurve}
-

Get TwoTerminalHVDCDetailedLine converter_loss.

source
PowerSystems.get_dc_current — Method
get_dc_current(
+

Get TwoTerminalHVDCDetailedLine converter_loss.

source
PowerSystems.get_dc_current — Method
get_dc_current(
     value::TwoTerminalHVDCDetailedLine
 ) -> Float64
-

Get TwoTerminalHVDCDetailedLine dc_current.

source
PowerSystems.get_ext — Method
get_ext(
+

Get TwoTerminalHVDCDetailedLine dc_current.

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

Get TwoTerminalHVDCDetailedLine ext.

source
PowerSystems.get_g — Method
get_g(value::TwoTerminalHVDCDetailedLine) -> Float64
-

Get TwoTerminalHVDCDetailedLine g.

source
PowerSystems.get_max_dc_current — Method
get_max_dc_current(
+

Get TwoTerminalHVDCDetailedLine ext.

source
PowerSystems.get_g — Method
get_g(value::TwoTerminalHVDCDetailedLine) -> Float64
+

Get TwoTerminalHVDCDetailedLine g.

source
PowerSystems.get_max_dc_current — Method
get_max_dc_current(
     value::TwoTerminalHVDCDetailedLine
 ) -> Float64
-

Get TwoTerminalHVDCDetailedLine max_dc_current.

source
PowerSystems.get_rating — Method
get_rating(value::TwoTerminalHVDCDetailedLine) -> Any
-

Get TwoTerminalHVDCDetailedLine rating.

source
PowerSystems.get_services — Method
get_services(
+

Get TwoTerminalHVDCDetailedLine max_dc_current.

source
PowerSystems.get_rating — Method
get_rating(value::TwoTerminalHVDCDetailedLine) -> Any
+

Get TwoTerminalHVDCDetailedLine rating.

source
PowerSystems.get_services — Method
get_services(
     value::TwoTerminalHVDCDetailedLine
 ) -> Vector{Service}
-

Get TwoTerminalHVDCDetailedLine services.

source
PowerSystems.get_voltage_limits — Method
get_voltage_limits(
+

Get TwoTerminalHVDCDetailedLine services.

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

Get TwoTerminalHVDCDetailedLine voltage_limits.

source
PowerSystems.set_active_power_flow! — Method
set_active_power_flow!(
+

Get TwoTerminalHVDCDetailedLine voltage_limits.

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

Set TwoTerminalHVDCDetailedLine active_power_flow.

source
PowerSystems.set_active_power_limits_from! — Method
set_active_power_limits_from!(
     value::TwoTerminalHVDCDetailedLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCDetailedLine active_power_flow.

source
PowerSystems.set_active_power_limits! — Method
set_active_power_limits!(
+

Set TwoTerminalHVDCDetailedLine active_power_limits_from.

source
PowerSystems.set_active_power_limits_to! — Method
set_active_power_limits_to!(
     value::TwoTerminalHVDCDetailedLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCDetailedLine active_power_limits.

source
PowerSystems.set_arc! — Method
set_arc!(value::TwoTerminalHVDCDetailedLine, val) -> Any
-

Set TwoTerminalHVDCDetailedLine arc.

source
PowerSystems.set_available! — Method
set_available!(
+

Set TwoTerminalHVDCDetailedLine active_power_limits_to.

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

Set TwoTerminalHVDCDetailedLine arc.

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

Set TwoTerminalHVDCDetailedLine available.

source
PowerSystems.set_converter_loss! — Method
set_converter_loss!(
+

Set TwoTerminalHVDCDetailedLine available.

source
PowerSystems.set_converter_loss! — Method
set_converter_loss!(
     value::TwoTerminalHVDCDetailedLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCDetailedLine converter_loss.

source
PowerSystems.set_dc_current! — Method
set_dc_current!(
+

Set TwoTerminalHVDCDetailedLine converter_loss.

source
PowerSystems.set_dc_current! — Method
set_dc_current!(
     value::TwoTerminalHVDCDetailedLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCDetailedLine dc_current.

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

Set TwoTerminalHVDCDetailedLine ext.

source
PowerSystems.set_g! — Method
set_g!(value::TwoTerminalHVDCDetailedLine, val) -> Any
-

Set TwoTerminalHVDCDetailedLine g.

source
PowerSystems.set_max_dc_current! — Method
set_max_dc_current!(
+

Set TwoTerminalHVDCDetailedLine dc_current.

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

Set TwoTerminalHVDCDetailedLine ext.

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

Set TwoTerminalHVDCDetailedLine g.

source
PowerSystems.set_max_dc_current! — Method
set_max_dc_current!(
     value::TwoTerminalHVDCDetailedLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCDetailedLine max_dc_current.

source
PowerSystems.set_rating! — Method
set_rating!(value::TwoTerminalHVDCDetailedLine, val) -> Any
-

Set TwoTerminalHVDCDetailedLine rating.

source
PowerSystems.set_services! — Method
set_services!(
+

Set TwoTerminalHVDCDetailedLine max_dc_current.

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

Set TwoTerminalHVDCDetailedLine rating.

source
PowerSystems.set_services! — Method
set_services!(
     value::TwoTerminalHVDCDetailedLine,
     val
 ) -> Any
-

Set TwoTerminalHVDCDetailedLine services.

source
PowerSystems.set_voltage_limits! — Method
set_voltage_limits!(
+

Set TwoTerminalHVDCDetailedLine services.

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

Set TwoTerminalHVDCDetailedLine voltage_limits.

source
+

Set TwoTerminalHVDCDetailedLine voltage_limits.

source diff --git a/previews/PR1205/model_library/generated_TwoTerminalHVDCLine/index.html b/previews/PR1205/model_library/generated_TwoTerminalHVDCLine/index.html index 4eefec784c..807b0f74eb 100644 --- a/previews/PR1205/model_library/generated_TwoTerminalHVDCLine/index.html +++ b/previews/PR1205/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::Union{LinearCurve, PiecewiseIncrementalCurve}: (default: LinearCurve(0.0)) Loss model coefficients. It accepts a linear model with a constant loss (MW) and a proportional loss rate (MW of loss per MW of flow). It also accepts a Piecewise loss, with N segments to specify different proportional losses for different segments.
  • 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.
  • 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
 ) -> Union{LinearCurve, PiecewiseIncrementalCurve}
-

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/previews/PR1205/model_library/generated_TwoTerminalVSCDCLine/index.html b/previews/PR1205/model_library/generated_TwoTerminalVSCDCLine/index.html index a451ccb9fd..a8282ccb01 100644 --- a/previews/PR1205/model_library/generated_TwoTerminalVSCDCLine/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/generated_VariableReserveNonSpinning/index.html b/previews/PR1205/model_library/generated_VariableReserveNonSpinning/index.html index e723fd1d23..82b3158b90 100644 --- a/previews/PR1205/model_library/generated_VariableReserveNonSpinning/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/hybrid_system/index.html b/previews/PR1205/model_library/hybrid_system/index.html index 7195b5d39a..65480371d0 100644 --- a/previews/PR1205/model_library/hybrid_system/index.html +++ b/previews/PR1205/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.
  • 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/previews/PR1205/model_library/hydro_generation_cost/index.html b/previews/PR1205/model_library/hydro_generation_cost/index.html index 5cabfa31c4..c69a28bbf5 100644 --- a/previews/PR1205/model_library/hydro_generation_cost/index.html +++ b/previews/PR1205/model_library/hydro_generation_cost/index.html @@ -1,9 +1,9 @@ HydroGenerationCost · PowerSystems.jl
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/previews/PR1205/model_library/load_cost/index.html b/previews/PR1205/model_library/load_cost/index.html index 2d40e5f293..fd8c72e14c 100644 --- a/previews/PR1205/model_library/load_cost/index.html +++ b/previews/PR1205/model_library/load_cost/index.html @@ -1,7 +1,7 @@ LoadCost · PowerSystems.jl
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/previews/PR1205/model_library/market_bid_cost/index.html b/previews/PR1205/model_library/market_bid_cost/index.html index b0919c254b..b5b9ab4fe7 100644 --- a/previews/PR1205/model_library/market_bid_cost/index.html +++ b/previews/PR1205/model_library/market_bid_cost/index.html @@ -1,7 +1,7 @@ MarketBidCost · PowerSystems.jl
GitHub

MarketBidCost

PowerSystems.MarketBidCost — Type
mutable struct MarketBidCost <: OperationalCost

  • no_load_cost::Union{Nothing, 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, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}: Sell Offer Curves data, which can be a time series of PiecewiseStepData or a CostCurve of PiecewiseIncrementalCurve

  • decremental_offer_curves::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}: Buy Offer Curves data, which can be a time series of PiecewiseStepData or a CostCurve of PiecewiseIncrementalCurve

  • incremental_initial_input::Union{Nothing, TimeSeriesKey}: If using a time series for incrementaloffercurves, this is a time series of Float64 representing the initial_input

  • decremental_initial_input::Union{Nothing, TimeSeriesKey}: If using a time series for decrementaloffercurves, this is a time series of Float64 representing the initial_input

  • 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.MarketBidCost — Method
MarketBidCost(
+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.MarketBidCost — Method
MarketBidCost(
     no_load_cost,
     start_up::Real,
     shut_down;
@@ -11,7 +11,7 @@
     decremental_initial_input,
     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 — Method
MarketBidCost(
     no_load_cost::Float64,
     start_up::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey},
     shut_down,
@@ -19,7 +19,7 @@
     decremental_offer_curves,
     ancillary_service_offers
 ) -> MarketBidCost
-

Auxiliary Constructor for TestData

source
PowerSystems.MarketBidCost — Method
MarketBidCost(
     no_load_cost::Integer,
     start_up::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey},
     shut_down,
@@ -29,35 +29,35 @@
     decremental_initial_input,
     ancillary_service_offers
 ) -> MarketBidCost
-

Auxiliary Constructor for Deserialization with Integer at no load cost

source
PowerSystems.make_market_bid_curve — Method
make_market_bid_curve(
     data::PiecewiseStepData,
     initial_input::Float64;
     power_units,
     input_at_zero
 ) -> 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},
     initial_input::Float64;
@@ -66,34 +66,34 @@
 ) -> CostCurve{PiecewiseIncrementalCurve}

Make a CostCurve{PiecewiseIncrementalCurve} suitable for inclusion in a MarketBidCost from a vector of power values, a vector of marginal costs, a float of initial input, and an optional units system and input at zero.

Examples

mbc = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0)
 mbc2 = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0; input_at_zero = 10.0)
-mbc3 = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0; power_inputs = UnitSystem.NATURAL_UNITS)
source
PowerSystems.set_start_up! — Method
set_start_up!(
     value::MarketBidCost,
     val::Real
 ) -> NamedTuple{(:hot, :warm, :cold), <:Tuple{Any, Float64, Float64}}
-

Auxiliary Method for setting up start up that are not multi-start

source
+

Auxiliary Method for setting up start up that are not multi-start

source diff --git a/previews/PR1205/model_library/outer_control/index.html b/previews/PR1205/model_library/outer_control/index.html index d3595ca4f3..ad9423587d 100644 --- a/previews/PR1205/model_library/outer_control/index.html +++ b/previews/PR1205/model_library/outer_control/index.html @@ -8,11 +8,11 @@ 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
PowerSystems.get_ext — Method
get_ext(value::OuterControl) -> Dict{String, Any}
-

Get ext from OuterControl.

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

Get n_states from OuterControl.

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

Get states from OuterControl.

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

Set OuterControl ext.

source

Active Power Controllers

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
PowerSystems.get_ext — Method
get_ext(value::OuterControl) -> Dict{String, Any}
+

Get ext from OuterControl.

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

Get n_states from OuterControl.

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

Get states from OuterControl.

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

Set OuterControl ext.

source

Active Power Controllers

Virtual Inertia

PowerSystems.VirtualInertia — Type
mutable struct VirtualInertia <: ActivePowerControl
     Ta::Float64
     kd::Float64
     kω::Float64
@@ -21,19 +21,19 @@
     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.
  • 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

Active Power Droop

PowerSystems.ActivePowerDroop — Type
mutable struct ActivePowerDroop <: ActivePowerControl
+ω_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

Active Power Droop

PowerSystems.ActivePowerDroop — Type
mutable struct ActivePowerDroop <: ActivePowerControl
     Rp::Float64
     ωz::Float64
     P_ref::Float64
@@ -41,17 +41,17 @@
     states::Vector{Symbol}
     n_states::Int
 end

Parameters of an Active Power droop controller

Arguments

  • Rp::Float64: Droop Gain, validation range: (0, nothing)
  • ωz::Float64: filter frequency cutoff, 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ActivePowerDroop model are:
θ_oc: Phase angle displacement of the inverter model,
-p_oc: Measured active power of the inverter model
  • n_states::Int: (Do not modify.) ActivePowerDroop has two states
source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActivePowerDroop) -> Float64
-

Get ActivePowerDroop P_ref.

source
PowerSystems.get_Rp — Method
get_Rp(value::ActivePowerDroop) -> Float64
-

Get ActivePowerDroop Rp.

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

Get ActivePowerDroop ext.

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

Get ActivePowerDroop n_states.

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

Get ActivePowerDroop states.

source
PowerSystems.get_ωz — Method
get_ωz(value::ActivePowerDroop) -> Float64
-

Get ActivePowerDroop ωz.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::ActivePowerDroop, val) -> Any
-

Set ActivePowerDroop P_ref.

source
PowerSystems.set_Rp! — Method
set_Rp!(value::ActivePowerDroop, val) -> Any
-

Set ActivePowerDroop Rp.

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

Set ActivePowerDroop ext.

source
PowerSystems.set_ωz! — Method
set_ωz!(value::ActivePowerDroop, val) -> Any
-

Set ActivePowerDroop ωz.

source

Active Power PI

PowerSystems.ActivePowerPI — Type
mutable struct ActivePowerPI <: ActivePowerControl
+p_oc: Measured active power of the inverter model
  • n_states::Int: (Do not modify.) ActivePowerDroop has two states
source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActivePowerDroop) -> Float64
+

Get ActivePowerDroop P_ref.

source
PowerSystems.get_Rp — Method
get_Rp(value::ActivePowerDroop) -> Float64
+

Get ActivePowerDroop Rp.

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

Get ActivePowerDroop ext.

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

Get ActivePowerDroop n_states.

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

Get ActivePowerDroop states.

source
PowerSystems.get_ωz — Method
get_ωz(value::ActivePowerDroop) -> Float64
+

Get ActivePowerDroop ωz.

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

Set ActivePowerDroop P_ref.

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

Set ActivePowerDroop Rp.

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

Set ActivePowerDroop ext.

source
PowerSystems.set_ωz! — Method
set_ωz!(value::ActivePowerDroop, val) -> Any
+

Set ActivePowerDroop ωz.

source

Active Power PI

PowerSystems.ActivePowerPI — Type
mutable struct ActivePowerPI <: ActivePowerControl
     Kp_p::Float64
     Ki_p::Float64
     ωz::Float64
@@ -60,36 +60,36 @@
     states::Vector{Symbol}
     n_states::Int
 end

Parameters of a Proportional-Integral Active Power controller for a specified power reference

Arguments

  • Kp_p::Float64: Proportional Gain, validation range: (0, nothing)
  • Ki_p::Float64: Integral Gain, validation range: (0, nothing)
  • ωz::Float64: filter frequency cutoff, 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ActivePowerPI model are:
σp_oc: Integrator state of the PI Controller,
-p_oc: Measured active power of the inverter model
  • n_states::Int: (Do not modify.) ActivePowerPI has two states
source
PowerSystems.get_Ki_p — Method
get_Ki_p(value::ActivePowerPI) -> Float64
-

Get ActivePowerPI Ki_p.

source
PowerSystems.get_Kp_p — Method
get_Kp_p(value::ActivePowerPI) -> Float64
-

Get ActivePowerPI Kp_p.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActivePowerPI) -> Float64
-

Get ActivePowerPI P_ref.

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

Get ActivePowerPI ext.

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

Get ActivePowerPI n_states.

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

Get ActivePowerPI states.

source
PowerSystems.get_ωz — Method
get_ωz(value::ActivePowerPI) -> Float64
-

Get ActivePowerPI ωz.

source
PowerSystems.set_Ki_p! — Method
set_Ki_p!(value::ActivePowerPI, val) -> Any
-

Set ActivePowerPI Ki_p.

source
PowerSystems.set_Kp_p! — Method
set_Kp_p!(value::ActivePowerPI, val) -> Any
-

Set ActivePowerPI Kp_p.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::ActivePowerPI, val) -> Any
-

Set ActivePowerPI P_ref.

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

Set ActivePowerPI ext.

source
PowerSystems.set_ωz! — Method
set_ωz!(value::ActivePowerPI, val) -> Any
-

Set ActivePowerPI ωz.

source

Active Virtual Oscillator

PowerSystems.ActiveVirtualOscillator — Type
mutable struct ActiveVirtualOscillator <: ActivePowerControl
+p_oc: Measured active power of the inverter model
  • n_states::Int: (Do not modify.) ActivePowerPI has two states
source
PowerSystems.get_Ki_p — Method
get_Ki_p(value::ActivePowerPI) -> Float64
+

Get ActivePowerPI Ki_p.

source
PowerSystems.get_Kp_p — Method
get_Kp_p(value::ActivePowerPI) -> Float64
+

Get ActivePowerPI Kp_p.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActivePowerPI) -> Float64
+

Get ActivePowerPI P_ref.

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

Get ActivePowerPI ext.

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

Get ActivePowerPI n_states.

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

Get ActivePowerPI states.

source
PowerSystems.get_ωz — Method
get_ωz(value::ActivePowerPI) -> Float64
+

Get ActivePowerPI ωz.

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

Set ActivePowerPI Ki_p.

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

Set ActivePowerPI Kp_p.

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

Set ActivePowerPI P_ref.

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

Set ActivePowerPI ext.

source
PowerSystems.set_ωz! — Method
set_ωz!(value::ActivePowerPI, val) -> Any
+

Set ActivePowerPI ωz.

source

Active Virtual Oscillator

PowerSystems.ActiveVirtualOscillator — Type
mutable struct ActiveVirtualOscillator <: ActivePowerControl
     k1::Float64
     ψ::Float64
     P_ref::Float64
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of an Active Virtual Oscillator controller. Model is based on "Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control."

Arguments

  • k1::Float64: VOC Synchronization Gain, validation range: (0, nothing)
  • ψ::Float64: Rotation angle of the controller, 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ActiveVirtualOscillator model are:
θ_oc: Phase angle displacement of the inverter model
  • n_states::Int: (Do not modify.) ActiveVirtualOscillator has one state
source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActiveVirtualOscillator) -> Float64
-

Get ActiveVirtualOscillator P_ref.

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

Get ActiveVirtualOscillator ext.

source
PowerSystems.get_k1 — Method
get_k1(value::ActiveVirtualOscillator) -> Float64
-

Get ActiveVirtualOscillator k1.

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

Get ActiveVirtualOscillator n_states.

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

Get ActiveVirtualOscillator states.

source
PowerSystems.get_ψ — Method
get_ψ(value::ActiveVirtualOscillator) -> Float64
-

Get ActiveVirtualOscillator ψ.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::ActiveVirtualOscillator, val) -> Any
-

Set ActiveVirtualOscillator P_ref.

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

Set ActiveVirtualOscillator ext.

source
PowerSystems.set_k1! — Method
set_k1!(value::ActiveVirtualOscillator, val) -> Any
-

Set ActiveVirtualOscillator k1.

source
PowerSystems.set_ψ! — Method
set_ψ!(value::ActiveVirtualOscillator, val) -> Any
-

Set ActiveVirtualOscillator ψ.

source

Active Renewable Controller Type AB

PowerSystems.ActiveRenewableControllerAB — Type
mutable struct ActiveRenewableControllerAB <: ActivePowerControl
+end

Parameters of an Active Virtual Oscillator controller. Model is based on "Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control."

Arguments

  • k1::Float64: VOC Synchronization Gain, validation range: (0, nothing)
  • ψ::Float64: Rotation angle of the controller, 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ActiveVirtualOscillator model are:
θ_oc: Phase angle displacement of the inverter model
  • n_states::Int: (Do not modify.) ActiveVirtualOscillator has one state
source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActiveVirtualOscillator) -> Float64
+

Get ActiveVirtualOscillator P_ref.

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

Get ActiveVirtualOscillator ext.

source
PowerSystems.get_k1 — Method
get_k1(value::ActiveVirtualOscillator) -> Float64
+

Get ActiveVirtualOscillator k1.

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

Get ActiveVirtualOscillator n_states.

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

Get ActiveVirtualOscillator states.

source
PowerSystems.get_ψ — Method
get_ψ(value::ActiveVirtualOscillator) -> Float64
+

Get ActiveVirtualOscillator ψ.

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

Set ActiveVirtualOscillator P_ref.

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

Set ActiveVirtualOscillator ext.

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

Set ActiveVirtualOscillator k1.

source
PowerSystems.set_ψ! — Method
set_ψ!(value::ActiveVirtualOscillator, val) -> Any
+

Set ActiveVirtualOscillator ψ.

source

Active Renewable Controller Type AB

PowerSystems.ActiveRenewableControllerAB — Type
mutable struct ActiveRenewableControllerAB <: ActivePowerControl
     bus_control::Int
     from_branch_control::Int
     to_branch_control::Int
@@ -111,105 +111,105 @@
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of Active Power Controller including REPCA1 and REECB1

Arguments

  • bus_control::Int: ACBus identification number for voltage control. 0 identifies the local bus connected to this component, validation range: (0, nothing)
  • from_branch_control::Int: Monitored branch FROM bus number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)
  • to_branch_control::Int: Monitored branch TO bus number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)
  • branch_id_control::String: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used
  • Freq_Flag::Int: Frequency Flag for REPCA1: 0: disable, 1:enable, validation range: (0, 1)
  • K_pg::Float64: Active power PI control proportional gain, validation range: (0, nothing)
  • K_ig::Float64: Active power PI control integral gain, validation range: (0, nothing)
  • T_p::Float64: Real power measurement filter time constant (s), validation range: (0, nothing)
  • fdbd_pnts::Tuple{Float64, Float64}: Frequency error dead band thresholds (fdbd1, fdbd2)
  • fe_lim::MinMax: Upper/Lower limit on frequency error (fe_min, fe_max)
  • P_lim::MinMax: Upper/Lower limit on power reference (P_min, P_max)
  • T_g::Float64: Power Controller lag time constant, validation range: (0, nothing)
  • D_dn::Float64: Droop for over-frequency conditions, validation range: (nothing, 0)
  • D_up::Float64: Droop for under-frequency conditions, validation range: (0, nothing)
  • dP_lim::MinMax: Upper/Lower limit on power reference ramp rates(dP_min, dP_max)
  • P_lim_inner::MinMax: Upper/Lower limit on power reference for REECB(P_min_inner, P_max_inner)
  • T_pord::Float64: Power filter time constant REECB time constant, 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ActiveRenewableControllerAB model depends on the Flag
  • n_states::Int: (Do not modify.) The states of the ActiveRenewableControllerAB model depends on the Flag
source
PowerSystems.get_D_dn — Method
get_D_dn(value::ActiveRenewableControllerAB) -> Float64
-

Get ActiveRenewableControllerAB D_dn.

source
PowerSystems.get_D_up — Method
get_D_up(value::ActiveRenewableControllerAB) -> Float64
-

Get ActiveRenewableControllerAB D_up.

source
PowerSystems.get_Freq_Flag — Method
get_Freq_Flag(value::ActiveRenewableControllerAB) -> Int64
-

Get ActiveRenewableControllerAB Freq_Flag.

source
PowerSystems.get_K_ig — Method
get_K_ig(value::ActiveRenewableControllerAB) -> Float64
-

Get ActiveRenewableControllerAB K_ig.

source
PowerSystems.get_K_pg — Method
get_K_pg(value::ActiveRenewableControllerAB) -> Float64
-

Get ActiveRenewableControllerAB K_pg.

source
PowerSystems.get_P_lim — Method
get_P_lim(
+end

Parameters of Active Power Controller including REPCA1 and REECB1

Arguments

  • bus_control::Int: ACBus identification number for voltage control. 0 identifies the local bus connected to this component, validation range: (0, nothing)
  • from_branch_control::Int: Monitored branch FROM bus number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)
  • to_branch_control::Int: Monitored branch TO bus number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)
  • branch_id_control::String: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used
  • Freq_Flag::Int: Frequency Flag for REPCA1: 0: disable, 1:enable, validation range: (0, 1)
  • K_pg::Float64: Active power PI control proportional gain, validation range: (0, nothing)
  • K_ig::Float64: Active power PI control integral gain, validation range: (0, nothing)
  • T_p::Float64: Real power measurement filter time constant (s), validation range: (0, nothing)
  • fdbd_pnts::Tuple{Float64, Float64}: Frequency error dead band thresholds (fdbd1, fdbd2)
  • fe_lim::MinMax: Upper/Lower limit on frequency error (fe_min, fe_max)
  • P_lim::MinMax: Upper/Lower limit on power reference (P_min, P_max)
  • T_g::Float64: Power Controller lag time constant, validation range: (0, nothing)
  • D_dn::Float64: Droop for over-frequency conditions, validation range: (nothing, 0)
  • D_up::Float64: Droop for under-frequency conditions, validation range: (0, nothing)
  • dP_lim::MinMax: Upper/Lower limit on power reference ramp rates(dP_min, dP_max)
  • P_lim_inner::MinMax: Upper/Lower limit on power reference for REECB(P_min_inner, P_max_inner)
  • T_pord::Float64: Power filter time constant REECB time constant, 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ActiveRenewableControllerAB model depends on the Flag
  • n_states::Int: (Do not modify.) The states of the ActiveRenewableControllerAB model depends on the Flag
source
PowerSystems.get_D_dn — Method
get_D_dn(value::ActiveRenewableControllerAB) -> Float64
+

Get ActiveRenewableControllerAB D_dn.

source
PowerSystems.get_D_up — Method
get_D_up(value::ActiveRenewableControllerAB) -> Float64
+

Get ActiveRenewableControllerAB D_up.

source
PowerSystems.get_Freq_Flag — Method
get_Freq_Flag(value::ActiveRenewableControllerAB) -> Int64
+

Get ActiveRenewableControllerAB Freq_Flag.

source
PowerSystems.get_K_ig — Method
get_K_ig(value::ActiveRenewableControllerAB) -> Float64
+

Get ActiveRenewableControllerAB K_ig.

source
PowerSystems.get_K_pg — Method
get_K_pg(value::ActiveRenewableControllerAB) -> Float64
+

Get ActiveRenewableControllerAB K_pg.

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

Get ActiveRenewableControllerAB P_lim.

source
PowerSystems.get_P_lim_inner — Method
get_P_lim_inner(
+

Get ActiveRenewableControllerAB P_lim.

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

Get ActiveRenewableControllerAB P_lim_inner.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActiveRenewableControllerAB) -> Float64
-

Get ActiveRenewableControllerAB P_ref.

source
PowerSystems.get_T_g — Method
get_T_g(value::ActiveRenewableControllerAB) -> Float64
-

Get ActiveRenewableControllerAB T_g.

source
PowerSystems.get_T_p — Method
get_T_p(value::ActiveRenewableControllerAB) -> Float64
-

Get ActiveRenewableControllerAB T_p.

source
PowerSystems.get_T_pord — Method
get_T_pord(value::ActiveRenewableControllerAB) -> Float64
-

Get ActiveRenewableControllerAB T_pord.

source
PowerSystems.get_branch_id_control — Method
get_branch_id_control(
+

Get ActiveRenewableControllerAB P_lim_inner.

source
PowerSystems.get_P_ref — Method
get_P_ref(value::ActiveRenewableControllerAB) -> Float64
+

Get ActiveRenewableControllerAB P_ref.

source
PowerSystems.get_T_g — Method
get_T_g(value::ActiveRenewableControllerAB) -> Float64
+

Get ActiveRenewableControllerAB T_g.

source
PowerSystems.get_T_p — Method
get_T_p(value::ActiveRenewableControllerAB) -> Float64
+

Get ActiveRenewableControllerAB T_p.

source
PowerSystems.get_T_pord — Method
get_T_pord(value::ActiveRenewableControllerAB) -> Float64
+

Get ActiveRenewableControllerAB T_pord.

source
PowerSystems.get_branch_id_control — Method
get_branch_id_control(
     value::ActiveRenewableControllerAB
 ) -> String
-

Get ActiveRenewableControllerAB branch_id_control.

source
PowerSystems.get_bus_control — Method
get_bus_control(value::ActiveRenewableControllerAB) -> Int64
-

Get ActiveRenewableControllerAB bus_control.

source
PowerSystems.get_dP_lim — Method
get_dP_lim(
+

Get ActiveRenewableControllerAB branch_id_control.

source
PowerSystems.get_bus_control — Method
get_bus_control(value::ActiveRenewableControllerAB) -> Int64
+

Get ActiveRenewableControllerAB bus_control.

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

Get ActiveRenewableControllerAB dP_lim.

source
PowerSystems.get_ext — Method
get_ext(
+

Get ActiveRenewableControllerAB dP_lim.

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

Get ActiveRenewableControllerAB ext.

source
PowerSystems.get_fdbd_pnts — Method
get_fdbd_pnts(
+

Get ActiveRenewableControllerAB ext.

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

Get ActiveRenewableControllerAB fdbd_pnts.

source
PowerSystems.get_fe_lim — Method
get_fe_lim(
+

Get ActiveRenewableControllerAB fdbd_pnts.

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

Get ActiveRenewableControllerAB fe_lim.

source
PowerSystems.get_from_branch_control — Method
get_from_branch_control(
+

Get ActiveRenewableControllerAB fe_lim.

source
PowerSystems.get_from_branch_control — Method
get_from_branch_control(
     value::ActiveRenewableControllerAB
 ) -> Int64
-

Get ActiveRenewableControllerAB from_branch_control.

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

Get ActiveRenewableControllerAB n_states.

source
PowerSystems.get_states — Method
get_states(
+

Get ActiveRenewableControllerAB from_branch_control.

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

Get ActiveRenewableControllerAB n_states.

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

Get ActiveRenewableControllerAB states.

source
PowerSystems.get_to_branch_control — Method
get_to_branch_control(
+

Get ActiveRenewableControllerAB states.

source
PowerSystems.get_to_branch_control — Method
get_to_branch_control(
     value::ActiveRenewableControllerAB
 ) -> Int64
-

Get ActiveRenewableControllerAB to_branch_control.

source
PowerSystems.set_D_dn! — Method
set_D_dn!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB D_dn.

source
PowerSystems.set_D_up! — Method
set_D_up!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB D_up.

source
PowerSystems.set_Freq_Flag! — Method
set_Freq_Flag!(
+

Get ActiveRenewableControllerAB to_branch_control.

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

Set ActiveRenewableControllerAB D_dn.

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

Set ActiveRenewableControllerAB D_up.

source
PowerSystems.set_Freq_Flag! — Method
set_Freq_Flag!(
     value::ActiveRenewableControllerAB,
     val
 ) -> Any
-

Set ActiveRenewableControllerAB Freq_Flag.

source
PowerSystems.set_K_ig! — Method
set_K_ig!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB K_ig.

source
PowerSystems.set_K_pg! — Method
set_K_pg!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB K_pg.

source
PowerSystems.set_P_lim! — Method
set_P_lim!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB P_lim.

source
PowerSystems.set_P_lim_inner! — Method
set_P_lim_inner!(
+

Set ActiveRenewableControllerAB Freq_Flag.

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

Set ActiveRenewableControllerAB K_ig.

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

Set ActiveRenewableControllerAB K_pg.

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

Set ActiveRenewableControllerAB P_lim.

source
PowerSystems.set_P_lim_inner! — Method
set_P_lim_inner!(
     value::ActiveRenewableControllerAB,
     val
 ) -> Any
-

Set ActiveRenewableControllerAB P_lim_inner.

source
PowerSystems.set_P_ref! — Method
set_P_ref!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB P_ref.

source
PowerSystems.set_T_g! — Method
set_T_g!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB T_g.

source
PowerSystems.set_T_p! — Method
set_T_p!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB T_p.

source
PowerSystems.set_T_pord! — Method
set_T_pord!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB T_pord.

source
PowerSystems.set_branch_id_control! — Method
set_branch_id_control!(
+

Set ActiveRenewableControllerAB P_lim_inner.

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

Set ActiveRenewableControllerAB P_ref.

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

Set ActiveRenewableControllerAB T_g.

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

Set ActiveRenewableControllerAB T_p.

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

Set ActiveRenewableControllerAB T_pord.

source
PowerSystems.set_branch_id_control! — Method
set_branch_id_control!(
     value::ActiveRenewableControllerAB,
     val
 ) -> Any
-

Set ActiveRenewableControllerAB branch_id_control.

source
PowerSystems.set_bus_control! — Method
set_bus_control!(
+

Set ActiveRenewableControllerAB branch_id_control.

source
PowerSystems.set_bus_control! — Method
set_bus_control!(
     value::ActiveRenewableControllerAB,
     val
 ) -> Any
-

Set ActiveRenewableControllerAB bus_control.

source
PowerSystems.set_dP_lim! — Method
set_dP_lim!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB dP_lim.

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

Set ActiveRenewableControllerAB ext.

source
PowerSystems.set_fdbd_pnts! — Method
set_fdbd_pnts!(
+

Set ActiveRenewableControllerAB bus_control.

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

Set ActiveRenewableControllerAB dP_lim.

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

Set ActiveRenewableControllerAB ext.

source
PowerSystems.set_fdbd_pnts! — Method
set_fdbd_pnts!(
     value::ActiveRenewableControllerAB,
     val
 ) -> Any
-

Set ActiveRenewableControllerAB fdbd_pnts.

source
PowerSystems.set_fe_lim! — Method
set_fe_lim!(value::ActiveRenewableControllerAB, val) -> Any
-

Set ActiveRenewableControllerAB fe_lim.

source
PowerSystems.set_from_branch_control! — Method
set_from_branch_control!(
+

Set ActiveRenewableControllerAB fdbd_pnts.

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

Set ActiveRenewableControllerAB fe_lim.

source
PowerSystems.set_from_branch_control! — Method
set_from_branch_control!(
     value::ActiveRenewableControllerAB,
     val
 ) -> Any
-

Set ActiveRenewableControllerAB from_branch_control.

source
PowerSystems.set_to_branch_control! — Method
set_to_branch_control!(
+

Set ActiveRenewableControllerAB from_branch_control.

source
PowerSystems.set_to_branch_control! — Method
set_to_branch_control!(
     value::ActiveRenewableControllerAB,
     val
 ) -> Any
-

Set ActiveRenewableControllerAB to_branch_control.

source

Reactive Power Controllers

Reactive Power Droop

PowerSystems.ReactivePowerDroop — Type
mutable struct ReactivePowerDroop <: ReactivePowerControl
+

Set ActiveRenewableControllerAB to_branch_control.

source

Reactive Power Controllers

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.
  • 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

Reactive Power PI

PowerSystems.ReactivePowerPI — Type
mutable struct ReactivePowerPI <: ReactivePowerControl
+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.
  • 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

Reactive Power PI

PowerSystems.ReactivePowerPI — Type
mutable struct ReactivePowerPI <: ReactivePowerControl
     Kp_q::Float64
     Ki_q::Float64
     ωf::Float64
@@ -219,42 +219,42 @@
     states::Vector{Symbol}
     n_states::Int
 end

Parameters of a Proportional-Integral Reactive Power controller for a specified power reference

Arguments

  • Kp_q::Float64: Proportional Gain, validation range: (0, nothing)
  • Ki_q::Float64: Integral Gain, validation range: (0, nothing)
  • ωf::Float64: filter frequency cutoff, validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Voltage Set-point (pu), validation range: (0, nothing)
  • Q_ref::Float64: (default: 1.0) Reactive 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ReactivePowerPI model are:
σq_oc: Integrator state of the PI Controller,
-q_oc: Measured reactive power of the inverter model
  • n_states::Int: (Do not modify.) ReactivePowerPI has two states
source
PowerSystems.get_Ki_q — Method
get_Ki_q(value::ReactivePowerPI) -> Float64
-

Get ReactivePowerPI Ki_q.

source
PowerSystems.get_Kp_q — Method
get_Kp_q(value::ReactivePowerPI) -> Float64
-

Get ReactivePowerPI Kp_q.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::ReactivePowerPI) -> Float64
-

Get ReactivePowerPI Q_ref.

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

Get ReactivePowerPI V_ref.

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

Get ReactivePowerPI ext.

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

Get ReactivePowerPI n_states.

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

Get ReactivePowerPI states.

source
PowerSystems.get_ωf — Method
get_ωf(value::ReactivePowerPI) -> Float64
-

Get ReactivePowerPI ωf.

source
PowerSystems.set_Ki_q! — Method
set_Ki_q!(value::ReactivePowerPI, val) -> Any
-

Set ReactivePowerPI Ki_q.

source
PowerSystems.set_Kp_q! — Method
set_Kp_q!(value::ReactivePowerPI, val) -> Any
-

Set ReactivePowerPI Kp_q.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(value::ReactivePowerPI, val) -> Any
-

Set ReactivePowerPI Q_ref.

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

Set ReactivePowerPI V_ref.

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

Set ReactivePowerPI ext.

source
PowerSystems.set_ωf! — Method
set_ωf!(value::ReactivePowerPI, val) -> Any
-

Set ReactivePowerPI ωf.

source

Reactive Virtual Oscillator

PowerSystems.ReactiveVirtualOscillator — Type
mutable struct ReactiveVirtualOscillator <: ReactivePowerControl
+q_oc: Measured reactive power of the inverter model
  • n_states::Int: (Do not modify.) ReactivePowerPI has two states
source
PowerSystems.get_Ki_q — Method
get_Ki_q(value::ReactivePowerPI) -> Float64
+

Get ReactivePowerPI Ki_q.

source
PowerSystems.get_Kp_q — Method
get_Kp_q(value::ReactivePowerPI) -> Float64
+

Get ReactivePowerPI Kp_q.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::ReactivePowerPI) -> Float64
+

Get ReactivePowerPI Q_ref.

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

Get ReactivePowerPI V_ref.

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

Get ReactivePowerPI ext.

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

Get ReactivePowerPI n_states.

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

Get ReactivePowerPI states.

source
PowerSystems.get_ωf — Method
get_ωf(value::ReactivePowerPI) -> Float64
+

Get ReactivePowerPI ωf.

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

Set ReactivePowerPI Ki_q.

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

Set ReactivePowerPI Kp_q.

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

Set ReactivePowerPI Q_ref.

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

Set ReactivePowerPI V_ref.

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

Set ReactivePowerPI ext.

source
PowerSystems.set_ωf! — Method
set_ωf!(value::ReactivePowerPI, val) -> Any
+

Set ReactivePowerPI ωf.

source

Reactive Virtual Oscillator

PowerSystems.ReactiveVirtualOscillator — Type
mutable struct ReactiveVirtualOscillator <: ReactivePowerControl
     k2::Float64
     V_ref::Float64
     Q_ref::Float64
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of a Reactive Virtual Oscillator controller. Model is based on "Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control."

Arguments

  • k2::Float64: VOC voltage-amplitude control gain, validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • Q_ref::Float64: (default: 1.0) Reference Reactive 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ReactiveVirtualOscilator model are:
E_oc: voltage reference state for inner control in the d-axis
  • n_states::Int: (Do not modify.) ReactiveVirtualOscillator has 1 state
source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::ReactiveVirtualOscillator) -> Float64
-

Get ReactiveVirtualOscillator Q_ref.

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

Get ReactiveVirtualOscillator V_ref.

source
PowerSystems.get_ext — Method
get_ext(
+end

Parameters of a Reactive Virtual Oscillator controller. Model is based on "Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control."

Arguments

  • k2::Float64: VOC voltage-amplitude control gain, validation range: (0, nothing)
  • V_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)
  • Q_ref::Float64: (default: 1.0) Reference Reactive 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ReactiveVirtualOscilator model are:
E_oc: voltage reference state for inner control in the d-axis
  • n_states::Int: (Do not modify.) ReactiveVirtualOscillator has 1 state
source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::ReactiveVirtualOscillator) -> Float64
+

Get ReactiveVirtualOscillator Q_ref.

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

Get ReactiveVirtualOscillator V_ref.

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

Get ReactiveVirtualOscillator ext.

source
PowerSystems.get_k2 — Method
get_k2(value::ReactiveVirtualOscillator) -> Float64
-

Get ReactiveVirtualOscillator k2.

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

Get ReactiveVirtualOscillator n_states.

source
PowerSystems.get_states — Method
get_states(
+

Get ReactiveVirtualOscillator ext.

source
PowerSystems.get_k2 — Method
get_k2(value::ReactiveVirtualOscillator) -> Float64
+

Get ReactiveVirtualOscillator k2.

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

Get ReactiveVirtualOscillator n_states.

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

Get ReactiveVirtualOscillator states.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(value::ReactiveVirtualOscillator, val) -> Any
-

Set ReactiveVirtualOscillator Q_ref.

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

Set ReactiveVirtualOscillator V_ref.

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

Set ReactiveVirtualOscillator ext.

source
PowerSystems.set_k2! — Method
set_k2!(value::ReactiveVirtualOscillator, val) -> Any
-

Set ReactiveVirtualOscillator k2.

source

Reactive Renewable Controller Type AB

PowerSystems.ReactiveRenewableControllerAB — Type
mutable struct ReactiveRenewableControllerAB <: ReactivePowerControl
+

Get ReactiveVirtualOscillator states.

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

Set ReactiveVirtualOscillator Q_ref.

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

Set ReactiveVirtualOscillator V_ref.

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

Set ReactiveVirtualOscillator ext.

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

Set ReactiveVirtualOscillator k2.

source

Reactive Renewable Controller Type AB

PowerSystems.ReactiveRenewableControllerAB — Type
mutable struct ReactiveRenewableControllerAB <: ReactivePowerControl
     bus_control::Int
     from_branch_control::Int
     to_branch_control::Int
@@ -285,117 +285,117 @@
     ext::Dict{String, Any}
     states::Vector{Symbol}
     n_states::Int
-end

Parameters of Reactive Power Controller including REPCA1 and REECB1

Arguments

  • bus_control::Int: ACBus identification number for voltage control. 0 identifies the local bus connected to this component, validation range: (0, nothing)
  • from_branch_control::Int: Monitored branch FROM bus identification number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)
  • to_branch_control::Int: Monitored branch TO bus identification number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)
  • branch_id_control::String: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used
  • VC_Flag::Int: Voltage Compensator Flag for REPCA1, validation range: (0, 1)
  • Ref_Flag::Int: Flag for Reactive Power Control for REPCA1. 0: Q-control, 1: V-control, validation range: (0, 1)
  • PF_Flag::Int: Flag for Power Factor Control for Outer Control of REECB1. 0: Q-control, 1: Power Factor Control, validation range: (0, 1)
  • V_Flag::Int: Flag for Voltage Control for Outer Control of REECB1. 0: Voltage Control, 1: Q-Control, validation range: (0, 1)
  • T_fltr::Float64: Voltage or Q-power of REPCA Filter Time Constant, validation range: (0, nothing)
  • K_p::Float64: Reactive power PI control proportional gain, validation range: (0, nothing)
  • K_i::Float64: Reactive power PI control integral gain, validation range: (0, nothing)
  • T_ft::Float64: Reactive power lead time constant (s), validation range: (0, nothing)
  • T_fv::Float64: Reactive power lag time constant (s), validation range: (0, nothing)
  • V_frz::Float64: Voltage below which state ξq_oc (integrator state) is freeze, validation range: (0, nothing)
  • R_c::Float64: Line drop compensation resistance (used when VC_Flag = 1), validation range: (0, nothing)
  • X_c::Float64: Line drop compensation reactance (used when VC_Flag = 1), validation range: (0, nothing)
  • K_c::Float64: Reactive current compensation gain (pu) (used when VC_Flag = 0), validation range: (0, nothing)
  • e_lim::MinMax: Upper/Lower limit on Voltage or Q-power deadband output (e_min, e_max)
  • dbd_pnts::Tuple{Float64, Float64}: Voltage or Q-power error dead band thresholds (dbd1, dbd2)
  • Q_lim::MinMax: Upper/Lower limit on reactive power V/Q control in REPCA (Q_min, Q_max)
  • T_p::Float64: Active power lag time constant in REECB (s). Used only when PF_Flag = 1, validation range: (0, nothing)
  • Q_lim_inner::MinMax: Upper/Lower limit on reactive power input in REECB (Q_min_inner, Q_max_inner). Only used when V_Flag = 1
  • V_lim::MinMax: Upper/Lower limit on reactive power PI controller in REECB (V_min, V_max). Only used when V_Flag = 1
  • K_qp::Float64: Reactive power regulator proportional gain (used when V_Flag = 1), validation range: (0, nothing)
  • K_qi::Float64: Reactive power regulator integral gain (used when V_Flag = 1), validation range: (0, nothing)
  • Q_ref::Float64: (default: 1.0) Reference Reactive Power Set-point (pu), 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ReactiveRenewableControllerAB model depends on the Flag
  • n_states::Int: (Do not modify.) The states of the ReactiveRenewableControllerAB model depends on the Flag
source
PowerSystems.get_K_c — Method
get_K_c(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB K_c.

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

Get ReactiveRenewableControllerAB K_i.

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

Get ReactiveRenewableControllerAB K_p.

source
PowerSystems.get_K_qi — Method
get_K_qi(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB K_qi.

source
PowerSystems.get_K_qp — Method
get_K_qp(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB K_qp.

source
PowerSystems.get_PF_Flag — Method
get_PF_Flag(value::ReactiveRenewableControllerAB) -> Int64
-

Get ReactiveRenewableControllerAB PF_Flag.

source
PowerSystems.get_Q_lim — Method
get_Q_lim(
+end

Parameters of Reactive Power Controller including REPCA1 and REECB1

Arguments

  • bus_control::Int: ACBus identification number for voltage control. 0 identifies the local bus connected to this component, validation range: (0, nothing)
  • from_branch_control::Int: Monitored branch FROM bus identification number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)
  • to_branch_control::Int: Monitored branch TO bus identification number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)
  • branch_id_control::String: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used
  • VC_Flag::Int: Voltage Compensator Flag for REPCA1, validation range: (0, 1)
  • Ref_Flag::Int: Flag for Reactive Power Control for REPCA1. 0: Q-control, 1: V-control, validation range: (0, 1)
  • PF_Flag::Int: Flag for Power Factor Control for Outer Control of REECB1. 0: Q-control, 1: Power Factor Control, validation range: (0, 1)
  • V_Flag::Int: Flag for Voltage Control for Outer Control of REECB1. 0: Voltage Control, 1: Q-Control, validation range: (0, 1)
  • T_fltr::Float64: Voltage or Q-power of REPCA Filter Time Constant, validation range: (0, nothing)
  • K_p::Float64: Reactive power PI control proportional gain, validation range: (0, nothing)
  • K_i::Float64: Reactive power PI control integral gain, validation range: (0, nothing)
  • T_ft::Float64: Reactive power lead time constant (s), validation range: (0, nothing)
  • T_fv::Float64: Reactive power lag time constant (s), validation range: (0, nothing)
  • V_frz::Float64: Voltage below which state ξq_oc (integrator state) is freeze, validation range: (0, nothing)
  • R_c::Float64: Line drop compensation resistance (used when VC_Flag = 1), validation range: (0, nothing)
  • X_c::Float64: Line drop compensation reactance (used when VC_Flag = 1), validation range: (0, nothing)
  • K_c::Float64: Reactive current compensation gain (pu) (used when VC_Flag = 0), validation range: (0, nothing)
  • e_lim::MinMax: Upper/Lower limit on Voltage or Q-power deadband output (e_min, e_max)
  • dbd_pnts::Tuple{Float64, Float64}: Voltage or Q-power error dead band thresholds (dbd1, dbd2)
  • Q_lim::MinMax: Upper/Lower limit on reactive power V/Q control in REPCA (Q_min, Q_max)
  • T_p::Float64: Active power lag time constant in REECB (s). Used only when PF_Flag = 1, validation range: (0, nothing)
  • Q_lim_inner::MinMax: Upper/Lower limit on reactive power input in REECB (Q_min_inner, Q_max_inner). Only used when V_Flag = 1
  • V_lim::MinMax: Upper/Lower limit on reactive power PI controller in REECB (V_min, V_max). Only used when V_Flag = 1
  • K_qp::Float64: Reactive power regulator proportional gain (used when V_Flag = 1), validation range: (0, nothing)
  • K_qi::Float64: Reactive power regulator integral gain (used when V_Flag = 1), validation range: (0, nothing)
  • Q_ref::Float64: (default: 1.0) Reference Reactive Power Set-point (pu), 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.
  • states::Vector{Symbol}: (Do not modify.) The states of the ReactiveRenewableControllerAB model depends on the Flag
  • n_states::Int: (Do not modify.) The states of the ReactiveRenewableControllerAB model depends on the Flag
source
PowerSystems.get_K_c — Method
get_K_c(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB K_c.

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

Get ReactiveRenewableControllerAB K_i.

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

Get ReactiveRenewableControllerAB K_p.

source
PowerSystems.get_K_qi — Method
get_K_qi(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB K_qi.

source
PowerSystems.get_K_qp — Method
get_K_qp(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB K_qp.

source
PowerSystems.get_PF_Flag — Method
get_PF_Flag(value::ReactiveRenewableControllerAB) -> Int64
+

Get ReactiveRenewableControllerAB PF_Flag.

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

Get ReactiveRenewableControllerAB Q_lim.

source
PowerSystems.get_Q_lim_inner — Method
get_Q_lim_inner(
+

Get ReactiveRenewableControllerAB Q_lim.

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

Get ReactiveRenewableControllerAB Q_lim_inner.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB Q_ref.

source
PowerSystems.get_R_c — Method
get_R_c(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB R_c.

source
PowerSystems.get_Ref_Flag — Method
get_Ref_Flag(value::ReactiveRenewableControllerAB) -> Int64
-

Get ReactiveRenewableControllerAB Ref_Flag.

source
PowerSystems.get_T_fltr — Method
get_T_fltr(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB T_fltr.

source
PowerSystems.get_T_ft — Method
get_T_ft(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB T_ft.

source
PowerSystems.get_T_fv — Method
get_T_fv(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB T_fv.

source
PowerSystems.get_T_p — Method
get_T_p(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB T_p.

source
PowerSystems.get_VC_Flag — Method
get_VC_Flag(value::ReactiveRenewableControllerAB) -> Int64
-

Get ReactiveRenewableControllerAB VC_Flag.

source
PowerSystems.get_V_Flag — Method
get_V_Flag(value::ReactiveRenewableControllerAB) -> Int64
-

Get ReactiveRenewableControllerAB V_Flag.

source
PowerSystems.get_V_frz — Method
get_V_frz(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB V_frz.

source
PowerSystems.get_V_lim — Method
get_V_lim(
+

Get ReactiveRenewableControllerAB Q_lim_inner.

source
PowerSystems.get_Q_ref — Method
get_Q_ref(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB Q_ref.

source
PowerSystems.get_R_c — Method
get_R_c(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB R_c.

source
PowerSystems.get_Ref_Flag — Method
get_Ref_Flag(value::ReactiveRenewableControllerAB) -> Int64
+

Get ReactiveRenewableControllerAB Ref_Flag.

source
PowerSystems.get_T_fltr — Method
get_T_fltr(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB T_fltr.

source
PowerSystems.get_T_ft — Method
get_T_ft(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB T_ft.

source
PowerSystems.get_T_fv — Method
get_T_fv(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB T_fv.

source
PowerSystems.get_T_p — Method
get_T_p(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB T_p.

source
PowerSystems.get_VC_Flag — Method
get_VC_Flag(value::ReactiveRenewableControllerAB) -> Int64
+

Get ReactiveRenewableControllerAB VC_Flag.

source
PowerSystems.get_V_Flag — Method
get_V_Flag(value::ReactiveRenewableControllerAB) -> Int64
+

Get ReactiveRenewableControllerAB V_Flag.

source
PowerSystems.get_V_frz — Method
get_V_frz(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB V_frz.

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

Get ReactiveRenewableControllerAB V_lim.

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

Get ReactiveRenewableControllerAB V_ref.

source
PowerSystems.get_X_c — Method
get_X_c(value::ReactiveRenewableControllerAB) -> Float64
-

Get ReactiveRenewableControllerAB X_c.

source
PowerSystems.get_branch_id_control — Method
get_branch_id_control(
+

Get ReactiveRenewableControllerAB V_lim.

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

Get ReactiveRenewableControllerAB V_ref.

source
PowerSystems.get_X_c — Method
get_X_c(value::ReactiveRenewableControllerAB) -> Float64
+

Get ReactiveRenewableControllerAB X_c.

source
PowerSystems.get_branch_id_control — Method
get_branch_id_control(
     value::ReactiveRenewableControllerAB
 ) -> String
-

Get ReactiveRenewableControllerAB branch_id_control.

source
PowerSystems.get_bus_control — Method
get_bus_control(
+

Get ReactiveRenewableControllerAB branch_id_control.

source
PowerSystems.get_bus_control — Method
get_bus_control(
     value::ReactiveRenewableControllerAB
 ) -> Int64
-

Get ReactiveRenewableControllerAB bus_control.

source
PowerSystems.get_dbd_pnts — Method
get_dbd_pnts(
+

Get ReactiveRenewableControllerAB bus_control.

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

Get ReactiveRenewableControllerAB dbd_pnts.

source
PowerSystems.get_e_lim — Method
get_e_lim(
+

Get ReactiveRenewableControllerAB dbd_pnts.

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

Get ReactiveRenewableControllerAB e_lim.

source
PowerSystems.get_ext — Method
get_ext(
+

Get ReactiveRenewableControllerAB e_lim.

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

Get ReactiveRenewableControllerAB ext.

source
PowerSystems.get_from_branch_control — Method
get_from_branch_control(
+

Get ReactiveRenewableControllerAB ext.

source
PowerSystems.get_from_branch_control — Method
get_from_branch_control(
     value::ReactiveRenewableControllerAB
 ) -> Int64
-

Get ReactiveRenewableControllerAB from_branch_control.

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

Get ReactiveRenewableControllerAB n_states.

source
PowerSystems.get_states — Method
get_states(
+

Get ReactiveRenewableControllerAB from_branch_control.

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

Get ReactiveRenewableControllerAB n_states.

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

Get ReactiveRenewableControllerAB states.

source
PowerSystems.get_to_branch_control — Method
get_to_branch_control(
+

Get ReactiveRenewableControllerAB states.

source
PowerSystems.get_to_branch_control — Method
get_to_branch_control(
     value::ReactiveRenewableControllerAB
 ) -> Int64
-

Get ReactiveRenewableControllerAB to_branch_control.

source
PowerSystems.set_K_c! — Method
set_K_c!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB K_c.

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

Set ReactiveRenewableControllerAB K_i.

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

Set ReactiveRenewableControllerAB K_p.

source
PowerSystems.set_K_qi! — Method
set_K_qi!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB K_qi.

source
PowerSystems.set_K_qp! — Method
set_K_qp!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB K_qp.

source
PowerSystems.set_PF_Flag! — Method
set_PF_Flag!(
+

Get ReactiveRenewableControllerAB to_branch_control.

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

Set ReactiveRenewableControllerAB K_c.

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

Set ReactiveRenewableControllerAB K_i.

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

Set ReactiveRenewableControllerAB K_p.

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

Set ReactiveRenewableControllerAB K_qi.

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

Set ReactiveRenewableControllerAB K_qp.

source
PowerSystems.set_PF_Flag! — Method
set_PF_Flag!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB PF_Flag.

source
PowerSystems.set_Q_lim! — Method
set_Q_lim!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB Q_lim.

source
PowerSystems.set_Q_lim_inner! — Method
set_Q_lim_inner!(
+

Set ReactiveRenewableControllerAB PF_Flag.

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

Set ReactiveRenewableControllerAB Q_lim.

source
PowerSystems.set_Q_lim_inner! — Method
set_Q_lim_inner!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB Q_lim_inner.

source
PowerSystems.set_Q_ref! — Method
set_Q_ref!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB Q_ref.

source
PowerSystems.set_R_c! — Method
set_R_c!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB R_c.

source
PowerSystems.set_Ref_Flag! — Method
set_Ref_Flag!(
+

Set ReactiveRenewableControllerAB Q_lim_inner.

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

Set ReactiveRenewableControllerAB Q_ref.

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

Set ReactiveRenewableControllerAB R_c.

source
PowerSystems.set_Ref_Flag! — Method
set_Ref_Flag!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB Ref_Flag.

source
PowerSystems.set_T_fltr! — Method
set_T_fltr!(
+

Set ReactiveRenewableControllerAB Ref_Flag.

source
PowerSystems.set_T_fltr! — Method
set_T_fltr!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB T_fltr.

source
PowerSystems.set_T_ft! — Method
set_T_ft!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB T_ft.

source
PowerSystems.set_T_fv! — Method
set_T_fv!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB T_fv.

source
PowerSystems.set_T_p! — Method
set_T_p!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB T_p.

source
PowerSystems.set_VC_Flag! — Method
set_VC_Flag!(
+

Set ReactiveRenewableControllerAB T_fltr.

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

Set ReactiveRenewableControllerAB T_ft.

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

Set ReactiveRenewableControllerAB T_fv.

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

Set ReactiveRenewableControllerAB T_p.

source
PowerSystems.set_VC_Flag! — Method
set_VC_Flag!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB VC_Flag.

source
PowerSystems.set_V_Flag! — Method
set_V_Flag!(
+

Set ReactiveRenewableControllerAB VC_Flag.

source
PowerSystems.set_V_Flag! — Method
set_V_Flag!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB V_Flag.

source
PowerSystems.set_V_frz! — Method
set_V_frz!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB V_frz.

source
PowerSystems.set_V_lim! — Method
set_V_lim!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB V_lim.

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

Set ReactiveRenewableControllerAB V_ref.

source
PowerSystems.set_X_c! — Method
set_X_c!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB X_c.

source
PowerSystems.set_branch_id_control! — Method
set_branch_id_control!(
+

Set ReactiveRenewableControllerAB V_Flag.

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

Set ReactiveRenewableControllerAB V_frz.

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

Set ReactiveRenewableControllerAB V_lim.

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

Set ReactiveRenewableControllerAB V_ref.

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

Set ReactiveRenewableControllerAB X_c.

source
PowerSystems.set_branch_id_control! — Method
set_branch_id_control!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB branch_id_control.

source
PowerSystems.set_bus_control! — Method
set_bus_control!(
+

Set ReactiveRenewableControllerAB branch_id_control.

source
PowerSystems.set_bus_control! — Method
set_bus_control!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB bus_control.

source
PowerSystems.set_dbd_pnts! — Method
set_dbd_pnts!(
+

Set ReactiveRenewableControllerAB bus_control.

source
PowerSystems.set_dbd_pnts! — Method
set_dbd_pnts!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB dbd_pnts.

source
PowerSystems.set_e_lim! — Method
set_e_lim!(value::ReactiveRenewableControllerAB, val) -> Any
-

Set ReactiveRenewableControllerAB e_lim.

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

Set ReactiveRenewableControllerAB ext.

source
PowerSystems.set_from_branch_control! — Method
set_from_branch_control!(
+

Set ReactiveRenewableControllerAB dbd_pnts.

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

Set ReactiveRenewableControllerAB e_lim.

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

Set ReactiveRenewableControllerAB ext.

source
PowerSystems.set_from_branch_control! — Method
set_from_branch_control!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB from_branch_control.

source
PowerSystems.set_to_branch_control! — Method
set_to_branch_control!(
+

Set ReactiveRenewableControllerAB from_branch_control.

source
PowerSystems.set_to_branch_control! — Method
set_to_branch_control!(
     value::ReactiveRenewableControllerAB,
     val
 ) -> Any
-

Set ReactiveRenewableControllerAB to_branch_control.

source
+

Set ReactiveRenewableControllerAB to_branch_control.

source diff --git a/previews/PR1205/model_library/renewable_generation_cost/index.html b/previews/PR1205/model_library/renewable_generation_cost/index.html index 91fbdcace1..bd8199df04 100644 --- a/previews/PR1205/model_library/renewable_generation_cost/index.html +++ b/previews/PR1205/model_library/renewable_generation_cost/index.html @@ -1,13 +1,13 @@ RenewableGenerationCost · PowerSystems.jl
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/previews/PR1205/model_library/reserves/index.html b/previews/PR1205/model_library/reserves/index.html index d6b35c727b..e4a1a0c09d 100644 --- a/previews/PR1205/model_library/reserves/index.html +++ b/previews/PR1205/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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}
-

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/previews/PR1205/model_library/storage_cost/index.html b/previews/PR1205/model_library/storage_cost/index.html index 7536ddd0ea..1c301e3295 100644 --- a/previews/PR1205/model_library/storage_cost/index.html +++ b/previews/PR1205/model_library/storage_cost/index.html @@ -1,19 +1,19 @@ StorageCost · PowerSystems.jl
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/previews/PR1205/model_library/thermal_generation_cost/index.html b/previews/PR1205/model_library/thermal_generation_cost/index.html index c8760cdc06..a249fe1650 100644 --- a/previews/PR1205/model_library/thermal_generation_cost/index.html +++ b/previews/PR1205/model_library/thermal_generation_cost/index.html @@ -1,15 +1,15 @@ ThermalGenerationCost · PowerSystems.jl
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/previews/PR1205/objects.inv b/previews/PR1205/objects.inv index f07a20ff85..9550e26ac8 100644 Binary files a/previews/PR1205/objects.inv and b/previews/PR1205/objects.inv differ diff --git a/previews/PR1205/search_index.js b/previews/PR1205/search_index.js index 4ce904f947..f8f384d1bb 100644 --- a/previews/PR1205/search_index.js +++ b/previews/PR1205/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"model_library/generated_Filter/#Filter","page":"Filter","title":"Filter","text":"","category":"section"},{"location":"model_library/generated_Filter/#LCFilter","page":"Filter","title":"LCFilter","text":"","category":"section"},{"location":"model_library/generated_Filter/","page":"Filter","title":"Filter","text":"Modules = [PowerSystems]\nPages = [\"/LCFilter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Filter/#PowerSystems.LCFilter","page":"Filter","title":"PowerSystems.LCFilter","text":"mutable struct LCFilter <: Filter\n lf::Float64\n rf::Float64\n cf::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a LCL filter outside the converter\n\nArguments\n\nlf::Float64: filter inductance, validation range: (0, nothing)\nrf::Float64: filter resistance, validation range: (0, nothing)\ncf::Float64: filter capacitance, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the LCFilter model are:\n\nir_filter: Real current out of the filter,\nii_filter: Imaginary current out of the filter\n\nn_states::Int: (Do not modify.) LCFilter has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Filter/#PowerSystems.get_cf-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_cf","text":"get_cf(value::LCFilter) -> Float64\n\n\nGet LCFilter cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_ext-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_ext","text":"get_ext(value::LCFilter) -> Dict{String, Any}\n\n\nGet LCFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_lf-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_lf","text":"get_lf(value::LCFilter) -> Float64\n\n\nGet LCFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_n_states-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_n_states","text":"get_n_states(value::LCFilter) -> Int64\n\n\nGet LCFilter n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_rf-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_rf","text":"get_rf(value::LCFilter) -> Float64\n\n\nGet LCFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_states-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_states","text":"get_states(value::LCFilter) -> Vector{Symbol}\n\n\nGet LCFilter states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_cf!-Tuple{LCFilter, Any}","page":"Filter","title":"PowerSystems.set_cf!","text":"set_cf!(value::LCFilter, val) -> Any\n\n\nSet LCFilter cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_ext!-Tuple{LCFilter, Any}","page":"Filter","title":"PowerSystems.set_ext!","text":"set_ext!(value::LCFilter, val) -> Any\n\n\nSet LCFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_lf!-Tuple{LCFilter, Any}","page":"Filter","title":"PowerSystems.set_lf!","text":"set_lf!(value::LCFilter, val) -> Any\n\n\nSet LCFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_rf!-Tuple{LCFilter, Any}","page":"Filter","title":"PowerSystems.set_rf!","text":"set_rf!(value::LCFilter, val) -> Any\n\n\nSet LCFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#LCLFilter","page":"Filter","title":"LCLFilter","text":"","category":"section"},{"location":"model_library/generated_Filter/","page":"Filter","title":"Filter","text":"Modules = [PowerSystems]\nPages = [\"/LCLFilter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Filter/#PowerSystems.LCLFilter","page":"Filter","title":"PowerSystems.LCLFilter","text":"mutable struct LCLFilter <: Filter\n lf::Float64\n rf::Float64\n cf::Float64\n lg::Float64\n rg::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a LCL filter outside the converter, the states are in the grid's reference frame\n\nArguments\n\nlf::Float64: Series inductance in p.u. of converter filter, validation range: (0, nothing)\nrf::Float64: Series resistance in p.u. of converter filter, validation range: (0, nothing)\ncf::Float64: Shunt capacitance in p.u. of converter filter, validation range: (0, nothing)\nlg::Float64: Series inductance in p.u. of converter filter to the grid, validation range: (0, nothing)\nrg::Float64: Series resistance in p.u. of converter filter to the grid, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the LCLFilter model are:\n\nir_cnv: Real current out of the converter,\nii_cnv: Imaginary current out of the converter,\nvr_filter: Real voltage at the filter's capacitor,\nvi_filter: Imaginary voltage at the filter's capacitor,\nir_filter: Real current out of the filter,\nii_filter: Imaginary current out of the filter\n\nn_states::Int: (Do not modify.) LCLFilter has 6 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Filter/#PowerSystems.get_cf-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_cf","text":"get_cf(value::LCLFilter) -> Float64\n\n\nGet LCLFilter cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_ext-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_ext","text":"get_ext(value::LCLFilter) -> Dict{String, Any}\n\n\nGet LCLFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_lf-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_lf","text":"get_lf(value::LCLFilter) -> Float64\n\n\nGet LCLFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_lg-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_lg","text":"get_lg(value::LCLFilter) -> Float64\n\n\nGet LCLFilter lg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_n_states-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_n_states","text":"get_n_states(value::LCLFilter) -> Int64\n\n\nGet LCLFilter n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_rf-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_rf","text":"get_rf(value::LCLFilter) -> Float64\n\n\nGet LCLFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_rg-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_rg","text":"get_rg(value::LCLFilter) -> Float64\n\n\nGet LCLFilter rg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_states-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_states","text":"get_states(value::LCLFilter) -> Vector{Symbol}\n\n\nGet LCLFilter states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_cf!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_cf!","text":"set_cf!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_ext!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_ext!","text":"set_ext!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_lf!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_lf!","text":"set_lf!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_lg!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_lg!","text":"set_lg!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter lg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_rf!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_rf!","text":"set_rf!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_rg!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_rg!","text":"set_rg!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter rg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#RLFilter","page":"Filter","title":"RLFilter","text":"","category":"section"},{"location":"model_library/generated_Filter/","page":"Filter","title":"Filter","text":"Modules = [PowerSystems]\nPages = [\"/RLFilter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Filter/#PowerSystems.RLFilter","page":"Filter","title":"PowerSystems.RLFilter","text":"mutable struct RLFilter <: Filter\n rf::Float64\n lf::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of RL series filter in algebraic representation\n\nArguments\n\nrf::Float64: Series resistance in p.u. of converter filter to the grid, validation range: (0, nothing)\nlf::Float64: Series inductance in p.u. of converter filter to the grid, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) RLFilter has zero states\nn_states::Int: (Do not modify.) RLFilter has zero states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Filter/#PowerSystems.get_ext-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_ext","text":"get_ext(value::RLFilter) -> Dict{String, Any}\n\n\nGet RLFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_lf-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_lf","text":"get_lf(value::RLFilter) -> Float64\n\n\nGet RLFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_n_states-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_n_states","text":"get_n_states(value::RLFilter) -> Int64\n\n\nGet RLFilter n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_rf-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_rf","text":"get_rf(value::RLFilter) -> Float64\n\n\nGet RLFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_states-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_states","text":"get_states(value::RLFilter) -> Vector{Symbol}\n\n\nGet RLFilter states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_ext!-Tuple{RLFilter, Any}","page":"Filter","title":"PowerSystems.set_ext!","text":"set_ext!(value::RLFilter, val) -> Any\n\n\nSet RLFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_lf!-Tuple{RLFilter, Any}","page":"Filter","title":"PowerSystems.set_lf!","text":"set_lf!(value::RLFilter, val) -> Any\n\n\nSet RLFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_rf!-Tuple{RLFilter, Any}","page":"Filter","title":"PowerSystems.set_rf!","text":"set_rf!(value::RLFilter, val) -> Any\n\n\nSet RLFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"how_to/powersystembuilder/#psb","page":"...load a system from PowerSystemCaseBuilder","title":"Load a system from PowerSystemCaseBuilder","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"Originally Contributed by: Clayton Barrows","category":"page"},{"location":"how_to/powersystembuilder/#Introduction","page":"...load a system from PowerSystemCaseBuilder","title":"Introduction","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"PowerSystemCaseBuilder.jl provides a utility to manage a library of Systems. The package has utilities to list the available system data and to create instances of each system. By keeping track of which systems have been constructed locally, it makes the re-instantiation of systems efficient by utilizing the serialization features and avoiding the parsing process for systems that have been previously constructed.","category":"page"},{"location":"how_to/powersystembuilder/#Dependencies","page":"...load a system from PowerSystemCaseBuilder","title":"Dependencies","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"using PowerSystemCaseBuilder","category":"page"},{"location":"how_to/powersystembuilder/#List-all-systems-in-library","page":"...load a system from PowerSystemCaseBuilder","title":"List all systems in library","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"show_systems()","category":"page"},{"location":"how_to/powersystembuilder/#Systems-can-be-listed-by-category","page":"...load a system from PowerSystemCaseBuilder","title":"Systems can be listed by category","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"The available categories can be displayed with:","category":"page"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"show_categories()","category":"page"},{"location":"how_to/powersystembuilder/#Create-a-System","page":"...load a system from PowerSystemCaseBuilder","title":"Create a System","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"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","category":"page"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"sys = build_system(PSITestSystems, \"c_sys5_uc\")","category":"page"},{"location":"model_library/generated_Machine/#Machine","page":"Machine","title":"Machine","text":"","category":"section"},{"location":"model_library/generated_Machine/#AndersonFouadMachine","page":"Machine","title":"AndersonFouadMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/AndersonFouadMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.AndersonFouadMachine","page":"Machine","title":"PowerSystems.AndersonFouadMachine","text":"mutable struct AndersonFouadMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 6-states synchronous machine: Anderson-Fouad model\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψq: q-axis stator flux,\nψd: d-axis stator flux,\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage,\neq_pp: q-axis subtransient voltage,\ned_pp: d-axis subtransient voltage\n\nn_states::Int: (Do not modify.) The states AndersonFouadMachine has 6 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::AndersonFouadMachine) -> Dict{String, Any}\n\n\nGet AndersonFouadMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::AndersonFouadMachine) -> Int64\n\n\nGet AndersonFouadMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::AndersonFouadMachine) -> Vector{Symbol}\n\n\nGet AndersonFouadMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#BaseMachine","page":"Machine","title":"BaseMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/BaseMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.BaseMachine","page":"Machine","title":"PowerSystems.BaseMachine","text":"mutable struct BaseMachine <: Machine\n R::Float64\n Xd_p::Float64\n eq_p::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Classic Machine: GENCLS in PSSE and PSLF\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd_p::Float64: Reactance after EMF in machine per unit, validation range: (0, nothing)\neq_p::Float64: Fixed EMF behind the impedance, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) BaseMachine has no states\nn_states::Int: (Do not modify.) BaseMachine has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::BaseMachine) -> Float64\n\n\nGet BaseMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::BaseMachine) -> Float64\n\n\nGet BaseMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_eq_p-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_eq_p","text":"get_eq_p(value::BaseMachine) -> Float64\n\n\nGet BaseMachine eq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::BaseMachine) -> Dict{String, Any}\n\n\nGet BaseMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::BaseMachine) -> Int64\n\n\nGet BaseMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::BaseMachine) -> Vector{Symbol}\n\n\nGet BaseMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{BaseMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::BaseMachine, val) -> Any\n\n\nSet BaseMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{BaseMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::BaseMachine, val) -> Any\n\n\nSet BaseMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_eq_p!-Tuple{BaseMachine, Any}","page":"Machine","title":"PowerSystems.set_eq_p!","text":"set_eq_p!(value::BaseMachine, val) -> Any\n\n\nSet BaseMachine eq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{BaseMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::BaseMachine, val) -> Any\n\n\nSet BaseMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#FullMachine","page":"Machine","title":"FullMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/FullMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.FullMachine","page":"Machine","title":"PowerSystems.FullMachine","text":"mutable struct FullMachine <: Machine\n R::Float64\n R_f::Float64\n R_1d::Float64\n R_1q::Float64\n L_d::Float64\n L_q::Float64\n L_ad::Float64\n L_aq::Float64\n L_f1d::Float64\n L_ff::Float64\n L_1d::Float64\n L_1q::Float64\n ext::Dict{String, Any}\n inv_d_fluxlink::Array{Float64,2}\n inv_q_fluxlink::Array{Float64,2}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameter of a full order flux stator-rotor model without zero sequence flux in the stator. The derivative of stator fluxes (ψd and ψq) is NOT neglected. Only one q-axis damping circuit is considered. All parameters 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nR_f::Float64: Field rotor winding resistance in per unit, validation range: (0, nothing)\nR_1d::Float64: Damping rotor winding resistance on d-axis in per unit. This value is denoted as RD in Machowski, validation range: (0, nothing)\nR_1q::Float64: Damping rotor winding resistance on q-axis in per unit. This value is denoted as RQ in Machowski, validation range: (0, nothing)\nL_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)\nL_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)\nL_ad::Float64: Mutual inductance between stator winding and rotor field (and damping) winding inductance on d-axis, in per unit, validation range: (0, nothing)\nL_aq::Float64: Mutual inductance between stator winding and rotor damping winding inductance on q-axis, in per unit, validation range: (0, nothing)\nL_f1d::Float64: Mutual inductance between rotor field winding and rotor damping winding inductance on d-axis, in per unit, validation range: (0, nothing)\nL_ff::Float64: Field rotor winding inductance, in per unit, validation range: (0, nothing)\nL_1d::Float64: Inductance of the d-axis rotor damping circuit, in per unit, validation range: (0, nothing)\nL_1q::Float64: Inductance of the q-axis rotor damping circuit, in per unit, validation range: (0, nothing)\next::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.\ninv_d_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.127, 3.130, 3.131 From Kundur\ninv_q_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.128, 3.132 From Kundur\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψd: d-axis stator flux,\nψq: q-axis stator flux,\nψf: field rotor flux,\nψ1d: d-axis rotor damping flux,\nψ1q: q-axis rotor damping flux\n\nn_states::Int: (Do not modify.) FullMachine has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_1d-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_1d","text":"get_L_1d(value::FullMachine) -> Float64\n\n\nGet FullMachine L_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_1q-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_1q","text":"get_L_1q(value::FullMachine) -> Float64\n\n\nGet FullMachine L_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_ad-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_ad","text":"get_L_ad(value::FullMachine) -> Float64\n\n\nGet FullMachine L_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_aq-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_aq","text":"get_L_aq(value::FullMachine) -> Float64\n\n\nGet FullMachine L_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_d-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_d","text":"get_L_d(value::FullMachine) -> Float64\n\n\nGet FullMachine L_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_f1d-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_f1d","text":"get_L_f1d(value::FullMachine) -> Float64\n\n\nGet FullMachine L_f1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_ff-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_ff","text":"get_L_ff(value::FullMachine) -> Float64\n\n\nGet FullMachine L_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_q-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_q","text":"get_L_q(value::FullMachine) -> Float64\n\n\nGet FullMachine L_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::FullMachine) -> Float64\n\n\nGet FullMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_1d-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_R_1d","text":"get_R_1d(value::FullMachine) -> Float64\n\n\nGet FullMachine R_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_1q-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_R_1q","text":"get_R_1q(value::FullMachine) -> Float64\n\n\nGet FullMachine R_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_f-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_R_f","text":"get_R_f(value::FullMachine) -> Float64\n\n\nGet FullMachine R_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::FullMachine) -> Dict{String, Any}\n\n\nGet FullMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_inv_d_fluxlink-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_inv_d_fluxlink","text":"get_inv_d_fluxlink(value::FullMachine) -> Matrix{Float64}\n\n\nGet FullMachine inv_d_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_inv_q_fluxlink-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_inv_q_fluxlink","text":"get_inv_q_fluxlink(value::FullMachine) -> Matrix{Float64}\n\n\nGet FullMachine inv_q_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::FullMachine) -> Int64\n\n\nGet FullMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::FullMachine) -> Vector{Symbol}\n\n\nGet FullMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_1d!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_1d!","text":"set_L_1d!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_1q!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_1q!","text":"set_L_1q!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_ad!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_ad!","text":"set_L_ad!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_aq!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_aq!","text":"set_L_aq!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_d!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_d!","text":"set_L_d!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_f1d!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_f1d!","text":"set_L_f1d!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_f1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_ff!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_ff!","text":"set_L_ff!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_q!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_q!","text":"set_L_q!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::FullMachine, val) -> Any\n\n\nSet FullMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_1d!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_1d!","text":"set_R_1d!(value::FullMachine, val) -> Any\n\n\nSet FullMachine R_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_1q!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_1q!","text":"set_R_1q!(value::FullMachine, val) -> Any\n\n\nSet FullMachine R_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_f!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_f!","text":"set_R_f!(value::FullMachine, val) -> Any\n\n\nSet FullMachine R_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::FullMachine, val) -> Any\n\n\nSet FullMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_inv_d_fluxlink!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_inv_d_fluxlink!","text":"set_inv_d_fluxlink!(value::FullMachine, val) -> Any\n\n\nSet FullMachine inv_d_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_inv_q_fluxlink!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_inv_q_fluxlink!","text":"set_inv_q_fluxlink!(value::FullMachine, val) -> Any\n\n\nSet FullMachine inv_q_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#MarconatoMachine","page":"Machine","title":"MarconatoMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/MarconatoMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.MarconatoMachine","page":"Machine","title":"PowerSystems.MarconatoMachine","text":"mutable struct MarconatoMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n T_AA::Float64\n ext::Dict{String, Any}\n γd::Float64\n γq::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 6-states synchronous machine: Marconato model\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\nT_AA::Float64: Time constant of d-axis additional leakage, validation range: (0, nothing)\next::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.\nγd::Float64: (Do not modify.) Internal equation\nγq::Float64: (Do not modify.) Internal equation\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψq: q-axis stator flux,\nψd: d-axis stator flux,\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage,\neq_pp: q-axis subtransient voltage,\ned_pp: d-axis subtransient voltage\n\nn_states::Int: (Do not modify.) MarconatoMachine has 6 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_T_AA-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_T_AA","text":"get_T_AA(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine T_AA.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::MarconatoMachine) -> Dict{String, Any}\n\n\nGet MarconatoMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::MarconatoMachine) -> Int64\n\n\nGet MarconatoMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::MarconatoMachine) -> Vector{Symbol}\n\n\nGet MarconatoMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γd-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_γd","text":"get_γd(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine γd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γq-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_γq","text":"get_γq(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine γq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_T_AA!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_T_AA!","text":"set_T_AA!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine T_AA.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γd!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_γd!","text":"set_γd!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine γd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γq!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_γq!","text":"set_γq!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine γq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#OneDOneQMachine","page":"Machine","title":"OneDOneQMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/OneDOneQMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.OneDOneQMachine","page":"Machine","title":"PowerSystems.OneDOneQMachine","text":"mutable struct OneDOneQMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Td0_p::Float64\n Tq0_p::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage\n\nn_states::Int: (Do not modify.) OneDOneQMachine has 2 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::OneDOneQMachine) -> Dict{String, Any}\n\n\nGet OneDOneQMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::OneDOneQMachine) -> Int64\n\n\nGet OneDOneQMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::OneDOneQMachine) -> Vector{Symbol}\n\n\nGet OneDOneQMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#RoundRotorExponential","page":"Machine","title":"RoundRotorExponential","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/RoundRotorExponential.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.RoundRotorExponential","page":"Machine","title":"PowerSystems.RoundRotorExponential","text":"mutable struct RoundRotorExponential <: Machine\n base_machine::RoundRotorMachine\n saturation_coeffs::Tuple{Float64, Float64}\n\n4-states round-rotor synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROE model in PSSE and PSLF.\n\nArguments\n\nbase_machine::RoundRotorMachine: Round Rotor Machine model.\nsaturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for exponential model.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#RoundRotorMachine","page":"Machine","title":"RoundRotorMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/RoundRotorMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.RoundRotorMachine","page":"Machine","title":"PowerSystems.RoundRotorMachine","text":"mutable struct RoundRotorMachine <: Machine\n R::Float64\n Td0_p::Float64\n Td0_pp::Float64\n Tq0_p::Float64\n Tq0_pp::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xl::Float64\n Se::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n γ_d1::Float64\n γ_q1::Float64\n γ_d2::Float64\n γ_q2::Float64\n γ_qd::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Armature resistance, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit. Note: Xdpp = Xqpp, validation range: (0, nothing)\nXl::Float64: Stator leakage reactance, validation range: (0, nothing)\nSe::Tuple{Float64, Float64}: Saturation factor at 1 and 1.2 pu flux: S(1.0) = B(|ψ_pp|-A)^2\next::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.\nγ_d1::Float64: (Do not modify.) γ_d1 parameter\nγ_q1::Float64: (Do not modify.) γ_q1 parameter\nγ_d2::Float64: (Do not modify.) γ_d2 parameter\nγ_q2::Float64: (Do not modify.) γ_q2 parameter\nγ_qd::Float64: (Do not modify.) γ_qd parameter\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis generator voltage behind the transient reactance,\ned_p: d-axis generator voltage behind the transient reactance,\nψ_kd: flux linkage in the first equivalent damping circuit in the d-axis,\nψ_kq: flux linkage in the first equivalent damping circuit in the d-axis\n\nn_states::Int: (Do not modify.) RoundRotorMachine has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Se-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Se","text":"get_Se(value::RoundRotorMachine) -> Tuple{Float64, Float64}\n\n\nGet RoundRotorMachine Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xl-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xl","text":"get_Xl(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::RoundRotorMachine) -> Dict{String, Any}\n\n\nGet RoundRotorMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::RoundRotorMachine) -> Int64\n\n\nGet RoundRotorMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::RoundRotorMachine) -> Vector{Symbol}\n\n\nGet RoundRotorMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d1-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_d1","text":"get_γ_d1(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d2-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_d2","text":"get_γ_d2(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q1-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_q1","text":"get_γ_q1(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q2-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_q2","text":"get_γ_q2(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_q2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_qd-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_qd","text":"get_γ_qd(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_qd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Se!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Se!","text":"set_Se!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xl!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xl!","text":"set_Xl!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d1!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d1!","text":"set_γ_d1!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d2!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d2!","text":"set_γ_d2!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q1!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q1!","text":"set_γ_q1!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q2!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q2!","text":"set_γ_q2!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_q2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_qd!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_qd!","text":"set_γ_qd!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_qd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#RoundRotorQuadratic","page":"Machine","title":"RoundRotorQuadratic","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/RoundRotorQuadratic.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.RoundRotorQuadratic","page":"Machine","title":"PowerSystems.RoundRotorQuadratic","text":"mutable struct RoundRotorQuadratic <: Machine\n base_machine::RoundRotorMachine\n saturation_coeffs::Tuple{Float64, Float64}\n\n4-states round-rotor synchronous machine with quadratic saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROU model in PSSE and PSLF.\n\nArguments\n\nbase_machine::RoundRotorMachine: Round Rotor Machine model.\nsaturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for quadratic model.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#SalientPoleExponential","page":"Machine","title":"SalientPoleExponential","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SalientPoleExponential.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SalientPoleExponential","page":"Machine","title":"PowerSystems.SalientPoleExponential","text":"mutable struct SalientPoleExponential <: Machine\n base_machine::SalientPoleMachine\n saturation_coeffs::Tuple{Float64, Float64}\n\n3-states salient-pole synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.1). GENSAE in PSSE and PSLF.\n\nArguments:\n\nbase_machine::SalientPoleMachine: Salient Pole Machine model.\nsaturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for exponential model.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#SalientPoleMachine","page":"Machine","title":"SalientPoleMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SalientPoleMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SalientPoleMachine","page":"Machine","title":"PowerSystems.SalientPoleMachine","text":"mutable struct SalientPoleMachine <: Machine\n R::Float64\n Td0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xd_pp::Float64\n Xl::Float64\n Se::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n γ_d1::Float64\n γ_q1::Float64\n γ_d2::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Armature resistance, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit. Note: Xdpp = Xqpp, validation range: (0, nothing)\nXl::Float64: Stator leakage reactance, validation range: (0, nothing)\nSe::Tuple{Float64, Float64}: Saturation factor at 1 and 1.2 pu flux: Se(eqp) = B(eqp-A)^2\next::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.\nγ_d1::Float64: (Do not modify.) γ_d1 parameter\nγ_q1::Float64: (Do not modify.) γ_q1 parameter\nγ_d2::Float64: (Do not modify.) γ_d2 parameter\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis generator voltage behind the transient reactance,\nψ_kd: flux linkage in the first equivalent damping circuit in the d-axis,\nψq_pp: phasonf of the subtransient flux linkage in the q-axis\n\nn_states::Int: (Do not modify.) SalientPoleMachine has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Se-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Se","text":"get_Se(value::SalientPoleMachine) -> Tuple{Float64, Float64}\n\n\nGet SalientPoleMachine Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xl-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xl","text":"get_Xl(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SalientPoleMachine) -> Dict{String, Any}\n\n\nGet SalientPoleMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SalientPoleMachine) -> Int64\n\n\nGet SalientPoleMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SalientPoleMachine) -> Vector{Symbol}\n\n\nGet SalientPoleMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d1-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_γ_d1","text":"get_γ_d1(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d2-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_γ_d2","text":"get_γ_d2(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q1-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_γ_q1","text":"get_γ_q1(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Se!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Se!","text":"set_Se!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xl!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xl!","text":"set_Xl!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d1!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d1!","text":"set_γ_d1!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d2!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d2!","text":"set_γ_d2!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q1!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q1!","text":"set_γ_q1!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#SalientPoleQuadratic","page":"Machine","title":"SalientPoleQuadratic","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SalientPoleQuadratic.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SalientPoleQuadratic","page":"Machine","title":"PowerSystems.SalientPoleQuadratic","text":"mutable struct SalientPoleQuadratic <: Machine\n base_machine::SalientPoleMachine\n saturation_coeffs::Tuple{Float64, Float64}\n\n3-states salient-pole synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.1). GENSAL in PSSE and PSLF.\n\nArguments:\n\nbase_machine::SalientPoleMachine: Salient Pole Machine model.\nsaturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for quadratic model.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#SauerPaiMachine","page":"Machine","title":"SauerPaiMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SauerPaiMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SauerPaiMachine","page":"Machine","title":"PowerSystems.SauerPaiMachine","text":"mutable struct SauerPaiMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Xl::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n ext::Dict{String, Any}\n γ_d1::Float64\n γ_q1::Float64\n γ_d2::Float64\n γ_q2::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of synchronous machine: Sauer Pai model\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXl::Float64: Stator Leakage Reactance, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\next::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.\nγ_d1::Float64: (Do not modify.) Internal equation\nγ_q1::Float64: (Do not modify.) Internal equation\nγ_d2::Float64: (Do not modify.) Internal equation\nγ_q2::Float64: (Do not modify.) Internal equation\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψq: q-axis stator flux,\nψd: d-axis stator flux,\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage\nψd_pp: subtransient flux linkage in the d-axis\nψq_pp: subtransient flux linkage in the q-axis\n\nn_states::Int: (Do not modify.) SauerPaiMachine has 6 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xl-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xl","text":"get_Xl(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SauerPaiMachine) -> Dict{String, Any}\n\n\nGet SauerPaiMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SauerPaiMachine) -> Int64\n\n\nGet SauerPaiMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SauerPaiMachine) -> Vector{Symbol}\n\n\nGet SauerPaiMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d1-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_γ_d1","text":"get_γ_d1(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d2-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_γ_d2","text":"get_γ_d2(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q1-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_γ_q1","text":"get_γ_q1(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q2-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_γ_q2","text":"get_γ_q2(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine γ_q2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xl!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xl!","text":"set_Xl!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d1!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d1!","text":"set_γ_d1!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d2!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d2!","text":"set_γ_d2!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q1!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q1!","text":"set_γ_q1!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q2!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q2!","text":"set_γ_q2!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine γ_q2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#SimpleAFMachine","page":"Machine","title":"SimpleAFMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SimpleAFMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SimpleAFMachine","page":"Machine","title":"PowerSystems.SimpleAFMachine","text":"mutable struct SimpleAFMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage,\neq_pp: q-axis subtransient voltage,\ned_pp: d-axis subtransient voltage\n\nn_states::Int: (Do not modify.) SimpleAFMachine has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SimpleAFMachine) -> Dict{String, Any}\n\n\nGet SimpleAFMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SimpleAFMachine) -> Int64\n\n\nGet SimpleAFMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SimpleAFMachine) -> Vector{Symbol}\n\n\nGet SimpleAFMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#SimpleFullMachine","page":"Machine","title":"SimpleFullMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SimpleFullMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SimpleFullMachine","page":"Machine","title":"PowerSystems.SimpleFullMachine","text":"mutable struct SimpleFullMachine <: Machine\n R::Float64\n R_f::Float64\n R_1d::Float64\n R_1q::Float64\n L_d::Float64\n L_q::Float64\n L_ad::Float64\n L_aq::Float64\n L_f1d::Float64\n L_ff::Float64\n L_1d::Float64\n L_1q::Float64\n ext::Dict{String, Any}\n inv_d_fluxlink::Array{Float64,2}\n inv_q_fluxlink::Array{Float64,2}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameter 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nR_f::Float64: Field rotor winding resistance in per unit, validation range: (0, nothing)\nR_1d::Float64: Damping rotor winding resistance on d-axis in per unit. This value is denoted as RD in Machowski, validation range: (0, nothing)\nR_1q::Float64: Damping rotor winding resistance on q-axis in per unit. This value is denoted as RQ in Machowski, validation range: (0, nothing)\nL_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)\nL_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)\nL_ad::Float64: Mutual inductance between stator winding and rotor field (and damping) winding inductance on d-axis, in per unit, validation range: (0, nothing)\nL_aq::Float64: Mutual inductance between stator winding and rotor damping winding inductance on q-axis, in per unit, validation range: (0, nothing)\nL_f1d::Float64: Mutual inductance between rotor field winding and rotor damping winding inductance on d-axis, in per unit, validation range: (0, nothing)\nL_ff::Float64: Field rotor winding inductance, in per unit, validation range: (0, nothing)\nL_1d::Float64: Inductance of the d-axis rotor damping circuit, in per unit, validation range: (0, nothing)\nL_1q::Float64: Inductance of the q-axis rotor damping circuit, in per unit, validation range: (0, nothing)\next::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.\ninv_d_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.127, 3.130, 3.131 From Kundur\ninv_q_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.128, 3.132 From Kundur\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψf: field rotor flux,\nψ1d: d-axis rotor damping flux,\nψ1q: q-axis rotor damping flux\n\nn_states::Int: (Do not modify.) SimpleFullMachine has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_1d-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_1d","text":"get_L_1d(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_1q-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_1q","text":"get_L_1q(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_ad-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_ad","text":"get_L_ad(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_aq-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_aq","text":"get_L_aq(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_d-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_d","text":"get_L_d(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_f1d-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_f1d","text":"get_L_f1d(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_f1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_ff-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_ff","text":"get_L_ff(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_q-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_q","text":"get_L_q(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_1d-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_R_1d","text":"get_R_1d(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine R_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_1q-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_R_1q","text":"get_R_1q(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine R_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_f-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_R_f","text":"get_R_f(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine R_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SimpleFullMachine) -> Dict{String, Any}\n\n\nGet SimpleFullMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_inv_d_fluxlink-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_inv_d_fluxlink","text":"get_inv_d_fluxlink(\n value::SimpleFullMachine\n) -> Matrix{Float64}\n\n\nGet SimpleFullMachine inv_d_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_inv_q_fluxlink-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_inv_q_fluxlink","text":"get_inv_q_fluxlink(\n value::SimpleFullMachine\n) -> Matrix{Float64}\n\n\nGet SimpleFullMachine inv_q_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SimpleFullMachine) -> Int64\n\n\nGet SimpleFullMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SimpleFullMachine) -> Vector{Symbol}\n\n\nGet SimpleFullMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_1d!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_1d!","text":"set_L_1d!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_1q!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_1q!","text":"set_L_1q!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_ad!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_ad!","text":"set_L_ad!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_aq!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_aq!","text":"set_L_aq!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_d!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_d!","text":"set_L_d!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_f1d!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_f1d!","text":"set_L_f1d!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_f1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_ff!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_ff!","text":"set_L_ff!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_q!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_q!","text":"set_L_q!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_1d!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_1d!","text":"set_R_1d!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine R_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_1q!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_1q!","text":"set_R_1q!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine R_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_f!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_f!","text":"set_R_f!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine R_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_inv_d_fluxlink!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_inv_d_fluxlink!","text":"set_inv_d_fluxlink!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine inv_d_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_inv_q_fluxlink!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_inv_q_fluxlink!","text":"set_inv_q_fluxlink!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine inv_q_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#SimpleMarconatoMachine","page":"Machine","title":"SimpleMarconatoMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SimpleMarconatoMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SimpleMarconatoMachine","page":"Machine","title":"PowerSystems.SimpleMarconatoMachine","text":"mutable struct SimpleMarconatoMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n T_AA::Float64\n ext::Dict{String, Any}\n γd::Float64\n γq::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\nT_AA::Float64: Time constant of d-axis additional leakage, validation range: (0, nothing)\next::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.\nγd::Float64: (Do not modify.) Internal equation\nγq::Float64: (Do not modify.) Internal equation\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage,\neq_pp: q-axis subtransient voltage,\ned_pp: d-axis subtransient voltage\n\nn_states::Int: (Do not modify.) SimpleMarconatoMachine has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_T_AA-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_T_AA","text":"get_T_AA(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine T_AA.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SimpleMarconatoMachine) -> Dict{String, Any}\n\n\nGet SimpleMarconatoMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SimpleMarconatoMachine) -> Int64\n\n\nGet SimpleMarconatoMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SimpleMarconatoMachine) -> Vector{Symbol}\n\n\nGet SimpleMarconatoMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γd-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_γd","text":"get_γd(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine γd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γq-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_γq","text":"get_γq(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine γq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_T_AA!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_T_AA!","text":"set_T_AA!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine T_AA.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γd!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_γd!","text":"set_γd!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine γd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γq!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_γq!","text":"set_γq!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine γq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hydro_generation_cost/#HydroGenerationCost","page":"HydroGenerationCost","title":"HydroGenerationCost","text":"","category":"section"},{"location":"model_library/hydro_generation_cost/","page":"HydroGenerationCost","title":"HydroGenerationCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/HydroGenerationCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/hydro_generation_cost/#PowerSystems.HydroGenerationCost","page":"HydroGenerationCost","title":"PowerSystems.HydroGenerationCost","text":"mutable struct HydroGenerationCost <: OperationalCost\n\nvariable::ProductionVariableCostCurve: Production variable cost represented by a FuelCurve, where the fuel is water, or a CostCurve in currency.\nfixed::Float64: (default: 0) Fixed cost of keeping the unit online. For some cost represenations this field can be duplicative\n\nHydroGenerationCost(variable, fixed)\nHydroGenerationCost(; variable, fixed)\n\nAn 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. \n\nThe variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.\n\n\n\n\n\n","category":"type"},{"location":"model_library/hydro_generation_cost/#PowerSystems.get_fixed-Tuple{HydroGenerationCost}","page":"HydroGenerationCost","title":"PowerSystems.get_fixed","text":"get_fixed(value::HydroGenerationCost) -> Float64\n\n\nGet HydroGenerationCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hydro_generation_cost/#PowerSystems.get_variable-Tuple{HydroGenerationCost}","page":"HydroGenerationCost","title":"PowerSystems.get_variable","text":"get_variable(\n value::HydroGenerationCost\n) -> ProductionVariableCostCurve\n\n\nGet HydroGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hydro_generation_cost/#PowerSystems.set_fixed!-Tuple{HydroGenerationCost, Any}","page":"HydroGenerationCost","title":"PowerSystems.set_fixed!","text":"set_fixed!(value::HydroGenerationCost, val) -> Any\n\n\nSet HydroGenerationCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hydro_generation_cost/#PowerSystems.set_variable!-Tuple{HydroGenerationCost, Any}","page":"HydroGenerationCost","title":"PowerSystems.set_variable!","text":"set_variable!(value::HydroGenerationCost, val) -> Any\n\n\nSet HydroGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"explanation/type_structure/#type_structure","page":"Type Structure","title":"Type Structure","text":"","category":"section"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"PowerSystems.jl provides a type hierarchy to contain power system data.","category":"page"},{"location":"explanation/type_structure/#Types-in-PowerSystems","page":"Type Structure","title":"Types in PowerSystems","text":"","category":"section"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"In PowerSystems.jl, data that describes infrastructure components is held in structs. For example, an ACBus is a struct with the following parameters to describe a bus on an AC network:","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"using PowerSystems #hide\nimport TypeTree: tt #hide\ndocs_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"utils\"); #hide\ninclude(joinpath(docs_dir, \"docs_utils.jl\")); #hide\nprint_struct(ACBus) #hide","category":"page"},{"location":"explanation/type_structure/#Type-Hierarchy","page":"Type Structure","title":"Type Hierarchy","text":"","category":"section"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"PowerSystems is intended to organize data by the behavior of the devices that the data represents. A type hierarchy has been defined with several levels of abstract types starting with InfrastructureSystemsType. There are a bunch of subtypes of InfrastructureSystemsType, but the important ones to know about are:","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"System: overarching struct that collects all of the Components\nComponent: includes all elements of power system data\nTopology: includes non physical elements describing network connectivity\nService: includes descriptions of system requirements (other than energy balance)\nDevice: includes descriptions of all the physical devices in a power system\nInfrastructureSystems.DeviceParameter: includes structs that hold data describing the dynamic, or economic capabilities of Device.\nTimeSeriesData: Includes all time series types\nForecast: includes structs to define time series of forecasted data where multiple values can represent each time stamp\nStaticTimeSeries: includes structs to define time series with a single value for each time stamp","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"The abstract hierarchy enables categorization of the devices by their operational characteristics and modeling requirements.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"For instance, generation is classified by the distinctive data requirements for modeling in three categories: ThermalGen, RenewableGen, and HydroGen.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"PowerSystems.jl has a category Topology of topological components (e.g., ACBus, Arc), separate from the physical components.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"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.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"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.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"⠀ ```","category":"page"},{"location":"model_library/generated_ConstantReserveNonSpinning/#ConstantReserveNonSpinning","page":"ConstantReserveNonSpinning","title":"ConstantReserveNonSpinning","text":"","category":"section"},{"location":"model_library/generated_ConstantReserveNonSpinning/","page":"ConstantReserveNonSpinning","title":"ConstantReserveNonSpinning","text":"Modules = [PowerSystems]\nPages = [\"generated/ConstantReserveNonSpinning.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.ConstantReserveNonSpinning","page":"ConstantReserveNonSpinning","title":"PowerSystems.ConstantReserveNonSpinning","text":"mutable struct ConstantReserveNonSpinning <: ReserveNonSpinning\n name::String\n available::Bool\n time_frame::Float64\n requirement::Float64\n sustained_time::Float64\n max_output_fraction::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA non-spinning reserve product with a constant procurement requirement, such as 3% of the system base power at all times.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time frame in minutes that a participating device must provide its reserve contribution, validation range: (0, nothing)\nrequirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)\nsustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ConstantReserveNonSpinning/#InfrastructureSystems.get_name-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"InfrastructureSystems.get_name","text":"get_name(value::ConstantReserveNonSpinning) -> String\n\n\nGet ConstantReserveNonSpinning name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_available-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_available","text":"get_available(value::ConstantReserveNonSpinning) -> Bool\n\n\nGet ConstantReserveNonSpinning available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_deployed_fraction-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(\n value::ConstantReserveNonSpinning\n) -> Float64\n\n\nGet ConstantReserveNonSpinning deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_ext-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_ext","text":"get_ext(\n value::ConstantReserveNonSpinning\n) -> Dict{String, Any}\n\n\nGet ConstantReserveNonSpinning ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_max_output_fraction-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_max_output_fraction","text":"get_max_output_fraction(\n value::ConstantReserveNonSpinning\n) -> Float64\n\n\nGet ConstantReserveNonSpinning max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_max_participation_factor-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::ConstantReserveNonSpinning\n) -> Float64\n\n\nGet ConstantReserveNonSpinning max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_requirement-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_requirement","text":"get_requirement(value::ConstantReserveNonSpinning) -> Any\n\n\nGet ConstantReserveNonSpinning requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_sustained_time-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(\n value::ConstantReserveNonSpinning\n) -> Float64\n\n\nGet ConstantReserveNonSpinning sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_time_frame-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::ConstantReserveNonSpinning) -> Float64\n\n\nGet ConstantReserveNonSpinning time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_available!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_available!","text":"set_available!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_deployed_fraction!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_ext!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_ext!","text":"set_ext!(value::ConstantReserveNonSpinning, val) -> Any\n\n\nSet ConstantReserveNonSpinning ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_max_output_fraction!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_max_output_fraction!","text":"set_max_output_fraction!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_max_participation_factor!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_requirement!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_requirement!","text":"set_requirement!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_sustained_time!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_time_frame!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSS","page":"PSS","title":"PSS","text":"","category":"section"},{"location":"model_library/generated_PSS/#IEEEST","page":"PSS","title":"IEEEST","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/IEEEST.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.IEEEST","page":"PSS","title":"PowerSystems.IEEEST","text":"mutable struct IEEEST <: PSS\n input_code::Int\n remote_bus_control::Int\n A1::Float64\n A2::Float64\n A3::Float64\n A4::Float64\n A5::Float64\n A6::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n T5::Float64\n T6::Float64\n Ks::Float64\n Ls_lim::Tuple{Float64, Float64}\n Vcu::Float64\n Vcl::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Stabilizing Model PSS. \n\nArguments\n\ninput_code::Int: Code input for stabilizer, validation range: (1, 6)\nremote_bus_control::Int: ACBus identification number for control. 0 identifies the bus connected to this component\nA1::Float64: Filter coefficient, validation range: (0, nothing)\nA2::Float64: Filter coefficient, validation range: (0, nothing)\nA3::Float64: Filter coefficient, validation range: (0, nothing)\nA4::Float64: Filter coefficient, validation range: (0, nothing)\nA5::Float64: Filter coefficient, validation range: (0, nothing)\nA6::Float64: Filter coefficient, validation range: (0, nothing)\nT1::Float64: Time constant, validation range: (0, 10)\nT2::Float64: Time constant, validation range: (0, 10)\nT3::Float64: Time constant, validation range: (0, 10)\nT4::Float64: Time constant, validation range: (0, 10)\nT5::Float64: Time constant, validation range: (0, 10)\nT6::Float64: Time constant, validation range: (eps(), 2.0)\nKs::Float64: Proportional gain, validation range: (0, nothing)\nLs_lim::Tuple{Float64, Float64}: PSS output limits for regulator output (Ls_min, Ls_max)\nVcu::Float64: Cutoff limiter upper bound, validation range: (0, 1.25)\nVcl::Float64: Cutoff limiter lower bound, validation range: (0, 1.0)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: 1st filter integration,\nx_p2: 2nd filter integration, \nx_p3: 3rd filter integration, \nx_p4: 4rd filter integration, \nx_p5: T1/T2 lead-lag integrator, \nx_p6: T3/T4 lead-lag integrator, \n:x_p7 last integer,\n\nn_states::Int: (Do not modify.) IEEEST has 7 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEST has 7 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_A1-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A1","text":"get_A1(value::IEEEST) -> Float64\n\n\nGet IEEEST A1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A2-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A2","text":"get_A2(value::IEEEST) -> Float64\n\n\nGet IEEEST A2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A3-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A3","text":"get_A3(value::IEEEST) -> Float64\n\n\nGet IEEEST A3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A4-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A4","text":"get_A4(value::IEEEST) -> Float64\n\n\nGet IEEEST A4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A5-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A5","text":"get_A5(value::IEEEST) -> Float64\n\n\nGet IEEEST A5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A6-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A6","text":"get_A6(value::IEEEST) -> Float64\n\n\nGet IEEEST A6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_Ks","text":"get_Ks(value::IEEEST) -> Float64\n\n\nGet IEEEST Ks.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ls_lim-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_Ls_lim","text":"get_Ls_lim(value::IEEEST) -> Tuple{Float64, Float64}\n\n\nGet IEEEST Ls_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T1","text":"get_T1(value::IEEEST) -> Float64\n\n\nGet IEEEST T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T2","text":"get_T2(value::IEEEST) -> Float64\n\n\nGet IEEEST T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::IEEEST) -> Float64\n\n\nGet IEEEST T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::IEEEST) -> Float64\n\n\nGet IEEEST T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T5-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T5","text":"get_T5(value::IEEEST) -> Float64\n\n\nGet IEEEST T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T6-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T6","text":"get_T6(value::IEEEST) -> Float64\n\n\nGet IEEEST T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vcl-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_Vcl","text":"get_Vcl(value::IEEEST) -> Float64\n\n\nGet IEEEST Vcl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vcu-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_Vcu","text":"get_Vcu(value::IEEEST) -> Float64\n\n\nGet IEEEST Vcu.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::IEEEST) -> Dict{String, Any}\n\n\nGet IEEEST ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_input_code","text":"get_input_code(value::IEEEST) -> Int64\n\n\nGet IEEEST input_code.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::IEEEST) -> Int64\n\n\nGet IEEEST n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_remote_bus_control","text":"get_remote_bus_control(value::IEEEST) -> Int64\n\n\nGet IEEEST remote_bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::IEEEST) -> Vector{Symbol}\n\n\nGet IEEEST states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::IEEEST) -> Vector{StateTypes}\n\n\nGet IEEEST states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A1!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A1!","text":"set_A1!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A2!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A2!","text":"set_A2!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A3!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A3!","text":"set_A3!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A4!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A4!","text":"set_A4!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A5!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A5!","text":"set_A5!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A6!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A6!","text":"set_A6!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_Ks!","text":"set_Ks!(value::IEEEST, val) -> Any\n\n\nSet IEEEST Ks.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ls_lim!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_Ls_lim!","text":"set_Ls_lim!(value::IEEEST, val) -> Any\n\n\nSet IEEEST Ls_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T1!","text":"set_T1!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T2!","text":"set_T2!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T5!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T5!","text":"set_T5!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T6!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T6!","text":"set_T6!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vcl!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_Vcl!","text":"set_Vcl!(value::IEEEST, val) -> Any\n\n\nSet IEEEST Vcl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vcu!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_Vcu!","text":"set_Vcu!(value::IEEEST, val) -> Any\n\n\nSet IEEEST Vcu.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::IEEEST, val) -> Any\n\n\nSet IEEEST ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_input_code!","text":"set_input_code!(value::IEEEST, val) -> Any\n\n\nSet IEEEST input_code.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control!","text":"set_remote_bus_control!(value::IEEEST, val) -> Any\n\n\nSet IEEEST remote_bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::IEEEST, val) -> Any\n\n\nSet IEEEST states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSS2A","page":"PSS","title":"PSS2A","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSS2A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSS2A","page":"PSS","title":"PowerSystems.PSS2A","text":"mutable struct PSS2A <: PSS\n input_code_1::Int\n remote_bus_control_1::Int\n input_code_2::Int\n remote_bus_control_2::Int\n M_rtf::Int\n N_rtf::Int\n Tw1::Float64\n Tw2::Float64\n T6::Float64\n Tw3::Float64\n Tw4::Float64\n T7::Float64\n Ks2::Float64\n Ks3::Float64\n T8::Float64\n T9::Float64\n Ks1::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n Vst_lim::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Dual-Input Stabilizer Model\n\nArguments\n\ninput_code_1::Int: First Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_1::Int: First Input remote bus identification number for control. 0 identifies the local bus connected to this component\ninput_code_2::Int: Second Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_2::Int: Second Input remote bus identification number for control. 0 identifies the local bus connected to this component\nM_rtf::Int: M parameter for ramp tracking filter, validation range: (0, 8)\nN_rtf::Int: N parameter for ramp tracking filter, validation range: (0, 8)\nTw1::Float64: Time constant for first washout filter for first input, validation range: (eps(), nothing)\nTw2::Float64: Time constant for second washout filter for first input, validation range: (0, nothing)\nT6::Float64: Time constant for low-pass filter for first input, validation range: (0, nothing)\nTw3::Float64: Time constant for first washout filter for second input, validation range: (eps(), nothing)\nTw4::Float64: Time constant for second washout filter for second input, validation range: (0, nothing)\nT7::Float64: Time constant for low-pass filter for second input, validation range: (0, nothing)\nKs2::Float64: Gain for low-pass filter for second input, validation range: (0, nothing)\nKs3::Float64: Gain for second input, validation range: (0, nothing)\nT8::Float64: Time constant for ramp tracking filter, validation range: (0, nothing)\nT9::Float64: Time constant for ramp tracking filter, validation range: (eps(), nothing)\nKs1::Float64: Gain before lead-lag blocks, validation range: (0, nothing)\nT1::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT2::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT3::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT4::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nVst_lim::Tuple{Float64, Float64}: PSS output limits (Vst_min, Vst_max)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: 1st washout 1st input, \nx_p2: 2nd washout 1st input, \nx_p3: transducer 1st input, \nx_p4: 1st washout 2nd input, \nx_p5: 2nd washout 2nd input, \nx_p6: transducer 2nd input, \nx_p7: ramp tracking filter state 1, \nx_p8: ramp tracking filter state 2, \nx_p9: ramp tracking filter state 3, \nx_p10: ramp tracking filter state 4, \nx_p11: ramp tracking filter state 5, \nx_p12: ramp tracking filter state 6, \nx_p13: ramp tracking filter state 7, \nx_p14: ramp tracking filter state 8, \nx_p15: 1st lead-lag, \nx_p16: 2nd lead-lag,\n\nn_states::Int: (Do not modify.) IEEEST has 16 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEST has 16 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Ks1","text":"get_Ks1(value::PSS2A) -> Float64\n\n\nGet PSS2A Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Ks2","text":"get_Ks2(value::PSS2A) -> Float64\n\n\nGet PSS2A Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks3-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Ks3","text":"get_Ks3(value::PSS2A) -> Float64\n\n\nGet PSS2A Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_M_rtf-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_M_rtf","text":"get_M_rtf(value::PSS2A) -> Int64\n\n\nGet PSS2A M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_N_rtf-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_N_rtf","text":"get_N_rtf(value::PSS2A) -> Int64\n\n\nGet PSS2A N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T1","text":"get_T1(value::PSS2A) -> Float64\n\n\nGet PSS2A T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T2","text":"get_T2(value::PSS2A) -> Float64\n\n\nGet PSS2A T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::PSS2A) -> Float64\n\n\nGet PSS2A T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::PSS2A) -> Float64\n\n\nGet PSS2A T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T6-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T6","text":"get_T6(value::PSS2A) -> Float64\n\n\nGet PSS2A T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T7-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T7","text":"get_T7(value::PSS2A) -> Float64\n\n\nGet PSS2A T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T8-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T8","text":"get_T8(value::PSS2A) -> Float64\n\n\nGet PSS2A T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T9-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T9","text":"get_T9(value::PSS2A) -> Float64\n\n\nGet PSS2A T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Tw1","text":"get_Tw1(value::PSS2A) -> Float64\n\n\nGet PSS2A Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Tw2","text":"get_Tw2(value::PSS2A) -> Float64\n\n\nGet PSS2A Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw3-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Tw3","text":"get_Tw3(value::PSS2A) -> Float64\n\n\nGet PSS2A Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw4-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Tw4","text":"get_Tw4(value::PSS2A) -> Float64\n\n\nGet PSS2A Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vst_lim-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Vst_lim","text":"get_Vst_lim(value::PSS2A) -> Tuple{Float64, Float64}\n\n\nGet PSS2A Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSS2A) -> Dict{String, Any}\n\n\nGet PSS2A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_input_code_1","text":"get_input_code_1(value::PSS2A) -> Int64\n\n\nGet PSS2A input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_input_code_2","text":"get_input_code_2(value::PSS2A) -> Int64\n\n\nGet PSS2A input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSS2A) -> Int64\n\n\nGet PSS2A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_remote_bus_control_1","text":"get_remote_bus_control_1(value::PSS2A) -> Int64\n\n\nGet PSS2A remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_remote_bus_control_2","text":"get_remote_bus_control_2(value::PSS2A) -> Int64\n\n\nGet PSS2A remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSS2A) -> Vector{Symbol}\n\n\nGet PSS2A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::PSS2A) -> Vector{StateTypes}\n\n\nGet PSS2A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Ks1!","text":"set_Ks1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Ks2!","text":"set_Ks2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks3!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Ks3!","text":"set_Ks3!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_M_rtf!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_M_rtf!","text":"set_M_rtf!(value::PSS2A, val) -> Any\n\n\nSet PSS2A M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_N_rtf!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_N_rtf!","text":"set_N_rtf!(value::PSS2A, val) -> Any\n\n\nSet PSS2A N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T1!","text":"set_T1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T2!","text":"set_T2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T6!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T6!","text":"set_T6!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T7!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T7!","text":"set_T7!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T8!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T8!","text":"set_T8!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T9!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T9!","text":"set_T9!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Tw1!","text":"set_Tw1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Tw2!","text":"set_Tw2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw3!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Tw3!","text":"set_Tw3!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw4!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Tw4!","text":"set_Tw4!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vst_lim!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Vst_lim!","text":"set_Vst_lim!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSS2A, val) -> Any\n\n\nSet PSS2A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_input_code_1!","text":"set_input_code_1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_input_code_2!","text":"set_input_code_2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_1!","text":"set_remote_bus_control_1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_2!","text":"set_remote_bus_control_2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::PSS2A, val) -> Any\n\n\nSet PSS2A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSS2B","page":"PSS","title":"PSS2B","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSS2B.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSS2B","page":"PSS","title":"PowerSystems.PSS2B","text":"mutable struct PSS2B <: PSS\n input_code_1::Int\n remote_bus_control_1::Int\n input_code_2::Int\n remote_bus_control_2::Int\n M_rtf::Int\n N_rtf::Int\n Tw1::Float64\n Tw2::Float64\n T6::Float64\n Tw3::Float64\n Tw4::Float64\n T7::Float64\n Ks2::Float64\n Ks3::Float64\n T8::Float64\n T9::Float64\n Ks1::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n T10::Float64\n T11::Float64\n Vs1_lim::Tuple{Float64, Float64}\n Vs2_lim::Tuple{Float64, Float64}\n Vst_lim::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE 421.5 2005 PSS2B IEEE Dual-Input Stabilizer Model\n\nArguments\n\ninput_code_1::Int: First Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_1::Int: First Input remote bus identification number for control. 0 identifies the local bus connected to this component\ninput_code_2::Int: Second Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_2::Int: Second Input remote bus identification number for control. 0 identifies the local bus connected to this component\nM_rtf::Int: M parameter for ramp tracking filter, validation range: (0, 8)\nN_rtf::Int: N parameter for ramp tracking filter, validation range: (0, 8)\nTw1::Float64: Time constant for first washout filter for first input, validation range: (eps(), nothing)\nTw2::Float64: Time constant for second washout filter for first input, validation range: (0, nothing)\nT6::Float64: Time constant for low-pass filter for first input, validation range: (0, nothing)\nTw3::Float64: Time constant for first washout filter for second input, validation range: (eps(), nothing)\nTw4::Float64: Time constant for second washout filter for second input, validation range: (0, nothing)\nT7::Float64: Time constant for low-pass filter for second input, validation range: (0, nothing)\nKs2::Float64: Gain for low-pass filter for second input, validation range: (0, nothing)\nKs3::Float64: Gain for second input, validation range: (0, nothing)\nT8::Float64: Time constant for ramp tracking filter, validation range: (0, nothing)\nT9::Float64: Time constant for ramp tracking filter, validation range: (eps(), nothing)\nKs1::Float64: Gain before lead-lag blocks, validation range: (0, nothing)\nT1::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT2::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT3::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT4::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT10::Float64: Time constant for third lead-lag block, validation range: (0, nothing)\nT11::Float64: Time constant for third lead-lag block, validation range: (0, nothing)\nVs1_lim::Tuple{Float64, Float64}: First input limits (Vs1_min, Vs1_max)\nVs2_lim::Tuple{Float64, Float64}: Second input limits (Vs2_min, Vs2_max)\nVst_lim::Tuple{Float64, Float64}: PSS output limits (Vst_min, Vst_max)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: 1st washout 1st input, \nx_p2: 2nd washout 1st input, \nx_p3: transducer 1st input, \nx_p4: 1st washout 2nd input, \nx_p5: 2nd washout 2nd input, \nx_p6: transducer 2nd input, \nx_p7: ramp tracking filter state 1, \nx_p8: ramp tracking filter state 2, \nx_p9: ramp tracking filter state 3, \nx_p10: ramp tracking filter state 4, \nx_p11: ramp tracking filter state 5, \nx_p12: ramp tracking filter state 6, \nx_p13: ramp tracking filter state 7, \nx_p14: ramp tracking filter state 8, \nx_p15: 1st lead-lag, \nx_p16: 2nd lead-lag, \nx_p17: 3rd lead-lag,\n\nn_states::Int: (Do not modify.) IEEEST has 17 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEST has 17 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Ks1","text":"get_Ks1(value::PSS2B) -> Float64\n\n\nGet PSS2B Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Ks2","text":"get_Ks2(value::PSS2B) -> Float64\n\n\nGet PSS2B Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks3-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Ks3","text":"get_Ks3(value::PSS2B) -> Float64\n\n\nGet PSS2B Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_M_rtf-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_M_rtf","text":"get_M_rtf(value::PSS2B) -> Int64\n\n\nGet PSS2B M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_N_rtf-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_N_rtf","text":"get_N_rtf(value::PSS2B) -> Int64\n\n\nGet PSS2B N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T1","text":"get_T1(value::PSS2B) -> Float64\n\n\nGet PSS2B T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T10-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T10","text":"get_T10(value::PSS2B) -> Float64\n\n\nGet PSS2B T10.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T11-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T11","text":"get_T11(value::PSS2B) -> Float64\n\n\nGet PSS2B T11.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T2","text":"get_T2(value::PSS2B) -> Float64\n\n\nGet PSS2B T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::PSS2B) -> Float64\n\n\nGet PSS2B T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::PSS2B) -> Float64\n\n\nGet PSS2B T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T6-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T6","text":"get_T6(value::PSS2B) -> Float64\n\n\nGet PSS2B T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T7-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T7","text":"get_T7(value::PSS2B) -> Float64\n\n\nGet PSS2B T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T8-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T8","text":"get_T8(value::PSS2B) -> Float64\n\n\nGet PSS2B T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T9-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T9","text":"get_T9(value::PSS2B) -> Float64\n\n\nGet PSS2B T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Tw1","text":"get_Tw1(value::PSS2B) -> Float64\n\n\nGet PSS2B Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Tw2","text":"get_Tw2(value::PSS2B) -> Float64\n\n\nGet PSS2B Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw3-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Tw3","text":"get_Tw3(value::PSS2B) -> Float64\n\n\nGet PSS2B Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw4-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Tw4","text":"get_Tw4(value::PSS2B) -> Float64\n\n\nGet PSS2B Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vs1_lim-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Vs1_lim","text":"get_Vs1_lim(value::PSS2B) -> Tuple{Float64, Float64}\n\n\nGet PSS2B Vs1_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vs2_lim-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Vs2_lim","text":"get_Vs2_lim(value::PSS2B) -> Tuple{Float64, Float64}\n\n\nGet PSS2B Vs2_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vst_lim-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Vst_lim","text":"get_Vst_lim(value::PSS2B) -> Tuple{Float64, Float64}\n\n\nGet PSS2B Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSS2B) -> Dict{String, Any}\n\n\nGet PSS2B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_input_code_1","text":"get_input_code_1(value::PSS2B) -> Int64\n\n\nGet PSS2B input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_input_code_2","text":"get_input_code_2(value::PSS2B) -> Int64\n\n\nGet PSS2B input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSS2B) -> Int64\n\n\nGet PSS2B n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_remote_bus_control_1","text":"get_remote_bus_control_1(value::PSS2B) -> Int64\n\n\nGet PSS2B remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_remote_bus_control_2","text":"get_remote_bus_control_2(value::PSS2B) -> Int64\n\n\nGet PSS2B remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSS2B) -> Vector{Symbol}\n\n\nGet PSS2B states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::PSS2B) -> Vector{StateTypes}\n\n\nGet PSS2B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Ks1!","text":"set_Ks1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Ks2!","text":"set_Ks2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks3!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Ks3!","text":"set_Ks3!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_M_rtf!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_M_rtf!","text":"set_M_rtf!(value::PSS2B, val) -> Any\n\n\nSet PSS2B M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_N_rtf!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_N_rtf!","text":"set_N_rtf!(value::PSS2B, val) -> Any\n\n\nSet PSS2B N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T1!","text":"set_T1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T10!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T10!","text":"set_T10!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T10.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T11!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T11!","text":"set_T11!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T11.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T2!","text":"set_T2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T6!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T6!","text":"set_T6!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T7!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T7!","text":"set_T7!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T8!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T8!","text":"set_T8!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T9!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T9!","text":"set_T9!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Tw1!","text":"set_Tw1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Tw2!","text":"set_Tw2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw3!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Tw3!","text":"set_Tw3!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw4!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Tw4!","text":"set_Tw4!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vs1_lim!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Vs1_lim!","text":"set_Vs1_lim!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Vs1_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vs2_lim!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Vs2_lim!","text":"set_Vs2_lim!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Vs2_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vst_lim!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Vst_lim!","text":"set_Vst_lim!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSS2B, val) -> Any\n\n\nSet PSS2B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_input_code_1!","text":"set_input_code_1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_input_code_2!","text":"set_input_code_2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_1!","text":"set_remote_bus_control_1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_2!","text":"set_remote_bus_control_2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::PSS2B, val) -> Any\n\n\nSet PSS2B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSS2C","page":"PSS","title":"PSS2C","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSS2C.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSS2C","page":"PSS","title":"PowerSystems.PSS2C","text":"mutable struct PSS2C <: PSS\n input_code_1::Int\n remote_bus_control_1::Int\n input_code_2::Int\n remote_bus_control_2::Int\n M_rtf::Int\n N_rtf::Int\n Tw1::Float64\n Tw2::Float64\n T6::Float64\n Tw3::Float64\n Tw4::Float64\n T7::Float64\n Ks2::Float64\n Ks3::Float64\n T8::Float64\n T9::Float64\n Ks1::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n T10::Float64\n T11::Float64\n Vs1_lim::Tuple{Float64, Float64}\n Vs2_lim::Tuple{Float64, Float64}\n Vst_lim::Tuple{Float64, Float64}\n T12::Float64\n T13::Float64\n PSS_Hysteresis_param::Tuple{Float64, Float64}\n Xcomp::Float64\n Tcomp::Float64\n hysteresis_binary_logic::Int\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE 421.5 2016 PSS2C IEEE Dual-Input Stabilizer Model\n\nArguments\n\ninput_code_1::Int: First Input Code for stabilizer, validation range: (1, 7)\nremote_bus_control_1::Int: First Input remote bus identification number for control. 0 identifies the local bus connected to this component\ninput_code_2::Int: Second Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_2::Int: Second Input remote bus identification number for control. 0 identifies the local bus connected to this component\nM_rtf::Int: M parameter for ramp tracking filter, validation range: (0, 8)\nN_rtf::Int: N parameter for ramp tracking filter, validation range: (0, 8)\nTw1::Float64: Time constant for first washout filter for first input, validation range: (eps(), nothing)\nTw2::Float64: Time constant for second washout filter for first input, validation range: (0, nothing)\nT6::Float64: Time constant for low-pass filter for first input, validation range: (0, nothing)\nTw3::Float64: Time constant for first washout filter for second input, validation range: (eps(), nothing)\nTw4::Float64: Time constant for second washout filter for second input, validation range: (0, nothing)\nT7::Float64: Time constant for low-pass filter for second input, validation range: (0, nothing)\nKs2::Float64: Gain for low-pass filter for second input, validation range: (0, nothing)\nKs3::Float64: Gain for second input, validation range: (0, nothing)\nT8::Float64: Time constant for ramp tracking filter, validation range: (0, nothing)\nT9::Float64: Time constant for ramp tracking filter, validation range: (eps(), nothing)\nKs1::Float64: Gain before lead-lag blocks, validation range: (0, nothing)\nT1::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT2::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT3::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT4::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT10::Float64: Time constant for third lead-lag block, validation range: (0, nothing)\nT11::Float64: Time constant for third lead-lag block, validation range: (0, nothing)\nVs1_lim::Tuple{Float64, Float64}: First input limits (Vs1_min, Vs1_max)\nVs2_lim::Tuple{Float64, Float64}: Second input limits (Vs2_min, Vs2_max)\nVst_lim::Tuple{Float64, Float64}: PSS output limits (Vst_min, Vst_max)\nT12::Float64: Time constant for fourth lead-lag block, validation range: (0, nothing)\nT13::Float64: Time constant for fourth lead-lag block, validation range: (0, nothing)\nPSS_Hysteresis_param::Tuple{Float64, Float64}: PSS output hysteresis parameters (PSSOFF, PSSON)\nXcomp::Float64: Stator Leakage Reactance, validation range: (0, nothing)\nTcomp::Float64: Time measured with compensated frequency, validation range: (eps(), nothing)\nhysteresis_binary_logic::Int: (default: 1) Hysteresis memory variable\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: 1st washout 1st input, \nx_p2: 2nd washout 1st input, \nx_p3: transducer 1st input, \nx_p4: 1st washout 2nd input, \nx_p5: 2nd washout 2nd input, \nx_p6: transducer 2nd input, \nx_p7: ramp tracking filter state 1, \nx_p8: ramp tracking filter state 2, \nx_p9: ramp tracking filter state 3, \nx_p10: ramp tracking filter state 4, \nx_p11: ramp tracking filter state 5, \nx_p12: ramp tracking filter state 6, \nx_p13: ramp tracking filter state 7, \nx_p14: ramp tracking filter state 8, \nx_p15: 1st lead-lag, \nx_p16: 2nd lead-lag, \nx_p17: 3rd lead-lag, \nx_p18: 4th lead-lag, \nx_p19: washout block for compensated frequency,\n\nn_states::Int: (Do not modify.) IEEEST has 19 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEST has 19 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Ks1","text":"get_Ks1(value::PSS2C) -> Float64\n\n\nGet PSS2C Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Ks2","text":"get_Ks2(value::PSS2C) -> Float64\n\n\nGet PSS2C Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks3-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Ks3","text":"get_Ks3(value::PSS2C) -> Float64\n\n\nGet PSS2C Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_M_rtf-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_M_rtf","text":"get_M_rtf(value::PSS2C) -> Int64\n\n\nGet PSS2C M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_N_rtf-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_N_rtf","text":"get_N_rtf(value::PSS2C) -> Int64\n\n\nGet PSS2C N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_PSS_Hysteresis_param-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_PSS_Hysteresis_param","text":"get_PSS_Hysteresis_param(\n value::PSS2C\n) -> Tuple{Float64, Float64}\n\n\nGet PSS2C PSS_Hysteresis_param.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T1","text":"get_T1(value::PSS2C) -> Float64\n\n\nGet PSS2C T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T10-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T10","text":"get_T10(value::PSS2C) -> Float64\n\n\nGet PSS2C T10.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T11-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T11","text":"get_T11(value::PSS2C) -> Float64\n\n\nGet PSS2C T11.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T12-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T12","text":"get_T12(value::PSS2C) -> Float64\n\n\nGet PSS2C T12.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T13-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T13","text":"get_T13(value::PSS2C) -> Float64\n\n\nGet PSS2C T13.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T2","text":"get_T2(value::PSS2C) -> Float64\n\n\nGet PSS2C T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::PSS2C) -> Float64\n\n\nGet PSS2C T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::PSS2C) -> Float64\n\n\nGet PSS2C T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T6-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T6","text":"get_T6(value::PSS2C) -> Float64\n\n\nGet PSS2C T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T7-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T7","text":"get_T7(value::PSS2C) -> Float64\n\n\nGet PSS2C T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T8-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T8","text":"get_T8(value::PSS2C) -> Float64\n\n\nGet PSS2C T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T9-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T9","text":"get_T9(value::PSS2C) -> Float64\n\n\nGet PSS2C T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tcomp-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tcomp","text":"get_Tcomp(value::PSS2C) -> Float64\n\n\nGet PSS2C Tcomp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tw1","text":"get_Tw1(value::PSS2C) -> Float64\n\n\nGet PSS2C Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tw2","text":"get_Tw2(value::PSS2C) -> Float64\n\n\nGet PSS2C Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw3-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tw3","text":"get_Tw3(value::PSS2C) -> Float64\n\n\nGet PSS2C Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw4-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tw4","text":"get_Tw4(value::PSS2C) -> Float64\n\n\nGet PSS2C Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vs1_lim-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Vs1_lim","text":"get_Vs1_lim(value::PSS2C) -> Tuple{Float64, Float64}\n\n\nGet PSS2C Vs1_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vs2_lim-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Vs2_lim","text":"get_Vs2_lim(value::PSS2C) -> Tuple{Float64, Float64}\n\n\nGet PSS2C Vs2_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vst_lim-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Vst_lim","text":"get_Vst_lim(value::PSS2C) -> Tuple{Float64, Float64}\n\n\nGet PSS2C Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Xcomp-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Xcomp","text":"get_Xcomp(value::PSS2C) -> Float64\n\n\nGet PSS2C Xcomp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSS2C) -> Dict{String, Any}\n\n\nGet PSS2C ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_hysteresis_binary_logic-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_hysteresis_binary_logic","text":"get_hysteresis_binary_logic(value::PSS2C) -> Int64\n\n\nGet PSS2C hysteresis_binary_logic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_input_code_1","text":"get_input_code_1(value::PSS2C) -> Int64\n\n\nGet PSS2C input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_input_code_2","text":"get_input_code_2(value::PSS2C) -> Int64\n\n\nGet PSS2C input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSS2C) -> Int64\n\n\nGet PSS2C n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_remote_bus_control_1","text":"get_remote_bus_control_1(value::PSS2C) -> Int64\n\n\nGet PSS2C remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_remote_bus_control_2","text":"get_remote_bus_control_2(value::PSS2C) -> Int64\n\n\nGet PSS2C remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSS2C) -> Vector{Symbol}\n\n\nGet PSS2C states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::PSS2C) -> Vector{StateTypes}\n\n\nGet PSS2C states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Ks1!","text":"set_Ks1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Ks2!","text":"set_Ks2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks3!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Ks3!","text":"set_Ks3!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_M_rtf!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_M_rtf!","text":"set_M_rtf!(value::PSS2C, val) -> Any\n\n\nSet PSS2C M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_N_rtf!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_N_rtf!","text":"set_N_rtf!(value::PSS2C, val) -> Any\n\n\nSet PSS2C N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_PSS_Hysteresis_param!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_PSS_Hysteresis_param!","text":"set_PSS_Hysteresis_param!(value::PSS2C, val) -> Any\n\n\nSet PSS2C PSS_Hysteresis_param.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T1!","text":"set_T1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T10!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T10!","text":"set_T10!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T10.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T11!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T11!","text":"set_T11!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T11.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T12!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T12!","text":"set_T12!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T12.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T13!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T13!","text":"set_T13!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T13.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T2!","text":"set_T2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T6!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T6!","text":"set_T6!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T7!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T7!","text":"set_T7!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T8!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T8!","text":"set_T8!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T9!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T9!","text":"set_T9!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tcomp!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tcomp!","text":"set_Tcomp!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tcomp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tw1!","text":"set_Tw1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tw2!","text":"set_Tw2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw3!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tw3!","text":"set_Tw3!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw4!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tw4!","text":"set_Tw4!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vs1_lim!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Vs1_lim!","text":"set_Vs1_lim!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Vs1_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vs2_lim!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Vs2_lim!","text":"set_Vs2_lim!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Vs2_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vst_lim!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Vst_lim!","text":"set_Vst_lim!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Xcomp!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Xcomp!","text":"set_Xcomp!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Xcomp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSS2C, val) -> Any\n\n\nSet PSS2C ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_hysteresis_binary_logic!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_hysteresis_binary_logic!","text":"set_hysteresis_binary_logic!(value::PSS2C, val) -> Any\n\n\nSet PSS2C hysteresis_binary_logic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_input_code_1!","text":"set_input_code_1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_input_code_2!","text":"set_input_code_2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_1!","text":"set_remote_bus_control_1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_2!","text":"set_remote_bus_control_2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::PSS2C, val) -> Any\n\n\nSet PSS2C states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSSFixed","page":"PSS","title":"PSSFixed","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSSFixed.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSSFixed","page":"PSS","title":"PowerSystems.PSSFixed","text":"mutable struct PSSFixed <: PSS\n V_pss::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a PSS that returns a fixed voltage to add to the reference for the AVR\n\nArguments\n\nV_pss::Float64: Fixed voltage stabilization signal in pu (DEVICE_BASE), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) PSSFixed has no states\nn_states::Int: (Do not modify.) PSSFixed has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_V_pss-Tuple{PSSFixed}","page":"PSS","title":"PowerSystems.get_V_pss","text":"get_V_pss(value::PSSFixed) -> Float64\n\n\nGet PSSFixed V_pss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSSFixed}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSSFixed) -> Dict{String, Any}\n\n\nGet PSSFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSSFixed}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSSFixed) -> Int64\n\n\nGet PSSFixed n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSSFixed}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSSFixed) -> Vector{Symbol}\n\n\nGet PSSFixed states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_V_pss!-Tuple{PSSFixed, Any}","page":"PSS","title":"PowerSystems.set_V_pss!","text":"set_V_pss!(value::PSSFixed, val) -> Any\n\n\nSet PSSFixed V_pss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSSFixed, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSSFixed, val) -> Any\n\n\nSet PSSFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSSSimple","page":"PSS","title":"PSSSimple","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSSSimple.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSSSimple","page":"PSS","title":"PowerSystems.PSSSimple","text":"mutable struct PSSSimple <: PSS\n K_ω::Float64\n K_p::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a PSS that returns a proportional droop voltage to add to the reference for the AVR\n\nArguments\n\nK_ω::Float64: Proportional gain for frequency, validation range: (0, nothing)\nK_p::Float64: Proportional gain for active power, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) PSSSimple has no states\nn_states::Int: (Do not modify.) PSSSimple has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_K_p-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_K_p","text":"get_K_p(value::PSSSimple) -> Float64\n\n\nGet PSSSimple K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_K_ω-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_K_ω","text":"get_K_ω(value::PSSSimple) -> Float64\n\n\nGet PSSSimple K_ω.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSSSimple) -> Dict{String, Any}\n\n\nGet PSSSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSSSimple) -> Int64\n\n\nGet PSSSimple n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSSSimple) -> Vector{Symbol}\n\n\nGet PSSSimple states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_K_p!-Tuple{PSSSimple, Any}","page":"PSS","title":"PowerSystems.set_K_p!","text":"set_K_p!(value::PSSSimple, val) -> Any\n\n\nSet PSSSimple K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_K_ω!-Tuple{PSSSimple, Any}","page":"PSS","title":"PowerSystems.set_K_ω!","text":"set_K_ω!(value::PSSSimple, val) -> Any\n\n\nSet PSSSimple K_ω.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSSSimple, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSSSimple, val) -> Any\n\n\nSet PSSSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#STAB1","page":"PSS","title":"STAB1","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/STAB1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.STAB1","page":"PSS","title":"PowerSystems.STAB1","text":"mutable struct STAB1 <: PSS\n KT::Float64\n T::Float64\n T1T3::Float64\n T3::Float64\n T2T4::Float64\n T4::Float64\n H_lim::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nSpeed-Sensitive Stabilizing Model\n\nArguments\n\nKT::Float64: K/T for washout filter, validation range: (0, nothing)\nT::Float64: Time constant for washout filter, validation range: (0.01, nothing)\nT1T3::Float64: Time constant division T1/T3, validation range: (0, nothing)\nT3::Float64: Time constant, validation range: (0.01, nothing)\nT2T4::Float64: Time constant division T2/T4, validation range: (0, nothing)\nT4::Float64: Time constant, validation range: (0.01, nothing)\nH_lim::Float64: PSS output limit, validation range: (0, 0.5)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: washout filter,\nx_p2: T1/T3 lead-lag block, \nx_p3: T2/T4 lead-lag block,\n\nn_states::Int: (Do not modify.) STAB1 has 3 states\nstates_types::Vector{StateTypes}: (Do not modify.) STAB1 has 3 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_H_lim-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_H_lim","text":"get_H_lim(value::STAB1) -> Float64\n\n\nGet STAB1 H_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_KT-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_KT","text":"get_KT(value::STAB1) -> Float64\n\n\nGet STAB1 KT.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T","text":"get_T(value::STAB1) -> Float64\n\n\nGet STAB1 T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1T3-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T1T3","text":"get_T1T3(value::STAB1) -> Float64\n\n\nGet STAB1 T1T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2T4-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T2T4","text":"get_T2T4(value::STAB1) -> Float64\n\n\nGet STAB1 T2T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::STAB1) -> Float64\n\n\nGet STAB1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::STAB1) -> Float64\n\n\nGet STAB1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::STAB1) -> Dict{String, Any}\n\n\nGet STAB1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::STAB1) -> Int64\n\n\nGet STAB1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::STAB1) -> Vector{Symbol}\n\n\nGet STAB1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::STAB1) -> Vector{StateTypes}\n\n\nGet STAB1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_H_lim!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_H_lim!","text":"set_H_lim!(value::STAB1, val) -> Any\n\n\nSet STAB1 H_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_KT!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_KT!","text":"set_KT!(value::STAB1, val) -> Any\n\n\nSet STAB1 KT.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T!","text":"set_T!(value::STAB1, val) -> Any\n\n\nSet STAB1 T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1T3!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T1T3!","text":"set_T1T3!(value::STAB1, val) -> Any\n\n\nSet STAB1 T1T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2T4!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T2T4!","text":"set_T2T4!(value::STAB1, val) -> Any\n\n\nSet STAB1 T2T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::STAB1, val) -> Any\n\n\nSet STAB1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::STAB1, val) -> Any\n\n\nSet STAB1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::STAB1, val) -> Any\n\n\nSet STAB1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::STAB1, val) -> Any\n\n\nSet STAB1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#TwoTerminalHVDCLine","page":"TwoTerminalHVDCLine","title":"TwoTerminalHVDCLine","text":"","category":"section"},{"location":"model_library/generated_TwoTerminalHVDCLine/","page":"TwoTerminalHVDCLine","title":"TwoTerminalHVDCLine","text":"Modules = [PowerSystems]\nPages = [\"generated/TwoTerminalHVDCLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.TwoTerminalHVDCLine","page":"TwoTerminalHVDCLine","title":"PowerSystems.TwoTerminalHVDCLine","text":"mutable struct TwoTerminalHVDCLine <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n arc::Arc\n active_power_limits_from::MinMax\n active_power_limits_to::MinMax\n reactive_power_limits_from::MinMax\n reactive_power_limits_to::MinMax\n loss::Union{LinearCurve, PiecewiseIncrementalCurve}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA High Voltage DC line, which must be connected to an ACBus on each end.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\narc::Arc: An Arc defining this line from a bus to another bus\nactive_power_limits_from::MinMax: Minimum and maximum active power flows to the FROM node (MW)\nactive_power_limits_to::MinMax: Minimum and maximum active power flows to the TO node (MW)\nreactive_power_limits_from::MinMax: Minimum and maximum reactive power limits to the FROM node (MVAR)\nreactive_power_limits_to::MinMax: Minimum and maximum reactive power limits to the TO node (MVAR)\nloss::Union{LinearCurve, PiecewiseIncrementalCurve}: (default: LinearCurve(0.0)) Loss model coefficients. It accepts a linear model with a constant loss (MW) and a proportional loss rate (MW of loss per MW of flow). It also accepts a Piecewise loss, with N segments to specify different proportional losses for different segments.\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TwoTerminalHVDCLine/#InfrastructureSystems.get_name-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"InfrastructureSystems.get_name","text":"get_name(value::TwoTerminalHVDCLine) -> String\n\n\nGet TwoTerminalHVDCLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_active_power_flow-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::TwoTerminalHVDCLine) -> Any\n\n\nGet TwoTerminalHVDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_active_power_limits_from-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_active_power_limits_from","text":"get_active_power_limits_from(\n value::TwoTerminalHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_active_power_limits_to-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_active_power_limits_to","text":"get_active_power_limits_to(\n value::TwoTerminalHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_arc-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_arc","text":"get_arc(value::TwoTerminalHVDCLine) -> Arc\n\n\nGet TwoTerminalHVDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_available-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_available","text":"get_available(value::TwoTerminalHVDCLine) -> Bool\n\n\nGet TwoTerminalHVDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_ext-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_ext","text":"get_ext(value::TwoTerminalHVDCLine) -> Dict{String, Any}\n\n\nGet TwoTerminalHVDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_loss-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_loss","text":"get_loss(\n value::TwoTerminalHVDCLine\n) -> Union{LinearCurve, PiecewiseIncrementalCurve}\n\n\nGet TwoTerminalHVDCLine loss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_reactive_power_limits_from-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_reactive_power_limits_from","text":"get_reactive_power_limits_from(\n value::TwoTerminalHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCLine reactive_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_reactive_power_limits_to-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_reactive_power_limits_to","text":"get_reactive_power_limits_to(\n value::TwoTerminalHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCLine reactive_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_services-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_services","text":"get_services(value::TwoTerminalHVDCLine) -> Vector{Service}\n\n\nGet TwoTerminalHVDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_active_power_flow!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_active_power_limits_from!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_active_power_limits_from!","text":"set_active_power_limits_from!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_active_power_limits_to!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_active_power_limits_to!","text":"set_active_power_limits_to!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_arc!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_available!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_available!","text":"set_available!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_ext!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_loss!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_loss!","text":"set_loss!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine loss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_reactive_power_limits_from!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_reactive_power_limits_from!","text":"set_reactive_power_limits_from!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine reactive_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_reactive_power_limits_to!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_reactive_power_limits_to!","text":"set_reactive_power_limits_to!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine reactive_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_services!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_services!","text":"set_services!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"api/developer_guidelines/#Developer-Guidelines","page":"Developer Guidelines","title":"Developer Guidelines","text":"","category":"section"},{"location":"api/developer_guidelines/","page":"Developer Guidelines","title":"Developer Guidelines","text":"In order to contribute to PowerSystems.jl repository please read the following sections of InfrastructureSystems.jl documentation in detail:","category":"page"},{"location":"api/developer_guidelines/","page":"Developer Guidelines","title":"Developer Guidelines","text":"Style Guide\nContributing Guidelines","category":"page"},{"location":"api/developer_guidelines/","page":"Developer Guidelines","title":"Developer Guidelines","text":"Pull requests are always welcome to fix bugs or add additional modeling capabilities.","category":"page"},{"location":"api/developer_guidelines/","page":"Developer Guidelines","title":"Developer Guidelines","text":"All the code contributions need to include tests with a minimum coverage of 70%","category":"page"},{"location":"tutorials/creating_system/#Create-and-Explore-a-Power-System","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Welcome to PowerSystems.jl!","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"In this tutorial, we will create a power system and add some components to it, including some nodes, a transmission line, load, and both renewable and fossil fuel generators. Then we will retrieve data from the system and explore the system settings.","category":"page"},{"location":"tutorials/creating_system/#Setup","page":"Create and Explore a Power System","title":"Setup","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"To get started, ensure you have followed the installation instructions.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Start Julia from the command line if you haven't already:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"$ julia","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Load the PowerSystems.jl package:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"using PowerSystems","category":"page"},{"location":"tutorials/creating_system/#Creating-a-Power-System","page":"Create and Explore a Power System","title":"Creating a Power System","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"In PowerSystems.jl, data is held in a System that holds all of the individual components along with some metadata about the power system itself.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"There are many ways to define a System, but let's start with an empty system. All we need to define is a base power of 100 MVA for per-unitization.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys = System(100.0)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that this system is a 60 Hz system with a base power of 100 MVA.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now, let's add some components to our system.","category":"page"},{"location":"tutorials/creating_system/#Adding-Buses","page":"Create and Explore a Power System","title":"Adding Buses","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We'll start by creating some buses. By referring to the documentation for ACBus, notice that we need define some basic data, including the bus's unique identifier and name, base voltage, and whether it's a load, generator, or reference bus.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's start with a reference bus:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"bus1 = ACBus(;\n number = 1,\n name = \"bus1\",\n bustype = ACBusTypes.REF,\n angle = 0.0,\n magnitude = 1.0,\n voltage_limits = (min = 0.9, max = 1.05),\n base_voltage = 230.0,\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"This bus is on a 230 kV AC transmission network, with an allowable voltage range of 0.9 to 1.05 p.u. We are assuming it is currently operating at 1.0 p.u. voltage and an angle of 0 radians.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's add this bus to our System with add_component!:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_component!(sys, bus1)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We can see the impact this has on the System simply by printing it:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that System now shows a summary of components in the system.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's create a second bus:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"bus2 = ACBus(;\n number = 2,\n name = \"bus2\",\n bustype = ACBusTypes.PV,\n angle = 0.0,\n magnitude = 1.0,\n voltage_limits = (min = 0.9, max = 1.05),\n base_voltage = 230.0,\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that we've defined this bus with power and voltage variables, suitable for power flow studies.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's also add this to our System:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_component!(sys, bus2)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now, let's use show_components to quickly see some basic information about the buses:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"show_components(sys, ACBus)","category":"page"},{"location":"tutorials/creating_system/#Adding-a-Transmission-Line","page":"Create and Explore a Power System","title":"Adding a Transmission Line","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's connect our buses. We'll add a transmission Line between bus1 and bus2.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"warning: Warning\nWhen defining a line that isn't attached to a System yet, you must define the thermal rating of the transmission line in per-unit using the base power of the System you plan to connect it to – in this case, 100 MVA.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"line = Line(;\n name = \"line1\",\n available = true,\n active_power_flow = 0.0,\n reactive_power_flow = 0.0,\n arc = Arc(; from = bus1, to = bus2),\n r = 0.00281, # Per-unit\n x = 0.0281, # Per-unit\n b = (from = 0.00356, to = 0.00356), # Per-unit\n rating = 2.0, # Line rating of 200 MVA / System base of 100 MVA\n angle_limits = (min = -0.7, max = 0.7),\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Note that we also had to define an Arc in the process to define the connection between the two buses.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's also add this to our System:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_component!(sys, line)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Finally, let's check our System summary to see all the network topology components we have added are attached:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys","category":"page"},{"location":"tutorials/creating_system/#Adding-Loads-and-Generators","page":"Create and Explore a Power System","title":"Adding Loads and Generators","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now that our network topology is complete, we'll start adding components that inject or withdraw power from the network.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"warning: Warning\nWhen you define components that aren't attached to a System yet, you must define all fields related to power (with units such as MW, MVA, MVAR, or MW/min) in per-unit using the base_power of the component (with the exception of base_power itself, which is in MVA).","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We'll start with defining a 10 MW load to bus1:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"load = PowerLoad(;\n name = \"load1\",\n available = true,\n bus = bus1,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n base_power = 10.0, # MVA\n max_active_power = 1.0, # 10 MW per-unitized by device base_power\n max_reactive_power = 0.0,\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that we defined the max_active_power, which is 10 MW, as 1.0 in per-unit using the base_power of 10 MVA. We've also used the bus1 component itself to define where this load is located in the network.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now add the load to the system:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_component!(sys, load)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Finally, we'll add two generators: one renewable and one thermal.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We'll add a 5 MW solar power plant to bus2:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"solar = RenewableDispatch(;\n name = \"solar1\",\n available = true,\n bus = bus2,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n rating = 1.0, # 5 MW per-unitized by device base_power\n prime_mover_type = PrimeMovers.PVe,\n reactive_power_limits = (min = 0.0, max = 0.05), # 0 MVAR to 0.25 MVAR per-unitized by device base_power\n power_factor = 1.0,\n operation_cost = RenewableGenerationCost(nothing),\n base_power = 5.0, # MVA\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Note that we've used a generic renewable generator to model solar, but we can specify that it is solar through the prime mover.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Finally, we'll also add a 30 MW gas thermal generator:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"gas = ThermalStandard(;\n name = \"gas1\",\n available = true,\n status = true,\n bus = bus2,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n rating = 1.0, # 30 MW per-unitized by device base_power\n active_power_limits = (min = 0.2, max = 1.0), # 6 MW to 30 MW per-unitized by device base_power\n reactive_power_limits = nothing, # Per-unitized by device base_power\n ramp_limits = (up = 0.2, down = 0.2), # 6 MW/min up or down, per-unitized by device base_power\n operation_cost = ThermalGenerationCost(nothing),\n base_power = 30.0, # MVA\n time_limits = (up = 8.0, down = 8.0), # Hours\n must_run = false,\n prime_mover_type = PrimeMovers.CC,\n fuel = ThermalFuels.NATURAL_GAS,\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"This time, let's add these components to our System using add_components! to add them both at the same time:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_components!(sys, [solar, gas])","category":"page"},{"location":"tutorials/creating_system/#Explore-the-System-and-its-Components","page":"Create and Explore a Power System","title":"Explore the System and its Components","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Congratulations! You have built a power system including buses, a transmission line, a load, and different types of generators. Now let's take a look around.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Remember that we can see a summary of our System using the print statement:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now, let's double-check some of our data by retrieving it from the System. Let's use show_components again to get an overview of our renewable generators:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"show_components(sys, RenewableDispatch)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We just have the one renewable generator named solar1. Use get_component to retrieve it by name:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"retrieved_component = get_component(RenewableDispatch, sys, \"solar1\");","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's double-check what type of renewable generator this is using a get_ function:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_prime_mover_type(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Verify that this a PVe, or solar photovoltaic, generator.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's also use a get_ function to double-check where this generator is connected in the transmission network:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_bus(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"See that the generator's bus is linked to the actual bus2 component in our System.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"These \"getter\" functions are available for all the data fields in a component.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"tip: Tip\nAlways use the get_* functions to retrieve the data within a component. While in Julia a user can use . to access the fields of a component, we make no guarantees on the stability of field names and locations. We do however promise to keep the getter functions stable. PowerSystems.jl also does many internal data calculations that the getter functions will properly handle for you, as you'll see below.","category":"page"},{"location":"tutorials/creating_system/#Changing-System-Per-Unit-Settings","page":"Create and Explore a Power System","title":"Changing System Per-Unit Settings","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now, let's use a getter function to look up the solar generator's rating:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_rating(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"tip: Important\nWhen we defined the solar generator, we defined the rating as 1.0 per-unit with a device base_power of 5.0 MVA. Notice that the rating now reads 0.05. After we attached this component to our System, its power data is being returned to us in the System's units base.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's double-check the System's units base:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_units_base(sys)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"SYSTEM_BASE means all power-related (MW, MVA, MVAR, MW/min) component data in the System, except for each component's base_power, is per-unitized by the system base power for consistency.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Check the System's base_power again:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_base_power(sys)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that when we called get_rating above, the solar generator's rating, 5.0 MW, is being returned as 0.05 = (5 MVA)/(100 MVA) using the system base power.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Instead of using the System base power, let's view everything in MW or MVA – or what we call \"NATURAL_UNITS\" in PowerSystems.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Change the System's unit system:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"set_units_base_system!(sys, \"NATURAL_UNITS\")","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now retrieve the solar generator's rating again:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_rating(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that the value is now its \"natural\" value, 5.0 MVA.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Finally, let's change the System's unit system to the final option, \"DEVICE_BASE\":","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"set_units_base_system!(sys, \"DEVICE_BASE\")","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"And retrieve the solar generator's rating once more:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_rating(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"See that now the data is now 1.0 (5.0 MVA per-unitized by the generator (i.e., the device's) base_power of 5.0 MVA), which is the format we used to originally define the device.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Recall that if you ever need to check a System's settings, including the unit system being used by all the getter functions, you can always just print the System:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"See the units base is printed as one of the System properties.","category":"page"},{"location":"tutorials/creating_system/#Next-Steps","page":"Create and Explore a Power System","title":"Next Steps","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"In this tutorial, you manually created a power System, added and then retrieved its components, and modified the System per-unit settings.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Next, you might want to:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Add time series data to components in the System\nAdd necessary data for dynamic simulations\nImport a System from an existing Matpower or PSSE file or with PSSE dynamic data instead of creating it manually\nCreate your own System from .csv files instead of creating it manually\nRead more to understand per-unitization in PowerSystems.jl\nSee a workaround for how to Add a Component in Natural Units","category":"page"},{"location":"model_library/generated_LoadZone/#LoadZone","page":"LoadZone","title":"LoadZone","text":"","category":"section"},{"location":"model_library/generated_LoadZone/","page":"LoadZone","title":"LoadZone","text":"Modules = [PowerSystems]\nPages = [\"generated/LoadZone.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_LoadZone/#PowerSystems.LoadZone","page":"LoadZone","title":"PowerSystems.LoadZone","text":"mutable struct LoadZone <: AggregationTopology\n name::String\n peak_active_power::Float64\n peak_reactive_power::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA load zone for electricity price analysis.\n\nThe load zone can be specified when defining each ACBus or DCBus in the zone\n\nArguments\n\nname::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\npeak_active_power::Float64: Peak active power in the zone (MW)\npeak_reactive_power::Float64: Peak reactive power in the zone (MVAR)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_LoadZone/#InfrastructureSystems.get_name-Tuple{LoadZone}","page":"LoadZone","title":"InfrastructureSystems.get_name","text":"get_name(value::LoadZone) -> String\n\n\nGet LoadZone name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.get_ext-Tuple{LoadZone}","page":"LoadZone","title":"PowerSystems.get_ext","text":"get_ext(value::LoadZone) -> Dict{String, Any}\n\n\nGet LoadZone ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.get_peak_active_power-Tuple{LoadZone}","page":"LoadZone","title":"PowerSystems.get_peak_active_power","text":"get_peak_active_power(value::LoadZone) -> Any\n\n\nGet LoadZone peak_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.get_peak_reactive_power-Tuple{LoadZone}","page":"LoadZone","title":"PowerSystems.get_peak_reactive_power","text":"get_peak_reactive_power(value::LoadZone) -> Any\n\n\nGet LoadZone peak_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.set_ext!-Tuple{LoadZone, Any}","page":"LoadZone","title":"PowerSystems.set_ext!","text":"set_ext!(value::LoadZone, val) -> Any\n\n\nSet LoadZone ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.set_peak_active_power!-Tuple{LoadZone, Any}","page":"LoadZone","title":"PowerSystems.set_peak_active_power!","text":"set_peak_active_power!(value::LoadZone, val) -> Any\n\n\nSet LoadZone peak_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.set_peak_reactive_power!-Tuple{LoadZone, Any}","page":"LoadZone","title":"PowerSystems.set_peak_reactive_power!","text":"set_peak_reactive_power!(value::LoadZone, val) -> Any\n\n\nSet LoadZone peak_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"how_to/add_cost_curve/#cost_how_to","page":"...add an Operating Cost","title":"Adding an Operating Cost","text":"","category":"section"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"This how-to guide covers the steps to select and add an operating cost to a component, such as a generator, load, or energy storage system.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"using PowerSystems #hide","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"To begin, the user must make 2 or 3 decisions before defining the operating cost:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Select an appropriate OperationalCost from the OperationalCost options. In general, each operating cost has parameters to define fixed and variable costs. To be able to define an OperationalCost, you must first select a curve to represent the variable cost(s).\nIf you selected ThermalGenerationCost or HydroGenerationCost, select either a FuelCurve or CostCurve to represent the variable cost, based on the units of the generator's data.\nIf you have data in terms of heat rate or water flow, use FuelCurve.\nIf you have data in units of currency, such as $/MWh, use CostCurve. If you selected another OperationalCost type, the variable cost is represented as a CostCurve.\nSelect a ValueCurve to represent the variable cost data by comparing the format of your variable cost data to the Variable Cost Representations table and the ValueCurve options.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Then, the user defines the cost by working backwards:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Define the variable cost's ValueCurve\nUse the ValueCurve to define the selected CostCurve or FuelCurve\nUse the CostCurve or FuelCurve to define the OperationalCost","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Let's look at a few examples.","category":"page"},{"location":"how_to/add_cost_curve/#Example-1:-A-Renewable-Generator","page":"...add an Operating Cost","title":"Example 1: A Renewable Generator","text":"","category":"section"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"We have a renewable unit that produces at $22/MWh.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Following the decision steps above:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"We select RenewableGenerationCost to represent this renewable generator.\nWe select a LinearCurve to represent the $22/MWh variable cost.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Following the implementation steps, we define RenewableGenerationCost by nesting the definitions:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"RenewableGenerationCost(; variable = CostCurve(; value_curve = LinearCurve(22.0)))","category":"page"},{"location":"how_to/add_cost_curve/#Example-2:-A-Thermal-Generator","page":"...add an Operating Cost","title":"Example 2: A Thermal Generator","text":"","category":"section"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"We have a thermal generating unit that has a heat rate of 7 GJ/MWh at 100 MW and 9 GJ/MWh at 200 MW, plus a fixed cost of $6.0/hr, a start-up cost of $2000, and a shut-down cost of $1000. Its fuel cost is $20/GJ.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Following the decision steps above:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"We select ThermalGenerationCost to represent this thermal generator.\nWe select FuelCurve because we have consumption in units of fuel (GJ/MWh) instead of currency.\nWe select a PiecewisePointCurve to represent the piecewise linear heat rate curve.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"This time, we'll define each step individually, beginning with the heat rate curve:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"heat_rate_curve = PiecewisePointCurve([(100.0, 7.0), (200.0, 9.0)])","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Use the heat rate to define the fuel curve, including the cost of fuel:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"fuel_curve = FuelCurve(; value_curve = heat_rate_curve, fuel_cost = 20.0)","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Finally, define the full operating cost:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"cost = ThermalGenerationCost(;\n variable = fuel_curve,\n fixed = 6.0,\n start_up = 2000.0,\n shut_down = 1000.0,\n)","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"This OperationalCost can be used when defining a component or added to an existing component using set_operation_cost!.","category":"page"},{"location":"model_library/dynamic_branch/#Dynamic-Branch","page":"Dynamic Lines","title":"Dynamic Branch","text":"","category":"section"},{"location":"model_library/dynamic_branch/","page":"Dynamic Lines","title":"Dynamic Lines","text":"Modules = [PowerSystems]\nPages = [\"models/dynamic_branch.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/dynamic_branch/#PowerSystems.DynamicBranch","page":"Dynamic Lines","title":"PowerSystems.DynamicBranch","text":"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\n\nArguments\n\nbranch::ACBranch\n\n\n\n\n\n","category":"type"},{"location":"model_library/dynamic_branch/#PowerSystems.get_active_power_flow-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::DynamicBranch)\n\n\nGet DynamicBranch activepowerflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_angle_limits-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_angle_limits","text":"get_angle_limits(\n value::DynamicBranch\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet DynamicBranch angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_arc-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_arc","text":"get_arc(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_available-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_available","text":"get_available(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_b-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_b","text":"get_b(\n value::DynamicBranch\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet DynamicBranch b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_ext-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_ext","text":"get_ext(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_n_states-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_n_states","text":"get_n_states(value::DynamicBranch) -> Int64\n\n\nGet n_states\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_r-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_r","text":"get_r(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_rating-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_rating","text":"get_rating(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_reactive_power_flow-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::DynamicBranch)\n\n\nGet DynamicBranch reactivepowerflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_services-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_services","text":"get_services(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_states-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_states","text":"get_states(value::DynamicBranch) -> Vector{Symbol}\n\n\nGet states\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_x-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_x","text":"get_x(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_active_power_flow!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::DynamicBranch,\n val::Float64\n) -> Any\n\n\nSet DynamicBranch activepowerflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_angle_limits!-Tuple{DynamicBranch, @NamedTuple{min::Float64, max::Float64}}","page":"Dynamic Lines","title":"PowerSystems.set_angle_limits!","text":"set_angle_limits!(\n value::DynamicBranch,\n val::@NamedTuple{min::Float64, max::Float64}\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nSet DynamicBranch angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_arc!-Tuple{DynamicBranch, Arc}","page":"Dynamic Lines","title":"PowerSystems.set_arc!","text":"set_arc!(value::DynamicBranch, val::Arc) -> Any\n\n\nSet DynamicBranch arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_available!-Tuple{DynamicBranch, Bool}","page":"Dynamic Lines","title":"PowerSystems.set_available!","text":"set_available!(value::DynamicBranch, val::Bool) -> Any\n\n\nSet DynamicBranch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_b!-Tuple{DynamicBranch, Any}","page":"Dynamic Lines","title":"PowerSystems.set_b!","text":"set_b!(value::DynamicBranch, val) -> Any\n\n\nSet DynamicBranch b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_ext!-Tuple{DynamicBranch, Dict{String, Any}}","page":"Dynamic Lines","title":"PowerSystems.set_ext!","text":"set_ext!(\n value::DynamicBranch,\n val::Dict{String, Any}\n) -> Any\n\n\nSet DynamicBranch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_n_states!-Tuple{DynamicBranch, Int64}","page":"Dynamic Lines","title":"PowerSystems.set_n_states!","text":"set_n_states!(value::DynamicBranch, val::Int64) -> Int64\n\n\nSet n_states\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_r!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_r!","text":"set_r!(value::DynamicBranch, val::Float64) -> Any\n\n\nSet DynamicBranch r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_rating!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_rating!","text":"set_rating!(value::DynamicBranch, val::Float64) -> Any\n\n\nSet DynamicBranch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_reactive_power_flow!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(\n value::DynamicBranch,\n val::Float64\n) -> Any\n\n\nSet DynamicBranch reactivepowerflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_services!-Tuple{DynamicBranch, Vector{Service}}","page":"Dynamic Lines","title":"PowerSystems.set_services!","text":"set_services!(\n value::DynamicBranch,\n val::Vector{Service}\n) -> Any\n\n\nSet DynamicBranch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_states!-Tuple{DynamicBranch, Vector{Symbol}}","page":"Dynamic Lines","title":"PowerSystems.set_states!","text":"set_states!(\n value::DynamicBranch,\n val::Vector{Symbol}\n) -> Vector{Symbol}\n\n\nSet states\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_x!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_x!","text":"set_x!(value::DynamicBranch, val::Float64) -> Any\n\n\nSet DynamicBranch x.\n\n\n\n\n\n","category":"method"},{"location":"how_to/reduce_repl_printing/#Reduce-REPL-printing","page":"...reduce REPL printing","title":"Reduce REPL printing","text":"","category":"section"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"By default PowerSystems.jl outputs to the REPL all Logging statements, which can be overwhelming in some cases.","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"Use configure_logging to create a logger with your preferences for which logging statements should be printed to the console or a log file:","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"Example: Set log output to only see error messages in the console","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"using PowerSystems\nusing Logging\nconfigure_logging(; console_level = Logging.Error)","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"Note: log messages are not automatically flushed to files. Call flush(logger) to make this happen.","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"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.","category":"page"},{"location":"how_to/improve_ts_performance/#Improve-Performance-with-Time-Series-Data","page":"...improve performance with time series data","title":"Improve Performance with Time Series Data","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"Use the steps here to improve performance with small or large data sets, but particularly large data sets. These improvements can help handle adding large numbers of data sets or reduce overhead when accessing time series data multiple times.","category":"page"},{"location":"how_to/improve_ts_performance/#Choosing-the-Storage-Location","page":"...improve performance with time series data","title":"Choosing the Storage Location","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"By default, time series data is stored in an HDF5 file in the tmp file system to prevent large datasets from overwhelming system memory. However, you can change its location.","category":"page"},{"location":"how_to/improve_ts_performance/#Small-data-sets","page":"...improve performance with time series data","title":"Small data sets","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"If your dataset will fit in your computer's memory, then you can increase performance by storing it in memory:","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"sys = System(100.0; time_series_in_memory = true)","category":"page"},{"location":"how_to/improve_ts_performance/#Large-data-sets","page":"...improve performance with time series data","title":"Large data sets","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"If the system's time series data will be larger than the amount of tmp space available, use the time_series_directory parameter to change its location.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"sys = System(100.0; time_series_directory = \"bigger_directory\")","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"You can also override the location by setting the environment variable SIENNA_TIME_SERIES_DIRECTORY to another directory.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"HDF5 compression is not enabled by default, but you can enable it with enable_compression to get significant storage savings at the cost of CPU time. CompressionSettings can be used to customize the HDF5 compression.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"sys = System(100.0; enable_compression = true)\nsys = System(\n 100.0;\n compression = CompressionSettings(;\n enabled = true,\n type = CompressionTypes.DEFLATE, # BLOSC is also supported\n level = 3,\n shuffle = true,\n ),\n)","category":"page"},{"location":"how_to/improve_ts_performance/#Adding-Timeseries-To-The-System","page":"...improve performance with time series data","title":"Adding Timeseries To The System","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"In order to optimize the storage of time series data, time series can be shared across devices to avoid duplication. If the same forecast applies to multiple components then can call add_time_series!, passing the collection of components that share the time series data. Time series data can also be shared on a component level. Suppose a time series array applies to both the max_active_power and max_reactive_power attributes of a generator. You can share the data.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"resolution = Dates.Hour(1)\ndata = Dict(\n DateTime(\"2020-01-01T00:00:00\") => ones(24),\n DateTime(\"2020-01-01T01:00:00\") => ones(24),\n)\n# Define a Deterministic for the first attribute\nforecast_max_active_power = Deterministic(\n \"max_active_power\",\n data,\n resolution;\n scaling_factor_multiplier = get_max_active_power,\n)\nadd_time_series!(sys, generator, forecast_max_active_power)\n# Reuse time series for second attribute\nforecast_max_reactive_power = Deterministic(\n forecast_max_active_power,\n \"max_reactive_power\";\n scaling_factor_multiplier = get_max_reactive_power,\n)\nadd_time_series!(sys, generator, forecast_max_reactive_power)","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"By default, the call to add_time_series! will open the HDF5 file, write the data to the file, and close the file. It will also add a row to an SQLite database. These operations have overhead. If you will add thousands of time series arrays, consider using bulk_add_time_series!. All arrays will be written with one file handle. The bulk SQLite operations are much more efficient. As a fallback option, use open_time_series_store! if timeseries must be added one at a time.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"# Assumes `read_time_series` will return data appropriate for Deterministic forecasts\n# based on the generator name and the filenames match the component and time series names.\nresolution = Dates.Hour(1)\nassociations = (\n IS.TimeSeriesAssociation(\n gen,\n Deterministic(;\n data = read_time_series(get_name(gen) * \".csv\"),\n name = \"get_max_active_power\",\n resolution = resolution),\n )\n for gen in get_components(ThermalStandard, sys)\n)\nbulk_add_time_series!(sys, associations)","category":"page"},{"location":"how_to/improve_ts_performance/#Using-Forecast-Caches-for-Simulations","page":"...improve performance with time series data","title":"Using Forecast Caches for Simulations","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"Each retrieval of a forecast window from the HDF5 file will involve a small disk read. In the case of production cost modeling or other analyses that access forecast windows repeatedly, this can slow down processes significantly, especially if the underlying storage uses spinning disks.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"PowerSystems provides an alternate interface – the forecast cache – that pre-fetches data into the system memory with large reads in order to mitigate this potential problem. It is highly recommended that you use this interface for modeling implementations. This is particularly relevant for models using large datasets. For example:","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"cache = ForecastCache(Deterministic, component, \"max_active_power\")\nwindow1 = get_next_time_series_array!(cache)\nwindow2 = get_next_time_series_array!(cache)\n# or\nfor window in cache\n @show window\nend","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"Each iteration of on the cache object will deliver the next forecast window (see get_next_time_series_array!).","category":"page"},{"location":"how_to/parse_ts_from_csvs/#parsing_time_series","page":"...parse time series data from .csv files","title":"Parse Time Series Data from .csv's","text":"","category":"section"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"This example shows how to parse time series data from .csv files to add to a System. For example, a System created by parsing a MATPOWER file doesn't contain any time series data, so a user may want to add time series to be able to run a production cost model.","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"using PowerSystems\nusing JSON3\n\nfile_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"tutorials_data\"); #hide\nsys = System(joinpath(file_dir, \"case5_re.m\"));","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"Let's use a predefined 5-bus System with some renewable generators and loads that we want to add time-series data to:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"sys","category":"page"},{"location":"how_to/parse_ts_from_csvs/#Define-pointers-to-time-series-files","page":"...parse time series data from .csv files","title":"Define pointers to time series files","text":"","category":"section"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"PowerSystems requires a metadata file that maps components to their time series data in order to be able to automatically construct time_series from .csv data files.","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"For example, if we want to add a bunch of time series files, say one for each load and one for each renewable generator, we need to define pointers to each time series .csv file with the following fields:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"simulation: User description of simulation\nresolution: Resolution of time series in seconds\nmodule: Module that defines the abstract type of the component\ncategory: Type of component. Must map to abstract types defined by the \"module\" entry (Bus, ElectricLoad, Generator, LoadZone, Reserve)\ncomponent_name: Name of component\nname: User-defined name for the time series data.\nnormalization_factor: Controls normalization of the data. Use 1.0 for pre-normalized data. Use 'Max' to divide the time series by the max value in the column. Use any float for a custom scaling factor.\nscaling_factor_multiplier_module: Module that defines the accessor function for the scaling factor\nscaling_factor_multiplier: Accessor function of the scaling factor\ndata_file: Path to the time series data file","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"Notes:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"The module, category, and component_name entries must be valid arguments to retrieve a component using get_component(${module}.${category}, sys, $name).\nThe scaling_factor_multiplier_module and the scaling_factor_multiplier entries must be sufficient to return the scaling factor data using ${scaling_factor_multiplier_module}.${scaling_factor_multiplier}(component).","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"PowerSystems supports this metadata in either CSV or JSON formats.","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"In this example, we will use the JSON format. The example file can be found here, and this is what its pointers look like in the required format:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"using PowerSystemCaseBuilder #hide\nDATA_DIR = PowerSystemCaseBuilder.DATA_DIR #hide\nFORECASTS_DIR = joinpath(DATA_DIR, \"5-Bus\", \"5bus_ts\"); #hide\nfname = joinpath(FORECASTS_DIR, \"timeseries_pointers_da.json\"); # hide\nopen(fname, \"r\") do f # hide\n JSON3.@pretty JSON3.read(f) # hide\nend #hide","category":"page"},{"location":"how_to/parse_ts_from_csvs/#Read-and-assign-time-series-to-System-using-these-parameters.","page":"...parse time series data from .csv files","title":"Read and assign time series to System using these parameters.","text":"","category":"section"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"fname = joinpath(FORECASTS_DIR, \"timeseries_pointers_da.json\")\nadd_time_series!(sys, fname)","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"You can print the System to see a new table summarizing the time series data that has been added:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"sys","category":"page"},{"location":"how_to/parse_ts_from_csvs/#See-also:","page":"...parse time series data from .csv files","title":"See also:","text":"","category":"section"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"Improve Performance with Time Series Data\nParsing Matpower or PSS/e RAW Files\nParsing PSS/e DYR Files\nParsing table data (CSV Files)","category":"page"},{"location":"api/citation/#Citation","page":"Citation","title":"Citation","text":"","category":"section"},{"location":"api/citation/","page":"Citation","title":"Citation","text":"Users are requested to please cite the following paper:","category":"page"},{"location":"api/citation/","page":"Citation","title":"Citation","text":"@article{LARA2021100747,\ntitle = {PowerSystems.jl — A power system data management package for large scale modeling},\njournal = {SoftwareX},\nvolume = {15},\npages = {100747},\nyear = {2021},\nissn = {2352-7110},\ndoi = {https://doi.org/10.1016/j.softx.2021.100747},\nurl = {https://www.sciencedirect.com/science/article/pii/S2352711021000765},\nauthor = {José Daniel Lara and Clayton Barrows and Daniel Thom and Dheepak Krishnamurthy and Duncan Callaway},\nkeywords = {Power Systems, Julia, Energy},","category":"page"},{"location":"api/citation/","page":"Citation","title":"Citation","text":"PowerSystems has been developed as part of the Sienna platform by the U.S. Department of Energy's National Renewable Energy Laboratory (NREL).","category":"page"},{"location":"model_library/generated_AreaInterchange/#AreaInterchange","page":"AreaInterchange","title":"AreaInterchange","text":"","category":"section"},{"location":"model_library/generated_AreaInterchange/","page":"AreaInterchange","title":"AreaInterchange","text":"Modules = [PowerSystems]\nPages = [\"generated/AreaInterchange.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.AreaInterchange","page":"AreaInterchange","title":"PowerSystems.AreaInterchange","text":"mutable struct AreaInterchange <: Branch\n name::String\n available::Bool\n active_power_flow::Float64\n from_area::Area\n to_area::Area\n flow_limits::FromTo_ToFrom\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nFlow 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\nfrom_area::Area: Area from which the power is extracted\nto_area::Area: Area to which the power is injected\nflow_limits::FromTo_ToFrom: Max flow between the areas. It ignores lines and other branches totals\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AreaInterchange/#InfrastructureSystems.get_name-Tuple{AreaInterchange}","page":"AreaInterchange","title":"InfrastructureSystems.get_name","text":"get_name(value::AreaInterchange) -> String\n\n\nGet AreaInterchange name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_active_power_flow-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::AreaInterchange) -> Any\n\n\nGet AreaInterchange active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_available-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_available","text":"get_available(value::AreaInterchange) -> Bool\n\n\nGet AreaInterchange available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_ext-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_ext","text":"get_ext(value::AreaInterchange) -> Dict{String, Any}\n\n\nGet AreaInterchange ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_flow_limits-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_flow_limits","text":"get_flow_limits(\n value::AreaInterchange\n) -> NamedTuple{(:from_to, :to_from), <:Tuple{Any, Any}}\n\n\nGet AreaInterchange flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_from_area-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_from_area","text":"get_from_area(value::AreaInterchange) -> Area\n\n\nGet AreaInterchange from_area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_to_area-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_to_area","text":"get_to_area(value::AreaInterchange) -> Area\n\n\nGet AreaInterchange to_area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_active_power_flow!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_available!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_available!","text":"set_available!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_ext!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_ext!","text":"set_ext!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_flow_limits!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_flow_limits!","text":"set_flow_limits!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_from_area!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_from_area!","text":"set_from_area!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange from_area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_to_area!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_to_area!","text":"set_to_area!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange to_area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TurbineGov","page":"TurbineGov","title":"TurbineGov","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/#DEGOV","page":"TurbineGov","title":"DEGOV","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/DEGOV.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.DEGOV","page":"TurbineGov","title":"PowerSystems.DEGOV","text":"mutable struct DEGOV <: TurbineGov\n T1::Float64\n T2::Float64\n T3::Float64\n K::Float64\n T4::Float64\n T5::Float64\n T6::Float64\n Td::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters Woodward Diesel Governor Model. DEGOV in PowerWorld\n\nArguments\n\nT1::Float64: Governor mechanism time constant, validation range: (eps(), 100)\nT2::Float64: Turbine power time constant, validation range: (eps(), 100)\nT3::Float64: Turbine exhaust temperature time constant, validation range: (eps(), 100)\nK::Float64: Governor gain (reciprocal of droop), validation range: (eps(), 100)\nT4::Float64: Governor lead time constant, validation range: (eps(), 100)\nT5::Float64: Governor lag time constant, validation range: (eps(), 100)\nT6::Float64: Actuator time constant, validation range: (eps(), 100)\nTd::Float64: Engine time delay, validation range: (eps(), 100)\nP_ref::Float64: (default: 1.0) Reference Load Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the DEGOV model are:\n\nx_ecb1: Electric control box 1,\nx_ecb2: Electric control box 2,\nx_a1: Actuator 1,\nx_a2: Actuator 2,\nx_a3: Actuator 3,\n\nn_states::Int: (Do not modify.) DEGOV has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) DEGOV has 5 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_K","text":"get_K(value::DEGOV) -> Float64\n\n\nGet DEGOV K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::DEGOV) -> Float64\n\n\nGet DEGOV P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::DEGOV) -> Float64\n\n\nGet DEGOV T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::DEGOV) -> Float64\n\n\nGet DEGOV T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::DEGOV) -> Float64\n\n\nGet DEGOV T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T4-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T4","text":"get_T4(value::DEGOV) -> Float64\n\n\nGet DEGOV T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T5-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T5","text":"get_T5(value::DEGOV) -> Float64\n\n\nGet DEGOV T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T6-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T6","text":"get_T6(value::DEGOV) -> Float64\n\n\nGet DEGOV T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Td-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_Td","text":"get_Td(value::DEGOV) -> Float64\n\n\nGet DEGOV Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::DEGOV) -> Dict{String, Any}\n\n\nGet DEGOV ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::DEGOV) -> Int64\n\n\nGet DEGOV n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::DEGOV) -> Vector{Symbol}\n\n\nGet DEGOV states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(value::DEGOV) -> Vector{StateTypes}\n\n\nGet DEGOV states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_K!","text":"set_K!(value::DEGOV, val) -> Any\n\n\nSet DEGOV K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::DEGOV, val) -> Any\n\n\nSet DEGOV P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T4!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T4!","text":"set_T4!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T5!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T5!","text":"set_T5!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T6!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T6!","text":"set_T6!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Td!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Td!","text":"set_Td!(value::DEGOV, val) -> Any\n\n\nSet DEGOV Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::DEGOV, val) -> Any\n\n\nSet DEGOV ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::DEGOV, val) -> Any\n\n\nSet DEGOV states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#DEGOV1","page":"TurbineGov","title":"DEGOV1","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/DEGOV1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.DEGOV1","page":"TurbineGov","title":"PowerSystems.DEGOV1","text":"mutable struct DEGOV1 <: TurbineGov\n droop_flag::Int\n T1::Float64\n T2::Float64\n T3::Float64\n K::Float64\n T4::Float64\n T5::Float64\n T6::Float64\n Td::Float64\n T_lim::Tuple{Float64, Float64}\n R::Float64\n Te::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters Woodward Diesel Governor Model. DEGOV1 in PSSE\n\nArguments\n\ndroop_flag::Int: Droop control Flag. 0 for throttle feedback and 1 for electric power feedback, validation range: (0, 1)\nT1::Float64: Governor mechanism time constant in s, validation range: (0, 100)\nT2::Float64: Turbine power time constant in s, validation range: (0, 100)\nT3::Float64: Turbine exhaust temperature time constant in s, validation range: (0, 100)\nK::Float64: Governor gain for actuator, validation range: (0, 100)\nT4::Float64: Governor lead time constant in s, validation range: (0, 100)\nT5::Float64: Governor lag time constant in s, validation range: (0, 100)\nT6::Float64: Actuator time constant in s, validation range: (0, 100)\nTd::Float64: Engine time delay in s, validation range: (0, 100)\nT_lim::Tuple{Float64, Float64}: Operational control limits on actuator (Tmin, Tmax)\nR::Float64: Steady state droop parameter, validation range: (0, 100)\nTe::Float64: Power transducer time constant in s, validation range: (0, 100)\nP_ref::Float64: (default: 1.0) Reference Load Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the DEGOV1 model depends on the droop flag\nn_states::Int: (Do not modify.) The number of states of the DEGOV1 model depends on the droop flag\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_K","text":"get_K(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T4-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T4","text":"get_T4(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T5-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T5","text":"get_T5(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T6-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T6","text":"get_T6(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_lim-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T_lim","text":"get_T_lim(value::DEGOV1) -> Tuple{Float64, Float64}\n\n\nGet DEGOV1 T_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Td-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_Td","text":"get_Td(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Te-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_Te","text":"get_Te(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_droop_flag-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_droop_flag","text":"get_droop_flag(value::DEGOV1) -> Int64\n\n\nGet DEGOV1 droop_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::DEGOV1) -> Dict{String, Any}\n\n\nGet DEGOV1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::DEGOV1) -> Int64\n\n\nGet DEGOV1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::DEGOV1) -> Vector{Symbol}\n\n\nGet DEGOV1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_K!","text":"set_K!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T4!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T4!","text":"set_T4!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T5!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T5!","text":"set_T5!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T6!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T6!","text":"set_T6!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_lim!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T_lim!","text":"set_T_lim!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Td!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_Td!","text":"set_Td!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Te!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_Te!","text":"set_Te!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_droop_flag!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_droop_flag!","text":"set_droop_flag!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 droop_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#GasTG","page":"TurbineGov","title":"GasTG","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/GasTG.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.GasTG","page":"TurbineGov","title":"PowerSystems.GasTG","text":"mutable struct GasTG <: TurbineGov\n R::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n AT::Float64\n Kt::Float64\n V_lim::Tuple{Float64, Float64}\n D_turb::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of Gas Turbine-Governor. GAST in PSSE and GAST_PTI in PowerWorld\n\nArguments\n\nR::Float64: Speed droop parameter, validation range: (eps(), 0.1)\nT1::Float64: Governor time constant in s, validation range: (eps(), 0.5)\nT2::Float64: Combustion chamber time constant, validation range: (eps(), 0.5)\nT3::Float64: Load limit time constant (exhaust gas measurement time), validation range: (eps(), 5)\nAT::Float64: Ambient temperature load limit, validation range: (0, 1)\nKt::Float64: Load limit feedback gain, validation range: (0, 5)\nV_lim::Tuple{Float64, Float64}: Operational control limits on fuel valve opening (Vmin, Vmax)\nD_turb::Float64: Speed damping coefficient of gas turbine rotor, validation range: (0, 0.5)\nP_ref::Float64: (default: 1.0) Reference Load Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the GAST model are:\n\nx_g1: Fuel valve opening,\nx_g2: Fuel flow,\nx_g3: Exhaust temperature load\n\nn_states::Int: (Do not modify.) GasTG has 3 states\nstates_types::Vector{StateTypes}: (Do not modify.) GAST has 3 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_AT-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_AT","text":"get_AT(value::GasTG) -> Float64\n\n\nGet GasTG AT.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D_turb-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_D_turb","text":"get_D_turb(value::GasTG) -> Float64\n\n\nGet GasTG D_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kt-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_Kt","text":"get_Kt(value::GasTG) -> Float64\n\n\nGet GasTG Kt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::GasTG) -> Float64\n\n\nGet GasTG P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::GasTG) -> Float64\n\n\nGet GasTG R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::GasTG) -> Float64\n\n\nGet GasTG T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::GasTG) -> Float64\n\n\nGet GasTG T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::GasTG) -> Float64\n\n\nGet GasTG T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_V_lim-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_V_lim","text":"get_V_lim(value::GasTG) -> Tuple{Float64, Float64}\n\n\nGet GasTG V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::GasTG) -> Dict{String, Any}\n\n\nGet GasTG ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::GasTG) -> Int64\n\n\nGet GasTG n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::GasTG) -> Vector{Symbol}\n\n\nGet GasTG states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(value::GasTG) -> Vector{StateTypes}\n\n\nGet GasTG states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_AT!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_AT!","text":"set_AT!(value::GasTG, val) -> Any\n\n\nSet GasTG AT.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D_turb!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_D_turb!","text":"set_D_turb!(value::GasTG, val) -> Any\n\n\nSet GasTG D_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kt!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_Kt!","text":"set_Kt!(value::GasTG, val) -> Any\n\n\nSet GasTG Kt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::GasTG, val) -> Any\n\n\nSet GasTG P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::GasTG, val) -> Any\n\n\nSet GasTG R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::GasTG, val) -> Any\n\n\nSet GasTG T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::GasTG, val) -> Any\n\n\nSet GasTG T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::GasTG, val) -> Any\n\n\nSet GasTG T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_V_lim!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::GasTG, val) -> Any\n\n\nSet GasTG V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::GasTG, val) -> Any\n\n\nSet GasTG ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::GasTG, val) -> Any\n\n\nSet GasTG states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#GeneralGovModel","page":"TurbineGov","title":"GeneralGovModel","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/GeneralGovModel.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.GeneralGovModel","page":"TurbineGov","title":"PowerSystems.GeneralGovModel","text":"mutable struct GeneralGovModel <: TurbineGov\n Rselect::Int\n fuel_flag::Int\n R::Float64\n Tpelec::Float64\n speed_error_signal::MinMax\n Kp_gov::Float64\n Ki_gov::Float64\n Kd_gov::Float64\n Td_gov::Float64\n valve_position_limits::MinMax\n T_act::Float64\n K_turb::Float64\n Wf_nl::Float64\n Tb::Float64\n Tc::Float64\n T_eng::Float64\n Tf_load::Float64\n Kp_load::Float64\n Ki_load::Float64\n Ld_ref::Float64\n Dm::Float64\n R_open::Float64\n R_close::Float64\n Ki_mw::Float64\n A_set::Float64\n Ka::Float64\n Ta::Float64\n T_rate::Float64\n db::Float64\n Tsa::Float64\n Tsb::Float64\n R_lim::UpDown\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nGE General Governor/Turbine Model. The GeneralGovModel (GGOV1) model is a general purpose governor model used for a variety of prime movers controlled by proportional-integral-derivative (PID) governors including gas turbines\n\nArguments\n\nRselect::Int: Feedback signal for governor droop, validation range: (-2, 1)\nfuel_flag::Int: Flag Switch for fuel source characteristic, validation range: (0, 1)\nR::Float64: Speed droop parameter, validation range: (eps(), nothing)\nTpelec::Float64: Electrical power transducer time constant, seconds, validation range: (eps(), nothing)\nspeed_error_signal::MinMax: Speed error signal limits\nKp_gov::Float64: Governor proportional gain, validation range: (0, nothing)\nKi_gov::Float64: Governor integral gain, validation range: (0, nothing)\nKd_gov::Float64: Governor derivative gain, validation range: (0, nothing)\nTd_gov::Float64: Governor derivative time constant, validation range: (0, nothing)\nvalve_position_limits::MinMax: Valve position limits\nT_act::Float64: Actuator time constant, validation range: (0, nothing)\nK_turb::Float64: Turbine gain, validation range: (0, nothing)\nWf_nl::Float64: No load fuel flow, pu, validation range: (0, nothing)\nTb::Float64: Turbine lag time constant, sec, validation range: (0, nothing)\nTc::Float64: Turbine lead time constant, sec, validation range: (0, nothing)\nT_eng::Float64: Transport lag time constant for diesel engine, sec, validation range: (0, nothing)\nTf_load::Float64: Load limiter time constant, validation range: (0, nothing)\nKp_load::Float64: Load limiter proportional gain for PI controller, validation range: (0, nothing)\nKi_load::Float64: Load integral gain for PI controller, validation range: (0, nothing)\nLd_ref::Float64: Load limiter integral gain for PI controller, validation range: (0, nothing)\nDm::Float64: Mechanical damping coefficient, pu, validation range: (0, nothing)\nR_open::Float64: Maximum valve opening rate, pu/sec, validation range: (0, nothing)\nR_close::Float64: Maximum valve closing rate, pu/sec, validation range: (0, nothing)\nKi_mw::Float64: Power controller (reset) gain, validation range: (0, nothing)\nA_set::Float64: Acceleration limiter setpoint, pu/sec, validation range: (0, nothing)\nKa::Float64: Acceleration limiter gain, validation range: (0, nothing)\nTa::Float64: Acceleration limiter time constant , validation range: (eps(), nothing)\nT_rate::Float64: Turbine rating, validation range: (0, nothing)\ndb::Float64: Speed governor deadband, validation range: (0, nothing)\nTsa::Float64: Temperature detection lead time constant, validation range: (0, nothing)\nTsb::Float64: Temperature detection lag time constant, validation range: (0, nothing)\nR_lim::UpDown: Maximum rate of load increase\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the GGOV1 model are:\n\nPe: Machine Electrical Power Measurement,\nx_g1: Governor differential control,\nx_g2: Governor integral control, \nx_g3: Turbine actuator, \nx_g4: Turbine Lead-Lag, \nx_g5: Turbine load limiter measurement, \nx_g6: Turbine Load Limiter Integral Control, \nx_g7: Supervisory Load Control, \nx_g8: Acceleration Control, \nx_g9 Temperature Detection Lead - Lag:\n\nn_states::Int: (Do not modify.) GeneralGovModel has 10 states\nstates_types::Vector{StateTypes}: (Do not modify.) GGOV1 has 10 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_A_set-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_A_set","text":"get_A_set(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel A_set.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Dm-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Dm","text":"get_Dm(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Dm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K_turb-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_K_turb","text":"get_K_turb(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel K_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ka-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ka","text":"get_Ka(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kd_gov-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Kd_gov","text":"get_Kd_gov(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Kd_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki_gov-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ki_gov","text":"get_Ki_gov(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ki_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki_load-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ki_load","text":"get_Ki_load(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ki_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki_mw-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ki_mw","text":"get_Ki_mw(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ki_mw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kp_gov-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Kp_gov","text":"get_Kp_gov(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Kp_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kp_load-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Kp_load","text":"get_Kp_load(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Kp_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ld_ref-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ld_ref","text":"get_Ld_ref(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ld_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R_close-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_R_close","text":"get_R_close(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel R_close.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R_lim-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_R_lim","text":"get_R_lim(\n value::GeneralGovModel\n) -> @NamedTuple{up::Float64, down::Float64}\n\n\nGet GeneralGovModel R_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R_open-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_R_open","text":"get_R_open(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel R_open.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Rselect-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Rselect","text":"get_Rselect(value::GeneralGovModel) -> Int64\n\n\nGet GeneralGovModel Rselect.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_act-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_T_act","text":"get_T_act(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel T_act.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_eng-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_T_eng","text":"get_T_eng(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel T_eng.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_rate-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_T_rate","text":"get_T_rate(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel T_rate.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ta-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ta","text":"get_Ta(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tb-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tb","text":"get_Tb(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tc-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tc","text":"get_Tc(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Td_gov-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Td_gov","text":"get_Td_gov(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Td_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tf_load-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tf_load","text":"get_Tf_load(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tf_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tpelec-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tpelec","text":"get_Tpelec(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tpelec.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tsa-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tsa","text":"get_Tsa(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tsa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tsb-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tsb","text":"get_Tsb(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tsb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Wf_nl-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Wf_nl","text":"get_Wf_nl(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Wf_nl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_db-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_db","text":"get_db(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel db.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::GeneralGovModel) -> Dict{String, Any}\n\n\nGet GeneralGovModel ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_fuel_flag-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_fuel_flag","text":"get_fuel_flag(value::GeneralGovModel) -> Int64\n\n\nGet GeneralGovModel fuel_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::GeneralGovModel) -> Int64\n\n\nGet GeneralGovModel n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_speed_error_signal-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_speed_error_signal","text":"get_speed_error_signal(\n value::GeneralGovModel\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GeneralGovModel speed_error_signal.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::GeneralGovModel) -> Vector{Symbol}\n\n\nGet GeneralGovModel states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(\n value::GeneralGovModel\n) -> Vector{StateTypes}\n\n\nGet GeneralGovModel states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_valve_position_limits-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_valve_position_limits","text":"get_valve_position_limits(\n value::GeneralGovModel\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GeneralGovModel valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_A_set!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_A_set!","text":"set_A_set!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel A_set.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Dm!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Dm!","text":"set_Dm!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Dm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K_turb!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_K_turb!","text":"set_K_turb!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel K_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ka!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kd_gov!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Kd_gov!","text":"set_Kd_gov!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Kd_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki_gov!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki_gov!","text":"set_Ki_gov!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ki_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki_load!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki_load!","text":"set_Ki_load!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ki_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki_mw!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki_mw!","text":"set_Ki_mw!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ki_mw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kp_gov!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Kp_gov!","text":"set_Kp_gov!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Kp_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kp_load!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Kp_load!","text":"set_Kp_load!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Kp_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ld_ref!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ld_ref!","text":"set_Ld_ref!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ld_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R_close!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_R_close!","text":"set_R_close!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel R_close.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R_lim!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_R_lim!","text":"set_R_lim!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel R_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R_open!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_R_open!","text":"set_R_open!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel R_open.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Rselect!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Rselect!","text":"set_Rselect!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Rselect.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_act!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_T_act!","text":"set_T_act!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel T_act.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_eng!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_T_eng!","text":"set_T_eng!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel T_eng.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_rate!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_T_rate!","text":"set_T_rate!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel T_rate.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ta!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tb!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tc!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Td_gov!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Td_gov!","text":"set_Td_gov!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Td_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tf_load!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tf_load!","text":"set_Tf_load!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tf_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tpelec!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tpelec!","text":"set_Tpelec!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tpelec.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tsa!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tsa!","text":"set_Tsa!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tsa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tsb!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tsb!","text":"set_Tsb!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tsb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Wf_nl!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Wf_nl!","text":"set_Wf_nl!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Wf_nl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_db!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_db!","text":"set_db!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel db.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_fuel_flag!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_fuel_flag!","text":"set_fuel_flag!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel fuel_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_speed_error_signal!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_speed_error_signal!","text":"set_speed_error_signal!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel speed_error_signal.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_valve_position_limits!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_valve_position_limits!","text":"set_valve_position_limits!(\n value::GeneralGovModel,\n val\n) -> Any\n\n\nSet GeneralGovModel valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#HydroTurbineGov","page":"TurbineGov","title":"HydroTurbineGov","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/HydroTurbineGov.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.HydroTurbineGov","page":"TurbineGov","title":"PowerSystems.HydroTurbineGov","text":"mutable struct HydroTurbineGov <: TurbineGov\n R::Float64\n r::Float64\n Tr::Float64\n Tf::Float64\n Tg::Float64\n VELM::Float64\n gate_position_limits::MinMax\n Tw::Float64\n At::Float64\n D_T::Float64\n q_nl::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nHydro Turbine-Governor\n\nArguments\n\nR::Float64: Permanent droop parameter, validation range: (0, 0.1)\nr::Float64: Temporary Droop, validation range: (0, 2)\nTr::Float64: Governor time constant, validation range: (eps(), 30)\nTf::Float64: Filter Time constant, validation range: (eps(), 0.1)\nTg::Float64: Servo time constant, validation range: (eps(), 1)\nVELM::Float64: gate velocity limit, validation range: (eps(), 0.3)\ngate_position_limits::MinMax: Gate position limits\nTw::Float64: water time constant, validation range: (eps(), 3)\nAt::Float64: Turbine gain, validation range: (0.8, 1.5)\nD_T::Float64: Turbine Damping, validation range: (0, 0.5)\nq_nl::Float64: No-power flow, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the HydroTurbineGov model are:\n\nx_g1: filter_output,\nx_g2: desired gate, \nx_g3: gate opening, \nx_g4: turbine flow\n\nn_states::Int: (Do not modify.) HYGOV has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) HYGOV has 4 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_At-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_At","text":"get_At(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov At.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D_T-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_D_T","text":"get_D_T(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov D_T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tf-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_Tf","text":"get_Tf(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tg-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_Tg","text":"get_Tg(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tr-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_Tr","text":"get_Tr(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tw-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_Tw","text":"get_Tw(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_VELM-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_VELM","text":"get_VELM(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov VELM.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::HydroTurbineGov) -> Dict{String, Any}\n\n\nGet HydroTurbineGov ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_gate_position_limits-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_gate_position_limits","text":"get_gate_position_limits(\n value::HydroTurbineGov\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet HydroTurbineGov gate_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::HydroTurbineGov) -> Int64\n\n\nGet HydroTurbineGov n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_q_nl-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_q_nl","text":"get_q_nl(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov q_nl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_r-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_r","text":"get_r(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::HydroTurbineGov) -> Vector{Symbol}\n\n\nGet HydroTurbineGov states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(\n value::HydroTurbineGov\n) -> Vector{StateTypes}\n\n\nGet HydroTurbineGov states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_At!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_At!","text":"set_At!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov At.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D_T!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_D_T!","text":"set_D_T!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov D_T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tf!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tg!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_Tg!","text":"set_Tg!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tr!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tw!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_Tw!","text":"set_Tw!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_VELM!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_VELM!","text":"set_VELM!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov VELM.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_gate_position_limits!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_gate_position_limits!","text":"set_gate_position_limits!(\n value::HydroTurbineGov,\n val\n) -> Any\n\n\nSet HydroTurbineGov gate_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_q_nl!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_q_nl!","text":"set_q_nl!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov q_nl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_r!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_r!","text":"set_r!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#IEEETurbineGov1","page":"TurbineGov","title":"IEEETurbineGov1","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/IEEETurbineGov1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.IEEETurbineGov1","page":"TurbineGov","title":"PowerSystems.IEEETurbineGov1","text":"mutable struct IEEETurbineGov1 <: TurbineGov\n K::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n U0::Float64\n U_c::Float64\n valve_position_limits::MinMax\n T4::Float64\n K1::Float64\n K2::Float64\n T5::Float64\n K3::Float64\n K4::Float64\n T6::Float64\n K5::Float64\n K6::Float64\n T7::Float64\n K7::Float64\n K8::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Type 1 Speed-Governing Model\n\nArguments\n\nK::Float64: Governor Gain, validation range: (5, 30)\nT1::Float64: Input Filter Lag, validation range: (0, 5)\nT2::Float64: Input Filter Lead, validation range: (0, 10)\nT3::Float64: Valve position Time Constant, validation range: (eps(), 1)\nU0::Float64: Maximum Valve Opening Rate, validation range: (0.01, 0.03)\nU_c::Float64: Maximum Valve closing rate, validation range: (-0.3, 0)\nvalve_position_limits::MinMax: Valve position limits in MW\nT4::Float64: Time Constant inlet steam, validation range: (0, 1)\nK1::Float64: Fraction of high presure shaft power, validation range: (-2, 1)\nK2::Float64: Fraction of low presure shaft power, validation range: (0, nothing)\nT5::Float64: Time constant for second boiler pass, validation range: (0, 10)\nK3::Float64: Fraction of high presure shaft power second boiler pass, validation range: (0, 0.5)\nK4::Float64: Fraction of low presure shaft power second boiler pass, validation range: (0, 0.5)\nT6::Float64: Time constant for third boiler pass, validation range: (0, 10)\nK5::Float64: Fraction of high presure shaft power third boiler pass, validation range: (0, 0.35)\nK6::Float64: Fraction of low presure shaft power third boiler pass, validation range: (0, 0.55)\nT7::Float64: Time constant for fourth boiler pass, validation range: (0, 10)\nK7::Float64: Fraction of high presure shaft power fourth boiler pass, validation range: (0, 0.3)\nK8::Float64: Fraction of low presure shaft power fourth boiler pass, validation range: (0, 0.3)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the IEEETurbineGov model are:\n\nx_g1: First Governor integrator,\nx_g2: Governor output,\nx_g3: First Turbine integrator, \nx_g4: Second Turbine Integrator, \nx_g5: Third Turbine Integrator, \nx_g6: Fourth Turbine Integrator,\n\nn_states::Int: (Do not modify.) IEEEG1 has 6 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEG1 has 6 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K","text":"get_K(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K1-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K1","text":"get_K1(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K2-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K2","text":"get_K2(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K3-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K3","text":"get_K3(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K4-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K4","text":"get_K4(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K5-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K5","text":"get_K5(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K6-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K6","text":"get_K6(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K7-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K7","text":"get_K7(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K8-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K8","text":"get_K8(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T4-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T4","text":"get_T4(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T5-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T5","text":"get_T5(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T6-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T6","text":"get_T6(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T7-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T7","text":"get_T7(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_U0-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_U0","text":"get_U0(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 U0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_U_c-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_U_c","text":"get_U_c(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 U_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::IEEETurbineGov1) -> Dict{String, Any}\n\n\nGet IEEETurbineGov1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::IEEETurbineGov1) -> Int64\n\n\nGet IEEETurbineGov1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::IEEETurbineGov1) -> Vector{Symbol}\n\n\nGet IEEETurbineGov1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(\n value::IEEETurbineGov1\n) -> Vector{StateTypes}\n\n\nGet IEEETurbineGov1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_valve_position_limits-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_valve_position_limits","text":"get_valve_position_limits(\n value::IEEETurbineGov1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet IEEETurbineGov1 valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K!","text":"set_K!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K1!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K1!","text":"set_K1!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K2!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K2!","text":"set_K2!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K3!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K3!","text":"set_K3!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K4!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K4!","text":"set_K4!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K5!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K5!","text":"set_K5!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K6!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K6!","text":"set_K6!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K7!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K7!","text":"set_K7!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K8!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K8!","text":"set_K8!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T4!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T4!","text":"set_T4!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T5!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T5!","text":"set_T5!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T6!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T6!","text":"set_T6!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T7!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T7!","text":"set_T7!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_U0!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_U0!","text":"set_U0!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 U0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_U_c!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_U_c!","text":"set_U_c!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 U_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_valve_position_limits!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_valve_position_limits!","text":"set_valve_position_limits!(\n value::IEEETurbineGov1,\n val\n) -> Any\n\n\nSet IEEETurbineGov1 valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PIDGOV","page":"TurbineGov","title":"PIDGOV","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/PIDGOV.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.PIDGOV","page":"TurbineGov","title":"PowerSystems.PIDGOV","text":"mutable struct PIDGOV <: TurbineGov\n feedback_flag::Int\n Rperm::Float64\n T_reg::Float64\n Kp::Float64\n Ki::Float64\n Kd::Float64\n Ta::Float64\n Tb::Float64\n D_turb::Float64\n gate_openings::Tuple{Float64, Float64, Float64}\n power_gate_openings::Tuple{Float64, Float64, Float64}\n G_lim::MinMax\n A_tw::Float64\n Tw::Float64\n V_lim::MinMax\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nHydro Turbine-Governor with PID controller.\n\nArguments\n\nfeedback_flag::Int: Feedback signal for governor droop: 0 for electrical power, and 1 for gate position., validation range: (0, 1)\nRperm::Float64: Speed permanent droop parameter, validation range: (0, nothing)\nT_reg::Float64: Speed detector time constant, validation range: (0, nothing)\nKp::Float64: Governor proportional gain, validation range: (0, nothing)\nKi::Float64: Governor integral gain, validation range: (0, nothing)\nKd::Float64: Governor derivative gain, validation range: (0, nothing)\nTa::Float64: Governor derivative time constant, validation range: (0, nothing)\nTb::Float64: Gate-servo time constant, validation range: (0, nothing)\nD_turb::Float64: Turbine damping factor, validation range: (0, nothing)\ngate_openings::Tuple{Float64, Float64, Float64}: Gate-opening speed at different loads\npower_gate_openings::Tuple{Float64, Float64, Float64}: Power at gate_openings\nG_lim::MinMax: Minimum/Maximum Gate openings (G_min, G_max).\nA_tw::Float64: Factor multiplying Tw, validation range: (eps(), nothing)\nTw::Float64: Water inertia time constant, sec, validation range: (eps(), nothing)\nV_lim::MinMax: Gate opening velocity limits (G_min, G_max).\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the PIDGOV model are:\n\nx_g1: Filtered input measurement,\nx_g2: PI block internal state,\nx_g3: First regulator state, \nx_g4: Derivative block internal state, \nx_g5: Second regulator state, \nx_g6: Gate position state, \nx_g7: Water inertia state\n\nn_states::Int: (Do not modify.) PIDGOV has 7 states\nstates_types::Vector{StateTypes}: (Do not modify.) PIDGOV has 7 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_A_tw-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_A_tw","text":"get_A_tw(value::PIDGOV) -> Float64\n\n\nGet PIDGOV A_tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D_turb-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_D_turb","text":"get_D_turb(value::PIDGOV) -> Float64\n\n\nGet PIDGOV D_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_G_lim-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_G_lim","text":"get_G_lim(\n value::PIDGOV\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet PIDGOV G_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kd-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Kd","text":"get_Kd(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Ki","text":"get_Ki(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kp-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Kp","text":"get_Kp(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::PIDGOV) -> Float64\n\n\nGet PIDGOV P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Rperm-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Rperm","text":"get_Rperm(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Rperm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_reg-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_T_reg","text":"get_T_reg(value::PIDGOV) -> Float64\n\n\nGet PIDGOV T_reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ta-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Ta","text":"get_Ta(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tb-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Tb","text":"get_Tb(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tw-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Tw","text":"get_Tw(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_V_lim-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_V_lim","text":"get_V_lim(\n value::PIDGOV\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet PIDGOV V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::PIDGOV) -> Dict{String, Any}\n\n\nGet PIDGOV ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_feedback_flag-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_feedback_flag","text":"get_feedback_flag(value::PIDGOV) -> Int64\n\n\nGet PIDGOV feedback_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_gate_openings-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_gate_openings","text":"get_gate_openings(\n value::PIDGOV\n) -> Tuple{Float64, Float64, Float64}\n\n\nGet PIDGOV gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::PIDGOV) -> Int64\n\n\nGet PIDGOV n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_power_gate_openings-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_power_gate_openings","text":"get_power_gate_openings(\n value::PIDGOV\n) -> Tuple{Float64, Float64, Float64}\n\n\nGet PIDGOV power_gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::PIDGOV) -> Vector{Symbol}\n\n\nGet PIDGOV states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(value::PIDGOV) -> Vector{StateTypes}\n\n\nGet PIDGOV states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_A_tw!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_A_tw!","text":"set_A_tw!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV A_tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D_turb!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_D_turb!","text":"set_D_turb!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV D_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_G_lim!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_G_lim!","text":"set_G_lim!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV G_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kd!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kp!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Rperm!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Rperm!","text":"set_Rperm!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Rperm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_reg!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T_reg!","text":"set_T_reg!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV T_reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ta!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tb!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tw!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Tw!","text":"set_Tw!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_V_lim!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_feedback_flag!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_feedback_flag!","text":"set_feedback_flag!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV feedback_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_gate_openings!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_gate_openings!","text":"set_gate_openings!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_power_gate_openings!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_power_gate_openings!","text":"set_power_gate_openings!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV power_gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#SteamTurbineGov1","page":"TurbineGov","title":"SteamTurbineGov1","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/SteamTurbineGov1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.SteamTurbineGov1","page":"TurbineGov","title":"PowerSystems.SteamTurbineGov1","text":"mutable struct SteamTurbineGov1 <: TurbineGov\n R::Float64\n T1::Float64\n valve_position_limits::MinMax\n T2::Float64\n T3::Float64\n D_T::Float64\n DB_h::Float64\n DB_l::Float64\n T_rate::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nSteam Turbine-Governor. This model considers both TGOV1 or TGOV1DU in PSS/E\n\nArguments\n\nR::Float64: Droop parameter, validation range: (0, 0.1)\nT1::Float64: Governor time constant, validation range: (eps(), 0.5)\nvalve_position_limits::MinMax: Valve position limits\nT2::Float64: Lead Lag Lead Time constant , validation range: (0, nothing)\nT3::Float64: Lead Lag Lag Time constant , validation range: (eps(), 10)\nD_T::Float64: Turbine Damping, validation range: (0, 0.5)\nDB_h::Float64: Deadband for overspeed, validation range: (0, nothing)\nDB_l::Float64: Deadband for underspeed, validation range: (nothing, 0)\nT_rate::Float64: Turbine Rate (MW). If zero, generator base is used, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the SteamTurbineGov1 model are:\n\nx_g1: Valve Opening,\nx_g2: Lead-lag state\n\nn_states::Int: (Do not modify.) TGOV1 has 2 states\nstates_types::Vector{StateTypes}: (Do not modify.) TGOV1 has 2 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_DB_h-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_DB_h","text":"get_DB_h(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 DB_h.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_DB_l-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_DB_l","text":"get_DB_l(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 DB_l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D_T-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_D_T","text":"get_D_T(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 D_T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_rate-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T_rate","text":"get_T_rate(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 T_rate.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::SteamTurbineGov1) -> Dict{String, Any}\n\n\nGet SteamTurbineGov1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::SteamTurbineGov1) -> Int64\n\n\nGet SteamTurbineGov1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::SteamTurbineGov1) -> Vector{Symbol}\n\n\nGet SteamTurbineGov1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(\n value::SteamTurbineGov1\n) -> Vector{StateTypes}\n\n\nGet SteamTurbineGov1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_valve_position_limits-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_valve_position_limits","text":"get_valve_position_limits(\n value::SteamTurbineGov1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet SteamTurbineGov1 valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_DB_h!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_DB_h!","text":"set_DB_h!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 DB_h.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_DB_l!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_DB_l!","text":"set_DB_l!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 DB_l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D_T!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_D_T!","text":"set_D_T!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 D_T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_rate!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T_rate!","text":"set_T_rate!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 T_rate.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_valve_position_limits!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_valve_position_limits!","text":"set_valve_position_limits!(\n value::SteamTurbineGov1,\n val\n) -> Any\n\n\nSet SteamTurbineGov1 valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TGFixed","page":"TurbineGov","title":"TGFixed","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/TGFixed.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.TGFixed","page":"TurbineGov","title":"PowerSystems.TGFixed","text":"mutable struct TGFixed <: TurbineGov\n efficiency::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a fixed Turbine Governor that returns a fixed mechanical torque given by the product of P_ref*efficiency\n\nArguments\n\nefficiency::Float64: Efficiency factor that multiplies P_ref, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) TGFixed has no states\nn_states::Int: (Do not modify.) TGFixed has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::TGFixed) -> Float64\n\n\nGet TGFixed P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_efficiency-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_efficiency","text":"get_efficiency(value::TGFixed) -> Float64\n\n\nGet TGFixed efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::TGFixed) -> Dict{String, Any}\n\n\nGet TGFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::TGFixed) -> Int64\n\n\nGet TGFixed n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::TGFixed) -> Vector{Symbol}\n\n\nGet TGFixed states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{TGFixed, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::TGFixed, val) -> Any\n\n\nSet TGFixed P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_efficiency!-Tuple{TGFixed, Any}","page":"TurbineGov","title":"PowerSystems.set_efficiency!","text":"set_efficiency!(value::TGFixed, val) -> Any\n\n\nSet TGFixed efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{TGFixed, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::TGFixed, val) -> Any\n\n\nSet TGFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TGSimple","page":"TurbineGov","title":"TGSimple","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/TGSimple.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.TGSimple","page":"TurbineGov","title":"PowerSystems.TGSimple","text":"mutable struct TGSimple <: TurbineGov\n d_t::Float64\n Tm::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Simple one-state Turbine Governor\n\nArguments\n\nd_t::Float64: Inverse Droop parameter, validation range: (0, nothing)\nTm::Float64: Turbine Governor Low-Pass Time Constant [s], validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the TGSimple model are:\n\nτm: mechanical torque\n\nn_states::Int: (Do not modify.) TGSimple has 1 state\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::TGSimple) -> Float64\n\n\nGet TGSimple P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tm-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_Tm","text":"get_Tm(value::TGSimple) -> Float64\n\n\nGet TGSimple Tm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_d_t-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_d_t","text":"get_d_t(value::TGSimple) -> Float64\n\n\nGet TGSimple d_t.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::TGSimple) -> Dict{String, Any}\n\n\nGet TGSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::TGSimple) -> Int64\n\n\nGet TGSimple n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::TGSimple) -> Vector{Symbol}\n\n\nGet TGSimple states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{TGSimple, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::TGSimple, val) -> Any\n\n\nSet TGSimple P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tm!-Tuple{TGSimple, Any}","page":"TurbineGov","title":"PowerSystems.set_Tm!","text":"set_Tm!(value::TGSimple, val) -> Any\n\n\nSet TGSimple Tm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_d_t!-Tuple{TGSimple, Any}","page":"TurbineGov","title":"PowerSystems.set_d_t!","text":"set_d_t!(value::TGSimple, val) -> Any\n\n\nSet TGSimple d_t.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{TGSimple, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::TGSimple, val) -> Any\n\n\nSet TGSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TGTypeI","page":"TurbineGov","title":"TGTypeI","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/TGTypeI.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.TGTypeI","page":"TurbineGov","title":"PowerSystems.TGTypeI","text":"mutable struct TGTypeI <: TurbineGov\n R::Float64\n Ts::Float64\n Tc::Float64\n T3::Float64\n T4::Float64\n T5::Float64\n valve_position_limits::MinMax\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Turbine Governor Type I\n\nArguments\n\nR::Float64: Droop parameter, validation range: (0, nothing)\nTs::Float64: Governor time constant, validation range: (0, nothing)\nTc::Float64: Servo time constant, validation range: (0, nothing)\nT3::Float64: Transient gain time constant, validation range: (0, nothing)\nT4::Float64: Power fraction time constant, validation range: (0, nothing)\nT5::Float64: Reheat time constant, validation range: (0, nothing)\nvalve_position_limits::MinMax: Valve position limits in MW\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the TGTypeI model are:\n\nx_g1: Governor state,\nx_g2: Servo state,\nx_g3: Reheat state\n\nn_states::Int: (Do not modify.) TGTypeI has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::TGTypeI) -> Float64\n\n\nGet TGTypeI P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::TGTypeI) -> Float64\n\n\nGet TGTypeI R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::TGTypeI) -> Float64\n\n\nGet TGTypeI T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T4-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_T4","text":"get_T4(value::TGTypeI) -> Float64\n\n\nGet TGTypeI T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T5-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_T5","text":"get_T5(value::TGTypeI) -> Float64\n\n\nGet TGTypeI T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tc-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_Tc","text":"get_Tc(value::TGTypeI) -> Float64\n\n\nGet TGTypeI Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ts-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_Ts","text":"get_Ts(value::TGTypeI) -> Float64\n\n\nGet TGTypeI Ts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::TGTypeI) -> Dict{String, Any}\n\n\nGet TGTypeI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::TGTypeI) -> Int64\n\n\nGet TGTypeI n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::TGTypeI) -> Vector{Symbol}\n\n\nGet TGTypeI states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_valve_position_limits-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_valve_position_limits","text":"get_valve_position_limits(\n value::TGTypeI\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TGTypeI valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T4!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_T4!","text":"set_T4!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T5!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_T5!","text":"set_T5!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tc!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ts!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_Ts!","text":"set_Ts!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI Ts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_valve_position_limits!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_valve_position_limits!","text":"set_valve_position_limits!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TGTypeII","page":"TurbineGov","title":"TGTypeII","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/TGTypeII.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.TGTypeII","page":"TurbineGov","title":"PowerSystems.TGTypeII","text":"mutable struct TGTypeII <: TurbineGov\n R::Float64\n T1::Float64\n T2::Float64\n τ_limits::MinMax\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Turbine Governor Type II\n\nArguments\n\nR::Float64: Droop parameter, validation range: (0, nothing)\nT1::Float64: Transient gain time constant, validation range: (0, nothing)\nT2::Float64: Power fraction time constant, validation range: (0, nothing)\nτ_limits::MinMax: Power into the governor limits\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the TGTypeI model are:\n\nx_g1: lead-lag state\n\nn_states::Int: (Do not modify.) TGTypeII has 1 state\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::TGTypeII) -> Float64\n\n\nGet TGTypeII P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::TGTypeII) -> Float64\n\n\nGet TGTypeII R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::TGTypeII) -> Float64\n\n\nGet TGTypeII T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::TGTypeII) -> Float64\n\n\nGet TGTypeII T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::TGTypeII) -> Dict{String, Any}\n\n\nGet TGTypeII ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::TGTypeII) -> Int64\n\n\nGet TGTypeII n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::TGTypeII) -> Vector{Symbol}\n\n\nGet TGTypeII states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_τ_limits-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_τ_limits","text":"get_τ_limits(\n value::TGTypeII\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TGTypeII τ_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_τ_limits!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_τ_limits!","text":"set_τ_limits!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII τ_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#WPIDHY","page":"TurbineGov","title":"WPIDHY","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/WPIDHY.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.WPIDHY","page":"TurbineGov","title":"PowerSystems.WPIDHY","text":"mutable struct WPIDHY <: TurbineGov\n T_reg::Float64\n reg::Float64\n Kp::Float64\n Ki::Float64\n Kd::Float64\n Ta::Float64\n Tb::Float64\n V_lim::MinMax\n G_lim::MinMax\n Tw::Float64\n P_lim::MinMax\n D::Float64\n gate_openings::Tuple{Float64, Float64, Float64}\n power_gate_openings::Tuple{Float64, Float64, Float64}\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nWoodward PID Hydro Governor\n\nArguments\n\nT_reg::Float64: Input time constant of the governor in s, validation range: (0, nothing)\nreg::Float64: Input governor gain, validation range: (0, nothing)\nKp::Float64: Governor proportional gain, validation range: (0, nothing)\nKi::Float64: Governor integral gain, validation range: (0, nothing)\nKd::Float64: Governor derivative gain, validation range: (0, nothing)\nTa::Float64: Governor derivative/high-frequency time constant, validation range: (0, nothing)\nTb::Float64: Gate-servo time constant, validation range: (0, nothing)\nV_lim::MinMax: Gate opening velocity limits (G_min, G_max).\nG_lim::MinMax: Minimum/Maximum Gate velocity (G_min, G_max).\nTw::Float64: Water inertia time constant, sec, validation range: (eps(), nothing)\nP_lim::MinMax: Minimum/Maximum Gate openings (P_min, P_max).\nD::Float64: Turbine damping coefficient, validation range: (0, nothing)\ngate_openings::Tuple{Float64, Float64, Float64}: Gate-opening speed at different loads\npower_gate_openings::Tuple{Float64, Float64, Float64}: Power at gate_openings\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the PIDGOV model are:\n\nx_g1: Filtered input measurement,\nx_g2: PI block internal state,\nx_g3: First regulator state, \nx_g4: Derivative block internal state, \nx_g5: Second regulator state, \nx_g6: Gate position state, \nx_g7: Water inertia state\n\nn_states::Int: (Do not modify.) PIDGOV has 7 states\nstates_types::Vector{StateTypes}: (Do not modify.) PIDGOV has 7 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_D","text":"get_D(value::WPIDHY) -> Float64\n\n\nGet WPIDHY D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_G_lim-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_G_lim","text":"get_G_lim(\n value::WPIDHY\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet WPIDHY G_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kd-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Kd","text":"get_Kd(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Ki","text":"get_Ki(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kp-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Kp","text":"get_Kp(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_lim-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_P_lim","text":"get_P_lim(\n value::WPIDHY\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet WPIDHY P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::WPIDHY) -> Float64\n\n\nGet WPIDHY P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_reg-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_T_reg","text":"get_T_reg(value::WPIDHY) -> Float64\n\n\nGet WPIDHY T_reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ta-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Ta","text":"get_Ta(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tb-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Tb","text":"get_Tb(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tw-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Tw","text":"get_Tw(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_V_lim-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_V_lim","text":"get_V_lim(\n value::WPIDHY\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet WPIDHY V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::WPIDHY) -> Dict{String, Any}\n\n\nGet WPIDHY ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_gate_openings-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_gate_openings","text":"get_gate_openings(\n value::WPIDHY\n) -> Tuple{Float64, Float64, Float64}\n\n\nGet WPIDHY gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::WPIDHY) -> Int64\n\n\nGet WPIDHY n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_power_gate_openings-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_power_gate_openings","text":"get_power_gate_openings(\n value::WPIDHY\n) -> Tuple{Float64, Float64, Float64}\n\n\nGet WPIDHY power_gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_reg-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_reg","text":"get_reg(value::WPIDHY) -> Float64\n\n\nGet WPIDHY reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::WPIDHY) -> Vector{Symbol}\n\n\nGet WPIDHY states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(value::WPIDHY) -> Vector{StateTypes}\n\n\nGet WPIDHY states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_D!","text":"set_D!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_G_lim!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_G_lim!","text":"set_G_lim!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY G_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kd!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kp!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_lim!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_P_lim!","text":"set_P_lim!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_reg!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_T_reg!","text":"set_T_reg!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY T_reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ta!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tb!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tw!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Tw!","text":"set_Tw!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_V_lim!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_gate_openings!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_gate_openings!","text":"set_gate_openings!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_power_gate_openings!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_power_gate_openings!","text":"set_power_gate_openings!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY power_gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_reg!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_reg!","text":"set_reg!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/renewable_generation_cost/#RenewableGenerationCost","page":"RenewableGenerationCost","title":"RenewableGenerationCost","text":"","category":"section"},{"location":"model_library/renewable_generation_cost/","page":"RenewableGenerationCost","title":"RenewableGenerationCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/RenewableGenerationCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/renewable_generation_cost/#PowerSystems.RenewableGenerationCost","page":"RenewableGenerationCost","title":"PowerSystems.RenewableGenerationCost","text":"mutable struct RenewableGenerationCost <: OperationalCost\n\nvariable::CostCurve: Variable cost represented as a CostCurve\ncurtailment_cost::CostCurve: (default of 0) Cost of curtailing power represented as a CostCurve\n\nRenewableGenerationCost(variable, curtailment_cost)\nRenewableGenerationCost(variable; curtailment_cost)\nRenewableGenerationCost(; variable, curtailment_cost)\n\nAn 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.\n\nThe variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.\n\n\n\n\n\n","category":"type"},{"location":"model_library/renewable_generation_cost/#PowerSystems.get_curtailment_cost-Tuple{RenewableGenerationCost}","page":"RenewableGenerationCost","title":"PowerSystems.get_curtailment_cost","text":"get_curtailment_cost(\n value::RenewableGenerationCost\n) -> CostCurve\n\n\nGet RenewableGenerationCost curtailment_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/renewable_generation_cost/#PowerSystems.get_variable-Tuple{RenewableGenerationCost}","page":"RenewableGenerationCost","title":"PowerSystems.get_variable","text":"get_variable(value::RenewableGenerationCost) -> CostCurve\n\n\nGet RenewableGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/renewable_generation_cost/#PowerSystems.set_curtailment_cost!-Tuple{RenewableGenerationCost, Any}","page":"RenewableGenerationCost","title":"PowerSystems.set_curtailment_cost!","text":"set_curtailment_cost!(\n value::RenewableGenerationCost,\n val\n) -> Any\n\n\nSet RenewableGenerationCost curtailment_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/renewable_generation_cost/#PowerSystems.set_variable!-Tuple{RenewableGenerationCost, Any}","page":"RenewableGenerationCost","title":"PowerSystems.set_variable!","text":"set_variable!(value::RenewableGenerationCost, val) -> Any\n\n\nSet RenewableGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"api/type_tree/#Type-Hierarchy","page":"Type Hierarchy","title":"Type Hierarchy","text":"","category":"section"},{"location":"api/type_tree/","page":"Type Hierarchy","title":"Type Hierarchy","text":"Here is the complete PowerSystems.jl type hierarchy:","category":"page"},{"location":"api/type_tree/","page":"Type Hierarchy","title":"Type Hierarchy","text":"using PowerSystems #hide\nimport TypeTree: tt #hide\ndocs_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"utils\"); #hide\ninclude(joinpath(docs_dir, \"docs_utils.jl\")); #hide\nprint(join(tt(PowerSystems.IS.InfrastructureSystemsType), \"\")) #hide","category":"page"},{"location":"model_library/generated_HydroDispatch/#HydroDispatch","page":"HydroDispatch","title":"HydroDispatch","text":"","category":"section"},{"location":"model_library/generated_HydroDispatch/","page":"HydroDispatch","title":"HydroDispatch","text":"Modules = [PowerSystems]\nPages = [\"generated/HydroDispatch.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.HydroDispatch","page":"HydroDispatch","title":"PowerSystems.HydroDispatch","text":"mutable struct HydroDispatch <: HydroGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n time_limits::Union{Nothing, UpDown}\n base_power::Float64\n operation_cost::Union{HydroGenerationCost, MarketBidCost}\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA hydropower generator without a reservoir, suitable for modeling run-of-river hydropower.\n\nFor hydro generators with an upper reservoir, see HydroEnergyReservoir\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\noperation_cost::Union{HydroGenerationCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_HydroDispatch/#InfrastructureSystems.get_name-Tuple{HydroDispatch}","page":"HydroDispatch","title":"InfrastructureSystems.get_name","text":"get_name(value::HydroDispatch) -> String\n\n\nGet HydroDispatch name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_active_power-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_active_power","text":"get_active_power(value::HydroDispatch) -> Any\n\n\nGet HydroDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_active_power_limits-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::HydroDispatch\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet HydroDispatch active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_available-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_available","text":"get_available(value::HydroDispatch) -> Bool\n\n\nGet HydroDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_base_power-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_base_power","text":"get_base_power(value::HydroDispatch) -> Float64\n\n\nGet HydroDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_bus-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_bus","text":"get_bus(value::HydroDispatch) -> ACBus\n\n\nGet HydroDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_dynamic_injector-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::HydroDispatch\n) -> Union{Nothing, DynamicInjection}\n\n\nGet HydroDispatch dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_ext-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_ext","text":"get_ext(value::HydroDispatch) -> Dict{String, Any}\n\n\nGet HydroDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_operation_cost-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::HydroDispatch\n) -> Union{HydroGenerationCost, MarketBidCost}\n\n\nGet HydroDispatch operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_prime_mover_type-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(value::HydroDispatch) -> PrimeMovers\n\n\nGet HydroDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_ramp_limits-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::HydroDispatch\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet HydroDispatch ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_rating-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_rating","text":"get_rating(value::HydroDispatch) -> Any\n\n\nGet HydroDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_reactive_power-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::HydroDispatch) -> Any\n\n\nGet HydroDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_reactive_power_limits-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::HydroDispatch\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HydroDispatch reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_services-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_services","text":"get_services(value::HydroDispatch) -> Vector{Service}\n\n\nGet HydroDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_time_limits-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::HydroDispatch\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet HydroDispatch time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_active_power!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_active_power_limits!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_available!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_available!","text":"set_available!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_base_power!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_bus!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_bus!","text":"set_bus!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_ext!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_ext!","text":"set_ext!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_operation_cost!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_prime_mover_type!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_ramp_limits!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_rating!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_rating!","text":"set_rating!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_reactive_power!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_reactive_power_limits!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_services!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_services!","text":"set_services!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_time_limits!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#Line","page":"Line","title":"Line","text":"","category":"section"},{"location":"model_library/generated_Line/","page":"Line","title":"Line","text":"Modules = [PowerSystems]\nPages = [\"generated/Line.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Line/#PowerSystems.Line","page":"Line","title":"PowerSystems.Line","text":"mutable struct Line <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n b::FromTo\n rating::Float64\n angle_limits::MinMax\n g::FromTo\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn AC transmission line\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow on the line (MVAR)\narc::Arc: An Arc defining this line from a bus to another bus\nr::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)\nx::Float64: Reactance in pu (SYSTEM_BASE), validation range: (0, 4)\nb::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)\nrating::Float64: Thermal rating (MVA). Flow on the line must be between -rating and rating. When defining a line before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to\nangle_limits::MinMax: Minimum and maximum angle limits (radians), validation range: (-1.571, 1.571)\ng::FromTo: (default: (from=0.0, to=0.0)) Shunt conductance 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)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Line/#InfrastructureSystems.get_name-Tuple{Line}","page":"Line","title":"InfrastructureSystems.get_name","text":"get_name(value::Line) -> String\n\n\nGet Line name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_active_power_flow-Tuple{Line}","page":"Line","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::Line) -> Any\n\n\nGet Line active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_angle_limits-Tuple{Line}","page":"Line","title":"PowerSystems.get_angle_limits","text":"get_angle_limits(\n value::Line\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet Line angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_arc-Tuple{Line}","page":"Line","title":"PowerSystems.get_arc","text":"get_arc(value::Line) -> Arc\n\n\nGet Line arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_available-Tuple{Line}","page":"Line","title":"PowerSystems.get_available","text":"get_available(value::Line) -> Bool\n\n\nGet Line available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_b-Tuple{Line}","page":"Line","title":"PowerSystems.get_b","text":"get_b(\n value::Line\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet Line b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_ext-Tuple{Line}","page":"Line","title":"PowerSystems.get_ext","text":"get_ext(value::Line) -> Dict{String, Any}\n\n\nGet Line ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_g-Tuple{Line}","page":"Line","title":"PowerSystems.get_g","text":"get_g(\n value::Line\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet Line g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_r-Tuple{Line}","page":"Line","title":"PowerSystems.get_r","text":"get_r(value::Line) -> Float64\n\n\nGet Line r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_rating-Tuple{Line}","page":"Line","title":"PowerSystems.get_rating","text":"get_rating(value::Line) -> Any\n\n\nGet Line rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_reactive_power_flow-Tuple{Line}","page":"Line","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::Line) -> Any\n\n\nGet Line reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_services-Tuple{Line}","page":"Line","title":"PowerSystems.get_services","text":"get_services(value::Line) -> Vector{Service}\n\n\nGet Line services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_x-Tuple{Line}","page":"Line","title":"PowerSystems.get_x","text":"get_x(value::Line) -> Float64\n\n\nGet Line x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_active_power_flow!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::Line, val) -> Any\n\n\nSet Line active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_angle_limits!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_angle_limits!","text":"set_angle_limits!(value::Line, val) -> Any\n\n\nSet Line angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_arc!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_arc!","text":"set_arc!(value::Line, val) -> Any\n\n\nSet Line arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_available!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_available!","text":"set_available!(value::Line, val) -> Any\n\n\nSet Line available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_b!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_b!","text":"set_b!(value::Line, val) -> Any\n\n\nSet Line b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_ext!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_ext!","text":"set_ext!(value::Line, val) -> Any\n\n\nSet Line ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_g!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_g!","text":"set_g!(value::Line, val) -> Any\n\n\nSet Line g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_r!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_r!","text":"set_r!(value::Line, val) -> Any\n\n\nSet Line r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_rating!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_rating!","text":"set_rating!(value::Line, val) -> Any\n\n\nSet Line rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_reactive_power_flow!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(value::Line, val) -> Any\n\n\nSet Line reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_services!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_services!","text":"set_services!(value::Line, val) -> Any\n\n\nSet Line services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_x!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_x!","text":"set_x!(value::Line, val) -> Any\n\n\nSet Line x.\n\n\n\n\n\n","category":"method"},{"location":"explanation/per_unit/#per_unit","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"","category":"section"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"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:","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"\"NATURAL_UNITS\": The naturally defined units of each parameter (typically MW).\n\"SYSTEM_BASE\": Parameter values are divided by the system base_power.\n\"DEVICE_BASE\": Parameter values are divided by the device base_power.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"PowerSystems.jl supports these unit systems because different power system tools and data sets use different units systems by convention, such as:","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"Dynamics data is often defined in device base\nNetwork data (e.g., reactance, resistance) is often defined in system base\nProduction cost modeling data is often gathered from variety of data sources, which are typically defined in natural units","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"These three unit bases allow easy conversion between unit systems. This allows PowerSystems.jl users to input data in the formats they have available, as well as view data in the unit system that is most intuitive to them.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"You can get and set the unit system setting of a System with get_units_base and set_units_base_system!.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"Conversion between unit systems does not change the stored parameter values. Instead, unit system conversions are made when accessing parameters using the accessor functions, thus making it imperative to utilize the accessor functions instead of the \"dot\" accessor methods to ensure the return of the correct values. The units of the parameter values stored in each struct are defined in src/descriptors/power_system_structs.json.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"There are some unit system conventions in PowerSystems.jl when defining new components. Currently, when you define components that aren't attached to a System, you must define all fields in \"DEVICE_BASE\", except for certain components that don't have their own base_power rating, such as Lines, where the rating must be defined in \"SYSTEM_BASE\".","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"In the future, PowerSystems.jl hopes to support defining components in natural units. For now, if you want to define data in natural units, you must first set the system units to \"NATURAL_UNITS\", define an empty component, and then use the accessor functions (e.g., getters and setters), to define each field within the component. The accessor functions will then do the data conversion from your input data in natural units (e.g., MW or MVA) to per-unit.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"By default, PowerSystems.jl uses \"SYSTEM_BASE\" because many optimization problems won't converge when using natural units. If you change the unit setting, it's suggested that you switch back to \"SYSTEM_BASE\" before solving an optimization problem (for example in PowerSimulations.jl).","category":"page"},{"location":"model_library/generated_Arc/#Arc","page":"Arc","title":"Arc","text":"","category":"section"},{"location":"model_library/generated_Arc/","page":"Arc","title":"Arc","text":"Modules = [PowerSystems]\nPages = [\"generated/Arc.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Arc/#PowerSystems.Arc","page":"Arc","title":"PowerSystems.Arc","text":"mutable struct Arc <: Topology\n from::Bus\n to::Bus\n internal::InfrastructureSystemsInternal\nend\n\nA topological directed edge connecting two buses.\n\nArcs are used to define the from and to buses when defining a line or transformer\n\nArguments\n\nfrom::Bus: The initial bus\nto::Bus: The terminal bus\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Arc/#PowerSystems.get_from-Tuple{Arc}","page":"Arc","title":"PowerSystems.get_from","text":"get_from(value::Arc) -> Bus\n\n\nGet Arc from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Arc/#PowerSystems.get_to-Tuple{Arc}","page":"Arc","title":"PowerSystems.get_to","text":"get_to(value::Arc) -> Bus\n\n\nGet Arc to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Arc/#PowerSystems.set_from!-Tuple{Arc, Any}","page":"Arc","title":"PowerSystems.set_from!","text":"set_from!(value::Arc, val) -> Any\n\n\nSet Arc from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Arc/#PowerSystems.set_to!-Tuple{Arc, Any}","page":"Arc","title":"PowerSystems.set_to!","text":"set_to!(value::Arc, val) -> Any\n\n\nSet Arc to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#InterruptiblePowerLoad","page":"InterruptiblePowerLoad","title":"InterruptiblePowerLoad","text":"","category":"section"},{"location":"model_library/generated_InterruptiblePowerLoad/","page":"InterruptiblePowerLoad","title":"InterruptiblePowerLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/InterruptiblePowerLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.InterruptiblePowerLoad","page":"InterruptiblePowerLoad","title":"PowerSystems.InterruptiblePowerLoad","text":"mutable struct InterruptiblePowerLoad <: ControllableLoad\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n max_active_power::Float64\n max_reactive_power::Float64\n base_power::Float64\n operation_cost::Union{LoadCost, MarketBidCost}\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA static power load that can be compensated for temporary or continuous interruptions to its requested demand.\n\nThese 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_power::Float64: Initial steady state active power demand (MW)\nreactive_power::Float64: Initial steady state reactive power demand (MVAR)\nmax_active_power::Float64: Maximum active power (MW) that this load can demand\nmax_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand\nbase_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)\noperation_cost::Union{LoadCost, MarketBidCost}: OperationalCost of interrupting load\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InterruptiblePowerLoad/#InfrastructureSystems.get_name-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::InterruptiblePowerLoad) -> String\n\n\nGet InterruptiblePowerLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_active_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_active_power","text":"get_active_power(value::InterruptiblePowerLoad) -> Any\n\n\nGet InterruptiblePowerLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_available-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_available","text":"get_available(value::InterruptiblePowerLoad) -> Bool\n\n\nGet InterruptiblePowerLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_base_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::InterruptiblePowerLoad) -> Float64\n\n\nGet InterruptiblePowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_bus-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_bus","text":"get_bus(value::InterruptiblePowerLoad) -> ACBus\n\n\nGet InterruptiblePowerLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_dynamic_injector-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::InterruptiblePowerLoad\n) -> Union{Nothing, DynamicInjection}\n\n\nGet InterruptiblePowerLoad dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_ext-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_ext","text":"get_ext(value::InterruptiblePowerLoad) -> Dict{String, Any}\n\n\nGet InterruptiblePowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_max_active_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(value::InterruptiblePowerLoad) -> Any\n\n\nGet InterruptiblePowerLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_max_reactive_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(value::InterruptiblePowerLoad) -> Any\n\n\nGet InterruptiblePowerLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_operation_cost-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::InterruptiblePowerLoad\n) -> Union{LoadCost, MarketBidCost}\n\n\nGet InterruptiblePowerLoad operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_reactive_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::InterruptiblePowerLoad) -> Any\n\n\nGet InterruptiblePowerLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_services-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_services","text":"get_services(\n value::InterruptiblePowerLoad\n) -> Vector{Service}\n\n\nGet InterruptiblePowerLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_active_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_available!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_available!","text":"set_available!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_base_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_bus!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_bus!","text":"set_bus!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_ext!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_max_active_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_max_active_power!","text":"set_max_active_power!(\n value::InterruptiblePowerLoad,\n val\n) -> Any\n\n\nSet InterruptiblePowerLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_max_reactive_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_max_reactive_power!","text":"set_max_reactive_power!(\n value::InterruptiblePowerLoad,\n val\n) -> Any\n\n\nSet InterruptiblePowerLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_operation_cost!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(\n value::InterruptiblePowerLoad,\n val\n) -> Any\n\n\nSet InterruptiblePowerLoad operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_reactive_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(\n value::InterruptiblePowerLoad,\n val\n) -> Any\n\n\nSet InterruptiblePowerLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_services!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_services!","text":"set_services!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad services.\n\n\n\n\n\n","category":"method"},{"location":"explanation/time_series/#ts_data","page":"Time Series Data","title":"Time Series Data","text":"","category":"section"},{"location":"explanation/time_series/#Categories-of-Time-Series","page":"Time Series Data","title":"Categories of Time Series","text":"","category":"section"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"The bulk of the data in many power system models is time series data. Given the potential complexity, PowerSystems.jl has a set of definitions to organize this data and enable consistent modeling.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"PowerSystems.jl supports two categories of time series data depending on the process to obtain the data and its interpretation:","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Static Time Series Data\nForecasts","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"These categories are are all subtypes of TimeSeriesData and fall within this time series type hierarchy:","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"using PowerSystems #hide\nimport TypeTree: tt #hide\ndocs_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"utils\"); #hide\ninclude(joinpath(docs_dir, \"docs_utils.jl\")); #hide\nprint(join(tt(TimeSeriesData), \"\")) #hide","category":"page"},{"location":"explanation/time_series/#Static-Time-Series-Data","page":"Time Series Data","title":"Static Time Series Data","text":"","category":"section"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"A static time series data is a single column of data where each time period has a single value assigned to a component field, such as its maximum active power. This data commonly is obtained from historical information or the realization of a time-varying quantity.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Static time series usually comes in the following format, with a set resolution between the time-stamps:","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"DateTime Value\n2020-09-01T00:00:00 100.0\n2020-09-01T01:00:00 101.0\n2020-09-01T02:00:00 99.0","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"This example is a 1-hour resolution static time-series.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"In PowerSystems, a static time series is represented using SingleTimeSeries.","category":"page"},{"location":"explanation/time_series/#Forecasts","page":"Time Series Data","title":"Forecasts","text":"","category":"section"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"A forecast time series includes predicted values of a time-varying quantity that commonly includes a look-ahead window 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.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Key forecast format parameters are the forecast resolution, the interval of time between forecast initial times, and the number of forecast windows (or forecasted values) in the forecast horizon.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Forecast data usually comes in the following format, where a column represents the time stamp associated with the initial time of the forecast, and the remaining columns represent the forecasted values at each step in the forecast horizon.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"DateTime 0 1 2 3 4 5 6 7\n2020-09-01T00:00:00 100.0 101.0 101.3 90.0 98.0 87.0 88.0 67.0\n2020-09-01T01:00:00 101.0 101.3 99.0 98.0 88.9 88.3 67.1 89.4\n2020-09-01T02:00:00 99.0 67.0 89.0 99.9 100.0 101.0 112.0 101.3","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"This example forecast has a interval of 1 hour and a horizon of 8.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"PowerSystems defines the following Julia structs to represent forecasts:","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Deterministic: Point forecast without any uncertainty representation.\nProbabilistic: Stores a discretized cumulative distribution functions (CDFs) or probability distribution functions (PDFs) at each time step in the look-ahead window.\nScenarios: Stores a set of probable trajectories for forecasted quantity with equal probability.","category":"page"},{"location":"explanation/time_series/#Data-Storage","page":"Time Series Data","title":"Data Storage","text":"","category":"section"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"By default PowerSystems stores time series data in an HDF5 file. This prevents large datasets from overwhelming system memory. Refer to this page for details on how the time series data is stored in HDF5 files.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Time series data can be stored actual component values (for instance MW) or scaling factors intended to be multiplied by a scalar to generate the component values. By default PowerSystems treats the values in the time series data as physical units. In order to specify them as scaling factors, you must pass the accessor function that provides the multiplier value (e.g., get_time_series_array). The scaling factor multiplier must be passed into the forecast when you create it to use this option.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"The time series contains fields for scaling_factor_multiplier and data to identify the details of th Component field that the time series describes, and the time series data. For example: we commonly want to use a time series to describe the maximum active power capability of a renewable generator. In this case, we can create a SingleTimeSeries with a TimeArray and an accessor function to the maximum active power field in the struct describing the generator. In this way, we can store a scaling factor time series that will get multiplied by the maximum active power rather than the magnitudes of the maximum active power time series.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Examples of how to create and add time series to system can be found in the Add Time Series Example","category":"page"},{"location":"how_to/adding_additional_fields/#additional_fields","page":"...add additional data to a component","title":"Adding additional data to a component","text":"","category":"section"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"All PowerSystems.jl components have an ext field that contains an empty Dictionary. This Dictionary is useful to contain additional required data where there is no need to create new behaviors with that data. A simple example is the addition of geographic information, if needed.","category":"page"},{"location":"how_to/adding_additional_fields/#Example","page":"...add additional data to a component","title":"Example","text":"","category":"section"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"using PowerSystems #hide\nusing PowerSystemCaseBuilder #hide\nsystem = build_system(PSISystems, \"modified_RTS_GMLC_DA_sys\"); #hide","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"Step 1: Use get_ext to get the ext field of the desired components and assign your data:","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"for g in get_components(ThermalStandard, system)\n external_field = get_ext(g)\n external_field[\"my_data\"] = 1.0\nend","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"Here, we added additional data called my_data to the ThermalStandard generators in a previously defined System.","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"Step 2: Retrieve your data using get_ext again","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"First, retrieve the first ThermalStandard generator:","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"gen = collect(get_components(ThermalStandard, system))[1];","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"Then, retrieve my_data from the generator and verify it is 1.0, as assigned.","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"retrieved_data = get_ext(gen)[\"my_data\"]","category":"page"},{"location":"how_to/add_new_types/#Add-a-New-or-Custom-Type","page":"...customize or add a new Type","title":"Add a New or Custom Type","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"This page describes how developers should add types to PowerSystems.jl","category":"page"},{"location":"how_to/add_new_types/#Type-Hierarchy","page":"...customize or add a new Type","title":"Type Hierarchy","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"All structs that correlate to power system components must be subtypes of the Component abstract type. Browse its type hierachy to choose an appropriate supertype for your new struct.","category":"page"},{"location":"how_to/add_new_types/#Interfaces","page":"...customize or add a new Type","title":"Interfaces","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Refer to the managing components guide for component requirements.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"In particular, please note the methods supports_time_series (default = false) and supports_supplemental_attributes (default = true) that you may need to implement.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Note: get_internal and get_name are imported into PowerSystems, so you should implement your methods as PowerSystems methods.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Some abstract types define required interface functions in docstring. Be sure to implement each of them for your new type.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Formalized documentation for each abstract type is TBD.","category":"page"},{"location":"how_to/add_new_types/#Specialize-an-Existing-Type","page":"...customize or add a new Type","title":"Specialize an Existing Type","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"There are scenarios where you may want to make a new type that is identical to an existing type except for one attribute or behavior, and don't want to duplicate the entire existing type and methods. In programming languages that support inheritance you would derive a new class from the existing class and automatically inherit its fields and methods. Julia doesn't support that. However, you can achieve a similar result with a forwarding macro. The basic idea is that you include the existing type within your struct and then use a macro to automatically forward specific methods to that instance.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"A few PowerSystems structs use the macro InfrastructureSystems.@forward to do this. Refer to the struct RoundRotorQuadratic for an example of how to use this.","category":"page"},{"location":"how_to/add_new_types/#Custom-Rules","page":"...customize or add a new Type","title":"Custom Rules","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Some types require special checks before they can be added to or removed from a system. One example is the case where a component includes another component that is also stored in the system. We must ensure that the parent component does not contain a reference to another component that is not already attached to the system.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Similarly, if the child object is removed from the system we must also remove the parent's reference to that child.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The source file src/base.jl provides functions that you can implement for your new type to manage these scenarios.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"check_component_addition(sys::System, component::Component; kwargs...)\nhandle_component_addition!(sys::System, component::Component; kwargs...)\ncheck_component_removal(sys::System, component::Component; kwargs...)\nhandle_component_removal!(sys::System, component::Component; kwargs...)","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The functions add_component!() and remove_component!() call the check function before performing actions and then call the handle function afterwards. The default behavior of these functions is to do nothing. Implement versions that take your type in order to add your own checks or perform additional actions.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Beware of the condition where a custom method is already implemented for a supertype of your type.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Note that you can call the helper functions is_attached(component, system) and throw_if_not_attached(component, system).","category":"page"},{"location":"how_to/add_new_types/#Custom-Validation","page":"...customize or add a new Type","title":"Custom Validation","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"You can implement three methods to perform custom validation or correction for your type. PowerSystems calls all of these functions in add_component!.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"sanitize_component!(component::Component, sys::System): intended to make standard data corrections (e.g. voltage angle in degrees -> radians)\nvalidate_component(component::Component): intended to check component field values for internal consistency\nvalidate_component_with_system(component::Component, sys::System): intended to check component field values for consistency with system","category":"page"},{"location":"how_to/add_new_types/#Struct-Requirements-for-Serialization-of-custom-components","page":"...customize or add a new Type","title":"Struct Requirements for Serialization of custom components","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"One key feature of PowerSystems.jl is the serialization capabilities. Supporting serialization and de-serialization of custom components requires the implementation of several methods. The serialization code converts structs to dictionaries where the struct fields become dictionary keys.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The code imposes these requirements:","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The InfrastructureSystems methods serialize and deserialize must be implemented for the struct. InfrastructureSystems implements a method that covers all subtypes of InfrastructureSystemsType. All PowerSystems components should be subtypes of PowerSystems.Component which is a subtype InfrastructureSystemsType, so any new structs should be covered as well.\nAll struct fields must be able to be encoded in JSON format or be covered be covered by serialize and deserialize methods. Basic types, such as numbers and strings or arrays and dictionaries of numbers and strings, should just work. Complex containers with symbols may not.\nStructs relying on the default deserialize method must have a kwarg-only constructor. The deserialization code constructs objects by splatting the dictionary key/value pairs into the constructor.\nStructs that contain other PowerSystem components (like a generator contains a bus) must serialize those components as UUIDs instead of actual values. The deserialization code uses the UUIDs as a mechanism to restore a reference to the actual object rather a new object with identical values. It also significantly reduces the size of the JSON file.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Refer to InfrastructureSystems.serialize_struct for example behavior. New structs that are not subtypes of InfrastructureSystemsType may be able to call it directly.","category":"page"},{"location":"how_to/add_new_types/#How-to-trouble-shoot-serialization-issues","page":"...customize or add a new Type","title":"How to trouble-shoot serialization issues","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Here are some examples of potential problems and solutions if you need to implement custom InfrastructureSystems.serialize and InfrastructureSystems.deserialize methods for your type.:","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Problem: Your struct contains a field defined as an abstract type. The deserialization process doesn't know what concrete type to construct.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Solution: Encode the concrete type into the serialized dictionary as a string.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Example: serialize and deserialize methods for DynamicBranch in src/models/dynamic_branch.jl.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Problem: Similar to above in that a field is defined as an abstract type but the struct is parameterized on the actual concrete type.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"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.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Example: deserialize method for OuterControl in src/models/OuterControl.jl.","category":"page"},{"location":"how_to/add_new_types/#Adding-PowerSystems.jl-as-a-dependency-in-a-modeling-package","page":"...customize or add a new Type","title":"Adding PowerSystems.jl as a dependency in a modeling package","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"module MyModelingModule\n\nimport PowerSystems\nimport InfrastructureSystems\nconst PSY = PowerSystems\nconst IS = InfrastructureSystems\n\nexport MyDevice\nexport get_name\n\nmutable struct MyDevice <: PSY.Device\n name::String\n internal::IS.InfrastructureSystemsInternal\nend\n\nfunction MyDevice(name::String)\n return MyDevice(name, IS.InfrastructureSystemsInternal())\nend\n\nPSY.get_name(val::MyDevice) = val.name\n\nend","category":"page"},{"location":"how_to/add_new_types/#autogen","page":"...customize or add a new Type","title":"Auto-generating Structs","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Most PowerSystems.jl structs are auto-generated from the JSON descriptor file src/descriptors/power_system_structs.json. You can add your new struct here or write it manually when contributing code to the repository.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"If all you need is the basic struct definition and getter/setter functions then you will likely find the auto-generation helpful.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"If you will need to write specialized functions for the type then you will probably want to write it manually.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"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/.","category":"page"},{"location":"how_to/add_new_types/#Testing-the-addition-of-new-struct-to-the-code-base","page":"...customize or add a new Type","title":"Testing the addition of new struct to the code base","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"In order to merge new structs to the code base, your struct needs to pass several tests.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"addition to System\nretrieval from System\nserialization/de-serialization","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The following code block is an example of the code that the new struct needs to pass","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"using PowerSystems\n\nsys = System(100.0)\ndevice = NewType(data)\n\n# add your component to the system\nadd_component!(sys, device)\nretrived_device = get_component(NewType, sys, \"component_name\")\n\n# Serialize\nto_json(sys, \"sys.json\")\n\n# Re-create the system and find your component.\nsys2 = System(\"sys.json\")\nserialized_device = get_component(NewType, sys, \"component_name\")\n\n@test get_name(retrieved_device) == get_name(serialized_device)","category":"page"},{"location":"model_library/generated_DCBus/#DCBus","page":"DCBus","title":"DCBus","text":"","category":"section"},{"location":"model_library/generated_DCBus/","page":"DCBus","title":"DCBus","text":"Modules = [PowerSystems]\nPages = [\"generated/DCBus.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_DCBus/#PowerSystems.DCBus","page":"DCBus","title":"PowerSystems.DCBus","text":"mutable struct DCBus <: Bus\n number::Int\n name::String\n magnitude::Union{Nothing, Float64}\n voltage_limits::Union{Nothing, MinMax}\n base_voltage::Union{Nothing, Float64}\n area::Union{Nothing, Area}\n load_zone::Union{Nothing, LoadZone}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA DC bus\n\nArguments\n\nnumber::Int: A unique bus identification number (positive integer)\nname::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\nmagnitude::Union{Nothing, Float64}: voltage as a multiple of base_voltage, validation range: voltage_limits\nvoltage_limits::Union{Nothing, MinMax}: limits on the voltage variation as multiples of base_voltage\nbase_voltage::Union{Nothing, Float64}: the base voltage in kV, validation range: (0, nothing)\narea::Union{Nothing, Area}: (default: nothing) the area containing the DC bus\nload_zone::Union{Nothing, LoadZone}: (default: nothing) the load zone containing the DC bus\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_DCBus/#InfrastructureSystems.get_name-Tuple{DCBus}","page":"DCBus","title":"InfrastructureSystems.get_name","text":"get_name(value::DCBus) -> String\n\n\nGet DCBus name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_area-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_area","text":"get_area(value::DCBus) -> Union{Nothing, Area}\n\n\nGet DCBus area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_base_voltage-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_base_voltage","text":"get_base_voltage(value::DCBus) -> Union{Nothing, Float64}\n\n\nGet DCBus base_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_ext-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_ext","text":"get_ext(value::DCBus) -> Dict{String, Any}\n\n\nGet DCBus ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_load_zone-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_load_zone","text":"get_load_zone(value::DCBus) -> Union{Nothing, LoadZone}\n\n\nGet DCBus load_zone.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_magnitude-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_magnitude","text":"get_magnitude(value::DCBus) -> Union{Nothing, Float64}\n\n\nGet DCBus magnitude.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_number-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_number","text":"get_number(value::DCBus) -> Int64\n\n\nGet DCBus number.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_voltage_limits-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_voltage_limits","text":"get_voltage_limits(\n value::DCBus\n) -> Union{Nothing, @NamedTuple{min::Float64, max::Float64}}\n\n\nGet DCBus voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_area!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_area!","text":"set_area!(value::DCBus, val) -> Any\n\n\nSet DCBus area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_base_voltage!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_base_voltage!","text":"set_base_voltage!(value::DCBus, val) -> Any\n\n\nSet DCBus base_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_ext!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_ext!","text":"set_ext!(value::DCBus, val) -> Any\n\n\nSet DCBus ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_load_zone!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_load_zone!","text":"set_load_zone!(value::DCBus, val) -> Any\n\n\nSet DCBus load_zone.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_magnitude!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_magnitude!","text":"set_magnitude!(value::DCBus, val) -> Any\n\n\nSet DCBus magnitude.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_number!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_number!","text":"set_number!(value::DCBus, val) -> Any\n\n\nSet DCBus number.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_voltage_limits!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_voltage_limits!","text":"set_voltage_limits!(value::DCBus, val) -> Any\n\n\nSet DCBus voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#SwitchedAdmittance","page":"SwitchedAdmittance","title":"SwitchedAdmittance","text":"","category":"section"},{"location":"model_library/generated_SwitchedAdmittance/","page":"SwitchedAdmittance","title":"SwitchedAdmittance","text":"Modules = [PowerSystems]\nPages = [\"generated/SwitchedAdmittance.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.SwitchedAdmittance","page":"SwitchedAdmittance","title":"PowerSystems.SwitchedAdmittance","text":"mutable struct SwitchedAdmittance <: ElectricLoad\n name::String\n available::Bool\n bus::ACBus\n Y::Complex{Float64}\n number_of_steps::Int\n Y_increase::Complex{Float64}\n dynamic_injector::Union{Nothing, DynamicInjection}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA switched admittance, with discrete steps to adjust the admittance.\n\nMost 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nY::Complex{Float64}: Initial admittance at N = 0\nnumber_of_steps::Int: (default: 0) Number of steps for adjustable shunt\nY_increase::Complex{Float64}: (default: 0) Admittance increment for each of step increase\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection model for admittance\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_SwitchedAdmittance/#InfrastructureSystems.get_name-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"InfrastructureSystems.get_name","text":"get_name(value::SwitchedAdmittance) -> String\n\n\nGet SwitchedAdmittance name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_Y-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_Y","text":"get_Y(value::SwitchedAdmittance) -> ComplexF64\n\n\nGet SwitchedAdmittance Y.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_Y_increase-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_Y_increase","text":"get_Y_increase(value::SwitchedAdmittance) -> ComplexF64\n\n\nGet SwitchedAdmittance Y_increase.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_available-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_available","text":"get_available(value::SwitchedAdmittance) -> Bool\n\n\nGet SwitchedAdmittance available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_bus-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_bus","text":"get_bus(value::SwitchedAdmittance) -> ACBus\n\n\nGet SwitchedAdmittance bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_dynamic_injector-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::SwitchedAdmittance\n) -> Union{Nothing, DynamicInjection}\n\n\nGet SwitchedAdmittance dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_ext-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_ext","text":"get_ext(value::SwitchedAdmittance) -> Dict{String, Any}\n\n\nGet SwitchedAdmittance ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_number_of_steps-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_number_of_steps","text":"get_number_of_steps(value::SwitchedAdmittance) -> Int64\n\n\nGet SwitchedAdmittance number_of_steps.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_services-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_services","text":"get_services(value::SwitchedAdmittance) -> Vector{Service}\n\n\nGet SwitchedAdmittance services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_Y!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_Y!","text":"set_Y!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance Y.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_Y_increase!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_Y_increase!","text":"set_Y_increase!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance Y_increase.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_available!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_available!","text":"set_available!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_bus!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_bus!","text":"set_bus!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_ext!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_ext!","text":"set_ext!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_number_of_steps!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_number_of_steps!","text":"set_number_of_steps!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance number_of_steps.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_services!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_services!","text":"set_services!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#StandardLoad","page":"StandardLoad","title":"StandardLoad","text":"","category":"section"},{"location":"model_library/generated_StandardLoad/","page":"StandardLoad","title":"StandardLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/StandardLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_StandardLoad/#PowerSystems.StandardLoad","page":"StandardLoad","title":"PowerSystems.StandardLoad","text":"mutable struct StandardLoad <: StaticLoad\n name::String\n available::Bool\n bus::ACBus\n base_power::Float64\n constant_active_power::Float64\n constant_reactive_power::Float64\n impedance_active_power::Float64\n impedance_reactive_power::Float64\n current_active_power::Float64\n current_reactive_power::Float64\n max_constant_active_power::Float64\n max_constant_reactive_power::Float64\n max_impedance_active_power::Float64\n max_impedance_reactive_power::Float64\n max_current_active_power::Float64\n max_current_reactive_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA voltage-dependent ZIP load, most commonly used for dynamics modeling.\n\nA 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.)\n\nFor an alternative exponential formulation of the ZIP model, see ExponentialLoad. For a simpler load model with no voltage dependency, see PowerLoad\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nbase_power::Float64: Base power of the load (MVA) for per unitization, validation range: (0, nothing)\nconstant_active_power::Float64: (default: 0.0) Constant active power demand in MW (P_P)\nconstant_reactive_power::Float64: (default: 0.0) Constant reactive power demand in MVAR (Q_P)\nimpedance_active_power::Float64: (default: 0.0) Active power coefficient in MW for constant impedance load (P_Z)\nimpedance_reactive_power::Float64: (default: 0.0) Reactive power coefficient in MVAR for constant impedance load (Q_Z)\ncurrent_active_power::Float64: (default: 0.0) Active power coefficient in MW for constant current load (P_I)\ncurrent_reactive_power::Float64: (default: 0.0) Reactive power coefficient in MVAR for constant current load (Q_I)\nmax_constant_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant power load\nmax_constant_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant power load\nmax_impedance_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant impedance load\nmax_impedance_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant impedance load\nmax_current_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant current load\nmax_current_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant current load\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_StandardLoad/#InfrastructureSystems.get_name-Tuple{StandardLoad}","page":"StandardLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::StandardLoad) -> String\n\n\nGet StandardLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_available-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_available","text":"get_available(value::StandardLoad) -> Bool\n\n\nGet StandardLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_base_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::StandardLoad) -> Float64\n\n\nGet StandardLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_bus-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_bus","text":"get_bus(value::StandardLoad) -> ACBus\n\n\nGet StandardLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_constant_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_constant_active_power","text":"get_constant_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad constant_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_constant_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_constant_reactive_power","text":"get_constant_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad constant_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_current_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_current_active_power","text":"get_current_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad current_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_current_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_current_reactive_power","text":"get_current_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad current_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_dynamic_injector-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::StandardLoad\n) -> Union{Nothing, DynamicInjection}\n\n\nGet StandardLoad dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_ext-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_ext","text":"get_ext(value::StandardLoad) -> Dict{String, Any}\n\n\nGet StandardLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_impedance_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_impedance_active_power","text":"get_impedance_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad impedance_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_impedance_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_impedance_reactive_power","text":"get_impedance_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad impedance_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_constant_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_constant_active_power","text":"get_max_constant_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_constant_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_constant_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_constant_reactive_power","text":"get_max_constant_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_constant_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_current_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_current_active_power","text":"get_max_current_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_current_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_current_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_current_reactive_power","text":"get_max_current_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_current_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_impedance_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_impedance_active_power","text":"get_max_impedance_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_impedance_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_impedance_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_impedance_reactive_power","text":"get_max_impedance_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_impedance_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_services-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_services","text":"get_services(value::StandardLoad) -> Vector{Service}\n\n\nGet StandardLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_available!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_available!","text":"set_available!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_base_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_bus!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_bus!","text":"set_bus!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_constant_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_constant_active_power!","text":"set_constant_active_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad constant_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_constant_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_constant_reactive_power!","text":"set_constant_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad constant_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_current_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_current_active_power!","text":"set_current_active_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad current_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_current_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_current_reactive_power!","text":"set_current_reactive_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad current_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_ext!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_impedance_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_impedance_active_power!","text":"set_impedance_active_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad impedance_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_impedance_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_impedance_reactive_power!","text":"set_impedance_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad impedance_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_constant_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_constant_active_power!","text":"set_max_constant_active_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_constant_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_constant_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_constant_reactive_power!","text":"set_max_constant_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_constant_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_current_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_current_active_power!","text":"set_max_current_active_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_current_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_current_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_current_reactive_power!","text":"set_max_current_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_current_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_impedance_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_impedance_active_power!","text":"set_max_impedance_active_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_impedance_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_impedance_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_impedance_reactive_power!","text":"set_max_impedance_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_impedance_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_services!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_services!","text":"set_services!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#Area","page":"Area","title":"Area","text":"","category":"section"},{"location":"model_library/generated_Area/","page":"Area","title":"Area","text":"Modules = [PowerSystems]\nPages = [\"generated/Area.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Area/#PowerSystems.Area","page":"Area","title":"PowerSystems.Area","text":"mutable struct Area <: AggregationTopology\n name::String\n peak_active_power::Float64\n peak_reactive_power::Float64\n load_response::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA collection of buses for control purposes.\n\nThe Area can be specified when defining each ACBus or DCBus in the area\n\nArguments\n\nname::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\npeak_active_power::Float64: (default: 0.0) Peak active power in the area\npeak_reactive_power::Float64: (default: 0.0) Peak reactive power in the area\nload_response::Float64: (default: 0.0) Load-frequency damping parameter modeling how much the load in the area changes due to changes in frequency (MW/Hz). Example here.\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Area/#InfrastructureSystems.get_name-Tuple{Area}","page":"Area","title":"InfrastructureSystems.get_name","text":"get_name(value::Area) -> String\n\n\nGet Area name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.get_ext-Tuple{Area}","page":"Area","title":"PowerSystems.get_ext","text":"get_ext(value::Area) -> Dict{String, Any}\n\n\nGet Area ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.get_load_response-Tuple{Area}","page":"Area","title":"PowerSystems.get_load_response","text":"get_load_response(value::Area) -> Float64\n\n\nGet Area load_response.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.get_peak_active_power-Tuple{Area}","page":"Area","title":"PowerSystems.get_peak_active_power","text":"get_peak_active_power(value::Area) -> Any\n\n\nGet Area peak_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.get_peak_reactive_power-Tuple{Area}","page":"Area","title":"PowerSystems.get_peak_reactive_power","text":"get_peak_reactive_power(value::Area) -> Any\n\n\nGet Area peak_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.set_ext!-Tuple{Area, Any}","page":"Area","title":"PowerSystems.set_ext!","text":"set_ext!(value::Area, val) -> Any\n\n\nSet Area ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.set_load_response!-Tuple{Area, Any}","page":"Area","title":"PowerSystems.set_load_response!","text":"set_load_response!(value::Area, val) -> Any\n\n\nSet Area load_response.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.set_peak_active_power!-Tuple{Area, Any}","page":"Area","title":"PowerSystems.set_peak_active_power!","text":"set_peak_active_power!(value::Area, val) -> Any\n\n\nSet Area peak_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.set_peak_reactive_power!-Tuple{Area, Any}","page":"Area","title":"PowerSystems.set_peak_reactive_power!","text":"set_peak_reactive_power!(value::Area, val) -> Any\n\n\nSet Area peak_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"api/glossary/#Glossary-and-Acronyms","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"A | D | E | F | H | I | O | P | R | S | V | W | Z","category":"page"},{"location":"api/glossary/#A","page":"Glossary and Acronyms","title":"A","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"AC: Alternating current\nACE: Area control error\nAGC: Automatic generation control\nAVR: Automatic Voltage Regulator","category":"page"},{"location":"api/glossary/#D","page":"Glossary and Acronyms","title":"D","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"DC: Direct current\nDERA1:\nDynamic: 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.","category":"page"},{"location":"api/glossary/#E","page":"Glossary and Acronyms","title":"E","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"EMF: Electromotive force\nESAC: IEEE Type AC Excitation System model\nESDC: IEEE Type DC Excitation System model\nEXAC: IEEE Type AC Excitation System (modified) model\nEXPIC: Proportional/Integral Excitation System from PSS/E\nEXST: IEEE Type ST (Static) Excitation System model\nEX4VSA: IEEE Excitation System for Voltage Security Assessment with Over-Excitation Limits.","category":"page"},{"location":"api/glossary/#F","page":"Glossary and Acronyms","title":"F","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"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.\nForecast window: Represents the forecasted value starting at a particular initial time. See the article on Time Series Data.","category":"page"},{"location":"api/glossary/#H","page":"Glossary and Acronyms","title":"H","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"Horizon: Is the duration of all time steps in one forecast. As of PowerSystems.jl version 4.0, all horizons in PowerSystems.jl are represented as a Dates.Period. For instance, many Day-ahead markets will have an hourly-resolution forecast for the next day, which would have a horizon of Dates.Hour(24) or Dates.Day(1). If the forecast included the next day plus a 24-hour lookahead window, the horizon would be Dates.Hour(48) or Dates.Day(2). See the article on Time Series Data.\nHVDC: High-voltage DC","category":"page"},{"location":"api/glossary/#I","page":"Glossary and Acronyms","title":"I","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"IEEET: IEEE Type I Excitation System.\nInjector 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.\nInterval: 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).\nInitial time: The first time-stamp in a forecast window. See the article on Time Series Data.\nIPC: Interconnecting power converter","category":"page"},{"location":"api/glossary/#O","page":"Glossary and Acronyms","title":"O","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"OEL: Over Excitation Limiter","category":"page"},{"location":"api/glossary/#P","page":"Glossary and Acronyms","title":"P","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"PLL: Phase-locked loop\nPSS: Power System Stabilizer\nPSSE or PSS/E: Siemens' PSS®E Power System Simulator for Engineering\nPPA: Power purchase agreement\nPSI: PowerSimulations.jl\nPSID: PowerSimulationsDynamics.jl\nPSLF: GE Vernova's Positive Sequence Load Flow Software\nPSY: PowerSystems.jl (this package)\npu or p.u.: Per-unit","category":"page"},{"location":"api/glossary/#R","page":"Glossary and Acronyms","title":"R","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"REECB1: Renewable Energy Electric Controller Type B1\nREPCA1: REPCA1: Renewable Energy Power Controller Type A1\nResolution: 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).","category":"page"},{"location":"api/glossary/#S","page":"Glossary and Acronyms","title":"S","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"SCRX: Bus Fed or Solid Fed Static Exciter\nSEXS: Simplified Excitation System model from PSS/E\nSIL: Surge impedance loading\nStates: 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.\nStatic: 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.\nSTAB: Speed Sensitive Stabilizing PSS Model","category":"page"},{"location":"api/glossary/#V","page":"Glossary and Acronyms","title":"V","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"VSCDCLine: Voltage-Source Converter Direct Current Line\nVSM: Virtual Synchronous Machine","category":"page"},{"location":"api/glossary/#W","page":"Glossary and Acronyms","title":"W","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"Window: A forecast window is one forecast run that starts at one initial time and extends through the forecast horizon. Typically, a forecast data set contains multiple forecast windows, with sequential initial times. For example, a year-long data set of day-ahead forecasts contains 365 forecast windows","category":"page"},{"location":"api/glossary/#Z","page":"Glossary and Acronyms","title":"Z","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"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.","category":"page"},{"location":"tutorials/add_dynamic_data/#Adding-Data-for-Dynamic-Simulations","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"In this tutorial, we are going to add dynamic data to a power System, including a dynamic generator suitable for phasor-type simulations, as well as a dynamic inverter and dynamic lines necessary for more complex EMT (electro-magnetic transient) simulations.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"To run a dynamic simulation in Sienna\\Dyn using PowerSimulationsDynamics.jl, two data layers are required:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"A base layer of static components, which includes the data needed to run a power flow problem\nAn additional layer of dynamic components, which define differential equations to run a transient simulation","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"We'll define these two layers sequentially.","category":"page"},{"location":"tutorials/add_dynamic_data/#Defining-the-Static-Data-Layer","page":"Adding Data for Dynamic Simulations","title":"Defining the Static Data Layer","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Instead of defining the static data in the System manually, we will load an existing three-bus system using PowerSystemCaseBuilder.jl to use as a starting point.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Start by importing these packages:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"using PowerSystems\nusing PowerSystemCaseBuilder\nconst PSY = PowerSystems;","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"To create the system, load pre-existing data for a 3-bus system using PowerSystemCaseBuilder.jl:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"threebus_sys = build_system(PSIDSystems, \"3 Bus Inverter Base\")","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that there is a table of \"Static Components\", but no \"Dynamic\" data yet.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's view the generators in the system with show_components, including which bus they are connected at:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"show_components(ThermalStandard, threebus_sys, [:bus])","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that there are generators connected at Buses 2 and 3, but not Bus 1.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Now, we are going to add the data needed to run an EMT simulation. We will add an infinite voltage source to Bus 1, which is the last component we need to complete the static data layer. Then, we will a dynamic generator or inverter model to the two generators, as well as adding dynamic lines.","category":"page"},{"location":"tutorials/add_dynamic_data/#Add-an-Infinite-Voltage-Source","page":"Adding Data for Dynamic Simulations","title":"Add an Infinite Voltage Source","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Add a infinite voltage source with small impedance to Bus 1 (the reference bus). First, retrieve the reference bus using get_components:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"slack_bus = first(get_components(x -> get_bustype(x) == ACBusTypes.REF, Bus, threebus_sys))","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice we filtered by the bus type to get the bus(es) we wanted.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Next, manually define a Source:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"inf_source = Source(;\n name = \"InfBus\", #name\n available = true, #availability\n active_power = 0.0,\n reactive_power = 0.0,\n bus = slack_bus, #bus\n R_th = 0.0, #Rth\n X_th = 5e-6, #Xth\n);","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"And add it to the system:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"add_component!(threebus_sys, inf_source)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"This completes the first layer of static data, using components similar to those we added manually in the Create and Explore a Power System tutorial.","category":"page"},{"location":"tutorials/add_dynamic_data/#Adding-a-Dynamic-Generator","page":"Adding Data for Dynamic Simulations","title":"Adding a Dynamic Generator","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Now, we will connect a classic machine model to the generator at bus 102. Dynamic generator devices are composed by 5 components: a Machine, Shaft, Automatic Voltage Regulator (AVR), Power System Stabilizer (PSS), and Prime Mover and Turbine Governor. For each of those 5 components, we will select a specific model that defines the data and differential equations for that component, and then use those 5 components to define the complete dynamic generator.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"note: Note\nWhen defining dynamic data, by convention PowerSystems.jl assumes that all data is in DEVICE_BASE.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"First, define a Machine that describes the the stator electro-magnetic dynamics:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"# Create the machine\nmachine_oneDoneQ = OneDOneQMachine(;\n R = 0.0,\n Xd = 1.3125,\n Xq = 1.2578,\n Xd_p = 0.1813,\n Xq_p = 0.25,\n Td0_p = 5.89,\n Tq0_p = 0.6,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that we selected a specific model, OneDOneQMachine, with the parameters tailored to a One-d-one-q dynamic machine model.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Next, define a specific Shaft model, SingleMass that describes the rotor electro-mechanical dynamics:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"# Shaft\nshaft_no_damping = SingleMass(;\n H = 3.01, #(M = 6.02 -> H = M/2)\n D = 0.0,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Represent the electromotive dynamics of the AVR controller using a specific Automatic Voltage Regulator model, AVRTypeI:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"# AVR: Type I: Resembles a DC1 AVR\navr_type1 = AVRTypeI(;\n Ka = 20.0,\n Ke = 0.01,\n Kf = 0.063,\n Ta = 0.2,\n Te = 0.314,\n Tf = 0.35,\n Tr = 0.001,\n Va_lim = (min = -5.0, max = 5.0),\n Ae = 0.0039, #1st ceiling coefficient\n Be = 1.555, #2nd ceiling coefficient\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define a fixed efficiency Prime Mover and Turbine Governor with TGFixed:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"#No TG\ntg_none = TGFixed(; efficiency = 1.0) #efficiency","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that we are modeling a machine that does not include a Turbine Governor (or PSS below), but you must define components for them to build a complete machine model.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Similarly, define a PSS using PSSFixed, which is used to describe the stabilization signal for the AVR:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"#No PSS\npss_none = PSSFixed(; V_pss = 0.0)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Now, we are ready to add a dynamic generator to the static generator at bus 102. First, let's get that static generator:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"static_gen = get_component(Generator, threebus_sys, \"generator-102-1\")","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that its dynamic_injector field is currently nothing.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Use its name and the 5 components above to define its DynamicGenerator model:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"dynamic_gen = DynamicGenerator(;\n name = get_name(static_gen),\n ω_ref = 1.0, # frequency reference set-point\n machine = machine_oneDoneQ,\n shaft = shaft_no_damping,\n avr = avr_type1,\n prime_mover = tg_none,\n pss = pss_none,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that the specific component models that we selected and defined above were used to specify the states needed to model this generator in a dynamic simulation.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Finally, use the dynamic version of add_component! to add this data to the System:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"add_component!(threebus_sys, dynamic_gen, static_gen)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that unlike static components, which are just added to the System, this dynamic component is added to a specific static component within the System.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"tip: Tip\nTo define identical dynamic devices for multiple generators at once, define the pieces of the generator model as functions, such as:avr_type1() = AVRTypeI(...When called in the DynamicGenerator constructor, this will create a new AVR for each generator, so they are different in memory. Later, if you decide to modify the AVR parameters for a specific generator, it will not modify the AVR in another generator.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Recall that you can print the system to see a summary of its data:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"threebus_sys","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that a new table has been added: \"Dynamic Components.\"","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Also, print the static generator to double-check the dynamic layer has been added:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"static_gen","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Verify that dynamic_injector now contains our dynamic generator model.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Up to this point, you have added the dynamic data necessary to do a phaser-type simulation, which focuses on machine behavior. Now we will also add dynamic inverters and lines to enable EMT simulations.","category":"page"},{"location":"tutorials/add_dynamic_data/#Adding-a-Dynamic-Inverter","page":"Adding Data for Dynamic Simulations","title":"Adding a Dynamic Inverter","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Next we will connect a Virtual Synchronous Generator Inverter at bus 103.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"An inverter is composed of Converter, OuterControl, InnerControl, DCSource, FrequencyEstimator, and Filter components:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"As we did for the generator, we will define each of these six components with a specific model, which defines its differential equations.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"First, define an AverageConverter as the specific model for the Converter component:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"converter_high_power() = AverageConverter(;\n rated_voltage = 138.0,\n rated_current = 100.0,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Recall from the tip above that we can define these components as functions instead of objects for reusability across multiple generators, and notice that that is what we have done here.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define OuterControl using Virtual Inertia for the active power control and ReactivePowerDroop for the reactive power control:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"outer_control() = OuterControl(\n VirtualInertia(; Ta = 2.0, kd = 400.0, kω = 20.0),\n ReactivePowerDroop(; kq = 0.2, ωf = 1000.0),\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define an InnerControl as a Voltage+Current Controller with Virtual Impedance, using VoltageModeControl:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"inner_control() = VoltageModeControl(;\n kpv = 0.59, #Voltage controller proportional gain\n kiv = 736.0, #Voltage controller integral gain\n kffv = 0.0, #Binary variable enabling voltage feed-forward in current controllers\n rv = 0.0, #Virtual resistance in pu\n lv = 0.2, #Virtual inductance in pu\n kpc = 1.27, #Current controller proportional gain\n kic = 14.3, #Current controller integral gain\n kffi = 0.0, #Binary variable enabling the current feed-forward in output of current controllers\n ωad = 50.0, #Active damping low pass filter cut-off frequency\n kad = 0.2, #Active damping gain\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define a FixedDCSource for the DCSource:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"dc_source_lv() = FixedDCSource(; voltage = 600.0)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define a FrequencyEstimator as a phase-locked loop (PLL) using KauraPLL:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"pll() = KauraPLL(;\n ω_lp = 500.0, #Cut-off frequency for LowPass filter of PLL filter.\n kp_pll = 0.084, #PLL proportional gain\n ki_pll = 4.69, #PLL integral gain\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Finally, define an LCLFilter for the Filter:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"filt() = LCLFilter(;\n lf = 0.08,\n rf = 0.003,\n cf = 0.074,\n lg = 0.2,\n rg = 0.01,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Now, use those six functions to define a complete dynamic inverter by getting the static component at bus 103:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"gen_103 = get_component(Generator, threebus_sys, \"generator-103-1\");","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"using it and our six functions to define a DynamicInverter:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"dynamic_inv = DynamicInverter(;\n name = get_name(gen_103),\n ω_ref = 1.0, # frequency reference set-point\n converter = converter_high_power(),\n outer_control = outer_control(),\n inner_control = inner_control(),\n dc_source = dc_source_lv(),\n freq_estimator = pll(),\n filter = filt(),\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"and adding it to the System:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"add_component!(threebus_sys, dynamic_inv, gen_103)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Both generators have now been updated with dynamic data. Let's complete the System updates by adding dynamic lines.","category":"page"},{"location":"tutorials/add_dynamic_data/#Adding-Dynamic-Lines","page":"Adding Data for Dynamic Simulations","title":"Adding Dynamic Lines","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"warning: Warning\nA System must have at least two buses and one branch to run a dynamic simulation in PowerSimulationsDynamics.jl.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's review the AC branches currently in the system:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"get_components(ACBranch, threebus_sys)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that we have three static Line components.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's also print the first line to review its format:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"first(get_components(Line, threebus_sys))","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that these components do not have the fields for dynamic modeling, such as fields for different states.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's update that by cycling through these lines and using DynamicBranch to extend each static line with the necessary fields:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"for l in get_components(Line, threebus_sys)\n # create a dynamic branch\n dyn_branch = DynamicBranch(l)\n # add dynamic branch to the system, replacing the static branch\n add_component!(threebus_sys, dyn_branch)\nend","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Take a look at the AC branches in the system again:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"branches = get_components(ACBranch, threebus_sys)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that now there are 3 DynamicBranch components instead the Line components.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's take a look by printing first one:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"first(branches)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Observe that this is a wrapper around the static data, with the additional states data for dynamic modeling.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Finally, let's print the System again to summarize our additions:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"threebus_sys","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Verify that the additions were successful, with an added voltage Source, DynamicBranches replacing the static Lines, and two new dynamic components with the generator and inverter models.","category":"page"},{"location":"tutorials/add_dynamic_data/#Next-Steps","page":"Adding Data for Dynamic Simulations","title":"Next Steps","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"In this tutorial, you have updated a static system with a second dynamic data layer. The data you added can enable a phasor-based simulation using the dynamic generator, or a more complex EMT simulation with the additional dynamic inverter and dynamic lines.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Next, you might like to:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Read more about the static and dynamic data layers and the dynamic data format in Dynamic Devices.\nReview the specific sub-system models available in PowerSystems.jl for Machine, Shaft, AVR, PSS, Prime Mover and Turbine Governor, Converter, OuterControl, InnerControl, DCSource, FrequencyEstimator, and Filter components\nExplore PowerSimulationsDynamics.jl for dynamics modeling in Sienna\\Dyn","category":"page"},{"location":"model_library/generated_ThermalStandard/#ThermalStandard","page":"ThermalStandard","title":"ThermalStandard","text":"","category":"section"},{"location":"model_library/generated_ThermalStandard/","page":"ThermalStandard","title":"ThermalStandard","text":"Modules = [PowerSystems]\nPages = [\"generated/ThermalStandard.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.ThermalStandard","page":"ThermalStandard","title":"PowerSystems.ThermalStandard","text":"mutable struct ThermalStandard <: ThermalGen\n name::String\n available::Bool\n status::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n operation_cost::Union{ThermalGenerationCost, MarketBidCost}\n base_power::Float64\n time_limits::Union{Nothing, UpDown}\n must_run::Bool\n prime_mover_type::PrimeMovers\n fuel::ThermalFuels\n services::Vector{Service}\n time_at_status::Float64\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA thermal generator, such as a fossil fuel and nuclear generator.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nstatus::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)\noperation_cost::Union{ThermalGenerationCost, MarketBidCost}: OperationalCost of generation\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: (default: nothing) Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nmust_run::Bool: (default: false) Set to true if the unit is must run\nprime_mover_type::PrimeMovers: (default: PrimeMovers.OT) Prime mover technology according to EIA 923. Options are listed here\nfuel::ThermalFuels: (default: ThermalFuels.OTHER) Prime mover fuel according to EIA 923. Options are listed here\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ntime_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ThermalStandard/#InfrastructureSystems.get_name-Tuple{ThermalStandard}","page":"ThermalStandard","title":"InfrastructureSystems.get_name","text":"get_name(value::ThermalStandard) -> String\n\n\nGet ThermalStandard name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_active_power-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_active_power","text":"get_active_power(value::ThermalStandard) -> Any\n\n\nGet ThermalStandard active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_active_power_limits-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::ThermalStandard\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet ThermalStandard active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_available-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_available","text":"get_available(value::ThermalStandard) -> Bool\n\n\nGet ThermalStandard available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_base_power-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_base_power","text":"get_base_power(value::ThermalStandard) -> Float64\n\n\nGet ThermalStandard base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_bus-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_bus","text":"get_bus(value::ThermalStandard) -> ACBus\n\n\nGet ThermalStandard bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_dynamic_injector-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::ThermalStandard\n) -> Union{Nothing, DynamicInjection}\n\n\nGet ThermalStandard dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_ext-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_ext","text":"get_ext(value::ThermalStandard) -> Dict{String, Any}\n\n\nGet ThermalStandard ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_fuel-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_fuel","text":"get_fuel(value::ThermalStandard) -> ThermalFuels\n\n\nGet ThermalStandard fuel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_must_run-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_must_run","text":"get_must_run(value::ThermalStandard) -> Bool\n\n\nGet ThermalStandard must_run.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_operation_cost-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::ThermalStandard\n) -> Union{MarketBidCost, ThermalGenerationCost}\n\n\nGet ThermalStandard operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_prime_mover_type-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(value::ThermalStandard) -> PrimeMovers\n\n\nGet ThermalStandard prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_ramp_limits-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::ThermalStandard\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet ThermalStandard ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_rating-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_rating","text":"get_rating(value::ThermalStandard) -> Any\n\n\nGet ThermalStandard rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_reactive_power-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::ThermalStandard) -> Any\n\n\nGet ThermalStandard reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_reactive_power_limits-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::ThermalStandard\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet ThermalStandard reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_services-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_services","text":"get_services(value::ThermalStandard) -> Vector{Service}\n\n\nGet ThermalStandard services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_status-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_status","text":"get_status(value::ThermalStandard) -> Bool\n\n\nGet ThermalStandard status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_time_at_status-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_time_at_status","text":"get_time_at_status(value::ThermalStandard) -> Float64\n\n\nGet ThermalStandard time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_time_limits-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::ThermalStandard\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet ThermalStandard time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_active_power!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_active_power_limits!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_available!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_available!","text":"set_available!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_base_power!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_bus!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_bus!","text":"set_bus!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_ext!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_ext!","text":"set_ext!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_fuel!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_fuel!","text":"set_fuel!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard fuel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_must_run!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_must_run!","text":"set_must_run!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard must_run.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_operation_cost!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_prime_mover_type!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_ramp_limits!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_rating!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_rating!","text":"set_rating!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_reactive_power!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_reactive_power_limits!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::ThermalStandard,\n val\n) -> Any\n\n\nSet ThermalStandard reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_services!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_services!","text":"set_services!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_status!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_status!","text":"set_status!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_time_at_status!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_time_at_status!","text":"set_time_at_status!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_time_limits!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#VariableReserveNonSpinning","page":"VariableReserveNonSpinning","title":"VariableReserveNonSpinning","text":"","category":"section"},{"location":"model_library/generated_VariableReserveNonSpinning/","page":"VariableReserveNonSpinning","title":"VariableReserveNonSpinning","text":"Modules = [PowerSystems]\nPages = [\"generated/VariableReserveNonSpinning.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.VariableReserveNonSpinning","page":"VariableReserveNonSpinning","title":"PowerSystems.VariableReserveNonSpinning","text":"mutable struct VariableReserveNonSpinning <: ReserveNonSpinning\n name::String\n available::Bool\n time_frame::Float64\n requirement::Float64\n sustained_time::Float64\n max_output_fraction::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA 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.\n\nThis 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.\n\nThis is only an upwards reserve. For faster-responding upwards or downwards reserves from components already synchronized with the system, see VariableReserve\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)\nrequirement::Float64: the required quantity of the product should be scaled by a TimeSeriesData\nsustained_time::Float64: (default: 14400.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_VariableReserveNonSpinning/#InfrastructureSystems.get_name-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"InfrastructureSystems.get_name","text":"get_name(value::VariableReserveNonSpinning) -> String\n\n\nGet VariableReserveNonSpinning name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_available-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_available","text":"get_available(value::VariableReserveNonSpinning) -> Bool\n\n\nGet VariableReserveNonSpinning available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_deployed_fraction-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(\n value::VariableReserveNonSpinning\n) -> Float64\n\n\nGet VariableReserveNonSpinning deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_ext-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_ext","text":"get_ext(\n value::VariableReserveNonSpinning\n) -> Dict{String, Any}\n\n\nGet VariableReserveNonSpinning ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_max_output_fraction-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_max_output_fraction","text":"get_max_output_fraction(\n value::VariableReserveNonSpinning\n) -> Float64\n\n\nGet VariableReserveNonSpinning max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_max_participation_factor-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::VariableReserveNonSpinning\n) -> Float64\n\n\nGet VariableReserveNonSpinning max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_requirement-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_requirement","text":"get_requirement(value::VariableReserveNonSpinning) -> Any\n\n\nGet VariableReserveNonSpinning requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_sustained_time-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(\n value::VariableReserveNonSpinning\n) -> Float64\n\n\nGet VariableReserveNonSpinning sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_time_frame-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::VariableReserveNonSpinning) -> Float64\n\n\nGet VariableReserveNonSpinning time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_available!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_available!","text":"set_available!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_deployed_fraction!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_ext!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_ext!","text":"set_ext!(value::VariableReserveNonSpinning, val) -> Any\n\n\nSet VariableReserveNonSpinning ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_max_output_fraction!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_max_output_fraction!","text":"set_max_output_fraction!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_max_participation_factor!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_requirement!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_requirement!","text":"set_requirement!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_sustained_time!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_time_frame!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#Converter","page":"Converter","title":"Converter","text":"","category":"section"},{"location":"model_library/generated_Converter/#AverageConverter","page":"Converter","title":"AverageConverter","text":"","category":"section"},{"location":"model_library/generated_Converter/","page":"Converter","title":"Converter","text":"Modules = [PowerSystems]\nPages = [\"/AverageConverter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Converter/#PowerSystems.AverageConverter","page":"Converter","title":"PowerSystems.AverageConverter","text":"mutable struct AverageConverter <: Converter\n rated_voltage::Float64\n rated_current::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an average converter model\n\nArguments\n\nrated_voltage::Float64: Rated voltage (V), validation range: (0, nothing)\nrated_current::Float64: Rated current (A), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) AverageConverter has no states\nn_states::Int: (Do not modify.) AverageConverter has no states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Converter/#PowerSystems.get_ext-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_ext","text":"get_ext(value::AverageConverter) -> Dict{String, Any}\n\n\nGet AverageConverter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_n_states-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_n_states","text":"get_n_states(value::AverageConverter) -> Int64\n\n\nGet AverageConverter n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_rated_current-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_rated_current","text":"get_rated_current(value::AverageConverter) -> Float64\n\n\nGet AverageConverter rated_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_rated_voltage-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_rated_voltage","text":"get_rated_voltage(value::AverageConverter) -> Float64\n\n\nGet AverageConverter rated_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_states-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_states","text":"get_states(value::AverageConverter) -> Vector{Symbol}\n\n\nGet AverageConverter states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_ext!-Tuple{AverageConverter, Any}","page":"Converter","title":"PowerSystems.set_ext!","text":"set_ext!(value::AverageConverter, val) -> Any\n\n\nSet AverageConverter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_rated_current!-Tuple{AverageConverter, Any}","page":"Converter","title":"PowerSystems.set_rated_current!","text":"set_rated_current!(value::AverageConverter, val) -> Any\n\n\nSet AverageConverter rated_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_rated_voltage!-Tuple{AverageConverter, Any}","page":"Converter","title":"PowerSystems.set_rated_voltage!","text":"set_rated_voltage!(value::AverageConverter, val) -> Any\n\n\nSet AverageConverter rated_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#RenewableEnergyConverterTypeA","page":"Converter","title":"RenewableEnergyConverterTypeA","text":"","category":"section"},{"location":"model_library/generated_Converter/","page":"Converter","title":"Converter","text":"Modules = [PowerSystems]\nPages = [\"/RenewableEnergyConverterTypeA.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Converter/#PowerSystems.RenewableEnergyConverterTypeA","page":"Converter","title":"PowerSystems.RenewableEnergyConverterTypeA","text":"mutable struct RenewableEnergyConverterTypeA <: Converter\n T_g::Float64\n Rrpwr::Float64\n Brkpt::Float64\n Zerox::Float64\n Lvpl1::Float64\n Vo_lim::Float64\n Lv_pnts::MinMax\n Io_lim::Float64\n T_fltr::Float64\n K_hv::Float64\n Iqr_lims::MinMax\n Accel::Float64\n Lvpl_sw::Int\n Q_ref::Float64\n R_source::Float64\n X_source::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a renewable energy generator/converter model, this model corresponds to REGCA1 in PSSE\n\nArguments\n\nT_g::Float64: Converter time constant (s), validation range: (0, nothing)\nRrpwr::Float64: Low Voltage Power Logic (LVPL) ramp rate limit (pu/s), validation range: (0, nothing)\nBrkpt::Float64: LVPL characteristic voltage 2 (pu), validation range: (0, nothing)\nZerox::Float64: LVPL characteristic voltage 1 (pu), validation range: (0, nothing)\nLvpl1::Float64: LVPL gain (pu), validation range: (0, nothing)\nVo_lim::Float64: Voltage limit for high voltage reactive current management (pu), validation range: (0, nothing)\nLv_pnts::MinMax: Voltage points for low voltage active current management (pu) (Lvpnt0, Lvpnt1)\nIo_lim::Float64: Current limit (pu) for high voltage reactive current management (specified as a negative value), validation range: (nothing, 0)\nT_fltr::Float64: Voltage filter time constant for low voltage active current management (s), validation range: (0, nothing)\nK_hv::Float64: Overvoltage compensation gain used in the high voltage reactive current management, validation range: (0, nothing)\nIqr_lims::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)\nAccel::Float64: Acceleration factor, validation range: (0, 1)\nLvpl_sw::Int: Low voltage power logic (LVPL) switch. (0: LVPL not present, 1: LVPL present), validation range: (0, 1)\nQ_ref::Float64: (default: 1.0) Initial condition of reactive power from power flow, validation range: (0, nothing)\nR_source::Float64: (default: 0.0) Output resistor used for the Thevenin Equivalent, validation range: (0, nothing)\nX_source::Float64: (default: 1.0e5) Output reactance used for the Thevenin Equivalent, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\tIp: Converter lag for Ipcmd,\tIq: Converter lag for Iqcmd,\tVmeas: Voltage filter for low voltage active current management\nn_states::Int: (Do not modify.) RenewableEnergyConverterTypeA has 3 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Converter/#PowerSystems.get_Accel-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Accel","text":"get_Accel(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Accel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Brkpt-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Brkpt","text":"get_Brkpt(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Brkpt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Io_lim-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Io_lim","text":"get_Io_lim(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Io_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Iqr_lims-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Iqr_lims","text":"get_Iqr_lims(\n value::RenewableEnergyConverterTypeA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RenewableEnergyConverterTypeA Iqr_lims.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_K_hv-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_K_hv","text":"get_K_hv(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA K_hv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lv_pnts-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lv_pnts","text":"get_Lv_pnts(\n value::RenewableEnergyConverterTypeA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RenewableEnergyConverterTypeA Lv_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lvpl1-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lvpl1","text":"get_Lvpl1(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Lvpl1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lvpl_sw-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lvpl_sw","text":"get_Lvpl_sw(value::RenewableEnergyConverterTypeA) -> Int64\n\n\nGet RenewableEnergyConverterTypeA Lvpl_sw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Q_ref-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_R_source-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_R_source","text":"get_R_source(\n value::RenewableEnergyConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyConverterTypeA R_source.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Rrpwr-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Rrpwr","text":"get_Rrpwr(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_T_fltr-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_T_fltr","text":"get_T_fltr(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_T_g-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_T_g","text":"get_T_g(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Vo_lim-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Vo_lim","text":"get_Vo_lim(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Vo_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_X_source-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_X_source","text":"get_X_source(\n value::RenewableEnergyConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyConverterTypeA X_source.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Zerox-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Zerox","text":"get_Zerox(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Zerox.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_ext-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_ext","text":"get_ext(\n value::RenewableEnergyConverterTypeA\n) -> Dict{String, Any}\n\n\nGet RenewableEnergyConverterTypeA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_n_states-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_n_states","text":"get_n_states(value::RenewableEnergyConverterTypeA) -> Int64\n\n\nGet RenewableEnergyConverterTypeA n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_states-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_states","text":"get_states(\n value::RenewableEnergyConverterTypeA\n) -> Vector{Symbol}\n\n\nGet RenewableEnergyConverterTypeA states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Accel!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Accel!","text":"set_Accel!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Accel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Brkpt!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Brkpt!","text":"set_Brkpt!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Brkpt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Io_lim!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Io_lim!","text":"set_Io_lim!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Io_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Iqr_lims!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Iqr_lims!","text":"set_Iqr_lims!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Iqr_lims.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_K_hv!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_K_hv!","text":"set_K_hv!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA K_hv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lv_pnts!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lv_pnts!","text":"set_Lv_pnts!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Lv_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lvpl1!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lvpl1!","text":"set_Lvpl1!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Lvpl1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lvpl_sw!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lvpl_sw!","text":"set_Lvpl_sw!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Lvpl_sw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Q_ref!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_R_source!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_R_source!","text":"set_R_source!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA R_source.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Rrpwr!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Rrpwr!","text":"set_Rrpwr!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_T_fltr!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_T_fltr!","text":"set_T_fltr!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_T_g!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_T_g!","text":"set_T_g!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Vo_lim!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Vo_lim!","text":"set_Vo_lim!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Vo_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_X_source!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_X_source!","text":"set_X_source!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA X_source.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Zerox!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Zerox!","text":"set_Zerox!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Zerox.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_ext!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_ext!","text":"set_ext!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#RenewableEnergyVoltageConverterTypeA","page":"Converter","title":"RenewableEnergyVoltageConverterTypeA","text":"","category":"section"},{"location":"model_library/generated_Converter/","page":"Converter","title":"Converter","text":"Modules = [PowerSystems]\nPages = [\"/RenewableEnergyVoltageConverterTypeA.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Converter/#PowerSystems.RenewableEnergyVoltageConverterTypeA","page":"Converter","title":"PowerSystems.RenewableEnergyVoltageConverterTypeA","text":"mutable struct RenewableEnergyVoltageConverterTypeA <: Converter\n T_g::Float64\n Rrpwr::Float64\n Brkpt::Float64\n Zerox::Float64\n Lvpl1::Float64\n Vo_lim::Float64\n Lv_pnts::MinMax\n Io_lim::Float64\n T_fltr::Float64\n K_hv::Float64\n Iqr_lims::MinMax\n Accel::Float64\n Lvpl_sw::Int\n Q_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters 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\n\nArguments\n\nT_g::Float64: Converter time constant (s), validation range: (0, nothing)\nRrpwr::Float64: Low Voltage Power Logic (LVPL) ramp rate limit (pu/s), validation range: (0, nothing)\nBrkpt::Float64: LVPL characteristic voltage 2 (pu), validation range: (0, nothing)\nZerox::Float64: LVPL characteristic voltage 1 (pu), validation range: (0, nothing)\nLvpl1::Float64: LVPL gain (pu), validation range: (0, nothing)\nVo_lim::Float64: Voltage limit for high voltage reactive current management (pu), validation range: (0, nothing)\nLv_pnts::MinMax: Voltage points for low voltage active current management (pu) (Lvpnt0, Lvpnt1)\nIo_lim::Float64: Current limit (pu) for high voltage reactive current management (specified as a negative value), validation range: (nothing, 0)\nT_fltr::Float64: Voltage filter time constant for low voltage active current management (s), validation range: (0, nothing)\nK_hv::Float64: Overvoltage compensation gain used in the high voltage reactive current management, validation range: (0, nothing)\nIqr_lims::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)\nAccel::Float64: Acceleration factor, validation range: (0, 1)\nLvpl_sw::Int: Low voltage power logic (LVPL) switch. (0: LVPL not present, 1: LVPL present), validation range: (0, 1)\nQ_ref::Float64: (default: 1.0) Initial condition of reactive power from power flow, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\tIp: Converter lag for Ipcmd,\tIq: Converter lag for Iqcmd,\tVmeas: Voltage filter for low voltage active current management\nn_states::Int: (Do not modify.) RenewableEnergyVoltageConverterTypeA has 3 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Converter/#PowerSystems.get_Accel-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Accel","text":"get_Accel(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Accel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Brkpt-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Brkpt","text":"get_Brkpt(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Brkpt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Io_lim-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Io_lim","text":"get_Io_lim(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Io_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Iqr_lims-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Iqr_lims","text":"get_Iqr_lims(\n value::RenewableEnergyVoltageConverterTypeA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RenewableEnergyVoltageConverterTypeA Iqr_lims.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_K_hv-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_K_hv","text":"get_K_hv(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA K_hv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lv_pnts-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lv_pnts","text":"get_Lv_pnts(\n value::RenewableEnergyVoltageConverterTypeA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RenewableEnergyVoltageConverterTypeA Lv_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lvpl1-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lvpl1","text":"get_Lvpl1(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Lvpl1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lvpl_sw-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lvpl_sw","text":"get_Lvpl_sw(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Int64\n\n\nGet RenewableEnergyVoltageConverterTypeA Lvpl_sw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Q_ref-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Rrpwr-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Rrpwr","text":"get_Rrpwr(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_T_fltr-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_T_fltr","text":"get_T_fltr(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_T_g-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_T_g","text":"get_T_g(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Vo_lim-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Vo_lim","text":"get_Vo_lim(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Vo_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Zerox-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Zerox","text":"get_Zerox(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Zerox.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_ext-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_ext","text":"get_ext(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Dict{String, Any}\n\n\nGet RenewableEnergyVoltageConverterTypeA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_n_states-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_n_states","text":"get_n_states(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Int64\n\n\nGet RenewableEnergyVoltageConverterTypeA n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_states-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_states","text":"get_states(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Vector{Symbol}\n\n\nGet RenewableEnergyVoltageConverterTypeA states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Accel!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Accel!","text":"set_Accel!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Accel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Brkpt!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Brkpt!","text":"set_Brkpt!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Brkpt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Io_lim!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Io_lim!","text":"set_Io_lim!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Io_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Iqr_lims!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Iqr_lims!","text":"set_Iqr_lims!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Iqr_lims.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_K_hv!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_K_hv!","text":"set_K_hv!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA K_hv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lv_pnts!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lv_pnts!","text":"set_Lv_pnts!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Lv_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lvpl1!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lvpl1!","text":"set_Lvpl1!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Lvpl1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lvpl_sw!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lvpl_sw!","text":"set_Lvpl_sw!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Lvpl_sw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Q_ref!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Rrpwr!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Rrpwr!","text":"set_Rrpwr!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_T_fltr!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_T_fltr!","text":"set_T_fltr!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_T_g!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_T_g!","text":"set_T_g!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Vo_lim!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Vo_lim!","text":"set_Vo_lim!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Vo_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Zerox!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Zerox!","text":"set_Zerox!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Zerox.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_ext!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_ext!","text":"set_ext!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#AggregateDistributedGenerationA","page":"AggregateDistributedGenerationA","title":"AggregateDistributedGenerationA","text":"","category":"section"},{"location":"model_library/generated_AggregateDistributedGenerationA/","page":"AggregateDistributedGenerationA","title":"AggregateDistributedGenerationA","text":"Modules = [PowerSystems]\nPages = [\"generated/AggregateDistributedGenerationA.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.AggregateDistributedGenerationA","page":"AggregateDistributedGenerationA","title":"PowerSystems.AggregateDistributedGenerationA","text":"mutable struct AggregateDistributedGenerationA <: DynamicInjection\n name::String\n Pf_Flag::Int\n Freq_Flag::Int\n PQ_Flag::Int\n Gen_Flag::Int\n Vtrip_Flag::Int\n Ftrip_Flag::Int\n T_rv::Float64\n Trf::Float64\n dbd_pnts::Tuple{Float64, Float64}\n K_qv::Float64\n Tp::Float64\n T_iq::Float64\n D_dn::Float64\n D_up::Float64\n fdbd_pnts::Tuple{Float64, Float64}\n fe_lim::MinMax\n P_lim::MinMax\n dP_lim::MinMax\n Tpord::Float64\n Kpg::Float64\n Kig::Float64\n I_max::Float64\n vl_pnts::Vector{Tuple{Float64,Float64}}\n vh_pnts::Vector{Tuple{Float64,Float64}}\n Vrfrac::Float64\n fl::Float64\n fh::Float64\n tfl::Float64\n tfh::Float64\n Tg::Float64\n rrpwr::Float64\n Tv::Float64\n Vpr::Float64\n Iq_lim::MinMax\n V_ref::Float64\n Pfa_ref::Float64\n ω_ref::Float64\n Q_ref::Float64\n P_ref::Float64\n base_power::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of the DERA1 model in PSS/E\n\nArguments\n\nname::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\nPf_Flag::Int: Flag for Power Factor Control, validation range: (0, 1)\nFreq_Flag::Int: Flag to enable/disable frequency control, validation range: (0, 1)\nPQ_Flag::Int: Flag used to enforce maximum current, validation range: (0, 1)\nGen_Flag::Int: Flag to specify generator or storage, validation range: (0, 1)\nVtrip_Flag::Int: Flag to enable/disable voltage trip logic, validation range: (0, 1)\nFtrip_Flag::Int: Flag to enable/disable frequency trip logic, validation range: (0, 1)\nT_rv::Float64: Voltage measurement transducer time constant, validation range: (0, nothing)\nTrf::Float64: Frequency measurement transducer time constant, validation range: (0, nothing)\ndbd_pnts::Tuple{Float64, Float64}: Voltage deadband thresholds (dbd1, dbd2)\nK_qv::Float64: Proportional voltage control gain (pu), validation range: (0, nothing)\nTp::Float64: Power measurement transducer time constant, validation range: (0, nothing)\nT_iq::Float64: Time constant for low-pass filter for state q_V when QFlag = 0, validation range: (0, nothing)\nD_dn::Float64: Reciprocal of droop for over-frequency conditions (>0) (pu), validation range: (0, nothing)\nD_up::Float64: Reciprocal of droop for under-frequency conditions <=0) (pu), validation range: (0, nothing)\nfdbd_pnts::Tuple{Float64, Float64}: Frequency control deadband thresholds (fdbd1, fdbd2)\nfe_lim::MinMax: Frequency error limits (femin, femax)\nP_lim::MinMax: Power limits (Pmin, Pmax)\ndP_lim::MinMax: Power reference ramp rate limits (dPmin, dPmax)\nTpord::Float64: Power filter time constant, validation range: (0, nothing)\nKpg::Float64: PI controller proportional gain (pu), validation range: (0, nothing)\nKig::Float64: PI controller integral gain (pu), validation range: (0, nothing)\nI_max::Float64: Maximum limit on total converter current (pu), validation range: (0, nothing)\nvl_pnts::Vector{Tuple{Float64,Float64}}: Low voltage cutout points [(tv10, vl0), (tv11, vl1)]\nvh_pnts::Vector{Tuple{Float64,Float64}}: High voltage cutout points [(tvh0, vh0), (tvh1, vh1)]\nVrfrac::Float64: Fraction of device that recovers after voltage comes back to within vl1 < V < vh1 (0 <= Vrfrac <= 1), validation range: (0, 1)\nfl::Float64: Inverter frequency break-point for low frequency cut-out (Hz), validation range: (0, nothing)\nfh::Float64: Inverter frequency break-point for high frequency cut-out (Hz), validation range: (0, nothing)\ntfl::Float64: Low frequency cut-out timer corresponding to frequency fl (s), validation range: (0, nothing)\ntfh::Float64: High frequency cut-out timer corresponding to frequency fh (s), validation range: (0, nothing)\nTg::Float64: Current control time constant (to represent behavior of inner control loops) (> 0) (s), validation range: (0, nothing)\nrrpwr::Float64: Ramp rate for real power increase following a fault (pu/s), validation range: (0, nothing)\nTv::Float64: Time constant on the output of the multiplier (s), validation range: (0, nothing)\nVpr::Float64: Voltage below which frequency tripping is disabled (pu), validation range: (0, nothing)\nIq_lim::MinMax: Reactive current injection limits (Iqll, Iqhl)\nV_ref::Float64: (default: 1.0) User defined voltage reference. If 0, PowerSimulationsDynamics.jl initializes to initial terminal voltage, validation range: (0, nothing)\nPfa_ref::Float64: (default: 0.0) Reference power factor, validation range: (0, nothing)\nω_ref::Float64: (default: 1.0) Reference Frequency (pu), validation range: (0, nothing)\nQ_ref::Float64: (default: 0.0) Reference reactive power, in pu, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference active power, in pu, validation range: (0, nothing)\nbase_power::Float64: (default: 100.0) Base power (MVA) for per unitization\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of AggregateDistributedGenerationA depends on the Flags\nn_states::Int: (Do not modify.) The states of AggregateDistributedGenerationA depends on the Flags\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AggregateDistributedGenerationA/#InfrastructureSystems.get_name-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"InfrastructureSystems.get_name","text":"get_name(value::AggregateDistributedGenerationA) -> String\n\n\nGet AggregateDistributedGenerationA name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_D_dn-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_D_dn","text":"get_D_dn(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_D_up-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_D_up","text":"get_D_up(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Freq_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Freq_Flag","text":"get_Freq_Flag(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA Freq_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Ftrip_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Ftrip_Flag","text":"get_Ftrip_Flag(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA Ftrip_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Gen_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Gen_Flag","text":"get_Gen_Flag(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA Gen_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_I_max-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_I_max","text":"get_I_max(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Iq_lim-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Iq_lim","text":"get_Iq_lim(\n value::AggregateDistributedGenerationA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AggregateDistributedGenerationA Iq_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_K_qv-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_K_qv","text":"get_K_qv(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA K_qv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Kig-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Kig","text":"get_Kig(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Kig.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Kpg-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Kpg","text":"get_Kpg(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Kpg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_PQ_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_PQ_Flag","text":"get_PQ_Flag(value::AggregateDistributedGenerationA) -> Int64\n\n\nGet AggregateDistributedGenerationA PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_P_lim-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_P_lim","text":"get_P_lim(\n value::AggregateDistributedGenerationA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AggregateDistributedGenerationA P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_P_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Pf_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Pf_Flag","text":"get_Pf_Flag(value::AggregateDistributedGenerationA) -> Int64\n\n\nGet AggregateDistributedGenerationA Pf_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Pfa_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Pfa_ref","text":"get_Pfa_ref(\n value::AggregateDistributedGenerationA\n) -> Float64\n\n\nGet AggregateDistributedGenerationA Pfa_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Q_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_T_iq-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_T_iq","text":"get_T_iq(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA T_iq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_T_rv-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_T_rv","text":"get_T_rv(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA T_rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Tg-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Tg","text":"get_Tg(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Tp-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Tp","text":"get_Tp(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Tp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Tpord-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Tpord","text":"get_Tpord(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Tpord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Trf-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Trf","text":"get_Trf(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Trf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Tv-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Tv","text":"get_Tv(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Tv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_V_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Vpr-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Vpr","text":"get_Vpr(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Vpr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Vrfrac-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Vrfrac","text":"get_Vrfrac(\n value::AggregateDistributedGenerationA\n) -> Float64\n\n\nGet AggregateDistributedGenerationA Vrfrac.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Vtrip_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Vtrip_Flag","text":"get_Vtrip_Flag(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA Vtrip_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_base_power-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_base_power","text":"get_base_power(\n value::AggregateDistributedGenerationA\n) -> Float64\n\n\nGet AggregateDistributedGenerationA base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_dP_lim-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_dP_lim","text":"get_dP_lim(\n value::AggregateDistributedGenerationA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AggregateDistributedGenerationA dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_dbd_pnts-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_dbd_pnts","text":"get_dbd_pnts(\n value::AggregateDistributedGenerationA\n) -> Tuple{Float64, Float64}\n\n\nGet AggregateDistributedGenerationA dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_ext-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_ext","text":"get_ext(\n value::AggregateDistributedGenerationA\n) -> Dict{String, Any}\n\n\nGet AggregateDistributedGenerationA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_fdbd_pnts-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_fdbd_pnts","text":"get_fdbd_pnts(\n value::AggregateDistributedGenerationA\n) -> Tuple{Float64, Float64}\n\n\nGet AggregateDistributedGenerationA fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_fe_lim-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_fe_lim","text":"get_fe_lim(\n value::AggregateDistributedGenerationA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AggregateDistributedGenerationA fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_fh-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_fh","text":"get_fh(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA fh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_fl-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_fl","text":"get_fl(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA fl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_n_states-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_n_states","text":"get_n_states(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_rrpwr-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_rrpwr","text":"get_rrpwr(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_states-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_states","text":"get_states(\n value::AggregateDistributedGenerationA\n) -> Vector{Symbol}\n\n\nGet AggregateDistributedGenerationA states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_tfh-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_tfh","text":"get_tfh(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA tfh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_tfl-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_tfl","text":"get_tfl(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA tfl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_vh_pnts-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_vh_pnts","text":"get_vh_pnts(\n value::AggregateDistributedGenerationA\n) -> Vector{Tuple{Float64, Float64}}\n\n\nGet AggregateDistributedGenerationA vh_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_vl_pnts-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_vl_pnts","text":"get_vl_pnts(\n value::AggregateDistributedGenerationA\n) -> Vector{Tuple{Float64, Float64}}\n\n\nGet AggregateDistributedGenerationA vl_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_ω_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_ω_ref","text":"get_ω_ref(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA ω_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_D_dn!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_D_dn!","text":"set_D_dn!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_D_up!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_D_up!","text":"set_D_up!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Freq_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Freq_Flag!","text":"set_Freq_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Freq_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Ftrip_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Ftrip_Flag!","text":"set_Ftrip_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Ftrip_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Gen_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Gen_Flag!","text":"set_Gen_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Gen_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_I_max!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_I_max!","text":"set_I_max!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Iq_lim!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Iq_lim!","text":"set_Iq_lim!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Iq_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_K_qv!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_K_qv!","text":"set_K_qv!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA K_qv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Kig!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Kig!","text":"set_Kig!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Kig.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Kpg!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Kpg!","text":"set_Kpg!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Kpg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_PQ_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_PQ_Flag!","text":"set_PQ_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_P_lim!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_P_lim!","text":"set_P_lim!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_P_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Pf_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Pf_Flag!","text":"set_Pf_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Pf_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Pfa_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Pfa_ref!","text":"set_Pfa_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Pfa_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Q_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_T_iq!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_T_iq!","text":"set_T_iq!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA T_iq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_T_rv!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_T_rv!","text":"set_T_rv!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA T_rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Tg!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Tg!","text":"set_Tg!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Tp!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Tp!","text":"set_Tp!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Tp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Tpord!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Tpord!","text":"set_Tpord!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Tpord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Trf!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Trf!","text":"set_Trf!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Trf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Tv!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Tv!","text":"set_Tv!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Tv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_V_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Vpr!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Vpr!","text":"set_Vpr!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Vpr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Vrfrac!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Vrfrac!","text":"set_Vrfrac!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Vrfrac.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Vtrip_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Vtrip_Flag!","text":"set_Vtrip_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Vtrip_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_base_power!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_base_power!","text":"set_base_power!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_dP_lim!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_dP_lim!","text":"set_dP_lim!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_dbd_pnts!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_dbd_pnts!","text":"set_dbd_pnts!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_ext!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_ext!","text":"set_ext!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_fdbd_pnts!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_fdbd_pnts!","text":"set_fdbd_pnts!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_fe_lim!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_fe_lim!","text":"set_fe_lim!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_fh!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_fh!","text":"set_fh!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA fh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_fl!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_fl!","text":"set_fl!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA fl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_rrpwr!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_rrpwr!","text":"set_rrpwr!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_tfh!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_tfh!","text":"set_tfh!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA tfh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_tfl!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_tfl!","text":"set_tfl!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA tfl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_vh_pnts!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_vh_pnts!","text":"set_vh_pnts!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA vh_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_vl_pnts!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_vl_pnts!","text":"set_vl_pnts!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA vl_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_ω_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_ω_ref!","text":"set_ω_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA ω_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PhaseShiftingTransformer","page":"PhaseShiftingTransformer","title":"PhaseShiftingTransformer","text":"","category":"section"},{"location":"model_library/generated_PhaseShiftingTransformer/","page":"PhaseShiftingTransformer","title":"PhaseShiftingTransformer","text":"Modules = [PowerSystems]\nPages = [\"generated/PhaseShiftingTransformer.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.PhaseShiftingTransformer","page":"PhaseShiftingTransformer","title":"PowerSystems.PhaseShiftingTransformer","text":"mutable struct PhaseShiftingTransformer <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n primary_shunt::Float64\n tap::Float64\n α::Float64\n rating::Union{Nothing, Float64}\n phase_angle_limits::MinMax\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA phase-shifting transformer regulating the phase angle between two buses to control active power flow in the system.\n\nThe 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow through the transformer (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow through the transformer (MVAR)\narc::Arc: An Arc defining this transformer from a bus to another bus\nr::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)\nx::Float64: Reactance in pu (SYSTEM_BASE), validation range: (-2, 4)\nprimary_shunt::Float64:, validation range: (0, 2)\ntap::Float64: Normalized tap changer position for voltage control, varying between 0 and 2, with 1 centered at the nominal voltage, validation range: (0, 2)\nα::Float64: Initial condition of phase shift (radians) between the from and to buses , validation range: (-1.571, 1.571)\nrating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating and rating. When defining a transformer before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to, validation range: (0, nothing)\nphase_angle_limits::MinMax: (default: (min=-1.571, max=1.571)) Minimum and maximum phase angle limits (radians), validation range: (-1.571, 1.571)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PhaseShiftingTransformer/#InfrastructureSystems.get_name-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"InfrastructureSystems.get_name","text":"get_name(value::PhaseShiftingTransformer) -> String\n\n\nGet PhaseShiftingTransformer name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_active_power_flow-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(\n value::PhaseShiftingTransformer\n) -> Any\n\n\nGet PhaseShiftingTransformer active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_arc-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_arc","text":"get_arc(value::PhaseShiftingTransformer) -> Arc\n\n\nGet PhaseShiftingTransformer arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_available-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_available","text":"get_available(value::PhaseShiftingTransformer) -> Bool\n\n\nGet PhaseShiftingTransformer available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_ext-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_ext","text":"get_ext(\n value::PhaseShiftingTransformer\n) -> Dict{String, Any}\n\n\nGet PhaseShiftingTransformer ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_phase_angle_limits-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_phase_angle_limits","text":"get_phase_angle_limits(\n value::PhaseShiftingTransformer\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet PhaseShiftingTransformer phase_angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_primary_shunt-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_primary_shunt","text":"get_primary_shunt(\n value::PhaseShiftingTransformer\n) -> Float64\n\n\nGet PhaseShiftingTransformer primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_r-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_r","text":"get_r(value::PhaseShiftingTransformer) -> Float64\n\n\nGet PhaseShiftingTransformer r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_rating-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_rating","text":"get_rating(value::PhaseShiftingTransformer) -> Any\n\n\nGet PhaseShiftingTransformer rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_reactive_power_flow-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(\n value::PhaseShiftingTransformer\n) -> Any\n\n\nGet PhaseShiftingTransformer reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_services-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_services","text":"get_services(\n value::PhaseShiftingTransformer\n) -> Vector{Service}\n\n\nGet PhaseShiftingTransformer services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_tap-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_tap","text":"get_tap(value::PhaseShiftingTransformer) -> Float64\n\n\nGet PhaseShiftingTransformer tap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_x-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_x","text":"get_x(value::PhaseShiftingTransformer) -> Float64\n\n\nGet PhaseShiftingTransformer x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_α-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_α","text":"get_α(value::PhaseShiftingTransformer) -> Float64\n\n\nGet PhaseShiftingTransformer α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_active_power_flow!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::PhaseShiftingTransformer,\n val\n) -> Any\n\n\nSet PhaseShiftingTransformer active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_arc!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_arc!","text":"set_arc!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_available!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_available!","text":"set_available!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_ext!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_ext!","text":"set_ext!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_phase_angle_limits!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_phase_angle_limits!","text":"set_phase_angle_limits!(\n value::PhaseShiftingTransformer,\n val\n) -> Any\n\n\nSet PhaseShiftingTransformer phase_angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_primary_shunt!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_primary_shunt!","text":"set_primary_shunt!(\n value::PhaseShiftingTransformer,\n val\n) -> Any\n\n\nSet PhaseShiftingTransformer primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_r!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_r!","text":"set_r!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_rating!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_rating!","text":"set_rating!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_reactive_power_flow!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(\n value::PhaseShiftingTransformer,\n val\n) -> Any\n\n\nSet PhaseShiftingTransformer reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_services!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_services!","text":"set_services!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_tap!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_tap!","text":"set_tap!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer tap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_x!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_x!","text":"set_x!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_α!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_α!","text":"set_α!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer α.\n\n\n\n\n\n","category":"method"},{"location":"explanation/system/#system_doc","page":"System","title":"System","text":"","category":"section"},{"location":"explanation/system/","page":"System","title":"System","text":"The System is the main container of components and the time series data references. PowerSystems.jl uses a hybrid approach to data storage, where the component data and time series references are stored in volatile memory while the actual time series data is stored in an HDF5 file. This design loads into memory the portions of the data that are relevant at time of the query, and so avoids overwhelming the memory resources.","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"","category":"page"},{"location":"explanation/system/#Accessing-components-stored-in-the-System","page":"System","title":"Accessing components stored in the System","text":"","category":"section"},{"location":"explanation/system/","page":"System","title":"System","text":"PowerSystems.jl implements a wide variety of methods to search for components to aid in data manipulation. Most of these use the Type Structure to retrieve all components of a certain Type.","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"For example, the most common search function is get_components, which takes a desired device Type (concrete or abstract) and retrieves all components in that category from the System. It also accepts filter functions for a more refined search.","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"Given the potential size of the return, PowerSystems.jl returns Julia iterators in order to avoid unnecessary memory allocations. The container is optimized for iteration over abstract or concrete component types as described by the Type Structure.","category":"page"},{"location":"explanation/system/#dot_access","page":"System","title":"Accessing data stored in a component","text":"","category":"section"},{"location":"explanation/system/","page":"System","title":"System","text":"Using the \"dot\" access to get a parameter value from a component is actively discouraged, use \"getter\" functions instead","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"Using code autogeneration, PowerSystems.jl implements accessor (or \"getter\") functions to enable the retrieval of parameters defined in the component struct fields. Julia syntax enables access to this data using the \"dot\" access (e.g. component.field), however this is actively discouraged for two reasons:","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"We make no guarantees on the stability of component structure definitions. We will maintain version stability on the accessor methods.\nPer-unit conversions are made in the return of data from the accessor functions. (see the per-unit section for more details)","category":"page"},{"location":"model_library/generated_PeriodicVariableSource/#PeriodicVariableSource","page":"PeriodicVariableSource","title":"PeriodicVariableSource","text":"","category":"section"},{"location":"model_library/generated_PeriodicVariableSource/","page":"PeriodicVariableSource","title":"PeriodicVariableSource","text":"Modules = [PowerSystems]\nPages = [\"generated/PeriodicVariableSource.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.PeriodicVariableSource","page":"PeriodicVariableSource","title":"PowerSystems.PeriodicVariableSource","text":"mutable struct PeriodicVariableSource <: DynamicInjection\n name::String\n R_th::Float64\n X_th::Float64\n internal_voltage_bias::Float64\n internal_voltage_frequencies::Vector{Float64}\n internal_voltage_coefficients::Vector{Tuple{Float64,Float64}}\n internal_angle_bias::Float64\n internal_angle_frequencies::Vector{Float64}\n internal_angle_coefficients::Vector{Tuple{Float64,Float64}}\n base_power::Float64\n states::Vector{Symbol}\n n_states::Int\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nThis struct acts as an infinity bus with time varying phasor values magnitude and angle V(t) \theta(t). Time varying functions are represented using fourier series\n\nArguments\n\nname::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\nR_th::Float64: Source Thevenin resistance, validation range: (0, nothing)\nX_th::Float64: Source Thevenin reactance, validation range: (0, nothing)\ninternal_voltage_bias::Float64: (default: 0.0) a0 term of the Fourier Series for the voltage\ninternal_voltage_frequencies::Vector{Float64}: (default: [0.0]) Frequencies in radians/s\ninternal_voltage_coefficients::Vector{Tuple{Float64,Float64}}: (default: [(0.0, 0.0)]) Coefficients for terms n > 1. First component corresponds to sin and second component to cos\ninternal_angle_bias::Float64: (default: 0.0) a0 term of the Fourier Series for the angle\ninternal_angle_frequencies::Vector{Float64}: (default: [0.0]) Frequencies in radians/s\ninternal_angle_coefficients::Vector{Tuple{Float64,Float64}}: (default: [(0.0, 0.0)]) Coefficients for terms n > 1. First component corresponds to sin and second component to cos\nbase_power::Float64: (default: 100.0) Base power of the source (MVA) for per unitization\nstates::Vector{Symbol}: (Do not modify.) The states for time, voltage and angle\nn_states::Int: (Do not modify.) PeriodicVariableSource has 2 states\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PeriodicVariableSource/#InfrastructureSystems.get_name-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"InfrastructureSystems.get_name","text":"get_name(value::PeriodicVariableSource) -> String\n\n\nGet PeriodicVariableSource name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_R_th-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_R_th","text":"get_R_th(value::PeriodicVariableSource) -> Float64\n\n\nGet PeriodicVariableSource R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_X_th-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_X_th","text":"get_X_th(value::PeriodicVariableSource) -> Float64\n\n\nGet PeriodicVariableSource X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_base_power-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_base_power","text":"get_base_power(value::PeriodicVariableSource) -> Float64\n\n\nGet PeriodicVariableSource base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_ext-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_ext","text":"get_ext(value::PeriodicVariableSource) -> Dict{String, Any}\n\n\nGet PeriodicVariableSource ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_angle_bias-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_angle_bias","text":"get_internal_angle_bias(\n value::PeriodicVariableSource\n) -> Float64\n\n\nGet PeriodicVariableSource internal_angle_bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_angle_coefficients-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_angle_coefficients","text":"get_internal_angle_coefficients(\n value::PeriodicVariableSource\n) -> Vector{Tuple{Float64, Float64}}\n\n\nGet PeriodicVariableSource internal_angle_coefficients.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_angle_frequencies-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_angle_frequencies","text":"get_internal_angle_frequencies(\n value::PeriodicVariableSource\n) -> Vector{Float64}\n\n\nGet PeriodicVariableSource internal_angle_frequencies.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_voltage_bias-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_voltage_bias","text":"get_internal_voltage_bias(\n value::PeriodicVariableSource\n) -> Float64\n\n\nGet PeriodicVariableSource internal_voltage_bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_voltage_coefficients-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_voltage_coefficients","text":"get_internal_voltage_coefficients(\n value::PeriodicVariableSource\n) -> Vector{Tuple{Float64, Float64}}\n\n\nGet PeriodicVariableSource internal_voltage_coefficients.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_voltage_frequencies-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_voltage_frequencies","text":"get_internal_voltage_frequencies(\n value::PeriodicVariableSource\n) -> Vector{Float64}\n\n\nGet PeriodicVariableSource internal_voltage_frequencies.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_n_states-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_n_states","text":"get_n_states(value::PeriodicVariableSource) -> Int64\n\n\nGet PeriodicVariableSource n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_states-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_states","text":"get_states(value::PeriodicVariableSource) -> Vector{Symbol}\n\n\nGet PeriodicVariableSource states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_R_th!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_R_th!","text":"set_R_th!(value::PeriodicVariableSource, val) -> Any\n\n\nSet PeriodicVariableSource R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_X_th!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_X_th!","text":"set_X_th!(value::PeriodicVariableSource, val) -> Any\n\n\nSet PeriodicVariableSource X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_base_power!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::PeriodicVariableSource, val) -> Any\n\n\nSet PeriodicVariableSource base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_ext!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_ext!","text":"set_ext!(value::PeriodicVariableSource, val) -> Any\n\n\nSet PeriodicVariableSource ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_angle_bias!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_angle_bias!","text":"set_internal_angle_bias!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_angle_bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_angle_coefficients!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_angle_coefficients!","text":"set_internal_angle_coefficients!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_angle_coefficients.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_angle_frequencies!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_angle_frequencies!","text":"set_internal_angle_frequencies!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_angle_frequencies.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_voltage_bias!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_voltage_bias!","text":"set_internal_voltage_bias!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_voltage_bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_voltage_coefficients!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_voltage_coefficients!","text":"set_internal_voltage_coefficients!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_voltage_coefficients.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_voltage_frequencies!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_voltage_frequencies!","text":"set_internal_voltage_frequencies!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_voltage_frequencies.\n\n\n\n\n\n","category":"method"},{"location":"api/enumerated_types/#Specifying-the-type-of...","page":"Specifying the category of...","title":"Specifying the type of...","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Some fields in PowerSystems.jl are specified with an option from a pre-defined list (Specified with IS.scoped_enums).","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Example syntax:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"set_fuel!(gen, ThermalFuels.COAL)","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"These predefined lists are below:","category":"page"},{"location":"api/enumerated_types/#acbustypes_list","page":"Specifying the category of...","title":"AC Buses","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"ACBusTypes categorize buses for modeling activities and denote which quantities are specified for load flow calculations. ACBusTypes has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name Description\nISOLATED Disconnected from network\nPQ Active and reactive power defined (load bus)\nPV Active power and voltage magnitude defined (generator bus)\nREF Reference bus (θ = 0)\nSLACK Slack bus","category":"page"},{"location":"api/enumerated_types/#pm_list","page":"Specifying the category of...","title":"Prime Movers","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Each generator contains a field for prime_mover::PrimeMovers, based on the options in EIA form 923. PrimeMovers has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name Description\nBA Energy Storage, Battery\nBT Turbines Used in a Binary Cycle (including those used for geothermal applications)\nCA Combined-Cycle – Steam Part\nCC Combined-Cycle - Aggregated Plant *augmentation of EIA\nCE Energy Storage, Compressed Air\nCP Energy Storage, Concentrated Solar Power\nCS Combined-Cycle Single-Shaft Combustion turbine and steam turbine share a single generator\nCT Combined-Cycle Combustion Turbine Part\nES Energy Storage, Other\nFC Fuel Cell\nFW Energy Storage, Flywheel\nGT Combustion (Gas) Turbine (including jet engine design)\nHA Hydrokinetic, Axial Flow Turbine\nHB Hydrokinetic, Wave Buoy\nHK Hydrokinetic, Other\nHY Hydraulic Turbine (including turbines associated with delivery of water by pipeline)\nIC Internal Combustion (diesel, piston, reciprocating) Engine\nPS Energy Storage, Reversible Hydraulic Turbine (Pumped Storage)\nOT Other\nST Steam Turbine (including nuclear, geothermal and solar steam; does not include combined-cycle turbine)\nPVe Photovoltaic (Note: renaming from EIA PV to PVe to avoid conflict with ACBusType.PV)\nWT Wind Turbine, Onshore\nWS Wind Turbine, Offshore","category":"page"},{"location":"api/enumerated_types/#tf_list","page":"Specifying the category of...","title":"Fuels for Thermal Generators","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Each ThermalGen generator has a field for fuel::ThermalFuels where ThermalFuels are intended to reflect the options in the Aggregated Fuel Codes from the EIA Annual Energy Review. ThermalFuels has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name EIA Fuel Code Description\nCOAL COL Anthracite Coal and Bituminous Coal\nWASTE_COAL WOC Waste/Other Coal (includes anthracite culm, gob, fine coal, lignite waste, waste coal)\nDISTILLATE_FUEL_OIL DFO Distillate Fuel Oil (Diesel, No. 1, No. 2, and No. 4)\nWASTE_OIL WOO Waste Oil Kerosene and JetFuel Butane, Propane\nPETROLEUM_COKE PC Petroleum Coke\nRESIDUAL_FUEL_OIL RFO Residual Fuel Oil (No. 5, No. 6 Fuel Oils, and Bunker Oil)\nNATURAL_GAS NG Natural Gas\nOTHER_GAS OOG Other Gas and blast furnace gas\nNUCLEAR NUC Nuclear Fission (Uranium, Plutonium, Thorium)\nAG_BIPRODUCT ORW Agricultural Crop Byproducts/Straw/Energy Crops\nMUNICIPAL_WASTE MLG Municipal Solid Waste – Biogenic component\nWOOD_WASTE WWW Wood Waste Liquids excluding Black Liquor (BLQ) (Includes red liquor, sludge wood, spent sulfite liquor, and other wood-based liquids)\nGEOTHERMAL GEO Geothermal\nOTHER OTH Other","category":"page"},{"location":"api/enumerated_types/#storagetech_list","page":"Specifying the category of...","title":"Energy Storage","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"StorageTech defines the storage technology used in an energy Storage system, based on the options in EIA form 923. StorageTech has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name Description\nPTES Pumped thermal energy storage\nLIB LiON Battery\nLAB Lead Acid Battery\nFLWB Redox Flow Battery\nSIB Sodium Ion Battery\nZIB Zinc Ion Battery\nHGS Hydrogen Gas Storage\nLAES Liquid Air Storage\nOTHER_CHEM Other Chemical Storage\nOTHER_MECH Other Mechanical Storage\nOTHER_THERM Other Thermal Storage","category":"page"},{"location":"api/enumerated_types/#states_list","page":"Specifying the category of...","title":"Dynamic States","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"StateTypes are used to denote the type of dynamic equation a specific state is subject to in PowerSimulationsDynamics.jl. StateTypes has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name Description\nDifferential State evolves over time via a differential equation dotx = f(x)\nAlgebraic State evolves over time by satisfying an algebraic equation 0 = g(x)\nHybrid Depending on specific parameters, the state can be Differential or Algebraic","category":"page"},{"location":"api/enumerated_types/#angleunits_list","page":"Specifying the category of...","title":"Angle Units","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"AngleUnits can be specified in:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name\nDEGREES\nRADIANS","category":"page"},{"location":"model_library/load_cost/#LoadCost","page":"LoadCost","title":"LoadCost","text":"","category":"section"},{"location":"model_library/load_cost/","page":"LoadCost","title":"LoadCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/LoadCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/load_cost/#PowerSystems.LoadCost","page":"LoadCost","title":"PowerSystems.LoadCost","text":"mutable struct LoadCost <: OperationalCost\n\nvariable::CostCurve: Variable cost represented as a CostCurve\nfixed::Float64: (default: 0) Fixed cost. For some cost represenations this field can be duplicative\n\nLoadCost(variable, fixed)\nLoadCost(; variable, fixed)\n\nAn operational cost for controllable loads (e.g., InterruptiblePowerLoad), including fixed and variable cost components.\n\nThe variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.\n\n\n\n\n\n","category":"type"},{"location":"model_library/load_cost/#PowerSystems.get_fixed-Tuple{LoadCost}","page":"LoadCost","title":"PowerSystems.get_fixed","text":"get_fixed(value::LoadCost) -> Float64\n\n\nGet LoadCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/load_cost/#PowerSystems.get_variable-Tuple{LoadCost}","page":"LoadCost","title":"PowerSystems.get_variable","text":"get_variable(value::LoadCost) -> CostCurve\n\n\nGet LoadCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/load_cost/#PowerSystems.set_fixed!-Tuple{LoadCost, Any}","page":"LoadCost","title":"PowerSystems.set_fixed!","text":"set_fixed!(value::LoadCost, val) -> Any\n\n\nSet LoadCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/load_cost/#PowerSystems.set_variable!-Tuple{LoadCost, Any}","page":"LoadCost","title":"PowerSystems.set_variable!","text":"set_variable!(value::LoadCost, val) -> Any\n\n\nSet LoadCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#ThermalGenerationCost","page":"ThermalGenerationCost","title":"ThermalGenerationCost","text":"","category":"section"},{"location":"model_library/thermal_generation_cost/","page":"ThermalGenerationCost","title":"ThermalGenerationCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/ThermalGenerationCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/thermal_generation_cost/#PowerSystems.ThermalGenerationCost","page":"ThermalGenerationCost","title":"PowerSystems.ThermalGenerationCost","text":"mutable struct ThermalGenerationCost <: OperationalCost\n\nvariable::ProductionVariableCostCurve: Variable production cost. Can take a CostCurve or FuelCurve\nfixed::Float64: Fixed cost of keeping the unit online. For some cost represenations this field can be duplicative\nstart_up::Union{Float64, @NamedTuple{hot::Float64, warm::Float64, cold::Float64}}: Start-up cost can take linear or multi-stage cost\nshut_down::Float64: Cost to turn the unit off\n\nThermalGenerationCost(variable, fixed, start_up, shut_down)\nThermalGenerationCost(; variable, fixed, start_up, shut_down)\n\nAn operational cost for thermal generators which includes fixed cost, variable cost, shut-down cost, and multiple options for start up costs.\n\n\n\n\n\n","category":"type"},{"location":"model_library/thermal_generation_cost/#PowerSystems.get_fixed-Tuple{ThermalGenerationCost}","page":"ThermalGenerationCost","title":"PowerSystems.get_fixed","text":"get_fixed(value::ThermalGenerationCost) -> Float64\n\n\nGet ThermalGenerationCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.get_shut_down-Tuple{ThermalGenerationCost}","page":"ThermalGenerationCost","title":"PowerSystems.get_shut_down","text":"get_shut_down(value::ThermalGenerationCost) -> Float64\n\n\nGet ThermalGenerationCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.get_start_up-Tuple{ThermalGenerationCost}","page":"ThermalGenerationCost","title":"PowerSystems.get_start_up","text":"get_start_up(\n value::ThermalGenerationCost\n) -> Union{Float64, @NamedTuple{hot::Float64, warm::Float64, cold::Float64}}\n\n\nGet ThermalGenerationCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.get_variable-Tuple{ThermalGenerationCost}","page":"ThermalGenerationCost","title":"PowerSystems.get_variable","text":"get_variable(\n value::ThermalGenerationCost\n) -> ProductionVariableCostCurve\n\n\nGet ThermalGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.set_fixed!-Tuple{ThermalGenerationCost, Any}","page":"ThermalGenerationCost","title":"PowerSystems.set_fixed!","text":"set_fixed!(value::ThermalGenerationCost, val) -> Any\n\n\nSet ThermalGenerationCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.set_shut_down!-Tuple{ThermalGenerationCost, Any}","page":"ThermalGenerationCost","title":"PowerSystems.set_shut_down!","text":"set_shut_down!(value::ThermalGenerationCost, val) -> Any\n\n\nSet ThermalGenerationCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.set_start_up!-Tuple{ThermalGenerationCost, Any}","page":"ThermalGenerationCost","title":"PowerSystems.set_start_up!","text":"set_start_up!(value::ThermalGenerationCost, val) -> Any\n\n\nSet ThermalGenerationCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.set_variable!-Tuple{ThermalGenerationCost, Any}","page":"ThermalGenerationCost","title":"PowerSystems.set_variable!","text":"set_variable!(value::ThermalGenerationCost, val) -> Any\n\n\nSet ThermalGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerLoad","page":"PowerLoad","title":"PowerLoad","text":"","category":"section"},{"location":"model_library/generated_PowerLoad/","page":"PowerLoad","title":"PowerLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/PowerLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PowerLoad/#PowerSystems.PowerLoad","page":"PowerLoad","title":"PowerSystems.PowerLoad","text":"mutable struct PowerLoad <: StaticLoad\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n base_power::Float64\n max_active_power::Float64\n max_reactive_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA static power load, most commonly used for operational models such as power flow and operational optimizations.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_power::Float64: Initial steady-state active power demand (MW)\nreactive_power::Float64: Initial steady-state reactive power demand (MVAR)\nbase_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)\nmax_active_power::Float64: Maximum active power (MW) that this load can demand\nmax_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PowerLoad/#InfrastructureSystems.get_name-Tuple{PowerLoad}","page":"PowerLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::PowerLoad) -> String\n\n\nGet PowerLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_active_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_active_power","text":"get_active_power(value::PowerLoad) -> Any\n\n\nGet PowerLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_available-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_available","text":"get_available(value::PowerLoad) -> Bool\n\n\nGet PowerLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_base_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::PowerLoad) -> Float64\n\n\nGet PowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_bus-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_bus","text":"get_bus(value::PowerLoad) -> ACBus\n\n\nGet PowerLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_dynamic_injector-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::PowerLoad\n) -> Union{Nothing, DynamicInjection}\n\n\nGet PowerLoad dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_ext-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_ext","text":"get_ext(value::PowerLoad) -> Dict{String, Any}\n\n\nGet PowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_max_active_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(value::PowerLoad) -> Any\n\n\nGet PowerLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_max_reactive_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(value::PowerLoad) -> Any\n\n\nGet PowerLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_reactive_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::PowerLoad) -> Any\n\n\nGet PowerLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_services-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_services","text":"get_services(value::PowerLoad) -> Vector{Service}\n\n\nGet PowerLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_active_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_available!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_available!","text":"set_available!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_base_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_bus!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_bus!","text":"set_bus!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_ext!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_max_active_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_max_active_power!","text":"set_max_active_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_max_reactive_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_max_reactive_power!","text":"set_max_reactive_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_reactive_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_services!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_services!","text":"set_services!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad services.\n\n\n\n\n\n","category":"method"},{"location":"tutorials/working_with_time_series/#tutorial_time_series","page":"Working with Time Series","title":"Working with Time Series Data","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"In this tutorial, we will manually add, retrieve, and inspect time-series data in different formats, including identifying which components in a power System have time series data. Along the way, we will also use workarounds for missing forecast data and reuse identical time series profiles to avoid unnecessary memory usage.","category":"page"},{"location":"tutorials/working_with_time_series/#Example-Data-and-Setup","page":"Working with Time Series","title":"Example Data and Setup","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"We will make an example System with a wind generator and two loads, and add the time series needed to model, for example, the impacts of wind forecast uncertainty.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Here is the available data:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"For the wind generator, we have the historical point (deterministic) forecasts of power output. The forecasts were generated every 30 minutes with a 5-minute resolution and 1-hour horizon. We also have measurements what actually happened at 5-minute resolution over the 2 hours.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"For the loads, note that the forecast data is missing. We only have the historical measurements of total load for the system, which is normalized to the system's peak load.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Load the PowerSystems, Dates, and TimeSeries packages to get started:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"using PowerSystems\nusing Dates\nusing TimeSeries","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"As usual, we need to define a power System that holds all our data. Let's define a simple system with a bus, a wind generator, and two loads:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"system = System(100.0); # 100 MVA base power\n\nbus1 = ACBus(;\n number = 1,\n name = \"bus1\",\n bustype = ACBusTypes.REF,\n angle = 0.0,\n magnitude = 1.0,\n voltage_limits = (min = 0.9, max = 1.05),\n base_voltage = 230.0,\n);\n\nwind1 = RenewableDispatch(;\n name = \"wind1\",\n available = true,\n bus = bus1,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n rating = 1.0, # 10 MW per-unitized by device base_power\n prime_mover_type = PrimeMovers.WT,\n reactive_power_limits = (min = 0.0, max = 0.0), # per-unitized by device base_power\n power_factor = 1.0,\n operation_cost = RenewableGenerationCost(nothing),\n base_power = 10.0, # MVA\n);\n\nload1 = PowerLoad(;\n name = \"load1\",\n available = true,\n bus = bus1,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n base_power = 10.0, # MVA\n max_active_power = 1.0, # 10 MW per-unitized by device base_power\n max_reactive_power = 0.0,\n);\n\nload2 = PowerLoad(;\n name = \"load2\",\n available = true,\n bus = bus1,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n base_power = 30.0, # MVA\n max_active_power = 1.0, # 10 MW per-unitized by device base_power\n max_reactive_power = 0.0,\n);\n\nadd_components!(system, [bus1, wind1, load1, load2])","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Recall that we can also set the System's unit base to natural units (MW) to make it easier to inspect results:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"set_units_base_system!(system, \"NATURAL_UNITS\")","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Before we get started, print wind1 to see its data:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind1","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See the has_time_series field at the bottom is false.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Recall that we also can see a summary of the system by printing it:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"system","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Observe that there is no mention of time series data in the system yet.","category":"page"},{"location":"tutorials/working_with_time_series/#Add-and-Retrieve-a-Single-Time-Series","page":"Working with Time Series","title":"Add and Retrieve a Single Time Series","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's start by defining and attaching the wind measurements shown in the data above. This is a single time series profile, so we will use a SingleTimeSeries.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"First, define a TimeSeries.TimeArray of input data, using the 5-minute resolution to define the time-stamps in the example data:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind_values = [6.0, 7, 7, 6, 7, 9, 9, 9, 8, 8, 7, 6, 5, 5, 5, 5, 5, 6, 6, 6, 7, 6, 7, 7];\nresolution = Dates.Minute(5);\ntimestamps = range(DateTime(\"2020-01-01T08:00:00\"); step = resolution, length = 24);\nwind_timearray = TimeArray(timestamps, wind_values);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now, use the input data to define a Single Time Series in PowerSystems:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind_time_series = SingleTimeSeries(;\n name = \"max_active_power\",\n data = wind_timearray,\n);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Note that we've chosen the name max_active_power, which is the default time series profile name when using PowerSimulations.jl for simulations.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"So far, this time series has been defined, but not attached to our System in any way. Now, attach it to wind1 using add_time_series!:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"add_time_series!(system, wind1, wind_time_series);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's double-check this worked by calling show_time_series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now wind1 has the first time-series data set. Recall that you can also print wind1 and check the has_time_series field like we did above.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, let's retrieve and inspect the new timeseries, using get_time_series_array:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(SingleTimeSeries, wind1, \"max_active_power\")","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Verify this matches your expectation based on the input data.","category":"page"},{"location":"tutorials/working_with_time_series/#Add-and-Retrieve-a-Forecast","page":"Working with Time Series","title":"Add and Retrieve a Forecast","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Next, let's add the wind power forecasts. We will use a Deterministic format for the point forecasts.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Because we have forecasts with at different initial times, the input data must be a dictionary where the keys are the initial times and the values are vectors or TimeSeries.TimeArrays of the forecast data. Set up the example input data:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind_forecast_data = Dict(\n DateTime(\"2020-01-01T08:00:00\") => [5.0, 6, 7, 7, 7, 8, 9, 10, 10, 9, 7, 5],\n DateTime(\"2020-01-01T08:30:00\") => [9.0, 9, 9, 9, 8, 7, 6, 5, 4, 5, 4, 4],\n DateTime(\"2020-01-01T09:00:00\") => [6.0, 6, 5, 5, 4, 5, 6, 7, 7, 7, 6, 6],\n);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Define the Deterministic forecast and attach it to wind1:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind_forecast = Deterministic(\"max_active_power\", wind_forecast_data, resolution);\nadd_time_series!(system, wind1, wind_forecast);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's call show_time_series once again:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that we now have two types of time series listed – the single time series and the forecasts.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, let's retrieve the forecast data to double check it was added properly, specifying the initial time to get the 2nd forecast window starting at 8:30:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(\n Deterministic,\n wind1,\n \"max_active_power\";\n start_time = DateTime(\"2020-01-01T08:30:00\"),\n)","category":"page"},{"location":"tutorials/working_with_time_series/#Add-A-Time-Series-Using-Scaling-Factors","page":"Working with Time Series","title":"Add A Time Series Using Scaling Factors","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's add the load time series. Recall that this data is normalized to the peak system power, so we'll use it to scale both of our loads. We call normalized time series data scaling factors.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"First, let's create our input data TimeSeries.TimeArray with the example data and the same time stamps we used in the wind time series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"load_values = [0.3, 0.3, 0.3, 0.3, 0.4, 0.4, 0.4, 0.4, 0.5, 0.5, 0.6, 0.6,\n 0.7, 0.8, 0.8, 0.8, 0.8, 0.8, 0.9, 0.8, 0.8, 0.8, 0.8, 0.8];\nload_timearray = TimeArray(timestamps, load_values);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Again, define a SingleTimeSeries, but this time use the scaling_factor_multiplierparameter to scale this time series from normalized values to power values:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"load_time_series = SingleTimeSeries(;\n name = \"max_active_power\",\n data = load_timearray,\n scaling_factor_multiplier = get_max_active_power,\n);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that we assigned the get_max_active_power function to scale the time series, rather than a value, making the time series reusable for multiple components or multiple fields in a component.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now, add the scaling factor time series to both loads to save memory and avoid data duplication:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"add_time_series!(system, [load1, load2], load_time_series);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's take a look at load1, including printing its parameters...","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"load1","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"...as well as its time series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(load1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"tip: Important\nNotice that each load now has two references to max_active_power. This is intentional. There is the parameter, max_active_power, which is the maximum demand of each load at any time (10 MW). There is also max_active_power the time series, which is the time varying demand over the 2-hour window, calculated using the scaling factors and the max_active_power parameter.This means that if we change the max_active_power parameter, the time series will also change when we retrieve it! This is also true when we apply the same scaling factors to multiple components or parameters.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's check the impact that these two max_active_power data sources have on the times series data when we retrieve it. Get the max_active_power time series for load1:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(SingleTimeSeries, load1, \"max_active_power\") # in MW","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See that the normalized values have been scaled up by 10 MW.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now let's at load2. First check its max_active_power parameter:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_max_active_power(load2)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"This has a higher peak maximum demand of 30 MW.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Next, retrieve it's max_active_power time series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(SingleTimeSeries, load2, \"max_active_power\") # in MW","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Observe the difference compared to load1's time series.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, retrieve the underlying time series data with no scaling factor multiplier applied:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(SingleTimeSeries,\n load2,\n \"max_active_power\";\n ignore_scaling_factors = true,\n)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that this is the normalized input data, which is still being stored underneath. Each load is using a reference to that data when we call get_time_series_array to avoid unnecessary data duplication.","category":"page"},{"location":"tutorials/working_with_time_series/#Transform-a-SingleTimeSeries-into-a-Forecast","page":"Working with Time Series","title":"Transform a SingleTimeSeries into a Forecast","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, let's use a workaround to handle the missing load forecast data. We will assume a perfect forecast where the forecast is based on the SingleTimeSeries we just added.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Rather than unnecessarily duplicating and reformatting data, use PowerSystems.jl's dedicated transform_single_time_series! function to generate a DeterministicSingleTimeSeries, which saves memory while behaving just like a Deterministic forecast:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"transform_single_time_series!(\n system,\n Dates.Hour(1), # horizon\n Dates.Minute(30), # interval\n);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's see the results for load1's time series summary:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(load1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice we now have a load forecast data set with the resolution, horizon, and, interval matching our wind forecasts.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Retrieve the first forecast window:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(\n DeterministicSingleTimeSeries,\n load1,\n \"max_active_power\";\n start_time = DateTime(\"2020-01-01T08:00:00\"),\n)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See that load1's scaling factor multiplier is still being applied as expected.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Continue to the next section to address one more impact of calling transform_single_time_series! on the entire System.","category":"page"},{"location":"tutorials/working_with_time_series/#Finding,-Retrieving,-and-Inspecting-Time-Series","page":"Working with Time Series","title":"Finding, Retrieving, and Inspecting Time Series","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now, let's complete this tutorial by doing a few sanity checks on the data that we've added, where are we will also examine components with time series and retrieve the time series data in a few more ways.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"First, recall that we can print a component to check its has_time_series field:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"load1","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Also, recall we can print the System to summarize the data in our system:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"system","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that a new table has been added – the Time Series Summary, showing the count of each Type of component that has a given time series type.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Additionally, see that there are both Deterministic and DeterministicSingleTimeSeries forecasts for our RenewableDispatch generator (wind1). This was a side effect of transform_single_time_series! which added DeterministicSingleTimeSeries for all StaticTimeSeries in the system, even though we don't need one for wind.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's remove it with remove_time_series!. Since we have one wind generator, we could easily do it for that component, but let's do programmatically instead by its Type:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"for g in get_components(x -> has_time_series(x), RenewableDispatch, system)\n remove_time_series!(system, DeterministicSingleTimeSeries, g, \"max_active_power\")\nend","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that we also filtered for components where has_time_series is true, which is a simple way to find and manipulate components with time series.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's double check wind1 now:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See the unnecessary data is gone.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, let's do a last data sanity check on the forecasts. Since we defined the wind time series in MW instead of scaling factors, let's make sure none of our forecasts exceeds the max_active_power parameter.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Instead of using get_time_series_array where we need to remember some details of the time series we're looking up, let's use get_time_series_keys to refresh our memories:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"keys = get_time_series_keys(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See the forecast key is first, so let's retrieve it using get_time_series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"forecast = get_time_series(wind1, keys[1])","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See that unlike when we used get_time_series_array, this returns an object we can manipulate.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Use iterate_windows to cycle through the 3 forecast windows and inspect the peak value:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"for window in iterate_windows(forecast)\n @show values(maximum(window))\nend","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, use get_max_active_power to check the expected maximum:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_max_active_power(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See that the forecasts are not exceeding this maximum – sanity check complete.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"tip: Tip\nUnlike PowerLoad components, RenewableDispatch components do not have a max_active_power field, so check get_max_active_power to see how its calculated.","category":"page"},{"location":"tutorials/working_with_time_series/#Next-Steps","page":"Working with Time Series","title":"Next Steps","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"In this tutorial, you defined, added, and retrieved four time series data sets, including static time series and deterministic forecasts. Along the way, we reduced data duplication using normalized scaling factors for reuse by multiple components or component fields, as well as by referencing a StaticTimeSeries to address missing forecast data.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Next you might like to:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Parse many timeseries data sets from CSV's\nSee how to improve performance efficiency with your own time series data\nReview the available time series data formats\nLearn more about how times series data is stored","category":"page"},{"location":"#Welcome-to-PowerSystems.jl","page":"Welcome Page","title":"Welcome to PowerSystems.jl","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"CurrentModule = PowerSystems","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"tip: Announcement\nPowerSystems.jl upgraded to version 4.0 in June 2024, which included breaking changes. Visit the v4.0 migration guide for information on how to update your existing code.We also have re-organized and updated this documentation, including new tutorials! Check out How To Use This Documentation below to orient yourself.","category":"page"},{"location":"#About","page":"Welcome Page","title":"About","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerSystems.jl is part of the National Renewable Energy Laboratory's Sienna ecosystem, an open source framework for scheduling problems and dynamic simulations for power systems. The Sienna ecosystem can be found on github. It contains three applications:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Sienna\\Data enables efficient data input, analysis, and transformation\nSienna\\Ops enables enables system scheduling simulations by formulating and solving optimization problems\nSienna\\Dyn enables system transient analysis including small signal stability and full system dynamic simulations","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Each application uses multiple packages in the Julia programming language.","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerSystems.jl is the foundation of Sienna\\Data, and it is used with all three applications. It provides a rigorous data model using Julia structures to enable power systems modeling. PowerSystems.jl is agnostic to a specific mathematical model and can be used for many model categories.","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerSystems.jl provides tools to prepare and process data useful for electric energy systems modeling. This package serves two purposes:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"It facilitates the development and open sharing of large data sets for Power Systems modeling\nIt provides a data model that imposes discipline on model specification, addressing the challenge of design and terminology choices when sharing code and data.","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"The main features include:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Comprehensive and extensible library of data structures for electric systems modeling.\nLarge scale data set development tools based on common text based data formats (PSS/e .raw and .dyr, and MATPOWER) and configurable tabular data (e.g. CSV) parsing capabilities.\nOptimized container for component data and time series supporting serialization to portable file formats and configurable validation routines.","category":"page"},{"location":"#How-To-Use-This-Documentation","page":"Welcome Page","title":"How To Use This Documentation","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"There are five main sections containing different information:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Tutorials - Detailed walk-throughs to help you learn how to use PowerSystems.jl\nHow to... - Directions to help guide your work for a particular task\nExplanation - Additional details and background information to help you understand PowerSystems.jl, its structure, and how it works behind the scenes\nReference - Technical references and API for a quick look-up during your work\nModel Library - Technical references of the data types and their functions that PowerSystems.jl uses to model power system components","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerSystems.jl strives to follow the Diataxis documentation framework.","category":"page"},{"location":"#Getting-Started","page":"Welcome Page","title":"Getting Started","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"If you are new to PowerSystems.jl, here's how we suggest getting started:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Install\nWork through the introductory tutorial: Create and Explore a Power System to familiarize yourself with how PowerSystems.jl works\nWork through the other basic tutorials based on your interests\nSee Working with Time Series Data if you will be doing production cost modeling or working with time series\nSee Adding Data for Dynamic Simulations if you are interested in dynamic simulations\nThen, see the how-to's on parsing Matpower or PSS/e files or CSV files to begin loading your own data into PowerSystems.jl","category":"page"},{"location":"how_to/add_component_natural_units/#Add-a-Component-in-Natural-Units","page":"...add a component using natural units (MW)","title":"Add a Component in Natural Units","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"using PowerSystems; #hide\nusing PowerSystemCaseBuilder #hide\nsystem = build_system(PSISystems, \"modified_RTS_GMLC_DA_sys\"); #hide","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"PowerSystems.jl has three per-unitization options for getting, setting and displaying data.","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Currently, only one of these options – \"DEVICE_BASE\" – is supported when using a constructor function define a component. You can see an example of the default capabilities using \"DEVICE_BASE\" here.","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"We hope to add capability to define components in \"NATURAL_UNITS\" with constructors in the future, but for now, below is a workaround for users who prefer to define data using \"NATURAL_UNITS\" (e.g., MW, MVA, MVAR, or MW/min):","category":"page"},{"location":"how_to/add_component_natural_units/#Step-1:-Set-Units-Base","page":"...add a component using natural units (MW)","title":"Step 1: Set Units Base","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Set your (previously-defined) System's units base to \"NATURAL_UNITS\":","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"set_units_base_system!(system, \"NATURAL_UNITS\")","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Now, the \"setter\" functions have been switched to define data using natural units (MW, MVA, etc.), taking care of the necessary data conversions behind the scenes.","category":"page"},{"location":"how_to/add_component_natural_units/#Step-2:-Define-Empty-Component","page":"...add a component using natural units (MW)","title":"Step 2: Define Empty Component","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Define an empty component with 0.0 or nothing for all the power-related fields except base_power, which is always in MVA.","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"For example:","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"gas1 = ThermalStandard(;\n name = \"gas1\",\n available = true,\n status = true,\n bus = get_component(ACBus, system, \"Cobb\"), # Attach to a previously-defined bus named Cobb\n active_power = 0.0,\n reactive_power = 0.0,\n rating = 0.0,\n active_power_limits = (min = 0.0, max = 0.0),\n reactive_power_limits = nothing,\n ramp_limits = nothing,\n operation_cost = ThermalGenerationCost(nothing),\n base_power = 30.0, # MVA\n time_limits = (up = 8.0, down = 8.0), # Hours, unaffected by per-unitization\n must_run = false,\n prime_mover_type = PrimeMovers.CC,\n fuel = ThermalFuels.NATURAL_GAS,\n);","category":"page"},{"location":"how_to/add_component_natural_units/#Step-3:-Attach-the-Component","page":"...add a component using natural units (MW)","title":"Step 3: Attach the Component","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Attach the component to your System:","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"add_component!(system, gas1)","category":"page"},{"location":"how_to/add_component_natural_units/#Step-4:-Add-Data-with-\"setter\"-Functions","page":"...add a component using natural units (MW)","title":"Step 4: Add Data with \"setter\" Functions","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Use individual \"setter\" functions to set each the value of each numeric field in natural units:","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"set_rating!(gas1, 30.0) #MVA\nset_active_power_limits!(gas1, (min = 6.0, max = 30.0)) # MW\nset_reactive_power_limits!(gas1, (min = 6.0, max = 30.0)) # MVAR\nset_ramp_limits!(gas1, (up = 6.0, down = 6.0)) #MW/min","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Notice the return values are divided by the base_power of 30 MW, showing the setters have done the per-unit conversion into \"DEVICE_BASE\" behind the scenes.","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"tip: Tip\nSteps 2-4 can be called within a for loop to define many components at once (or step 3 can be replaced with add_components! to add all components at once).","category":"page"},{"location":"how_to/add_component_natural_units/#See-Also","page":"...add a component using natural units (MW)","title":"See Also","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Read more to understand per-unitization in PowerSystems.jl\nLearn how to use the default constructors and explore the per-unitization settings in Create and Explore a Power System","category":"page"},{"location":"how_to/get_buses/#Get-the-buses-in-a-System","page":"...get all the buses in a system","title":"Get the buses in a System","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"using PowerSystems; #hide\nusing PowerSystemCaseBuilder #hide\nsystem = build_system(PSISystems, \"modified_RTS_GMLC_DA_sys\"); #hide","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"You can access all the buses in a System to view or manipulate their data using two key functions: get_components or get_buses.","category":"page"},{"location":"how_to/get_buses/#Option-1a:-Get-an-iterator-for-all-the-buses","page":"...get all the buses in a system","title":"Option 1a: Get an iterator for all the buses","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Use get_components to get an iterator of all the AC buses in an existing system:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"bus_iter = get_components(ACBus, system)","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"The iterator avoids unnecessary memory allocations if there are many buses, and it can be used to view or update the bus data. For example, we can set the base voltage of all buses to 330 kV:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"for b in bus_iter\n set_base_voltage!(b, 330.0)\nend","category":"page"},{"location":"how_to/get_buses/#Option-1b:-Get-a-vector-of-all-the-buses","page":"...get all the buses in a system","title":"Option 1b: Get a vector of all the buses","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Use collect to get a vector of the buses instead of an iterator, which could require a lot of memory:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"buses = collect(get_components(ACBus, system))","category":"page"},{"location":"how_to/get_buses/#Option-2a:-Get-the-buses-in-an-Area-or-LoadZone","page":"...get all the buses in a system","title":"Option 2a: Get the buses in an Area or LoadZone","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Use get_buses to get a vector of buses when you know which Area or LoadZone you are interested in.","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"First, we select an Area:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"show_components(Area, system) # See available Areas\narea2 = get_component(Area, system, \"2\"); # Get Area named 2","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Then call get_buses for that Area:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"area_buses = get_buses(system, area2)","category":"page"},{"location":"how_to/get_buses/#Option-2b:-Get-buses-by-ID-number","page":"...get all the buses in a system","title":"Option 2b: Get buses by ID number","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Finally, use get_buses to get a vector of buses by their ID numbers.","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Example getting buses with ID numbers from 101 to 110:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"buses_by_ID = get_buses(system, Set(101:110))","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"note: Note\nYou can combine this with Option 1 to first view all the bus numbers if needed:get_number.(get_components(ACBus, system))","category":"page"},{"location":"how_to/get_buses/#See-Also","page":"...get all the buses in a system","title":"See Also","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"How to: Get the available generators in a System","category":"page"},{"location":"model_library/hybrid_system/#Hybrid-System","page":"HybridSystem","title":"Hybrid System","text":"","category":"section"},{"location":"model_library/hybrid_system/","page":"HybridSystem","title":"HybridSystem","text":"Modules = [PowerSystems]\nPages = [\"HybridSystem.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/hybrid_system/#PowerSystems.HybridSystem","page":"HybridSystem","title":"PowerSystems.HybridSystem","text":"mutable struct HybridSystem <: StaticInjectionSubsystem\n name::String\n available::Bool\n status::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n base_power::Float64\n operation_cost::MarketBidCost\n thermal_unit::Union{Nothing, ThermalGen}\n electric_load::Union{Nothing, ElectricLoad}\n storage::Union{Nothing, Storage}\n renewable_unit::Union{Nothing, RenewableGen}\n interconnection_impedance::ComplexF64\n interconnection_rating::Union{Nothing, Float64}\n input_active_power_limits::Union{Nothing, MinMax}\n output_active_power_limits::Union{Nothing, MinMax}\n reactive_power_limits::Union{Nothing, MinMax}\n interconnection_efficiency::Union{\n Nothing,\n NamedTuple{(:in, :out), Tuple{Float64, Float64}},\n }\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA Hybrid System that includes a combination of renewable generation, load, thermal generation and/or energy storage.\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nstatus::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating\noperation_cost::MarketBidCost: Market bid cost to operate, MarketBidCost\nthermal_unit::Union{Nothing, ThermalGen}: A thermal generator with supertype ThermalGen\nelectric_load::Union{Nothing, ElectricLoad}: A load with supertype ElectricLoad\nstorage::Union{Nothing, Storage}: An energy storage system with supertype Storage\nrenewable_unit::Union{Nothing, RenewableGen}: A renewable generator with supertype RenewableGen\ninterconnection_impedance::ComplexF64: Impedance (typically in p.u.) between the hybrid system and the grid interconnection\ninterconnection_rating::Union{Nothing, Float64}: Maximum rating of the hybrid system's interconnection with the transmission network (MVA)\ninput_active_power_limits::MinMax: Minimum and maximum stable input active power levels (MW)\noutput_active_power_limits::MinMax: Minimum and maximum stable output active power levels (MW)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits (MVAR). Set to Nothing if not applicable.\ninterconnection_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\nservices::Vector{Service}: (optional) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (optional) corresponding dynamic injection device\next::Dict{String, Any}: (optional) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference.\n\n\n\n\n\n","category":"type"},{"location":"model_library/hybrid_system/#PowerSystems.get_active_power-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_active_power","text":"get_active_power(value::HybridSystem) -> Any\n\n\nGet HybridSystem active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_available-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_available","text":"get_available(value::HybridSystem) -> Bool\n\n\nGet HybridSystem available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_base_power-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_base_power","text":"get_base_power(value::HybridSystem) -> Float64\n\n\nGet HybridSystem base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_bus-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_bus","text":"get_bus(value::HybridSystem) -> ACBus\n\n\nGet HybridSystem bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_dynamic_injector-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::HybridSystem\n) -> Union{Nothing, DynamicInjection}\n\n\nGet HybridSystem dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_electric_load-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_electric_load","text":"get_electric_load(\n value::HybridSystem\n) -> Union{Nothing, ElectricLoad}\n\n\nGet HybridSystem load\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_ext-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_ext","text":"get_ext(value::HybridSystem) -> Dict{String, Any}\n\n\nGet HybridSystem ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_input_active_power_limits-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_input_active_power_limits","text":"get_input_active_power_limits(\n value::HybridSystem\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HybridSystem input_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_interconnection_impedance-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_interconnection_impedance","text":"get_interconnection_impedance(\n value::HybridSystem\n) -> ComplexF64\n\n\nget HybridSystem interconnection impedance\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_interconnection_rating-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_interconnection_rating","text":"get_interconnection_rating(value::HybridSystem) -> Any\n\n\nGet HybridSystem interconnection_rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_operation_cost-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(value::HybridSystem) -> MarketBidCost\n\n\nGet HybridSystem operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_output_active_power_limits-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_output_active_power_limits","text":"get_output_active_power_limits(\n value::HybridSystem\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HybridSystem output_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_reactive_power-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::HybridSystem) -> Any\n\n\nGet HybridSystem reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_reactive_power_limits-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::HybridSystem\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HybridSystem reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_renewable_unit-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_renewable_unit","text":"get_renewable_unit(\n value::HybridSystem\n) -> Union{Nothing, RenewableGen}\n\n\nGet HybridSystem renewable unit\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_services-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_services","text":"get_services(value::HybridSystem) -> Vector{Service}\n\n\nGet HybridSystem services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_status-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_status","text":"get_status(value::HybridSystem) -> Bool\n\n\nGet HybridSystem status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_storage-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_storage","text":"get_storage(value::HybridSystem) -> Union{Nothing, Storage}\n\n\nGet HybridSystem storage unit\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_subcomponents-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_subcomponents","text":"get_subcomponents(hybrid::HybridSystem) -> Channel{Any}\n\n\nReturn an iterator over the subcomponents in the HybridSystem.\n\nExamples\n\nfor subcomponent in get_subcomponents(hybrid_sys)\n @show subcomponent\nend\nsubcomponents = collect(get_subcomponents(hybrid_sys))\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_thermal_unit-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_thermal_unit","text":"get_thermal_unit(\n value::HybridSystem\n) -> Union{Nothing, ThermalGen}\n\n\nGet HybridSystem thermal unit\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_active_power!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_available!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_available!","text":"set_available!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_base_power!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_bus!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_bus!","text":"set_bus!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_ext!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_ext!","text":"set_ext!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_input_active_power_limits!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_input_active_power_limits!","text":"set_input_active_power_limits!(\n value::HybridSystem,\n val\n) -> Any\n\n\nSet HybridSystem input_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_operation_cost!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_output_active_power_limits!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_output_active_power_limits!","text":"set_output_active_power_limits!(\n value::HybridSystem,\n val\n) -> Any\n\n\nSet HybridSystem output_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_reactive_power!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_reactive_power_limits!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_services!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_services!","text":"set_services!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_status!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_status!","text":"set_status!(value::HybridSystem, val) -> Any\n\n\nGet HybridSystem status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#RenewableNonDispatch","page":"RenewableNonDispatch","title":"RenewableNonDispatch","text":"","category":"section"},{"location":"model_library/generated_RenewableNonDispatch/","page":"RenewableNonDispatch","title":"RenewableNonDispatch","text":"Modules = [PowerSystems]\nPages = [\"generated/RenewableNonDispatch.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.RenewableNonDispatch","page":"RenewableNonDispatch","title":"PowerSystems.RenewableNonDispatch","text":"mutable struct RenewableNonDispatch <: RenewableGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n power_factor::Float64\n base_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA non-dispatchable (i.e., non-curtailable or must-take) renewable generator.\n\nIts 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.\n\nRenewable generators do not have a max_active_power parameter, which is instead calculated when calling get_max_active_power()\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), used in some production cost modeling simulations. To set the reactive power in a load flow, use power_factor\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\npower_factor::Float64: Power factor [0, 1] set-point, used in some production cost modeling and in load flow if the unit is connected to a PQ bus, validation range: (0, 1)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_RenewableNonDispatch/#InfrastructureSystems.get_name-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"InfrastructureSystems.get_name","text":"get_name(value::RenewableNonDispatch) -> String\n\n\nGet RenewableNonDispatch name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_active_power-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_active_power","text":"get_active_power(value::RenewableNonDispatch) -> Any\n\n\nGet RenewableNonDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_available-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_available","text":"get_available(value::RenewableNonDispatch) -> Bool\n\n\nGet RenewableNonDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_base_power-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_base_power","text":"get_base_power(value::RenewableNonDispatch) -> Float64\n\n\nGet RenewableNonDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_bus-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_bus","text":"get_bus(value::RenewableNonDispatch) -> ACBus\n\n\nGet RenewableNonDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_dynamic_injector-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::RenewableNonDispatch\n) -> Union{Nothing, DynamicInjection}\n\n\nGet RenewableNonDispatch dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_ext-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_ext","text":"get_ext(value::RenewableNonDispatch) -> Dict{String, Any}\n\n\nGet RenewableNonDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_power_factor-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_power_factor","text":"get_power_factor(value::RenewableNonDispatch) -> Float64\n\n\nGet RenewableNonDispatch power_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_prime_mover_type-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::RenewableNonDispatch\n) -> PrimeMovers\n\n\nGet RenewableNonDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_rating-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_rating","text":"get_rating(value::RenewableNonDispatch) -> Any\n\n\nGet RenewableNonDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_reactive_power-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::RenewableNonDispatch) -> Any\n\n\nGet RenewableNonDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_services-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_services","text":"get_services(value::RenewableNonDispatch) -> Vector{Service}\n\n\nGet RenewableNonDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_active_power!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_available!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_available!","text":"set_available!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_base_power!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_bus!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_bus!","text":"set_bus!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_ext!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_ext!","text":"set_ext!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_power_factor!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_power_factor!","text":"set_power_factor!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch power_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_prime_mover_type!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(\n value::RenewableNonDispatch,\n val\n) -> Any\n\n\nSet RenewableNonDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_rating!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_rating!","text":"set_rating!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_reactive_power!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_services!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_services!","text":"set_services!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#OutputCurrentLimiter","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/#HybridOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"HybridOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/HybridOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.HybridOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.HybridOutputCurrentLimiter","text":"mutable struct HybridOutputCurrentLimiter <: OutputCurrentLimiter\n I_max::Float64\n rv::Float64\n lv::Float64\n ext::Dict{String, Any}\nend\n\nParameters 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 \n\nArguments\n\nI_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)\nrv::Float64: Real part of the virtual impedance, validation range: (0, nothing)\nlv::Float64: Imaginary part of the virtual impedance, validation range: (0, nothing)\next::Dict{String, Any}: (default: Dict{String, Any}())\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_I_max-Tuple{HybridOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_I_max","text":"get_I_max(value::HybridOutputCurrentLimiter) -> Float64\n\n\nGet HybridOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{HybridOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::HybridOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet HybridOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_lv-Tuple{HybridOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_lv","text":"get_lv(value::HybridOutputCurrentLimiter) -> Float64\n\n\nGet HybridOutputCurrentLimiter lv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_rv-Tuple{HybridOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_rv","text":"get_rv(value::HybridOutputCurrentLimiter) -> Float64\n\n\nGet HybridOutputCurrentLimiter rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_I_max!-Tuple{HybridOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::HybridOutputCurrentLimiter, val) -> Any\n\n\nSet HybridOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{HybridOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(value::HybridOutputCurrentLimiter, val) -> Any\n\n\nSet HybridOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_lv!-Tuple{HybridOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_lv!","text":"set_lv!(value::HybridOutputCurrentLimiter, val) -> Any\n\n\nSet HybridOutputCurrentLimiter lv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_rv!-Tuple{HybridOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_rv!","text":"set_rv!(value::HybridOutputCurrentLimiter, val) -> Any\n\n\nSet HybridOutputCurrentLimiter rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#InstantaneousOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"InstantaneousOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/InstantaneousOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.InstantaneousOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.InstantaneousOutputCurrentLimiter","text":"mutable struct InstantaneousOutputCurrentLimiter <: OutputCurrentLimiter\n Id_max::Float64\n Iq_max::Float64\n ext::Dict{String, Any}\nend\n\nParameters of Instantaneous (Square) Current Controller Limiter. Regulates inverter output current on the d and q axis separately\n\nArguments\n\nId_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)\nIq_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)\next::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.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_Id_max-Tuple{InstantaneousOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_Id_max","text":"get_Id_max(\n value::InstantaneousOutputCurrentLimiter\n) -> Float64\n\n\nGet InstantaneousOutputCurrentLimiter Id_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_Iq_max-Tuple{InstantaneousOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_Iq_max","text":"get_Iq_max(\n value::InstantaneousOutputCurrentLimiter\n) -> Float64\n\n\nGet InstantaneousOutputCurrentLimiter Iq_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{InstantaneousOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::InstantaneousOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet InstantaneousOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_Id_max!-Tuple{InstantaneousOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_Id_max!","text":"set_Id_max!(\n value::InstantaneousOutputCurrentLimiter,\n val\n) -> Any\n\n\nSet InstantaneousOutputCurrentLimiter Id_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_Iq_max!-Tuple{InstantaneousOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_Iq_max!","text":"set_Iq_max!(\n value::InstantaneousOutputCurrentLimiter,\n val\n) -> Any\n\n\nSet InstantaneousOutputCurrentLimiter Iq_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{InstantaneousOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(\n value::InstantaneousOutputCurrentLimiter,\n val\n) -> Any\n\n\nSet InstantaneousOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#MagnitudeOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"MagnitudeOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/MagnitudeOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.MagnitudeOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.MagnitudeOutputCurrentLimiter","text":"mutable struct MagnitudeOutputCurrentLimiter <: OutputCurrentLimiter\n I_max::Float64\n ext::Dict{String, Any}\nend\n\nParameters of Magnitude (Circular) Current Controller Limiter. Regulates only the magnitude of the inverter output current\n\nArguments\n\nI_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)\next::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.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_I_max-Tuple{MagnitudeOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_I_max","text":"get_I_max(value::MagnitudeOutputCurrentLimiter) -> Float64\n\n\nGet MagnitudeOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{MagnitudeOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::MagnitudeOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet MagnitudeOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_I_max!-Tuple{MagnitudeOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::MagnitudeOutputCurrentLimiter, val) -> Any\n\n\nSet MagnitudeOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{MagnitudeOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(value::MagnitudeOutputCurrentLimiter, val) -> Any\n\n\nSet MagnitudeOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PriorityOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PriorityOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/PriorityOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.PriorityOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.PriorityOutputCurrentLimiter","text":"mutable struct PriorityOutputCurrentLimiter <: OutputCurrentLimiter\n I_max::Float64\n ϕ_I::Float64\n ext::Dict{String, Any}\nend\n\nParameters of Priority-Based Current Controller Limiter. Regulates the magnitude of the inverter output current and prioritizes a specific angle for the resultant current signal\n\nArguments\n\nI_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)\nϕ_I::Float64: Pre-defined angle (measured against the d-axis) for Iref once limit Imax is hit, validation range: (-1.571, 1.571)\next::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.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_I_max-Tuple{PriorityOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_I_max","text":"get_I_max(value::PriorityOutputCurrentLimiter) -> Float64\n\n\nGet PriorityOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{PriorityOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::PriorityOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet PriorityOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ϕ_I-Tuple{PriorityOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ϕ_I","text":"get_ϕ_I(value::PriorityOutputCurrentLimiter) -> Float64\n\n\nGet PriorityOutputCurrentLimiter ϕ_I.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_I_max!-Tuple{PriorityOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::PriorityOutputCurrentLimiter, val) -> Any\n\n\nSet PriorityOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{PriorityOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(value::PriorityOutputCurrentLimiter, val) -> Any\n\n\nSet PriorityOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ϕ_I!-Tuple{PriorityOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ϕ_I!","text":"set_ϕ_I!(value::PriorityOutputCurrentLimiter, val) -> Any\n\n\nSet PriorityOutputCurrentLimiter ϕ_I.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#SaturationOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"SaturationOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/SaturationOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.SaturationOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.SaturationOutputCurrentLimiter","text":"mutable struct SaturationOutputCurrentLimiter <: OutputCurrentLimiter\n I_max::Float64\n kw::Float64\n ext::Dict{String, Any}\nend\n\nParameters 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\n\nArguments\n\nI_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)\nkw::Float64: Defined feedback gain, validation range: (0, nothing)\next::Dict{String, Any}: (default: Dict{String, Any}())\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_I_max-Tuple{SaturationOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_I_max","text":"get_I_max(value::SaturationOutputCurrentLimiter) -> Float64\n\n\nGet SaturationOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{SaturationOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::SaturationOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet SaturationOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_kw-Tuple{SaturationOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_kw","text":"get_kw(value::SaturationOutputCurrentLimiter) -> Float64\n\n\nGet SaturationOutputCurrentLimiter kw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_I_max!-Tuple{SaturationOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_I_max!","text":"set_I_max!(\n value::SaturationOutputCurrentLimiter,\n val\n) -> Any\n\n\nSet SaturationOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{SaturationOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(value::SaturationOutputCurrentLimiter, val) -> Any\n\n\nSet SaturationOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_kw!-Tuple{SaturationOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_kw!","text":"set_kw!(value::SaturationOutputCurrentLimiter, val) -> Any\n\n\nSet SaturationOutputCurrentLimiter kw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#TapTransformer","page":"TapTransformer","title":"TapTransformer","text":"","category":"section"},{"location":"model_library/generated_TapTransformer/","page":"TapTransformer","title":"TapTransformer","text":"Modules = [PowerSystems]\nPages = [\"generated/TapTransformer.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TapTransformer/#PowerSystems.TapTransformer","page":"TapTransformer","title":"PowerSystems.TapTransformer","text":"mutable struct TapTransformer <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n primary_shunt::Float64\n tap::Float64\n rating::Union{Nothing, Float64}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA 2-winding transformer, with a tap changer for variable turns ratio.\n\nThe 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow through the transformer (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow through the transformer (MVAR)\narc::Arc: An Arc defining this transformer from a bus to another bus\nr::Float64: Resistance in p.u. (SYSTEM_BASE), validation range: (-2, 2)\nx::Float64: Reactance in p.u. (SYSTEM_BASE), validation range: (-2, 4)\nprimary_shunt::Float64: Shunt reactance in p.u. (SYSTEM_BASE), validation range: (0, 2)\ntap::Float64: Normalized tap changer position for voltage control, varying between 0 and 2, with 1 centered at the nominal voltage, validation range: (0, 2)\nrating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating. When defining a transformer before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TapTransformer/#InfrastructureSystems.get_name-Tuple{TapTransformer}","page":"TapTransformer","title":"InfrastructureSystems.get_name","text":"get_name(value::TapTransformer) -> String\n\n\nGet TapTransformer name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_active_power_flow-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::TapTransformer) -> Any\n\n\nGet TapTransformer active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_arc-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_arc","text":"get_arc(value::TapTransformer) -> Arc\n\n\nGet TapTransformer arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_available-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_available","text":"get_available(value::TapTransformer) -> Bool\n\n\nGet TapTransformer available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_ext-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_ext","text":"get_ext(value::TapTransformer) -> Dict{String, Any}\n\n\nGet TapTransformer ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_primary_shunt-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_primary_shunt","text":"get_primary_shunt(value::TapTransformer) -> Float64\n\n\nGet TapTransformer primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_r-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_r","text":"get_r(value::TapTransformer) -> Float64\n\n\nGet TapTransformer r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_rating-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_rating","text":"get_rating(value::TapTransformer) -> Any\n\n\nGet TapTransformer rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_reactive_power_flow-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::TapTransformer) -> Any\n\n\nGet TapTransformer reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_services-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_services","text":"get_services(value::TapTransformer) -> Vector{Service}\n\n\nGet TapTransformer services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_tap-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_tap","text":"get_tap(value::TapTransformer) -> Float64\n\n\nGet TapTransformer tap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_x-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_x","text":"get_x(value::TapTransformer) -> Float64\n\n\nGet TapTransformer x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_active_power_flow!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_arc!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_arc!","text":"set_arc!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_available!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_available!","text":"set_available!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_ext!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_ext!","text":"set_ext!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_primary_shunt!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_primary_shunt!","text":"set_primary_shunt!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_r!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_r!","text":"set_r!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_rating!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_rating!","text":"set_rating!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_reactive_power_flow!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_services!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_services!","text":"set_services!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_tap!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_tap!","text":"set_tap!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer tap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_x!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_x!","text":"set_x!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#StorageCost","page":"StorageCost","title":"StorageCost","text":"","category":"section"},{"location":"model_library/storage_cost/","page":"StorageCost","title":"StorageCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/StorageCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/storage_cost/#PowerSystems.StorageCost","page":"StorageCost","title":"PowerSystems.StorageCost","text":"mutable struct StorageCost <: OperationalCost\n\ncharge_variable_cost::CostCurve: (default of 0) Variable cost of charging represented as a CostCurve\ndischarge_variable_cost::CostCurve: (default of 0) Variable cost of discharging represented as a CostCurve\nfixed::Float64: (default: 0) Fixed cost of operating the storage system\nstart_up::Union{Float64, @NamedTuple{charge::Float64, discharge::Float64}}: (default: 0) Start-up cost\nshut_down::Float64: (default: 0) Shut-down cost\nenergy_shortage_cost::Float64: (default: 0) Cost incurred by the model for being short of the energy target\nenergy_surplus_cost::Float64: (default: 0) Cost incurred by the model for surplus energy stored\n\nStorageCost(charge_variable_cost, discharge_variable_cost, fixed, start_up, shut_down, energy_shortage_cost, energy_surplus_cost)\nStorageCost(; charge_variable_cost, discharge_variable_cost, fixed, start_up, shut_down, energy_shortage_cost, energy_surplus_cost)\n\nAn operational cost for storage units including fixed costs and variable costs to charge or discharge.\n\nThis data structure is not intended to represent market storage systems market operations like the submission of buy/sell bids – see MarketBidCost instead.\n\n\n\n\n\n","category":"type"},{"location":"model_library/storage_cost/#PowerSystems.get_charge_variable_cost-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_charge_variable_cost","text":"get_charge_variable_cost(value::StorageCost) -> CostCurve\n\n\nGet StorageCost charge_variable_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_discharge_variable_cost-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_discharge_variable_cost","text":"get_discharge_variable_cost(value::StorageCost) -> CostCurve\n\n\nGet StorageCost discharge_variable_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_energy_shortage_cost-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_energy_shortage_cost","text":"get_energy_shortage_cost(value::StorageCost) -> Float64\n\n\nGet StorageCost energy_shortage_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_energy_surplus_cost-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_energy_surplus_cost","text":"get_energy_surplus_cost(value::StorageCost) -> Float64\n\n\nGet StorageCost energy_surplus_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_fixed-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_fixed","text":"get_fixed(value::StorageCost) -> Float64\n\n\nGet StorageCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_shut_down-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_shut_down","text":"get_shut_down(value::StorageCost) -> Float64\n\n\nGet StorageCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_start_up-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_start_up","text":"get_start_up(\n value::StorageCost\n) -> Union{Float64, @NamedTuple{charge::Float64, discharge::Float64}}\n\n\nGet StorageCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_charge_variable_cost!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_charge_variable_cost!","text":"set_charge_variable_cost!(value::StorageCost, val) -> Any\n\n\nSet StorageCost charge_variable_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_discharge_variable_cost!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_discharge_variable_cost!","text":"set_discharge_variable_cost!(value::StorageCost, val) -> Any\n\n\nSet StorageCost discharge_variable_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_energy_shortage_cost!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_energy_shortage_cost!","text":"set_energy_shortage_cost!(value::StorageCost, val) -> Any\n\n\nSet StorageCost energy_shortage_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_energy_surplus_cost!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_energy_surplus_cost!","text":"set_energy_surplus_cost!(value::StorageCost, val) -> Any\n\n\nSet StorageCost energy_surplus_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_fixed!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_fixed!","text":"set_fixed!(value::StorageCost, val) -> Any\n\n\nSet StorageCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_shut_down!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_shut_down!","text":"set_shut_down!(value::StorageCost, val) -> Any\n\n\nSet StorageCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_start_up!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_start_up!","text":"set_start_up!(value::StorageCost, val) -> Any\n\n\nSet StorageCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"explanation/dynamic_data/#Dynamic-Devices","page":"Dynamic Devices","title":"Dynamic Devices","text":"","category":"section"},{"location":"explanation/dynamic_data/#Static-and-Dynamic-Data-Layers","page":"Dynamic Devices","title":"Static and Dynamic Data Layers","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"PowerSystems.jl uses two categories to define data for dynamic simulations:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Static components, which includes the data needed to run a power flow problem\nDynamic components are those that define differential equations to run a transient simulation. These dynamic data are attached to the static components.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Although PowerSystems.jl is not constrained to only PSS/e files, commonly the data for a dynamic simulation comes in a pair of files: One for the static data power flow case (e.g., .raw file) and a second one with the dynamic components information (e.g., .dyr file). However, PowerSystems.jl is able to take any power flow case and specify dynamic components to it. The two data layers in PowerSystems.jl are similar to the data division between those two files.","category":"page"},{"location":"explanation/dynamic_data/#Layer-1:-Static-Components","page":"Dynamic Devices","title":"Layer 1: Static Components","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"The first data layer contains all the information necessary to run a power flow problem:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Vector of Bus elements, that define all the buses in the network.\nVector of Branch elements, that define all the branches elements (that connect two buses) in the network.\nVector of StaticInjection elements, that define all the devices connected to buses that can inject (or withdraw) power. These static devices, typically generators, in PowerSimulationsDynamics are used to solve the Power Flow problem that determines the active and reactive power provided for each device.\nVector of PowerLoad elements, that define all the loads connected to buses that can withdraw current. These are also used to solve the Power Flow.\nVector of Source elements, that define source components behind a reactance that can inject or withdraw current.\nThe base of power used to define per unit values, in MVA as a Float64 value.\nThe base frequency used in the system, in Hz as a Float64 value.","category":"page"},{"location":"explanation/dynamic_data/#Layer-2:-Dynamic-Components","page":"Dynamic Devices","title":"Layer 2: Dynamic Components","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"The second data layer contains the additional information describing the dynamic response of certain components in the System. This data is all attached to components defined in the static data layer:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"(Optional) Selecting which of the Lines (of the Branch vector) elements must be modeled of DynamicLines elements, that can be used to model lines with differential equations.\nVector of DynamicInjection elements. These components must be attached to a StaticInjection that connects the power flow solution to the dynamic formulation of such device.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"DynamicInjection can be DynamicGenerator or DynamicInverter, and its specific formulation (i.e. differential equations) will depend on the specific components that define each device (see the sections below). As a result, it is possible to flexibly define dynamic data models and methods according to the analysis requirements. DynamicInjection components use 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.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"DynamicInjection components also implement some additional information useful for the modeling, like the usual states assumed by the model and the number of states. 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.","category":"page"},{"location":"explanation/dynamic_data/#Dynamic-Generator-Structure","page":"Dynamic Devices","title":"Dynamic Generator Structure","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Each generator is a data structure that is defined by the following components:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Machine: That defines the stator electro-magnetic dynamics.\nShaft: That describes the rotor electro-mechanical dynamics.\nAutomatic Voltage Regulator: Electromotive dynamics to model an AVR controller.\nPower System Stabilizer: Control dynamics to define an stabilization signal for the AVR.\nPrime Mover and Turbine Governor: Thermo-mechanical dynamics and associated controllers.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"","category":"page"},{"location":"explanation/dynamic_data/#Dynamic-Inverter-Structure","page":"Dynamic Devices","title":"Dynamic Inverter Structure","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Each inverter is a data structure that is defined by the following components:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"DC Source: Defines the dynamics of the DC side of the converter.\nFrequency Estimator: That describes how the frequency of the grid can be estimated using the grid voltages. Typically a phase-locked loop (PLL).\nOuter Loop Control: That describes the active and reactive power control dynamics.\nInner Loop Control: That can describe virtual impedance, voltage control and current control dynamics.\nConverter: That describes the dynamics of the pulse width modulation (PWM) or space vector modulation (SVM).\nFilter: Used to connect the converter output to the grid.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"⠀ ```","category":"page"},{"location":"model_library/generated_HydroPumpedStorage/#HydroPumpedStorage","page":"HydroPumpedStorage","title":"HydroPumpedStorage","text":"","category":"section"},{"location":"model_library/generated_HydroPumpedStorage/","page":"HydroPumpedStorage","title":"HydroPumpedStorage","text":"Modules = [PowerSystems]\nPages = [\"generated/HydroPumpedStorage.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.HydroPumpedStorage","page":"HydroPumpedStorage","title":"PowerSystems.HydroPumpedStorage","text":"mutable struct HydroPumpedStorage <: HydroGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n base_power::Float64\n prime_mover_type::PrimeMovers\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n time_limits::Union{Nothing, UpDown}\n rating_pump::Float64\n active_power_limits_pump::MinMax\n reactive_power_limits_pump::Union{Nothing, MinMax}\n ramp_limits_pump::Union{Nothing, UpDown}\n time_limits_pump::Union{Nothing, UpDown}\n storage_capacity::UpDown\n inflow::Float64\n outflow::Float64\n initial_storage::UpDown\n storage_target::UpDown\n operation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}\n pump_efficiency::Float64\n conversion_factor::Float64\n status::PumpHydroStatus\n time_at_status::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA hydropower generator with pumped storage and upper and lower reservoirs. \n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR)\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nrating_pump::Float64: Maximum power withdrawal (MVA) of the pump, validation range: (0, nothing)\nactive_power_limits_pump::MinMax:\nreactive_power_limits_pump::Union{Nothing, MinMax}:\nramp_limits_pump::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min of pump, validation range: (0, nothing)\ntime_limits_pump::Union{Nothing, UpDown}: Minimum up and Minimum down time limits of pump in hours, validation range: (0, nothing)\nstorage_capacity::UpDown: Maximum storage capacity in the upper and lower reservoirs (units can be p.u-hr or m^3), validation range: (0, nothing)\ninflow::Float64: Baseline inflow into the upper reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)\noutflow::Float64: Baseline outflow from the lower reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)\ninitial_storage::UpDown: Initial storage capacity in the upper and lower reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)\nstorage_target::UpDown: (default: (up=1.0, down=1.0)) Storage target of upper reservoir at the end of simulation as ratio of storage capacity\noperation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation\npump_efficiency::Float64: (default: 1.0) Pumping efficiency [0, 1.0], validation range: (0, 1)\nconversion_factor::Float64: (default: 1.0) Conversion factor from flow/volume to energy: m^3 -> p.u-hr\nstatus::PumpHydroStatus: (default: PumpHydroStatus.OFF) Initial commitment condition at the start of a simulation (PumpHydroStatus.PUMP, PumpHydroStatus.GEN, or PumpHydroStatus.OFF)\ntime_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been generating, pumping, or off, as indicated by status\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_HydroPumpedStorage/#InfrastructureSystems.get_name-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"InfrastructureSystems.get_name","text":"get_name(value::HydroPumpedStorage) -> String\n\n\nGet HydroPumpedStorage name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_active_power-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_active_power","text":"get_active_power(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_active_power_limits-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::HydroPumpedStorage\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet HydroPumpedStorage active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_active_power_limits_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_active_power_limits_pump","text":"get_active_power_limits_pump(\n value::HydroPumpedStorage\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet HydroPumpedStorage active_power_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_available-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_available","text":"get_available(value::HydroPumpedStorage) -> Bool\n\n\nGet HydroPumpedStorage available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_base_power-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_base_power","text":"get_base_power(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_bus-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_bus","text":"get_bus(value::HydroPumpedStorage) -> ACBus\n\n\nGet HydroPumpedStorage bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_conversion_factor-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_conversion_factor","text":"get_conversion_factor(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_dynamic_injector-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::HydroPumpedStorage\n) -> Union{Nothing, DynamicInjection}\n\n\nGet HydroPumpedStorage dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_ext-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_ext","text":"get_ext(value::HydroPumpedStorage) -> Dict{String, Any}\n\n\nGet HydroPumpedStorage ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_inflow-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_inflow","text":"get_inflow(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage inflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_initial_storage-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_initial_storage","text":"get_initial_storage(\n value::HydroPumpedStorage\n) -> NamedTuple{(:up, :down), <:Tuple{Any, Any}}\n\n\nGet HydroPumpedStorage initial_storage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_operation_cost-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::HydroPumpedStorage\n) -> Union{HydroGenerationCost, MarketBidCost, StorageCost}\n\n\nGet HydroPumpedStorage operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_outflow-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_outflow","text":"get_outflow(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage outflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_prime_mover_type-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::HydroPumpedStorage\n) -> PrimeMovers\n\n\nGet HydroPumpedStorage prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_pump_efficiency-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_pump_efficiency","text":"get_pump_efficiency(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage pump_efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_ramp_limits-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::HydroPumpedStorage\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet HydroPumpedStorage ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_ramp_limits_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_ramp_limits_pump","text":"get_ramp_limits_pump(\n value::HydroPumpedStorage\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet HydroPumpedStorage ramp_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_rating-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_rating","text":"get_rating(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_rating_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_rating_pump","text":"get_rating_pump(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage rating_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_reactive_power-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_reactive_power_limits-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::HydroPumpedStorage\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HydroPumpedStorage reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_reactive_power_limits_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_reactive_power_limits_pump","text":"get_reactive_power_limits_pump(\n value::HydroPumpedStorage\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HydroPumpedStorage reactive_power_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_services-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_services","text":"get_services(value::HydroPumpedStorage) -> Vector{Service}\n\n\nGet HydroPumpedStorage services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_status-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_status","text":"get_status(\n value::HydroPumpedStorage\n) -> PowerSystems.PumpHydroStatusModule.PumpHydroStatus\n\n\nGet HydroPumpedStorage status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_storage_capacity-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_storage_capacity","text":"get_storage_capacity(\n value::HydroPumpedStorage\n) -> NamedTuple{(:up, :down), <:Tuple{Any, Any}}\n\n\nGet HydroPumpedStorage storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_storage_target-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_storage_target","text":"get_storage_target(\n value::HydroPumpedStorage\n) -> @NamedTuple{up::Float64, down::Float64}\n\n\nGet HydroPumpedStorage storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_time_at_status-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_time_at_status","text":"get_time_at_status(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_time_limits-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::HydroPumpedStorage\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet HydroPumpedStorage time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_time_limits_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_time_limits_pump","text":"get_time_limits_pump(\n value::HydroPumpedStorage\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet HydroPumpedStorage time_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_active_power!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_active_power_limits!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_active_power_limits_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_active_power_limits_pump!","text":"set_active_power_limits_pump!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage active_power_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_available!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_available!","text":"set_available!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_base_power!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_bus!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_bus!","text":"set_bus!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_conversion_factor!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_conversion_factor!","text":"set_conversion_factor!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_ext!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_ext!","text":"set_ext!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_inflow!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_inflow!","text":"set_inflow!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage inflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_initial_storage!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_initial_storage!","text":"set_initial_storage!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage initial_storage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_operation_cost!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_outflow!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_outflow!","text":"set_outflow!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage outflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_prime_mover_type!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_pump_efficiency!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_pump_efficiency!","text":"set_pump_efficiency!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage pump_efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_ramp_limits!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_ramp_limits_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_ramp_limits_pump!","text":"set_ramp_limits_pump!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage ramp_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_rating!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_rating!","text":"set_rating!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_rating_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_rating_pump!","text":"set_rating_pump!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage rating_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_reactive_power!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_reactive_power_limits!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_reactive_power_limits_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_reactive_power_limits_pump!","text":"set_reactive_power_limits_pump!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage reactive_power_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_services!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_services!","text":"set_services!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_status!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_status!","text":"set_status!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_storage_capacity!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_storage_capacity!","text":"set_storage_capacity!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_storage_target!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_storage_target!","text":"set_storage_target!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_time_at_status!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_time_at_status!","text":"set_time_at_status!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_time_limits!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_time_limits_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_time_limits_pump!","text":"set_time_limits_pump!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage time_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#DynamicExponentialLoad","page":"DynamicExponentialLoad","title":"DynamicExponentialLoad","text":"","category":"section"},{"location":"model_library/generated_DynamicExponentialLoad/","page":"DynamicExponentialLoad","title":"DynamicExponentialLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/DynamicExponentialLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.DynamicExponentialLoad","page":"DynamicExponentialLoad","title":"PowerSystems.DynamicExponentialLoad","text":"mutable struct DynamicExponentialLoad <: DynamicInjection\n name::String\n a::Float64\n b::Float64\n α::Float64\n β::Float64\n T_p::Float64\n T_q::Float64\n ext::Dict{String, Any}\n base_power::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 2-states of a generic dynamic load model based on \"Voltage stability analysis using generic dynamic load models.\"\n\nArguments\n\nname::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\na::Float64: Active power static exponential coefficient, validation range: (0, nothing)\nb::Float64: Reactive power static exponential coefficient, validation range: (0, nothing)\nα::Float64: Active power transient exponential coefficient, validation range: (0, nothing)\nβ::Float64: Reactive power transient exponential coefficient, validation range: (0, nothing)\nT_p::Float64: Active Power Time Constant, validation range: (0, nothing)\nT_q::Float64: Reactive Power Time Constant, validation range: (0, nothing)\next::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.\nbase_power::Float64: Base power of the load (MVA) for per unitization\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p: Integrator state of the active power,\nx_q: Integrator state of the reactive power,\n\nn_states::Int: (Do not modify.) DynamicExponentialLoad has 2 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_DynamicExponentialLoad/#InfrastructureSystems.get_name-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::DynamicExponentialLoad) -> String\n\n\nGet DynamicExponentialLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_T_p-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_T_p","text":"get_T_p(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_T_q-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_T_q","text":"get_T_q(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad T_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_a-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_a","text":"get_a(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_b-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_b","text":"get_b(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_base_power-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_ext-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_ext","text":"get_ext(value::DynamicExponentialLoad) -> Dict{String, Any}\n\n\nGet DynamicExponentialLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_n_states-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_n_states","text":"get_n_states(value::DynamicExponentialLoad) -> Int64\n\n\nGet DynamicExponentialLoad n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_states-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_states","text":"get_states(value::DynamicExponentialLoad) -> Vector{Symbol}\n\n\nGet DynamicExponentialLoad states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_α-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_α","text":"get_α(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_β-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_β","text":"get_β(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad β.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_T_p!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_T_p!","text":"set_T_p!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_T_q!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_T_q!","text":"set_T_q!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad T_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_a!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_a!","text":"set_a!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_b!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_b!","text":"set_b!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_base_power!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_ext!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_α!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_α!","text":"set_α!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_β!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_β!","text":"set_β!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad β.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#ActiveConstantPowerLoad","page":"ActiveConstantPowerLoad","title":"ActiveConstantPowerLoad","text":"","category":"section"},{"location":"model_library/generated_ActiveConstantPowerLoad/","page":"ActiveConstantPowerLoad","title":"ActiveConstantPowerLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/ActiveConstantPowerLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.ActiveConstantPowerLoad","page":"ActiveConstantPowerLoad","title":"PowerSystems.ActiveConstantPowerLoad","text":"mutable struct ActiveConstantPowerLoad <: DynamicInjection\n name::String\n r_load::Float64\n c_dc::Float64\n rf::Float64\n lf::Float64\n cf::Float64\n rg::Float64\n lg::Float64\n kp_pll::Float64\n ki_pll::Float64\n kpv::Float64\n kiv::Float64\n kpc::Float64\n kic::Float64\n base_power::Float64\n ext::Dict{String, Any}\n P_ref::Float64\n Q_ref::Float64\n V_ref::Float64\n ω_ref::Float64\n is_filter_differential::Int\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 12-states active power load based on the paper, \"Dynamic Stability of a Microgrid With an Active Load.\"\n\nArguments\n\nname::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\nr_load::Float64: DC-side resistor, validation range: (0, nothing)\nc_dc::Float64: DC-side capacitor, validation range: (0, nothing)\nrf::Float64: Converter side filter resistance, validation range: (0, nothing)\nlf::Float64: Converter side filter inductance, validation range: (0, nothing)\ncf::Float64: AC Converter filter capacitance, validation range: (0, nothing)\nrg::Float64: Network side filter resistance, validation range: (0, nothing)\nlg::Float64: Network side filter inductance, validation range: (0, nothing)\nkp_pll::Float64: Proportional constant for PI-PLL block, validation range: (0, nothing)\nki_pll::Float64: Integral constant for PI-PLL block, validation range: (0, nothing)\nkpv::Float64: Proportional constant for Voltage Control block, validation range: (0, nothing)\nkiv::Float64: Integral constant for Voltage Control block, validation range: (0, nothing)\nkpc::Float64: Proportional constant for Current Control block, validation range: (0, nothing)\nkic::Float64: Integral constant for Current Control block, validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\next::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.\nP_ref::Float64: Reference active power (pu)\nQ_ref::Float64: Reference reactive power (pu)\nV_ref::Float64: Reference voltage (pu)\nω_ref::Float64: Reference frequency (pu)\nis_filter_differential::Int: Boolean to decide if filter states are differential or algebraic\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nθ_pll: PLL deviation angle, \nϵ_pll: PLL integrator state, \nη: DC-voltage controller integrator state, \nv_dc: DC voltage at the capacitor, \nγd: d-axis Current controller integrator state, \nγq: q-axis Current controller integrator state, \nir_cnv: Real current out of the converter,\nii_cnv: Imaginary current out of the converter,\nvr_filter: Real voltage at the filter's capacitor,\nvi_filter: Imaginary voltage at the filter's capacitor,\nir_filter: Real current out of the filter,\nii_filter: Imaginary current out of the filter\n\nn_states::Int: (Do not modify.) ActiveConstantPowerLoad has 12 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ActiveConstantPowerLoad/#InfrastructureSystems.get_name-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::ActiveConstantPowerLoad) -> String\n\n\nGet ActiveConstantPowerLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_P_ref-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_Q_ref-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_V_ref-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_base_power-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_c_dc-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_c_dc","text":"get_c_dc(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad c_dc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_cf-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_cf","text":"get_cf(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_ext-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_ext","text":"get_ext(value::ActiveConstantPowerLoad) -> Dict{String, Any}\n\n\nGet ActiveConstantPowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_is_filter_differential-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_is_filter_differential","text":"get_is_filter_differential(\n value::ActiveConstantPowerLoad\n) -> Int64\n\n\nGet ActiveConstantPowerLoad is_filter_differential.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_ki_pll-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_ki_pll","text":"get_ki_pll(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kic-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kic","text":"get_kic(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kiv-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kiv","text":"get_kiv(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kp_pll-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kp_pll","text":"get_kp_pll(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kpc-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kpc","text":"get_kpc(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kpv-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kpv","text":"get_kpv(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_lf-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_lf","text":"get_lf(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_lg-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_lg","text":"get_lg(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad lg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_n_states-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActiveConstantPowerLoad) -> Int64\n\n\nGet ActiveConstantPowerLoad n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_r_load-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_r_load","text":"get_r_load(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad r_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_rf-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_rf","text":"get_rf(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_rg-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_rg","text":"get_rg(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad rg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_states-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_states","text":"get_states(value::ActiveConstantPowerLoad) -> Vector{Symbol}\n\n\nGet ActiveConstantPowerLoad states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_ω_ref-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_ω_ref","text":"get_ω_ref(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad ω_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_P_ref!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_Q_ref!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_V_ref!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_base_power!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_c_dc!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_c_dc!","text":"set_c_dc!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad c_dc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_cf!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_cf!","text":"set_cf!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_ext!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_is_filter_differential!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_is_filter_differential!","text":"set_is_filter_differential!(\n value::ActiveConstantPowerLoad,\n val\n) -> Any\n\n\nSet ActiveConstantPowerLoad is_filter_differential.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_ki_pll!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_ki_pll!","text":"set_ki_pll!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kic!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kic!","text":"set_kic!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kiv!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kiv!","text":"set_kiv!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kp_pll!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kp_pll!","text":"set_kp_pll!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kpc!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kpc!","text":"set_kpc!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kpv!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kpv!","text":"set_kpv!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_lf!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_lf!","text":"set_lf!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_lg!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_lg!","text":"set_lg!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad lg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_r_load!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_r_load!","text":"set_r_load!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad r_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_rf!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_rf!","text":"set_rf!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_rg!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_rg!","text":"set_rg!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad rg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_ω_ref!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_ω_ref!","text":"set_ω_ref!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad ω_ref.\n\n\n\n\n\n","category":"method"},{"location":"how_to/get_available_generators/#Get-the-available-generators-in-a-System","page":"...get the available generators in a system","title":"Get the available generators in a System","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"using PowerSystems; #hide\nusing PowerSystemCaseBuilder #hide\nsystem = build_system(PSISystems, \"modified_RTS_GMLC_DA_sys\"); #hide","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"You can access use get_available_components or get_components to access all the available generators in an existing system.","category":"page"},{"location":"how_to/get_available_generators/#Option-1a:-Using-get_available_components-to-get-an-iterator","page":"...get the available generators in a system","title":"Option 1a: Using get_available_components to get an iterator","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"Use get_available_components to get an iterator of all the available generators in an existing system, which also prints a summary:","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"gen_iter = get_available_components(Generator, system)","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"The iterator avoids unnecessary memory allocations if there are many generators, and it can be used to view or update the generator data, such as seeing each of the names:","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"get_name.(gen_iter)","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"tip: Tip\nAbove, we use the abstract supertype Generator to get all components that are subtypes of it. You can instead get all the components of a concrete type, such as:gen_iter = get_available_components(RenewableDispatch, system)","category":"page"},{"location":"how_to/get_available_generators/#Option-1b:-Using-get_available_components-to-get-a-vector","page":"...get the available generators in a system","title":"Option 1b: Using get_available_components to get a vector","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"Use collect to get a vector of the generators instead of an iterator, which could require a lot of memory:","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"gens = collect(get_available_components(Generator, system));","category":"page"},{"location":"how_to/get_available_generators/#Option-2:-Using-get_components-to-get-an-iterator","page":"...get the available generators in a system","title":"Option 2: Using get_components to get an iterator","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"Alternatively, use get_components with a filter to check for availability:","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"gen_iter = get_components(get_available, Generator, system)","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"collect can also be used to turn this iterator into a vector.","category":"page"},{"location":"how_to/get_available_generators/#See-Also","page":"...get the available generators in a system","title":"See Also","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"How to: Get the buses in a System","category":"page"},{"location":"how_to/parse_tabular_data/#table_data","page":"...parse tabular data from .csv files","title":"Parse Tabular Data from .csv Files","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"warning: Warning\nThis parser will be deprecated sometime in the fall of 2024. PowerSystems.jl will be moving to a database solution for handling data. There are plans to eventually include utility functions to translate from .csv files to the database, but there will probably be a gap in support. Users are recommended to write their own custom Julia code to import data from their unique data formats, rather than relying on this parsing code.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"This parser, called the tabular data parser, is a custom format that allows users to define power system component data by category and column with custom names, types, and units.","category":"page"},{"location":"how_to/parse_tabular_data/#Categories","page":"...parse tabular data from .csv files","title":"Categories","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Components for each category must be defined in their own CSV file. The following categories are currently supported:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"branch.csv\nbus.csv (required)\ncolumns specifying area and zone will create a corresponding set of Area and LoadZone objects.\ncolumns specifying max_active_power or max_reactive_power will create PowerLoad objects when nonzero values are encountered and will contribute to the peak_active_power and peak_reactive_power values for the corresponding LoadZone object.\ndc_branch.csv\ngen.csv\nload.csv\nreserves.csv\nstorage.csv","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"These must reside in the directory passed when constructing PowerSystemTableData.","category":"page"},{"location":"how_to/parse_tabular_data/#Customization","page":"...parse tabular data from .csv files","title":"Customization","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"The tabular data parser in PowerSystems.jl can be customized to read a variety of datasets by configuring:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"which type of generator (<:Generator) to create based on the fuel and prime mover specifications\nproperty names, units, and per units conversions in *.csv files","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Here is an example of how to construct a System with all customizations listed in this section:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"data_dir = \"/data/my-data-dir\"\nbase_power = 100.0\ndescriptors = \"./user_descriptors.yaml\"\ntimeseries_metadata_file = \"./timeseries_pointers.json\"\ngenerator_mapping_file = \"./generator_mapping.yaml\"\ndata = PowerSystemTableData(\n data_dir,\n base_power,\n descriptors;\n timeseries_metadata_file = timeseries_metadata_file,\n generator_mapping_file = generator_mapping_file,\n)\nsys = System(data; time_series_in_memory = true)","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Examples configuration files can be found in the RTS-GMLC repo:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"user_descriptors.yaml\ngenerator_mapping.yaml","category":"page"},{"location":"how_to/parse_tabular_data/#csv_data","page":"...parse tabular data from .csv files","title":"CSV Data Configurations","text":"","category":"section"},{"location":"how_to/parse_tabular_data/#csv_genmap","page":"...parse tabular data from .csv files","title":"Custom construction of generators","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/#csv_columns","page":"...parse tabular data from .csv files","title":"Column names","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"PowerSystems provides am input mapping capability that allows you to keep your own column names.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"python ./bin/generate_config_file.py ./user_descriptors.yaml","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Next, edit this file with your customizations.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/#csv_per_unit","page":"...parse tabular data from .csv files","title":"Per-unit conversion","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"For more info on the per-unit conventions in PowerSystems.jl, refer to the per-unit section of the system documentation.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/#csv_units","page":"...parse tabular data from .csv files","title":"Unit conversion","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/#Extending-the-Tabular-Data-Parser","page":"...parse tabular data from .csv files","title":"Extending the Tabular Data Parser","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"This section describes how developers should read columns from raw data files, and assumes you are familiar with the sections above.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"The main point is that you should not read individual hard-coded column names from DataFrames. The parsing code includes mapping functionality that allows you to use PowerSystems-standard names while letting the users define their own custom names.","category":"page"},{"location":"how_to/parse_tabular_data/#Procedure","page":"...parse tabular data from .csv files","title":"Procedure","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Add an entry to the array of parameters for your category in src/descriptors/power_system_inputs.json according to the following:\nUse snake_case for the name field.\nThe fields name and description are required.\nTry to use a name that is generic and not specific to one dataset.\nIt is recommended that you define unit.\nIf PowerSystems expects the value to be per-unit then you must specify system_per_unit=true.\nPowerSystems has two commonly-used datasets with customized user config files: PowerSystemsTestData and RTS_GMLC. Update both of these files and submit pull requests.\nParse the raw data like in this example:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"function demo_bus_csv_parser!(data::PowerSystemTableData)\n for bus in iterate_rows(data, BUS::InputCategory)\n @show bus.name, bus.max_active_power, bus.max_reactive_power\n end\nend","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"iterate_rows returns a NamedTuple where each name defined in src/descriptors/power_system_inputs.json is a field.","category":"page"},{"location":"how_to/parse_tabular_data/#See-also:","page":"...parse tabular data from .csv files","title":"See also:","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Parsing Matpower or PSS/e RAW Files\nParsing PSS/e DYR Files\nParsing time series","category":"page"},{"location":"api/valuecurve_options/#curve_table","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"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.","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"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 is done by constructing various subtypes of ValueCurve.","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"This summary table shows each way to construct a ValueCurve with the user-friendly subtype aliases. The ValueCurves make no assumption about units; the example interpretation given here assumes that the variable cost ValueCurve will be wrapped in a CostCurve with natural units. Note that all four Piecewise options here fundamentally represent the same curve. More information and explanatory plots are provided for each subtype alias in the subheadings below.","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Description Example Example interpretation\nLinear input-output curve with zero no-load cost (constant average rate) LinearCurve(5.0) $5/MWh\nLinear input-output curve with potentially nonzero no-load cost (constant marginal rate) LinearCurve(5.0, 15.0) $5/MWh + $15/hr\nQuadratic input-output curve with potentially nonzero no-load cost QuadraticCurve(1.0, 1.0, 18.0) C(P) = 1 P^2 + 1 P + 18 where C is $/hr, P is MW\nPiecewise linear curve specified by cost values at production points PiecewisePointCurve([(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\nPiecewise linear curve specified by initial value and marginal rates (slopes) between production points PiecewiseIncrementalCurve(20.0, [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\nNo-load cost plus piecewise linear curve specified by initial value and marginal rates (slopes) between production points PiecewiseIncrementalCurve(18.0, 20.0, [1.0, 2.0, 3.0], [4.0, 6.0]) $18/hr no-load cost; $20/hr @ 1 MW plus additional $4/MWh from 1 MW to 2 MW plus additional $6/MWh from 2 MW to 3 MW\nPiecewise linear curve specified by initial value and average rates between production points PiecewiseAverageCurve(20.0, [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","category":"page"},{"location":"api/valuecurve_options/#[LinearCurve](@ref)","page":"ValueCurve Options","title":"LinearCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify the marginal cost of production M and optionally the no-load cost C, which defaults to zero. Here is a graphical representation:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"api/valuecurve_options/#[QuadraticCurve](@ref)","page":"ValueCurve Options","title":"QuadraticCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify the quadratic (Q), proportional (M), and constant (C) terms of a function that defines the input-output curve:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"api/valuecurve_options/#[PiecewisePointCurve](@ref)","page":"ValueCurve Options","title":"PiecewisePointCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify a vector of K (production, cost) pairs (i.e., (P_k C_k) for k = 1 dots K) to define the input-output curve:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"api/valuecurve_options/#[PiecewiseIncrementalCurve](@ref)","page":"ValueCurve Options","title":"PiecewiseIncrementalCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify the cost C_1 at the least production point given (NOT the cost at zero production), a vector of K production points P_1 dots P_k, and a vector of K-1 marginal rates M_1 dots M_k-1, that represent the slopes of the curve segments between the points. C_1 may be nothing, which results in a not-fully-defined curve. The no-load cost C_0 can optionally be specified as a first argument; it is not part of the representation of the curve, just another piece of data that may be stored:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"api/valuecurve_options/#[PiecewiseAverageCurve](@ref)","page":"ValueCurve Options","title":"PiecewiseAverageCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify the cost C_1 at the least production point given (NOT the cost at zero production), a vector of K production points P_1 dots P_k, and a vector of K-1 average rates R_1 dots R_k-1 at the K-1 latter production points:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"how_to/migrating_to_psy4/#psy4_migration","page":"...migrate from version 3.0 to 4.0","title":"Migrating from version 3.0 to 4.0","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"This guide outlines the code updates required to upgrade from PowerSystems.jl version 3.0 to 4.0, which was released in June 2024 and includes breaking changes. These are:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Renamed Types and Parameters\nNew and Eliminated Types\nUpdates to Energy Storage Parameters\nHydropower status added\nNew Cost Functions\nNew Time Series Horizon Format\nMinor Type Hierarchy Change\n(Temporary) Use Version 3.0 for HybridSystem (+ new parameter)","category":"page"},{"location":"how_to/migrating_to_psy4/#Renamed-Types-and-Parameters","page":"...migrate from version 3.0 to 4.0","title":"Renamed Types and Parameters","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Some Types and fields were renamed, which should require a trivial search and replace:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Renamed Types:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"RenewableFix is now named RenewableNonDispatch\nStaticReserve is now named ConstantReserve\nStaticReserveGroup is now named ConstantReserveGroup\nStaticReserveNonSpinning is now named ConstantReserveNonSpinning\nPriorityCurrentLimiter is now named PriorityOutputCurrentLimiter\nMagnitudeCurrentLimiter is now named MagnitudeOutputCurrentLimiter\nInstantaneousCurrentLimiter is now named InstantaneousOutputCurrentLimiter","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Renamed parameters:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The rate parameter is now named rating for subtypes of Branch, for consistency with other Types. Affected Types are:\nLine\nMonitoredLine\nPhaseShiftingTransformer\nTapTransformer\nTransformer2W","category":"page"},{"location":"how_to/migrating_to_psy4/#New-and-Eliminated-Types","page":"...migrate from version 3.0 to 4.0","title":"New and Eliminated Types","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"In addition to cost-related types detailed in New Cost Functions, these new types have been added:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"AreaInterchange\nHybridOutputCurrentLimiter\nSaturationOutputCurrentLimiter","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"These types are no longer part of PowerSystems.jl, although there are future plans to rework some of them:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"RegulationDevice\nTransfer\nBatteryEMS\nGenericBattery (see Updates to Energy Storage Parameters)","category":"page"},{"location":"how_to/migrating_to_psy4/#esr_migration","page":"...migrate from version 3.0 to 4.0","title":"Updates to Energy Storage Parameters","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"EnergyReservoirStorage is now the default battery and energy storage model, replacing GenericBattery.","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"There are also changes to the data fields compared to GenericBattery to improve clarity and modeling flexibility.","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"New data fields:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"storage_capacity for the maximum storage capacity (can be in units of, e.g., MWh for batteries or liters for hydrogen)\nExample: 10000.0 for 10,000 liters hydrogen\nstorage_level_limits for the minimum and maximum allowable storage levels on [0, 1], which can be used to model derates or other restrictions, such as state-of-charge restrictions on battery cycling\nExample: Minimum of 0.2 and maximum of 1.0 to restrict the storage from dropping below 20% capacity to keep some reserve margin available at all times\ninitial_storage_capacity_level for the initial storage capacity level as a ratio [0, 1.0] of storage_capacity\nExample: 0.5 to start the storage at 50% full\nconversion_factor is the (optional) conversion factor of storage_capacity to MWh, if different than 1.0 (i.e., no conversion is needed if the storage_capacity is in MWh)\nExample: 0.0005 for 0.5 kWh/l hydrogen","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Removed data fields:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"state_of_charge_limits with units of p.u.-hr\ninitial_energy with units of p.u.-hr","category":"page"},{"location":"how_to/migrating_to_psy4/#Hydropower-status-added","page":"...migrate from version 3.0 to 4.0","title":"Hydropower status added","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"A new required parameter, status, was added to HydroEnergyReservoir and HydroPumpedStorage, for the initial condition of the generator.","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"For HydroEnergyReservoir, status can be true = on or false = off.\nFor HydroPumpedStorage, status can be PumpHydroStatus.PUMP, PumpHydroStatus.GEN, or PumpHydroStatus.OFF","category":"page"},{"location":"how_to/migrating_to_psy4/#New-Cost-Functions","page":"...migrate from version 3.0 to 4.0","title":"New Cost Functions","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/#New-Time-Series-Horizon-Format","page":"...migrate from version 3.0 to 4.0","title":"New Time Series Horizon Format","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The horizon for a forecast has changed from a count of time steps (as an Int) to a duration, as a Dates.Period","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Example day-ahead forecast: A forecast with hourly resolution for the next 24 hours, with a new forecast available every 24 hours (i.e., 24-hour interval)","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The horizon is now Dates.Hour(24) or Dates.Day(1)\nPreviously in version 3.0, the horizon would have been 24 for the 24 1-hour time-steps in each forecast","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Example hour-ahead forecast: A forecast with 5-minute resolution for the next 1 hour, with a new forecast available every hour (i.e., 1-hour interval)","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The horizon is now Dates.Hour(1)\nPreviously in version 3.0, the horizon would have been 12 for the 12 5-minute time-steps in each forecast","category":"page"},{"location":"how_to/migrating_to_psy4/#Minor-Type-Hierarchy-Change","page":"...migrate from version 3.0 to 4.0","title":"Minor Type Hierarchy Change","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"ControllableLoad is now a subtype of StaticLoad rather than ElectricLoad","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The vast majority of users are not expected to be impacted by this change.","category":"page"},{"location":"how_to/migrating_to_psy4/#(Temporary)-Use-Version-3.0-for-HybridSystem-(-new-parameter)","page":"...migrate from version 3.0 to 4.0","title":"(Temporary) Use Version 3.0 for HybridSystem (+ new parameter)","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The HybridSystem is currently not supported in the rest of the Sienna ecosystem, such as PowerSimulations.jl. To use HybridSystem in simulation, revert to version 3.0. There are plans to update HybridSystem for version 4.0, but they have not been completed.","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"In addition, HybridSystem has a new required parameter: interconnection_efficiency","category":"page"},{"location":"how_to/market_bid_cost/#Add-a-Market-Bid","page":"...add a market bid","title":"Add a Market Bid","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"A MarketBidCost is an OperationalCost data structure that allows the user to run a production cost model that is very similar to most US electricity market auctions with bids for energy and ancillary services jointly. This page showcases how to create data for this cost function.","category":"page"},{"location":"how_to/market_bid_cost/#Adding-a-Single-Incremental-Energy-bids-to-MarketBidCost","page":"...add a market bid","title":"Adding a Single Incremental Energy bids to MarketBidCost","text":"","category":"section"},{"location":"how_to/market_bid_cost/#Construct-directly-the-MarketBidCost-using-the-make_market_bid_curve-method.","page":"...add a market bid","title":"Construct directly the MarketBidCost using the make_market_bid_curve method.","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"The make_market_bid_curve creates an incremental or decremental offer curve from a vector of n power values, a vector of n-1 marginal costs and single initial input. For example, the following code creates an incremental offer curve:","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"using PowerSystems, Dates\nproposed_offer_curve =\n make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0)","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Then a device with MarketBidCost can be directly instantiated using:","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"using PowerSystems, Dates\nbus = ACBus(1, \"nodeE\", \"REF\", 0, 1.0, (min = 0.9, max = 1.05), 230, nothing, nothing)\n\ngenerator = ThermalStandard(;\n name = \"Brighton\",\n available = true,\n status = true,\n bus = bus,\n active_power = 6.0,\n reactive_power = 1.50,\n rating = 0.75,\n prime_mover_type = PrimeMovers.ST,\n fuel = ThermalFuels.COAL,\n active_power_limits = (min = 0.0, max = 6.0),\n reactive_power_limits = (min = -4.50, max = 4.50),\n time_limits = (up = 0.015, down = 0.015),\n ramp_limits = (up = 5.0, down = 3.0),\n operation_cost = MarketBidCost(;\n no_load_cost = 0.0,\n start_up = (hot = 0.0, warm = 0.0, cold = 0.0),\n shut_down = 0.0,\n incremental_offer_curves = proposed_offer_curve,\n ),\n base_power = 100.0,\n)","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Similarly, a decremental offer curve can also be created directly using the same helper method:","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"using PowerSystems, Dates\ndecremental_offer =\n make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [30.0, 28.0, 26.0, 25.0], 50.0)","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"and can be added to a MarketBidCost using the field decremental_offer_curves.","category":"page"},{"location":"how_to/market_bid_cost/#Adding-Time-Series-Energy-bids-to-MarketBidCost","page":"...add a market bid","title":"Adding Time Series Energy bids to MarketBidCost","text":"","category":"section"},{"location":"how_to/market_bid_cost/#Step-1:-Constructing-device-with-MarketBidCost","page":"...add a market bid","title":"Step 1: Constructing device with MarketBidCost","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"When using MarketBidCost, the user can add the cost struct to the device specifying only certain elements, at this point the actual energy cost bids don't need to be populated/passed.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"The code below shows an example how we can create a thermal device with MarketBidCost.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"using PowerSystems, Dates\nbus = ACBus(1, \"nodeE\", \"REF\", 0, 1.0, (min = 0.9, max = 1.05), 230, nothing, nothing)\n\ngenerator = ThermalStandard(;\n name = \"Brighton\",\n available = true,\n status = true,\n bus = bus,\n active_power = 6.0,\n reactive_power = 1.50,\n rating = 0.75,\n prime_mover_type = PrimeMovers.ST,\n fuel = ThermalFuels.COAL,\n active_power_limits = (min = 0.0, max = 6.0),\n reactive_power_limits = (min = -4.50, max = 4.50),\n time_limits = (up = 0.015, down = 0.015),\n ramp_limits = (up = 5.0, down = 3.0),\n operation_cost = MarketBidCost(;\n no_load_cost = 0.0,\n start_up = (hot = 0.0, warm = 0.0, cold = 0.0),\n shut_down = 0.0,\n ),\n base_power = 100.0,\n)","category":"page"},{"location":"how_to/market_bid_cost/#Step-2:-Creating-the-TimeSeriesData-for-the-Market-Bid","page":"...add a market bid","title":"Step 2: Creating the TimeSeriesData for the Market Bid","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"The user is expected to pass the TimeSeriesData that holds the energy bid data which can be of any type (i.e. SingleTimeSeries or Deterministic) and data must be PiecewiseStepData. This data type is created by specifying a vector of n powers, and n-1 marginal costs. The data must be specified in natural units, that is power in MW and marginal cost in /MWh or it will not be accepted when adding to the system. Code below shows an example of how to build a Deterministic TimeSeries.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"initial_time = Dates.DateTime(\"2020-01-01\")\npsd1 = PiecewiseStepData([5.0, 7.33, 9.67, 12.0], [2.901, 5.8272, 8.941])\npsd2 = PiecewiseStepData([5.0, 7.33, 9.67, 12.0], [3.001, 6.0072, 9.001])\ndata =\n Dict(\n initial_time => [\n psd1,\n psd2,\n ],\n )\ntime_series_data = Deterministic(;\n name = \"variable_cost\",\n data = data,\n resolution = Dates.Hour(1),\n)","category":"page"},{"location":"how_to/market_bid_cost/#Step-3a:-Adding-Energy-Bid-TimeSeriesData-to-the-device","page":"...add a market bid","title":"Step 3a: Adding Energy Bid TimeSeriesData to the device","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"To add energy market bids time-series to the MarketBidCost, use set_variable_cost!. The arguments for set_variable_cost! are:","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"sys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::TimeSeriesData: TimeSeriesData\npower_units::UnitSystem: UnitSystem","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Currently, time series data only supports natural units for time series data, i.e. MW for power and /MWh for marginal costs.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"sys = System(100.0, [bus], [generator])\nset_variable_cost!(sys, generator, time_series_data, UnitSystem.NATURAL_UNITS)","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Note: set_variable_cost! add curves to the incremental_offer_curves in the MarketBidCost. Similarly, set_incremental_variable_cost! can be used to add curves to the incremental_offer_curves. On the other hand, set_decremental_variable_cost! must be used to decremental curves (usually for storage or demand). The creation of the TimeSeriesData is similar to Step 2, using PiecewiseStepData","category":"page"},{"location":"how_to/market_bid_cost/#Step-3b:-Adding-Service-Bid-TimeSeriesData-to-the-device","page":"...add a market bid","title":"Step 3b: Adding Service Bid TimeSeriesData to the device","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Similar to adding energy market bids, for adding bids for ancillary services, use set_service_bid!.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"service = VariableReserve{ReserveUp}(\"example_reserve\", true, 0.6, 2.0)\nadd_service!(sys, service, get_component(ThermalStandard, sys, \"Brighton\"))\n\npsd3 = PiecewiseStepData([0.0, 10.0], [650.3])\npsd4 = PiecewiseStepData([0.0, 10.0], [750.0])\ndata = Dict(Dates.DateTime(\"2020-01-01\") => [psd3, psd4])\ntime_series_data = Deterministic(;\n name = get_name(service),\n data = data,\n resolution = Dates.Hour(1),\n)\nset_service_bid!(sys, generator, service, time_series_data, UnitSystem.NATURAL_UNITS)","category":"page"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#SimplifiedSingleCageInductionMachine","page":"SimplifiedSingleCageInductionMachine","title":"SimplifiedSingleCageInductionMachine","text":"","category":"section"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/","page":"SimplifiedSingleCageInductionMachine","title":"SimplifiedSingleCageInductionMachine","text":"Modules = [PowerSystems]\nPages = [\"generated/SimplifiedSingleCageInductionMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.SimplifiedSingleCageInductionMachine","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.SimplifiedSingleCageInductionMachine","text":"mutable struct SimplifiedSingleCageInductionMachine <: DynamicInjection\n name::String\n R_s::Float64\n R_r::Float64\n X_ls::Float64\n X_lr::Float64\n X_m::Float64\n H::Float64\n A::Float64\n B::Float64\n base_power::Float64\n ext::Dict{String, Any}\n C::Float64\n τ_ref::Float64\n B_shunt::Float64\n X_ss::Float64\n X_rr::Float64\n X_p::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 3-states three-phase single cage induction machine with quadratic torque-speed relationship\n\nArguments\n\nname::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\nR_s::Float64: Armature stator resistance, validation range: (0, nothing)\nR_r::Float64: Rotor resistance, validation range: (0, nothing)\nX_ls::Float64: Stator Leakage Reactance, validation range: (0, nothing)\nX_lr::Float64: Rotor Leakage Reactance, validation range: (0, nothing)\nX_m::Float64: Stator-Rotor Mutual Reactance, validation range: (0, nothing)\nH::Float64: Motor Inertia Constant [s], validation range: (0, nothing)\nA::Float64: Torque-Speed Quadratic Term, validation range: (0, 1)\nB::Float64: Torque-Speed Linear Term, validation range: (0, 1)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\next::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.\nC::Float64: (Do not modify.) Torque-Speed Constant Term\nτ_ref::Float64: Reference torque parameter\nB_shunt::Float64: Susceptance Initialization Corrector Term\nX_ss::Float64: (Do not modify.) Stator self reactance\nX_rr::Float64: (Do not modify.) Rotor self reactance\nX_p::Float64: (Do not modify.) Transient reactance\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψ_qr: rotor flux in the q-axis,\nψ_dr: rotor flux in the d-axis, \nωr: Rotor speed [pu],\n\nn_states::Int: (Do not modify.) SimplifiedSingleCageInductionMachine has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#InfrastructureSystems.get_name-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"InfrastructureSystems.get_name","text":"get_name(\n value::SimplifiedSingleCageInductionMachine\n) -> String\n\n\nGet SimplifiedSingleCageInductionMachine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_A-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_A","text":"get_A(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine A.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_B-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_B","text":"get_B(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine B.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_B_shunt-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_B_shunt","text":"get_B_shunt(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine B_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_C-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_C","text":"get_C(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine C.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_H-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_H","text":"get_H(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_R_r-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_R_r","text":"get_R_r(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine R_r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_R_s-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_R_s","text":"get_R_s(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine R_s.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_lr-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_lr","text":"get_X_lr(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_ls-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_ls","text":"get_X_ls(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_ls.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_m-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_m","text":"get_X_m(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_p-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_p","text":"get_X_p(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_rr-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_rr","text":"get_X_rr(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_rr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_ss-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_ss","text":"get_X_ss(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_ss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_base_power-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_base_power","text":"get_base_power(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_ext-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_ext","text":"get_ext(\n value::SimplifiedSingleCageInductionMachine\n) -> Dict{String, Any}\n\n\nGet SimplifiedSingleCageInductionMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_n_states-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_n_states","text":"get_n_states(\n value::SimplifiedSingleCageInductionMachine\n) -> Int64\n\n\nGet SimplifiedSingleCageInductionMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_states-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_states","text":"get_states(\n value::SimplifiedSingleCageInductionMachine\n) -> Vector{Symbol}\n\n\nGet SimplifiedSingleCageInductionMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_τ_ref-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_τ_ref","text":"get_τ_ref(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine τ_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_A!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_A!","text":"set_A!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine A.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_B!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_B!","text":"set_B!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine B.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_B_shunt!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_B_shunt!","text":"set_B_shunt!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine B_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_C!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_C!","text":"set_C!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine C.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_H!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_H!","text":"set_H!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_R_r!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_R_r!","text":"set_R_r!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine R_r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_R_s!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_R_s!","text":"set_R_s!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine R_s.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_lr!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_lr!","text":"set_X_lr!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_ls!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_ls!","text":"set_X_ls!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_ls.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_m!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_m!","text":"set_X_m!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_p!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_p!","text":"set_X_p!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_rr!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_rr!","text":"set_X_rr!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_rr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_ss!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_ss!","text":"set_X_ss!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_ss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_base_power!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_base_power!","text":"set_base_power!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_ext!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_ext!","text":"set_ext!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_τ_ref!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_τ_ref!","text":"set_τ_ref!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine τ_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#ACBus","page":"ACBus","title":"ACBus","text":"","category":"section"},{"location":"model_library/generated_ACBus/","page":"ACBus","title":"ACBus","text":"Modules = [PowerSystems]\nPages = [\"generated/ACBus.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ACBus/#PowerSystems.ACBus","page":"ACBus","title":"PowerSystems.ACBus","text":"mutable struct ACBus <: Bus\n number::Int\n name::String\n bustype::Union{Nothing, ACBusTypes}\n angle::Union{Nothing, Float64}\n magnitude::Union{Nothing, Float64}\n voltage_limits::Union{Nothing, MinMax}\n base_voltage::Union{Nothing, Float64}\n area::Union{Nothing, Area}\n load_zone::Union{Nothing, LoadZone}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn AC bus\n\nArguments\n\nnumber::Int: A unique bus identification number (positive integer)\nname::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\nbustype::Union{Nothing, ACBusTypes}: Used to describe the connectivity and behavior of this bus. Options are listed here.\nangle::Union{Nothing, Float64}: angle of the bus in radians, validation range: (-1.571, 1.571)\nmagnitude::Union{Nothing, Float64}: voltage as a multiple of base_voltage, validation range: voltage_limits\nvoltage_limits::Union{Nothing, MinMax}: limits on the voltage variation as multiples of base_voltage\nbase_voltage::Union{Nothing, Float64}: the base voltage in kV, validation range: (0, nothing)\narea::Union{Nothing, Area}: (default: nothing) the area containing the bus\nload_zone::Union{Nothing, LoadZone}: (default: nothing) the load zone containing the bus\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ACBus/#InfrastructureSystems.get_name-Tuple{ACBus}","page":"ACBus","title":"InfrastructureSystems.get_name","text":"get_name(value::ACBus) -> String\n\n\nGet ACBus name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_angle-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_angle","text":"get_angle(value::ACBus) -> Union{Nothing, Float64}\n\n\nGet ACBus angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_area-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_area","text":"get_area(value::ACBus) -> Union{Nothing, Area}\n\n\nGet ACBus area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_base_voltage-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_base_voltage","text":"get_base_voltage(value::ACBus) -> Union{Nothing, Float64}\n\n\nGet ACBus base_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_bustype-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_bustype","text":"get_bustype(value::ACBus) -> Union{Nothing, ACBusTypes}\n\n\nGet ACBus bustype.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_ext-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_ext","text":"get_ext(value::ACBus) -> Dict{String, Any}\n\n\nGet ACBus ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_load_zone-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_load_zone","text":"get_load_zone(value::ACBus) -> Union{Nothing, LoadZone}\n\n\nGet ACBus load_zone.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_magnitude-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_magnitude","text":"get_magnitude(value::ACBus) -> Union{Nothing, Float64}\n\n\nGet ACBus magnitude.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_number-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_number","text":"get_number(value::ACBus) -> Int64\n\n\nGet ACBus number.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_voltage_limits-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_voltage_limits","text":"get_voltage_limits(\n value::ACBus\n) -> Union{Nothing, @NamedTuple{min::Float64, max::Float64}}\n\n\nGet ACBus voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_angle!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_angle!","text":"set_angle!(value::ACBus, val) -> Any\n\n\nSet ACBus angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_area!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_area!","text":"set_area!(value::ACBus, val) -> Area\n\n\nSet ACBus area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_base_voltage!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_base_voltage!","text":"set_base_voltage!(value::ACBus, val) -> Any\n\n\nSet ACBus base_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_bustype!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_bustype!","text":"set_bustype!(value::ACBus, val) -> Any\n\n\nSet ACBus bustype.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_ext!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_ext!","text":"set_ext!(value::ACBus, val) -> Any\n\n\nSet ACBus ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_load_zone!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_load_zone!","text":"set_load_zone!(value::ACBus, val) -> LoadZone\n\n\nSet ACBus load_zone.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_magnitude!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_magnitude!","text":"set_magnitude!(value::ACBus, val) -> Any\n\n\nSet ACBus magnitude.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_number!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_number!","text":"set_number!(value::ACBus, val) -> Any\n\n\nSet ACBus number.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_voltage_limits!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_voltage_limits!","text":"set_voltage_limits!(value::ACBus, val) -> Any\n\n\nSet ACBus voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#EnergyReservoirStorage","page":"EnergyReservoirStorage","title":"EnergyReservoirStorage","text":"","category":"section"},{"location":"model_library/generated_EnergyReservoirStorage/","page":"EnergyReservoirStorage","title":"EnergyReservoirStorage","text":"Modules = [PowerSystems]\nPages = [\"generated/EnergyReservoirStorage.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.EnergyReservoirStorage","page":"EnergyReservoirStorage","title":"PowerSystems.EnergyReservoirStorage","text":"mutable struct EnergyReservoirStorage <: Storage\n name::String\n available::Bool\n bus::ACBus\n prime_mover_type::PrimeMovers\n storage_technology_type::StorageTech\n storage_capacity::Float64\n storage_level_limits::MinMax\n initial_storage_capacity_level::Float64\n rating::Float64\n active_power::Float64\n input_active_power_limits::MinMax\n output_active_power_limits::MinMax\n efficiency::NamedTuple{(:in, :out), Tuple{Float64, Float64}}\n reactive_power::Float64\n reactive_power_limits::Union{Nothing, MinMax}\n base_power::Float64\n operation_cost::StorageCost\n conversion_factor::Float64\n storage_target::Float64\n cycle_limits::Int\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn energy storage device, modeled as a generic energy reservoir.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nstorage_technology_type::StorageTech: Storage Technology Complementary to EIA 923. Options are listed here\nstorage_capacity::Float64: Maximum storage capacity (can be in units of, e.g., MWh for batteries or liters for hydrogen), validation range: (0, nothing)\nstorage_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)\ninitial_storage_capacity_level::Float64: Initial storage capacity level as a ratio [0, 1.0] of storage_capacity, validation range: (0, 1)\nrating::Float64: Maximum output power rating of the unit (MVA)\nactive_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\ninput_active_power_limits::MinMax: Minimum and maximum limits on the input active power (i.e., charging), validation range: (0, nothing)\noutput_active_power_limits::MinMax: Minimum and maximum limits on the output active power (i.e., discharging), validation range: (0, nothing)\nefficiency::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)\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\noperation_cost::StorageCost: (default: StorageCost(nothing)) OperationalCost of storage\nconversion_factor::Float64: (default: 1.0) Conversion factor of storage_capacity to MWh, if different than 1.0. For example, X MWh/liter hydrogen\nstorage_target::Float64: (default: 0.0) Storage target at the end of simulation as ratio of storage capacity\ncycle_limits::Int: (default: 1e4) Storage Maximum number of cycles per year\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_EnergyReservoirStorage/#InfrastructureSystems.get_name-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"InfrastructureSystems.get_name","text":"get_name(value::EnergyReservoirStorage) -> String\n\n\nGet EnergyReservoirStorage name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_active_power-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_active_power","text":"get_active_power(value::EnergyReservoirStorage) -> Any\n\n\nGet EnergyReservoirStorage active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_available-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_available","text":"get_available(value::EnergyReservoirStorage) -> Bool\n\n\nGet EnergyReservoirStorage available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_base_power-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_base_power","text":"get_base_power(value::EnergyReservoirStorage) -> Float64\n\n\nGet EnergyReservoirStorage base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_bus-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_bus","text":"get_bus(value::EnergyReservoirStorage) -> ACBus\n\n\nGet EnergyReservoirStorage bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_conversion_factor-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_conversion_factor","text":"get_conversion_factor(\n value::EnergyReservoirStorage\n) -> Float64\n\n\nGet EnergyReservoirStorage conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_cycle_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_cycle_limits","text":"get_cycle_limits(value::EnergyReservoirStorage) -> Int64\n\n\nGet EnergyReservoirStorage cycle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_dynamic_injector-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::EnergyReservoirStorage\n) -> Union{Nothing, DynamicInjection}\n\n\nGet EnergyReservoirStorage dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_efficiency-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_efficiency","text":"get_efficiency(\n value::EnergyReservoirStorage\n) -> @NamedTuple{in::Float64, out::Float64}\n\n\nGet EnergyReservoirStorage efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_ext-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_ext","text":"get_ext(value::EnergyReservoirStorage) -> Dict{String, Any}\n\n\nGet EnergyReservoirStorage ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_initial_storage_capacity_level-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_initial_storage_capacity_level","text":"get_initial_storage_capacity_level(\n value::EnergyReservoirStorage\n) -> Float64\n\n\nGet EnergyReservoirStorage initial_storage_capacity_level.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_input_active_power_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_input_active_power_limits","text":"get_input_active_power_limits(\n value::EnergyReservoirStorage\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet EnergyReservoirStorage input_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_operation_cost-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::EnergyReservoirStorage\n) -> StorageCost\n\n\nGet EnergyReservoirStorage operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_output_active_power_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_output_active_power_limits","text":"get_output_active_power_limits(\n value::EnergyReservoirStorage\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet EnergyReservoirStorage output_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_prime_mover_type-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::EnergyReservoirStorage\n) -> PrimeMovers\n\n\nGet EnergyReservoirStorage prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_rating-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_rating","text":"get_rating(value::EnergyReservoirStorage) -> Any\n\n\nGet EnergyReservoirStorage rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_reactive_power-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::EnergyReservoirStorage) -> Any\n\n\nGet EnergyReservoirStorage reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_reactive_power_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::EnergyReservoirStorage\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet EnergyReservoirStorage reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_services-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_services","text":"get_services(\n value::EnergyReservoirStorage\n) -> Vector{Service}\n\n\nGet EnergyReservoirStorage services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_storage_capacity-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_storage_capacity","text":"get_storage_capacity(value::EnergyReservoirStorage) -> Any\n\n\nGet EnergyReservoirStorage storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_storage_level_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_storage_level_limits","text":"get_storage_level_limits(\n value::EnergyReservoirStorage\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EnergyReservoirStorage storage_level_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_storage_target-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_storage_target","text":"get_storage_target(value::EnergyReservoirStorage) -> Float64\n\n\nGet EnergyReservoirStorage storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_storage_technology_type-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_storage_technology_type","text":"get_storage_technology_type(\n value::EnergyReservoirStorage\n) -> StorageTech\n\n\nGet EnergyReservoirStorage storage_technology_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_active_power!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_available!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_available!","text":"set_available!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_base_power!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_bus!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_bus!","text":"set_bus!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_conversion_factor!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_conversion_factor!","text":"set_conversion_factor!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_cycle_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_cycle_limits!","text":"set_cycle_limits!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage cycle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_efficiency!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_efficiency!","text":"set_efficiency!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_ext!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_ext!","text":"set_ext!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_initial_storage_capacity_level!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_initial_storage_capacity_level!","text":"set_initial_storage_capacity_level!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage initial_storage_capacity_level.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_input_active_power_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_input_active_power_limits!","text":"set_input_active_power_limits!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage input_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_operation_cost!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_output_active_power_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_output_active_power_limits!","text":"set_output_active_power_limits!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage output_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_prime_mover_type!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_rating!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_rating!","text":"set_rating!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_reactive_power!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_reactive_power_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_services!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_services!","text":"set_services!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_storage_capacity!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_storage_capacity!","text":"set_storage_capacity!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_storage_level_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_storage_level_limits!","text":"set_storage_level_limits!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage storage_level_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_storage_target!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_storage_target!","text":"set_storage_target!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_storage_technology_type!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_storage_technology_type!","text":"set_storage_technology_type!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage storage_technology_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#MonitoredLine","page":"MonitoredLine","title":"MonitoredLine","text":"","category":"section"},{"location":"model_library/generated_MonitoredLine/","page":"MonitoredLine","title":"MonitoredLine","text":"Modules = [PowerSystems]\nPages = [\"generated/MonitoredLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.MonitoredLine","page":"MonitoredLine","title":"PowerSystems.MonitoredLine","text":"mutable struct MonitoredLine <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n b::FromTo\n flow_limits::FromTo_ToFrom\n rating::Float64\n angle_limits::MinMax\n g::FromTo\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn AC transmission line with additional power flow constraints specified by the system operator, more restrictive than the line's thermal limits.\n\nFor 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow on the line (MVAR)\narc::Arc: An Arc defining this line from a bus to another bus\nr::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)\nx::Float64: Reactance in pu (SYSTEM_BASE), validation range: (0, 4)\nb::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)\nflow_limits::FromTo_ToFrom: Minimum and maximum permissable flow on the line (MVA), if different from the thermal rating defined in rating\nrating::Float64: Thermal rating (MVA). Flow through the transformer must be between -rating and rating. When defining a line before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to\nangle_limits::MinMax: Minimum and maximum angle limits (radians), validation range: (-1.571, 1.571)\ng::FromTo: (default: (from=0.0, to=0.0)) Shunt conductance 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)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_MonitoredLine/#InfrastructureSystems.get_name-Tuple{MonitoredLine}","page":"MonitoredLine","title":"InfrastructureSystems.get_name","text":"get_name(value::MonitoredLine) -> String\n\n\nGet MonitoredLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_active_power_flow-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::MonitoredLine) -> Any\n\n\nGet MonitoredLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_angle_limits-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_angle_limits","text":"get_angle_limits(\n value::MonitoredLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet MonitoredLine angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_arc-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_arc","text":"get_arc(value::MonitoredLine) -> Arc\n\n\nGet MonitoredLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_available-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_available","text":"get_available(value::MonitoredLine) -> Bool\n\n\nGet MonitoredLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_b-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_b","text":"get_b(\n value::MonitoredLine\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet MonitoredLine b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_ext-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_ext","text":"get_ext(value::MonitoredLine) -> Dict{String, Any}\n\n\nGet MonitoredLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_flow_limits-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_flow_limits","text":"get_flow_limits(\n value::MonitoredLine\n) -> NamedTuple{(:from_to, :to_from), <:Tuple{Any, Any}}\n\n\nGet MonitoredLine flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_g-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_g","text":"get_g(\n value::MonitoredLine\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet MonitoredLine g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_r-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_r","text":"get_r(value::MonitoredLine) -> Float64\n\n\nGet MonitoredLine r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_rating-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_rating","text":"get_rating(value::MonitoredLine) -> Any\n\n\nGet MonitoredLine rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_reactive_power_flow-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::MonitoredLine) -> Any\n\n\nGet MonitoredLine reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_services-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_services","text":"get_services(value::MonitoredLine) -> Vector{Service}\n\n\nGet MonitoredLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_x-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_x","text":"get_x(value::MonitoredLine) -> Float64\n\n\nGet MonitoredLine x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_active_power_flow!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_angle_limits!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_angle_limits!","text":"set_angle_limits!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_arc!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_available!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_available!","text":"set_available!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_b!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_b!","text":"set_b!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_ext!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_flow_limits!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_flow_limits!","text":"set_flow_limits!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_g!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_g!","text":"set_g!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_r!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_r!","text":"set_r!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_rating!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_rating!","text":"set_rating!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_reactive_power_flow!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_services!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_services!","text":"set_services!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_x!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_x!","text":"set_x!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_inverter/#DynamicInverter","page":"Dynamic Inverter","title":"DynamicInverter","text":"","category":"section"},{"location":"model_library/dynamic_inverter/","page":"Dynamic Inverter","title":"Dynamic Inverter","text":"Modules = [PowerSystems]\nPages = [\"dynamic_inverter.jl\"]\nOrder = [:type, :function]\nPublic = true","category":"page"},{"location":"model_library/dynamic_inverter/#PowerSystems.DynamicInverter","page":"Dynamic Inverter","title":"PowerSystems.DynamicInverter","text":"mutable struct DynamicInverter{\n C <: Converter,\n O <: OuterControl,\n IC <: InnerControl,\n DC <: DCSource,\n P <: FrequencyEstimator,\n F <: Filter,\n} <: DynamicInjection\n name::String\n ω_ref::Float64\n converter::C\n outer_control::O\n inner_control::IC\n dc_source::DC\n freq_estimator::P\n filter::F\n limiter::Union{nothing, OutputCurrentLimiter}\n base_power::Float64\n n_states::Int\n states::Vector{Symbol}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA dynamic inverter with the necessary data for modeling the dynamic response of an inverter in a phasor or electromagnetic transient simulation.\n\nA dynamic inverter is composed by 6 components, namely a Converter, Outer Loop Control, Inner Loop Control, a DC Source, a Frequency Estimator and a Filter.\n\nIt must be attached to a StaticInjection device using add_component!, which contains all the rest of the generator's data that isn't specific to its dynamic response.\n\nArguments\n\nname::String: Name of inverter.\nω_ref::Float64: Frequency reference set-point in pu.\nconverter <: Converter: Converter model for the PWM transformation.\nouter_control <: OuterControl: An OuterControl controller model.\ninner_control <: InnerControl: An InnerControl controller model.\ndc_source <: DCSource: DCSource model.\nfreq_estimator <: FrequencyEstimator: a FrequencyEstimator (typically a PLL) model.\nfilter <: Filter: Filter model.\nlimiter <: Union{nothing, OutputCurrentLimiter}: (default: nothing) Inner Control Current Limiter model\nbase_power::Float64: (default: 100.0) Base power of the unit (MVA) for per unitization. Although this has a default, in almost all cases base_power should be updated to equal the base_power field of the StaticInjection device that this dynamic generator will be attached to.\nn_states::Int: (Do not modify.) Number of states (will depend on the inputs above).\nstates::Vector{Symbol}: (Do not modify.) Vector of states (will depend on the inputs above).\next::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AGC/#AGC","page":"AGC","title":"AGC","text":"","category":"section"},{"location":"model_library/generated_AGC/","page":"AGC","title":"AGC","text":"Modules = [PowerSystems]\nPages = [\"generated/AGC.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AGC/#PowerSystems.AGC","page":"AGC","title":"PowerSystems.AGC","text":"mutable struct AGC <: Service\n name::String\n available::Bool\n bias::Float64\n K_p::Float64\n K_i::Float64\n K_d::Float64\n delta_t::Float64\n area::Union{Nothing, Area}\n initial_ace::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAutomatic generation control (AGC) for the system or a certain Area within the system.\n\nThis 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.\"\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbias::Float64: Area frequency bias in MW/Hz\nK_p::Float64: PID Proportional Constant\nK_i::Float64: PID Integral Constant\nK_d::Float64: PID Derivative Constant\ndelta_t::Float64: PID Discretization period [Seconds]\narea::Union{Nothing, Area}: (default: nothing) the area controlled by the AGC\ninitial_ace::Float64: (default: 0.0) Initial condition for ACE\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AGC/#InfrastructureSystems.get_name-Tuple{AGC}","page":"AGC","title":"InfrastructureSystems.get_name","text":"get_name(value::AGC) -> String\n\n\nGet AGC name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_K_d-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_K_d","text":"get_K_d(value::AGC) -> Float64\n\n\nGet AGC K_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_K_i-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_K_i","text":"get_K_i(value::AGC) -> Float64\n\n\nGet AGC K_i.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_K_p-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_K_p","text":"get_K_p(value::AGC) -> Float64\n\n\nGet AGC K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_area-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_area","text":"get_area(value::AGC) -> Union{Nothing, Area}\n\n\nGet AGC area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_available-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_available","text":"get_available(value::AGC) -> Bool\n\n\nGet AGC available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_bias-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_bias","text":"get_bias(value::AGC) -> Float64\n\n\nGet AGC bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_delta_t-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_delta_t","text":"get_delta_t(value::AGC) -> Float64\n\n\nGet AGC delta_t.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_ext-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_ext","text":"get_ext(value::AGC) -> Dict{String, Any}\n\n\nGet AGC ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_initial_ace-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_initial_ace","text":"get_initial_ace(value::AGC) -> Float64\n\n\nGet AGC initial_ace.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_K_d!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_K_d!","text":"set_K_d!(value::AGC, val) -> Any\n\n\nSet AGC K_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_K_i!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_K_i!","text":"set_K_i!(value::AGC, val) -> Any\n\n\nSet AGC K_i.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_K_p!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_K_p!","text":"set_K_p!(value::AGC, val) -> Any\n\n\nSet AGC K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_area!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_area!","text":"set_area!(value::AGC, val) -> Any\n\n\nSet AGC area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_available!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_available!","text":"set_available!(value::AGC, val) -> Any\n\n\nSet AGC available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_bias!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_bias!","text":"set_bias!(value::AGC, val) -> Any\n\n\nSet AGC bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_delta_t!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_delta_t!","text":"set_delta_t!(value::AGC, val) -> Any\n\n\nSet AGC delta_t.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_ext!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_ext!","text":"set_ext!(value::AGC, val) -> Any\n\n\nSet AGC ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_initial_ace!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_initial_ace!","text":"set_initial_ace!(value::AGC, val) -> Any\n\n\nSet AGC initial_ace.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#Transformer2W","page":"Transformer2W","title":"Transformer2W","text":"","category":"section"},{"location":"model_library/generated_Transformer2W/","page":"Transformer2W","title":"Transformer2W","text":"Modules = [PowerSystems]\nPages = [\"generated/Transformer2W.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Transformer2W/#PowerSystems.Transformer2W","page":"Transformer2W","title":"PowerSystems.Transformer2W","text":"mutable struct Transformer2W <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n primary_shunt::Float64\n rating::Union{Nothing, Float64}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA basic 2-winding transformer.\n\nThe 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow through the transformer (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow through the transformer (MVAR)\narc::Arc: An Arc defining this transformer from a bus to another bus\nr::Float64: Resistance in pu (SYSTEM_BASE), validation range: (-2, 4)\nx::Float64: Reactance in pu (SYSTEM_BASE), validation range: (-2, 4)\nprimary_shunt::Float64: Shunt reactance in pu (SYSTEM_BASE), validation range: (0, 2)\nrating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating and rating. When defining a transformer before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Transformer2W/#InfrastructureSystems.get_name-Tuple{Transformer2W}","page":"Transformer2W","title":"InfrastructureSystems.get_name","text":"get_name(value::Transformer2W) -> String\n\n\nGet Transformer2W name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_active_power_flow-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::Transformer2W) -> Any\n\n\nGet Transformer2W active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_arc-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_arc","text":"get_arc(value::Transformer2W) -> Arc\n\n\nGet Transformer2W arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_available-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_available","text":"get_available(value::Transformer2W) -> Bool\n\n\nGet Transformer2W available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_ext-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_ext","text":"get_ext(value::Transformer2W) -> Dict{String, Any}\n\n\nGet Transformer2W ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_primary_shunt-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_primary_shunt","text":"get_primary_shunt(value::Transformer2W) -> Float64\n\n\nGet Transformer2W primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_r-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_r","text":"get_r(value::Transformer2W) -> Float64\n\n\nGet Transformer2W r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_rating-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_rating","text":"get_rating(value::Transformer2W) -> Any\n\n\nGet Transformer2W rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_reactive_power_flow-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::Transformer2W) -> Any\n\n\nGet Transformer2W reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_services-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_services","text":"get_services(value::Transformer2W) -> Vector{Service}\n\n\nGet Transformer2W services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_x-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_x","text":"get_x(value::Transformer2W) -> Float64\n\n\nGet Transformer2W x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_active_power_flow!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_arc!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_arc!","text":"set_arc!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_available!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_available!","text":"set_available!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_ext!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_ext!","text":"set_ext!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_primary_shunt!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_primary_shunt!","text":"set_primary_shunt!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_r!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_r!","text":"set_r!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_rating!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_rating!","text":"set_rating!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_reactive_power_flow!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_services!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_services!","text":"set_services!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_x!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_x!","text":"set_x!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#HydroEnergyReservoir","page":"HydroEnergyReservoir","title":"HydroEnergyReservoir","text":"","category":"section"},{"location":"model_library/generated_HydroEnergyReservoir/","page":"HydroEnergyReservoir","title":"HydroEnergyReservoir","text":"Modules = [PowerSystems]\nPages = [\"generated/HydroEnergyReservoir.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.HydroEnergyReservoir","page":"HydroEnergyReservoir","title":"PowerSystems.HydroEnergyReservoir","text":"mutable struct HydroEnergyReservoir <: HydroGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n time_limits::Union{Nothing, UpDown}\n base_power::Float64\n storage_capacity::Float64\n inflow::Float64\n initial_storage::Float64\n operation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}\n storage_target::Float64\n conversion_factor::Float64\n status::Bool\n time_at_status::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA hydropower generator with an upper reservoir, offering some energy storage and operational flexibility.\n\nFor hydro generators with pumped storage, see HydroPumpedStorage\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nstorage_capacity::Float64: Maximum storage capacity in the reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)\ninflow::Float64: Baseline inflow into the reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)\ninitial_storage::Float64: Initial storage capacity in the reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)\noperation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation\nstorage_target::Float64: (default: 1.0) Storage target at the end of simulation as a fraction of storage capacity\nconversion_factor::Float64: (default: 1.0) Conversion factor from flow/volume to energy: m^3 -> p.u-hr\nstatus::Bool: (default: false) Initial commitment condition at the start of a simulation (true = on or false = off)\ntime_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_HydroEnergyReservoir/#InfrastructureSystems.get_name-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"InfrastructureSystems.get_name","text":"get_name(value::HydroEnergyReservoir) -> String\n\n\nGet HydroEnergyReservoir name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_active_power-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_active_power","text":"get_active_power(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_active_power_limits-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::HydroEnergyReservoir\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet HydroEnergyReservoir active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_available-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_available","text":"get_available(value::HydroEnergyReservoir) -> Bool\n\n\nGet HydroEnergyReservoir available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_base_power-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_base_power","text":"get_base_power(value::HydroEnergyReservoir) -> Float64\n\n\nGet HydroEnergyReservoir base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_bus-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_bus","text":"get_bus(value::HydroEnergyReservoir) -> ACBus\n\n\nGet HydroEnergyReservoir bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_conversion_factor-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_conversion_factor","text":"get_conversion_factor(\n value::HydroEnergyReservoir\n) -> Float64\n\n\nGet HydroEnergyReservoir conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_dynamic_injector-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::HydroEnergyReservoir\n) -> Union{Nothing, DynamicInjection}\n\n\nGet HydroEnergyReservoir dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_ext-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_ext","text":"get_ext(value::HydroEnergyReservoir) -> Dict{String, Any}\n\n\nGet HydroEnergyReservoir ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_inflow-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_inflow","text":"get_inflow(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir inflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_initial_storage-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_initial_storage","text":"get_initial_storage(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir initial_storage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_operation_cost-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::HydroEnergyReservoir\n) -> Union{HydroGenerationCost, MarketBidCost, StorageCost}\n\n\nGet HydroEnergyReservoir operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_prime_mover_type-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::HydroEnergyReservoir\n) -> PrimeMovers\n\n\nGet HydroEnergyReservoir prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_ramp_limits-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::HydroEnergyReservoir\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet HydroEnergyReservoir ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_rating-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_rating","text":"get_rating(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_reactive_power-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_reactive_power_limits-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::HydroEnergyReservoir\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HydroEnergyReservoir reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_services-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_services","text":"get_services(value::HydroEnergyReservoir) -> Vector{Service}\n\n\nGet HydroEnergyReservoir services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_status-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_status","text":"get_status(value::HydroEnergyReservoir) -> Bool\n\n\nGet HydroEnergyReservoir status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_storage_capacity-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_storage_capacity","text":"get_storage_capacity(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_storage_target-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_storage_target","text":"get_storage_target(value::HydroEnergyReservoir) -> Float64\n\n\nGet HydroEnergyReservoir storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_time_at_status-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_time_at_status","text":"get_time_at_status(value::HydroEnergyReservoir) -> Float64\n\n\nGet HydroEnergyReservoir time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_time_limits-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::HydroEnergyReservoir\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet HydroEnergyReservoir time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_active_power!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_active_power_limits!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_available!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_available!","text":"set_available!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_base_power!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_bus!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_bus!","text":"set_bus!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_conversion_factor!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_conversion_factor!","text":"set_conversion_factor!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_ext!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_ext!","text":"set_ext!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_inflow!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_inflow!","text":"set_inflow!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir inflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_initial_storage!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_initial_storage!","text":"set_initial_storage!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir initial_storage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_operation_cost!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_prime_mover_type!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_ramp_limits!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_rating!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_rating!","text":"set_rating!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_reactive_power!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_reactive_power_limits!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_services!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_services!","text":"set_services!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_status!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_status!","text":"set_status!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_storage_capacity!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_storage_capacity!","text":"set_storage_capacity!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_storage_target!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_storage_target!","text":"set_storage_target!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_time_at_status!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_time_at_status!","text":"set_time_at_status!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_time_limits!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_generator/#DynamicGenerator","page":"Dynamic Generator","title":"DynamicGenerator","text":"","category":"section"},{"location":"model_library/dynamic_generator/","page":"Dynamic Generator","title":"Dynamic Generator","text":"Modules = [PowerSystems]\nPages = [\"dynamic_generator.jl\"]\nOrder = [:type, :function]\nPublic = true","category":"page"},{"location":"model_library/dynamic_generator/#PowerSystems.DynamicGenerator","page":"Dynamic Generator","title":"PowerSystems.DynamicGenerator","text":"mutable struct DynamicGenerator{\n M <: Machine,\n S <: Shaft,\n A <: AVR,\n TG <: TurbineGov,\n P <: PSS,\n} <: DynamicInjection\n name::String\n ω_ref::Float64\n machine::M\n shaft::S\n avr::A\n prime_mover::TG\n pss::P\n base_power::Float64\n n_states::Int\n states::Vector{Symbol}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA dynamic generator with the necessary data for modeling the dynamic response of a generator in a phasor or electromagnetic transient simulation.\n\nDynamic generator is composed by 5 components, namely a Machine, a Shaft, an Automatic Voltage Regulator (AVR), a Prime Mover and Turbine Governor, and Power System Stabilizer (PSS). It must be attached to a StaticInjection device using add_component!, which contains all the rest of the generator's data that isn't specific to its dynamic response.\n\nArguments\n\nname::String: Name of generator.\nω_ref::Float64: Frequency reference set-point in pu.\nmachine <: Machine: Machine model for modeling the electro-magnetic phenomena.\nshaft <: Shaft: Shaft model for modeling the electro-mechanical phenomena.\navr <: AVR: AVR model of the excitacion system.\nprime_mover <: TurbineGov: Prime Mover and Turbine Governor model for mechanical power.\npss <: PSS: PSS model.\nbase_power::Float64: (default: 100.0) Base power of the unit (MVA) for per unitization. Although this has a default, in almost all cases base_power should be updated to equal the base_power field of the StaticInjection device that this dynamic generator will be attached to.\nn_states::Int: (Do not modify.) Number of states (will depend on the inputs above).\nstates::Vector{Symbol}: (Do not modify.) Vector of states (will depend on the inputs above).\next::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_RenewableDispatch/#RenewableDispatch","page":"RenewableDispatch","title":"RenewableDispatch","text":"","category":"section"},{"location":"model_library/generated_RenewableDispatch/","page":"RenewableDispatch","title":"RenewableDispatch","text":"Modules = [PowerSystems]\nPages = [\"generated/RenewableDispatch.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.RenewableDispatch","page":"RenewableDispatch","title":"PowerSystems.RenewableDispatch","text":"mutable struct RenewableDispatch <: RenewableGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n reactive_power_limits::Union{Nothing, MinMax}\n power_factor::Float64\n operation_cost::Union{RenewableGenerationCost, MarketBidCost}\n base_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA renewable (e.g., wind or solar) generator whose output can be curtailed to satisfy power system constraints.\n\nThese 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.\n\nRenewable generators do not have a max_active_power parameter, which is instead calculated when calling get_max_active_power()\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), used in some production cost modeling simulations. To set the reactive power in a load flow, use power_factor\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits, used in some production cost model simulations and in power flow if the unit is connected to a PV bus. Set to nothing if not applicable\npower_factor::Float64: Power factor [0, 1] set-point, used in some production cost modeling and in load flow if the unit is connected to a PQ bus, validation range: (0, 1)\noperation_cost::Union{RenewableGenerationCost, MarketBidCost}: OperationalCost of generation\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_RenewableDispatch/#InfrastructureSystems.get_name-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"InfrastructureSystems.get_name","text":"get_name(value::RenewableDispatch) -> String\n\n\nGet RenewableDispatch name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_active_power-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_active_power","text":"get_active_power(value::RenewableDispatch) -> Any\n\n\nGet RenewableDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_available-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_available","text":"get_available(value::RenewableDispatch) -> Bool\n\n\nGet RenewableDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_base_power-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_base_power","text":"get_base_power(value::RenewableDispatch) -> Float64\n\n\nGet RenewableDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_bus-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_bus","text":"get_bus(value::RenewableDispatch) -> ACBus\n\n\nGet RenewableDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_dynamic_injector-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::RenewableDispatch\n) -> Union{Nothing, DynamicInjection}\n\n\nGet RenewableDispatch dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_ext-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_ext","text":"get_ext(value::RenewableDispatch) -> Dict{String, Any}\n\n\nGet RenewableDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_operation_cost-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::RenewableDispatch\n) -> Union{MarketBidCost, RenewableGenerationCost}\n\n\nGet RenewableDispatch operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_power_factor-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_power_factor","text":"get_power_factor(value::RenewableDispatch) -> Float64\n\n\nGet RenewableDispatch power_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_prime_mover_type-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::RenewableDispatch\n) -> PrimeMovers\n\n\nGet RenewableDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_rating-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_rating","text":"get_rating(value::RenewableDispatch) -> Any\n\n\nGet RenewableDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_reactive_power-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::RenewableDispatch) -> Any\n\n\nGet RenewableDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_reactive_power_limits-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::RenewableDispatch\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet RenewableDispatch reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_services-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_services","text":"get_services(value::RenewableDispatch) -> Vector{Service}\n\n\nGet RenewableDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_active_power!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_available!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_available!","text":"set_available!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_base_power!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_bus!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_bus!","text":"set_bus!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_ext!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_ext!","text":"set_ext!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_operation_cost!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_power_factor!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_power_factor!","text":"set_power_factor!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch power_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_prime_mover_type!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_rating!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_rating!","text":"set_rating!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_reactive_power!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_reactive_power_limits!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::RenewableDispatch,\n val\n) -> Any\n\n\nSet RenewableDispatch reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_services!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_services!","text":"set_services!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#TwoTerminalVSCDCLine","page":"TwoTerminalVSCDCLine","title":"TwoTerminalVSCDCLine","text":"","category":"section"},{"location":"model_library/generated_TwoTerminalVSCDCLine/","page":"TwoTerminalVSCDCLine","title":"TwoTerminalVSCDCLine","text":"Modules = [PowerSystems]\nPages = [\"generated/TwoTerminalVSCDCLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.TwoTerminalVSCDCLine","page":"TwoTerminalVSCDCLine","title":"PowerSystems.TwoTerminalVSCDCLine","text":"mutable struct TwoTerminalVSCDCLine <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n arc::Arc\n rectifier_tap_limits::MinMax\n rectifier_xrc::Float64\n rectifier_firing_angle::MinMax\n inverter_tap_limits::MinMax\n inverter_xrc::Float64\n inverter_extinction_angle::MinMax\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA Voltage Sourced Converter (VSC)-HVDC transmission line.\n\nAs implemented in \"Power System Modelling and Scripting\" by Federico Milano, Chapter 18, Page 397. This model is suitable for dynamic simulations\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\narc::Arc: An Arc defining this line from a bus to another bus\nrectifier_tap_limits::MinMax: Minimum and maximum rectifier tap limits as a ratio between the primary and secondary side voltages\nrectifier_xrc::Float64: Rectifier commutation reactance in p.u. (DEVICE_BASE)\nrectifier_firing_angle::MinMax: Minimum and maximum rectifier firing angle (α) (radians)\ninverter_tap_limits::MinMax: Minimum and maximum inverter tap limits as a ratio between the primary and secondary side voltages\ninverter_xrc::Float64: Inverter commutation reactance in p.u. (DEVICE_BASE)\ninverter_extinction_angle::MinMax: Minimum and maximum inverter extinction angle (γ) (radians)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#InfrastructureSystems.get_name-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"InfrastructureSystems.get_name","text":"get_name(value::TwoTerminalVSCDCLine) -> String\n\n\nGet TwoTerminalVSCDCLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_active_power_flow-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::TwoTerminalVSCDCLine) -> Any\n\n\nGet TwoTerminalVSCDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_arc-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_arc","text":"get_arc(value::TwoTerminalVSCDCLine) -> Arc\n\n\nGet TwoTerminalVSCDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_available-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_available","text":"get_available(value::TwoTerminalVSCDCLine) -> Bool\n\n\nGet TwoTerminalVSCDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_ext-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_ext","text":"get_ext(value::TwoTerminalVSCDCLine) -> Dict{String, Any}\n\n\nGet TwoTerminalVSCDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_inverter_extinction_angle-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_inverter_extinction_angle","text":"get_inverter_extinction_angle(\n value::TwoTerminalVSCDCLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalVSCDCLine inverter_extinction_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_inverter_tap_limits-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_inverter_tap_limits","text":"get_inverter_tap_limits(\n value::TwoTerminalVSCDCLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalVSCDCLine inverter_tap_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_inverter_xrc-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_inverter_xrc","text":"get_inverter_xrc(value::TwoTerminalVSCDCLine) -> Float64\n\n\nGet TwoTerminalVSCDCLine inverter_xrc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_rectifier_firing_angle-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_rectifier_firing_angle","text":"get_rectifier_firing_angle(\n value::TwoTerminalVSCDCLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalVSCDCLine rectifier_firing_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_rectifier_tap_limits-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_rectifier_tap_limits","text":"get_rectifier_tap_limits(\n value::TwoTerminalVSCDCLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalVSCDCLine rectifier_tap_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_rectifier_xrc-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_rectifier_xrc","text":"get_rectifier_xrc(value::TwoTerminalVSCDCLine) -> Float64\n\n\nGet TwoTerminalVSCDCLine rectifier_xrc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_services-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_services","text":"get_services(value::TwoTerminalVSCDCLine) -> Vector{Service}\n\n\nGet TwoTerminalVSCDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_active_power_flow!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_arc!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_available!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_available!","text":"set_available!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_ext!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_inverter_extinction_angle!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_inverter_extinction_angle!","text":"set_inverter_extinction_angle!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine inverter_extinction_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_inverter_tap_limits!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_inverter_tap_limits!","text":"set_inverter_tap_limits!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine inverter_tap_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_inverter_xrc!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_inverter_xrc!","text":"set_inverter_xrc!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine inverter_xrc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_rectifier_firing_angle!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_rectifier_firing_angle!","text":"set_rectifier_firing_angle!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine rectifier_firing_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_rectifier_tap_limits!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_rectifier_tap_limits!","text":"set_rectifier_tap_limits!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine rectifier_tap_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_rectifier_xrc!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_rectifier_xrc!","text":"set_rectifier_xrc!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine rectifier_xrc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_services!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_services!","text":"set_services!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#Source","page":"Source","title":"Source","text":"","category":"section"},{"location":"model_library/generated_Source/","page":"Source","title":"Source","text":"Modules = [PowerSystems]\nPages = [\"generated/Source.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Source/#PowerSystems.Source","page":"Source","title":"PowerSystems.Source","text":"mutable struct Source <: StaticInjection\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n R_th::Float64\n X_th::Float64\n internal_voltage::Float64\n internal_angle::Float64\n base_power::Float64\n dynamic_injector::Union{Nothing, DynamicInjection}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn infinite bus with a constant voltage output.\n\nCommonly used in dynamics simulations to represent a very large machine on a single bus\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR)\nR_th::Float64: Source Thevenin resistance, validation range: (0, nothing)\nX_th::Float64: Source Thevenin reactance, validation range: (0, nothing)\ninternal_voltage::Float64: (default: 1.0) Internal Voltage (pu), validation range: (0, nothing)\ninternal_angle::Float64: (default: 0.0) Internal Angle\nbase_power::Float64: (default: 100.0) Base Power in MVA\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Source/#InfrastructureSystems.get_name-Tuple{Source}","page":"Source","title":"InfrastructureSystems.get_name","text":"get_name(value::Source) -> String\n\n\nGet Source name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_R_th-Tuple{Source}","page":"Source","title":"PowerSystems.get_R_th","text":"get_R_th(value::Source) -> Float64\n\n\nGet Source R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_X_th-Tuple{Source}","page":"Source","title":"PowerSystems.get_X_th","text":"get_X_th(value::Source) -> Float64\n\n\nGet Source X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_active_power-Tuple{Source}","page":"Source","title":"PowerSystems.get_active_power","text":"get_active_power(value::Source) -> Float64\n\n\nGet Source active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_available-Tuple{Source}","page":"Source","title":"PowerSystems.get_available","text":"get_available(value::Source) -> Bool\n\n\nGet Source available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_base_power-Tuple{Source}","page":"Source","title":"PowerSystems.get_base_power","text":"get_base_power(value::Source) -> Float64\n\n\nGet Source base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_bus-Tuple{Source}","page":"Source","title":"PowerSystems.get_bus","text":"get_bus(value::Source) -> ACBus\n\n\nGet Source bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_dynamic_injector-Tuple{Source}","page":"Source","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::Source\n) -> Union{Nothing, DynamicInjection}\n\n\nGet Source dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_ext-Tuple{Source}","page":"Source","title":"PowerSystems.get_ext","text":"get_ext(value::Source) -> Dict{String, Any}\n\n\nGet Source ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_internal_angle-Tuple{Source}","page":"Source","title":"PowerSystems.get_internal_angle","text":"get_internal_angle(value::Source) -> Float64\n\n\nGet Source internal_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_internal_voltage-Tuple{Source}","page":"Source","title":"PowerSystems.get_internal_voltage","text":"get_internal_voltage(value::Source) -> Float64\n\n\nGet Source internal_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_reactive_power-Tuple{Source}","page":"Source","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::Source) -> Float64\n\n\nGet Source reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_services-Tuple{Source}","page":"Source","title":"PowerSystems.get_services","text":"get_services(value::Source) -> Vector{Service}\n\n\nGet Source services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_R_th!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_R_th!","text":"set_R_th!(value::Source, val) -> Any\n\n\nSet Source R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_X_th!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_X_th!","text":"set_X_th!(value::Source, val) -> Any\n\n\nSet Source X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_active_power!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::Source, val) -> Any\n\n\nSet Source active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_available!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_available!","text":"set_available!(value::Source, val) -> Any\n\n\nSet Source available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_base_power!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::Source, val) -> Any\n\n\nSet Source base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_bus!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_bus!","text":"set_bus!(value::Source, val) -> Any\n\n\nSet Source bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_ext!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_ext!","text":"set_ext!(value::Source, val) -> Any\n\n\nSet Source ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_internal_angle!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_internal_angle!","text":"set_internal_angle!(value::Source, val) -> Any\n\n\nSet Source internal_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_internal_voltage!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_internal_voltage!","text":"set_internal_voltage!(value::Source, val) -> Any\n\n\nSet Source internal_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_reactive_power!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::Source, val) -> Any\n\n\nSet Source reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_services!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_services!","text":"set_services!(value::Source, val) -> Any\n\n\nSet Source services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#FixedAdmittance","page":"FixedAdmittance","title":"FixedAdmittance","text":"","category":"section"},{"location":"model_library/generated_FixedAdmittance/","page":"FixedAdmittance","title":"FixedAdmittance","text":"Modules = [PowerSystems]\nPages = [\"generated/FixedAdmittance.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.FixedAdmittance","page":"FixedAdmittance","title":"PowerSystems.FixedAdmittance","text":"mutable struct FixedAdmittance <: ElectricLoad\n name::String\n available::Bool\n bus::ACBus\n Y::Complex{Float64}\n dynamic_injector::Union{Nothing, DynamicInjection}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA fixed admittance.\n\nMost often used in dynamics or AC power flow studies as a source of reactive power\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nY::Complex{Float64}: Fixed admittance in p.u. (SYSTEM_BASE)\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection model for admittance\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_FixedAdmittance/#InfrastructureSystems.get_name-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"InfrastructureSystems.get_name","text":"get_name(value::FixedAdmittance) -> String\n\n\nGet FixedAdmittance name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_Y-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_Y","text":"get_Y(value::FixedAdmittance) -> ComplexF64\n\n\nGet FixedAdmittance Y.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_available-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_available","text":"get_available(value::FixedAdmittance) -> Bool\n\n\nGet FixedAdmittance available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_bus-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_bus","text":"get_bus(value::FixedAdmittance) -> ACBus\n\n\nGet FixedAdmittance bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_dynamic_injector-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::FixedAdmittance\n) -> Union{Nothing, DynamicInjection}\n\n\nGet FixedAdmittance dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_ext-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_ext","text":"get_ext(value::FixedAdmittance) -> Dict{String, Any}\n\n\nGet FixedAdmittance ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_services-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_services","text":"get_services(value::FixedAdmittance) -> Vector{Service}\n\n\nGet FixedAdmittance services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_Y!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_Y!","text":"set_Y!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance Y.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_available!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_available!","text":"set_available!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_bus!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_bus!","text":"set_bus!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_ext!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_ext!","text":"set_ext!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_services!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_services!","text":"set_services!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#InterconnectingConverter","page":"InterconnectingConverter","title":"InterconnectingConverter","text":"","category":"section"},{"location":"model_library/generated_InterconnectingConverter/","page":"InterconnectingConverter","title":"InterconnectingConverter","text":"Modules = [PowerSystems]\nPages = [\"generated/InterconnectingConverter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.InterconnectingConverter","page":"InterconnectingConverter","title":"PowerSystems.InterconnectingConverter","text":"mutable struct InterconnectingConverter <: StaticInjection\n name::String\n available::Bool\n bus::ACBus\n dc_bus::DCBus\n active_power::Float64\n rating::Float64\n active_power_limits::MinMax\n base_power::Float64\n dc_current::Float64\n max_dc_current::Float64\n loss_function::Union{LinearCurve, QuadraticCurve}\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nInterconnecting Power Converter (IPC) for transforming power from an ACBus to a DCBus\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus on the AC side of this converter\ndc_bus::DCBus: Bus on the DC side of this converter\nactive_power::Float64: Active power (MW) on the DC side, validation range: active_power_limits\nrating::Float64: Maximum output power rating of the converter (MVA), validation range: (0, nothing)\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW)\nbase_power::Float64: Base power of the converter in MVA, validation range: (0, nothing)\ndc_current::Float64: (default: 0.0) DC current (A) on the converter\nmax_dc_current::Float64: (default: 1e8) Maximum stable dc current limits (A)\nloss_function::Union{LinearCurve, QuadraticCurve}: (default: LinearCurve(0.0)) Linear or quadratic loss function with respect to the converter current\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InterconnectingConverter/#InfrastructureSystems.get_name-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"InfrastructureSystems.get_name","text":"get_name(value::InterconnectingConverter) -> String\n\n\nGet InterconnectingConverter name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_active_power-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_active_power","text":"get_active_power(value::InterconnectingConverter) -> Any\n\n\nGet InterconnectingConverter active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_active_power_limits-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::InterconnectingConverter\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet InterconnectingConverter active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_available-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_available","text":"get_available(value::InterconnectingConverter) -> Bool\n\n\nGet InterconnectingConverter available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_base_power-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_base_power","text":"get_base_power(value::InterconnectingConverter) -> Float64\n\n\nGet InterconnectingConverter base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_bus-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_bus","text":"get_bus(value::InterconnectingConverter) -> ACBus\n\n\nGet InterconnectingConverter bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_dc_bus-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_dc_bus","text":"get_dc_bus(value::InterconnectingConverter) -> DCBus\n\n\nGet InterconnectingConverter dc_bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_dc_current-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_dc_current","text":"get_dc_current(value::InterconnectingConverter) -> Float64\n\n\nGet InterconnectingConverter dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_dynamic_injector-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::InterconnectingConverter\n) -> Union{Nothing, DynamicInjection}\n\n\nGet InterconnectingConverter dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_ext-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_ext","text":"get_ext(\n value::InterconnectingConverter\n) -> Dict{String, Any}\n\n\nGet InterconnectingConverter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_loss_function-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_loss_function","text":"get_loss_function(\n value::InterconnectingConverter\n) -> Union{LinearCurve, QuadraticCurve}\n\n\nGet InterconnectingConverter loss_function.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_max_dc_current-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_max_dc_current","text":"get_max_dc_current(\n value::InterconnectingConverter\n) -> Float64\n\n\nGet InterconnectingConverter max_dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_rating-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_rating","text":"get_rating(value::InterconnectingConverter) -> Any\n\n\nGet InterconnectingConverter rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_services-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_services","text":"get_services(\n value::InterconnectingConverter\n) -> Vector{Service}\n\n\nGet InterconnectingConverter services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_active_power!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_active_power!","text":"set_active_power!(\n value::InterconnectingConverter,\n val\n) -> Any\n\n\nSet InterconnectingConverter active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_active_power_limits!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::InterconnectingConverter,\n val\n) -> Any\n\n\nSet InterconnectingConverter active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_available!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_available!","text":"set_available!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_base_power!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_bus!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_bus!","text":"set_bus!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_dc_bus!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_dc_bus!","text":"set_dc_bus!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter dc_bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_dc_current!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_dc_current!","text":"set_dc_current!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_ext!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_ext!","text":"set_ext!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_loss_function!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_loss_function!","text":"set_loss_function!(\n value::InterconnectingConverter,\n val\n) -> Any\n\n\nSet InterconnectingConverter loss_function.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_max_dc_current!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_max_dc_current!","text":"set_max_dc_current!(\n value::InterconnectingConverter,\n val\n) -> Any\n\n\nSet InterconnectingConverter max_dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_rating!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_rating!","text":"set_rating!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_services!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_services!","text":"set_services!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#TModelHVDCLine","page":"TModelHVDCLine","title":"TModelHVDCLine","text":"","category":"section"},{"location":"model_library/generated_TModelHVDCLine/","page":"TModelHVDCLine","title":"TModelHVDCLine","text":"Modules = [PowerSystems]\nPages = [\"generated/TModelHVDCLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.TModelHVDCLine","page":"TModelHVDCLine","title":"PowerSystems.TModelHVDCLine","text":"mutable struct TModelHVDCLine <: DCBranch\n name::String\n available::Bool\n active_power_flow::Float64\n arc::Arc\n r::Float64\n l::Float64\n c::Float64\n active_power_limits_from::MinMax\n active_power_limits_to::MinMax\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA High Voltage DC transmission line for modeling DC transmission networks.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\narc::Arc: An Arc defining this line from a bus to another bus\nr::Float64: Total series Resistance in p.u. (SYSTEM_BASE), split equally on both sides of the shunt capacitance\nl::Float64: Total series Inductance in p.u. (SYSTEM_BASE), split equally on both sides of the shunt capacitance\nc::Float64: Shunt capacitance in p.u. (SYSTEM_BASE)\nactive_power_limits_from::MinMax: Minimum and maximum active power flows to the FROM node (MW)\nactive_power_limits_to::MinMax: Minimum and maximum active power flows to the TO node (MW)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TModelHVDCLine/#InfrastructureSystems.get_name-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"InfrastructureSystems.get_name","text":"get_name(value::TModelHVDCLine) -> String\n\n\nGet TModelHVDCLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_active_power_flow-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::TModelHVDCLine) -> Any\n\n\nGet TModelHVDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_active_power_limits_from-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_active_power_limits_from","text":"get_active_power_limits_from(\n value::TModelHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TModelHVDCLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_active_power_limits_to-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_active_power_limits_to","text":"get_active_power_limits_to(\n value::TModelHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TModelHVDCLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_arc-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_arc","text":"get_arc(value::TModelHVDCLine) -> Arc\n\n\nGet TModelHVDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_available-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_available","text":"get_available(value::TModelHVDCLine) -> Bool\n\n\nGet TModelHVDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_c-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_c","text":"get_c(value::TModelHVDCLine) -> Float64\n\n\nGet TModelHVDCLine c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_ext-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_ext","text":"get_ext(value::TModelHVDCLine) -> Dict{String, Any}\n\n\nGet TModelHVDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_l-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_l","text":"get_l(value::TModelHVDCLine) -> Float64\n\n\nGet TModelHVDCLine l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_r-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_r","text":"get_r(value::TModelHVDCLine) -> Float64\n\n\nGet TModelHVDCLine r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_services-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_services","text":"get_services(value::TModelHVDCLine) -> Vector{Service}\n\n\nGet TModelHVDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_active_power_flow!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_active_power_limits_from!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_active_power_limits_from!","text":"set_active_power_limits_from!(\n value::TModelHVDCLine,\n val\n) -> Any\n\n\nSet TModelHVDCLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_active_power_limits_to!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_active_power_limits_to!","text":"set_active_power_limits_to!(\n value::TModelHVDCLine,\n val\n) -> Any\n\n\nSet TModelHVDCLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_arc!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_available!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_available!","text":"set_available!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_c!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_c!","text":"set_c!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_ext!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_l!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_l!","text":"set_l!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_r!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_r!","text":"set_r!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_services!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_services!","text":"set_services!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#GenericDER","page":"GenericDER","title":"GenericDER","text":"","category":"section"},{"location":"model_library/generated_GenericDER/","page":"GenericDER","title":"GenericDER","text":"Modules = [PowerSystems]\nPages = [\"generated/GenericDER.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_GenericDER/#PowerSystems.GenericDER","page":"GenericDER","title":"PowerSystems.GenericDER","text":"mutable struct GenericDER <: DynamicInjection\n name::String\n Qref_Flag::Int\n PQ_Flag::Int\n Gen_Flag::Int\n PerOp_Flag::Int\n Recon_Flag::Int\n Trv::Float64\n VV_pnts::NamedTuple{(:V1, :V2, :V3, :V4), Tuple{Float64, Float64, Float64, Float64}}\n Q_lim::MinMax\n Tp::Float64\n e_lim::MinMax\n Kpq::Float64\n Kiq::Float64\n Iqr_lim::MinMax\n I_max::Float64\n Tg::Float64\n kWh_Cap::Float64\n SOC_ini::Float64\n SOC_lim::MinMax\n Trf::Float64\n fdbd_pnts::NamedTuple{(:fdbd1, :fdbd2), Tuple{Float64, Float64}}\n D_dn::Float64\n D_up::Float64\n fe_lim::MinMax\n Kpp::Float64\n Kip::Float64\n P_lim::MinMax\n dP_lim::MinMax\n T_pord::Float64\n rrpwr::Float64\n VRT_pnts::NamedTuple{(:vrt1, :vrt2, :vrt3, :vrt4, :vrt5), Tuple{Float64, Float64, Float64, Float64, Float64}}\n TVRT_pnts::NamedTuple{(:tvrt1, :tvrt2, :tvrt3), Tuple{Float64, Float64, Float64}}\n tV_delay::Float64\n VES_lim::MinMax\n FRT_pnts::NamedTuple{(:frt1, :frt2, :frt3, :frt4), Tuple{Float64, Float64, Float64, Float64}}\n TFRT_pnts::NamedTuple{(:tfrt1, :tfrt2), Tuple{Float64, Float64}}\n tF_delay::Float64\n FES_lim::MinMax\n Pfa_ref::Float64\n Q_ref::Float64\n P_ref::Float64\n base_power::Float64\n states::Vector{Symbol}\n n_states::Int\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Generic Distributed Energy Resource Model. Based on \"Modeling Framework and Coordination of DER and Flexible Loads for Ancillary Service Provision.\"\n\nArguments\n\nname::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\nQref_Flag::Int: Reactive Power Control Mode. 1 VoltVar Control, 2 Constant Q Control, 3 Constant PF Control, validation range: (1, 3)\nPQ_Flag::Int: Active and reactive power priority mode. 0 for Q priority, 1 for P priority, validation range: (0, 1)\nGen_Flag::Int: Define generator or storage system. 0 unit is a storage device, 1 unit is a generator, validation range: (0, 1)\nPerOp_Flag::Int: Defines operation of permisible region in VRT characteristic. 0 for cease, 1 for continuous operation, validation range: (0, 1)\nRecon_Flag::Int: Defines if DER can reconnect after voltage ride-through disconnection, validation range: (0, 1)\nTrv::Float64: Voltage measurement transducer's time constant, in s, validation range: (0, nothing)\nVV_pnts::NamedTuple{(:V1, :V2, :V3, :V4), Tuple{Float64, Float64, Float64, Float64}}: Y-axis Volt-var curve points (V1,V2,V3,V4)\nQ_lim::MinMax: Reactive power limits in pu (Qmin, Qmax)\nTp::Float64: Power measurement transducer's time constant, in s, validation range: (0, nothing)\ne_lim::MinMax: Error limit in PI controller for q control (emin, emax)\nKpq::Float64: PI controller proportional gain for q control, validation range: (0, nothing)\nKiq::Float64: PI controller integral gain for q control, validation range: (0, nothing)\nIqr_lim::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)\nI_max::Float64: Max. inverter's current, validation range: (0, nothing)\nTg::Float64: Current control's time constant, in s, validation range: (0, nothing)\nkWh_Cap::Float64: BESS capacity in kWh, validation range: (0, nothing)\nSOC_ini::Float64: Initial state of charge (SOC) in pu, validation range: (0, 1)\nSOC_lim::MinMax: Battery's SOC limits (SOCmin, SOCmax)\nTrf::Float64: Time constant to estimate system frequency, in s, validation range: (0, nothing)\nfdbd_pnts::NamedTuple{(:fdbd1, :fdbd2), Tuple{Float64, Float64}}: Frequency error dead band thresholds (fdbd1, fdbd2)\nD_dn::Float64: reciprocal of droop for over-frequency conditions, in pu, validation range: (0, nothing)\nD_up::Float64: reciprocal of droop for under-frequency conditions, in pu, validation range: (0, nothing)\nfe_lim::MinMax: Frequency error limits in pu (femin, femax)\nKpp::Float64: PI controller proportional gain for p control, validation range: (0, nothing)\nKip::Float64: PI controller integral gain for p control, validation range: (0, nothing)\nP_lim::MinMax: Active power limits in pu (Pmin, Pmax)\ndP_lim::MinMax: Ramp rate limits for active power in pu/s (dPmin, dPmax)\nT_pord::Float64: Power filter time constant in s, validation range: (0, nothing)\nrrpwr::Float64: Ramp rate for real power increase following a fault, in pu/s, validation range: (0, nothing)\nVRT_pnts::NamedTuple{(:vrt1, :vrt2, :vrt3, :vrt4, :vrt5), Tuple{Float64, Float64, Float64, Float64, Float64}}: Voltage ride through v points (vrt1,vrt2,vrt3,vrt4,vrt5)\nTVRT_pnts::NamedTuple{(:tvrt1, :tvrt2, :tvrt3), Tuple{Float64, Float64, Float64}}: Voltage ride through time points (tvrt1,tvrt2,tvrt3)\ntV_delay::Float64: Time delay for reconnection after voltage ride-through disconnection, validation range: (0, nothing)\nVES_lim::MinMax: Min and max voltage for entering service (VESmin,VESmax)\nFRT_pnts::NamedTuple{(:frt1, :frt2, :frt3, :frt4), Tuple{Float64, Float64, Float64, Float64}}: Frequency ride through v points (frt1,frt2,frt3,frt4)\nTFRT_pnts::NamedTuple{(:tfrt1, :tfrt2), Tuple{Float64, Float64}}: Frequency ride through time points (tfrt1,tfrt2)\ntF_delay::Float64: Time delay for reconnection after frequency ride-through disconnection, validation range: (0, nothing)\nFES_lim::MinMax: Min and max frequency for entering service (FESmin,FESmax)\nPfa_ref::Float64: (default: 0.0) Reference power factor, validation range: (0, nothing)\nQ_ref::Float64: (default: 0.0) Reference reactive power, in pu, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference active power, in pu, validation range: (0, nothing)\nbase_power::Float64: (default: 100.0) Base power of the unit (MVA) for per unitization\nstates::Vector{Symbol}: (Do not modify.) The states of GenericDER depend on the Flags\nn_states::Int: (Do not modify.) The states of GenericDER depend on the Flags\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_GenericDER/#InfrastructureSystems.get_name-Tuple{GenericDER}","page":"GenericDER","title":"InfrastructureSystems.get_name","text":"get_name(value::GenericDER) -> String\n\n\nGet GenericDER name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_D_dn-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_D_dn","text":"get_D_dn(value::GenericDER) -> Float64\n\n\nGet GenericDER D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_D_up-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_D_up","text":"get_D_up(value::GenericDER) -> Float64\n\n\nGet GenericDER D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_FES_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_FES_lim","text":"get_FES_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER FES_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_FRT_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_FRT_pnts","text":"get_FRT_pnts(\n value::GenericDER\n) -> @NamedTuple{frt1::Float64, frt2::Float64, frt3::Float64, frt4::Float64}\n\n\nGet GenericDER FRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Gen_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Gen_Flag","text":"get_Gen_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER Gen_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_I_max-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_I_max","text":"get_I_max(value::GenericDER) -> Float64\n\n\nGet GenericDER I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Iqr_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Iqr_lim","text":"get_Iqr_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER Iqr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Kip-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Kip","text":"get_Kip(value::GenericDER) -> Float64\n\n\nGet GenericDER Kip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Kiq-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Kiq","text":"get_Kiq(value::GenericDER) -> Float64\n\n\nGet GenericDER Kiq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Kpp-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Kpp","text":"get_Kpp(value::GenericDER) -> Float64\n\n\nGet GenericDER Kpp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Kpq-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Kpq","text":"get_Kpq(value::GenericDER) -> Float64\n\n\nGet GenericDER Kpq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_PQ_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_PQ_Flag","text":"get_PQ_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_P_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_P_lim","text":"get_P_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_P_ref-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::GenericDER) -> Float64\n\n\nGet GenericDER P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_PerOp_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_PerOp_Flag","text":"get_PerOp_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER PerOp_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Pfa_ref-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Pfa_ref","text":"get_Pfa_ref(value::GenericDER) -> Float64\n\n\nGet GenericDER Pfa_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Q_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Q_lim","text":"get_Q_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER Q_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Q_ref-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::GenericDER) -> Float64\n\n\nGet GenericDER Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Qref_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Qref_Flag","text":"get_Qref_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER Qref_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Recon_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Recon_Flag","text":"get_Recon_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER Recon_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_SOC_ini-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_SOC_ini","text":"get_SOC_ini(value::GenericDER) -> Float64\n\n\nGet GenericDER SOC_ini.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_SOC_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_SOC_lim","text":"get_SOC_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER SOC_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_TFRT_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_TFRT_pnts","text":"get_TFRT_pnts(\n value::GenericDER\n) -> @NamedTuple{tfrt1::Float64, tfrt2::Float64}\n\n\nGet GenericDER TFRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_TVRT_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_TVRT_pnts","text":"get_TVRT_pnts(\n value::GenericDER\n) -> @NamedTuple{tvrt1::Float64, tvrt2::Float64, tvrt3::Float64}\n\n\nGet GenericDER TVRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_T_pord-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_T_pord","text":"get_T_pord(value::GenericDER) -> Float64\n\n\nGet GenericDER T_pord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Tg-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Tg","text":"get_Tg(value::GenericDER) -> Float64\n\n\nGet GenericDER Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Tp-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Tp","text":"get_Tp(value::GenericDER) -> Float64\n\n\nGet GenericDER Tp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Trf-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Trf","text":"get_Trf(value::GenericDER) -> Float64\n\n\nGet GenericDER Trf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Trv-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Trv","text":"get_Trv(value::GenericDER) -> Float64\n\n\nGet GenericDER Trv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_VES_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_VES_lim","text":"get_VES_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER VES_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_VRT_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_VRT_pnts","text":"get_VRT_pnts(\n value::GenericDER\n) -> @NamedTuple{vrt1::Float64, vrt2::Float64, vrt3::Float64, vrt4::Float64, vrt5::Float64}\n\n\nGet GenericDER VRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_VV_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_VV_pnts","text":"get_VV_pnts(\n value::GenericDER\n) -> @NamedTuple{V1::Float64, V2::Float64, V3::Float64, V4::Float64}\n\n\nGet GenericDER VV_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_base_power-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_base_power","text":"get_base_power(value::GenericDER) -> Float64\n\n\nGet GenericDER base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_dP_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_dP_lim","text":"get_dP_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_e_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_e_lim","text":"get_e_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER e_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_ext-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_ext","text":"get_ext(value::GenericDER) -> Dict{String, Any}\n\n\nGet GenericDER ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_fdbd_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_fdbd_pnts","text":"get_fdbd_pnts(\n value::GenericDER\n) -> @NamedTuple{fdbd1::Float64, fdbd2::Float64}\n\n\nGet GenericDER fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_fe_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_fe_lim","text":"get_fe_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_kWh_Cap-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_kWh_Cap","text":"get_kWh_Cap(value::GenericDER) -> Float64\n\n\nGet GenericDER kWh_Cap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_n_states-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_n_states","text":"get_n_states(value::GenericDER) -> Int64\n\n\nGet GenericDER n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_rrpwr-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_rrpwr","text":"get_rrpwr(value::GenericDER) -> Float64\n\n\nGet GenericDER rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_states-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_states","text":"get_states(value::GenericDER) -> Vector{Symbol}\n\n\nGet GenericDER states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_tF_delay-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_tF_delay","text":"get_tF_delay(value::GenericDER) -> Float64\n\n\nGet GenericDER tF_delay.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_tV_delay-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_tV_delay","text":"get_tV_delay(value::GenericDER) -> Float64\n\n\nGet GenericDER tV_delay.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_D_dn!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_D_dn!","text":"set_D_dn!(value::GenericDER, val) -> Any\n\n\nSet GenericDER D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_D_up!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_D_up!","text":"set_D_up!(value::GenericDER, val) -> Any\n\n\nSet GenericDER D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_FES_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_FES_lim!","text":"set_FES_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER FES_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_FRT_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_FRT_pnts!","text":"set_FRT_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER FRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Gen_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Gen_Flag!","text":"set_Gen_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Gen_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_I_max!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::GenericDER, val) -> Any\n\n\nSet GenericDER I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Iqr_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Iqr_lim!","text":"set_Iqr_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Iqr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Kip!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Kip!","text":"set_Kip!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Kip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Kiq!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Kiq!","text":"set_Kiq!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Kiq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Kpp!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Kpp!","text":"set_Kpp!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Kpp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Kpq!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Kpq!","text":"set_Kpq!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Kpq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_PQ_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_PQ_Flag!","text":"set_PQ_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_P_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_P_lim!","text":"set_P_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_P_ref!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::GenericDER, val) -> Any\n\n\nSet GenericDER P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_PerOp_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_PerOp_Flag!","text":"set_PerOp_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER PerOp_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Pfa_ref!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Pfa_ref!","text":"set_Pfa_ref!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Pfa_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Q_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Q_lim!","text":"set_Q_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Q_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Q_ref!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Qref_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Qref_Flag!","text":"set_Qref_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Qref_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Recon_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Recon_Flag!","text":"set_Recon_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Recon_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_SOC_ini!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_SOC_ini!","text":"set_SOC_ini!(value::GenericDER, val) -> Any\n\n\nSet GenericDER SOC_ini.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_SOC_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_SOC_lim!","text":"set_SOC_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER SOC_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_TFRT_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_TFRT_pnts!","text":"set_TFRT_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER TFRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_TVRT_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_TVRT_pnts!","text":"set_TVRT_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER TVRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_T_pord!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_T_pord!","text":"set_T_pord!(value::GenericDER, val) -> Any\n\n\nSet GenericDER T_pord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Tg!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Tg!","text":"set_Tg!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Tp!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Tp!","text":"set_Tp!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Tp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Trf!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Trf!","text":"set_Trf!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Trf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Trv!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Trv!","text":"set_Trv!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Trv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_VES_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_VES_lim!","text":"set_VES_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER VES_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_VRT_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_VRT_pnts!","text":"set_VRT_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER VRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_VV_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_VV_pnts!","text":"set_VV_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER VV_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_base_power!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::GenericDER, val) -> Any\n\n\nSet GenericDER base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_dP_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_dP_lim!","text":"set_dP_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_e_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_e_lim!","text":"set_e_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER e_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_ext!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_ext!","text":"set_ext!(value::GenericDER, val) -> Any\n\n\nSet GenericDER ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_fdbd_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_fdbd_pnts!","text":"set_fdbd_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_fe_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_fe_lim!","text":"set_fe_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_kWh_Cap!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_kWh_Cap!","text":"set_kWh_Cap!(value::GenericDER, val) -> Any\n\n\nSet GenericDER kWh_Cap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_rrpwr!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_rrpwr!","text":"set_rrpwr!(value::GenericDER, val) -> Any\n\n\nSet GenericDER rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_tF_delay!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_tF_delay!","text":"set_tF_delay!(value::GenericDER, val) -> Any\n\n\nSet GenericDER tF_delay.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_tV_delay!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_tV_delay!","text":"set_tV_delay!(value::GenericDER, val) -> Any\n\n\nSet GenericDER tV_delay.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#AVR","page":"AVR","title":"AVR","text":"","category":"section"},{"location":"model_library/generated_AVR/#AVRFixed","page":"AVR","title":"AVRFixed","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/AVRFixed.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.AVRFixed","page":"AVR","title":"PowerSystems.AVRFixed","text":"mutable struct AVRFixed <: AVR\n Vf::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a AVR that returns a fixed voltage to the rotor winding\n\nArguments\n\nVf::Float64: Fixed voltage field applied to the rotor winding in pu (DEVICE_BASE), validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) Fixed AVR has no states\nn_states::Int: (Do not modify.) Fixed AVR has no states\nstates_types::Vector{StateTypes}: (Do not modify.) Fixed AVR has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AVRFixed) -> Float64\n\n\nGet AVRFixed V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vf-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_Vf","text":"get_Vf(value::AVRFixed) -> Float64\n\n\nGet AVRFixed Vf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::AVRFixed) -> Dict{String, Any}\n\n\nGet AVRFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::AVRFixed) -> Int64\n\n\nGet AVRFixed n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::AVRFixed) -> Vector{Symbol}\n\n\nGet AVRFixed states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::AVRFixed) -> Vector{StateTypes}\n\n\nGet AVRFixed states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{AVRFixed, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::AVRFixed, val) -> Any\n\n\nSet AVRFixed V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vf!-Tuple{AVRFixed, Any}","page":"AVR","title":"PowerSystems.set_Vf!","text":"set_Vf!(value::AVRFixed, val) -> Any\n\n\nSet AVRFixed Vf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{AVRFixed, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::AVRFixed, val) -> Any\n\n\nSet AVRFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{AVRFixed, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::AVRFixed, val) -> Any\n\n\nSet AVRFixed states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#AVRSimple","page":"AVR","title":"AVRSimple","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/AVRSimple.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.AVRSimple","page":"AVR","title":"PowerSystems.AVRSimple","text":"mutable struct AVRSimple <: AVR\n Kv::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a simple proportional AVR in the derivative of EMF i.e. an integrator controller on EMF\n\nArguments\n\nKv::Float64: Proportional Gain, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVf: field voltage\n\nn_states::Int: (Do not modify.) Fixed AVR has 1 state\nstates_types::Vector{StateTypes}: (Do not modify.) Simple AVR has 1 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kv-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_Kv","text":"get_Kv(value::AVRSimple) -> Float64\n\n\nGet AVRSimple Kv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AVRSimple) -> Float64\n\n\nGet AVRSimple V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::AVRSimple) -> Dict{String, Any}\n\n\nGet AVRSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::AVRSimple) -> Int64\n\n\nGet AVRSimple n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::AVRSimple) -> Vector{Symbol}\n\n\nGet AVRSimple states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::AVRSimple) -> Vector{StateTypes}\n\n\nGet AVRSimple states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kv!-Tuple{AVRSimple, Any}","page":"AVR","title":"PowerSystems.set_Kv!","text":"set_Kv!(value::AVRSimple, val) -> Any\n\n\nSet AVRSimple Kv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{AVRSimple, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::AVRSimple, val) -> Any\n\n\nSet AVRSimple V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{AVRSimple, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::AVRSimple, val) -> Any\n\n\nSet AVRSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{AVRSimple, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::AVRSimple, val) -> Any\n\n\nSet AVRSimple states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#AVRTypeI","page":"AVR","title":"AVRTypeI","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/AVRTypeI.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.AVRTypeI","page":"AVR","title":"PowerSystems.AVRTypeI","text":"mutable struct AVRTypeI <: AVR\n Ka::Float64\n Ke::Float64\n Kf::Float64\n Ta::Float64\n Te::Float64\n Tf::Float64\n Tr::Float64\n Va_lim::MinMax\n Ae::Float64\n Be::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of an Automatic Voltage Regulator Type I - Resembles IEEE Type DC1\n\nArguments\n\nKa::Float64: Amplifier Gain, validation range: (0, nothing)\nKe::Float64: Field circuit integral deviation, validation range: (0, nothing)\nKf::Float64: Stabilizer Gain in s * pu/pu, validation range: (0, nothing)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, nothing)\nTe::Float64: Field Circuit Time Constant in s, validation range: (0, nothing)\nTf::Float64: Stabilizer Time Constant in s, validation range: (0, nothing)\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)\nVa_lim::MinMax: Limits for pi controler (Va_min, Va_max)\nAe::Float64: 1st ceiling coefficient, validation range: (0, nothing)\nBe::Float64: 2nd ceiling coefficient, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVf: Voltage field,\nVr1: Amplifier State,\nVr2: Stabilizing Feedback State,\nVm: Measured voltage\n\nn_states::Int: (Do not modify.) The AVR Type I has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) AVR Type I has 4 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ae-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Ae","text":"get_Ae(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Ae.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Be-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Be","text":"get_Be(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Be.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::AVRTypeI\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AVRTypeI Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::AVRTypeI) -> Dict{String, Any}\n\n\nGet AVRTypeI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::AVRTypeI) -> Int64\n\n\nGet AVRTypeI n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::AVRTypeI) -> Vector{Symbol}\n\n\nGet AVRTypeI states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::AVRTypeI) -> Vector{StateTypes}\n\n\nGet AVRTypeI states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ae!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Ae!","text":"set_Ae!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Ae.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Be!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Be!","text":"set_Be!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Be.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#AVRTypeII","page":"AVR","title":"AVRTypeII","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/AVRTypeII.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.AVRTypeII","page":"AVR","title":"PowerSystems.AVRTypeII","text":"mutable struct AVRTypeII <: AVR\n K0::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n Te::Float64\n Tr::Float64\n Va_lim::MinMax\n Ae::Float64\n Be::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of an Automatic Voltage Regulator Type II - Typical static exciter model\n\nArguments\n\nK0::Float64: Regulator Gain, validation range: (0, nothing)\nT1::Float64: First Pole in s, validation range: (0, nothing)\nT2::Float64: First zero in s, validation range: (0, nothing)\nT3::Float64: First Pole in s, validation range: (0, nothing)\nT4::Float64: First zero in s, validation range: (0, nothing)\nTe::Float64: Field Circuit Time Constant in s, validation range: (0, nothing)\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)\nVa_lim::MinMax: Limits for pi controler (Va_min, Va_max)\nAe::Float64: 1st ceiling coefficient, validation range: (0, nothing)\nBe::Float64: 2nd ceiling coefficient, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVf: Voltage field,\nVr1: First Lead-Lag state,\nVr2: Second lead-lag state,\nVm: Measured voltage\n\nn_states::Int: (Do not modify.) AVR Type II has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) AVR Type II has 4 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ae-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Ae","text":"get_Ae(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII Ae.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Be-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Be","text":"get_Be(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII Be.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K0-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_K0","text":"get_K0(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII K0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T1-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_T1","text":"get_T1(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T2-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_T2","text":"get_T2(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T3-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_T3","text":"get_T3(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T4-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_T4","text":"get_T4(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::AVRTypeII\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AVRTypeII Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::AVRTypeII) -> Dict{String, Any}\n\n\nGet AVRTypeII ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::AVRTypeII) -> Int64\n\n\nGet AVRTypeII n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::AVRTypeII) -> Vector{Symbol}\n\n\nGet AVRTypeII states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::AVRTypeII) -> Vector{StateTypes}\n\n\nGet AVRTypeII states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ae!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Ae!","text":"set_Ae!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Ae.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Be!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Be!","text":"set_Be!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Be.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K0!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_K0!","text":"set_K0!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII K0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T1!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_T1!","text":"set_T1!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T2!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_T2!","text":"set_T2!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T3!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_T3!","text":"set_T3!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T4!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_T4!","text":"set_T4!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESAC1A","page":"AVR","title":"ESAC1A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESAC1A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESAC1A","page":"AVR","title":"PowerSystems.ESAC1A","text":"mutable struct ESAC1A <: AVR\n Tr::Float64\n Tb::Float64\n Tc::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Te::Float64\n Kf::Float64\n Tf::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n Vr_lim::MinMax\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nThis excitation systems consists of an alternator main exciter feeding its output via non-controlled rectifiers. The exciter does not employ self-excitation, and the voltage regulator power is taken from a source that is not affected by external transients. Parameters of IEEE Std 421.5 Type AC1A Excitacion System. This model corresponds to ESAC1A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output time constant in s, validation range: (0, 10)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nTe::Float64: Exciter field time constant in s, validation range: (eps(), 2)\nKf::Float64: Rate feedback excitation system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant, validation range: (eps(), 1.5)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 1)\nKe::Float64: Exciter field proportional constant, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nVr_lim::MinMax: Limits for exciter field voltage: (Vr_min, Vr_max)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_coeffs::Tuple{Float64, Float64}: (default: PowerSystems.get_avr_saturation(E_sat, Se)) (Do not modify.) Coefficients (A,B) of the function: Se(x) = B(x - A)^2/x\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) ESAC1A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESAC1A has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESAC1A) -> Tuple{Float64, Float64}\n\n\nGet ESAC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESAC1A) -> Tuple{Float64, Float64}\n\n\nGet ESAC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESAC1A) -> Float64\n\n\nGet ESAC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ESAC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESAC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESAC1A) -> Dict{String, Any}\n\n\nGet ESAC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESAC1A) -> Int64\n\n\nGet ESAC1A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESAC1A\n) -> Tuple{Float64, Float64}\n\n\nGet ESAC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESAC1A) -> Vector{Symbol}\n\n\nGet ESAC1A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESAC1A) -> Vector{StateTypes}\n\n\nGet ESAC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESAC6A","page":"AVR","title":"ESAC6A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESAC6A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESAC6A","page":"AVR","title":"PowerSystems.ESAC6A","text":"mutable struct ESAC6A <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Tk::Float64\n Tb::Float64\n Tc::Float64\n Va_lim::MinMax\n Vr_lim::MinMax\n Te::Float64\n VFE_lim::Float64\n Kh::Float64\n VH_max::Float64\n Th::Float64\n Tj::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nModified AC6A. Used to represent field-controlled alternator-rectifier excitation systems with system-supplied electronic voltage regulators. Parameters of IEEE Std 421.5 Type AC6A Excitacion System. ESAC6A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output lag time constant in s, validation range: (0, 10)\nTk::Float64: Voltage Regulator lead time constant, validation range: (0, 10)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nVr_lim::MinMax: Limits for exciter field voltage (Vr_min, Vr_max)\nTe::Float64: Exciter field time constant, validation range: (eps(), 2)\nVFE_lim::Float64: Exciter field current limiter reference, validation range: (-5, 20)\nKh::Float64: Exciter field current regulator feedback gain, validation range: (0, 100)\nVH_max::Float64: Exciter field current limiter maximum output, validation range: (0, 100)\nTh::Float64: Exciter field current limiter denominator (lag) time constant, validation range: (0, 1)\nTj::Float64: Exciter field current limiter numerator (lead) time constant, validation range: (0, 1)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 2)\nKe::Float64: Exciter field proportional constant, validation range: (0, 2)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) ESAC6A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESAC6A has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESAC6A) -> Tuple{Float64, Float64}\n\n\nGet ESAC6A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kh-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Kh","text":"get_Kh(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Kh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESAC6A) -> Tuple{Float64, Float64}\n\n\nGet ESAC6A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Th-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Th","text":"get_Th(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tj-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tj","text":"get_Tj(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tj.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tk-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tk","text":"get_Tk(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tk.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VFE_lim-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_VFE_lim","text":"get_VFE_lim(value::ESAC6A) -> Float64\n\n\nGet ESAC6A VFE_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VH_max-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_VH_max","text":"get_VH_max(value::ESAC6A) -> Float64\n\n\nGet ESAC6A VH_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESAC6A) -> Float64\n\n\nGet ESAC6A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ESAC6A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC6A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESAC6A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC6A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESAC6A) -> Dict{String, Any}\n\n\nGet ESAC6A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESAC6A) -> Int64\n\n\nGet ESAC6A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESAC6A\n) -> Tuple{Float64, Float64}\n\n\nGet ESAC6A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESAC6A) -> Vector{Symbol}\n\n\nGet ESAC6A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESAC6A) -> Vector{StateTypes}\n\n\nGet ESAC6A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kh!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Kh!","text":"set_Kh!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Kh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Th!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Th!","text":"set_Th!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tj!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tj!","text":"set_Tj!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tj.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tk!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tk!","text":"set_Tk!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tk.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VFE_lim!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_VFE_lim!","text":"set_VFE_lim!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A VFE_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VH_max!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_VH_max!","text":"set_VH_max!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A VH_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESAC8B","page":"AVR","title":"ESAC8B","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESAC8B.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESAC8B","page":"AVR","title":"PowerSystems.ESAC8B","text":"mutable struct ESAC8B <: AVR\n Tr::Float64\n Kp::Float64\n Ki::Float64\n Kd::Float64\n Td::Float64\n Ka::Float64\n Ta::Float64\n Vr_lim::MinMax\n Te::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nExcitation System AC8B. Used to represent the Basler Digital Excitation Control System (DECS) with PID controller in PSSE.\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, nothing)\nKp::Float64: Regulator proportional PID gain, validation range: (0, nothing)\nKi::Float64: Regulator integral PID gain, validation range: (0, nothing)\nKd::Float64: Regulator derivative PID gain, validation range: (0, nothing)\nTd::Float64: Regulator derivative PID time constant., validation range: (0, 10)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output lag time constant in s, validation range: (0, 10)\nVr_lim::MinMax: Limits for exciter field voltage (Vr_min, Vr_max)\nTe::Float64: Exciter field time constant, validation range: (eps(), 2)\nKe::Float64: Exciter field proportional constant, validation range: (0, 2)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nx_i: Internal PI-block state,\nx_d: Internal Derivative-block state,\nVr: Voltage regulator state,\nEfd: Exciter output state\n\nn_states::Int: (Do not modify.) ESAC8B has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESAC8B has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESAC8B) -> Tuple{Float64, Float64}\n\n\nGet ESAC8B E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ki-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Ki","text":"get_Ki(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kp-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Kp","text":"get_Kp(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESAC8B) -> Tuple{Float64, Float64}\n\n\nGet ESAC8B Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Td-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Td","text":"get_Td(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESAC8B) -> Float64\n\n\nGet ESAC8B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESAC8B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC8B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESAC8B) -> Dict{String, Any}\n\n\nGet ESAC8B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESAC8B) -> Int64\n\n\nGet ESAC8B n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESAC8B\n) -> Tuple{Float64, Float64}\n\n\nGet ESAC8B saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESAC8B) -> Vector{Symbol}\n\n\nGet ESAC8B states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESAC8B) -> Vector{StateTypes}\n\n\nGet ESAC8B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ki!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kp!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Td!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Td!","text":"set_Td!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESDC1A","page":"AVR","title":"ESDC1A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESDC1A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESDC1A","page":"AVR","title":"PowerSystems.ESDC1A","text":"mutable struct ESDC1A <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Tb::Float64\n Tc::Float64\n Vr_lim::MinMax\n Ke::Float64\n Te::Float64\n Kf::Float64\n Tf::Float64\n switch::Int\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nSelf-excited shunt fields with the voltage regulator operating in a mode commonly termed buck-boost. Parameters of IEEE Std 421.5 Type DC1A Excitacion System. This model corresponds to ESDC1A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, 0.5)\nKa::Float64: Amplifier Gain, validation range: (10, 500)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, 1)\nTb::Float64: Regulator input Time Constant in s, validation range: (0, nothing)\nTc::Float64: Regulator input Time Constant in s, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)\nKe::Float64: Exciter constant related to self-excited field, validation range: (0, nothing)\nTe::Float64: Exciter time constant, integration rate associated with exciter control, validation range: (eps(), 1)\nKf::Float64: Excitation control system stabilizer gain, validation range: (eps(), 0.3)\nTf::Float64: Excitation control system stabilizer time constant, validation range: (eps(), nothing)\nswitch::Int: Switch, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVt: Terminal Voltage,\nVr1: input lead lag,\nVr2: Regulator Output,\nVf: Exciter Output, \nVr3: Rate feedback integrator\n\nn_states::Int: (Do not modify.) The ESDC1A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESDC1A has 5 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESDC1A) -> Tuple{Float64, Float64}\n\n\nGet ESDC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESDC1A) -> Tuple{Float64, Float64}\n\n\nGet ESDC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESDC1A) -> Float64\n\n\nGet ESDC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESDC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESDC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESDC1A) -> Dict{String, Any}\n\n\nGet ESDC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESDC1A) -> Int64\n\n\nGet ESDC1A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESDC1A\n) -> Tuple{Float64, Float64}\n\n\nGet ESDC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESDC1A) -> Vector{Symbol}\n\n\nGet ESDC1A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESDC1A) -> Vector{StateTypes}\n\n\nGet ESDC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_switch-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_switch","text":"get_switch(value::ESDC1A) -> Int64\n\n\nGet ESDC1A switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_switch!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_switch!","text":"set_switch!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESDC2A","page":"AVR","title":"ESDC2A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESDC2A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESDC2A","page":"AVR","title":"PowerSystems.ESDC2A","text":"mutable struct ESDC2A <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Tb::Float64\n Tc::Float64\n Vr_lim::MinMax\n Ke::Float64\n Te::Float64\n Kf::Float64\n Tf::Float64\n switch::Int\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIs used to represent field-controlled dc commutator exciters with continuously acting voltage regulators having power supplies derived from the generator or auxiliaries bus. Parameters of IEEE Std 421.5 Type DC2A Excitacion System. This model corresponds to ESDC2A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, 0.5)\nKa::Float64: Amplifier Gain, validation range: (10, 500)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, 1)\nTb::Float64: Regulator input Time Constant in s, validation range: (0, nothing)\nTc::Float64: Regulator input Time Constant in s, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)\nKe::Float64: Exciter constant related to self-excited field, validation range: (-1, 1)\nTe::Float64: Exciter time constant, integration rate associated with exciter control, validation range: (eps(), 2)\nKf::Float64: Excitation control system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Excitation control system stabilizer time constant. Appropiate Data: 5.0 <= Tf/Kf <= 15.0, validation range: (eps(), 1.5)\nswitch::Int: Switch, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVt: Terminal Voltage,\nVr1: input lead lag,\nVr2: Regulator Output,\nVf: Exciter Output, \nVr3: Rate feedback integrator\n\nn_states::Int: (Do not modify.) The ESDC2A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESDC2A has 5 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESDC2A) -> Tuple{Float64, Float64}\n\n\nGet ESDC2A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESDC2A) -> Tuple{Float64, Float64}\n\n\nGet ESDC2A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESDC2A) -> Float64\n\n\nGet ESDC2A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESDC2A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESDC2A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESDC2A) -> Dict{String, Any}\n\n\nGet ESDC2A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESDC2A) -> Int64\n\n\nGet ESDC2A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESDC2A\n) -> Tuple{Float64, Float64}\n\n\nGet ESDC2A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESDC2A) -> Vector{Symbol}\n\n\nGet ESDC2A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESDC2A) -> Vector{StateTypes}\n\n\nGet ESDC2A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_switch-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_switch","text":"get_switch(value::ESDC2A) -> Int64\n\n\nGet ESDC2A switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_switch!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_switch!","text":"set_switch!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESST1A","page":"AVR","title":"ESST1A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESST1A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESST1A","page":"AVR","title":"PowerSystems.ESST1A","text":"mutable struct ESST1A <: AVR\n UEL_flags::Int\n PSS_flags::Int\n Tr::Float64\n Vi_lim::Tuple{Float64, Float64}\n Tc::Float64\n Tb::Float64\n Tc1::Float64\n Tb1::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Vr_lim::MinMax\n Kc::Float64\n Kf::Float64\n Tf::Float64\n K_lr::Float64\n I_lr::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nThis excitation system supplies power through a transformer from the generator terminals and its regulated by a controlled rectifier (via thyristors). Parameters of IEEE Std 421.5 Type ST1A Excitacion System. ESST1A in PSSE and PSLF\n\nArguments\n\nUEL_flags::Int: Code input for Underexcitization limiter (UEL) entry. Not supported, validation range: (1, 3)\nPSS_flags::Int: Code input for Power System Stabilizer (PSS) or (VOS) entry, validation range: (1, 2)\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.1)\nVi_lim::Tuple{Float64, Float64}: Voltage error limits (regulator input) (Vimin, Vimax)\nTc::Float64: First regulator denominator (lead) time constant in s, validation range: (0, 10)\nTb::Float64: First regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc1::Float64: Second regulator denominator (lead) time constant in s, validation range: (0, 10)\nTb1::Float64: Second regulator denominator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Voltage regulator gain, validation range: (50, 1000)\nTa::Float64: Voltage regulator time constant in s, validation range: (0, 0.5)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nVr_lim::MinMax: Limits for exciter output (Vr_min, Vr_max)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 0.3)\nKf::Float64: Rate feedback gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant in s, validation range: (eps(), 1.5)\nK_lr::Float64: Exciter output current limiter gain, validation range: (0, 5)\nI_lr::Float64: Exciter output current limit reference, validation range: (0, 5)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: First Lead-lag state,\nVr2: Second lead-lag state,\nVa: Regulator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) ST1A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ST1A has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_I_lr-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_I_lr","text":"get_I_lr(value::ESST1A) -> Float64\n\n\nGet ESST1A I_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_lr-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_K_lr","text":"get_K_lr(value::ESST1A) -> Float64\n\n\nGet ESST1A K_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESST1A) -> Float64\n\n\nGet ESST1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::ESST1A) -> Float64\n\n\nGet ESST1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::ESST1A) -> Float64\n\n\nGet ESST1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_PSS_flags-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_PSS_flags","text":"get_PSS_flags(value::ESST1A) -> Int64\n\n\nGet ESST1A PSS_flags.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESST1A) -> Float64\n\n\nGet ESST1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESST1A) -> Float64\n\n\nGet ESST1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb1-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tb1","text":"get_Tb1(value::ESST1A) -> Float64\n\n\nGet ESST1A Tb1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESST1A) -> Float64\n\n\nGet ESST1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc1-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tc1","text":"get_Tc1(value::ESST1A) -> Float64\n\n\nGet ESST1A Tc1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::ESST1A) -> Float64\n\n\nGet ESST1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESST1A) -> Float64\n\n\nGet ESST1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_UEL_flags-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_UEL_flags","text":"get_UEL_flags(value::ESST1A) -> Int64\n\n\nGet ESST1A UEL_flags.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESST1A) -> Float64\n\n\nGet ESST1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ESST1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESST1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vi_lim-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Vi_lim","text":"get_Vi_lim(value::ESST1A) -> Tuple{Float64, Float64}\n\n\nGet ESST1A Vi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESST1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESST1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESST1A) -> Dict{String, Any}\n\n\nGet ESST1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESST1A) -> Int64\n\n\nGet ESST1A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESST1A) -> Vector{Symbol}\n\n\nGet ESST1A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESST1A) -> Vector{StateTypes}\n\n\nGet ESST1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_I_lr!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_I_lr!","text":"set_I_lr!(value::ESST1A, val) -> Any\n\n\nSet ESST1A I_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_lr!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_K_lr!","text":"set_K_lr!(value::ESST1A, val) -> Any\n\n\nSet ESST1A K_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_PSS_flags!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_PSS_flags!","text":"set_PSS_flags!(value::ESST1A, val) -> Any\n\n\nSet ESST1A PSS_flags.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb1!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tb1!","text":"set_Tb1!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tb1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc1!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tc1!","text":"set_Tc1!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tc1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_UEL_flags!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_UEL_flags!","text":"set_UEL_flags!(value::ESST1A, val) -> Any\n\n\nSet ESST1A UEL_flags.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESST1A, val) -> Any\n\n\nSet ESST1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vi_lim!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Vi_lim!","text":"set_Vi_lim!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Vi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESST1A, val) -> Any\n\n\nSet ESST1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESST1A, val) -> Any\n\n\nSet ESST1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESST4B","page":"AVR","title":"ESST4B","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESST4B.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESST4B","page":"AVR","title":"PowerSystems.ESST4B","text":"mutable struct ESST4B <: AVR\n Tr::Float64\n K_pr::Float64\n K_ir::Float64\n Vr_lim::MinMax\n Ta::Float64\n K_pm::Float64\n K_im::Float64\n Vm_lim::MinMax\n Kg::Float64\n Kp::Float64\n Ki::Float64\n VB_max::Float64\n Kc::Float64\n Xl::Float64\n θp::Float64\n V_ref::Float64\n θp_rad::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIn these excitation systems, voltage (and also current in compounded systems) is transformed to an appropriate level. Rectifiers, either controlled or non-controlled, provide the necessary direct current for the generator field. Parameters of IEEE Std 421.5 Type ST4B Excitacion System. ESST4B in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nK_pr::Float64: Regulator propotional gain, validation range: (0, 75)\nK_ir::Float64: Regulator integral gain, validation range: (0, 75)\nVr_lim::MinMax: Voltage regulator limits (Vimin, Vimax)\nTa::Float64: Voltage regulator time constant in s, validation range: (0, 1)\nK_pm::Float64: Voltage regulator proportional gain output, validation range: (0, 1.2)\nK_im::Float64: Voltage regulator integral gain output, validation range: (0, 18)\nVm_lim::MinMax: Limits for inner loop output (Vm_min, Vm_max)\nKg::Float64: Feedback gain constant of the inner loop field regulator, validation range: (0, 1.1)\nKp::Float64: Potential circuit (voltage) gain coefficient, validation range: (0, 10)\nKi::Float64: Compound circuit (current) gain coefficient, validation range: (0, 1.1)\nVB_max::Float64: Maximum available exciter voltage, validation range: (1, 20)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nXl::Float64: Reactance associated with potential source, validation range: (0, 0.5)\nθp::Float64: Potential circuit phase angle (degrees), validation range: (-90, 90)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nθp_rad::Float64: (default: θp*π*inv(180)) (Do not modify.) Potential circuit phase angle (radians)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVt: Sensed Terminal Voltage,\nVr1: Regulator Integrator,\nVr2: Regulator Output,\nVm: Output integrator\n\nn_states::Int: (Do not modify.) ST4B has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) ST4B has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_im-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_K_im","text":"get_K_im(value::ESST4B) -> Float64\n\n\nGet ESST4B K_im.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ir-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_K_ir","text":"get_K_ir(value::ESST4B) -> Float64\n\n\nGet ESST4B K_ir.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pm-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_K_pm","text":"get_K_pm(value::ESST4B) -> Float64\n\n\nGet ESST4B K_pm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pr-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_K_pr","text":"get_K_pr(value::ESST4B) -> Float64\n\n\nGet ESST4B K_pr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::ESST4B) -> Float64\n\n\nGet ESST4B Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kg-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Kg","text":"get_Kg(value::ESST4B) -> Float64\n\n\nGet ESST4B Kg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ki-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Ki","text":"get_Ki(value::ESST4B) -> Float64\n\n\nGet ESST4B Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kp-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Kp","text":"get_Kp(value::ESST4B) -> Float64\n\n\nGet ESST4B Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESST4B) -> Float64\n\n\nGet ESST4B Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESST4B) -> Float64\n\n\nGet ESST4B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VB_max-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_VB_max","text":"get_VB_max(value::ESST4B) -> Float64\n\n\nGet ESST4B VB_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESST4B) -> Float64\n\n\nGet ESST4B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vm_lim-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Vm_lim","text":"get_Vm_lim(\n value::ESST4B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESST4B Vm_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESST4B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESST4B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Xl-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Xl","text":"get_Xl(value::ESST4B) -> Float64\n\n\nGet ESST4B Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESST4B) -> Dict{String, Any}\n\n\nGet ESST4B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESST4B) -> Int64\n\n\nGet ESST4B n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESST4B) -> Vector{Symbol}\n\n\nGet ESST4B states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESST4B) -> Vector{StateTypes}\n\n\nGet ESST4B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_θp-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_θp","text":"get_θp(value::ESST4B) -> Float64\n\n\nGet ESST4B θp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_θp_rad-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_θp_rad","text":"get_θp_rad(value::ESST4B) -> Float64\n\n\nGet ESST4B θp_rad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_im!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_K_im!","text":"set_K_im!(value::ESST4B, val) -> Any\n\n\nSet ESST4B K_im.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ir!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_K_ir!","text":"set_K_ir!(value::ESST4B, val) -> Any\n\n\nSet ESST4B K_ir.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pm!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_K_pm!","text":"set_K_pm!(value::ESST4B, val) -> Any\n\n\nSet ESST4B K_pm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pr!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_K_pr!","text":"set_K_pr!(value::ESST4B, val) -> Any\n\n\nSet ESST4B K_pr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kg!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Kg!","text":"set_Kg!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Kg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ki!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kp!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VB_max!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_VB_max!","text":"set_VB_max!(value::ESST4B, val) -> Any\n\n\nSet ESST4B VB_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESST4B, val) -> Any\n\n\nSet ESST4B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vm_lim!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Vm_lim!","text":"set_Vm_lim!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Vm_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Xl!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Xl!","text":"set_Xl!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESST4B, val) -> Any\n\n\nSet ESST4B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESST4B, val) -> Any\n\n\nSet ESST4B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_θp!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_θp!","text":"set_θp!(value::ESST4B, val) -> Any\n\n\nSet ESST4B θp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_θp_rad!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_θp_rad!","text":"set_θp_rad!(value::ESST4B, val) -> Any\n\n\nSet ESST4B θp_rad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXAC1","page":"AVR","title":"EXAC1","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXAC1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.EXAC1","page":"AVR","title":"PowerSystems.EXAC1","text":"mutable struct EXAC1 <: AVR\n Tr::Float64\n Tb::Float64\n Tc::Float64\n Ka::Float64\n Ta::Float64\n Vr_lim::MinMax\n Te::Float64\n Kf::Float64\n Tf::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nModified ESAC1A. This excitation systems consists of an alternator main exciter feeding its output via non-controlled rectifiers. The exciter does not employ self-excitation, and the voltage regulator power is taken from a source that is not affected by external transients. Parameters of IEEE Std 421.5 Type AC1A. EXAC1 in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output time constant in s, validation range: (0, 10)\nVr_lim::MinMax: Limits for regulator output (Vr_min, Vr_max)\nTe::Float64: Exciter field time constant in s, validation range: (eps(), 2)\nKf::Float64: Rate feedback excitation system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant, validation range: (eps(), 1.5)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 1)\nKe::Float64: Exciter field proportional constant, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) EXAC1 has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) EXAC1 has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::EXAC1) -> Tuple{Float64, Float64}\n\n\nGet EXAC1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::EXAC1) -> Float64\n\n\nGet EXAC1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::EXAC1) -> Float64\n\n\nGet EXAC1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::EXAC1) -> Float64\n\n\nGet EXAC1 Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::EXAC1) -> Float64\n\n\nGet EXAC1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::EXAC1) -> Float64\n\n\nGet EXAC1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::EXAC1) -> Tuple{Float64, Float64}\n\n\nGet EXAC1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::EXAC1) -> Float64\n\n\nGet EXAC1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::EXAC1) -> Float64\n\n\nGet EXAC1 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::EXAC1) -> Float64\n\n\nGet EXAC1 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::EXAC1) -> Float64\n\n\nGet EXAC1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::EXAC1) -> Float64\n\n\nGet EXAC1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::EXAC1) -> Float64\n\n\nGet EXAC1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::EXAC1) -> Float64\n\n\nGet EXAC1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::EXAC1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::EXAC1) -> Dict{String, Any}\n\n\nGet EXAC1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::EXAC1) -> Int64\n\n\nGet EXAC1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::EXAC1\n) -> Tuple{Float64, Float64}\n\n\nGet EXAC1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::EXAC1) -> Vector{Symbol}\n\n\nGet EXAC1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::EXAC1) -> Vector{StateTypes}\n\n\nGet EXAC1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXAC1A","page":"AVR","title":"EXAC1A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXAC1A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.EXAC1A","page":"AVR","title":"PowerSystems.EXAC1A","text":"mutable struct EXAC1A <: AVR\n Tr::Float64\n Tb::Float64\n Tc::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Te::Float64\n Kf::Float64\n Tf::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n Vr_lim::MinMax\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nModified ESAC1A. This excitation systems consists of an alternator main exciter feeding its output via non-controlled rectifiers. The exciter does not employ self-excitation, and the voltage regulator power is taken from a source that is not affected by external transients. Parameters of IEEE Std 421.5 Type AC1A Excitacion System. EXAC1A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output time constant in s, validation range: (0, 10)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nTe::Float64: Exciter field time constant in s, validation range: (eps(), 2)\nKf::Float64: Rate feedback excitation system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant, validation range: (eps(), 1.5)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 1)\nKe::Float64: Exciter field proportional constant, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nVr_lim::MinMax: Limits for exciter field voltage: (Vr_min, Vr_max)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_coeffs::Tuple{Float64, Float64}: (default: PowerSystems.get_avr_saturation(E_sat, Se)) (Do not modify.) Coefficients (A,B) of the function: Se(x) = B(x - A)^2/x\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) EXAC1A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) EXAC1A has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::EXAC1A) -> Tuple{Float64, Float64}\n\n\nGet EXAC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::EXAC1A) -> Tuple{Float64, Float64}\n\n\nGet EXAC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::EXAC1A) -> Float64\n\n\nGet EXAC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::EXAC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::EXAC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::EXAC1A) -> Dict{String, Any}\n\n\nGet EXAC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::EXAC1A) -> Int64\n\n\nGet EXAC1A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::EXAC1A\n) -> Tuple{Float64, Float64}\n\n\nGet EXAC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::EXAC1A) -> Vector{Symbol}\n\n\nGet EXAC1A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::EXAC1A) -> Vector{StateTypes}\n\n\nGet EXAC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXAC2","page":"AVR","title":"EXAC2","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXAC2.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.EXAC2","page":"AVR","title":"PowerSystems.EXAC2","text":"mutable struct EXAC2 <: AVR\n Tr::Float64\n Tb::Float64\n Tc::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Kb::Float64\n Vr_lim::MinMax\n Te::Float64\n Kl::Float64\n Kh::Float64\n Kf::Float64\n Tf::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n V_lr::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nModified AC2. This excitation systems consists of an alternator main exciter feeding its output via non-controlled rectifiers. The exciter does not employ self-excitation, and the voltage regulator power is taken from a source that is not affected by external transients. Parameters of IEEE Std 421.5 Type AC2A Excitacion System. The alternator main exciter is used, feeding its output via non-controlled rectifiers. The Type AC2C model is similar to that of Type AC1C except for the inclusion of exciter time constant compensation and exciter field current limiting elements. EXAC2 in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output time constant in s, validation range: (0, 10)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nKb::Float64: Second Stage regulator gain, validation range: (eps(), 500)\nVr_lim::MinMax: Limits for exciter field voltage (Vr_min, Vr_max)\nTe::Float64: Exciter field time constant, validation range: (eps(), 2)\nKl::Float64: Exciter field current limiter gain, validation range: (0, 1.1)\nKh::Float64: Exciter field current regulator feedback gain, validation range: (0, 1.1)\nKf::Float64: Rate feedback excitation system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant, validation range: (eps(), nothing)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 1)\nKe::Float64: Exciter field proportional constant, validation range: (0, 1)\nV_lr::Float64: Maximum exciter field current, validation range: (0, nothing)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) EXAC2 has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) EXAC2 has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::EXAC2) -> Tuple{Float64, Float64}\n\n\nGet EXAC2 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::EXAC2) -> Float64\n\n\nGet EXAC2 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kb-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kb","text":"get_Kb(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::EXAC2) -> Float64\n\n\nGet EXAC2 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kh-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kh","text":"get_Kh(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kl-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kl","text":"get_Kl(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::EXAC2) -> Tuple{Float64, Float64}\n\n\nGet EXAC2 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::EXAC2) -> Float64\n\n\nGet EXAC2 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::EXAC2) -> Float64\n\n\nGet EXAC2 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::EXAC2) -> Float64\n\n\nGet EXAC2 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::EXAC2) -> Float64\n\n\nGet EXAC2 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::EXAC2) -> Float64\n\n\nGet EXAC2 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::EXAC2) -> Float64\n\n\nGet EXAC2 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_lr-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_V_lr","text":"get_V_lr(value::EXAC2) -> Float64\n\n\nGet EXAC2 V_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::EXAC2) -> Float64\n\n\nGet EXAC2 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::EXAC2\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC2 Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::EXAC2\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC2 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::EXAC2) -> Dict{String, Any}\n\n\nGet EXAC2 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::EXAC2) -> Int64\n\n\nGet EXAC2 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::EXAC2\n) -> Tuple{Float64, Float64}\n\n\nGet EXAC2 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::EXAC2) -> Vector{Symbol}\n\n\nGet EXAC2 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::EXAC2) -> Vector{StateTypes}\n\n\nGet EXAC2 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kb!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kb!","text":"set_Kb!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kh!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kh!","text":"set_Kh!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kl!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kl!","text":"set_Kl!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_lr!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_V_lr!","text":"set_V_lr!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 V_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXPIC1","page":"AVR","title":"EXPIC1","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXPIC1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.EXPIC1","page":"AVR","title":"PowerSystems.EXPIC1","text":"mutable struct EXPIC1 <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Ta_2::Float64\n Ta_3::Float64\n Ta_4::Float64\n Vr_lim::MinMax\n Kf::Float64\n Tf_1::Float64\n Tf_2::Float64\n Efd_lim::MinMax\n Ke::Float64\n Te::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n Kp::Float64\n Ki::Float64\n Kc::Float64\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nGeneric Proportional/Integral Excitation System\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nKa::Float64: Voltage regulator gain, validation range: (1, 500)\nTa::Float64: Voltage regulator time constant in s, validation range: (0, 10)\nVa_lim::MinMax: Limits for pi controler (Vr_min, Vr_max)\nTa_2::Float64: Voltage regulator time constant in s, validation range: (0, nothing)\nTa_3::Float64: Voltage regulator time constant in s, validation range: (0, nothing)\nTa_4::Float64: Voltage regulator time constant in s, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)\nKf::Float64: Rate feedback gain, validation range: (0, 0.3)\nTf_1::Float64: Rate Feedback time constant in s, validation range: (eps(), 15)\nTf_2::Float64: Rate Feedback time constant in s, validation range: (0, 5)\nEfd_lim::MinMax: Field Voltage regulator limits (regulator output) (Efdmin, Efdmax)\nKe::Float64: Exciter constant, validation range: (0, 1)\nTe::Float64: Exciter time constant, validation range: (0, 2)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nKp::Float64: Potential source gain, validation range: (0, 5)\nKi::Float64: current source gain, validation range: (0, 1.1)\nKc::Float64: Exciter regulation factor, validation range: (0, 2)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: First Lead-lag state,\nVr2: Second regulator lead-lag state,\nVr2: Third regulator lead-lag state \nVf: Exciter output \nVr3: First feedback integrator,\nVr4: second feedback integrator\n\nn_states::Int: (Do not modify.) EXPIC1 has 6 states\nstates_types::Vector{StateTypes}: (Do not modify.) EXPIC has 6 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::EXPIC1) -> Tuple{Float64, Float64}\n\n\nGet EXPIC1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Efd_lim-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Efd_lim","text":"get_Efd_lim(\n value::EXPIC1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXPIC1 Efd_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ki-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ki","text":"get_Ki(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kp-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Kp","text":"get_Kp(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::EXPIC1) -> Tuple{Float64, Float64}\n\n\nGet EXPIC1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_2-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ta_2","text":"get_Ta_2(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ta_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_3-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ta_3","text":"get_Ta_3(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ta_3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_4-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ta_4","text":"get_Ta_4(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ta_4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf_1-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Tf_1","text":"get_Tf_1(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Tf_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf_2-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Tf_2","text":"get_Tf_2(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Tf_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::EXPIC1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXPIC1 Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::EXPIC1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXPIC1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::EXPIC1) -> Dict{String, Any}\n\n\nGet EXPIC1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::EXPIC1) -> Int64\n\n\nGet EXPIC1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::EXPIC1\n) -> Tuple{Float64, Float64}\n\n\nGet EXPIC1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::EXPIC1) -> Vector{Symbol}\n\n\nGet EXPIC1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::EXPIC1) -> Vector{StateTypes}\n\n\nGet EXPIC1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Efd_lim!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Efd_lim!","text":"set_Efd_lim!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Efd_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ki!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kp!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_2!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ta_2!","text":"set_Ta_2!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ta_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_3!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ta_3!","text":"set_Ta_3!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ta_3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_4!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ta_4!","text":"set_Ta_4!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ta_4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf_1!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Tf_1!","text":"set_Tf_1!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Tf_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf_2!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Tf_2!","text":"set_Tf_2!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Tf_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#IEEET1","page":"AVR","title":"IEEET1","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/IEEET1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.IEEET1","page":"AVR","title":"PowerSystems.IEEET1","text":"mutable struct IEEET1 <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Vr_lim::MinMax\n Ke::Float64\n Te::Float64\n Kf::Float64\n Tf::Float64\n switch::Int\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\n1968 IEEE type 1 excitation system model\n\nArguments\n\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, 0.5)\nKa::Float64: Amplifier Gain, validation range: (10, 500)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, 1)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)\nKe::Float64: Exciter constant related to self-excited field, validation range: (-1, 1)\nTe::Float64: Exciter time constant, integration rate associated with exciter control, validation range: (eps(), 1)\nKf::Float64: Excitation control system stabilizer gain, validation range: (eps(), 0.3)\nTf::Float64: Excitation control system stabilizer time constant. Appropiate Data: 5 <= Tf/Kf <= 15, validation range: (eps(), nothing)\nswitch::Int: Switch, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVt: Terminal Voltage,\nVr: Regulator Output,\nVf: Exciter Output, \nVr3: Rate feedback integrator\n\nn_states::Int: (Do not modify.) The IEEET1 has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEET1 I has 4 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::IEEET1) -> Tuple{Float64, Float64}\n\n\nGet IEEET1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::IEEET1) -> Float64\n\n\nGet IEEET1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::IEEET1) -> Float64\n\n\nGet IEEET1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::IEEET1) -> Float64\n\n\nGet IEEET1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::IEEET1) -> Tuple{Float64, Float64}\n\n\nGet IEEET1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::IEEET1) -> Float64\n\n\nGet IEEET1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::IEEET1) -> Float64\n\n\nGet IEEET1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::IEEET1) -> Float64\n\n\nGet IEEET1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::IEEET1) -> Float64\n\n\nGet IEEET1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::IEEET1) -> Float64\n\n\nGet IEEET1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::IEEET1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet IEEET1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::IEEET1) -> Dict{String, Any}\n\n\nGet IEEET1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::IEEET1) -> Int64\n\n\nGet IEEET1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::IEEET1\n) -> Tuple{Float64, Float64}\n\n\nGet IEEET1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::IEEET1) -> Vector{Symbol}\n\n\nGet IEEET1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::IEEET1) -> Vector{StateTypes}\n\n\nGet IEEET1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_switch-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_switch","text":"get_switch(value::IEEET1) -> Int64\n\n\nGet IEEET1 switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_switch!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_switch!","text":"set_switch!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EX4VSA","page":"AVR","title":"EX4VSA","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EX4VSA.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_lim-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_E_lim","text":"get_E_lim(\n value::PowerSystems.EX4VSA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EX4VSA E_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_G-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_G","text":"get_G(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA G.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Iflim-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Iflim","text":"get_Iflim(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Iflim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K1-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_K1","text":"get_K1(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA K1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K2-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_K2","text":"get_K2(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA K2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Oel_lim-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Oel_lim","text":"get_Oel_lim(\n value::PowerSystems.EX4VSA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EX4VSA Oel_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Spar-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Spar","text":"get_Spar(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Spar.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_d-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_d","text":"get_d(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::PowerSystems.EX4VSA) -> Dict{String, Any}\n\n\nGet EX4VSA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_f-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_f","text":"get_f(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::PowerSystems.EX4VSA) -> Int64\n\n\nGet EX4VSA n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::PowerSystems.EX4VSA) -> Vector{Symbol}\n\n\nGet EX4VSA states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_lim!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_E_lim!","text":"set_E_lim!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA E_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_G!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_G!","text":"set_G!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA G.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Iflim!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Iflim!","text":"set_Iflim!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Iflim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K1!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_K1!","text":"set_K1!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA K1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K2!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_K2!","text":"set_K2!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA K2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Oel_lim!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Oel_lim!","text":"set_Oel_lim!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Oel_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Spar!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Spar!","text":"set_Spar!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Spar.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_d!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_d!","text":"set_d!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_f!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_f!","text":"set_f!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXST1","page":"AVR","title":"EXST1","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXST1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vi_lim-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Vi_lim","text":"get_Vi_lim(\n value::PowerSystems.EXST1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXST1 Vi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::PowerSystems.EXST1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXST1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::PowerSystems.EXST1) -> Dict{String, Any}\n\n\nGet EXST1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::PowerSystems.EXST1) -> Int64\n\n\nGet EXST1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::PowerSystems.EXST1) -> Vector{Symbol}\n\n\nGet EXST1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vi_lim!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Vi_lim!","text":"set_Vi_lim!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Vi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#SCRX","page":"AVR","title":"SCRX","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/SCRX.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.SCRX","page":"AVR","title":"PowerSystems.SCRX","text":"mutable struct SCRX <: AVR\n Ta_Tb::Float64\n Tb::Float64\n K::Float64\n Te::Float64\n Efd_lim::MinMax\n switch::Int\n rc_rfd::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nThis 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\n\nArguments\n\nTa_Tb::Float64: Lead input constant ratio, validation range: (0.05, 0.3)\nTb::Float64: Lag input constant in s, validation range: (5, 20)\nK::Float64: Regulator Gain, validation range: (20, 100)\nTe::Float64: Regulator Time Constant, validation range: (0, 1)\nEfd_lim::MinMax: Field Voltage regulator limits (regulator output) (Efdmin, Efdmax)\nswitch::Int: Switch, validation range: (0, 1)\nrc_rfd::Float64: Field current capability. Set = 0 for negative current capability. Typical value 10, validation range: (0, 10)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVr1: First integrator,\nVr2: Second integrator\n\nn_states::Int: (Do not modify.) SCRX has 2 states\nstates_types::Vector{StateTypes}: (Do not modify.) SCRX has 2 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Efd_lim-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_Efd_lim","text":"get_Efd_lim(\n value::SCRX\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet SCRX Efd_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_K","text":"get_K(value::SCRX) -> Float64\n\n\nGet SCRX K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_Tb-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_Ta_Tb","text":"get_Ta_Tb(value::SCRX) -> Float64\n\n\nGet SCRX Ta_Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::SCRX) -> Float64\n\n\nGet SCRX Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::SCRX) -> Float64\n\n\nGet SCRX Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::SCRX) -> Float64\n\n\nGet SCRX V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::SCRX) -> Dict{String, Any}\n\n\nGet SCRX ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::SCRX) -> Int64\n\n\nGet SCRX n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_rc_rfd-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_rc_rfd","text":"get_rc_rfd(value::SCRX) -> Float64\n\n\nGet SCRX rc_rfd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::SCRX) -> Vector{Symbol}\n\n\nGet SCRX states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::SCRX) -> Vector{StateTypes}\n\n\nGet SCRX states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_switch-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_switch","text":"get_switch(value::SCRX) -> Int64\n\n\nGet SCRX switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Efd_lim!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_Efd_lim!","text":"set_Efd_lim!(value::SCRX, val) -> Any\n\n\nSet SCRX Efd_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_K!","text":"set_K!(value::SCRX, val) -> Any\n\n\nSet SCRX K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_Tb!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_Ta_Tb!","text":"set_Ta_Tb!(value::SCRX, val) -> Any\n\n\nSet SCRX Ta_Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::SCRX, val) -> Any\n\n\nSet SCRX Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::SCRX, val) -> Any\n\n\nSet SCRX Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::SCRX, val) -> Any\n\n\nSet SCRX V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::SCRX, val) -> Any\n\n\nSet SCRX ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_rc_rfd!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_rc_rfd!","text":"set_rc_rfd!(value::SCRX, val) -> Any\n\n\nSet SCRX rc_rfd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::SCRX, val) -> Any\n\n\nSet SCRX states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_switch!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_switch!","text":"set_switch!(value::SCRX, val) -> Any\n\n\nSet SCRX switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#SEXS","page":"AVR","title":"SEXS","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/SEXS.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.SEXS","page":"AVR","title":"PowerSystems.SEXS","text":"mutable struct SEXS <: AVR\n Ta_Tb::Float64\n Tb::Float64\n K::Float64\n Te::Float64\n V_lim::MinMax\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of Simplified Excitation System Model - SEXS in PSSE\n\nArguments\n\nTa_Tb::Float64: Ratio of lead and lag time constants, validation range: (0, nothing)\nTb::Float64: Lag time constant, validation range: (eps(), nothing)\nK::Float64: Gain, validation range: (0, nothing)\nTe::Float64: Field circuit time constant in s, validation range: (0, nothing)\nV_lim::MinMax: Field voltage limits\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\tVf: Voltage field,\tVr: Lead-lag state\nn_states::Int: (Do not modify.) SEXS has 2 states\nstates_types::Vector{StateTypes}: (Do not modify.) SEXS has 2 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_K-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_K","text":"get_K(value::SEXS) -> Float64\n\n\nGet SEXS K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_Tb-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_Ta_Tb","text":"get_Ta_Tb(value::SEXS) -> Float64\n\n\nGet SEXS Ta_Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::SEXS) -> Float64\n\n\nGet SEXS Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::SEXS) -> Float64\n\n\nGet SEXS Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_lim-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_V_lim","text":"get_V_lim(\n value::SEXS\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet SEXS V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::SEXS) -> Float64\n\n\nGet SEXS V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::SEXS) -> Dict{String, Any}\n\n\nGet SEXS ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::SEXS) -> Int64\n\n\nGet SEXS n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::SEXS) -> Vector{Symbol}\n\n\nGet SEXS states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::SEXS) -> Vector{StateTypes}\n\n\nGet SEXS states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_K!","text":"set_K!(value::SEXS, val) -> Any\n\n\nSet SEXS K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_Tb!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_Ta_Tb!","text":"set_Ta_Tb!(value::SEXS, val) -> Any\n\n\nSet SEXS Ta_Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::SEXS, val) -> Any\n\n\nSet SEXS Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::SEXS, val) -> Any\n\n\nSet SEXS Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_lim!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::SEXS, val) -> Any\n\n\nSet SEXS V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::SEXS, val) -> Any\n\n\nSet SEXS V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::SEXS, val) -> Any\n\n\nSet SEXS ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::SEXS, val) -> Any\n\n\nSet SEXS states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ST6B","page":"AVR","title":"ST6B","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ST6B.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ST6B","page":"AVR","title":"PowerSystems.ST6B","text":"mutable struct ST6B <: AVR\n OEL_Flag::Int\n Tr::Float64\n K_pa::Float64\n K_ia::Float64\n K_da::Float64\n T_da::Float64\n Va_lim::MinMax\n K_ff::Float64\n K_m::Float64\n K_ci::Float64\n K_lr::Float64\n I_lr::Float64\n Vr_lim::MinMax\n Kg::Float64\n Tg::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIn these excitation systems, voltage (and also current in compounded systems) is transformed to an appropriate level. Rectifiers, either controlled or non-controlled, provide the necessary direct current for the generator field. Parameters of IEEE Std 421.5 Type ST6B Excitacion System. ST6B in PSSE and PSLF\n\nArguments\n\nOEL_Flag::Int: OEL Flag for ST6B: 1: before HV gate, 2: after HV gate, validation range: (0, 2)\nTr::Float64: Regulator input filter time constant in s, validation range: (0, nothing)\nK_pa::Float64: Regulator proportional gain, validation range: (0, nothing)\nK_ia::Float64: Regulator integral gain, validation range: (0, nothing)\nK_da::Float64: Regulator derivative gain, validation range: (0, nothing)\nT_da::Float64: Voltage regulator derivative channel time constant in s, validation range: (0, nothing)\nVa_lim::MinMax: Regulator output limits (Vimin, Vimax)\nK_ff::Float64: Pre-control gain of the inner loop field regulator, validation range: (0, nothing)\nK_m::Float64: Forward gain of the inner loop field regulator, validation range: (0, nothing)\nK_ci::Float64: Exciter output current limit adjustment gain, validation range: (0, nothing)\nK_lr::Float64: Exciter output current limiter gain, validation range: (0, nothing)\nI_lr::Float64: Exciter current limiter reference, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (Vimin, Vimax)\nKg::Float64: Feedback gain constant of the inner loop field regulator, validation range: (0, nothing)\nTg::Float64: Feedback time constant of the inner loop field voltage regulator in s, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nx_i: Regulator Integrator,\nx_d: Regulator Derivative,\nVg: Regulator Feedback\n\nn_states::Int: (Do not modify.) ST6B has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) ST6B has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_I_lr-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_I_lr","text":"get_I_lr(value::ST6B) -> Float64\n\n\nGet ST6B I_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ci-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_ci","text":"get_K_ci(value::ST6B) -> Float64\n\n\nGet ST6B K_ci.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_da-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_da","text":"get_K_da(value::ST6B) -> Float64\n\n\nGet ST6B K_da.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ff-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_ff","text":"get_K_ff(value::ST6B) -> Float64\n\n\nGet ST6B K_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ia-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_ia","text":"get_K_ia(value::ST6B) -> Float64\n\n\nGet ST6B K_ia.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_lr-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_lr","text":"get_K_lr(value::ST6B) -> Float64\n\n\nGet ST6B K_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_m-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_m","text":"get_K_m(value::ST6B) -> Float64\n\n\nGet ST6B K_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pa-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_pa","text":"get_K_pa(value::ST6B) -> Float64\n\n\nGet ST6B K_pa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kg-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Kg","text":"get_Kg(value::ST6B) -> Float64\n\n\nGet ST6B Kg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_OEL_Flag-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_OEL_Flag","text":"get_OEL_Flag(value::ST6B) -> Int64\n\n\nGet ST6B OEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T_da-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_T_da","text":"get_T_da(value::ST6B) -> Float64\n\n\nGet ST6B T_da.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tg-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Tg","text":"get_Tg(value::ST6B) -> Float64\n\n\nGet ST6B Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ST6B) -> Float64\n\n\nGet ST6B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ST6B) -> Float64\n\n\nGet ST6B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ST6B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST6B Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ST6B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST6B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ST6B) -> Dict{String, Any}\n\n\nGet ST6B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ST6B) -> Int64\n\n\nGet ST6B n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ST6B) -> Vector{Symbol}\n\n\nGet ST6B states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ST6B) -> Vector{StateTypes}\n\n\nGet ST6B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_I_lr!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_I_lr!","text":"set_I_lr!(value::ST6B, val) -> Any\n\n\nSet ST6B I_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ci!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_ci!","text":"set_K_ci!(value::ST6B, val) -> Any\n\n\nSet ST6B K_ci.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_da!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_da!","text":"set_K_da!(value::ST6B, val) -> Any\n\n\nSet ST6B K_da.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ff!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_ff!","text":"set_K_ff!(value::ST6B, val) -> Any\n\n\nSet ST6B K_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ia!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_ia!","text":"set_K_ia!(value::ST6B, val) -> Any\n\n\nSet ST6B K_ia.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_lr!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_lr!","text":"set_K_lr!(value::ST6B, val) -> Any\n\n\nSet ST6B K_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_m!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_m!","text":"set_K_m!(value::ST6B, val) -> Any\n\n\nSet ST6B K_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pa!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_pa!","text":"set_K_pa!(value::ST6B, val) -> Any\n\n\nSet ST6B K_pa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kg!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Kg!","text":"set_Kg!(value::ST6B, val) -> Any\n\n\nSet ST6B Kg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_OEL_Flag!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_OEL_Flag!","text":"set_OEL_Flag!(value::ST6B, val) -> Any\n\n\nSet ST6B OEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T_da!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_T_da!","text":"set_T_da!(value::ST6B, val) -> Any\n\n\nSet ST6B T_da.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tg!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Tg!","text":"set_Tg!(value::ST6B, val) -> Any\n\n\nSet ST6B Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ST6B, val) -> Any\n\n\nSet ST6B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ST6B, val) -> Any\n\n\nSet ST6B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ST6B, val) -> Any\n\n\nSet ST6B Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ST6B, val) -> Any\n\n\nSet ST6B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ST6B, val) -> Any\n\n\nSet ST6B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ST6B, val) -> Any\n\n\nSet ST6B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ST8C","page":"AVR","title":"ST8C","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ST8C.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ST8C","page":"AVR","title":"PowerSystems.ST8C","text":"mutable struct ST8C <: AVR\n OEL_Flag::Int\n UEL_Flag::Int\n SCL_Flag::Int\n SW1_Flag::Int\n Tr::Float64\n K_pr::Float64\n K_ir::Float64\n Vpi_lim::MinMax\n K_pa::Float64\n K_ia::Float64\n Va_lim::MinMax\n K_a::Float64\n T_a::Float64\n Vr_lim::MinMax\n K_f::Float64\n T_f::Float64\n K_c1::Float64\n K_p::Float64\n K_i1::Float64\n X_l::Float64\n θ_p::Float64\n VB1_max::Float64\n K_c2::Float64\n K_i2::Float64\n VB2_max::Float64\n V_ref::Float64\n Ifd_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIn these excitation systems, voltage (and also current in compounded systems) is transformed to an appropriate level. Rectifiers, either controlled or non-controlled, provide the necessary direct current for the generator field. Parameters of IEEE Std 421.5 Type ST8C Excitacion System. ST8C in PSSE and PSLF\n\nArguments\n\nOEL_Flag::Int: OEL Flag for ST8C: <2: Summation at Voltage Error, 2: OEL takeover at gate, validation range: (0, 2)\nUEL_Flag::Int: UEL Flag for ST8C: <2: Summation at Voltage Error, 2: UEL takeover at gate, validation range: (0, 2)\nSCL_Flag::Int: SCL Flag for ST8C: <2: Summation at Voltage Error, 2: SCL Takeover at UEL and OEL gates, validation range: (0, 2)\nSW1_Flag::Int: SW1 Flag for Power Source Selector for ST8C: <2: Source from generator terminal voltage, 2: Independent power source, validation range: (0, 2)\nTr::Float64: Regulator input filter time constant in seconds, validation range: (0, nothing)\nK_pr::Float64: Regulator proportional gain (pu), validation range: (0, nothing)\nK_ir::Float64: Regulator integral gain (pu), validation range: (0, nothing)\nVpi_lim::MinMax: Regulator input limits (Vpimin, Vpimax)\nK_pa::Float64: Field current regulator proportional gain (pu), validation range: (0, nothing)\nK_ia::Float64: Field current regulator integral gain (pu), validation range: (0, nothing)\nVa_lim::MinMax: Field current regulator output limits (Vamin, Vamax)\nK_a::Float64: Field current regulator proportional gain (pu), validation range: (0, nothing)\nT_a::Float64: Controlled rectifier bridge equivalent time constant in seconds, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (Vrmin, Vrmax)\nK_f::Float64: Exciter field current feedback gain (pu), validation range: (0, nothing)\nT_f::Float64: Field current feedback time constant in seconds, validation range: (0, nothing)\nK_c1::Float64: Rectifier loading factor proportional to commutating reactance (pu), validation range: (0, nothing)\nK_p::Float64: Potential circuit (voltage) gain coefficient (pu), validation range: (0, nothing)\nK_i1::Float64: Potential circuit (current) gain coefficient (pu), validation range: (0, nothing)\nX_l::Float64: Reactance associated with potential source (pu), validation range: (0, nothing)\nθ_p::Float64: Potential circuit phase angle (degrees), validation range: (0, nothing)\nVB1_max::Float64: Maximum available exciter voltage (pu), validation range: (0, nothing)\nK_c2::Float64: Rectifier loading factor proportional to commutating reactance (pu), validation range: (0, nothing)\nK_i2::Float64: Potential circuit (current) gain coefficient (pu), validation range: (0, nothing)\nVB2_max::Float64: Maximum available exciter voltage (pu), validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nIfd_ref::Float64: (default: 1.0) Reference Field Current Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nx_a1: Regulator Integrator state,\nx_a2: Field Current regulator state,\nx_a3: Controller rectifier bridge state,\nx_a4: Regulator Feedback state\n\nn_states::Int: (Do not modify.) ST8C has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ST8C has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ifd_ref-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Ifd_ref","text":"get_Ifd_ref(value::ST8C) -> Float64\n\n\nGet ST8C Ifd_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_a-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_a","text":"get_K_a(value::ST8C) -> Float64\n\n\nGet ST8C K_a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_c1-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_c1","text":"get_K_c1(value::ST8C) -> Float64\n\n\nGet ST8C K_c1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_c2-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_c2","text":"get_K_c2(value::ST8C) -> Float64\n\n\nGet ST8C K_c2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_f-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_f","text":"get_K_f(value::ST8C) -> Float64\n\n\nGet ST8C K_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_i1-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_i1","text":"get_K_i1(value::ST8C) -> Float64\n\n\nGet ST8C K_i1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_i2-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_i2","text":"get_K_i2(value::ST8C) -> Float64\n\n\nGet ST8C K_i2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ia-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_ia","text":"get_K_ia(value::ST8C) -> Float64\n\n\nGet ST8C K_ia.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ir-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_ir","text":"get_K_ir(value::ST8C) -> Float64\n\n\nGet ST8C K_ir.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_p-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_p","text":"get_K_p(value::ST8C) -> Float64\n\n\nGet ST8C K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pa-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_pa","text":"get_K_pa(value::ST8C) -> Float64\n\n\nGet ST8C K_pa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pr-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_pr","text":"get_K_pr(value::ST8C) -> Float64\n\n\nGet ST8C K_pr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_OEL_Flag-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_OEL_Flag","text":"get_OEL_Flag(value::ST8C) -> Int64\n\n\nGet ST8C OEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_SCL_Flag-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_SCL_Flag","text":"get_SCL_Flag(value::ST8C) -> Int64\n\n\nGet ST8C SCL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_SW1_Flag-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_SW1_Flag","text":"get_SW1_Flag(value::ST8C) -> Int64\n\n\nGet ST8C SW1_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T_a-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_T_a","text":"get_T_a(value::ST8C) -> Float64\n\n\nGet ST8C T_a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T_f-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_T_f","text":"get_T_f(value::ST8C) -> Float64\n\n\nGet ST8C T_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ST8C) -> Float64\n\n\nGet ST8C Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_UEL_Flag-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_UEL_Flag","text":"get_UEL_Flag(value::ST8C) -> Int64\n\n\nGet ST8C UEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VB1_max-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_VB1_max","text":"get_VB1_max(value::ST8C) -> Float64\n\n\nGet ST8C VB1_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VB2_max-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_VB2_max","text":"get_VB2_max(value::ST8C) -> Float64\n\n\nGet ST8C VB2_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ST8C) -> Float64\n\n\nGet ST8C V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ST8C\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST8C Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vpi_lim-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Vpi_lim","text":"get_Vpi_lim(\n value::ST8C\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST8C Vpi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ST8C\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST8C Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_X_l-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_X_l","text":"get_X_l(value::ST8C) -> Float64\n\n\nGet ST8C X_l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ST8C) -> Dict{String, Any}\n\n\nGet ST8C ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ST8C) -> Int64\n\n\nGet ST8C n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ST8C) -> Vector{Symbol}\n\n\nGet ST8C states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ST8C) -> Vector{StateTypes}\n\n\nGet ST8C states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_θ_p-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_θ_p","text":"get_θ_p(value::ST8C) -> Float64\n\n\nGet ST8C θ_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ifd_ref!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Ifd_ref!","text":"set_Ifd_ref!(value::ST8C, val) -> Any\n\n\nSet ST8C Ifd_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_a!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_a!","text":"set_K_a!(value::ST8C, val) -> Any\n\n\nSet ST8C K_a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_c1!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_c1!","text":"set_K_c1!(value::ST8C, val) -> Any\n\n\nSet ST8C K_c1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_c2!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_c2!","text":"set_K_c2!(value::ST8C, val) -> Any\n\n\nSet ST8C K_c2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_f!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_f!","text":"set_K_f!(value::ST8C, val) -> Any\n\n\nSet ST8C K_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_i1!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_i1!","text":"set_K_i1!(value::ST8C, val) -> Any\n\n\nSet ST8C K_i1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_i2!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_i2!","text":"set_K_i2!(value::ST8C, val) -> Any\n\n\nSet ST8C K_i2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ia!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_ia!","text":"set_K_ia!(value::ST8C, val) -> Any\n\n\nSet ST8C K_ia.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ir!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_ir!","text":"set_K_ir!(value::ST8C, val) -> Any\n\n\nSet ST8C K_ir.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_p!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_p!","text":"set_K_p!(value::ST8C, val) -> Any\n\n\nSet ST8C K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pa!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_pa!","text":"set_K_pa!(value::ST8C, val) -> Any\n\n\nSet ST8C K_pa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pr!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_pr!","text":"set_K_pr!(value::ST8C, val) -> Any\n\n\nSet ST8C K_pr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_OEL_Flag!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_OEL_Flag!","text":"set_OEL_Flag!(value::ST8C, val) -> Any\n\n\nSet ST8C OEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_SCL_Flag!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_SCL_Flag!","text":"set_SCL_Flag!(value::ST8C, val) -> Any\n\n\nSet ST8C SCL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_SW1_Flag!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_SW1_Flag!","text":"set_SW1_Flag!(value::ST8C, val) -> Any\n\n\nSet ST8C SW1_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T_a!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_T_a!","text":"set_T_a!(value::ST8C, val) -> Any\n\n\nSet ST8C T_a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T_f!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_T_f!","text":"set_T_f!(value::ST8C, val) -> Any\n\n\nSet ST8C T_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ST8C, val) -> Any\n\n\nSet ST8C Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_UEL_Flag!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_UEL_Flag!","text":"set_UEL_Flag!(value::ST8C, val) -> Any\n\n\nSet ST8C UEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VB1_max!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_VB1_max!","text":"set_VB1_max!(value::ST8C, val) -> Any\n\n\nSet ST8C VB1_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VB2_max!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_VB2_max!","text":"set_VB2_max!(value::ST8C, val) -> Any\n\n\nSet ST8C VB2_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ST8C, val) -> Any\n\n\nSet ST8C V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ST8C, val) -> Any\n\n\nSet ST8C Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vpi_lim!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Vpi_lim!","text":"set_Vpi_lim!(value::ST8C, val) -> Any\n\n\nSet ST8C Vpi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ST8C, val) -> Any\n\n\nSet ST8C Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_X_l!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_X_l!","text":"set_X_l!(value::ST8C, val) -> Any\n\n\nSet ST8C X_l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ST8C, val) -> Any\n\n\nSet ST8C ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ST8C, val) -> Any\n\n\nSet ST8C states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_θ_p!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_θ_p!","text":"set_θ_p!(value::ST8C, val) -> Any\n\n\nSet ST8C θ_p.\n\n\n\n\n\n","category":"method"},{"location":"how_to/parse_dynamic_data/#dyr_data","page":"...parse PSS/e dynamic data","title":"Parsing PSS/e dynamic data","text":"","category":"section"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"A PowerSystems.jl system can be created using a .RAW and a .DYR file. In this example we will create a three bus system from these example files:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"using PowerSystems\nfile_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"tutorials_data\")\nRAW_dir = joinpath(file_dir, \"ThreeBusNetwork.raw\")\nDYR_dir = joinpath(file_dir, \"TestGENCLS.dyr\")","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"The data in the RAW file defines a three bus system with three generators, three loads and three branches:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"0, 100, 33, 0, 0, 60 / 24-Apr-2020 19:28:39 - MATPOWER 7.0.1-dev\n\n\n 101, 'BUS 1 ', 138, 3, 1, 1, 1, 1.02, 0, 1.1, 0.9, 1.1, 0.9\n 102, 'BUS 2 ', 138, 2, 1, 1, 1, 1.0142, 0, 1.1, 0.9, 1.1, 0.9\n 103, 'BUS 3 ', 138, 2, 1, 1, 1, 1.0059, 0, 1.1, 0.9, 1.1, 0.9\n0 / END OF BUS DATA, BEGIN LOAD DATA\n 101, 1, 1, 1, 1, 100, 20, 0, 0, 0, 0, 1, 1, 0\n 102, 1, 1, 1, 1, 70, 10, 0, 0, 0, 0, 1, 1, 0\n 103, 1, 1, 1, 1, 50, 10, 0, 0, 0, 0, 1, 1, 0\n0 / END OF LOAD DATA, BEGIN FIXED SHUNT DATA\n0 / END OF FIXED SHUNT DATA, BEGIN GENERATOR DATA\n 101, 1, 20, 0, 100, -100, 1.02, 0, 100, 0, 0, 0, 0, 1, 1, 100, 318, 0, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1\n 102, 1, 100, 0, 100, -100, 1.0142, 0, 100, 0, 0.7, 0, 0, 1, 1, 100, 318, 0, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1\n 103, 1, 100, 0, 100, -100, 1.0059, 0, 100, 0, 0.2, 0, 0, 1, 1, 100, 318, 0, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1\n0 / END OF GENERATOR DATA, BEGIN BRANCH DATA\n 101, 103, 1, 0.01000, 0.12, 0.0, 250, 250, 250, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1\n 101, 102, 1, 0.01000, 0.12, 0.0, 250, 250, 250, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1\n 102, 103, 1, 0.01000, 0.12, 0.0, 250, 250, 250, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1\n0 / END OF BRANCH DATA, BEGIN TRANSFORMER DATA\n0 / END OF TRANSFORMER DATA, BEGIN AREA DATA\n0 / END OF AREA DATA, BEGIN TWO-TERMINAL DC DATA\n0 / END OF TWO-TERMINAL DC DATA, BEGIN VOLTAGE SOURCE CONVERTER DATA\n0 / END OF VOLTAGE SOURCE CONVERTER DATA, BEGIN IMPEDANCE CORRECTION DATA\n0 / END OF IMPEDANCE CORRECTION DATA, BEGIN MULTI-TERMINAL DC DATA\n0 / END OF MULTI-TERMINAL DC DATA, BEGIN MULTI-SECTION LINE DATA\n0 / END OF MULTI-SECTION LINE DATA, BEGIN ZONE DATA\n0 / END OF ZONE DATA, BEGIN INTER-AREA TRANSFER DATA\n0 / END OF INTER-AREA TRANSFER DATA, BEGIN OWNER DATA\n0 / END OF OWNER DATA, BEGIN FACTS CONTROL DEVICE DATA\n0 / END OF FACTS CONTROL DEVICE DATA, BEGIN SWITCHED SHUNT DATA\n0 / END OF SWITCHED SHUNT DATA, BEGIN GNE DEVICE DATA\n0 / END OF GNE DEVICE DATA, BEGIN INDUCTION MACHINE DATA\n0 / END OF INDUCTION MACHINE DATA\nQ","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"The dynamic data for the generators is provided in the DYR file:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":" 101 'GENROE' 1 8.000000 0.030000 0.400000 0.050000 6.500000 0.000000 1.800000\n 1.700000 0.300000 0.550000 0.250000 0.200000 0.039200 0.267200 /\n 101 'ESST1A' 1 1 1 0.01 99 -99 1 10 1 1 200 0 4 -4 4 -4 0 0 1 0 3 /\n 102 'GENCLS' 1 0.0 0.0 /\n 103 'GENCLS' 1 3.1 2.0 /","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"That assigns a GENROU generator and a ESST1A voltage regulator at the generator located at bus 101, while classic machine models for the generators located at bus 102 and 103.","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"To create the System in PowerSystems.jl, we pass both files directories:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"dyn_system = System(RAW_dir, DYR_dir; runchecks = false)","category":"page"},{"location":"how_to/parse_dynamic_data/#Supported-PSS/e-Models","page":"...parse PSS/e dynamic data","title":"Supported PSS/e Models","text":"","category":"section"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"PSS/e's dynamic model library is extensive, we currently support parsing a limited amount of models out of the box.","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"Machine models AVR Models Prime Movers PSS models\nGENSAE IEEET1 HYGOV IEEEST\nGENSAL ESDC1A IEEEG1 \nGENROE ESAC1A GGOV1 \nGENCLS ESST4B \nGENROU EXAC2 \n EXPIC1 \n ESAC6A \n EXAC1 \n SCRX \n ESDC2A ","category":"page"},{"location":"how_to/parse_dynamic_data/#Common-Issue:-Unique-Bus-Names","page":"...parse PSS/e dynamic data","title":"Common Issue: Unique Bus Names","text":"","category":"section"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"Please note that while PSS/e does not enforce unique bus names, PowerSystems.jl does. To reparse bus names to comply with this requirement the bus_name_formatter *kwarg can be used in System() as shown in the example below:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"dyn_system = System(\n RAW_dir,\n DYR_dir;\n bus_name_formatter = x -> strip(string(x[\"name\"])) * \"-\" * string(x[\"index\"]),\n)","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"In this example the anonymous function x -> strip(string(x[\"name\"])) * \"-\" * string(x[\"index\"]) takes the bus name and index from PSSe and concatenates them to produce the name.","category":"page"},{"location":"how_to/parse_dynamic_data/#See-also:","page":"...parse PSS/e dynamic data","title":"See also:","text":"","category":"section"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"Parsing Matpower or PSS/e RAW Files\nParsing table data (CSV Files)\nParsing time series","category":"page"},{"location":"model_library/generated_ThermalMultiStart/#ThermalMultiStart","page":"ThermalMultiStart","title":"ThermalMultiStart","text":"","category":"section"},{"location":"model_library/generated_ThermalMultiStart/","page":"ThermalMultiStart","title":"ThermalMultiStart","text":"Modules = [PowerSystems]\nPages = [\"generated/ThermalMultiStart.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.ThermalMultiStart","page":"ThermalMultiStart","title":"PowerSystems.ThermalMultiStart","text":"mutable struct ThermalMultiStart <: ThermalGen\n name::String\n available::Bool\n status::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n fuel::ThermalFuels\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n power_trajectory::Union{Nothing, StartUpShutDown}\n time_limits::Union{Nothing, UpDown}\n start_time_limits::Union{Nothing, StartUpStages}\n start_types::Int\n operation_cost::Union{ThermalGenerationCost, MarketBidCost}\n base_power::Float64\n services::Vector{Service}\n time_at_status::Float64\n must_run::Bool\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA thermal generator, such as a fossil fuel or nuclear generator, that can start-up again from a hot, warm, or cold state.\n\nThermalMultiStart 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nstatus::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nfuel::ThermalFuels: Prime mover fuel according to EIA 923. Options are listed here\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}:, validation range: (0, nothing)\npower_trajectory::Union{Nothing, StartUpShutDown}: Power trajectory the unit will take during the start-up and shut-down ramp process, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nstart_time_limits::Union{Nothing, StartUpStages}: Time limits for start-up based on turbine temperature in hours\nstart_types::Int: Number of start-up based on turbine temperature, where 1 = hot, 2 = warm, and 3 = cold, validation range: (1, 3)\noperation_cost::Union{ThermalGenerationCost, MarketBidCost}: OperationalCost of generation\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ntime_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status\nmust_run::Bool: (default: false) Set to true if the unit is must run\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ThermalMultiStart/#InfrastructureSystems.get_name-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"InfrastructureSystems.get_name","text":"get_name(value::ThermalMultiStart) -> String\n\n\nGet ThermalMultiStart name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_active_power-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_active_power","text":"get_active_power(value::ThermalMultiStart) -> Any\n\n\nGet ThermalMultiStart active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_active_power_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::ThermalMultiStart\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet ThermalMultiStart active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_available-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_available","text":"get_available(value::ThermalMultiStart) -> Bool\n\n\nGet ThermalMultiStart available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_base_power-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_base_power","text":"get_base_power(value::ThermalMultiStart) -> Float64\n\n\nGet ThermalMultiStart base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_bus-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_bus","text":"get_bus(value::ThermalMultiStart) -> ACBus\n\n\nGet ThermalMultiStart bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_dynamic_injector-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::ThermalMultiStart\n) -> Union{Nothing, DynamicInjection}\n\n\nGet ThermalMultiStart dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_ext-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_ext","text":"get_ext(value::ThermalMultiStart) -> Dict{String, Any}\n\n\nGet ThermalMultiStart ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_fuel-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_fuel","text":"get_fuel(value::ThermalMultiStart) -> ThermalFuels\n\n\nGet ThermalMultiStart fuel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_must_run-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_must_run","text":"get_must_run(value::ThermalMultiStart) -> Bool\n\n\nGet ThermalMultiStart must_run.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_operation_cost-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::ThermalMultiStart\n) -> Union{MarketBidCost, ThermalGenerationCost}\n\n\nGet ThermalMultiStart operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_power_trajectory-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_power_trajectory","text":"get_power_trajectory(\n value::ThermalMultiStart\n) -> Union{Nothing, NamedTuple{(:startup, :shutdown), <:Tuple{Any, Any}}}\n\n\nGet ThermalMultiStart power_trajectory.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_prime_mover_type-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::ThermalMultiStart\n) -> PrimeMovers\n\n\nGet ThermalMultiStart prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_ramp_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::ThermalMultiStart\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet ThermalMultiStart ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_rating-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_rating","text":"get_rating(value::ThermalMultiStart) -> Any\n\n\nGet ThermalMultiStart rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_reactive_power-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::ThermalMultiStart) -> Any\n\n\nGet ThermalMultiStart reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_reactive_power_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::ThermalMultiStart\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet ThermalMultiStart reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_services-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_services","text":"get_services(value::ThermalMultiStart) -> Vector{Service}\n\n\nGet ThermalMultiStart services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_start_time_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_start_time_limits","text":"get_start_time_limits(\n value::ThermalMultiStart\n) -> Union{Nothing, @NamedTuple{hot::Float64, warm::Float64, cold::Float64}}\n\n\nGet ThermalMultiStart start_time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_start_types-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_start_types","text":"get_start_types(value::ThermalMultiStart) -> Int64\n\n\nGet ThermalMultiStart start_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_status-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_status","text":"get_status(value::ThermalMultiStart) -> Bool\n\n\nGet ThermalMultiStart status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_time_at_status-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_time_at_status","text":"get_time_at_status(value::ThermalMultiStart) -> Float64\n\n\nGet ThermalMultiStart time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_time_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::ThermalMultiStart\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet ThermalMultiStart time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_active_power!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_active_power_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::ThermalMultiStart,\n val\n) -> Any\n\n\nSet ThermalMultiStart active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_available!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_available!","text":"set_available!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_base_power!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_bus!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_bus!","text":"set_bus!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_ext!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_ext!","text":"set_ext!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_fuel!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_fuel!","text":"set_fuel!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart fuel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_must_run!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_must_run!","text":"set_must_run!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart must_run.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_operation_cost!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_power_trajectory!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_power_trajectory!","text":"set_power_trajectory!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart power_trajectory.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_prime_mover_type!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_ramp_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_rating!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_rating!","text":"set_rating!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_reactive_power!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_reactive_power_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::ThermalMultiStart,\n val\n) -> Any\n\n\nSet ThermalMultiStart reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_services!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_services!","text":"set_services!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_start_time_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_start_time_limits!","text":"set_start_time_limits!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart start_time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_start_types!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_start_types!","text":"set_start_types!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart start_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_status!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_status!","text":"set_status!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_time_at_status!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_time_at_status!","text":"set_time_at_status!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_time_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#CSVGN1","page":"CSVGN1","title":"CSVGN1","text":"","category":"section"},{"location":"model_library/generated_CSVGN1/","page":"CSVGN1","title":"CSVGN1","text":"Modules = [PowerSystems]\nPages = [\"generated/CSVGN1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_CSVGN1/#PowerSystems.CSVGN1","page":"CSVGN1","title":"PowerSystems.CSVGN1","text":"mutable struct CSVGN1 <: DynamicInjection\n name::String\n K::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n T5::Float64\n Rmin::Float64\n Vmax::Float64\n Vmin::Float64\n CBase::Float64\n base_power::Float64\n ext::Dict{String, Any}\n R_th::Float64\n X_th::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of static shunt compensator: CSVGN1 in PSSE\n\nArguments\n\nname::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\nK::Float64: Gain in pu (DEVICE_BASE), validation range: (0, nothing)\nT1::Float64: Time constant in s, validation range: (0, nothing)\nT2::Float64: Time constant in s, validation range: (0, nothing)\nT3::Float64: Time constant in s, validation range: (eps(), nothing)\nT4::Float64: Time constant in s, validation range: (0, nothing)\nT5::Float64: Time constant in s, validation range: (0, nothing)\nRmin::Float64: Reactor minimum Mvar, validation range: (0, nothing)\nVmax::Float64: Maximum voltage in pu, validation range: (0, nothing)\nVmin::Float64: Minimum voltage in pu, validation range: (0, nothing)\nCBase::Float64: Capacitor (MVAR), validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\next::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.\nR_th::Float64: Source Thevenin resistance\nX_th::Float64: Source Thevenin reactance\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nthy: thyristor,\nvr1: regulator output 1,\nvr2: regulator output 2\n\nn_states::Int: (Do not modify.) CSVGN1 has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_CSVGN1/#InfrastructureSystems.get_name-Tuple{CSVGN1}","page":"CSVGN1","title":"InfrastructureSystems.get_name","text":"get_name(value::CSVGN1) -> String\n\n\nGet CSVGN1 name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_CBase-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_CBase","text":"get_CBase(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 CBase.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_K-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_K","text":"get_K(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_R_th-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_R_th","text":"get_R_th(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_Rmin-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_Rmin","text":"get_Rmin(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 Rmin.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T1-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T1","text":"get_T1(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T2-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T2","text":"get_T2(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T3-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T3","text":"get_T3(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T4-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T4","text":"get_T4(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T5-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T5","text":"get_T5(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_Vmax-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_Vmax","text":"get_Vmax(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 Vmax.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_Vmin-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_Vmin","text":"get_Vmin(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 Vmin.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_X_th-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_X_th","text":"get_X_th(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_base_power-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_base_power","text":"get_base_power(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_ext-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_ext","text":"get_ext(value::CSVGN1) -> Dict{String, Any}\n\n\nGet CSVGN1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_n_states-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_n_states","text":"get_n_states(value::CSVGN1) -> Int64\n\n\nGet CSVGN1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_states-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_states","text":"get_states(value::CSVGN1) -> Vector{Symbol}\n\n\nGet CSVGN1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_CBase!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_CBase!","text":"set_CBase!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 CBase.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_K!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_K!","text":"set_K!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_R_th!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_R_th!","text":"set_R_th!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_Rmin!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_Rmin!","text":"set_Rmin!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 Rmin.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T1!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T1!","text":"set_T1!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T2!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T2!","text":"set_T2!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T3!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T3!","text":"set_T3!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T4!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T4!","text":"set_T4!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T5!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T5!","text":"set_T5!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_Vmax!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_Vmax!","text":"set_Vmax!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 Vmax.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_Vmin!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_Vmin!","text":"set_Vmin!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 Vmin.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_X_th!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_X_th!","text":"set_X_th!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_base_power!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_ext!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_ext!","text":"set_ext!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#MarketBidCost","page":"MarketBidCost","title":"MarketBidCost","text":"","category":"section"},{"location":"model_library/market_bid_cost/","page":"MarketBidCost","title":"MarketBidCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/MarketBidCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/market_bid_cost/#PowerSystems.MarketBidCost","page":"MarketBidCost","title":"PowerSystems.MarketBidCost","text":"mutable struct MarketBidCost <: OperationalCost\n\nno_load_cost::Union{Nothing, Float64, TimeSeriesKey}: No load cost\nstart_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\nshut_down::Float64: Shut-down cost\nincremental_offer_curves::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}: Sell Offer Curves data, which can be a time series of PiecewiseStepData or a CostCurve of PiecewiseIncrementalCurve\ndecremental_offer_curves::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}: Buy Offer Curves data, which can be a time series of PiecewiseStepData or a CostCurve of PiecewiseIncrementalCurve\nincremental_initial_input::Union{Nothing, TimeSeriesKey}: If using a time series for incrementaloffercurves, this is a time series of Float64 representing the initial_input\ndecremental_initial_input::Union{Nothing, TimeSeriesKey}: If using a time series for decrementaloffercurves, this is a time series of Float64 representing the initial_input\nancillary_service_offers::Vector{Service}: Bids for the ancillary services\n\nMarketBidCost(no_load_cost, start_up, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)\nMarketBidCost(; no_load_cost, start_up, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)\nMarketBidCost(no_load_cost, start_up::Real, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)\n\nAn 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.\n\n\n\n\n\n","category":"type"},{"location":"model_library/market_bid_cost/#PowerSystems.MarketBidCost-Tuple{Any, Real, Any}","page":"MarketBidCost","title":"PowerSystems.MarketBidCost","text":"MarketBidCost(\n no_load_cost,\n start_up::Real,\n shut_down;\n incremental_offer_curves,\n decremental_offer_curves,\n incremental_initial_input,\n decremental_initial_input,\n ancillary_service_offers\n) -> MarketBidCost\n\n\nAccepts a single start_up value to use as the hot value, with warm and cold set to 0.0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.MarketBidCost-Tuple{Float64, Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}, Vararg{Any, 4}}","page":"MarketBidCost","title":"PowerSystems.MarketBidCost","text":"MarketBidCost(\n no_load_cost::Float64,\n start_up::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey},\n shut_down,\n incremental_offer_curves,\n decremental_offer_curves,\n ancillary_service_offers\n) -> MarketBidCost\n\n\nAuxiliary Constructor for TestData\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.MarketBidCost-Tuple{Integer, Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}, Vararg{Any, 6}}","page":"MarketBidCost","title":"PowerSystems.MarketBidCost","text":"MarketBidCost(\n no_load_cost::Integer,\n start_up::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey},\n shut_down,\n incremental_offer_curves,\n decremental_offer_curves,\n incremental_initial_input,\n decremental_initial_input,\n ancillary_service_offers\n) -> MarketBidCost\n\n\nAuxiliary Constructor for Deserialization with Integer at no load cost\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_ancillary_service_offers-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_ancillary_service_offers","text":"get_ancillary_service_offers(\n value::MarketBidCost\n) -> Vector{Service}\n\n\nGet MarketBidCost ancillary_service_offers.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_decremental_initial_input-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_decremental_initial_input","text":"get_decremental_initial_input(\n value::MarketBidCost\n) -> Union{Nothing, TimeSeriesKey}\n\n\nGet MarketBidCost decremental_initial_input.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_decremental_offer_curves-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_decremental_offer_curves","text":"get_decremental_offer_curves(\n value::MarketBidCost\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}\n\n\nGet MarketBidCost decremental_offer_curves.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_incremental_initial_input-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_incremental_initial_input","text":"get_incremental_initial_input(\n value::MarketBidCost\n) -> Union{Nothing, TimeSeriesKey}\n\n\nGet MarketBidCost incremental_initial_input.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_incremental_offer_curves-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_incremental_offer_curves","text":"get_incremental_offer_curves(\n value::MarketBidCost\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}\n\n\nGet MarketBidCost incremental_offer_curves.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_no_load_cost-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_no_load_cost","text":"get_no_load_cost(\n value::MarketBidCost\n) -> Union{Nothing, Float64, TimeSeriesKey}\n\n\nGet MarketBidCost no_load_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_shut_down-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_shut_down","text":"get_shut_down(value::MarketBidCost) -> Float64\n\n\nGet MarketBidCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_start_up-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_start_up","text":"get_start_up(\n value::MarketBidCost\n) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}\n\n\nGet MarketBidCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.make_market_bid_curve-Tuple{PiecewiseStepData, Float64}","page":"MarketBidCost","title":"PowerSystems.make_market_bid_curve","text":"make_market_bid_curve(\n data::PiecewiseStepData,\n initial_input::Float64;\n power_units,\n input_at_zero\n) -> CostCurve{PiecewiseIncrementalCurve}\n\n\nMake 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.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.make_market_bid_curve-Tuple{Vector{Float64}, Vector{Float64}, Float64}","page":"MarketBidCost","title":"PowerSystems.make_market_bid_curve","text":"make_market_bid_curve(\n powers::Vector{Float64},\n marginal_costs::Vector{Float64},\n initial_input::Float64;\n power_units,\n input_at_zero\n) -> CostCurve{PiecewiseIncrementalCurve}\n\n\nMake a CostCurve{PiecewiseIncrementalCurve} suitable for inclusion in a MarketBidCost from a vector of power values, a vector of marginal costs, a float of initial input, and an optional units system and input at zero.\n\nExamples\n\nmbc = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0)\nmbc2 = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0; input_at_zero = 10.0)\nmbc3 = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0; power_inputs = UnitSystem.NATURAL_UNITS)\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_ancillary_service_offers!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_ancillary_service_offers!","text":"set_ancillary_service_offers!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost ancillary_service_offers.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_decremental_initial_input!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_decremental_initial_input!","text":"set_decremental_initial_input!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost decremental_initial_input.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_decremental_offer_curves!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_decremental_offer_curves!","text":"set_decremental_offer_curves!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost incremental_offer_curves.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_incremental_initial_input!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_incremental_initial_input!","text":"set_incremental_initial_input!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost incremental_initial_input.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_incremental_offer_curves!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_incremental_offer_curves!","text":"set_incremental_offer_curves!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost incremental_offer_curves.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_no_load_cost!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_no_load_cost!","text":"set_no_load_cost!(value::MarketBidCost, val) -> Any\n\n\nSet MarketBidCost no_load_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_shut_down!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_shut_down!","text":"set_shut_down!(value::MarketBidCost, val) -> Any\n\n\nSet MarketBidCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_start_up!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_start_up!","text":"set_start_up!(\n value::MarketBidCost,\n val\n) -> NamedTuple{(:hot, :warm, :cold), <:Tuple{Any, Float64, Float64}}\n\n\nSet MarketBidCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_start_up!-Tuple{MarketBidCost, Real}","page":"MarketBidCost","title":"PowerSystems.set_start_up!","text":"set_start_up!(\n value::MarketBidCost,\n val::Real\n) -> NamedTuple{(:hot, :warm, :cold), <:Tuple{Any, Float64, Float64}}\n\n\nAuxiliary Method for setting up start up that are not multi-start\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Public-API-Reference","page":"Public API","title":"Public API Reference","text":"","category":"section"},{"location":"api/public/#Modeling","page":"Public API","title":"Modeling","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"PowerSystems.jl\",\n \"branches.jl\",\n \"components.jl\",\n \"injection.jl\",\n \"devices.jl\",\n \"loads.jl\",\n \"supplemental_constructors\",\n \"generation.jl\",\n \"reserves.jl\",\n \"storage.jl\",\n \"services.jl\",\n \"outages.jl\",\n \"topological_elements.jl\",\n \"dynamic_models.jl\",\n \"static_models.jl\",\n \"subsystems.jl\",\n \"static_injection_subsystem.jl\",\n \"dynamic_models.jl\",\n \"operational_cost.jl\",\n \"cost_function_timeseries.jl\",\n \"definitions.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"api/public/#PowerSystems.PowerSystems","page":"Public API","title":"PowerSystems.PowerSystems","text":"Module for constructing self-contained power system objects.\n\n\n\n\n\n","category":"module"},{"location":"api/public/#PowerSystems.Component","page":"Public API","title":"PowerSystems.Component","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Device","page":"Public API","title":"PowerSystems.Device","text":"Supertype for \"devices\" (bus, line, etc.) \n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ACBranch","page":"Public API","title":"PowerSystems.ACBranch","text":"Supertype for all AC branches (branches connecting at least one AC node)\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Branch","page":"Public API","title":"PowerSystems.Branch","text":"Supertype for all branches\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.DCBranch","page":"Public API","title":"PowerSystems.DCBranch","text":"Supertype for all DC branches (branches that connect only DC nodes)\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_base_power-Tuple{Component}","page":"Public API","title":"PowerSystems.get_base_power","text":"get_base_power(c::Component) -> Float64\n\n\nDefault behavior of a component. If there is no base_power field, assume is in the system's base power.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_dynamic_injector!-Union{Tuple{U}, Tuple{T}, Tuple{T, U}} where {T<:StaticInjection, U<:Union{Nothing, DynamicInjection}}","page":"Public API","title":"PowerSystems.set_dynamic_injector!","text":"set_dynamic_injector!(\n static_injector::StaticInjection,\n dynamic_injector::Union{Nothing, DynamicInjection}\n)\n\n\nAny StaticInjection struct that wants to support dynamic injectors must implement this method to set the value.\n\nThe method is only for internal uses.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.clear_services!-Tuple{Device}","page":"Public API","title":"PowerSystems.clear_services!","text":"clear_services!(device::Device)\n\n\nRemove all services attached to the device.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_service-Tuple{Device, Service}","page":"Public API","title":"PowerSystems.has_service","text":"has_service(device::Device, service::Service) -> Bool\n\n\nReturn true if the service is attached to the device.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_service-Union{Tuple{T}, Tuple{Device, Type{T}}} where T<:Service","page":"Public API","title":"PowerSystems.has_service","text":"has_service(device::Device, _::Type{T<:Service}) -> Bool\n\n\nReturn true if a service with type T is attached to the device.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_service!-Tuple{Device, Service}","page":"Public API","title":"PowerSystems.remove_service!","text":"remove_service!(device::Device, service::Service)\n\n\nRemove a service from a device.\n\nThrows ArgumentError if the service is not attached to the device.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.ControllableLoad","page":"Public API","title":"PowerSystems.ControllableLoad","text":"Supertype for all controllable loads\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ElectricLoad","page":"Public API","title":"PowerSystems.ElectricLoad","text":"Supertype for all electric loads\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.StaticLoad","page":"Public API","title":"PowerSystems.StaticLoad","text":"Supertype for all static electric loads\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Generator","page":"Public API","title":"PowerSystems.Generator","text":"Supertype for all generation technologies\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.HydroGen","page":"Public API","title":"PowerSystems.HydroGen","text":"Supertype for all Hydropower generation technologies\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.RenewableGen","page":"Public API","title":"PowerSystems.RenewableGen","text":"Supertype for all renewable generation technologies\n\nRequires the implementation of get_ratingand get_power_factor methods\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ThermalGen","page":"Public API","title":"PowerSystems.ThermalGen","text":"Supertype for all Thermal generation technologies\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_max_active_power-Tuple{T} where T<:RenewableGen","page":"Public API","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(d::RenewableGen) -> Any\n\n\nReturn the max active power for the Renewable Generation calculated as the rating * power_factor\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_max_reactive_power-Tuple{T} where T<:RenewableGen","page":"Public API","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(d::RenewableGen) -> Any\n\n\nReturn the max reactive power for the Renewable Generation calculated as the rating * sin(acos(power_factor))\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.Reserve","page":"Public API","title":"PowerSystems.Reserve","text":"A reserve product to be able to respond to unexpected disturbances, such as the sudden loss of a transmission line or generator.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ReserveDirection","page":"Public API","title":"PowerSystems.ReserveDirection","text":"Used to specify if a Reserve is upwards, downwards, or symmetric\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ReserveDown","page":"Public API","title":"PowerSystems.ReserveDown","text":"A downwards reserve to decrease generation or increase load\n\nDownwards reserves are used when total load falls below its expected level, typically due to forecast errors or contingencies. Not work\n\nA Reserve can be specified as a ReserveDown when it is defined.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ReserveSymmetric","page":"Public API","title":"PowerSystems.ReserveSymmetric","text":"A symmetric reserve, procuring the same quantity (MW) of both upwards and downwards reserves\n\nA symmetric reserve is a special case. ReserveUp and ReserveDown can be used individually to specify different quantities of upwards and downwards reserves, respectively.\n\nA Reserve can be specified as a ReserveSymmetric when it is defined.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ReserveUp","page":"Public API","title":"PowerSystems.ReserveUp","text":"An upwards reserve to increase generation or reduce load\n\nUpwards reserves are used when total load exceeds its expected level, typically due to forecast errors or contingencies.\n\nA Reserve can be specified as a ReserveUp when it is defined.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Storage","page":"Public API","title":"PowerSystems.Storage","text":"Supertype for energy storage technologies\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Service","page":"Public API","title":"PowerSystems.Service","text":"Supertype for all system services\n\nServices (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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.GeometricDistributionForcedOutage","page":"Public API","title":"PowerSystems.GeometricDistributionForcedOutage","text":"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.\n\nArguments\n\ntime_to_recovery::Int: Time elapsed to recovery after a failure in Milliseconds.\noutage_transition_probability::Float64: Characterizes the probability of failure (1 - p) in the geometric distribution.\ninternal::InfrastructureSystemsInternal: power system internal reference, do not modify\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.PlannedOutage","page":"Public API","title":"PowerSystems.PlannedOutage","text":"Attribute that contains information regarding planned outages.\n\nArguments\n\noutage_schedule::String: String name of the time series used for the scheduled outages\ninternal::InfrastructureSystemsInternal: power system internal reference, do not modify\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.TimeSeriesForcedOutage","page":"Public API","title":"PowerSystems.TimeSeriesForcedOutage","text":"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.\n\nArguments\n\noutage_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.\ninternal::InfrastructureSystemsInternal: power system internal reference, do not modify\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_mean_time_to_recovery-Tuple{GeometricDistributionForcedOutage}","page":"Public API","title":"PowerSystems.get_mean_time_to_recovery","text":"get_mean_time_to_recovery(\n value::GeometricDistributionForcedOutage\n) -> Float64\n\n\nGet GeometricDistributionForcedOutage time_to_recovery.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_outage_schedule-Tuple{PlannedOutage}","page":"Public API","title":"PowerSystems.get_outage_schedule","text":"get_outage_schedule(value::PlannedOutage) -> String\n\n\nGet PlannedOutage outage_schedule.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_outage_transition_probability-Tuple{GeometricDistributionForcedOutage}","page":"Public API","title":"PowerSystems.get_outage_transition_probability","text":"get_outage_transition_probability(\n value::GeometricDistributionForcedOutage\n) -> Float64\n\n\nGet GeometricDistributionForcedOutage outage_transition_probability.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.AggregationTopology","page":"Public API","title":"PowerSystems.AggregationTopology","text":"Represents a geographical region of system components.\n\nAll subtypes must implement the method get_aggregation_topology_accessor.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Bus","page":"Public API","title":"PowerSystems.Bus","text":"Abstract type to represent any type of Bus, AC or DC.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Topology","page":"Public API","title":"PowerSystems.Topology","text":"Abstract type to represent the structure and interconnectedness of the system\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_aggregation_topology_accessor-Union{Tuple{Type{T}}, Tuple{T}} where T<:AggregationTopology","page":"Public API","title":"PowerSystems.get_aggregation_topology_accessor","text":"get_aggregation_topology_accessor(\n _::Type{T<:AggregationTopology}\n) -> typeof(get_load_zone)\n\n\nReturn the method to be called on a ACBus to get its AggregationTopology value for this type.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.StaticInjection","page":"Public API","title":"PowerSystems.StaticInjection","text":"Abstract type for devices that inject power or current\n\nA static injection is a steady state injection, such as modeling the output power of a generator held constant over a five-minute period.\n\nMany StaticInjection models can accept a DynamicInjection model as an optional add-on for conducting dynamic simulations.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.add_component_to_subsystem!-Tuple{System, AbstractString, Component}","page":"Public API","title":"PowerSystems.add_component_to_subsystem!","text":"add_component_to_subsystem!(\n sys::System,\n subsystem_name::AbstractString,\n component::Component\n)\n\n\nAdd a component to a subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_subsystem!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.add_subsystem!","text":"add_subsystem!(sys::System, subsystem_name::AbstractString)\n\n\nAdd a new subsystem to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_assigned_subsystems-Tuple{System, Component}","page":"Public API","title":"PowerSystems.get_assigned_subsystems","text":"get_assigned_subsystems(\n sys::System,\n component::Component\n) -> Vector\n\n\nReturn a Vector of subsystem names that contain the component.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_num_subsystems-Tuple{System}","page":"Public API","title":"PowerSystems.get_num_subsystems","text":"get_num_subsystems(sys::System) -> Int64\n\n\nReturn the number of subsystems stored in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_subsystem_components-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.get_subsystem_components","text":"get_subsystem_components(\n sys::System,\n subsystem_name::AbstractString\n) -> Base.Generator{Set{Base.UUID}, InfrastructureSystems.var\"#419#420\"{InfrastructureSystems.SystemData}}\n\n\nReturn a Generator of all components in the subsystem.\n\nThrows ArgumentError if the subsystem name is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_subsystems-Tuple{System}","page":"Public API","title":"PowerSystems.get_subsystems","text":"get_subsystems(\n sys::System\n) -> Base.KeySet{String, Dict{String, Set{Base.UUID}}}\n\n\nReturn an iterator of all subsystem names in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_component-Tuple{System, AbstractString, Component}","page":"Public API","title":"PowerSystems.has_component","text":"has_component(\n sys::System,\n subsystem_name::AbstractString,\n component::Component\n) -> Bool\n\n\nReturn true if the component is in the subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_subsystems-Tuple{System}","page":"Public API","title":"PowerSystems.has_subsystems","text":"has_subsystems(sys::System) -> Bool\n\n\nReturn true if the system has one or more subsystems.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.is_assigned_to_subsystem-Tuple{System, Component, AbstractString}","page":"Public API","title":"PowerSystems.is_assigned_to_subsystem","text":"is_assigned_to_subsystem(\n sys::System,\n component::Component,\n subsystem_name::AbstractString\n) -> Bool\n\n\nReturn true if the component is assigned to the subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.is_assigned_to_subsystem-Tuple{System, Component}","page":"Public API","title":"PowerSystems.is_assigned_to_subsystem","text":"is_assigned_to_subsystem(\n sys::System,\n component::Component\n) -> Bool\n\n\nReturn true if the component is assigned to any subsystems.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_component_from_subsystem!-Tuple{System, AbstractString, Component}","page":"Public API","title":"PowerSystems.remove_component_from_subsystem!","text":"remove_component_from_subsystem!(\n sys::System,\n subsystem_name::AbstractString,\n component::Component\n)\n\n\nRemove a component from a subsystem.\n\nThrows ArgumentError if the subsystem name or component is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_subsystem!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.remove_subsystem!","text":"remove_subsystem!(\n sys::System,\n subsystem_name::AbstractString\n)\n\n\nRemove a subsystem from the system.\n\nThrows ArgumentError if the subsystem name is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.StaticInjectionSubsystem","page":"Public API","title":"PowerSystems.StaticInjectionSubsystem","text":"Abstract type for a subsystem that contains multiple instances of StaticInjection\n\nSubtypes must implement:\n\nget_subcomponents(subsystem::StaticInjectionSubsystem)\n\nThe subcomponents in subtypes must be attached to the System as masked components.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.copy_subcomponent_time_series!-Tuple{StaticInjectionSubsystem, Component}","page":"Public API","title":"PowerSystems.copy_subcomponent_time_series!","text":"copy_subcomponent_time_series!(\n subsystem::StaticInjectionSubsystem,\n subcomponent::Component\n)\n\n\nEfficiently add all time series data in the subcomponent to the subsystem by copying the underlying references.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.DynamicComponent","page":"Public API","title":"PowerSystems.DynamicComponent","text":"Abstract type for all components used to compose a DynamicInjection device\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.DynamicInjection","page":"Public API","title":"PowerSystems.DynamicInjection","text":"Abstract type for all Dynamic Devices\n\nA dynamic injection is the continuous time response of a generator, typically modeled with differential equations. \n\nDynamicInjection components can added on to StaticInjection components, which together define all the information needed to model the device in a dynamic simulation.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_dynamic_components-Tuple{T} where T<:DynamicInjection","page":"Public API","title":"PowerSystems.get_dynamic_components","text":"get_dynamic_components(\n device::DynamicInjection\n) -> 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})}\n\n\nReturn all the dynamic components of a DynamicInjection device\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_states_types-Tuple{DynamicComponent}","page":"Public API","title":"PowerSystems.get_states_types","text":"get_states_types(d::DynamicComponent) -> Vector{StateTypes}\n\n\nDefault implementation of get_state_types for dynamic components. Assumes all states are\nDifferential\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.OperationalCost","page":"Public API","title":"PowerSystems.OperationalCost","text":"Supertype for operational cost representations\n\nCurrent concrete types include:\n\nThermalGenerationCost\nHydroGenerationCost\nRenewableGenerationCost\nStorageCost\nLoadCost\nMarketBidCost\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_fuel_cost-Tuple{StaticInjection}","page":"Public API","title":"InfrastructureSystems.get_fuel_cost","text":"get_fuel_cost(\n component::StaticInjection;\n start_time,\n len\n) -> Union{Float64, TimeSeries.TimeArray}\n\n\nGet the fuel cost of the component's variable cost, which must be a FuelCurve.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_decremental_initial_input-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_decremental_initial_input","text":"get_decremental_initial_input(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, TimeSeries.TimeArray}\n\n\nRetrieve the decremental_initial_input for a StaticInjection device with a MarketBidCost.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_decremental_offer_curves-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_decremental_offer_curves","text":"get_decremental_offer_curves(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}\n\n\nRetrieve the decremental_offer_curves 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 or Nothing.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_decremental_variable_cost-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_decremental_variable_cost","text":"get_decremental_variable_cost(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}\n\n\nRetrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (decremental_offer_curves, initial_input, no_load_cost) are 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_incremental_initial_input-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_incremental_initial_input","text":"get_incremental_initial_input(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, TimeSeries.TimeArray}\n\n\nRetrieve the incremental_initial_input for a StaticInjection device with a MarketBidCost.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_incremental_offer_curves-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_incremental_offer_curves","text":"get_incremental_offer_curves(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}\n\n\nRetrieve the incremental_offer_curves 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 or Nothing.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_incremental_variable_cost-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_incremental_variable_cost","text":"get_incremental_variable_cost(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}\n\n\nRetrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (incremental_offer_curves, initial_input, no_load_cost) are 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_no_load_cost-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_no_load_cost","text":"get_no_load_cost(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, Float64, TimeSeries.TimeArray}\n\n\nRetrieve 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 or Nothing.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_services_bid-Tuple{StaticInjection, MarketBidCost, Service}","page":"Public API","title":"PowerSystems.get_services_bid","text":"get_services_bid(\n device::StaticInjection,\n cost::MarketBidCost,\n service::Service;\n start_time,\n len\n) -> TimeSeries.TimeArray\n\n\nReturn 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_start_up-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_start_up","text":"get_start_up(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeries.TimeArray}\n\n\nRetrieve the startup 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_variable_cost-Tuple{ReserveDemandCurve}","page":"Public API","title":"PowerSystems.get_variable_cost","text":"get_variable_cost(\n service::ReserveDemandCurve;\n start_time,\n len\n) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}\n\n\nRetrieve the variable cost data for a ReserveDemandCurve. The user may specify start_time and len and the function returns a TimeArray of CostCurves.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_variable_cost-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_variable_cost","text":"get_variable_cost(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}\n\n\nRetrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (incremental_offer_curves, initial_input, no_load_cost) are 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_decremental_initial_input!-Tuple{System, StaticInjection, Union{Float64, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_decremental_initial_input!","text":"set_decremental_initial_input!(\n sys::System,\n component::StaticInjection,\n data::Union{Float64, TimeSeriesData}\n) -> TimeSeriesKey\n\n\nSet the decremental_initial_input for a StaticInjection device with a MarketBidCost to either a scalar or a time series.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Float64, IS.TimeSeriesData},: the data. If a time series, must be of eltype Float64.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_decremental_variable_cost!-Tuple{System, StaticInjection, Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData}, UnitSystem}","page":"Public API","title":"PowerSystems.set_decremental_variable_cost!","text":"set_decremental_variable_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},\n power_units::UnitSystem\n)\n\n\nSet the decremental variable cost bid for a StaticInjection device with a MarketBidCost.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Nothing, IS.TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}},: the data. If using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.\npower_units::UnitSystem: Units to be used for data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_fuel_cost!-Tuple{System, StaticInjection, Union{Float64, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_fuel_cost!","text":"set_fuel_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Float64, TimeSeriesData}\n) -> Any\n\n\nSet the fuel cost of the component's variable cost, which must be a FuelCurve.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_incremental_initial_input!-Tuple{System, StaticInjection, Union{Float64, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_incremental_initial_input!","text":"set_incremental_initial_input!(\n sys::System,\n component::StaticInjection,\n data::Union{Float64, TimeSeriesData}\n) -> TimeSeriesKey\n\n\nSet the incremental_initial_input for a StaticInjection device with a MarketBidCost to either a scalar or a time series.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Float64, IS.TimeSeriesData},: the data. If a time series, must be of eltype Float64.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_incremental_variable_cost!-Tuple{System, StaticInjection, Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData}, UnitSystem}","page":"Public API","title":"PowerSystems.set_incremental_variable_cost!","text":"set_incremental_variable_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},\n power_units::UnitSystem\n)\n\n\nSet the incremental variable cost bid for a StaticInjection device with a MarketBidCost.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Nothing, IS.TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}},: the data. If using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.\npower_units::UnitSystem: Units to be used for data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_no_load_cost!-Tuple{System, StaticInjection, Union{Float64, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_no_load_cost!","text":"set_no_load_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Float64, TimeSeriesData}\n) -> Union{Float64, TimeSeriesKey}\n\n\nSet the no-load cost for a StaticInjection device with a MarketBidCost to either a scalar or a time series.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Float64, IS.TimeSeriesData},: the data. If a time series, must be of eltype Float64.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_service_bid!-Tuple{System, StaticInjection, Service, TimeSeriesData, UnitSystem}","page":"Public API","title":"PowerSystems.set_service_bid!","text":"set_service_bid!(\n sys::System,\n component::StaticInjection,\n service::Service,\n time_series_data::TimeSeriesData,\n power_units::UnitSystem\n)\n\n\nAdds service bids time-series data to the MarketBidCost.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\nservice::Service,: Service for which the device is eligible to contribute\ntime_series_data::IS.TimeSeriesData: TimeSeriesData\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_start_up!-Tuple{System, StaticInjection, Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_start_up!","text":"set_start_up!(\n sys::System,\n component::StaticInjection,\n data::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesData}\n) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}\n\n\nSet the startup cost for a StaticInjection device with a MarketBidCost to either a single StartUpStages or a time series.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{StartUpStages, IS.TimeSeriesData},: the data. If a time series, must be of eltype NTuple{3, Float64}.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_variable_cost!-Tuple{System, ReserveDemandCurve, CostCurve{PiecewiseIncrementalCurve}}","page":"Public API","title":"PowerSystems.set_variable_cost!","text":"set_variable_cost!(\n _::System,\n component::ReserveDemandCurve,\n data::CostCurve{PiecewiseIncrementalCurve}\n) -> CostCurve{PiecewiseIncrementalCurve}\n\n\nAdds fixed energy market bids to the ReserveDemandCurve.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::ReserveDemandCurve: the curve\n`timeseriesdata::CostCurve{PiecewiseIncrementalCurve}\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_variable_cost!-Tuple{System, ReserveDemandCurve, Union{Nothing, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_variable_cost!","text":"set_variable_cost!(\n sys::System,\n component::ReserveDemandCurve,\n data::Union{Nothing, TimeSeriesData}\n) -> TimeSeriesKey\n\n\nAdds energy market bids time-series to the ReserveDemandCurve.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::ReserveDemandCurve: the curve\ntime_series_data::IS.TimeSeriesData: TimeSeriesData\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_variable_cost!-Tuple{System, StaticInjection, Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData}, UnitSystem}","page":"Public API","title":"PowerSystems.set_variable_cost!","text":"set_variable_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},\n power_units::UnitSystem\n)\n\n\nSet the incremental variable cost bid for a StaticInjection device with a MarketBidCost.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Nothing, IS.TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}},: the data. If using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.\npower_units::UnitSystem: Units to be used for data. Must be NATURAL_UNITS.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Operating-Costs","page":"Public API","title":"Operating Costs","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [InfrastructureSystems]\nPages = [\"production_variable_cost_curve.jl\",\n \"cost_aliases.jl\",\n \"value_curve.jl\",\n ]\nOrder = [:type, :function]\nFilter = t -> nameof(t) in names(PowerSystems)","category":"page"},{"location":"api/public/#InfrastructureSystems.CostCurve","page":"Public API","title":"InfrastructureSystems.CostCurve","text":"struct CostCurve{T<:ValueCurve} <: ProductionVariableCostCurve{T<:ValueCurve}\n\nvalue_curve::ValueCurve: The underlying ValueCurve representation of this ProductionVariableCostCurve\npower_units::UnitSystem: (default: natural units (MW)) The units for the x-axis of the curve\nvom_cost::LinearCurve: (default of 0) Additional proportional Variable Operation and Maintenance Cost in /(power_unit h), represented as a LinearCurve\n\nCostCurve(value_curve, power_units, vom_cost)\nCostCurve(; value_curve, power_units, vom_cost)\n\nDirect 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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.FuelCurve","page":"Public API","title":"InfrastructureSystems.FuelCurve","text":"struct FuelCurve{T<:ValueCurve} <: ProductionVariableCostCurve{T<:ValueCurve}\n\nvalue_curve::ValueCurve: The underlying ValueCurve representation of this ProductionVariableCostCurve\npower_units::UnitSystem: (default: natural units (MW)) The units for the x-axis of the curve\nfuel_cost::Union{Float64, TimeSeriesKey}: Either a fixed value for fuel cost or the TimeSeriesKey to a fuel cost time series\nvom_cost::LinearCurve: (default of 0) Additional proportional Variable Operation and Maintenance Cost in /(power_unit h) represented as a LinearCurve\n\nFuelCurve(value_curve, power_units, fuel_cost, vom_cost)\nFuelCurve(value_curve, fuel_cost)\nFuelCurve(value_curve, fuel_cost, vom_cost)\nFuelCurve(value_curve, power_units, fuel_cost)\nFuelCurve(; value_curve, power_units, fuel_cost, vom_cost)\n\nRepresentation 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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_fuel_cost-Tuple{FuelCurve}","page":"Public API","title":"InfrastructureSystems.get_fuel_cost","text":"get_fuel_cost(\n cost::FuelCurve\n) -> Union{Float64, TimeSeriesKey}\n\n\nGet the fuel cost or the name of the fuel cost time series\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_function_data-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_function_data","text":"get_function_data(cost::ProductionVariableCostCurve) -> Any\n\n\nGet the FunctionData representation of this ProductionVariableCostCurve's ValueCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_initial_input-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_initial_input","text":"get_initial_input(\n cost::ProductionVariableCostCurve\n) -> Union{Nothing, Float64}\n\n\nGet the initial_input field of this ProductionVariableCostCurve's ValueCurve (not defined for input-output data)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_power_units-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_power_units","text":"get_power_units(cost::ProductionVariableCostCurve) -> Any\n\n\nGet the units for the x-axis of the curve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_value_curve-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_value_curve","text":"get_value_curve(cost::ProductionVariableCostCurve) -> Any\n\n\nGet the underlying ValueCurve representation of this ProductionVariableCostCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_vom_cost-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_vom_cost","text":"get_vom_cost(cost::ProductionVariableCostCurve) -> Any\n\n\nGet the variable operation and maintenance cost in currency/(power_units h)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.is_convex-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.is_convex","text":"is_convex(cost::ProductionVariableCostCurve) -> Any\n\n\nCalculate the convexity of the underlying data\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.LinearCurve","page":"Public API","title":"InfrastructureSystems.LinearCurve","text":"LinearCurve(proportional_term::Float64)\nLinearCurve(proportional_term::Float64, constant_term::Float64)\n\nA linear input-output curve, representing a constant marginal rate. May have zero no-load cost (i.e., constant average rate) or not.\n\nArguments\n\nproportional_term::Float64: marginal rate\nconstant_term::Float64: optional, cost at zero production, defaults to 0.0\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.PiecewiseAverageCurve","page":"Public API","title":"InfrastructureSystems.PiecewiseAverageCurve","text":"PiecewiseAverageCurve(initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})\n\nA piecewise linear curve specified by average rates between production points. May have nonzero initial value.\n\nArguments\n\ninitial_input::Union{Float64, Nothing}: cost at minimum production point first(x_coords) (NOT at zero production), defines the start of the curve\nx_coords::Vector{Float64}: vector of n production points\nslopes::Vector{Float64}: vector of n-1 average rates/slopes of the curve segments between the points\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.PiecewiseIncrementalCurve","page":"Public API","title":"InfrastructureSystems.PiecewiseIncrementalCurve","text":"PiecewiseIncrementalCurve(initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})\nPiecewiseIncrementalCurve(input_at_zero::Union{Nothing, Float64}, initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})\n\nA piecewise linear curve specified by marginal rates (slopes) between production points. May have nonzero initial value.\n\nArguments\n\ninput_at_zero::Union{Nothing, Float64}: (optional, defaults to nothing) cost at zero production, does NOT represent a part of the curve\ninitial_input::Union{Float64, Nothing}: cost at minimum production point first(x_coords) (NOT at zero production), defines the start of the curve\nx_coords::Vector{Float64}: vector of n production points\nslopes::Vector{Float64}: vector of n-1 marginal rates/slopes of the curve segments between the points\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.PiecewisePointCurve","page":"Public API","title":"InfrastructureSystems.PiecewisePointCurve","text":"PiecewisePointCurve(points::Vector{Tuple{Float64, Float64}})\n\nA piecewise linear curve specified by cost values at production points.\n\nArguments\n\npoints::Vector{Tuple{Float64, Float64}} or similar: vector of (production, cost) pairs\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.QuadraticCurve","page":"Public API","title":"InfrastructureSystems.QuadraticCurve","text":"QuadraticCurve(quadratic_term::Float64, proportional_term::Float64, constant_term::Float64)\n\nA quadratic input-output curve, may have nonzero no-load cost.\n\nArguments\n\nquadratic_term::Float64: quadratic term of the curve\nproportional_term::Float64: proportional term of the curve\nconstant_term::Float64: constant term of the curve\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_average_rates-Tuple{PiecewiseAverageCurve}","page":"Public API","title":"InfrastructureSystems.get_average_rates","text":"get_average_rates(\n vc::PiecewiseAverageCurve\n) -> Vector{Float64}\n\n\nGet the average rates that define the PiecewiseAverageCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_constant_term-Tuple{LinearCurve}","page":"Public API","title":"InfrastructureSystems.get_constant_term","text":"get_constant_term(vc::LinearCurve) -> Float64\n\n\nGet the constant term (i.e., intercept) of the LinearCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_constant_term-Tuple{QuadraticCurve}","page":"Public API","title":"InfrastructureSystems.get_constant_term","text":"get_constant_term(vc::QuadraticCurve) -> Float64\n\n\nGet the constant term of the QuadraticCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_points-Tuple{PiecewisePointCurve}","page":"Public API","title":"InfrastructureSystems.get_points","text":"get_points(\n vc::PiecewisePointCurve\n) -> Vector{@NamedTuple{x::Float64, y::Float64}}\n\n\nGet the points that define the PiecewisePointCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_proportional_term-Tuple{LinearCurve}","page":"Public API","title":"InfrastructureSystems.get_proportional_term","text":"get_proportional_term(vc::LinearCurve) -> Float64\n\n\nGet the proportional term (i.e., slope) of the LinearCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_proportional_term-Tuple{QuadraticCurve}","page":"Public API","title":"InfrastructureSystems.get_proportional_term","text":"get_proportional_term(vc::QuadraticCurve) -> Float64\n\n\nGet the proportional (i.e., linear) term of the QuadraticCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_quadratic_term-Tuple{QuadraticCurve}","page":"Public API","title":"InfrastructureSystems.get_quadratic_term","text":"get_quadratic_term(vc::QuadraticCurve) -> Float64\n\n\nGet the quadratic term of the QuadraticCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_slopes-Tuple{PiecewiseIncrementalCurve}","page":"Public API","title":"InfrastructureSystems.get_slopes","text":"get_slopes(vc::PiecewiseIncrementalCurve) -> Vector{Float64}\n\n\nFetch the slopes that define the PiecewiseIncrementalCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_slopes-Tuple{PiecewisePointCurve}","page":"Public API","title":"InfrastructureSystems.get_slopes","text":"get_slopes(vc::PiecewisePointCurve) -> Vector{Float64}\n\n\nCalculate the slopes of the line segments defined by the PiecewisePointCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_x_coords-Tuple{PiecewiseAverageCurve}","page":"Public API","title":"InfrastructureSystems.get_x_coords","text":"get_x_coords(vc::PiecewiseAverageCurve) -> Vector{Float64}\n\n\nGet the x-coordinates that define the PiecewiseAverageCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_x_coords-Tuple{PiecewiseIncrementalCurve}","page":"Public API","title":"InfrastructureSystems.get_x_coords","text":"get_x_coords(\n vc::PiecewiseIncrementalCurve\n) -> Vector{Float64}\n\n\nGet the x-coordinates that define the PiecewiseIncrementalCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_x_coords-Tuple{PiecewisePointCurve}","page":"Public API","title":"InfrastructureSystems.get_x_coords","text":"get_x_coords(vc::PiecewisePointCurve) -> Vector{Float64}\n\n\nGet the x-coordinates of the points that define the PiecewisePointCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_y_coords-Tuple{PiecewisePointCurve}","page":"Public API","title":"InfrastructureSystems.get_y_coords","text":"get_y_coords(vc::PiecewisePointCurve) -> Vector{Float64}\n\n\nGet the y-coordinates of the points that define the PiecewisePointCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.AverageRateCurve","page":"Public API","title":"InfrastructureSystems.AverageRateCurve","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.IncrementalCurve","page":"Public API","title":"InfrastructureSystems.IncrementalCurve","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.InputOutputCurve","page":"Public API","title":"InfrastructureSystems.InputOutputCurve","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.ValueCurve","page":"Public API","title":"InfrastructureSystems.ValueCurve","text":"Supertype that represents a unitless cost curve\n\nConcrete subtypes are:\n\nLinearCurve\nQuadraticCurve\nPiecewisePointCurve\nPiecewiseIncrementalCurve\nPiecewiseAverageCurve\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_function_data-Tuple{ValueCurve}","page":"Public API","title":"InfrastructureSystems.get_function_data","text":"get_function_data(curve::ValueCurve) -> Any\n\n\nGet the underlying FunctionData representation of this ValueCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_initial_input-Tuple{Union{AverageRateCurve, IncrementalCurve}}","page":"Public API","title":"InfrastructureSystems.get_initial_input","text":"get_initial_input(\n curve::Union{AverageRateCurve, IncrementalCurve}\n) -> Union{Nothing, Float64}\n\n\nGet the initial_input field of this ValueCurve (not defined for InputOutputCurve)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_input_at_zero-Tuple{ValueCurve}","page":"Public API","title":"InfrastructureSystems.get_input_at_zero","text":"get_input_at_zero(curve::ValueCurve) -> Any\n\n\nGet the input_at_zero field of this ValueCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.is_convex-Tuple{ValueCurve}","page":"Public API","title":"InfrastructureSystems.is_convex","text":"is_convex(curve::ValueCurve) -> Bool\n\n\nCalculate the convexity of the underlying data\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Time-Series","page":"Public API","title":"Time Series","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [InfrastructureSystems]\nPages = [\"abstract_time_series.jl\",\n \"deterministic.jl\",\n \"deterministic_single_time_series.jl\",\n \"probabilistic.jl\",\n \"scenarios.jl\",\n \"static_time_series.jl\",\n \"single_time_series.jl\",\n \"forecasts.jl\",\n ]\nOrder = [:type, :function]\nFilter = t -> nameof(t) in names(PowerSystems)","category":"page"},{"location":"api/public/#InfrastructureSystems.TimeSeriesData","page":"Public API","title":"InfrastructureSystems.TimeSeriesData","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.Deterministic","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"mutable struct Deterministic <: AbstractDeterministic\n name::String\n data::SortedDict\n resolution::Dates.Period\n scaling_factor_multiplier::Union{Nothing, Function}\n internal::InfrastructureSystemsInternal\nend\n\nA deterministic forecast for a particular data field in a Component.\n\nArguments\n\nname::String: user-defined name\ndata::SortedDict: timestamp - scalingfactor\nresolution::Dates.Period: forecast resolution\nscaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.\ninternal::InfrastructureSystemsInternal\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{AbstractString, AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray}}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n name::AbstractString,\n input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray};\n normalization_factor,\n scaling_factor_multiplier\n) -> Deterministic\n\n\nConstruct Deterministic from a Dict of TimeArrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\ntimestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{AbstractString, AbstractString, InfrastructureSystems.InfrastructureSystemsComponent, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n name::AbstractString,\n filename::AbstractString,\n component::InfrastructureSystems.InfrastructureSystemsComponent,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Deterministic\n\n\nConstruct Deterministic from a CSV file. The first column must be a timestamp in DateTime format and the columns the values in the forecast window.\n\nArguments\n\nname::AbstractString: user-defined name\nfilename::AbstractString: name of CSV file containing data\ncomponent::InfrastructureSystemsComponent: component associated with the data\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{AbstractString, InfrastructureSystems.RawTimeSeries, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n name::AbstractString,\n series_data::InfrastructureSystems.RawTimeSeries,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Deterministic\n\n\nConstruct Deterministic from RawTimeSeries.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{Deterministic, AbstractString}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n src::Deterministic,\n name::AbstractString;\n scaling_factor_multiplier\n) -> Deterministic\n\n\nConstruct Deterministic that shares the data from an existing instance.\n\nThis is useful in cases where you want a component to use the same time series data for two different attributes.\n\nExamples\n\nresolution = Dates.Hour(1)\ndata = Dict(\n DateTime(\"2020-01-01T00:00:00\") => ones(24),\n DateTime(\"2020-01-01T01:00:00\") => ones(24),\n)\n# Define a Deterministic for the first attribute\nforecast_max_active_power = Deterministic(\n \"max_active_power\",\n data,\n resolution,\n scaling_factor_multiplier = get_max_active_power,\n)\nadd_time_series!(sys, generator, forecast_max_active_power)\n# Reuse time series for second attribute\nforecast_max_reactive_power = Deterministic(\n forecast_max_active_power,\n \"max_reactive_power\"\n scaling_factor_multiplier = get_max_reactive_power,\n)\nadd_time_series!(sys, generator, forecast_max_reactive_power)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{Deterministic, Any}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n forecast::Deterministic,\n data\n) -> Deterministic\n\n\nConstruct a new Deterministic from an existing instance and a subset of data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_data-Tuple{Deterministic}","page":"Public API","title":"InfrastructureSystems.get_data","text":"get_data(value::Deterministic) -> DataStructures.SortedDict\n\n\nGet Deterministic data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{Deterministic}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(value::Deterministic) -> String\n\n\nGet Deterministic name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_resolution-Tuple{Deterministic}","page":"Public API","title":"InfrastructureSystems.get_resolution","text":"get_resolution(value::Deterministic) -> Dates.Period\n\n\nGet Deterministic resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.iterate_windows-Tuple{Deterministic}","page":"Public API","title":"InfrastructureSystems.iterate_windows","text":"iterate_windows(\n forecast::Deterministic\n) -> Base.Generator{I, InfrastructureSystems.var\"#105#106\"{Deterministic}} where I<:(DataStructures.SDMKeyIteration{T} where T<:DataStructures.SortedDict)\n\n\nIterate over the windows in a forecast\n\nExamples\n\nfor window in iterate_windows(forecast)\n @show values(maximum(window))\nend\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{Deterministic, Any}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(value::Deterministic, val) -> Any\n\n\nSet Deterministic name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.DeterministicSingleTimeSeries","page":"Public API","title":"InfrastructureSystems.DeterministicSingleTimeSeries","text":"mutable struct DeterministicSingleTimeSeries <: AbstractDeterministic\n single_time_series::SingleTimeSeries\n initial_timestamp::Dates.DateTime\n interval::Dates.Period\n count::Int\n horizon::Int\nend\n\nA deterministic forecast that wraps a SingleTimeSeries\n\nDeterministicSingleTimeSeries behaves exactly like a Deterministic, but instead of storing windows at each initial time it provides a view into the existing SingleTimeSeries at incrementing offsets. This avoids large data duplications when there are the overlapping windows between forecasts. \n\nCan be used as a perfect forecast based on historical data when real forecast data is unavailable. \n\nArguments\n\nsingle_time_series::SingleTimeSeries: wrapped SingleTimeSeries object\ninitial_timestamp::Dates.DateTime: time series availability time\ninterval::Dates.Period: time step between forecast windows\ncount::Int: number of forecast windows\nhorizon::Int: length of this time series\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_horizon-Tuple{DeterministicSingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.get_horizon","text":"get_horizon(\n value::DeterministicSingleTimeSeries\n) -> Dates.Period\n\n\nGet DeterministicSingleTimeSeries horizon.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.iterate_windows-Tuple{DeterministicSingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.iterate_windows","text":"iterate_windows(\n forecast::DeterministicSingleTimeSeries\n) -> Union{Tuple{Any}, Base.Generator{I, InfrastructureSystems.var\"#134#135\"{DeterministicSingleTimeSeries}} where I<:(StepRangeLen{T, R, S, Int64} where {T, R>:Dates.DateTime, S})}\n\n\nIterate over the windows in a forecast\n\nExamples\n\nfor window in iterate_windows(forecast)\n @show values(maximum(window))\nend\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Probabilistic","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"mutable struct Probabilistic <: Forecast\n name::String\n resolution::Dates.Period\n percentiles::Vector{Float64}\n data::SortedDict\n scaling_factor_multiplier::Union{Nothing, Function}\n internal::InfrastructureSystemsInternal\nend\n\nA Probabilistic forecast for a particular data field in a Component.\n\nArguments\n\nname::String: user-defined name\nresolution::Dates.Period: forecast resolution\npercentiles::Vector{Float64}: Percentiles for the probabilistic forecast\ndata::SortedDict: timestamp - scalingfactor\nscaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.\ninternal::InfrastructureSystemsInternal\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.Probabilistic-Tuple{AbstractString, AbstractDict, Vector, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"Probabilistic(\n name::AbstractString,\n input_data::AbstractDict,\n percentiles::Vector,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Probabilistic\n\n\nConstruct Probabilistic from a SortedDict of Arrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, Matrix{Float64}}: time series data.\npercentiles: Percentiles represented in the probabilistic forecast\nresolution::Dates.Period: The resolution of the forecast in Dates.Period`\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Probabilistic-Tuple{AbstractString, AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray}, Vector{Float64}}","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"Probabilistic(\n name::AbstractString,\n input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray},\n percentiles::Vector{Float64};\n normalization_factor,\n scaling_factor_multiplier\n) -> Probabilistic\n\n\nConstruct Probabilistic from a Dict of TimeArrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.\npercentiles: Percentiles represented in the probabilistic forecast\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\ntimestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Probabilistic-Tuple{AbstractString, InfrastructureSystems.RawTimeSeries, Vector, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"Probabilistic(\n name::AbstractString,\n series_data::InfrastructureSystems.RawTimeSeries,\n percentiles::Vector,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Probabilistic\n\n\nConstruct Deterministic from RawTimeSeries.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Probabilistic-Tuple{Probabilistic, AbstractString}","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"Probabilistic(\n src::Probabilistic,\n name::AbstractString;\n scaling_factor_multiplier\n) -> Probabilistic\n\n\nConstruct a Probabilistic that shares the data from an existing instance.\n\nThis is useful in cases where you want a component to use the same time series data for two different attributes.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_data-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.get_data","text":"get_data(value::Probabilistic) -> DataStructures.SortedDict\n\n\nGet Probabilistic data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(value::Probabilistic) -> String\n\n\nGet Probabilistic name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_percentiles-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.get_percentiles","text":"get_percentiles(value::Probabilistic) -> Vector{Float64}\n\n\nGet Probabilistic percentiles.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_resolution-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.get_resolution","text":"get_resolution(value::Probabilistic) -> Dates.Period\n\n\nGet Probabilistic resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.iterate_windows-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.iterate_windows","text":"iterate_windows(\n forecast::Probabilistic\n) -> Base.Generator{I, InfrastructureSystems.var\"#105#106\"{Probabilistic}} where I<:(DataStructures.SDMKeyIteration{T} where T<:DataStructures.SortedDict)\n\n\nIterate over the windows in a forecast\n\nExamples\n\nfor window in iterate_windows(forecast)\n @show values(maximum(window))\nend\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{Probabilistic, Any}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(value::Probabilistic, val) -> Any\n\n\nSet Probabilistic name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Scenarios","page":"Public API","title":"InfrastructureSystems.Scenarios","text":"mutable struct Scenarios <: Forecast\n name::String\n resolution::Dates.Period\n scenario_count::Int64\n data::SortedDict\n scaling_factor_multiplier::Union{Nothing, Function}\n internal::InfrastructureSystemsInternal\nend\n\nA Discrete Scenario Based time series for a particular data field in a Component.\n\nArguments\n\nname::String: user-defined name\nresolution::Dates.Period: forecast resolution\nscenario_count::Int64: Number of scenarios\ndata::SortedDict: timestamp - scalingfactor\nscaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.\ninternal::InfrastructureSystemsInternal\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.Scenarios-Tuple{AbstractString, AbstractDict, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Scenarios","text":"Scenarios(\n name::AbstractString,\n input_data::AbstractDict,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Scenarios\n\n\nConstruct Scenarios from a SortedDict of Arrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, Matrix{Float64}}: time series data.\nresolution::Dates.Period: The resolution of the forecast in Dates.Period`\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Scenarios-Tuple{AbstractString, AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray}}","page":"Public API","title":"InfrastructureSystems.Scenarios","text":"Scenarios(\n name::AbstractString,\n input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray};\n normalization_factor,\n scaling_factor_multiplier\n) -> Scenarios\n\n\nConstruct Scenarios from a Dict of TimeArrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\ntimestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Scenarios-Tuple{Scenarios, AbstractString}","page":"Public API","title":"InfrastructureSystems.Scenarios","text":"Scenarios(\n src::Scenarios,\n name::AbstractString;\n scaling_factor_multiplier\n) -> Scenarios\n\n\nConstruct Scenarios that shares the data from an existing instance.\n\nThis is useful in cases where you want a component to use the same time series data for two different attributes.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_data-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.get_data","text":"get_data(value::Scenarios) -> DataStructures.SortedDict\n\n\nGet Scenarios data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(value::Scenarios) -> String\n\n\nGet Scenarios name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_resolution-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.get_resolution","text":"get_resolution(value::Scenarios) -> Dates.Period\n\n\nGet Scenarios resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_scenario_count-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.get_scenario_count","text":"get_scenario_count(value::Scenarios) -> Int64\n\n\nGet Scenarios scenario_count.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.iterate_windows-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.iterate_windows","text":"iterate_windows(\n forecast::Scenarios\n) -> Base.Generator{I, InfrastructureSystems.var\"#105#106\"{Scenarios}} where I<:(DataStructures.SDMKeyIteration{T} where T<:DataStructures.SortedDict)\n\n\nIterate over the windows in a forecast\n\nExamples\n\nfor window in iterate_windows(forecast)\n @show values(maximum(window))\nend\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{Scenarios, Any}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(value::Scenarios, val) -> Any\n\n\nSet Scenarios name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.StaticTimeSeries","page":"Public API","title":"InfrastructureSystems.StaticTimeSeries","text":"Supertype for static time series, which has one value per time point\n\nCurrent concrete subtypes are:\n\nSingleTimeSeries\n\nSee also: Forecast\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"mutable struct SingleTimeSeries <: StaticTimeSeries\n name::String\n data::TimeSeries.TimeArray\n scaling_factor_multiplier::Union{Nothing, Function}\n internal::InfrastructureSystemsInternal\nend\n\nA single column of time series data for a particular data field in a Component.\n\nIn contrast with a forecast, this can represent one continual time series, such as a series of historical measurements or realizations or a single scenario (e.g. a weather year or different input assumptions).\n\nArguments\n\nname::String: user-defined name\ndata::TimeSeries.TimeArray: timestamp - scalingfactor\nresolution::Dates.Period: Time duration between steps in the time series. The resolution must be the same throughout the time series\nscaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.\ninternal::InfrastructureSystemsInternal\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{AbstractString, AbstractString, InfrastructureSystems.InfrastructureSystemsComponent, Dates.Period}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n name::AbstractString,\n filename::AbstractString,\n component::InfrastructureSystems.InfrastructureSystemsComponent,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> SingleTimeSeries\n\n\nConstruct SingleTimeSeries from a CSV file. The file must have a column that is the name of the component.\n\nArguments\n\nname::AbstractString: user-defined name\nfilename::AbstractString: name of CSV file containing data\ncomponent::InfrastructureSystemsComponent: component associated with the data\nresolution::Dates.Period: resolution of the time series\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{AbstractString, Union{DataFrames.DataFrame, TimeSeries.TimeArray}}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n name::AbstractString,\n data::Union{DataFrames.DataFrame, TimeSeries.TimeArray};\n normalization_factor,\n scaling_factor_multiplier,\n timestamp\n) -> SingleTimeSeries\n\n\nConstruct SingleTimeSeries from a TimeArray or DataFrame.\n\nArguments\n\nname::AbstractString: user-defined name\ndata::Union{TimeSeries.TimeArray, DataFrames.DataFrame}: time series data\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\ntimestamp = :timestamp: If a DataFrame is passed then this must be the column name that contains timestamps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{SingleTimeSeries, AbstractString}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n src::SingleTimeSeries,\n name::AbstractString;\n scaling_factor_multiplier\n) -> SingleTimeSeries\n\n\nConstruct SingleTimeSeries that shares the data from an existing instance.\n\nThis is useful in cases where you want a component to use the same time series data for two different attribtues.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{SingleTimeSeries, TimeSeries.TimeArray}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n time_series::SingleTimeSeries,\n data::TimeSeries.TimeArray\n) -> Any\n\n\nCreates a new SingleTimeSeries from an existing instance and a subset of data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{String, Dates.Period, Dates.DateTime, Int64}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n name::String,\n resolution::Dates.Period,\n initial_time::Dates.DateTime,\n time_steps::Int64\n) -> SingleTimeSeries\n\n\nConstruct SingleTimeSeries after constructing a TimeArray from initial_time and time_steps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_data-Tuple{SingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.get_data","text":"get_data(value::SingleTimeSeries) -> TimeSeries.TimeArray\n\n\nGet SingleTimeSeries data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{SingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(value::SingleTimeSeries) -> String\n\n\nGet SingleTimeSeries name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_resolution-Tuple{SingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.get_resolution","text":"get_resolution(value::SingleTimeSeries) -> Dates.Period\n\n\nGet SingleTimeSeries resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{SingleTimeSeries, Any}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(value::SingleTimeSeries, val) -> Any\n\n\nSet SingleTimeSeries name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Forecast","page":"Public API","title":"InfrastructureSystems.Forecast","text":"Supertype for forecast time series Current concrete subtypes are:\n\nDeterministic\nDeterministicSingleTimeSeries\nScenarios\nProbabilistic\n\nSubtypes of Forecast must implement:\n\nget_horizon_count\nget_initial_times\nget_initial_timestamp\nget_name\nget_scaling_factor_multiplier\nget_window\niterate_windows\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_window-Tuple{Forecast, Int64}","page":"Public API","title":"InfrastructureSystems.get_window","text":"get_window(forecast::Forecast, index::Int64; len) -> Any\n\n\nReturn the forecast window corresponsing to interval index.\n\n\n\n\n\n","category":"method"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [InfrastructureSystems]\nPages = [\"time_series_cache.jl\",\n \"time_series_interface.jl\",\n \"time_series_structs.jl\",\n \"time_series_storage.jl\",\n \"time_series_parser.jl\",\n \"utils/print.jl\"]\nOrder = [:type, :function]\nFilter = t -> nameof(t) in names(PowerSystems)","category":"page"},{"location":"api/public/#InfrastructureSystems.ForecastCache-Union{Tuple{T}, Tuple{Type{T}, InfrastructureSystems.InfrastructureSystemsComponent, AbstractString}} where T<:Forecast","page":"Public API","title":"InfrastructureSystems.ForecastCache","text":"Construct ForecastCache to automatically control caching of forecast data. Maintains some count of forecast windows in memory based on cache_size_bytes.\n\nCall Base.iterate or get_next_time_series_array! to retrieve data. Each iteration will return a TimeSeries.TimeArray covering one forecast window of length horizon_count.\n\nArguments\n\n::Type{T}: subtype of Forecast\ncomponent::InfrastructureSystemsComponent: component\nname::AbstractString: forecast name\nstart_time::Union{Nothing, Dates.DateTime} = nothing: forecast start time\nhorizon_count::Union{Nothing, Int} = nothing: forecast horizon count\ncache_size_bytes = TIME_SERIES_CACHE_SIZE_BYTES: maximum size of data to keep in memory\nignore_scaling_factors = false: controls whether to ignore scaling_factor_multiplier in the time series instance\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.StaticTimeSeriesCache-Union{Tuple{T}, Tuple{Type{T}, InfrastructureSystems.InfrastructureSystemsComponent, AbstractString}} where T<:StaticTimeSeries","page":"Public API","title":"InfrastructureSystems.StaticTimeSeriesCache","text":"Construct StaticTimeSeriesCache to automatically control caching of time series data. Maintains rows of data in memory based on cache_size_bytes.\n\nCall Base.iterate or get_time_series_array to retrieve data. Each iteration will return a TimeSeries.TimeArray of size 1.\n\nArguments\n\n::Type{T}: subtype of StaticTimeSeries\ncomponent::InfrastructureSystemsComponent: component\nname::AbstractString: time series name\ncache_size_bytes = TIME_SERIES_CACHE_SIZE_BYTES: maximum size of data to keep in memory\nignore_scaling_factors = false: controls whether to ignore scalingfactormultiplier in the time series instance\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_next_time-Tuple{InfrastructureSystems.TimeSeriesCache}","page":"Public API","title":"InfrastructureSystems.get_next_time","text":"get_next_time(\n cache::InfrastructureSystems.TimeSeriesCache\n) -> Any\n\n\nReturn the timestamp for the next read with get_next_time_series_array!.\n\nReturn nothing if all data has been read.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_next_time_series_array!-Tuple{InfrastructureSystems.TimeSeriesCache}","page":"Public API","title":"InfrastructureSystems.get_next_time_series_array!","text":"get_next_time_series_array!(\n cache::InfrastructureSystems.TimeSeriesCache\n) -> Any\n\n\nReturn the next TimeSeries.TimeArray.\n\nReturns nothing when all data has been read. Call reset! to restart. Call get_next_time to check the start time.\n\nReads from storage if the data is not already in cache.\n\nArguments\n\ncache::StaticTimeSeriesCache: cached instance\n\nExamples\n\ncache = ForecastCache(Deterministic, component, \"max_active_power\")\nwindow1 = get_next_time_series_array!(cache)\nwindow2 = get_next_time_series_array!(cache)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.reset!-Tuple{InfrastructureSystems.TimeSeriesCache}","page":"Public API","title":"InfrastructureSystems.reset!","text":"reset!(cache::InfrastructureSystems.TimeSeriesCache)\n\n\nReset parameters in order to start reading data from the beginning with get_next_time_series_array!\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.copy_time_series!-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}}","page":"Public API","title":"InfrastructureSystems.copy_time_series!","text":"copy_time_series!(\n dst::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n src::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute};\n name_mapping,\n scaling_factor_multiplier_mapping\n)\n\n\nEfficiently add all time_series in one component to another by copying the underlying references.\n\nArguments\n\ndst::TimeSeriesOwners: Destination owner\nsrc::TimeSeriesOwners: Source owner\nname_mapping::Dict = nothing: Optionally map src names to different dst names. If provided and src has a timeseries with a name not present in namemapping, that timeseries will not copied. If namemapping is nothing then all time_series will be copied with src's names.\nscaling_factor_multiplier_mapping::Dict = nothing: Optionally map src multipliers to different dst multipliers. If provided and src has a timeseries with a multiplier not present in scalingfactormultipliermapping, that timeseries will not copied. If scalingfactormultipliermapping is nothing then all time_series will be copied with src's multipliers.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series","page":"Public API","title":"InfrastructureSystems.get_time_series","text":"get_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n key::TimeSeriesKey\n) -> Any\nget_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n key::TimeSeriesKey,\n start_time::Union{Nothing, Dates.DateTime}\n) -> Any\nget_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n key::TimeSeriesKey,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64}\n) -> Any\nget_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n key::TimeSeriesKey,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64},\n count::Union{Nothing, Int64}\n) -> Any\n\n\nReturn the exact stored data in a time series, using a time series key look up\n\nThis will load all forecast windows into memory by default. Be aware of how much data is stored.\n\nSpecify start_time and len if you only need a subset of data.\n\nDoes not apply a scaling factor multiplier.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\nkey::TimeSeriesKey: the time series' key\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If the time series is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length in the time dimension. If nothing, use the entire length.\ncount::Union{Nothing, Int} = nothing: Only applicable to subtypes of Forecast. Number of forecast windows starting at start_time to return. Defaults to all available.\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series by name\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series-Union{Tuple{T}, Tuple{Type{T}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, AbstractString}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.get_time_series","text":"get_time_series(\n ::Type{T<:TimeSeriesData},\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n name::AbstractString;\n start_time,\n len,\n count,\n features...\n) -> Any\n\n\nReturn the exact stored data in a time series\n\nThis will load all forecast windows into memory by default. Be aware of how much data is stored.\n\nSpecify start_time and len if you only need a subset of data.\n\nDoes not apply a scaling factor multiplier.\n\nArguments\n\n::Type{T}: Concrete subtype of TimeSeriesData to return\nowner::TimeSeriesOwners: Component or attribute containing the time series\nname::AbstractString: name of time series\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length in the time dimension. If nothing, use the entire length.\ncount::Union{Nothing, Int} = nothing: Only applicable to subtypes of Forecast. Number of forecast windows starting at start_time to return. Defaults to all available.\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series_array, get_time_series_values, get_time_series by key\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_array","page":"Public API","title":"InfrastructureSystems.get_time_series_array","text":"get_time_series_array(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries;\n ...\n) -> Any\nget_time_series_array(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries,\n start_time::Union{Nothing, Dates.DateTime};\n len,\n ignore_scaling_factors\n) -> Any\n\n\nReturn a TimeSeries.TimeArray from a cached StaticTimeSeries instance.\n\nIf the time series data are scaling factors, the returned data will be scaled by the scaling factor multiplier by default.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\ntime_series::StaticTimeSeries: subtype of StaticTimeSeries (e.g., SingleTimeSeries)\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp to retrieve. If nothing, use the initial_timestamp of the time series.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\n\nSee also: get_time_series_values, get_time_series_timestamps, StaticTimeSeriesCache, get_time_series_array by name from storage, get_time_series_array from a ForecastCache\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_array-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, Forecast, Dates.DateTime}","page":"Public API","title":"InfrastructureSystems.get_time_series_array","text":"get_time_series_array(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n forecast::Forecast,\n start_time::Dates.DateTime;\n len,\n ignore_scaling_factors\n) -> Any\n\n\nReturn a TimeSeries.TimeArray for one forecast window from a cached Forecast instance\n\nIf the time series data are scaling factors, the returned data will be scaled by the scaling factor multiplier by default.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\nforecast::Forecast: a concrete subtype of Forecast\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp of one of the forecast windows\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\n\nSee also get_time_series_values, get_time_series_timestamps, ForecastCache, get_time_series_array by name from storage, get_time_series_array from a StaticTimeSeriesCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_array-Union{Tuple{T}, Tuple{Type{T}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, AbstractString}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.get_time_series_array","text":"get_time_series_array(\n ::Type{T<:TimeSeriesData},\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n name::AbstractString;\n start_time,\n len,\n ignore_scaling_factors,\n features...\n) -> Any\n\n\nReturn a TimeSeries.TimeArray from storage for the given time series parameters.\n\nIf the time series data are scaling factors, the returned data will be scaled by the scaling factor multiplier by default.\n\nThis will load all forecast windows into memory by default. Be aware of how much data is stored.\n\nSpecify start_time and len if you only need a subset of data.\n\nArguments\n\n::Type{T}: the type of time series (a concrete subtype of TimeSeriesData)\nowner::TimeSeriesOwners: Component or attribute containing the time series\nname::AbstractString: name of time series\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series_values, get_time_series_timestamps, get_time_series_array from a StaticTimeSeriesCache, get_time_series_array from a ForecastCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_keys-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}}","page":"Public API","title":"InfrastructureSystems.get_time_series_keys","text":"get_time_series_keys(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}\n) -> Vector\n\n\nReturn information about each time series array attached to the owner. This information can be used to call get_time_series(::TimeSeriesOwners, ::TimeSeriesKey).\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_multiple","page":"Public API","title":"InfrastructureSystems.get_time_series_multiple","text":"get_time_series_multiple(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute};\n ...\n) -> Union{Tuple{}, Channel{Any}}\nget_time_series_multiple(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n filter_func;\n type,\n name\n) -> Union{Tuple{}, Channel{Any}}\n\n\nReturns an iterator of TimeSeriesData instances attached to the component or attribute.\n\nNote that passing a filter function can be much slower than the other filtering parameters because it reads time series data from media.\n\nCall collect on the result to get an array.\n\nArguments\n\nowner::TimeSeriesOwners: component or attribute from which to get time_series\nfilter_func = nothing: Only return time_series for which this returns true.\ntype = nothing: Only return time_series with this type.\nname = nothing: Only return time_series matching this value.\n\nSee also: get_time_series_multiple from a System\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_timestamps","page":"Public API","title":"InfrastructureSystems.get_time_series_timestamps","text":"get_time_series_timestamps(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n forecast::Forecast;\n ...\n)\nget_time_series_timestamps(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n forecast::Forecast,\n start_time::Union{Nothing, Dates.DateTime};\n len\n) -> Vector{D} where D<:Dates.TimeType\n\n\nReturn a vector of timestamps from a cached Forecast instance.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\nforecast::Forecast: a concrete subtype of Forecast\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp of one of the forecast windows\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\n\nSee also: get_time_series_array, get_time_series_values, ForecastCache, get_time_series_timestamps by name from storage, get_time_series_timestamps from a StaticTimeSeriesCache\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_timestamps-2","page":"Public API","title":"InfrastructureSystems.get_time_series_timestamps","text":"get_time_series_timestamps(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries;\n ...\n) -> Vector{D} where D<:Dates.TimeType\nget_time_series_timestamps(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries,\n start_time::Union{Nothing, Dates.DateTime};\n len\n) -> Vector{D} where D<:Dates.TimeType\n\n\nReturn a vector of timestamps from a cached StaticTimeSeries instance.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\ntime_series::StaticTimeSeries: subtype of StaticTimeSeries (e.g., SingleTimeSeries)\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp to retrieve. If nothing, use the initial_timestamp of the time series.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length\n\nSee also: get_time_series_array, get_time_series_values, StaticTimeSeriesCache, get_time_series_timestamps by name from storage, get_time_series_timestamps from a ForecastCache\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_timestamps-Union{Tuple{T}, Tuple{Type{T}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, AbstractString}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.get_time_series_timestamps","text":"get_time_series_timestamps(\n ::Type{T<:TimeSeriesData},\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n name::AbstractString;\n start_time,\n len,\n features...\n) -> Vector{D} where D<:Dates.TimeType\n\n\nReturn a vector of timestamps from storage for the given time series parameters.\n\nArguments\n\n::Type{T}: the type of time series (a concrete subtype of TimeSeriesData)\nowner::TimeSeriesOwners: Component or attribute containing the time series\nname::AbstractString: name of time series\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series_array, get_time_series_values, get_time_series_timestamps from a StaticTimeSeriesCache, get_time_series_timestamps from a ForecastCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_values","page":"Public API","title":"InfrastructureSystems.get_time_series_values","text":"get_time_series_values(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries;\n ...\n) -> Any\nget_time_series_values(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries,\n start_time::Union{Nothing, Dates.DateTime};\n len,\n ignore_scaling_factors\n) -> Any\n\n\nReturn an vector of timeseries data without timestamps from a cached StaticTimeSeries instance\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\ntime_series::StaticTimeSeries: subtype of StaticTimeSeries (e.g., SingleTimeSeries)\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp to retrieve. If nothing, use the initial_timestamp of the time series.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\n\nSee also: get_time_series_array, get_time_series_timestamps, StaticTimeSeriesCache, get_time_series_values by name from storage, get_time_series_values from a ForecastCache\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_values-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, Forecast, Dates.DateTime}","page":"Public API","title":"InfrastructureSystems.get_time_series_values","text":"get_time_series_values(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n forecast::Forecast,\n start_time::Dates.DateTime;\n len,\n ignore_scaling_factors\n) -> Any\n\n\nReturn an vector of timeseries data without timestamps for one forecast window from a cached Forecast instance.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\nforecast::Forecast: a concrete subtype of Forecast\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp of one of the forecast windows\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\n\nSee also: get_time_series_array, get_time_series_timestamps, ForecastCache, get_time_series_values by name from storage, get_time_series_values from a StaticTimeSeriesCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_values-Union{Tuple{T}, Tuple{Type{T}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, AbstractString}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.get_time_series_values","text":"get_time_series_values(\n ::Type{T<:TimeSeriesData},\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n name::AbstractString;\n start_time,\n len,\n ignore_scaling_factors,\n features...\n) -> Any\n\n\nReturn an vector of timeseries data without timestamps from storage\n\nIf the data size is small and this will be called many times, consider using the version that accepts a cached TimeSeriesData instance.\n\nArguments\n\n::Type{T}: type of the time series (a concrete subtype of TimeSeriesData)\nowner::TimeSeriesOwners: Component or attribute containing the time series\nname::AbstractString: name of time series\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series_array, get_time_series_timestamps, get_time_series, get_time_series_values from a StaticTimeSeriesCache, get_time_series_values from a ForecastCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.has_time_series-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}}","page":"Public API","title":"InfrastructureSystems.has_time_series","text":"has_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}\n) -> Any\n\n\nReturn true if the component or supplemental attribute has time series data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.has_time_series-Union{Tuple{T}, Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, Type{T}}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.has_time_series","text":"has_time_series(\n val::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n _::Type{T<:TimeSeriesData}\n) -> Any\n\n\nReturn true if the component or supplemental attribute has time series data of type T.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.ForecastKey","page":"Public API","title":"InfrastructureSystems.ForecastKey","text":"A unique key to identify and retrieve a Forecast\n\nSee: get_time_series_keys and get_time_series(::TimeSeriesOwners, ::TimeSeriesKey).\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.StaticTimeSeriesKey","page":"Public API","title":"InfrastructureSystems.StaticTimeSeriesKey","text":"A unique key to identify and retrieve a StaticTimeSeries\n\nSee: get_time_series_keys and get_time_series(::TimeSeriesOwners, ::TimeSeriesKey).\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.TimeSeriesAssociation","page":"Public API","title":"InfrastructureSystems.TimeSeriesAssociation","text":"Defines an association between a time series owner (component or supplemental attribute) and the time series metadata.\n\nExamples\n\nassociation1 = TimeSeriesAssociation(component, time_series)\nassociation2 = TimeSeriesAssociation(component, time_series, scenario = \"high\")\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.TimeSeriesCounts","page":"Public API","title":"InfrastructureSystems.TimeSeriesCounts","text":"Provides counts of time series including attachments to components and supplemental attributes.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.TimeSeriesKey","page":"Public API","title":"InfrastructureSystems.TimeSeriesKey","text":"Supertype for keys that can be used to access a desired time series dataset\n\nConcrete subtypes:\n\nStaticTimeSeriesKey\nForecastKey\n\nRequired methods:\n\nget_name\nget_time_series_type\n\nThe default methods rely on the field names name and time_series_type.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.CompressionSettings","page":"Public API","title":"InfrastructureSystems.CompressionSettings","text":"CompressionSettings(enabled, type, level, shuffle)\n\nProvides customization of HDF5 compression settings.\n\nenabled::Bool: Controls whether compression is enabled.\ntype::CompressionTypes: Specifies the type of compression to use.\nlevel::Int64: Supported values are 0-9. Higher values deliver better compression ratios but take longer.\nshuffle::Bool: Controls whether to enable the shuffle filter. Used with DEFLATE.\n\nRefer to the HDF5.jl and HDF5 documentation for more details on the options.\n\nExample\n\nsettings = CompressionSettings(\n enabled = true,\n type = CompressionTypes.DEFLATE, # BLOSC is also supported\n level = 3,\n shuffle = true,\n)\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.show_time_series-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}}","page":"Public API","title":"InfrastructureSystems.show_time_series","text":"show_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}\n)\n\n\nShow a table with time series data attached to the component.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#System","page":"Public API","title":"System","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"base.jl\"]\nPublic = true\nPrivate = false\nFilter = t -> t ∈ [System]","category":"page"},{"location":"api/public/#PowerSystems.System","page":"Public API","title":"PowerSystems.System","text":"A power system\n\nSystem is the main data container in PowerSystems.jl, including basic metadata (base power, frequency), components (network topology, loads, generators, and services), and time series data.\n\nSystem(base_power)\nSystem(base_power, buses, components...)\nSystem(base_power, buses, generators, loads, branches, storage, services; kwargs...)\nSystem(base_power, buses, generators, loads; kwargs...)\nSystem(file; kwargs...)\nSystem(; buses, generators, loads, branches, storage, base_power, services, kwargs...)\nSystem(; kwargs...)\n\nArguments\n\nbase_power::Float64: the base power value for the system\nbuses::Vector{ACBus}: an array of buses\ncomponents...: Each element (e.g., buses, generators, ...) must be an iterable containing subtypes of Component.\n\nKeyword arguments\n\next::Dict: Contains user-defined parameters. Should only contain standard types.\nfrequency::Float64: (default = 60.0) Operating frequency (Hz)\nrunchecks::Bool: Run available checks on input fields and when add_component! is called. Throws InvalidValue if an error is found.\ntime_series_in_memory::Bool=false: Store time series data in memory instead of HDF5.\ntime_series_directory::Union{Nothing, String}: Directory for the time series HDF5 file. Defaults to the tmp file system\nenable_compression::Bool=false: Enable compression of time series data in HDF5.\ncompression::CompressionSettings: Allows customization of HDF5 compression settings.\nconfig_path::String: specify path to validation config file\nunit_system::String: (Default = \"SYSTEM_BASE\") Set the unit system for per-unitization while getting and setting data (\"SYSTEM_BASE\", \"DEVICE_BASE\", or \"NATURAL_UNITS\")\n\nBy default, time series data is stored in an HDF5 file in the tmp file system to prevent large datasets from overwhelming system memory (see Data Storage). If the system's time series data will be larger than the amount of tmp space available, use the time_series_directory parameter to change its location. You can also override the location by setting the environment variable SIENNA_TIME_SERIES_DIRECTORY to another directory.\n\nHDF5 compression is not enabled by default, but you can enable it with enable_compression to get significant storage savings at the cost of CPU time. CompressionSettings can be used to customize the HDF5 compression.\n\nIf you know that your dataset will fit in your computer's memory, then you can increase performance by storing it in memory with time_series_in_memory.\n\nExamples\n\nsys = System(100.0; enable_compression = true)\nsys = System(100.0; compression = CompressionSettings(\n enabled = true,\n type = CompressionTypes.DEFLATE, # BLOSC is also supported\n level = 3,\n shuffle = true)\n)\nsys = System(100.0; time_series_in_memory = true)\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.System-Tuple{AbstractString, AbstractString}","page":"Public API","title":"PowerSystems.System","text":"System(\n sys_file::AbstractString,\n dyr_file::AbstractString;\n kwargs...\n) -> Any\n\n\nParse 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\n\nEach dictionary indexed by id contains a vector with 5 of its components:\n\nMachine\nShaft\nAVR\nTurbineGov\nPSS\n\nFiles must be parsed from a .raw file (PTI data format) and a .dyr file.\n\nExamples:\n\nraw_file = \"Example.raw\"\ndyr_file = \"Example.dyr\"\nsys = System(raw_file, dyr_file)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{AbstractString}","page":"Public API","title":"PowerSystems.System","text":"System(\n file_path::AbstractString;\n assign_new_uuids,\n kwargs...\n) -> Any\n\n\nConstructs a System from a file path ending with .m, .RAW, or .json\n\nIf the file is JSON then assignnewuuids = true will generate new UUIDs for the system and all components.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{Any, Number}","page":"Public API","title":"PowerSystems.System","text":"System(\n data,\n base_power::Number;\n internal,\n kwargs...\n) -> System\n\n\nConstruct a System from InfrastructureSystems.SystemData\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{Float64, Vector{ACBus}, Vararg{Any}}","page":"Public API","title":"PowerSystems.System","text":"System(\n base_power::Float64,\n buses::Vector{ACBus},\n components...;\n kwargs...\n) -> System\n\n\nSystem constructor when components are constructed externally.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{Nothing}","page":"Public API","title":"PowerSystems.System","text":"System(\n ::Nothing;\n buses,\n generators,\n loads,\n branches,\n storage,\n base_power,\n services,\n kwargs...\n) -> System\n\n\nConstructs a non-functional System for demo purposes.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{Number}","page":"Public API","title":"PowerSystems.System","text":"System(base_power::Number; kwargs...) -> System\n\n\nConstruct an empty System. Useful for building a System while parsing raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"base.jl\"]\nPublic = true\nPrivate = false\nFilter = t -> t ∉ [System]","category":"page"},{"location":"api/public/#InfrastructureSystems.from_json-Tuple{Union{IO, String}, Type{System}}","page":"Public API","title":"InfrastructureSystems.from_json","text":"from_json(\n io::Union{IO, String},\n ::Type{System};\n runchecks,\n assign_new_uuids,\n kwargs...\n) -> System\n\n\nIf assignnewuuids = true, generate new UUIDs for the system and all components.\n\nWarning: 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\").\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{System}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(sys::System) -> Union{Nothing, String}\n\n\nGet the name of the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_supplemental_attribute-Tuple{System, Base.UUID}","page":"Public API","title":"InfrastructureSystems.get_supplemental_attribute","text":"get_supplemental_attribute(\n sys::System,\n uuid::Base.UUID\n) -> SupplementalAttribute\n\n\nReturn the supplemental attribute with the given uuid.\n\nThrows ArgumentError if the attribute is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_supplemental_attributes-Union{Tuple{T}, Tuple{Function, Type{T}, System}} where T<:SupplementalAttribute","page":"Public API","title":"InfrastructureSystems.get_supplemental_attributes","text":"get_supplemental_attributes(\n filter_func::Function,\n _::Type{T<:SupplementalAttribute},\n sys::System\n) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:SupplementalAttribute, I<:(Vector)}\n\n\nReturns an iterator of supplemental attributes. T can be concrete or abstract. Call collect on the result if an array is desired.\n\nExamples\n\niter = get_supplemental_attributes(GeometricDistributionForcedOutage, sys)\niter = get_supplemental_attributes(Outage, sys)\niter = get_supplemental_attributes(x -> get_mean_time_to_recovery(x) == >= 0.5, GeometricDistributionForcedOutage, sys)\noutages = get_supplemental_attributes(GeometricDistributionForcedOutage, sys) do outage\n get_mean_time_to_recovery(x) == >= 0.5\nend\noutages = collect(get_supplemental_attributes(GeometricDistributionForcedOutage, sys))\n\nSee also: iterate_supplemental_attributes\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_multiple-2","page":"Public API","title":"InfrastructureSystems.get_time_series_multiple","text":"get_time_series_multiple(sys::System; ...) -> Channel{Any}\nget_time_series_multiple(\n sys::System,\n filter_func;\n type,\n name\n) -> Channel{Any}\n\n\nReturn an iterator of time series in order of initial time.\n\nNote that passing a filter function can be much slower than the other filtering parameters because it reads time series data from media.\n\nCall collect on the result to get an array.\n\nArguments\n\ndata::SystemData: system\nfilter_func = nothing: Only return time series for which this returns true.\ntype = nothing: Only return time series with this type.\nname = nothing: Only return time series matching this value.\n\nExamples\n\nfor time_series in get_time_series_multiple(sys)\n @show time_series\nend\n\nts = collect(get_time_series_multiple(sys; type = SingleTimeSeries))\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{Component, AbstractString}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(\n component::Component,\n name::AbstractString\n) -> AbstractString\n\n\nSet the name of a component.\n\nThrows an exception if the component is attached to a system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{System, AbstractString}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(\n sys::System,\n name::AbstractString\n) -> AbstractString\n\n\nSet the name of the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{System, Component, AbstractString}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(\n sys::System,\n component::Component,\n name::AbstractString\n)\n\n\nSet the name for a component that is attached to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.to_json-Tuple{System, AbstractString}","page":"Public API","title":"InfrastructureSystems.to_json","text":"to_json(\n sys::System,\n filename::AbstractString;\n user_data,\n pretty,\n force,\n runchecks\n)\n\n\nSerializes a system to a JSON file and saves time series to an HDF5 file.\n\nArguments\n\nsys::System: system\nfilename::AbstractString: filename to write\n\nKeyword arguments\n\nuser_data::Union{Nothing, Dict} = nothing: optional metadata to record\npretty::Bool = false: whether to pretty-print the JSON\nforce::Bool = false: whether to overwrite existing files\ncheck::Bool = false: whether to run system validation checks\n\nRefer to check_component for exceptions thrown if check = true.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_component!-Tuple{System, DynamicInjection, StaticInjection}","page":"Public API","title":"PowerSystems.add_component!","text":"add_component!(\n sys::System,\n dyn_injector::DynamicInjection,\n static_injector::StaticInjection;\n kwargs...\n)\n\n\nAdd a dynamic injector to the system.\n\nA component cannot be added to more than one System. Throws ArgumentError if the name does not match the static_injector name. Throws ArgumentError if the static_injector is not attached to the system.\n\nAll rules for the generic add_component! method also apply.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_component!-Union{Tuple{T}, Tuple{System, T}} where T<:Component","page":"Public API","title":"PowerSystems.add_component!","text":"add_component!(\n sys::System,\n component::Component;\n skip_validation,\n kwargs...\n)\n\n\nAdd a component to the system.\n\nA component cannot be added to more than one System. 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.\n\nExamples\n\nsys = System(100.0)\n\n# Add a single component.\nadd_component!(sys, bus)\n\n# Add many at once.\nbuses = [bus1, bus2, bus3]\ngenerators = [gen1, gen2, gen3]\nforeach(x -> add_component!(sys, x), Iterators.flatten((buses, generators)))\n\nSee also add_components!.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_components!-Tuple{System, Any}","page":"Public API","title":"PowerSystems.add_components!","text":"add_components!(sys::System, components)\n\n\nAdd many components to the system at once.\n\nA component cannot be added to more than one System. 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.\n\nExamples\n\nsys = System(100.0)\n\nbuses = [bus1, bus2, bus3]\ngenerators = [gen1, gen2, gen3]\nadd_components!(sys, Iterators.flatten((buses, generators))\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{Device, Service, System}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(device::Device, service::Service, sys::System)\n\n\nSimilar to add_service! but for Service and Device already stored in the system. Performs validation checks on the device and the system\n\nArguments\n\ndevice::Device: Device\nservice::Service: Service\nsys::System: system\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{System, ConstantReserveGroup, Vector{<:Service}}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(\n sys::System,\n service::ConstantReserveGroup,\n contributing_services::Vector{<:Service};\n skip_validation,\n kwargs...\n)\n\n\nSimilar to add_component! but for ConstantReserveGroup.\n\nArguments\n\nsys::System: system\nservice::ConstantReserveGroup: service to add\ncontributing_services: contributing services to the group\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{System, ConstantReserveGroup}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(\n sys::System,\n service::ConstantReserveGroup;\n skip_validation,\n kwargs...\n)\n\n\nSimilar to add_component! but for ConstantReserveGroup.\n\nArguments\n\nsys::System: system\nservice::ConstantReserveGroup: service to add\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{System, Service, Any}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(\n sys::System,\n service::Service,\n contributing_devices;\n kwargs...\n)\n\n\nSimilar to add_component! but for services.\n\nArguments\n\nsys::System: system\nservice::Service: service to add\ncontributing_devices: Must be an iterable of type Device\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{System, Service, Device}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(\n sys::System,\n service::Service,\n contributing_device::Device;\n kwargs...\n)\n\n\nSimilar to add_component! but for services.\n\nArguments\n\nsys::System: system\nservice::Service: service to add\ncontributing_device::Device: Valid Device\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_supplemental_attribute!-Tuple{System, Component, SupplementalAttribute}","page":"Public API","title":"PowerSystems.add_supplemental_attribute!","text":"add_supplemental_attribute!(\n sys::System,\n component::Component,\n attribute::SupplementalAttribute\n)\n\n\nAdd a supplemental attribute to the component. The attribute may already be attached to a different component.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_time_series!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.add_time_series!","text":"add_time_series!(\n sys::System,\n metadata_file::AbstractString;\n resolution\n) -> Vector{TimeSeriesKey}\n\n\nAdd time series data from a metadata file or metadata descriptors.\n\nArguments\n\nsys::System: system\nmetadata_file::AbstractString: metadata file for timeseries that includes an array of IS.TimeSeriesFileMetadata instances or a vector.\nresolution::DateTime.Period=nothing: skip time series that don't match this resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_time_series!-Tuple{System, Any, TimeSeriesData}","page":"Public API","title":"PowerSystems.add_time_series!","text":"add_time_series!(\n sys::System,\n components,\n time_series::TimeSeriesData;\n features...\n) -> TimeSeriesKey\n\n\nAdd the same time series data to multiple components.\n\nThis function stores a single copy of the data. Each component will store a reference to that data. 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.\n\nThrows ArgumentError if a component is not stored in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_time_series!-Tuple{System, Component, TimeSeriesData}","page":"Public API","title":"PowerSystems.add_time_series!","text":"add_time_series!(\n sys::System,\n component::Component,\n time_series::TimeSeriesData;\n features...\n) -> TimeSeriesKey\n\n\nAdd time series data to a component.\n\nThrows ArgumentError if the component is not stored in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_time_series!-Tuple{System, Vector{InfrastructureSystems.TimeSeriesFileMetadata}}","page":"Public API","title":"PowerSystems.add_time_series!","text":"add_time_series!(\n sys::System,\n file_metadata::Vector{InfrastructureSystems.TimeSeriesFileMetadata};\n resolution\n) -> Vector{TimeSeriesKey}\n\n\nAdd time series data from a metadata file or metadata descriptors.\n\nArguments\n\nsys::System: system\ntimeseries_metadata::Vector{IS.TimeSeriesFileMetadata}: metadata for timeseries\nresolution::DateTime.Period=nothing: skip time series that don't match this resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.bulk_add_time_series!-Tuple{System, Any}","page":"Public API","title":"PowerSystems.bulk_add_time_series!","text":"bulk_add_time_series!(\n sys::System,\n associations;\n batch_size\n) -> Vector{TimeSeriesKey}\n\n\nAdd many time series in bulk\n\nThis method is advantageous when adding thousands of time series arrays because of the overhead in writing the time series to the underlying storage.\n\nArguments\n\nsys::System: system\nassociations: Iterable of TimeSeriesAssociation instances. Using a Vector is not recommended. Pass a Generator or Iterator to avoid loading all time series data into system memory at once.\nbatch_size::Int: (Default = 100) Number of time series to add per batch.\n\nExamples\n\n# Assumes `read_time_series` will return data appropriate for Deterministic forecasts\n# based on the generator name and the filenames match the component and time series names.\nresolution = Dates.Hour(1)\nassociations = (\n IS.TimeSeriesAssociation(\n gen,\n Deterministic(\n data = read_time_series(get_name(gen) * \".csv\"),\n name = \"get_max_active_power\",\n resolution=resolution),\n )\n for gen in get_components(ThermalStandard, sys)\n)\nbulk_add_time_series!(sys, associations)\n\nSee also: open_time_series_store! to minimize HDF5 file handle overhead if you must add time series arrays one at a time\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check-Tuple{System}","page":"Public API","title":"PowerSystems.check","text":"check(sys::System)\n\n\nCheck system consistency and validity.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_component-Tuple{System, Component}","page":"Public API","title":"PowerSystems.check_component","text":"check_component(sys::System, component::Component)\n\n\nCheck the values of a component.\n\nThrows 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_components-Tuple{System, Any}","page":"Public API","title":"PowerSystems.check_components","text":"check_components(sys::System, components)\n\n\nCheck the values of each component in an iterable of components. See check_component for exceptions thrown.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_components-Tuple{System}","page":"Public API","title":"PowerSystems.check_components","text":"check_components(sys::System; check_masked_components)\n\n\nCheck the values of all components. See check_component for exceptions thrown.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_components-Union{Tuple{T}, Tuple{System, Type{T}}} where T<:Component","page":"Public API","title":"PowerSystems.check_components","text":"check_components(\n sys::System,\n ::Type{T<:Component};\n check_masked_components\n)\n\n\nCheck the values of components of a given abstract or concrete type. See check_component for exceptions thrown.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_time_series_consistency-Union{Tuple{T}, Tuple{System, Type{T}}} where T<:TimeSeriesData","page":"Public API","title":"PowerSystems.check_time_series_consistency","text":"check_time_series_consistency(\n sys::System,\n _::Type{T<:TimeSeriesData}\n) -> Union{Nothing, Tuple{Any, Any}}\n\n\nChecks time series in the system for inconsistencies.\n\nFor SingleTimeSeries, returns a Tuple of initial_timestamp and length.\n\nThis is a no-op for subtypes of Forecast because those are already guaranteed to be consistent.\n\nThrows InfrastructureSystems.InvalidValue if any time series is inconsistent.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.clear_components!-Tuple{System}","page":"Public API","title":"PowerSystems.clear_components!","text":"clear_components!(sys::System)\n\n\nRemove all components from the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.clear_ext!-Tuple{System}","page":"Public API","title":"PowerSystems.clear_ext!","text":"clear_ext!(sys::System)\n\n\nClear any value stored in ext.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.clear_time_series!-Tuple{System}","page":"Public API","title":"PowerSystems.clear_time_series!","text":"clear_time_series!(sys::System)\n\n\nClear all time series data from the system.\n\nIf you are storing time series data in an HDF5 file, this will will delete the HDF5 file and create a new one.\n\nSee also: remove_time_series!\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.convert_component!-Tuple{System, Line, Type{MonitoredLine}}","page":"Public API","title":"PowerSystems.convert_component!","text":"convert_component!(\n sys::System,\n line::Line,\n linetype::Type{MonitoredLine};\n kwargs...\n)\n\n\nConverts a Line component to a MonitoredLine component and replaces the original in the system\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.convert_component!-Tuple{System, MonitoredLine, Type{Line}}","page":"Public API","title":"PowerSystems.convert_component!","text":"convert_component!(\n sys::System,\n line::MonitoredLine,\n linetype::Type{Line};\n kwargs...\n)\n\n\nConverts a MonitoredLine component to a Line component and replaces the original in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.convert_component!-Tuple{System, PowerLoad, Type{StandardLoad}}","page":"Public API","title":"PowerSystems.convert_component!","text":"convert_component!(\n sys::System,\n old_load::PowerLoad,\n new_type::Type{StandardLoad};\n kwargs...\n)\n\n\nConverts 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.filter_components_by_subsystem!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.filter_components_by_subsystem!","text":"filter_components_by_subsystem!(\n sys::System,\n subsystem::AbstractString;\n runchecks\n)\n\n\nFilter out all components that are not part of the subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.from_subsystem-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.from_subsystem","text":"from_subsystem(\n sys::System,\n subsystem::AbstractString;\n runchecks\n) -> System\n\n\nConstruct a System from a subsystem of an existing system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_aggregation_topology_mapping-Union{Tuple{T}, Tuple{Type{T}, System}} where T<:AggregationTopology","page":"Public API","title":"PowerSystems.get_aggregation_topology_mapping","text":"get_aggregation_topology_mapping(\n _::Type{T<:AggregationTopology},\n sys::System\n) -> Dict{String, Vector{ACBus}}\n\n\nReturn a mapping of AggregationTopology name to vector of buses within it.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_available_components-Union{Tuple{T}, Tuple{Type{T}, System}} where T<:Component","page":"Public API","title":"PowerSystems.get_available_components","text":"get_available_components(\n _::Type{T<:Component},\n sys::System\n) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:Component, I<:(Vector)}\n\n\nGets components availability. Requires type T to have the method get_available implemented.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_base_power-Tuple{System}","page":"Public API","title":"PowerSystems.get_base_power","text":"get_base_power(sys::System) -> Float64\n\n\nReturn the system's base power.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_bus-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.get_bus","text":"get_bus(\n sys::System,\n name::AbstractString\n) -> Union{Nothing, InfrastructureSystems.InfrastructureSystemsComponent}\n\n\nReturn bus with name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_bus-Tuple{System, Int64}","page":"Public API","title":"PowerSystems.get_bus","text":"get_bus(sys::System, bus_number::Int64) -> Any\n\n\nReturn bus with bus_number.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_bus_numbers-Tuple{System}","page":"Public API","title":"PowerSystems.get_bus_numbers","text":"get_bus_numbers(sys::System) -> Vector{Int64}\n\n\nReturn a sorted vector of bus numbers in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_buses-Tuple{System, AggregationTopology}","page":"Public API","title":"PowerSystems.get_buses","text":"get_buses(\n sys::System,\n aggregator::AggregationTopology\n) -> Vector{ACBus}\n\n\nReturn a vector of buses contained within the AggregationTopology.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_buses-Tuple{System, Set{Int64}}","page":"Public API","title":"PowerSystems.get_buses","text":"get_buses(\n sys::System,\n bus_numbers::Set{Int64}\n) -> Vector{ACBus}\n\n\nReturn all buses values with bus_numbers.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_component-Tuple{System, Base.UUID}","page":"Public API","title":"PowerSystems.get_component","text":"get_component(\n sys::System,\n uuid::Base.UUID\n) -> InfrastructureSystems.InfrastructureSystemsComponent\n\n\nGet the component by UUID.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_component-Union{Tuple{T}, Tuple{Type{T}, System, AbstractString}} where T<:Component","page":"Public API","title":"PowerSystems.get_component","text":"get_component(\n _::Type{T<:Component},\n sys::System,\n name::AbstractString\n) -> Union{Nothing, InfrastructureSystems.InfrastructureSystemsComponent}\n\n\nGet 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.\n\nSee get_components_by_name for abstract types with non-unique names across subtypes.\n\nThrows ArgumentError if T is not a concrete type and there is more than one component with requested name\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_components-Tuple{System, SupplementalAttribute}","page":"Public API","title":"PowerSystems.get_components","text":"get_components(\n sys::System,\n attribute::SupplementalAttribute\n) -> Any\n\n\nReturn a vector of components that are attached to the supplemental attribute.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_components-Union{Tuple{T}, Tuple{Type{T}, System}} where T<:Component","page":"Public API","title":"PowerSystems.get_components","text":"get_components(\n ::Type{T<:Component},\n sys::System;\n subsystem_name\n) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:Component, I<:(Vector)}\n\n\nReturns an iterator of components. T can be concrete or abstract. Call collect on the result if an array is desired.\n\nExamples\n\niter = PowerSystems.get_components(ThermalStandard, sys)\niter = PowerSystems.get_components(Generator, sys)\niter = PowerSystems.get_components(x -> PowerSystems.get_available(x), Generator, sys)\nthermal_gens = get_components(ThermalStandard, sys) do gen\n get_available(gen)\nend\ngenerators = collect(PowerSystems.get_components(Generator, sys))\n\n\nSee also: iterate_components\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_components_by_name-Union{Tuple{T}, Tuple{Type{T}, System, AbstractString}} where T<:Component","page":"Public API","title":"PowerSystems.get_components_by_name","text":"get_components_by_name(\n _::Type{T<:Component},\n sys::System,\n name::AbstractString\n) -> Vector{T} where T<:InfrastructureSystems.InfrastructureSystemsComponent\n\n\nGet the components of abstract type T with name. Note that PowerSystems enforces unique names on each concrete type but not across concrete types.\n\nSee get_component if the concrete type is known.\n\nThrows ArgumentError if T is not an abstract type.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_components_in_aggregation_topology-Union{Tuple{T}, Tuple{Type{T}, System, AggregationTopology}} where T<:StaticInjection","page":"Public API","title":"PowerSystems.get_components_in_aggregation_topology","text":"get_components_in_aggregation_topology(\n _::Type{T<:StaticInjection},\n sys::System,\n aggregator::AggregationTopology\n) -> Vector{T} where T<:StaticInjection\n\n\nReturn a vector of components with buses in the AggregationTopology.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_compression_settings-Tuple{System}","page":"Public API","title":"PowerSystems.get_compression_settings","text":"get_compression_settings(sys::System) -> CompressionSettings\n\n\nReturn the compression settings used for system data such as time series arrays.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_contributing_device_mapping-Tuple{System}","page":"Public API","title":"PowerSystems.get_contributing_device_mapping","text":"get_contributing_device_mapping(\n sys::System\n) -> Dict{@NamedTuple{type::DataType, name::String}, ServiceContributingDevices}\n\n\nReturn an instance of ServiceContributingDevicesMapping.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_contributing_devices-Union{Tuple{T}, Tuple{System, T}} where T<:Service","page":"Public API","title":"PowerSystems.get_contributing_devices","text":"get_contributing_devices(\n sys::System,\n service::Service\n) -> Vector\n\n\nReturn a vector of devices contributing to the service.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_description-Tuple{System}","page":"Public API","title":"PowerSystems.get_description","text":"get_description(sys::System) -> Union{Nothing, String}\n\n\nGet the description of the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_existing_component_types-Tuple{System}","page":"Public API","title":"PowerSystems.get_existing_component_types","text":"get_existing_component_types(\n sys::System\n) -> Vector{DataType}\n\n\nReturn all the component types in the system. It does not return masked components.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_existing_device_types-Tuple{System}","page":"Public API","title":"PowerSystems.get_existing_device_types","text":"get_existing_device_types(sys::System) -> Vector{DataType}\n\n\nReturn all the device types in the system. It does not return component types or masked components.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_ext-Tuple{System}","page":"Public API","title":"PowerSystems.get_ext","text":"get_ext(sys::System) -> Union{Nothing, Dict{String, Any}}\n\n\nReturn a user-modifiable dictionary to store extra information.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_horizon-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_horizon","text":"get_forecast_horizon(sys::System) -> Any\n\n\nReturn the horizon for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_initial_times-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_initial_times","text":"get_forecast_initial_times(\n sys::System\n) -> Union{Vector{Any}, Vector{Dates.DateTime}, StepRangeLen{T, R, S, Int64} where {T, R>:Dates.DateTime, S}}\n\n\nReturn the initial times for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_initial_timestamp-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_initial_timestamp","text":"get_forecast_initial_timestamp(sys::System) -> Any\n\n\nReturn the initial_timestamp for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_interval-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_interval","text":"get_forecast_interval(sys::System) -> Any\n\n\nReturn the interval for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_window_count-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_window_count","text":"get_forecast_window_count(sys::System) -> Any\n\n\nReturn the window count for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_frequency-Tuple{System}","page":"Public API","title":"PowerSystems.get_frequency","text":"get_frequency(sys::System) -> Float64\n\n\nReturn the system's frequency.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_runchecks-Tuple{System}","page":"Public API","title":"PowerSystems.get_runchecks","text":"get_runchecks(sys::System) -> Bool\n\n\nReturn true if checks are enabled on the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_time_series_counts-Tuple{System}","page":"Public API","title":"PowerSystems.get_time_series_counts","text":"get_time_series_counts(sys::System) -> TimeSeriesCounts\n\n\nReturns counts of time series including attachments to components and supplemental attributes.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_time_series_resolutions-Tuple{System}","page":"Public API","title":"PowerSystems.get_time_series_resolutions","text":"get_time_series_resolutions(\n sys::System;\n time_series_type\n) -> Any\n\n\nReturn a sorted Vector of distinct resolutions for all time series of the given type (or all types).\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_units_base-Tuple{System}","page":"Public API","title":"PowerSystems.get_units_base","text":"get_units_base(system::System) -> String\n\n\nGet the system's unit base)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_component-Tuple{System, Type{<:Component}, AbstractString}","page":"Public API","title":"PowerSystems.has_component","text":"has_component(\n sys::System,\n T::Type{<:Component},\n name::AbstractString\n) -> Bool\n\n\nCheck to see if the component of type T with name exists.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_component-Tuple{System, Type{<:Component}}","page":"Public API","title":"PowerSystems.has_component","text":"has_component(sys::System, T::Type{<:Component})\n\n\nCheck to see if the component of type T exists.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.is_component_in_aggregation_topology-Union{Tuple{T}, Tuple{Component, T}} where T<:AggregationTopology","page":"Public API","title":"PowerSystems.is_component_in_aggregation_topology","text":"is_component_in_aggregation_topology(\n comp::Component,\n aggregator::AggregationTopology\n) -> Union{Missing, Bool}\n\n\nReturn whether the given component's bus is in the AggregationTopology.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.iterate_components-Tuple{System}","page":"Public API","title":"PowerSystems.iterate_components","text":"iterate_components(\n sys::System\n) -> Base.Iterators.Flatten{Base.Generator{Base.ValueIterator{Dict{DataType, Dict{String, <:InfrastructureSystems.InfrastructureSystemsComponent}}}, InfrastructureSystems.var\"#110#111\"}}\n\n\nIterates over all components.\n\nExamples\n\nfor component in iterate_components(sys)\n @show component\nend\n\nSee also: get_components\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.iterate_supplemental_attributes-Tuple{System}","page":"Public API","title":"PowerSystems.iterate_supplemental_attributes","text":"iterate_supplemental_attributes(\n sys::System\n) -> Base.Iterators.Flatten{Base.Generator{Base.ValueIterator{Dict{DataType, Dict{Base.UUID, <:SupplementalAttribute}}}, InfrastructureSystems.var\"#110#111\"}}\n\n\nIterates over all supplemental_attributes.\n\nExamples\n\nfor supplemental_attribute in iterate_supplemental_attributes(sys)\n @show supplemental_attribute\nend\n\nSee also: get_supplemental_attributes\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.open_time_series_store!","page":"Public API","title":"PowerSystems.open_time_series_store!","text":"open_time_series_store!(\n func::Function,\n sys::System;\n ...\n) -> Any\nopen_time_series_store!(\n func::Function,\n sys::System,\n mode,\n args...;\n kwargs...\n) -> Any\n\n\nOpen the time series store for bulk additions or reads\n\nThis is recommended before calling add_time_series! many times because of the overhead associated with opening and closing an HDF5 file.\n\nThis is not necessary for an in-memory time series store.\n\nExamples\n\n# Assume there is a system with an array of Components and SingleTimeSeries\n# stored in the variables components and single_time_series, respectively\nopen_time_series_store!(sys, \"r+\") do\n for (component, ts) in zip(components, single_time_series)\n add_time_series!(sys, component, ts)\n end\nend\n\nYou can also use this function to make reads faster. Change the mode from \"r+\" to \"r\" to open the file read-only.\n\nSee also: bulk_add_time_series!\n\n\n\n\n\n","category":"function"},{"location":"api/public/#PowerSystems.remove_component!-Union{Tuple{T}, Tuple{System, T}} where T<:Component","page":"Public API","title":"PowerSystems.remove_component!","text":"remove_component!(sys::System, component::Component)\n\n\nRemove a component from the system by its value.\n\nThrows ArgumentError if the component is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_component!-Union{Tuple{T}, Tuple{Type{T}, System, AbstractString}} where T<:Component","page":"Public API","title":"PowerSystems.remove_component!","text":"remove_component!(\n _::Type{T<:Component},\n sys::System,\n name::AbstractString\n)\n\n\nRemove a component from the system by its name.\n\nThrows ArgumentError if the component is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_supplemental_attribute!-Tuple{System, Component, SupplementalAttribute}","page":"Public API","title":"PowerSystems.remove_supplemental_attribute!","text":"remove_supplemental_attribute!(\n sys::System,\n component::Component,\n attribute::SupplementalAttribute\n)\n\n\nRemove the supplemental attribute from the component. The attribute will be removed from the system if it is not attached to any other component.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_supplemental_attribute!-Tuple{System, SupplementalAttribute}","page":"Public API","title":"PowerSystems.remove_supplemental_attribute!","text":"remove_supplemental_attribute!(\n sys::System,\n attribute::SupplementalAttribute\n)\n\n\nRemove the supplemental attribute from the system and all attached components.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_supplemental_attributes!-Union{Tuple{T}, Tuple{Type{T}, System}} where T<:SupplementalAttribute","page":"Public API","title":"PowerSystems.remove_supplemental_attributes!","text":"remove_supplemental_attributes!(\n _::Type{T<:SupplementalAttribute},\n sys::System\n)\n\n\nRemove all supplemental attributes with the given type from the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_time_series!-Union{Tuple{T}, Tuple{System, Type{T}, Component, String}} where T<:TimeSeriesData","page":"Public API","title":"PowerSystems.remove_time_series!","text":"remove_time_series!(\n sys::System,\n _::Type{T<:TimeSeriesData},\n component::Component,\n name::String\n)\n\n\nRemove the time series data for a component and time series type.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_time_series!-Union{Tuple{T}, Tuple{System, Type{T}}} where T<:TimeSeriesData","page":"Public API","title":"PowerSystems.remove_time_series!","text":"remove_time_series!(sys::System, _::Type{T<:TimeSeriesData})\n\n\nRemove all the time series data for a time series type.\n\nSee also: clear_time_series!\n\nIf you are storing time series data in an HDF5 file, remove_time_series! does not actually free up file space (HDF5 behavior). If you want to remove all or most time series instances then consider using clear_time_series!. It will delete the HDF5 file and create a new one. PowerSystems has plans to automate this type of workflow.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.sanitize_component!-Tuple{Component, System}","page":"Public API","title":"PowerSystems.sanitize_component!","text":"sanitize_component!(component::Component, sys::System)\n\n\nSanitize component values.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_contributing_services!-Tuple{System, ConstantReserveGroup, Vector{<:Service}}","page":"Public API","title":"PowerSystems.set_contributing_services!","text":"set_contributing_services!(\n sys::System,\n service::ConstantReserveGroup,\n val::Vector{<:Service}\n)\n\n\nSet ConstantReserveGroup contributing_services with check\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_description!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.set_description!","text":"set_description!(\n sys::System,\n description::AbstractString\n) -> AbstractString\n\n\nSet the description of the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_runchecks!-Tuple{System, Bool}","page":"Public API","title":"PowerSystems.set_runchecks!","text":"set_runchecks!(sys::System, value::Bool)\n\n\nEnable or disable system checks. Applies to component addition as well as overall system consistency.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_units_base_system!-Tuple{System, String}","page":"Public API","title":"PowerSystems.set_units_base_system!","text":"set_units_base_system!(system::System, settings::String)\n\n\nSets the units base for the getter functions on the devices. It modifies the behavior of all getter functions\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.transform_single_time_series!-Tuple{System, Dates.Period, Dates.Period}","page":"Public API","title":"PowerSystems.transform_single_time_series!","text":"transform_single_time_series!(\n sys::System,\n horizon::Dates.Period,\n interval::Dates.Period\n)\n\n\nTransform all instances of SingleTimeSeries in a System to DeterministicSingleTimeSeries\n\nThis can be used to generate a perfect forecast from historical measurements or realizations when actual forecasts are unavailable, without unnecessarily duplicating data.\n\nIf all SingleTimeSeries instances cannot be transformed then none will be.\n\nAny existing DeterministicSingleTimeSeries forecasts will be deleted even if the inputs are invalid.\n\nArguments\n\nsys::System: System containing the components.\nhorizon::Dates.Period: desired horizon of each forecast window\ninterval::Dates.Period: desired interval between forecast windows\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.validate_component-Tuple{Component}","page":"Public API","title":"PowerSystems.validate_component","text":"validate_component(component::Component) -> Bool\n\n\nValidate the component fields using only those fields. Refer to validate_component_with_system to use other System data for the validation.\n\nReturn true if the instance is valid.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.validate_component_with_system-Tuple{Component, System}","page":"Public API","title":"PowerSystems.validate_component_with_system","text":"validate_component_with_system(\n component::Component,\n sys::System\n) -> Bool\n\n\nValidate a component against System data. Return true if the instance is valid.\n\nRefer to validate_component if the validation logic only requires data contained within the instance.\n\n\n\n\n\n","category":"method"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"utils/print.jl\",\n \"utils/generate_struct_files.jl\"]\nPublic = true\nPrivate = false\nFilter = t -> t ∉ [System]","category":"page"},{"location":"api/public/#InfrastructureSystems.show_time_series-Tuple{System}","page":"Public API","title":"InfrastructureSystems.show_time_series","text":"show_time_series(sys::System)\n\n\nShow a table with the summary of time series attached to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.show_components","page":"Public API","title":"PowerSystems.show_components","text":"show_components(\n sys::System,\n component_type::Type{<:Component};\n ...\n)\nshow_components(\n sys::System,\n component_type::Type{<:Component},\n additional_columns::Union{Dict, Vector};\n kwargs...\n)\n\n\nShow all components of the given type in a table.\n\nArguments\n\nsys::System: System containing the components.\ncomponent_type::Type{<:Component}: Type to display. Must be a concrete type.\nadditional_columns::Union{Dict, Vector}: Additional columns to display. The Dict option is a mapping of column name to function. The function must accept a component. The Vector option is an array of field names for the component_type.\n\nExtra keyword arguments are forwarded to PrettyTables.pretty_table.\n\nExamples\n\nshow_components(sys, ThermalStandard)\nshow_components(sys, ThermalStandard, Dict(\"has_time_series\" => x -> has_time_series(x)))\nshow_components(sys, ThermalStandard, [:active_power, :reactive_power])\n\n\n\n\n\n","category":"function"},{"location":"api/public/#PowerSystems.generate_struct_file-Tuple{StructDefinition}","page":"Public API","title":"PowerSystems.generate_struct_file","text":"generate_struct_file(\n definition::StructDefinition;\n filename,\n output_directory\n)\n\n\nGenerate a Julia source code file for one struct from a StructDefinition.\n\nRefer to StructDefinition and StructField for descriptions of the available fields.\n\nArguments\n\ndefinition::StructDefinition: Defines the struct and all fields.\nfilename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json\noutput_directory::AbstractString: Generate the files in this directory. Defaults to src/models/generated\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.generate_struct_files-Tuple{Any}","page":"Public API","title":"PowerSystems.generate_struct_files","text":"generate_struct_files(\n definitions;\n filename,\n output_directory\n)\n\n\nGenerate Julia source code files for multiple structs from a iterable of StructDefinition instances.\n\nRefer to StructDefinition and StructField for descriptions of the available fields.\n\nArguments\n\ndefinitions: Defines the structs and all fields.\nfilename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json\noutput_directory::AbstractString: Generate the files in this directory. Defaults to src/models/generated\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Additional-Component-Methods","page":"Public API","title":"Additional Component Methods","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"supplemental_accessors.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"api/public/#PowerSystems.get_max_active_power-Tuple{T} where T<:Device","page":"Public API","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(d::Device) -> Any\n\n\nReturn the max active power for a device from getactivepower_limits.max\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_max_reactive_power-Tuple{RenewableDispatch}","page":"Public API","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(d::RenewableDispatch) -> Any\n\n\nReturn the max reactive power for the Renewable Generation calculated as the rating * powerfactor if reactivepower_limits is nothing\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_max_reactive_power-Tuple{T} where T<:Device","page":"Public API","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(d::Device) -> Any\n\n\nReturn the max reactive power for a device from getreactivepower_limits.max\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Parsing","page":"Public API","title":"Parsing","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"parsers/power_system_table_data.jl\",\n \"parsers/power_models_data.jl\",\n \"parsers/TAMU_data.jl\",\n \"parsers/psse_dynamic_data.jl\",\n \"parsers/pm_io/common.jl\"]\nPublic = true\nPrivate = false\nFilter = t -> t ∉ [System]","category":"page"},{"location":"api/public/#PowerSystems.PowerSystemTableData-Tuple{AbstractString, Float64, AbstractString}","page":"Public API","title":"PowerSystems.PowerSystemTableData","text":"PowerSystemTableData(\n directory::AbstractString,\n base_power::Float64,\n user_descriptor_file::AbstractString;\n descriptor_file,\n generator_mapping_file,\n timeseries_metadata_file\n) -> PowerSystemTableData\n\n\nReads in all the data stored in csv files The general format for data is folder: gen.csv branch.csv bus.csv .. load.csv\n\nArguments\n\ndirectory::AbstractString: directory containing CSV files\nbase_power::Float64: base power for System\nuser_descriptor_file::AbstractString: customized input descriptor file\ndescriptor_file=POWER_SYSTEM_DESCRIPTOR_FILE: PowerSystems descriptor file\ngenerator_mapping_file=GENERATOR_MAPPING_FILE: generator mapping configuration file\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.create_poly_cost-Tuple{Any, Any}","page":"Public API","title":"PowerSystems.create_poly_cost","text":"create_poly_cost(\n gen,\n cost_colnames\n) -> Union{Tuple{LinearCurve, Float64}, Tuple{QuadraticCurve, Float64}}\n\n\ncreate_poly_cost(gen, cost_colnames)\n\nReturn a Polynomial function cost based on the coeffiecients provided on gen.\n\nThree supported cases,\n\nIf three values are passed then we have data looking like: a2 * x^2 + a1 * x + a0,\nIf a1 and a0 are passed then we have data looking like: a1 * x + a0,\nIf only a1 is passed then we have data looking like: a1 * x.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.PowerModelsData","page":"Public API","title":"PowerSystems.PowerModelsData","text":"Container for data parsed by PowerModels\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.PowerModelsData-Tuple{Union{IO, String}}","page":"Public API","title":"PowerSystems.PowerModelsData","text":"PowerModelsData(\n file::Union{IO, String};\n kwargs...\n) -> PowerModelsData\n\n\nConstructs PowerModelsData from a raw file. Currently Supports MATPOWER and PSSE data files parsed by PowerModels.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.TamuSystem-Tuple{AbstractString}","page":"Public API","title":"PowerSystems.TamuSystem","text":"TamuSystem(tamu_folder::AbstractString; kwargs...) -> Any\n\n\nCreates 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\n\nThe general format for data is folder: [casename].raw [casename]loadtimeseriesMW.csv\n\nArguments\n\ndirectory::AbstractString: directory containing RAW and CSV files\n\nExamples\n\nsys = TamuSystem(\n \"./ACTIVSg25k\",\n config_path = \"ACTIVSg25k_validation.json\",\n bus_name_formatter = x->string(x[\"name\"]*\"-\"*string(x[\"index\"])),\n load_name_formatter = x->strip(join(x[\"source_id\"], \"_\"))\n)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_dyn_injectors!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.add_dyn_injectors!","text":"add_dyn_injectors!(sys::System, dyr_file::AbstractString)\n\n\nAdd to a system already created the dynamic components. The system should already be parsed from a .raw file.\n\nExamples:\n\ndyr_file = \"Example.dyr\"\nadd_dyn_injectors!(sys, dyr_file)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.parse_file-Tuple{IO}","page":"Public API","title":"PowerSystems.parse_file","text":"parse_file(\n io::IO;\n import_all,\n validate,\n correct_branch_rating,\n filetype\n) -> Any\n\n\nParses the iostream from a file\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.parse_file-Tuple{String}","page":"Public API","title":"PowerSystems.parse_file","text":"parse_file(\n file::String;\n import_all,\n validate,\n correct_branch_rating\n) -> Any\n\n\nparse_file(\n file;\n import_all = false,\n validate = true,\n correct_branch_rating = true,\n)\n\nParses a Matpower .m file or PTI (PSS(R)E-v33) .raw file into a PowerModels data structure. All fields from PTI files will be imported if import_all is true (Default: false).\n\n\n\n\n\n","category":"method"},{"location":"api/public/#logging","page":"Public API","title":"Logging","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"utils/logging.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"api/public/#PowerSystems.configure_logging-Tuple{}","page":"Public API","title":"PowerSystems.configure_logging","text":"configure_logging(\n;\n console_level,\n file_level,\n filename\n) -> MultiLogger\n\n\nCreates console and file loggers.\n\nNote: Log messages may not be written to the file until flush() or close() is called on the returned logger.\n\nArguments\n\nconsole_level = Logging.Error: level for console messages\nfile_level = Logging.Info: level for file messages\nfilename::Union{Nothing, AbstractString} = \"power-systems.log\": log file; pass nothing to disable file logging\n\nExample\n\nlogger = configure_logging(console_level = Logging.Info)\n@info \"log message\"\nclose(logger)\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#TwoTerminalHVDCDetailedLine","page":"TwoTerminalHVDCDetailedLine","title":"TwoTerminalHVDCDetailedLine","text":"","category":"section"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/","page":"TwoTerminalHVDCDetailedLine","title":"TwoTerminalHVDCDetailedLine","text":"Modules = [PowerSystems]\nPages = [\"generated/TwoTerminalHVDCDetailedLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.TwoTerminalHVDCDetailedLine","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.TwoTerminalHVDCDetailedLine","text":"mutable struct TwoTerminalHVDCDetailedLine <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n rating::Float64\n active_power_limits::MinMax\n arc::Arc\n converter_loss::Union{LinearCurve, QuadraticCurve}\n dc_current::Float64\n max_dc_current::Float64\n g::Float64\n voltage_limits::MinMax\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA High Voltage DC line, which must be connected to an ACBus on each end.\n\nThis model is appropriate for operational simulations with a linearized DC power flow approximation with losses using a voltage-current model. For modeling a DC network, see TModelHVDCLine\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flowing from the from-bus to the to-bus in DC.\nrating::Float64: Maximum output power rating of the converter (MVA), validation range: (0, nothing)\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW)\narc::Arc: An Arc defining this line from a bus to another bus\nconverter_loss::Union{LinearCurve, QuadraticCurve}: (default: LinearCurve(0.0)) Loss model coefficients. It accepts a linear model or quadratic. Same converter data is used in both ends.\ndc_current::Float64: (default: 0.0) DC current (A) on the converter on the from-bus DC side.\nmax_dc_current::Float64: (default: 1e8) Maximum stable dc current limits (A). Includes converter and DC line.\ng::Float64: (default: 0.0) Series conductance of the DC line in pu (SYSTEM_BASE)\nvoltage_limits::MinMax: (default: (min=0.0, max=999.9)) Limits on the Voltage at the DC Bus.\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#InfrastructureSystems.get_name-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"InfrastructureSystems.get_name","text":"get_name(value::TwoTerminalHVDCDetailedLine) -> String\n\n\nGet TwoTerminalHVDCDetailedLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_active_power_flow-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(\n value::TwoTerminalHVDCDetailedLine\n) -> Any\n\n\nGet TwoTerminalHVDCDetailedLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_active_power_limits-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::TwoTerminalHVDCDetailedLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCDetailedLine active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_arc-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_arc","text":"get_arc(value::TwoTerminalHVDCDetailedLine) -> Arc\n\n\nGet TwoTerminalHVDCDetailedLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_available-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_available","text":"get_available(value::TwoTerminalHVDCDetailedLine) -> Bool\n\n\nGet TwoTerminalHVDCDetailedLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_converter_loss-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_converter_loss","text":"get_converter_loss(\n value::TwoTerminalHVDCDetailedLine\n) -> Union{LinearCurve, QuadraticCurve}\n\n\nGet TwoTerminalHVDCDetailedLine converter_loss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_dc_current-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_dc_current","text":"get_dc_current(\n value::TwoTerminalHVDCDetailedLine\n) -> Float64\n\n\nGet TwoTerminalHVDCDetailedLine dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_ext-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_ext","text":"get_ext(\n value::TwoTerminalHVDCDetailedLine\n) -> Dict{String, Any}\n\n\nGet TwoTerminalHVDCDetailedLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_g-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_g","text":"get_g(value::TwoTerminalHVDCDetailedLine) -> Float64\n\n\nGet TwoTerminalHVDCDetailedLine g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_max_dc_current-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_max_dc_current","text":"get_max_dc_current(\n value::TwoTerminalHVDCDetailedLine\n) -> Float64\n\n\nGet TwoTerminalHVDCDetailedLine max_dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_rating-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_rating","text":"get_rating(value::TwoTerminalHVDCDetailedLine) -> Any\n\n\nGet TwoTerminalHVDCDetailedLine rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_services-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_services","text":"get_services(\n value::TwoTerminalHVDCDetailedLine\n) -> Vector{Service}\n\n\nGet TwoTerminalHVDCDetailedLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_voltage_limits-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_voltage_limits","text":"get_voltage_limits(\n value::TwoTerminalHVDCDetailedLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalHVDCDetailedLine voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_active_power_flow!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_active_power_limits!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_arc!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::TwoTerminalHVDCDetailedLine, val) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_available!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_available!","text":"set_available!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_converter_loss!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_converter_loss!","text":"set_converter_loss!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine converter_loss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_dc_current!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_dc_current!","text":"set_dc_current!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_ext!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::TwoTerminalHVDCDetailedLine, val) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_g!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_g!","text":"set_g!(value::TwoTerminalHVDCDetailedLine, val) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_max_dc_current!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_max_dc_current!","text":"set_max_dc_current!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine max_dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_rating!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_rating!","text":"set_rating!(value::TwoTerminalHVDCDetailedLine, val) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_services!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_services!","text":"set_services!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_voltage_limits!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_voltage_limits!","text":"set_voltage_limits!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#Reserves","page":"Reserves","title":"Reserves","text":"","category":"section"},{"location":"model_library/reserves/#Constant-Reserve","page":"Reserves","title":"Constant Reserve","text":"","category":"section"},{"location":"model_library/reserves/","page":"Reserves","title":"Reserves","text":"Modules = [PowerSystems]\nPages = [\"generated/ConstantReserve.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/reserves/#PowerSystems.ConstantReserve","page":"Reserves","title":"PowerSystems.ConstantReserve","text":"mutable struct ConstantReserve{T <: ReserveDirection} <: Reserve{T}\n name::String\n available::Bool\n time_frame::Float64\n requirement::Float64\n sustained_time::Float64\n max_output_fraction::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA reserve product with a constant procurement requirement, such as 3% of the system base power at all times.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)\nrequirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)\nsustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/reserves/#InfrastructureSystems.get_name-Tuple{ConstantReserve}","page":"Reserves","title":"InfrastructureSystems.get_name","text":"get_name(value::ConstantReserve) -> String\n\n\nGet ConstantReserve name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_available-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_available","text":"get_available(value::ConstantReserve) -> Bool\n\n\nGet ConstantReserve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_deployed_fraction-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(value::ConstantReserve) -> Float64\n\n\nGet ConstantReserve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_ext-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_ext","text":"get_ext(value::ConstantReserve) -> Dict{String, Any}\n\n\nGet ConstantReserve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_output_fraction-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_max_output_fraction","text":"get_max_output_fraction(value::ConstantReserve) -> Float64\n\n\nGet ConstantReserve max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_participation_factor-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::ConstantReserve\n) -> Float64\n\n\nGet ConstantReserve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_requirement-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_requirement","text":"get_requirement(value::ConstantReserve) -> Any\n\n\nGet ConstantReserve requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_sustained_time-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(value::ConstantReserve) -> Float64\n\n\nGet ConstantReserve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_time_frame-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::ConstantReserve) -> Float64\n\n\nGet ConstantReserve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_available!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_available!","text":"set_available!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_deployed_fraction!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_ext!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_ext!","text":"set_ext!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_output_fraction!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_max_output_fraction!","text":"set_max_output_fraction!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_participation_factor!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::ConstantReserve,\n val\n) -> Any\n\n\nSet ConstantReserve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_requirement!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_requirement!","text":"set_requirement!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_sustained_time!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_time_frame!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#Constant-Reserve-Group","page":"Reserves","title":"Constant Reserve Group","text":"","category":"section"},{"location":"model_library/reserves/","page":"Reserves","title":"Reserves","text":"Modules = [PowerSystems]\nPages = [\"generated/ConstantReserveGroup.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/reserves/#PowerSystems.ConstantReserveGroup","page":"Reserves","title":"PowerSystems.ConstantReserveGroup","text":"mutable struct ConstantReserveGroup{T <: ReserveDirection} <: Service\n name::String\n available::Bool\n requirement::Float64\n ext::Dict{String, Any}\n contributing_services::Vector{Service}\n internal::InfrastructureSystemsInternal\nend\n\nA reserve product met by a group of individual reserves.\n\nThe 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.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nrequirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)\next::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.\ncontributing_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\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/reserves/#InfrastructureSystems.get_name-Tuple{ConstantReserveGroup}","page":"Reserves","title":"InfrastructureSystems.get_name","text":"get_name(value::ConstantReserveGroup) -> String\n\n\nGet ConstantReserveGroup name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_available-Tuple{ConstantReserveGroup}","page":"Reserves","title":"PowerSystems.get_available","text":"get_available(value::ConstantReserveGroup) -> Bool\n\n\nGet ConstantReserveGroup available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_contributing_services-Tuple{ConstantReserveGroup}","page":"Reserves","title":"PowerSystems.get_contributing_services","text":"get_contributing_services(\n value::ConstantReserveGroup\n) -> Vector{Service}\n\n\nGet ConstantReserveGroup contributing_services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_ext-Tuple{ConstantReserveGroup}","page":"Reserves","title":"PowerSystems.get_ext","text":"get_ext(value::ConstantReserveGroup) -> Dict{String, Any}\n\n\nGet ConstantReserveGroup ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_requirement-Tuple{ConstantReserveGroup}","page":"Reserves","title":"PowerSystems.get_requirement","text":"get_requirement(value::ConstantReserveGroup) -> Any\n\n\nGet ConstantReserveGroup requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_available!-Tuple{ConstantReserveGroup, Any}","page":"Reserves","title":"PowerSystems.set_available!","text":"set_available!(value::ConstantReserveGroup, val) -> Any\n\n\nSet ConstantReserveGroup available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_ext!-Tuple{ConstantReserveGroup, Any}","page":"Reserves","title":"PowerSystems.set_ext!","text":"set_ext!(value::ConstantReserveGroup, val) -> Any\n\n\nSet ConstantReserveGroup ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_requirement!-Tuple{ConstantReserveGroup, Any}","page":"Reserves","title":"PowerSystems.set_requirement!","text":"set_requirement!(value::ConstantReserveGroup, val) -> Any\n\n\nSet ConstantReserveGroup requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#Variable-Reserve","page":"Reserves","title":"Variable Reserve","text":"","category":"section"},{"location":"model_library/reserves/","page":"Reserves","title":"Reserves","text":"Modules = [PowerSystems]\nPages = [\"generated/VariableReserve.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/reserves/#PowerSystems.VariableReserve","page":"Reserves","title":"PowerSystems.VariableReserve","text":"mutable struct VariableReserve{T <: ReserveDirection} <: Reserve{T}\n name::String\n available::Bool\n time_frame::Float64\n requirement::Float64\n sustained_time::Float64\n max_output_fraction::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA reserve product with a time-varying procurement requirement, such as a higher requirement during hours with an expected high load or high ramp.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)\nrequirement::Float64: the required quantity of the product should be scaled by a TimeSeriesData\nsustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/reserves/#InfrastructureSystems.get_name-Tuple{VariableReserve}","page":"Reserves","title":"InfrastructureSystems.get_name","text":"get_name(value::VariableReserve) -> String\n\n\nGet VariableReserve name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_available-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_available","text":"get_available(value::VariableReserve) -> Bool\n\n\nGet VariableReserve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_deployed_fraction-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(value::VariableReserve) -> Float64\n\n\nGet VariableReserve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_ext-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_ext","text":"get_ext(value::VariableReserve) -> Dict{String, Any}\n\n\nGet VariableReserve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_output_fraction-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_max_output_fraction","text":"get_max_output_fraction(value::VariableReserve) -> Float64\n\n\nGet VariableReserve max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_participation_factor-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::VariableReserve\n) -> Float64\n\n\nGet VariableReserve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_requirement-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_requirement","text":"get_requirement(value::VariableReserve) -> Float64\n\n\nGet VariableReserve requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_sustained_time-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(value::VariableReserve) -> Float64\n\n\nGet VariableReserve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_time_frame-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::VariableReserve) -> Float64\n\n\nGet VariableReserve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_available!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_available!","text":"set_available!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_deployed_fraction!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_ext!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_ext!","text":"set_ext!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_output_fraction!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_max_output_fraction!","text":"set_max_output_fraction!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_participation_factor!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::VariableReserve,\n val\n) -> Any\n\n\nSet VariableReserve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_requirement!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_requirement!","text":"set_requirement!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_sustained_time!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_time_frame!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#Reserve-Demand-Curve","page":"Reserves","title":"Reserve Demand Curve","text":"","category":"section"},{"location":"model_library/reserves/","page":"Reserves","title":"Reserves","text":"Modules = [PowerSystems]\nPages = [\"generated/ReserveDemandCurve.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/reserves/#PowerSystems.ReserveDemandCurve","page":"Reserves","title":"PowerSystems.ReserveDemandCurve","text":"mutable struct ReserveDemandCurve{T <: ReserveDirection} <: Reserve{T}\n variable::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}\n name::String\n available::Bool\n time_frame::Float64\n sustained_time::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA reserve product with an Operating Reserve Demand Curve (ORDC) for operational simulations.\n\nThe 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.\n\nWhen defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric\n\nArguments\n\nvariable::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\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)\nsustained_time::Float64: (default: 3600.0) the time in seconds that the reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/reserves/#InfrastructureSystems.get_name-Tuple{ReserveDemandCurve}","page":"Reserves","title":"InfrastructureSystems.get_name","text":"get_name(value::ReserveDemandCurve) -> String\n\n\nGet ReserveDemandCurve name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_available-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_available","text":"get_available(value::ReserveDemandCurve) -> Bool\n\n\nGet ReserveDemandCurve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_deployed_fraction-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(value::ReserveDemandCurve) -> Float64\n\n\nGet ReserveDemandCurve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_ext-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_ext","text":"get_ext(value::ReserveDemandCurve) -> Dict{String, Any}\n\n\nGet ReserveDemandCurve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_participation_factor-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::ReserveDemandCurve\n) -> Float64\n\n\nGet ReserveDemandCurve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_sustained_time-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(value::ReserveDemandCurve) -> Float64\n\n\nGet ReserveDemandCurve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_time_frame-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::ReserveDemandCurve) -> Float64\n\n\nGet ReserveDemandCurve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_variable-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_variable","text":"get_variable(\n value::ReserveDemandCurve\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}\n\n\nGet ReserveDemandCurve variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_available!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_available!","text":"set_available!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_deployed_fraction!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(\n value::ReserveDemandCurve,\n val\n) -> Any\n\n\nSet ReserveDemandCurve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_ext!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_participation_factor!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::ReserveDemandCurve,\n val\n) -> Any\n\n\nSet ReserveDemandCurve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_sustained_time!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_time_frame!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_variable!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_variable!","text":"set_variable!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#DCSource","page":"DCSource","title":"DCSource","text":"","category":"section"},{"location":"model_library/generated_DCSource/#FixedDCSource","page":"DCSource","title":"FixedDCSource","text":"","category":"section"},{"location":"model_library/generated_DCSource/","page":"DCSource","title":"DCSource","text":"Modules = [PowerSystems]\nPages = [\"/FixedDCSource.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_DCSource/#PowerSystems.FixedDCSource","page":"DCSource","title":"PowerSystems.FixedDCSource","text":"mutable struct FixedDCSource <: DCSource\n voltage::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Fixed DC Source that returns a fixed DC voltage\n\nArguments\n\nvoltage::Float64: Voltage (V), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) FixedDCSource has no states\nn_states::Int: (Do not modify.) FixedDCSource has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_DCSource/#PowerSystems.get_ext-Tuple{FixedDCSource}","page":"DCSource","title":"PowerSystems.get_ext","text":"get_ext(value::FixedDCSource) -> Dict{String, Any}\n\n\nGet FixedDCSource ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_n_states-Tuple{FixedDCSource}","page":"DCSource","title":"PowerSystems.get_n_states","text":"get_n_states(value::FixedDCSource) -> Int64\n\n\nGet FixedDCSource n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_states-Tuple{FixedDCSource}","page":"DCSource","title":"PowerSystems.get_states","text":"get_states(value::FixedDCSource) -> Vector{Symbol}\n\n\nGet FixedDCSource states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_voltage-Tuple{FixedDCSource}","page":"DCSource","title":"PowerSystems.get_voltage","text":"get_voltage(value::FixedDCSource) -> Float64\n\n\nGet FixedDCSource voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_ext!-Tuple{FixedDCSource, Any}","page":"DCSource","title":"PowerSystems.set_ext!","text":"set_ext!(value::FixedDCSource, val) -> Any\n\n\nSet FixedDCSource ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_voltage!-Tuple{FixedDCSource, Any}","page":"DCSource","title":"PowerSystems.set_voltage!","text":"set_voltage!(value::FixedDCSource, val) -> Any\n\n\nSet FixedDCSource voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#ZeroOrderBESS","page":"DCSource","title":"ZeroOrderBESS","text":"","category":"section"},{"location":"model_library/generated_DCSource/","page":"DCSource","title":"DCSource","text":"Modules = [PowerSystems]\nPages = [\"/ZeroOrderBESS.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_DCSource/#PowerSystems.ZeroOrderBESS","page":"DCSource","title":"PowerSystems.ZeroOrderBESS","text":"mutable struct ZeroOrderBESS <: DCSource\n rated_voltage::Float64\n rated_current::Float64\n battery_voltage::Float64\n battery_resistance::Float64\n dc_dc_inductor::Float64\n dc_link_capacitance::Float64\n fs::Float64\n kpv::Float64\n kiv::Float64\n kpi::Float64\n kii::Float64\n Vdc_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters for the DC-side with a Battery Energy Storage System from \"Grid-Coupled Dynamic Response of Battery-Driven Voltage Source Converters.\"\n\nArguments\n\nrated_voltage::Float64: Rated voltage (V), validation range: (0, nothing)\nrated_current::Float64: Rated current (A), validation range: (0, nothing)\nbattery_voltage::Float64: battery voltage in pu (DEVICE_BASE), validation range: (0, nothing)\nbattery_resistance::Float64: Battery resistance in pu (DEVICE_BASE), validation range: (0, nothing)\ndc_dc_inductor::Float64: DC/DC inductance in pu (DEVICE_BASE), validation range: (0, nothing)\ndc_link_capacitance::Float64: DC-link capacitance in pu (DEVICE_BASE), validation range: (0, nothing)\nfs::Float64: DC/DC converter switching frequency (kHz), validation range: (0, nothing)\nkpv::Float64: voltage controller proportional gain, validation range: (0, nothing)\nkiv::Float64: voltage controller integral gain, validation range: (0, nothing)\nkpi::Float64: current controller proportional gain, validation range: (0, nothing)\nkii::Float64: current controller integral gain, validation range: (0, nothing)\nVdc_ref::Float64: (default: 1.1) Reference DC-Voltage Set-point in pu (DEVICE_BASE), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ZeroOrderBESS model are:\n\nv_dc: DC-link voltage,\ni_b: Battery current,\n ν: integrator state of the voltage controller,\n ζ: integrator state of the PI current controller\n\nn_states::Int: (Do not modify.) ZeroOrderBESS has 4 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_DCSource/#PowerSystems.get_Vdc_ref-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_Vdc_ref","text":"get_Vdc_ref(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS Vdc_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_battery_resistance-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_battery_resistance","text":"get_battery_resistance(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS battery_resistance.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_battery_voltage-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_battery_voltage","text":"get_battery_voltage(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS battery_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_dc_dc_inductor-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_dc_dc_inductor","text":"get_dc_dc_inductor(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS dc_dc_inductor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_dc_link_capacitance-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_dc_link_capacitance","text":"get_dc_link_capacitance(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS dc_link_capacitance.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_ext-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_ext","text":"get_ext(value::ZeroOrderBESS) -> Dict{String, Any}\n\n\nGet ZeroOrderBESS ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_fs-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_fs","text":"get_fs(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS fs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_kii-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_kii","text":"get_kii(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS kii.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_kiv-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_kiv","text":"get_kiv(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_kpi-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_kpi","text":"get_kpi(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS kpi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_kpv-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_kpv","text":"get_kpv(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_n_states-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_n_states","text":"get_n_states(value::ZeroOrderBESS) -> Int64\n\n\nGet ZeroOrderBESS n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_rated_current-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_rated_current","text":"get_rated_current(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS rated_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_rated_voltage-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_rated_voltage","text":"get_rated_voltage(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS rated_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_states-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_states","text":"get_states(value::ZeroOrderBESS) -> Vector{Symbol}\n\n\nGet ZeroOrderBESS states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_Vdc_ref!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_Vdc_ref!","text":"set_Vdc_ref!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS Vdc_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_battery_resistance!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_battery_resistance!","text":"set_battery_resistance!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS battery_resistance.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_battery_voltage!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_battery_voltage!","text":"set_battery_voltage!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS battery_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_dc_dc_inductor!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_dc_dc_inductor!","text":"set_dc_dc_inductor!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS dc_dc_inductor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_dc_link_capacitance!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_dc_link_capacitance!","text":"set_dc_link_capacitance!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS dc_link_capacitance.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_ext!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_ext!","text":"set_ext!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_fs!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_fs!","text":"set_fs!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS fs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_kii!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_kii!","text":"set_kii!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS kii.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_kiv!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_kiv!","text":"set_kiv!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_kpi!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_kpi!","text":"set_kpi!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS kpi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_kpv!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_kpv!","text":"set_kpv!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_rated_current!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_rated_current!","text":"set_rated_current!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS rated_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_rated_voltage!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_rated_voltage!","text":"set_rated_voltage!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS rated_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#Shaft","page":"Shaft","title":"Shaft","text":"","category":"section"},{"location":"model_library/generated_Shaft/#FiveMassShaft","page":"Shaft","title":"FiveMassShaft","text":"","category":"section"},{"location":"model_library/generated_Shaft/","page":"Shaft","title":"Shaft","text":"Modules = [PowerSystems]\nPages = [\"/FiveMassShaft.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Shaft/#PowerSystems.FiveMassShaft","page":"Shaft","title":"PowerSystems.FiveMassShaft","text":"mutable struct FiveMassShaft <: Shaft\n H::Float64\n H_hp::Float64\n H_ip::Float64\n H_lp::Float64\n H_ex::Float64\n D::Float64\n D_hp::Float64\n D_ip::Float64\n D_lp::Float64\n D_ex::Float64\n D_12::Float64\n D_23::Float64\n D_34::Float64\n D_45::Float64\n K_hp::Float64\n K_ip::Float64\n K_lp::Float64\n K_ex::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 5 mass-spring shaft model. It contains a High-Pressure (HP) steam turbine, Intermediate-Pressure (IP) steam turbine, Low-Pressure (LP) steam turbine, the Rotor and an Exciter (EX) mover\n\nArguments\n\nH::Float64: Rotor inertia constant in MWs/MVA, validation range: (0, nothing)\nH_hp::Float64: High pressure turbine inertia constant in MWs/MVA, validation range: (0, nothing)\nH_ip::Float64: Intermediate pressure turbine inertia constant in MWs/MVA, validation range: (0, nothing)\nH_lp::Float64: Low pressure turbine inertia constant in MWs/MVA, validation range: (0, nothing)\nH_ex::Float64: Exciter inertia constant in MWs/MVA, validation range: (0, nothing)\nD::Float64: Rotor natural damping in pu, validation range: (0, nothing)\nD_hp::Float64: High pressure turbine natural damping in pu, validation range: (0, nothing)\nD_ip::Float64: Intermediate pressure turbine natural damping in pu, validation range: (0, nothing)\nD_lp::Float64: Low pressure turbine natural damping in pu, validation range: (0, nothing)\nD_ex::Float64: Exciter natural damping in pu, validation range: (0, nothing)\nD_12::Float64: High-Intermediate pressure turbine damping, validation range: (0, nothing)\nD_23::Float64: Intermediate-Low pressure turbine damping, validation range: (0, nothing)\nD_34::Float64: Low pressure turbine-Rotor damping, validation range: (0, nothing)\nD_45::Float64: Rotor-Exciter damping, validation range: (0, nothing)\nK_hp::Float64: High pressure turbine angle coefficient, validation range: (0, nothing)\nK_ip::Float64: Intermediate pressure turbine angle coefficient, validation range: (0, nothing)\nK_lp::Float64: Low pressure turbine angle coefficient, validation range: (0, nothing)\nK_ex::Float64: Exciter angle coefficient, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nδ: rotor angle,\nω: rotor speed,\nδ_hp: rotor angle of high pressure turbine,\nω_hp: rotor speed of high pressure turbine,\nδ_ip: rotor angle of intermediate pressure turbine,\nω_ip: rotor speed of intermediate pressure turbine,\nδ_lp: rotor angle of low pressure turbine,\nω_lp: rotor speed of low pressure turbine,\nδ_ex: rotor angle of exciter,\nω_lp: rotor speed of exciter\n\nn_states::Int: (Do not modify.) FiveMassShaft has 10 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D","text":"get_D(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_12-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_12","text":"get_D_12(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_12.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_23-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_23","text":"get_D_23(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_23.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_34-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_34","text":"get_D_34(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_34.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_45-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_45","text":"get_D_45(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_45.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_ex-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_ex","text":"get_D_ex(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_hp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_hp","text":"get_D_hp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_ip-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_ip","text":"get_D_ip(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_lp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_lp","text":"get_D_lp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H","text":"get_H(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H_ex-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H_ex","text":"get_H_ex(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H_hp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H_hp","text":"get_H_hp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H_ip-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H_ip","text":"get_H_ip(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H_lp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H_lp","text":"get_H_lp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_K_ex-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_K_ex","text":"get_K_ex(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft K_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_K_hp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_K_hp","text":"get_K_hp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft K_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_K_ip-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_K_ip","text":"get_K_ip(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft K_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_K_lp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_K_lp","text":"get_K_lp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft K_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_ext-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_ext","text":"get_ext(value::FiveMassShaft) -> Dict{String, Any}\n\n\nGet FiveMassShaft ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_n_states-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_n_states","text":"get_n_states(value::FiveMassShaft) -> Int64\n\n\nGet FiveMassShaft n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_states-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_states","text":"get_states(value::FiveMassShaft) -> Vector{Symbol}\n\n\nGet FiveMassShaft states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D!","text":"set_D!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_12!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_12!","text":"set_D_12!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_12.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_23!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_23!","text":"set_D_23!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_23.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_34!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_34!","text":"set_D_34!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_34.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_45!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_45!","text":"set_D_45!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_45.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_ex!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_ex!","text":"set_D_ex!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_hp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_hp!","text":"set_D_hp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_ip!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_ip!","text":"set_D_ip!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_lp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_lp!","text":"set_D_lp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H!","text":"set_H!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H_ex!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H_ex!","text":"set_H_ex!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H_hp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H_hp!","text":"set_H_hp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H_ip!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H_ip!","text":"set_H_ip!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H_lp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H_lp!","text":"set_H_lp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_K_ex!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_K_ex!","text":"set_K_ex!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft K_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_K_hp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_K_hp!","text":"set_K_hp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft K_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_K_ip!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_K_ip!","text":"set_K_ip!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft K_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_K_lp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_K_lp!","text":"set_K_lp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft K_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_ext!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_ext!","text":"set_ext!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#SingleMass","page":"Shaft","title":"SingleMass","text":"","category":"section"},{"location":"model_library/generated_Shaft/","page":"Shaft","title":"Shaft","text":"Modules = [PowerSystems]\nPages = [\"/SingleMass.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Shaft/#PowerSystems.SingleMass","page":"Shaft","title":"PowerSystems.SingleMass","text":"mutable struct SingleMass <: Shaft\n H::Float64\n D::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of single mass shaft model. Typically represents the rotor mass\n\nArguments\n\nH::Float64: Rotor inertia constant in MWs/MVA, validation range: (0, nothing)\nD::Float64: Rotor natural damping in pu, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nδ: rotor angle,\nω: rotor speed\n\nn_states::Int: (Do not modify.) SingleMass has 1 state\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_D","text":"get_D(value::SingleMass) -> Float64\n\n\nGet SingleMass D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_H","text":"get_H(value::SingleMass) -> Float64\n\n\nGet SingleMass H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_ext-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_ext","text":"get_ext(value::SingleMass) -> Dict{String, Any}\n\n\nGet SingleMass ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_n_states-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_n_states","text":"get_n_states(value::SingleMass) -> Int64\n\n\nGet SingleMass n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_states-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_states","text":"get_states(value::SingleMass) -> Vector{Symbol}\n\n\nGet SingleMass states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D!-Tuple{SingleMass, Any}","page":"Shaft","title":"PowerSystems.set_D!","text":"set_D!(value::SingleMass, val) -> Any\n\n\nSet SingleMass D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H!-Tuple{SingleMass, Any}","page":"Shaft","title":"PowerSystems.set_H!","text":"set_H!(value::SingleMass, val) -> Any\n\n\nSet SingleMass H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_ext!-Tuple{SingleMass, Any}","page":"Shaft","title":"PowerSystems.set_ext!","text":"set_ext!(value::SingleMass, val) -> Any\n\n\nSet SingleMass ext.\n\n\n\n\n\n","category":"method"},{"location":"how_to/install/#install","page":"...install PowerSystems.jl","title":"Install PowerSystems.jl","text":"","category":"section"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"PowerSystems.jl is a command line tool written in the Julia programming language. To install:","category":"page"},{"location":"how_to/install/#Step-1:-Install-Julia","page":"...install PowerSystems.jl","title":"Step 1: Install Julia","text":"","category":"section"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Follow the instructions here","category":"page"},{"location":"how_to/install/#Step-2:-Open-Julia","page":"...install PowerSystems.jl","title":"Step 2: Open Julia","text":"","category":"section"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Start the Julia REPL from a command line:","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"$ julia","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"You should see the Julia REPL start up, which looks something like this:","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":" _\n _ _ _(_)_ | Documentation: https://docs.julialang.org\n (_) | (_) (_) |\n _ _ _| |_ __ _ | Type \"?\" for help, \"]?\" for Pkg help.\n | | | | | | |/ _` | |\n | | |_| | | | (_| | | Version 1.10.4 (2024-06-04)\n _/ |\\__'_|_|_|\\__'_| | Official https://julialang.org/ release\n|__/ |\n\njulia>","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"If not, go back to check the Julia installation steps.","category":"page"},{"location":"how_to/install/#Step-3:-Install-PowerSystems.jl","page":"...install PowerSystems.jl","title":"Step 3: Install PowerSystems.jl","text":"","category":"section"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Install the latest stable release of PowerSystems.jl using the Julia package manager with:","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"] add PowerSystems","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Once you type ], you will see the prompt change color as it activates the Julia package manager. This command may take a few minutes to download the packages and compile them.","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Press the delete or backspace key to return to the REPL. ","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Install is complete!","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"note: Alternate\nTo use the current development version instead, \"checkout\" the main branch of this package with:] add PowerSystems#main","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"note: Note\nPowerSystems.jl uses InfrastructureSystems.jl as a utility library. Many methods are re-exported from InfrastructureSystems.jl. For most users there is no need to import InfrastructureSystems.jl.","category":"page"},{"location":"tutorials/get_component_data/#get_components_tutorial","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"","category":"section"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"In this tutorial, we will explore the data in a System, including looking at a summary of the system and getting both its components and their data. We will also start checking for time-series data, which we will explore more in the tutorial on Working with Time Series Data.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"In Create and Explore a Power System, we created a basic System with nodes, a transmission line, and a few generators. Let's recreate that system if you don't have it already:","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"using PowerSystems;\nsys = System(100.0);\nbus1 = ACBus(1, \"bus1\", ACBusTypes.REF, 0.0, 1.0, (min = 0.9, max = 1.05), 230.0);\nbus2 = ACBus(2, \"bus2\", ACBusTypes.PV, 0.0, 1.0, (min = 0.9, max = 1.05), 230.0);\n","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"PowerSystems provides functional interfaces to all data. The following examples outline the intended approach to accessing data expressed using PowerSystems.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"PowerSystems enforces unique name fields between components of a particular concrete type. So, in order to retrieve a specific component, the user must specify the type of the component along with the name and system","category":"page"},{"location":"tutorials/get_component_data/#Accessing-components-and-their-data","page":"Getting, Setting, and Viewing Data","title":"Accessing components and their data","text":"","category":"section"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_component(ACBus, sys, \"nodeA\")\nget_component(Line, sys, \"1\")","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"Similarly, you can access all the components of a particular type: *note: the return type of get_components is a FlattenIteratorWrapper, so call collect to get an Array","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_components(ACBus, sys) |> collect","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_components also works on abstract types:","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_components(Branch, sys) |> collect","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"The fields within a component can be accessed using the get_* functions: It's highly recommended that users avoid using the . to access fields since we make no guarantees on the stability field names and locations. We do however promise to keep the accessor functions stable.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"bus1 = get_component(ACBus, sys, \"nodeA\")\n@show get_name(bus1);\n@show get_magnitude(bus1);\nnothing #hide","category":"page"},{"location":"tutorials/get_component_data/#Accessing-components-stored-in-the-system","page":"Getting, Setting, and Viewing Data","title":"Accessing components stored in the system","text":"","category":"section"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"using PowerSystems\nfile_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"tutorials_data\")\nsystem = System(joinpath(file_dir, \"RTS_GMLC.m\"));\nthermal_gens = get_components(ThermalStandard, system)","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"It is also possible to execute get_components with abstract types from the abstract tree. For instance, it is possible to retrieve all renewable generators","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"thermal_gens = get_components(RenewableGen, system)","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"The most common filtering requirement is by component name and for this case the method get_component returns a single component taking the device type, system and name as arguments.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"my_thermal_gen = get_component(ThermalStandard, system, \"323_CC_1\")","category":"page"},{"location":"tutorials/get_component_data/#Accessing-data-stored-in-a-component","page":"Getting, Setting, and Viewing Data","title":"Accessing data stored in a component","text":"","category":"section"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"Using the \"dot\" access to get a parameter value from a component is actively discouraged, use \"getter\" functions instead","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"For example, the my_thermal_gen.active_power_limits parameter of a thermal generator should be accessed as follows:","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_active_power_limits(my_thermal_gen)","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"You can also view data from all instances of a concrete type in one table with the function show_components. It provides a few options:","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"View the standard fields by accepting the defaults.\nPass a dictionary where the keys are column names and the values are functions that accept a component as a single argument.\nPass a vector of symbols that are field names of the type.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"show_components(system, ThermalStandard)\nshow_components(system, ThermalStandard, Dict(\"has_time_series\" => x -> has_time_series(x)))\nshow_components(system, ThermalStandard, [:active_power, :reactive_power])","category":"page"},{"location":"tutorials/get_component_data/#to-do:-add-a-link-in-the-system-that-MD-explanation-to-these-examples","page":"Getting, Setting, and Viewing Data","title":"to do: add a link in the system that MD explanation to these examples","text":"","category":"section"},{"location":"model_library/outer_control/#OuterControl","page":"OuterControl","title":"OuterControl","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"The outer control is composed by the ReactivePowerControl and the ActivePowerControl types.","category":"page"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"/OuterControl.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.OuterControl","page":"OuterControl","title":"PowerSystems.OuterControl","text":"mutable struct OuterControl{\n A <: ActivePowerControl,\n R <: ReactivePowerControl\n} <: DynamicInverterComponent\n active_power_control::A\n reactive_power_control::R\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Outer-Loop controller using a active power controller and a reactive power droop controller.\n\nArguments\n\nA <: ActivePowerControl: Active power controller (typically droop or virtual inertia).\nR <: ReactivePowerControl: Reactive power controller (typically droop).\next::Dict{String, Any}\nstates::Vector{Symbol}: Vector of states (will depend on the components).\nn_states::Int: Number of states (will depend on the components).\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{OuterControl}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::OuterControl) -> Dict{String, Any}\n\n\nGet ext from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{OuterControl}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::OuterControl) -> Int64\n\n\nGet n_states from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{OuterControl}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::OuterControl) -> Vector{Symbol}\n\n\nGet states from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{OuterControl, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::OuterControl, val) -> Any\n\n\nSet OuterControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Power-Controllers","page":"OuterControl","title":"Active Power Controllers","text":"","category":"section"},{"location":"model_library/outer_control/#Virtual-Inertia","page":"OuterControl","title":"Virtual Inertia","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/VirtualInertia.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.VirtualInertia","page":"OuterControl","title":"PowerSystems.VirtualInertia","text":"mutable struct VirtualInertia <: ActivePowerControl\n Ta::Float64\n kd::Float64\n kω::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Virtual Inertia with SRF using VSM for active power controller\n\nArguments\n\nTa::Float64: VSM inertia constant, validation range: (0, nothing)\nkd::Float64: VSM damping constant, validation range: (0, nothing)\nkω::Float64: frequency droop gain, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the VirtualInertia model are:\n\nθ_oc: Phase angle displacement of the virtual synchronous generator model\nω_oc: Speed of the rotating reference frame of the virtual synchronous generator model\n\nn_states::Int: (Do not modify.) VirtualInertia has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::VirtualInertia) -> Float64\n\n\nGet VirtualInertia P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Ta-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_Ta","text":"get_Ta(value::VirtualInertia) -> Float64\n\n\nGet VirtualInertia Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::VirtualInertia) -> Dict{String, Any}\n\n\nGet VirtualInertia ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_kd-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_kd","text":"get_kd(value::VirtualInertia) -> Float64\n\n\nGet VirtualInertia kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_kω-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_kω","text":"get_kω(value::VirtualInertia) -> Float64\n\n\nGet VirtualInertia kω.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::VirtualInertia) -> Int64\n\n\nGet VirtualInertia n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::VirtualInertia) -> Vector{Symbol}\n\n\nGet VirtualInertia states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Ta!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_kd!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_kd!","text":"set_kd!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_kω!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_kω!","text":"set_kω!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia kω.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Power-Droop","page":"OuterControl","title":"Active Power Droop","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ActivePowerDroop.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ActivePowerDroop","page":"OuterControl","title":"PowerSystems.ActivePowerDroop","text":"mutable struct ActivePowerDroop <: ActivePowerControl\n Rp::Float64\n ωz::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an Active Power droop controller\n\nArguments\n\nRp::Float64: Droop Gain, validation range: (0, nothing)\nωz::Float64: filter frequency cutoff, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ActivePowerDroop model are:\n\nθ_oc: Phase angle displacement of the inverter model,\np_oc: Measured active power of the inverter model\n\nn_states::Int: (Do not modify.) ActivePowerDroop has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActivePowerDroop) -> Float64\n\n\nGet ActivePowerDroop P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Rp-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_Rp","text":"get_Rp(value::ActivePowerDroop) -> Float64\n\n\nGet ActivePowerDroop Rp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ActivePowerDroop) -> Dict{String, Any}\n\n\nGet ActivePowerDroop ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActivePowerDroop) -> Int64\n\n\nGet ActivePowerDroop n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ActivePowerDroop) -> Vector{Symbol}\n\n\nGet ActivePowerDroop states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ωz-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_ωz","text":"get_ωz(value::ActivePowerDroop) -> Float64\n\n\nGet ActivePowerDroop ωz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{ActivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActivePowerDroop, val) -> Any\n\n\nSet ActivePowerDroop P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Rp!-Tuple{ActivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_Rp!","text":"set_Rp!(value::ActivePowerDroop, val) -> Any\n\n\nSet ActivePowerDroop Rp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ActivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActivePowerDroop, val) -> Any\n\n\nSet ActivePowerDroop ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ωz!-Tuple{ActivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_ωz!","text":"set_ωz!(value::ActivePowerDroop, val) -> Any\n\n\nSet ActivePowerDroop ωz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Power-PI","page":"OuterControl","title":"Active Power PI","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ActivePowerPI.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ActivePowerPI","page":"OuterControl","title":"PowerSystems.ActivePowerPI","text":"mutable struct ActivePowerPI <: ActivePowerControl\n Kp_p::Float64\n Ki_p::Float64\n ωz::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Proportional-Integral Active Power controller for a specified power reference\n\nArguments\n\nKp_p::Float64: Proportional Gain, validation range: (0, nothing)\nKi_p::Float64: Integral Gain, validation range: (0, nothing)\nωz::Float64: filter frequency cutoff, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ActivePowerPI model are:\n\nσp_oc: Integrator state of the PI Controller,\np_oc: Measured active power of the inverter model\n\nn_states::Int: (Do not modify.) ActivePowerPI has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_Ki_p-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Ki_p","text":"get_Ki_p(value::ActivePowerPI) -> Float64\n\n\nGet ActivePowerPI Ki_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Kp_p-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Kp_p","text":"get_Kp_p(value::ActivePowerPI) -> Float64\n\n\nGet ActivePowerPI Kp_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActivePowerPI) -> Float64\n\n\nGet ActivePowerPI P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ActivePowerPI) -> Dict{String, Any}\n\n\nGet ActivePowerPI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActivePowerPI) -> Int64\n\n\nGet ActivePowerPI n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ActivePowerPI) -> Vector{Symbol}\n\n\nGet ActivePowerPI states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ωz-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_ωz","text":"get_ωz(value::ActivePowerPI) -> Float64\n\n\nGet ActivePowerPI ωz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Ki_p!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Ki_p!","text":"set_Ki_p!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI Ki_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Kp_p!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Kp_p!","text":"set_Kp_p!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI Kp_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ωz!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_ωz!","text":"set_ωz!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI ωz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Virtual-Oscillator","page":"OuterControl","title":"Active Virtual Oscillator","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ActiveVirtualOscillator.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ActiveVirtualOscillator","page":"OuterControl","title":"PowerSystems.ActiveVirtualOscillator","text":"mutable struct ActiveVirtualOscillator <: ActivePowerControl\n k1::Float64\n ψ::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an Active Virtual Oscillator controller. Model is based on \"Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control.\"\n\nArguments\n\nk1::Float64: VOC Synchronization Gain, validation range: (0, nothing)\nψ::Float64: Rotation angle of the controller, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ActiveVirtualOscillator model are:\n\nθ_oc: Phase angle displacement of the inverter model\n\nn_states::Int: (Do not modify.) ActiveVirtualOscillator has one state\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActiveVirtualOscillator) -> Float64\n\n\nGet ActiveVirtualOscillator P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ActiveVirtualOscillator) -> Dict{String, Any}\n\n\nGet ActiveVirtualOscillator ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_k1-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_k1","text":"get_k1(value::ActiveVirtualOscillator) -> Float64\n\n\nGet ActiveVirtualOscillator k1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActiveVirtualOscillator) -> Int64\n\n\nGet ActiveVirtualOscillator n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ActiveVirtualOscillator) -> Vector{Symbol}\n\n\nGet ActiveVirtualOscillator states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ψ-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_ψ","text":"get_ψ(value::ActiveVirtualOscillator) -> Float64\n\n\nGet ActiveVirtualOscillator ψ.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{ActiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActiveVirtualOscillator, val) -> Any\n\n\nSet ActiveVirtualOscillator P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ActiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActiveVirtualOscillator, val) -> Any\n\n\nSet ActiveVirtualOscillator ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_k1!-Tuple{ActiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_k1!","text":"set_k1!(value::ActiveVirtualOscillator, val) -> Any\n\n\nSet ActiveVirtualOscillator k1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ψ!-Tuple{ActiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_ψ!","text":"set_ψ!(value::ActiveVirtualOscillator, val) -> Any\n\n\nSet ActiveVirtualOscillator ψ.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Renewable-Controller-Type-AB","page":"OuterControl","title":"Active Renewable Controller Type AB","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ActiveRenewableControllerAB.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ActiveRenewableControllerAB","page":"OuterControl","title":"PowerSystems.ActiveRenewableControllerAB","text":"mutable struct ActiveRenewableControllerAB <: ActivePowerControl\n bus_control::Int\n from_branch_control::Int\n to_branch_control::Int\n branch_id_control::String\n Freq_Flag::Int\n K_pg::Float64\n K_ig::Float64\n T_p::Float64\n fdbd_pnts::Tuple{Float64, Float64}\n fe_lim::MinMax\n P_lim::MinMax\n T_g::Float64\n D_dn::Float64\n D_up::Float64\n dP_lim::MinMax\n P_lim_inner::MinMax\n T_pord::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of Active Power Controller including REPCA1 and REECB1\n\nArguments\n\nbus_control::Int: ACBus identification number for voltage control. 0 identifies the local bus connected to this component, validation range: (0, nothing)\nfrom_branch_control::Int: Monitored branch FROM bus number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)\nto_branch_control::Int: Monitored branch TO bus number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)\nbranch_id_control::String: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used\nFreq_Flag::Int: Frequency Flag for REPCA1: 0: disable, 1:enable, validation range: (0, 1)\nK_pg::Float64: Active power PI control proportional gain, validation range: (0, nothing)\nK_ig::Float64: Active power PI control integral gain, validation range: (0, nothing)\nT_p::Float64: Real power measurement filter time constant (s), validation range: (0, nothing)\nfdbd_pnts::Tuple{Float64, Float64}: Frequency error dead band thresholds (fdbd1, fdbd2)\nfe_lim::MinMax: Upper/Lower limit on frequency error (fe_min, fe_max)\nP_lim::MinMax: Upper/Lower limit on power reference (P_min, P_max)\nT_g::Float64: Power Controller lag time constant, validation range: (0, nothing)\nD_dn::Float64: Droop for over-frequency conditions, validation range: (nothing, 0)\nD_up::Float64: Droop for under-frequency conditions, validation range: (0, nothing)\ndP_lim::MinMax: Upper/Lower limit on power reference ramp rates(dP_min, dP_max)\nP_lim_inner::MinMax: Upper/Lower limit on power reference for REECB(P_min_inner, P_max_inner)\nT_pord::Float64: Power filter time constant REECB time constant, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ActiveRenewableControllerAB model depends on the Flag\nn_states::Int: (Do not modify.) The states of the ActiveRenewableControllerAB model depends on the Flag\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_D_dn-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_D_dn","text":"get_D_dn(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_D_up-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_D_up","text":"get_D_up(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Freq_Flag-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Freq_Flag","text":"get_Freq_Flag(value::ActiveRenewableControllerAB) -> Int64\n\n\nGet ActiveRenewableControllerAB Freq_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_ig-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_ig","text":"get_K_ig(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB K_ig.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_pg-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_pg","text":"get_K_pg(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB K_pg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_P_lim-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_P_lim","text":"get_P_lim(\n value::ActiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ActiveRenewableControllerAB P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_P_lim_inner-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_P_lim_inner","text":"get_P_lim_inner(\n value::ActiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ActiveRenewableControllerAB P_lim_inner.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_g-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_g","text":"get_T_g(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_p-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_p","text":"get_T_p(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_pord-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_pord","text":"get_T_pord(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB T_pord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_branch_id_control-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_branch_id_control","text":"get_branch_id_control(\n value::ActiveRenewableControllerAB\n) -> String\n\n\nGet ActiveRenewableControllerAB branch_id_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_bus_control-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_bus_control","text":"get_bus_control(value::ActiveRenewableControllerAB) -> Int64\n\n\nGet ActiveRenewableControllerAB bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_dP_lim-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_dP_lim","text":"get_dP_lim(\n value::ActiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ActiveRenewableControllerAB dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(\n value::ActiveRenewableControllerAB\n) -> Dict{String, Any}\n\n\nGet ActiveRenewableControllerAB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_fdbd_pnts-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_fdbd_pnts","text":"get_fdbd_pnts(\n value::ActiveRenewableControllerAB\n) -> Tuple{Float64, Float64}\n\n\nGet ActiveRenewableControllerAB fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_fe_lim-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_fe_lim","text":"get_fe_lim(\n value::ActiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ActiveRenewableControllerAB fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_from_branch_control-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_from_branch_control","text":"get_from_branch_control(\n value::ActiveRenewableControllerAB\n) -> Int64\n\n\nGet ActiveRenewableControllerAB from_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActiveRenewableControllerAB) -> Int64\n\n\nGet ActiveRenewableControllerAB n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(\n value::ActiveRenewableControllerAB\n) -> Vector{Symbol}\n\n\nGet ActiveRenewableControllerAB states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_to_branch_control-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_to_branch_control","text":"get_to_branch_control(\n value::ActiveRenewableControllerAB\n) -> Int64\n\n\nGet ActiveRenewableControllerAB to_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_D_dn!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_D_dn!","text":"set_D_dn!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_D_up!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_D_up!","text":"set_D_up!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Freq_Flag!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Freq_Flag!","text":"set_Freq_Flag!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB Freq_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_ig!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_ig!","text":"set_K_ig!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB K_ig.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_pg!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_pg!","text":"set_K_pg!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB K_pg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_lim!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_P_lim!","text":"set_P_lim!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_lim_inner!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_P_lim_inner!","text":"set_P_lim_inner!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB P_lim_inner.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_g!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_g!","text":"set_T_g!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_p!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_p!","text":"set_T_p!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_pord!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_pord!","text":"set_T_pord!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB T_pord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_branch_id_control!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_branch_id_control!","text":"set_branch_id_control!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB branch_id_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_bus_control!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_bus_control!","text":"set_bus_control!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_dP_lim!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_dP_lim!","text":"set_dP_lim!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_fdbd_pnts!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_fdbd_pnts!","text":"set_fdbd_pnts!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_fe_lim!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_fe_lim!","text":"set_fe_lim!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_from_branch_control!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_from_branch_control!","text":"set_from_branch_control!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB from_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_to_branch_control!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_to_branch_control!","text":"set_to_branch_control!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB to_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Reactive-Power-Controllers","page":"OuterControl","title":"Reactive Power Controllers","text":"","category":"section"},{"location":"model_library/outer_control/#Reactive-Power-Droop","page":"OuterControl","title":"Reactive Power Droop","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ReactivePowerDroop.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ReactivePowerDroop","page":"OuterControl","title":"PowerSystems.ReactivePowerDroop","text":"mutable struct ReactivePowerDroop <: ReactivePowerControl\n kq::Float64\n ωf::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Reactive Power droop controller\n\nArguments\n\nkq::Float64: frequency droop gain, validation range: (0, nothing)\nωf::Float64: filter frequency cutoff, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReactivePowerDroop model are:\n\nq_oc: Filtered reactive output power\n\nn_states::Int: (Do not modify.) ReactivePowerDroop has 1 state\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_V_ref-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ReactivePowerDroop) -> Float64\n\n\nGet ReactivePowerDroop V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ReactivePowerDroop) -> Dict{String, Any}\n\n\nGet ReactivePowerDroop ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_kq-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_kq","text":"get_kq(value::ReactivePowerDroop) -> Float64\n\n\nGet ReactivePowerDroop kq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReactivePowerDroop) -> Int64\n\n\nGet ReactivePowerDroop n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ReactivePowerDroop) -> Vector{Symbol}\n\n\nGet ReactivePowerDroop states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ωf-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_ωf","text":"get_ωf(value::ReactivePowerDroop) -> Float64\n\n\nGet ReactivePowerDroop ωf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_ref!-Tuple{ReactivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ReactivePowerDroop, val) -> Any\n\n\nSet ReactivePowerDroop V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ReactivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReactivePowerDroop, val) -> Any\n\n\nSet ReactivePowerDroop ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_kq!-Tuple{ReactivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_kq!","text":"set_kq!(value::ReactivePowerDroop, val) -> Any\n\n\nSet ReactivePowerDroop kq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ωf!-Tuple{ReactivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_ωf!","text":"set_ωf!(value::ReactivePowerDroop, val) -> Any\n\n\nSet ReactivePowerDroop ωf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Reactive-Power-PI","page":"OuterControl","title":"Reactive Power PI","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ReactivePowerPI.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ReactivePowerPI","page":"OuterControl","title":"PowerSystems.ReactivePowerPI","text":"mutable struct ReactivePowerPI <: ReactivePowerControl\n Kp_q::Float64\n Ki_q::Float64\n ωf::Float64\n V_ref::Float64\n Q_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Proportional-Integral Reactive Power controller for a specified power reference\n\nArguments\n\nKp_q::Float64: Proportional Gain, validation range: (0, nothing)\nKi_q::Float64: Integral Gain, validation range: (0, nothing)\nωf::Float64: filter frequency cutoff, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Voltage Set-point (pu), validation range: (0, nothing)\nQ_ref::Float64: (default: 1.0) Reactive Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReactivePowerPI model are:\n\nσq_oc: Integrator state of the PI Controller,\nq_oc: Measured reactive power of the inverter model\n\nn_states::Int: (Do not modify.) ReactivePowerPI has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_Ki_q-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Ki_q","text":"get_Ki_q(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI Ki_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Kp_q-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Kp_q","text":"get_Kp_q(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI Kp_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Q_ref-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_ref-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ReactivePowerPI) -> Dict{String, Any}\n\n\nGet ReactivePowerPI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReactivePowerPI) -> Int64\n\n\nGet ReactivePowerPI n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ReactivePowerPI) -> Vector{Symbol}\n\n\nGet ReactivePowerPI states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ωf-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_ωf","text":"get_ωf(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI ωf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Ki_q!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Ki_q!","text":"set_Ki_q!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI Ki_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Kp_q!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Kp_q!","text":"set_Kp_q!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI Kp_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_ref!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_ref!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ωf!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_ωf!","text":"set_ωf!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI ωf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Reactive-Virtual-Oscillator","page":"OuterControl","title":"Reactive Virtual Oscillator","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ReactiveVirtualOscillator.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ReactiveVirtualOscillator","page":"OuterControl","title":"PowerSystems.ReactiveVirtualOscillator","text":"mutable struct ReactiveVirtualOscillator <: ReactivePowerControl\n k2::Float64\n V_ref::Float64\n Q_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Reactive Virtual Oscillator controller. Model is based on \"Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control.\"\n\nArguments\n\nk2::Float64: VOC voltage-amplitude control gain, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nQ_ref::Float64: (default: 1.0) Reference Reactive Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReactiveVirtualOscilator model are:\n\nE_oc: voltage reference state for inner control in the d-axis\n\nn_states::Int: (Do not modify.) ReactiveVirtualOscillator has 1 state\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_Q_ref-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::ReactiveVirtualOscillator) -> Float64\n\n\nGet ReactiveVirtualOscillator Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_ref-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ReactiveVirtualOscillator) -> Float64\n\n\nGet ReactiveVirtualOscillator V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(\n value::ReactiveVirtualOscillator\n) -> Dict{String, Any}\n\n\nGet ReactiveVirtualOscillator ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_k2-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_k2","text":"get_k2(value::ReactiveVirtualOscillator) -> Float64\n\n\nGet ReactiveVirtualOscillator k2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReactiveVirtualOscillator) -> Int64\n\n\nGet ReactiveVirtualOscillator n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(\n value::ReactiveVirtualOscillator\n) -> Vector{Symbol}\n\n\nGet ReactiveVirtualOscillator states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_ref!-Tuple{ReactiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::ReactiveVirtualOscillator, val) -> Any\n\n\nSet ReactiveVirtualOscillator Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_ref!-Tuple{ReactiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ReactiveVirtualOscillator, val) -> Any\n\n\nSet ReactiveVirtualOscillator V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ReactiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReactiveVirtualOscillator, val) -> Any\n\n\nSet ReactiveVirtualOscillator ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_k2!-Tuple{ReactiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_k2!","text":"set_k2!(value::ReactiveVirtualOscillator, val) -> Any\n\n\nSet ReactiveVirtualOscillator k2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Reactive-Renewable-Controller-Type-AB","page":"OuterControl","title":"Reactive Renewable Controller Type AB","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ReactiveRenewableControllerAB.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ReactiveRenewableControllerAB","page":"OuterControl","title":"PowerSystems.ReactiveRenewableControllerAB","text":"mutable struct ReactiveRenewableControllerAB <: ReactivePowerControl\n bus_control::Int\n from_branch_control::Int\n to_branch_control::Int\n branch_id_control::String\n VC_Flag::Int\n Ref_Flag::Int\n PF_Flag::Int\n V_Flag::Int\n T_fltr::Float64\n K_p::Float64\n K_i::Float64\n T_ft::Float64\n T_fv::Float64\n V_frz::Float64\n R_c::Float64\n X_c::Float64\n K_c::Float64\n e_lim::MinMax\n dbd_pnts::Tuple{Float64, Float64}\n Q_lim::MinMax\n T_p::Float64\n Q_lim_inner::MinMax\n V_lim::MinMax\n K_qp::Float64\n K_qi::Float64\n Q_ref::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of Reactive Power Controller including REPCA1 and REECB1\n\nArguments\n\nbus_control::Int: ACBus identification number for voltage control. 0 identifies the local bus connected to this component, validation range: (0, nothing)\nfrom_branch_control::Int: Monitored branch FROM bus identification number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)\nto_branch_control::Int: Monitored branch TO bus identification number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)\nbranch_id_control::String: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used\nVC_Flag::Int: Voltage Compensator Flag for REPCA1, validation range: (0, 1)\nRef_Flag::Int: Flag for Reactive Power Control for REPCA1. 0: Q-control, 1: V-control, validation range: (0, 1)\nPF_Flag::Int: Flag for Power Factor Control for Outer Control of REECB1. 0: Q-control, 1: Power Factor Control, validation range: (0, 1)\nV_Flag::Int: Flag for Voltage Control for Outer Control of REECB1. 0: Voltage Control, 1: Q-Control, validation range: (0, 1)\nT_fltr::Float64: Voltage or Q-power of REPCA Filter Time Constant, validation range: (0, nothing)\nK_p::Float64: Reactive power PI control proportional gain, validation range: (0, nothing)\nK_i::Float64: Reactive power PI control integral gain, validation range: (0, nothing)\nT_ft::Float64: Reactive power lead time constant (s), validation range: (0, nothing)\nT_fv::Float64: Reactive power lag time constant (s), validation range: (0, nothing)\nV_frz::Float64: Voltage below which state ξq_oc (integrator state) is freeze, validation range: (0, nothing)\nR_c::Float64: Line drop compensation resistance (used when VC_Flag = 1), validation range: (0, nothing)\nX_c::Float64: Line drop compensation reactance (used when VC_Flag = 1), validation range: (0, nothing)\nK_c::Float64: Reactive current compensation gain (pu) (used when VC_Flag = 0), validation range: (0, nothing)\ne_lim::MinMax: Upper/Lower limit on Voltage or Q-power deadband output (e_min, e_max)\ndbd_pnts::Tuple{Float64, Float64}: Voltage or Q-power error dead band thresholds (dbd1, dbd2)\nQ_lim::MinMax: Upper/Lower limit on reactive power V/Q control in REPCA (Q_min, Q_max)\nT_p::Float64: Active power lag time constant in REECB (s). Used only when PF_Flag = 1, validation range: (0, nothing)\nQ_lim_inner::MinMax: Upper/Lower limit on reactive power input in REECB (Q_min_inner, Q_max_inner). Only used when V_Flag = 1\nV_lim::MinMax: Upper/Lower limit on reactive power PI controller in REECB (V_min, V_max). Only used when V_Flag = 1\nK_qp::Float64: Reactive power regulator proportional gain (used when V_Flag = 1), validation range: (0, nothing)\nK_qi::Float64: Reactive power regulator integral gain (used when V_Flag = 1), validation range: (0, nothing)\nQ_ref::Float64: (default: 1.0) Reference Reactive Power Set-point (pu), validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReactiveRenewableControllerAB model depends on the Flag\nn_states::Int: (Do not modify.) The states of the ReactiveRenewableControllerAB model depends on the Flag\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_K_c-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_c","text":"get_K_c(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_i-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_i","text":"get_K_i(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_i.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_p-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_p","text":"get_K_p(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_qi-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_qi","text":"get_K_qi(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_qi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_qp-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_qp","text":"get_K_qp(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_qp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_PF_Flag-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_PF_Flag","text":"get_PF_Flag(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB PF_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Q_lim-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Q_lim","text":"get_Q_lim(\n value::ReactiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ReactiveRenewableControllerAB Q_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Q_lim_inner-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Q_lim_inner","text":"get_Q_lim_inner(\n value::ReactiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ReactiveRenewableControllerAB Q_lim_inner.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Q_ref-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_R_c-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_R_c","text":"get_R_c(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB R_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Ref_Flag-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Ref_Flag","text":"get_Ref_Flag(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB Ref_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_fltr-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_fltr","text":"get_T_fltr(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_ft-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_ft","text":"get_T_ft(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB T_ft.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_fv-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_fv","text":"get_T_fv(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB T_fv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_p-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_p","text":"get_T_p(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_VC_Flag-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_VC_Flag","text":"get_VC_Flag(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB VC_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_Flag-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_V_Flag","text":"get_V_Flag(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB V_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_frz-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_V_frz","text":"get_V_frz(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB V_frz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_lim-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_V_lim","text":"get_V_lim(\n value::ReactiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ReactiveRenewableControllerAB V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_ref-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_X_c-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_X_c","text":"get_X_c(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB X_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_branch_id_control-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_branch_id_control","text":"get_branch_id_control(\n value::ReactiveRenewableControllerAB\n) -> String\n\n\nGet ReactiveRenewableControllerAB branch_id_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_bus_control-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_bus_control","text":"get_bus_control(\n value::ReactiveRenewableControllerAB\n) -> Int64\n\n\nGet ReactiveRenewableControllerAB bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_dbd_pnts-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_dbd_pnts","text":"get_dbd_pnts(\n value::ReactiveRenewableControllerAB\n) -> Tuple{Float64, Float64}\n\n\nGet ReactiveRenewableControllerAB dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_e_lim-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_e_lim","text":"get_e_lim(\n value::ReactiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ReactiveRenewableControllerAB e_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(\n value::ReactiveRenewableControllerAB\n) -> Dict{String, Any}\n\n\nGet ReactiveRenewableControllerAB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_from_branch_control-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_from_branch_control","text":"get_from_branch_control(\n value::ReactiveRenewableControllerAB\n) -> Int64\n\n\nGet ReactiveRenewableControllerAB from_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(\n value::ReactiveRenewableControllerAB\n) -> Vector{Symbol}\n\n\nGet ReactiveRenewableControllerAB states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_to_branch_control-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_to_branch_control","text":"get_to_branch_control(\n value::ReactiveRenewableControllerAB\n) -> Int64\n\n\nGet ReactiveRenewableControllerAB to_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_c!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_c!","text":"set_K_c!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_i!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_i!","text":"set_K_i!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_i.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_p!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_p!","text":"set_K_p!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_qi!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_qi!","text":"set_K_qi!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_qi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_qp!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_qp!","text":"set_K_qp!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_qp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_PF_Flag!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_PF_Flag!","text":"set_PF_Flag!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB PF_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_lim!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Q_lim!","text":"set_Q_lim!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB Q_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_lim_inner!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Q_lim_inner!","text":"set_Q_lim_inner!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB Q_lim_inner.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_ref!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_R_c!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_R_c!","text":"set_R_c!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB R_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Ref_Flag!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Ref_Flag!","text":"set_Ref_Flag!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB Ref_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_fltr!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_fltr!","text":"set_T_fltr!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_ft!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_ft!","text":"set_T_ft!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB T_ft.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_fv!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_fv!","text":"set_T_fv!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB T_fv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_p!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_p!","text":"set_T_p!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_VC_Flag!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_VC_Flag!","text":"set_VC_Flag!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB VC_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_Flag!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_V_Flag!","text":"set_V_Flag!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB V_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_frz!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_V_frz!","text":"set_V_frz!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB V_frz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_lim!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_ref!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_X_c!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_X_c!","text":"set_X_c!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB X_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_branch_id_control!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_branch_id_control!","text":"set_branch_id_control!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB branch_id_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_bus_control!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_bus_control!","text":"set_bus_control!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_dbd_pnts!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_dbd_pnts!","text":"set_dbd_pnts!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_e_lim!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_e_lim!","text":"set_e_lim!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB e_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_from_branch_control!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_from_branch_control!","text":"set_from_branch_control!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB from_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_to_branch_control!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_to_branch_control!","text":"set_to_branch_control!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB to_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"how_to/parse_matpower_psse/#pm_data","page":"...parse data from MATPOWER or PSS/e files","title":"Parsing MATPOWER or PSS/e Files","text":"","category":"section"},{"location":"how_to/parse_matpower_psse/","page":"...parse data from MATPOWER or PSS/e files","title":"...parse data from MATPOWER or PSS/e files","text":"The following code will create a System from a MATPOWER .m or PSS/e .raw file:","category":"page"},{"location":"how_to/parse_matpower_psse/","page":"...parse data from MATPOWER or PSS/e files","title":"...parse data from MATPOWER or PSS/e files","text":"using PowerSystems\nfile_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"tutorials_data\")\nsys = System(joinpath(file_dir, \"case5.m\"))","category":"page"},{"location":"how_to/parse_matpower_psse/","page":"...parse data from MATPOWER or PSS/e files","title":"...parse data from MATPOWER or PSS/e files","text":"This parsing code was copied with permission from PowerModels.jl.","category":"page"},{"location":"how_to/parse_matpower_psse/#See-also:","page":"...parse data from MATPOWER or PSS/e files","title":"See also:","text":"","category":"section"},{"location":"how_to/parse_matpower_psse/","page":"...parse data from MATPOWER or PSS/e files","title":"...parse data from MATPOWER or PSS/e files","text":"Parsing PSS/e .dyr Files, which also includes an example of parsing a .raw file\nParsing table data (CSV Files)\nParsing time series","category":"page"},{"location":"model_library/generated_InnerControl/#InnerControl","page":"InnerControl","title":"InnerControl","text":"","category":"section"},{"location":"model_library/generated_InnerControl/#CurrentModeControl","page":"InnerControl","title":"CurrentModeControl","text":"","category":"section"},{"location":"model_library/generated_InnerControl/","page":"InnerControl","title":"InnerControl","text":"Modules = [PowerSystems]\nPages = [\"/CurrentModeControl.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InnerControl/#PowerSystems.CurrentModeControl","page":"InnerControl","title":"PowerSystems.CurrentModeControl","text":"mutable struct CurrentModeControl <: InnerControl\n kpc::Float64\n kic::Float64\n kffv::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an inner loop proportional integral (PI) current control based on \"Reduced-order Structure-preserving Model for Parallel-connected Three-phase Grid-tied Inverters.\"\n\nArguments\n\nkpc::Float64: Current controller proportional gain, validation range: (0, nothing)\nkic::Float64: Current controller integral gain, validation range: (0, nothing)\nkffv::Float64: Gain to enable feed-forward gain of voltage, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the CurrentModeControl model are:\n\nγd_ic: d-axis integrator state of the PI current controller,\nγq_ic: q-axis integrator state of the PI current controller\n\nn_states::Int: (Do not modify.) CurrentControl has 2 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_ext-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_ext","text":"get_ext(value::CurrentModeControl) -> Dict{String, Any}\n\n\nGet CurrentModeControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kffv-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_kffv","text":"get_kffv(value::CurrentModeControl) -> Float64\n\n\nGet CurrentModeControl kffv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kic-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_kic","text":"get_kic(value::CurrentModeControl) -> Float64\n\n\nGet CurrentModeControl kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kpc-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_kpc","text":"get_kpc(value::CurrentModeControl) -> Float64\n\n\nGet CurrentModeControl kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_n_states-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::CurrentModeControl) -> Int64\n\n\nGet CurrentModeControl n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_states-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_states","text":"get_states(value::CurrentModeControl) -> Vector{Symbol}\n\n\nGet CurrentModeControl states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_ext!-Tuple{CurrentModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::CurrentModeControl, val) -> Any\n\n\nSet CurrentModeControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kffv!-Tuple{CurrentModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kffv!","text":"set_kffv!(value::CurrentModeControl, val) -> Any\n\n\nSet CurrentModeControl kffv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kic!-Tuple{CurrentModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kic!","text":"set_kic!(value::CurrentModeControl, val) -> Any\n\n\nSet CurrentModeControl kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kpc!-Tuple{CurrentModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kpc!","text":"set_kpc!(value::CurrentModeControl, val) -> Any\n\n\nSet CurrentModeControl kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#RECurrentControlB","page":"InnerControl","title":"RECurrentControlB","text":"","category":"section"},{"location":"model_library/generated_InnerControl/","page":"InnerControl","title":"InnerControl","text":"Modules = [PowerSystems]\nPages = [\"/RECurrentControlB.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InnerControl/#PowerSystems.RECurrentControlB","page":"InnerControl","title":"PowerSystems.RECurrentControlB","text":"mutable struct RECurrentControlB <: InnerControl\n Q_Flag::Int\n PQ_Flag::Int\n Vdip_lim::MinMax\n T_rv::Float64\n dbd_pnts::Tuple{Float64, Float64}\n K_qv::Float64\n Iqinj_lim::MinMax\n V_ref0::Float64\n K_vp::Float64\n K_vi::Float64\n T_iq::Float64\n I_max::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of the Inner Control part of the REECB model in PSS/E\n\nArguments\n\nQ_Flag::Int: Q Flag used for I_qinj, validation range: (0, 1)\nPQ_Flag::Int: PQ Flag used for the Current Limit Logic, validation range: (0, 1)\nVdip_lim::MinMax: Limits for Voltage Dip Logic (Vdip, Vup)\nT_rv::Float64: Voltage Filter Time Constant, validation range: (0, nothing)\ndbd_pnts::Tuple{Float64, Float64}: Voltage error deadband thresholds (dbd1, dbd2)\nK_qv::Float64: Reactive current injection gain during over and undervoltage conditions, validation range: (0, nothing)\nIqinj_lim::MinMax: Limits for Iqinj (I_qh1, I_ql1)\nV_ref0::Float64: User defined reference. If 0, PowerSimulationsDynamics.jl initializes to initial terminal voltage, validation range: (0, nothing)\nK_vp::Float64: Voltage regulator proportional gain (used when QFlag = 1), validation range: (0, nothing)\nK_vi::Float64: Voltage regulator integral gain (used when QFlag = 1), validation range: (0, nothing)\nT_iq::Float64: Time constant for low-pass filter for state q_V when QFlag = 0, validation range: (0, nothing)\nI_max::Float64: Maximum limit on total converter current, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the RECurrentControlB depends on the Flags\nn_states::Int: (Do not modify.) The states of the RECurrentControlB depends on the Flags\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_I_max-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_I_max","text":"get_I_max(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_Iqinj_lim-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_Iqinj_lim","text":"get_Iqinj_lim(\n value::RECurrentControlB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RECurrentControlB Iqinj_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_K_qv-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_K_qv","text":"get_K_qv(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB K_qv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_K_vi-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_K_vi","text":"get_K_vi(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB K_vi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_K_vp-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_K_vp","text":"get_K_vp(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB K_vp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_PQ_Flag-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_PQ_Flag","text":"get_PQ_Flag(value::RECurrentControlB) -> Int64\n\n\nGet RECurrentControlB PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_Q_Flag-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_Q_Flag","text":"get_Q_Flag(value::RECurrentControlB) -> Int64\n\n\nGet RECurrentControlB Q_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_T_iq-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_T_iq","text":"get_T_iq(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB T_iq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_T_rv-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_T_rv","text":"get_T_rv(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB T_rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_V_ref0-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_V_ref0","text":"get_V_ref0(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB V_ref0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_Vdip_lim-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_Vdip_lim","text":"get_Vdip_lim(\n value::RECurrentControlB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RECurrentControlB Vdip_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_dbd_pnts-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_dbd_pnts","text":"get_dbd_pnts(\n value::RECurrentControlB\n) -> Tuple{Float64, Float64}\n\n\nGet RECurrentControlB dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_ext-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_ext","text":"get_ext(value::RECurrentControlB) -> Dict{String, Any}\n\n\nGet RECurrentControlB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_n_states-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::RECurrentControlB) -> Int64\n\n\nGet RECurrentControlB n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_states-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_states","text":"get_states(value::RECurrentControlB) -> Vector{Symbol}\n\n\nGet RECurrentControlB states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_I_max!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_Iqinj_lim!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_Iqinj_lim!","text":"set_Iqinj_lim!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB Iqinj_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_K_qv!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_K_qv!","text":"set_K_qv!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB K_qv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_K_vi!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_K_vi!","text":"set_K_vi!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB K_vi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_K_vp!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_K_vp!","text":"set_K_vp!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB K_vp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_PQ_Flag!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_PQ_Flag!","text":"set_PQ_Flag!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_Q_Flag!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_Q_Flag!","text":"set_Q_Flag!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB Q_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_T_iq!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_T_iq!","text":"set_T_iq!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB T_iq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_T_rv!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_T_rv!","text":"set_T_rv!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB T_rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_V_ref0!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_V_ref0!","text":"set_V_ref0!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB V_ref0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_Vdip_lim!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_Vdip_lim!","text":"set_Vdip_lim!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB Vdip_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_dbd_pnts!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_dbd_pnts!","text":"set_dbd_pnts!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_ext!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#VoltageModeControl","page":"InnerControl","title":"VoltageModeControl","text":"","category":"section"},{"location":"model_library/generated_InnerControl/","page":"InnerControl","title":"InnerControl","text":"Modules = [PowerSystems]\nPages = [\"/VoltageModeControl.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InnerControl/#PowerSystems.VoltageModeControl","page":"InnerControl","title":"PowerSystems.VoltageModeControl","text":"mutable struct VoltageModeControl <: InnerControl\n kpv::Float64\n kiv::Float64\n kffv::Float64\n rv::Float64\n lv::Float64\n kpc::Float64\n kic::Float64\n kffi::Float64\n ωad::Float64\n kad::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an inner loop current control PID using virtual impedance based on \"A Virtual Synchronous Machine implementation for distributed control of power converters in SmartGrids.\"\n\nArguments\n\nkpv::Float64: voltage controller proportional gain, validation range: (0, nothing)\nkiv::Float64: voltage controller integral gain, validation range: (0, nothing)\nkffv::Float64: Binary variable to enable feed-forward gain of voltage, validation range: (0, nothing)\nrv::Float64: virtual resistance, validation range: (0, nothing)\nlv::Float64: virtual inductance, validation range: (0, nothing)\nkpc::Float64: current controller proportional gain, validation range: (0, nothing)\nkic::Float64: current controller integral gain, validation range: (0, nothing)\nkffi::Float64: Binary variable to enable feed-forward gain of current, validation range: (0, nothing)\nωad::Float64: active damping filter cutoff frequency (rad/sec), validation range: (0, nothing)\nkad::Float64: active damping gain, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the VoltageModeControl model are:\n\nξd_ic: d-axis integrator state of the PI voltage controller,\nξq_ic: q-axis integrator state of the PI voltage controller,\nγd_ic: d-axis integrator state of the PI current controller,\nγq_ic: q-axis integrator state of the PI current controller,\nϕd_ic: d-axis low-pass filter of active damping,\nϕq_ic: q-axis low-pass filter of active damping\n\nn_states::Int: (Do not modify.) VoltageModeControl has 6 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_ext-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_ext","text":"get_ext(value::VoltageModeControl) -> Dict{String, Any}\n\n\nGet VoltageModeControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kad-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kad","text":"get_kad(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kffi-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kffi","text":"get_kffi(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kffi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kffv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kffv","text":"get_kffv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kffv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kic-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kic","text":"get_kic(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kiv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kiv","text":"get_kiv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kpc-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kpc","text":"get_kpc(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kpv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kpv","text":"get_kpv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_lv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_lv","text":"get_lv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl lv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_n_states-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::VoltageModeControl) -> Int64\n\n\nGet VoltageModeControl n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_rv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_rv","text":"get_rv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_states-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_states","text":"get_states(value::VoltageModeControl) -> Vector{Symbol}\n\n\nGet VoltageModeControl states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_ωad-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_ωad","text":"get_ωad(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl ωad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_ext!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kad!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kad!","text":"set_kad!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kffi!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kffi!","text":"set_kffi!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kffi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kffv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kffv!","text":"set_kffv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kffv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kic!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kic!","text":"set_kic!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kiv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kiv!","text":"set_kiv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kpc!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kpc!","text":"set_kpc!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kpv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kpv!","text":"set_kpv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_lv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_lv!","text":"set_lv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl lv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_rv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_rv!","text":"set_rv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_ωad!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_ωad!","text":"set_ωad!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl ωad.\n\n\n\n\n\n","category":"method"},{"location":"how_to/serialize_data/#Write,-View,-and-Load-Data-with-a-JSON","page":"...write and read data with a JSON","title":"Write, View, and Load Data with a JSON","text":"","category":"section"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"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.","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"The sections below show how to write data to a JSON, explore the data while it is in JSON format, and load Data saved in a JSON back into PowerSystems.jl.","category":"page"},{"location":"how_to/serialize_data/#Write-data-to-a-JSON","page":"...write and read data with a JSON","title":"Write data to a JSON","text":"","category":"section"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"You can do this to save your own custom System, but we'll use an existing dataset from PowerSystemCaseBuilder.jl, simply to illustrate the process.","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"First, load the dependencies and a System from PowerSystemCaseBuilder:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"using PowerSystems\nusing PowerSystemCaseBuilder\nsys = build_system(PSISystems, \"c_sys5_pjm\")","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Set up your target path, for example in a \"mysystems\" subfolder:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"folder = mkdir(\"mysystems\");\npath = joinpath(folder, \"system.json\")","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Now write the system to JSON:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"to_json(sys, path)","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Notice in the Info statements that the serialization process stores 3 files:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"System data file (*.json file)\nValidation data file (*.json file)\nTime Series data file (*.h5 file)","category":"page"},{"location":"how_to/serialize_data/#Viewing-PowerSystems-Data-in-JSON-Format","page":"...write and read data with a JSON","title":"Viewing PowerSystems Data in JSON Format","text":"","category":"section"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Some users prefer to view and filter the PowerSystems.jl data while it is in JSON format. There are many tools available to browse JSON data.","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Here is an example GUI tool that is available online in a browser.","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"The command line utility jq offers even more features. Below are some example commands, called from the command line within the \"mysystems\" subfolder:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"View the entire file pretty-printed:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq . system.json","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"View the PowerSystems component types:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq '.data.components | .[] | .__metadata__ | .type' system.json | sort | uniq","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"View specific components:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq '.data.components | .[] | select(.__metadata__.type == \"ThermalStandard\")' system.json","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Get the count of a component type:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"# There is almost certainly a better way.\njq '.data.components | .[] | select(.__metadata__.type == \"ThermalStandard\")' system.json | grep -c ThermalStandard","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"View specific component by name:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq '.data.components | .[] | select(.__metadata__.type == \"ThermalStandard\" and .name == \"107_CC_1\")' system.json","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Filter on a field value:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq '.data.components | .[] | select(.__metadata__.type == \"ThermalStandard\" and .active_power > 2.3)' system.json","category":"page"},{"location":"how_to/serialize_data/#Read-the-JSON-file-and-create-a-new-System","page":"...write and read data with a JSON","title":"Read the JSON file and create a new System","text":"","category":"section"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Finally, you can read the file back in, and verify the new system has the same data as above:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"sys2 = System(path)\nrm(folder; recursive = true); #hide","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"tip: Tip\nPowerSystems 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(path; assign_new_uuids = true)","category":"page"},{"location":"model_library/generated_TransmissionInterface/#TransmissionInterface","page":"TransmissionInterface","title":"TransmissionInterface","text":"","category":"section"},{"location":"model_library/generated_TransmissionInterface/","page":"TransmissionInterface","title":"TransmissionInterface","text":"Modules = [PowerSystems]\nPages = [\"generated/TransmissionInterface.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.TransmissionInterface","page":"TransmissionInterface","title":"PowerSystems.TransmissionInterface","text":"mutable struct TransmissionInterface <: Service\n name::String\n available::Bool\n active_power_flow_limits::MinMax\n violation_penalty::Float64\n direction_mapping::Dict{String, Int}\n internal::InfrastructureSystemsInternal\nend\n\nA collection of branches that make up an interface or corridor for the transfer of power, such as between different Areas or LoadZones.\n\nThe interface can be used to constrain the power flow across it\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow_limits::MinMax: Minimum and maximum active power flow limits on the interface (MW)\nviolation_penalty::Float64: (default: INFINITE_COST) Penalty cost for violating the flow limits in the interface\ndirection_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\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TransmissionInterface/#InfrastructureSystems.get_name-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"InfrastructureSystems.get_name","text":"get_name(value::TransmissionInterface) -> String\n\n\nGet TransmissionInterface name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.get_active_power_flow_limits-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"PowerSystems.get_active_power_flow_limits","text":"get_active_power_flow_limits(\n value::TransmissionInterface\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TransmissionInterface active_power_flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.get_available-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"PowerSystems.get_available","text":"get_available(value::TransmissionInterface) -> Bool\n\n\nGet TransmissionInterface available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.get_direction_mapping-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"PowerSystems.get_direction_mapping","text":"get_direction_mapping(\n value::TransmissionInterface\n) -> Dict{String, Int64}\n\n\nGet TransmissionInterface direction_mapping.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.get_violation_penalty-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"PowerSystems.get_violation_penalty","text":"get_violation_penalty(\n value::TransmissionInterface\n) -> Float64\n\n\nGet TransmissionInterface violation_penalty.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.set_active_power_flow_limits!-Tuple{TransmissionInterface, Any}","page":"TransmissionInterface","title":"PowerSystems.set_active_power_flow_limits!","text":"set_active_power_flow_limits!(\n value::TransmissionInterface,\n val\n) -> Any\n\n\nSet TransmissionInterface active_power_flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.set_available!-Tuple{TransmissionInterface, Any}","page":"TransmissionInterface","title":"PowerSystems.set_available!","text":"set_available!(value::TransmissionInterface, val) -> Any\n\n\nSet TransmissionInterface available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.set_direction_mapping!-Tuple{TransmissionInterface, Any}","page":"TransmissionInterface","title":"PowerSystems.set_direction_mapping!","text":"set_direction_mapping!(\n value::TransmissionInterface,\n val\n) -> Any\n\n\nSet TransmissionInterface direction_mapping.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.set_violation_penalty!-Tuple{TransmissionInterface, Any}","page":"TransmissionInterface","title":"PowerSystems.set_violation_penalty!","text":"set_violation_penalty!(\n value::TransmissionInterface,\n val\n) -> Any\n\n\nSet TransmissionInterface violation_penalty.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#SingleCageInductionMachine","page":"SingleCageInductionMachine","title":"SingleCageInductionMachine","text":"","category":"section"},{"location":"model_library/generated_SingleCageInductionMachine/","page":"SingleCageInductionMachine","title":"SingleCageInductionMachine","text":"Modules = [PowerSystems]\nPages = [\"generated/SingleCageInductionMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.SingleCageInductionMachine","page":"SingleCageInductionMachine","title":"PowerSystems.SingleCageInductionMachine","text":"mutable struct SingleCageInductionMachine <: DynamicInjection\n name::String\n R_s::Float64\n R_r::Float64\n X_ls::Float64\n X_lr::Float64\n X_m::Float64\n H::Float64\n A::Float64\n B::Float64\n base_power::Float64\n ext::Dict{String, Any}\n C::Float64\n τ_ref::Float64\n B_shunt::Float64\n X_ad::Float64\n X_aq::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 5-states three-phase single cage induction machine with quadratic torque-speed relationship\n\nArguments\n\nname::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\nR_s::Float64: Armature stator resistance, validation range: (0, nothing)\nR_r::Float64: Rotor resistance, validation range: (0, nothing)\nX_ls::Float64: Stator Leakage Reactance, validation range: (0, nothing)\nX_lr::Float64: Rotor Leakage Reactance, validation range: (0, nothing)\nX_m::Float64: Stator-Rotor Mutual Reactance, validation range: (0, nothing)\nH::Float64: Motor Inertia Constant [s], validation range: (0, nothing)\nA::Float64: Torque-Speed Quadratic Term, validation range: (0, 1)\nB::Float64: Torque-Speed Linear Term, validation range: (0, 1)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\next::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.\nC::Float64: (Do not modify.) Torque-Speed Constant Term\nτ_ref::Float64: Reference torque parameter\nB_shunt::Float64: Susceptance Initialization Corrector Term\nX_ad::Float64: (Do not modify.) Equivalent d-axis reactance\nX_aq::Float64: (Do not modify.) Equivalent q-axis reactance\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψ_qs: stator flux in the q-axis,\nψ_ds: stator flux in the d-axis,\nψ_qr: rotor flux in the q-axis,\nψ_dr: rotor flux in the d-axis, \nωr: Rotor speed [pu],\n\nn_states::Int: (Do not modify.) SingleCageInductionMachine has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_SingleCageInductionMachine/#InfrastructureSystems.get_name-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"InfrastructureSystems.get_name","text":"get_name(value::SingleCageInductionMachine) -> String\n\n\nGet SingleCageInductionMachine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_A-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_A","text":"get_A(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine A.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_B-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_B","text":"get_B(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine B.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_B_shunt-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_B_shunt","text":"get_B_shunt(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine B_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_C-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_C","text":"get_C(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine C.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_H-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_H","text":"get_H(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_R_r-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_R_r","text":"get_R_r(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine R_r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_R_s-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_R_s","text":"get_R_s(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine R_s.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_ad-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_ad","text":"get_X_ad(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_aq-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_aq","text":"get_X_aq(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_lr-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_lr","text":"get_X_lr(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_ls-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_ls","text":"get_X_ls(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_ls.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_m-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_m","text":"get_X_m(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_base_power-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_base_power","text":"get_base_power(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_ext-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_ext","text":"get_ext(\n value::SingleCageInductionMachine\n) -> Dict{String, Any}\n\n\nGet SingleCageInductionMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_n_states-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SingleCageInductionMachine) -> Int64\n\n\nGet SingleCageInductionMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_states-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_states","text":"get_states(\n value::SingleCageInductionMachine\n) -> Vector{Symbol}\n\n\nGet SingleCageInductionMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_τ_ref-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_τ_ref","text":"get_τ_ref(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine τ_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_A!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_A!","text":"set_A!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine A.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_B!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_B!","text":"set_B!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine B.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_B_shunt!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_B_shunt!","text":"set_B_shunt!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine B_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_C!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_C!","text":"set_C!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine C.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_H!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_H!","text":"set_H!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_R_r!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_R_r!","text":"set_R_r!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine R_r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_R_s!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_R_s!","text":"set_R_s!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine R_s.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_ad!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_ad!","text":"set_X_ad!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_aq!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_aq!","text":"set_X_aq!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_lr!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_lr!","text":"set_X_lr!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_ls!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_ls!","text":"set_X_ls!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_ls.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_m!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_m!","text":"set_X_m!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_base_power!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_base_power!","text":"set_base_power!(\n value::SingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SingleCageInductionMachine base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_ext!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_τ_ref!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_τ_ref!","text":"set_τ_ref!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine τ_ref.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/","page":"Internals","title":"Internals","text":"CollapsedDocStrings = true","category":"page"},{"location":"api/internal/#Internal-API","page":"Internals","title":"Internal API","text":"","category":"section"},{"location":"api/internal/","page":"Internals","title":"Internals","text":"Modules = [PowerSystems]\nPublic = false","category":"page"},{"location":"api/internal/#PowerSystems._pti_dtypes","page":"Internals","title":"PowerSystems._pti_dtypes","text":"lookup array of data types for PTI file sections given by field_name, as enumerated by PSS/E Program Operation Manual.\n\n\n\n\n\n","category":"constant"},{"location":"api/internal/#PowerSystems._pti_sections","page":"Internals","title":"PowerSystems._pti_sections","text":"A list of data file sections in the order that they appear in a PTI v33 file\n\n\n\n\n\n","category":"constant"},{"location":"api/internal/#PowerSystems.pm_component_status","page":"Internals","title":"PowerSystems.pm_component_status","text":"maps component types to status parameters\n\n\n\n\n\n","category":"constant"},{"location":"api/internal/#PowerSystems.pm_component_status_inactive","page":"Internals","title":"PowerSystems.pm_component_status_inactive","text":"maps component types to inactive status values\n\n\n\n\n\n","category":"constant"},{"location":"api/internal/#PowerSystems.EX4VSA","page":"Internals","title":"PowerSystems.EX4VSA","text":"mutable struct EX4VSA <: AVR\n Iflim::Float64\n d::Float64\n f::Float64\n Spar::Float64\n K1::Float64\n K2::Float64\n Oel_lim::MinMax\n G::Float64\n Ta::Float64\n Tb::Float64\n Te::Float64\n E_lim::MinMax\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Excitation System for Voltage Security Assesment\n\nArguments\n\nIflim::Float64: OEL Field current limit, validation range: (0, nothing)\nd::Float64: OEL parameter d, validation range: (0, nothing)\nf::Float64: OEL parameter f, validation range: (0, nothing)\nSpar::Float64: OEL parameter Spar, validation range: (0, nothing)\nK1::Float64: OEL delay time constant, validation range: (0, nothing)\nK2::Float64: OEL parameter K2, validation range: (0, nothing)\nOel_lim::MinMax: Oel integrator limits (Oelmin, Oelmax)\nG::Float64: AVR Exciter Gain, validation range: (0, nothing)\nTa::Float64: Numerator lead-lag (lag) time constant in s, validation range: (0, nothing)\nTb::Float64: Denominator lead-lag (lag) time constant in s, validation range: (0, nothing)\nTe::Float64: Exciter Time Constant in s, validation range: (0, nothing)\nE_lim::MinMax: Voltage regulator limits (regulator output) (Emin, Emax)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVll: Lead-lag internal state,\nVex: Exciter Output, \noel: OEL integrator state\n\nn_states::Int: (Do not modify.) The EX4VSA has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerSystems.EXST1","page":"Internals","title":"PowerSystems.EXST1","text":"mutable struct EXST1 <: AVR\n Tr::Float64\n Vi_lim::MinMax\n Tc::Float64\n Tb::Float64\n Ka::Float64\n Ta::Float64\n Vr_lim::MinMax\n Kc::Float64\n Kf::Float64\n Tf::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Type ST1 Excitation System (PTI version)\n\nArguments\n\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)\nVi_lim::MinMax: Voltage input limits (Vimin, Vimax)\nTc::Float64: Numerator lead-lag (lead) time constant in s, validation range: (0, nothing)\nTb::Float64: Denominator lead-lag (lag) time constant in s, validation range: (0, nothing)\nKa::Float64: Amplifier Gain, validation range: (0, nothing)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vrmin, Vrmax)\nKc::Float64: Current field constant limiter multiplier, validation range: (0, nothing)\nKf::Float64: Excitation control system stabilizer gain, validation range: (eps(), 0.3)\nTf::Float64: Excitation control system stabilizer time constant, validation range: (eps(), nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed Terminal Voltage,\nVrll: Lead-Lag state,\nVr: Regulator Output, \nVfb: Feedback state\n\nn_states::Int: (Do not modify.) The EXST1 has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerSystems.PowerFlowDataNetwork","page":"Internals","title":"PowerSystems.PowerFlowDataNetwork","text":"Container for data parsed by PowerFlowData\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerSystems.PowerFlowDataNetwork-Tuple{Union{IO, String}}","page":"Internals","title":"PowerSystems.PowerFlowDataNetwork","text":"PowerFlowDataNetwork(\n file::Union{IO, String};\n kwargs...\n) -> PowerSystems.PowerFlowDataNetwork\n\n\nConstructs PowerFlowDataNetwork from a raw file. Currently Supports PSSE data files v30, v32 and v33\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._FieldInfo","page":"Internals","title":"PowerSystems._FieldInfo","text":"Stores user-customized information for required dataframe columns.\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerSystems._HeatRateColumns","page":"Internals","title":"PowerSystems._HeatRateColumns","text":"Add generators to the System from the raw data.\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#Base.convert-Tuple{Type{@NamedTuple{min::Float64, max::Float64}}, Tuple{Float64, Float64}}","page":"Internals","title":"Base.convert","text":"convert(\n _::Type{@NamedTuple{min::Float64, max::Float64}},\n input::Tuple{Float64, Float64}\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nConvert Tuple to Min Max Named Tuple\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#Base.convert-Tuple{Type{@NamedTuple{up::Float64, down::Float64}}, Tuple{Float64, Float64}}","page":"Internals","title":"Base.convert","text":"convert(\n _::Type{@NamedTuple{up::Float64, down::Float64}},\n input::Tuple{Float64, Float64}\n) -> @NamedTuple{up::Float64, down::Float64}\n\n\nConvert Tuple to Up Down Named Tuple\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.assign_new_uuid!-Tuple{System, Component}","page":"Internals","title":"InfrastructureSystems.assign_new_uuid!","text":"assign_new_uuid!(sys::System, x::Component)\n\n\nChange the UUID of a component.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ACBus}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ACBus\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ACBus internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AGC}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AGC\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AGC internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AVRFixed}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AVRFixed\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AVRFixed internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AVRSimple}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AVRSimple\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AVRSimple internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AVRTypeII}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AVRTypeII\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AVRTypeII internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AVRTypeI}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AVRTypeI\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AVRTypeI internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ActiveConstantPowerLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ActiveConstantPowerLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ActiveConstantPowerLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AggregateDistributedGenerationA}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AggregateDistributedGenerationA\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AggregateDistributedGenerationA internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AndersonFouadMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AndersonFouadMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AndersonFouadMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Arc}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Arc\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Arc internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AreaInterchange}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AreaInterchange\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AreaInterchange internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Area}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Area\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Area internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{BaseMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::BaseMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet BaseMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{CSVGN1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::CSVGN1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet CSVGN1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ConstantReserveGroup}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ConstantReserveGroup\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ConstantReserveGroup internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ConstantReserveNonSpinning}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ConstantReserveNonSpinning\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ConstantReserveNonSpinning internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ConstantReserve}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ConstantReserve\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ConstantReserve internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DCBus}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DCBus\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DCBus internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DEGOV1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DEGOV1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DEGOV1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DEGOV}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DEGOV\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DEGOV internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DynamicBranch}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DynamicBranch\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DynamicBranch internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DynamicExponentialLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DynamicExponentialLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DynamicExponentialLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESAC1A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESAC1A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESAC1A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESAC6A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESAC6A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESAC6A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESAC8B}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESAC8B\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESAC8B internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESDC1A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESDC1A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESDC1A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESDC2A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESDC2A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESDC2A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESST1A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESST1A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESST1A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESST4B}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESST4B\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESST4B internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EXAC1A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EXAC1A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXAC1A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EXAC1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EXAC1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXAC1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EXAC2}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EXAC2\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXAC2 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EXPIC1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EXPIC1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXPIC1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EnergyReservoirStorage}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EnergyReservoirStorage\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EnergyReservoirStorage internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ExponentialLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ExponentialLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ExponentialLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{FiveMassShaft}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::FiveMassShaft\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet FiveMassShaft internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{FixedAdmittance}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::FixedAdmittance\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet FixedAdmittance internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{FixedDCSource}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::FixedDCSource\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet FixedDCSource internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{FullMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::FullMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet FullMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{GasTG}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::GasTG\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet GasTG internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{GeneralGovModel}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::GeneralGovModel\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet GeneralGovModel internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{GenericDER}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::GenericDER\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet GenericDER internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HybridSystem}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HybridSystem\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HybridSystem internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HydroDispatch}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HydroDispatch\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HydroDispatch internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HydroEnergyReservoir}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HydroEnergyReservoir\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HydroEnergyReservoir internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HydroPumpedStorage}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HydroPumpedStorage\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HydroPumpedStorage internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HydroTurbineGov}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HydroTurbineGov\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HydroTurbineGov internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{IEEEST}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::IEEEST\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet IEEEST internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{IEEET1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::IEEET1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet IEEET1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{IEEETurbineGov1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::IEEETurbineGov1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet IEEETurbineGov1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{InterconnectingConverter}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::InterconnectingConverter\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet InterconnectingConverter internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{InterruptiblePowerLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::InterruptiblePowerLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet InterruptiblePowerLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Line}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Line\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Line internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{LoadZone}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::LoadZone\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet LoadZone internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{MarconatoMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::MarconatoMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet MarconatoMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{MonitoredLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::MonitoredLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet MonitoredLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{OneDOneQMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::OneDOneQMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet OneDOneQMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Outage}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(x::Outage) -> Any\n\n\nGet internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PIDGOV}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PIDGOV\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PIDGOV internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSS2A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSS2A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSS2A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSS2B}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSS2B\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSS2B internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSS2C}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSS2C\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSS2C internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSSFixed}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSSFixed\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSSFixed internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSSSimple}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSSSimple\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSSSimple internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PeriodicVariableSource}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PeriodicVariableSource\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PeriodicVariableSource internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PhaseShiftingTransformer}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PhaseShiftingTransformer\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PhaseShiftingTransformer internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PowerLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PowerLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PowerLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PowerSystems.EX4VSA}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PowerSystems.EX4VSA\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EX4VSA internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PowerSystems.EXST1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PowerSystems.EXST1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXST1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{RenewableDispatch}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::RenewableDispatch\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet RenewableDispatch internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{RenewableNonDispatch}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::RenewableNonDispatch\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet RenewableNonDispatch internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ReserveDemandCurve}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ReserveDemandCurve\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ReserveDemandCurve internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{RoundRotorMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::RoundRotorMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet RoundRotorMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SCRX}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SCRX\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SCRX internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SEXS}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SEXS\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SEXS internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ST6B}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ST6B\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ST6B internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ST8C}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ST8C\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ST8C internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{STAB1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::STAB1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet STAB1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SalientPoleMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SalientPoleMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SalientPoleMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SauerPaiMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SauerPaiMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SauerPaiMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SimpleAFMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SimpleAFMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SimpleAFMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SimpleFullMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SimpleFullMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SimpleFullMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SimpleMarconatoMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SimpleMarconatoMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SimpleMarconatoMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SimplifiedSingleCageInductionMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SimplifiedSingleCageInductionMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SimplifiedSingleCageInductionMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SingleCageInductionMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SingleCageInductionMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SingleCageInductionMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SingleMass}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SingleMass\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SingleMass internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Source}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Source\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Source internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{StandardLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::StandardLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet StandardLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SteamTurbineGov1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SteamTurbineGov1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SteamTurbineGov1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SwitchedAdmittance}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SwitchedAdmittance\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SwitchedAdmittance internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{System}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n sys::System\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nReturn the internal of the system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TGFixed}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TGFixed\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TGFixed internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TGSimple}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TGSimple\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TGSimple internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TGTypeII}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TGTypeII\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TGTypeII internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TGTypeI}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TGTypeI\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TGTypeI internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TModelHVDCLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TModelHVDCLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TModelHVDCLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TapTransformer}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TapTransformer\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TapTransformer internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ThermalMultiStart}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ThermalMultiStart\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ThermalMultiStart internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ThermalStandard}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ThermalStandard\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ThermalStandard internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Transformer2W}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Transformer2W\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Transformer2W internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TransmissionInterface}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TransmissionInterface\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TransmissionInterface internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TwoTerminalHVDCDetailedLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TwoTerminalHVDCDetailedLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TwoTerminalHVDCDetailedLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TwoTerminalHVDCLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TwoTerminalHVDCLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TwoTerminalHVDCLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TwoTerminalVSCDCLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TwoTerminalVSCDCLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TwoTerminalVSCDCLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{VariableReserveNonSpinning}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::VariableReserveNonSpinning\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet VariableReserveNonSpinning internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{VariableReserve}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::VariableReserve\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet VariableReserve internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{WPIDHY}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::WPIDHY\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet WPIDHY internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._add_dcline_costs!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._add_dcline_costs!","text":"_add_dcline_costs!(data::Dict{String, Any})\n\n\nadds dcline costs, if gen costs exist\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._add_line_delimiter-Tuple{AbstractString, Any, Any}","page":"Internals","title":"PowerSystems._add_line_delimiter","text":"_add_line_delimiter(\n mp_line::AbstractString,\n start_char,\n end_char\n) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._apply_func!-Tuple{Dict{String}, String, Any}","page":"Internals","title":"PowerSystems._apply_func!","text":"_apply_func!(data::Dict{String}, key::String, func) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._biggest_generator-Tuple{Any}","page":"Internals","title":"PowerSystems._biggest_generator","text":"_biggest_generator(gens) -> Any\n\n\nfind the largest active generator in the network\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._bold-Tuple{String}","page":"Internals","title":"PowerSystems._bold","text":"_bold(s::String) -> String\n\n\nMakes a string bold in the terminal\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_branch_flow_ac-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_branch_flow_ac","text":"_calc_branch_flow_ac(\n data::Dict{String}\n) -> Dict{String, Any}\n\n\nhelper function for calcbranchflow_ac\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_branch_flow_dc-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_branch_flow_dc","text":"_calc_branch_flow_dc(\n data::Dict{String}\n) -> Dict{String, Any}\n\n\nhelper function for calcbranchflow_dc\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_comp_lines-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_comp_lines","text":"_calc_comp_lines(component::Dict{String}) -> Vector{Any}\n\n\ncompute lines in m and b from from pwl cost models\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_max_cost_index-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_max_cost_index","text":"_calc_max_cost_index(data::Dict{String}) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_power_balance-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_power_balance","text":"_calc_power_balance(data::Dict{String}) -> Dict{String, Any}\n\n\nhelper function for calcpowerbalance\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._cc_dfs-NTuple{4, Any}","page":"Internals","title":"PowerSystems._cc_dfs","text":"_cc_dfs(i, neighbors, component_lookup, touched)\n\n\nDFS on a graph\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._check_conductors-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._check_conductors","text":"_check_conductors(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._check_keys-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._check_keys","text":"_check_keys(data, keys)\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._compare_numbers-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._compare_numbers","text":"_compare_numbers(v1, v2) -> Bool\n\n\ntests if two numbers are equal, up to floating point precision\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._convert_argument_types!-Tuple{AbstractString, Vector}","page":"Internals","title":"PowerSystems._convert_argument_types!","text":"_convert_argument_types!(\n str::AbstractString,\n struct_args::Vector\n) -> Any\n\n\nConvert specific parameters to types that are not Float64 for specific inverter components\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._convert_argument_types_for_gen!-Tuple{AbstractString, Vector}","page":"Internals","title":"PowerSystems._convert_argument_types_for_gen!","text":"_convert_argument_types_for_gen!(\n str::AbstractString,\n struct_args::Vector\n)\n\n\nConvert specific parameters to types that are not Float64 for specific generator components\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._correct_cost_function!-Tuple{Any, Any, Any}","page":"Internals","title":"PowerSystems._correct_cost_function!","text":"_correct_cost_function!(id, comp, type_name) -> Bool\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._correct_reference_buses!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._correct_reference_buses!","text":"_correct_reference_buses!(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._create_starbus_from_transformer-Tuple{Dict, Dict, Int64}","page":"Internals","title":"PowerSystems._create_starbus_from_transformer","text":"_create_starbus_from_transformer(\n pm_data::Dict,\n transformer::Dict,\n starbus_id::Int64\n) -> Dict{String, Any}\n\n\ncreate_starbus(pm_data, transformer)\n\nCreates 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._deactivate_isolated_components!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._deactivate_isolated_components!","text":"_deactivate_isolated_components!(data::Dict{String}) -> Bool\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._extract_matlab_assignment-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._extract_matlab_assignment","text":"_extract_matlab_assignment(\n string::AbstractString\n) -> Tuple{SubString, SubString}\n\n\nbreaks up matlab strings of the form 'name = value;'\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._find_max_bus_id-Tuple{Dict}","page":"Internals","title":"PowerSystems._find_max_bus_id","text":"_find_max_bus_id(pm_data::Dict) -> Int64\n\n\n_find_max_bus_id(pm_data)\n\nReturns the maximum bus id in pm_data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._float2string-Tuple{AbstractFloat, Int64}","page":"Internals","title":"PowerSystems._float2string","text":"_float2string(\n v::AbstractFloat,\n float_precision::Int64\n) -> Any\n\n\nconverts a float value into a string of fixed precision\n\nsprintf would do the job but this work around is needed because sprintf cannot take format strings during runtime\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_bus_value-Tuple{Int64, String, Dict{String, Any}}","page":"Internals","title":"PowerSystems._get_bus_value","text":"_get_bus_value(\n bus_i::Int64,\n field::String,\n pm_data::Dict{String, Any}\n) -> Any\n\n\n_get_bus_value(bus_i, field, pm_data)\n\nReturns the value of field of bus_i from the PowerModels data. Requires \"bus\" Dict to already be populated.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_contributing_devices-Union{Tuple{T}, Tuple{System, T}} where T<:Service","page":"Internals","title":"PowerSystems._get_contributing_devices","text":"_get_contributing_devices(\n sys::System,\n service::Service\n) -> ServiceContributingDevices\n\n\nReturns a ServiceContributingDevices object.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_line_elements-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._get_line_elements","text":"_get_line_elements(\n line::AbstractString\n) -> Tuple{Array{SubString{T}, 1} where T<:AbstractString, Union{String, SubString}}\n\n\n_get_line_elements(line)\n\nInternal 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_pm_branch_name-Tuple{Any, ACBus, ACBus}","page":"Internals","title":"PowerSystems._get_pm_branch_name","text":"_get_pm_branch_name(\n device_dict,\n bus_f::ACBus,\n bus_t::ACBus\n) -> String\n\n\nInternal branch name retreval from pm2ps_dict\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_pm_dict_name-Tuple{Dict}","page":"Internals","title":"PowerSystems._get_pm_dict_name","text":"_get_pm_dict_name(device_dict::Dict) -> String\n\n\nInternal component name retreval from pm2ps_dict\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._grey-Tuple{String}","page":"Internals","title":"PowerSystems._grey","text":"_grey(s::String) -> String\n\n\nMakes 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\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._import_remaining_comps!-Tuple{Dict, Dict}","page":"Internals","title":"PowerSystems._import_remaining_comps!","text":"_import_remaining_comps!(\n data_out::Dict,\n data_in::Dict;\n exclude\n)\n\n\nImports remaining top level component lists from data_in into data_out, excluding keys in exclude\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._import_remaining_keys!-Tuple{Dict, Dict}","page":"Internals","title":"PowerSystems._import_remaining_keys!","text":"_import_remaining_keys!(\n comp_dest::Dict,\n comp_src::Dict;\n exclude\n)\n\n\nImports remaining keys from a source component into detestation component, excluding keys in exclude\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._init_bus!-Tuple{Dict{String, Any}, Int64}","page":"Internals","title":"PowerSystems._init_bus!","text":"_init_bus!(bus::Dict{String, Any}, id::Int64)\n\n\n_init_bus!(bus, id)\n\nInitializes a bus of id id with default values given in the PSS(R)E specification.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._instantiate_param_vector_size-Tuple{AbstractString, Dict}","page":"Internals","title":"PowerSystems._instantiate_param_vector_size","text":"_instantiate_param_vector_size(\n str::AbstractString,\n param_map::Dict\n) -> Any\n\n\nConstruct appropiate vector size for components that collect parameters from more than 2 PSS/E components\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._make_market_bid_curve-Tuple{PiecewiseStepData}","page":"Internals","title":"PowerSystems._make_market_bid_curve","text":"_make_market_bid_curve(\n data::PiecewiseStepData;\n initial_input,\n power_units,\n input_at_zero\n) -> CostCurve{PiecewiseIncrementalCurve}\n\n\nAuxiliary make market bid curve for timeseries with nothing inputs. \n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._make_mixed_units!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._make_mixed_units!","text":"_make_mixed_units!(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._make_per_unit!-Tuple{Dict{String}, Real}","page":"Internals","title":"PowerSystems._make_per_unit!","text":"_make_per_unit!(data::Dict{String}, mva_base::Real)\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._make_shaft-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._make_shaft","text":"_make_shaft(param_map, val) -> Any\n\n\nCreate a SingleMass shaft struct directly using the parameter mapping.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._matpower_to_powermodels!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._matpower_to_powermodels!","text":"_matpower_to_powermodels!(\n mp_data::Dict{String}\n) -> Dict{String}\n\n\nConverts a Matpower dict into a PowerModels dict\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._merge_bus_name_data!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._merge_bus_name_data!","text":"_merge_bus_name_data!(\n data::Dict{String, Any}\n) -> Union{Nothing, Dict{String, Any}}\n\n\nmerges bus name data into buses, if names exist\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._merge_cost_data!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._merge_cost_data!","text":"_merge_cost_data!(\n data::Dict{String, Any}\n) -> Union{Nothing, Dict{String, Any}}\n\n\nmerges generator cost functions into generator data, if costs exist\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._merge_generic_data!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._merge_generic_data!","text":"_merge_generic_data!(data::Dict{String, Any})\n\n\nmerges Matpower tables based on the table extension syntax\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._mp2pm_branch!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._mp2pm_branch!","text":"_mp2pm_branch!(data::Dict{String, Any})\n\n\nsets all branch transformer taps to 1.0, to simplify branch models\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._mp2pm_dcline!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._mp2pm_dcline!","text":"_mp2pm_dcline!(data::Dict{String, Any})\n\n\nadds pmin and pmax values at to and from buses\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._mp_cost_data-Tuple{Any}","page":"Internals","title":"PowerSystems._mp_cost_data","text":"_mp_cost_data(cost_row) -> Dict\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dera1!-Tuple{Any, Any, Any, Dict, Int64}","page":"Internals","title":"PowerSystems._parse_dera1!","text":"_parse_dera1!(\n bus_dict,\n componentID,\n componentValues,\n param_map::Dict,\n bus_num::Int64\n)\n\n\nParse 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_components-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._parse_dyr_components","text":"_parse_dyr_components(\n dyr_file::AbstractString\n) -> Dict{Int64, Any}\n\n\nParse a .dyr file directly from its name by constructing its dictionary of dictionaries.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_components-Tuple{Dict}","page":"Internals","title":"PowerSystems._parse_dyr_components","text":"_parse_dyr_components(data::Dict) -> Dict{Int64, Any}\n\n\nParse 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).\n\nFor Generators, each dictionary indexed by id contains a vector with 5 of its components:\n\nMachine\nShaft\nAVR\nTurbineGov\nPSS\n\nFor Inverters, each dictionary indexed by id contains a vector with 7 of its components:\n\nConverter\nActivePowerControl\nReactivePowerControl\nInnerControl\nDCSource\nFrequencyEstimator\nFilter\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_file-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._parse_dyr_file","text":"_parse_dyr_file(file::AbstractString) -> Dict{Int64, Dict}\n\n\nParse .dyr file into a dictionary indexed by bus number. Each bus number key has a dictionary indexed by component type and id.\n\nComments in .dyr files are not supported (beginning of lines with //).\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_generator_components!-Tuple{Dict, Any, Any, Dict, Dict}","page":"Internals","title":"PowerSystems._parse_dyr_generator_components!","text":"_parse_dyr_generator_components!(\n bus_dict::Dict,\n componentID,\n componentValues,\n gen_map::Dict,\n param_map::Dict\n)\n\n\nParse 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_inverter_components!-Tuple{Dict, Dict, Tuple{String, String}, Dict}","page":"Internals","title":"PowerSystems._parse_dyr_inverter_components!","text":"_parse_dyr_inverter_components!(\n bus_dict::Dict,\n inv_dict::Dict,\n componentID::Tuple{String, String},\n inv_map::Dict\n)\n\n\nParse 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_elements-Tuple{Array, Array, Dict, AbstractString}","page":"Internals","title":"PowerSystems._parse_elements","text":"_parse_elements(\n elements::Array,\n dtypes::Array,\n defaults::Dict,\n section::AbstractString\n) -> Dict{String, Any}\n\n\nThis 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_line_element!-Tuple{Dict, Array, AbstractString}","page":"Internals","title":"PowerSystems._parse_line_element!","text":"_parse_line_element!(\n data::Dict,\n elements::Array,\n section::AbstractString\n)\n\n\n_parse_line_element!(data, elements, section)\n\nInternal 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_matlab_cells-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._parse_matlab_cells","text":"_parse_matlab_cells(lines, index) -> Dict\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_matlab_data-NTuple{4, Any}","page":"Internals","title":"PowerSystems._parse_matlab_data","text":"_parse_matlab_data(\n lines,\n index,\n start_char,\n end_char\n) -> Dict\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_matlab_matrix-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._parse_matlab_matrix","text":"_parse_matlab_matrix(lines, index) -> Dict\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_matpower_string-Tuple{String}","page":"Internals","title":"PowerSystems._parse_matpower_string","text":"_parse_matpower_string(\n data_string::String\n) -> Dict{String, Any}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_pti_data-Tuple{IO}","page":"Internals","title":"PowerSystems._parse_pti_data","text":"_parse_pti_data(data_io::IO) -> Dict{String, Array{Dict}}\n\n\n_parse_pti_data(data_string, sections)\n\nInternal 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().\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._populate_args-Tuple{Vector, Any}","page":"Internals","title":"PowerSystems._populate_args","text":"_populate_args(param_map::Vector, val) -> Vector{Any}\n\n\nPopulate arguments in a vector for each dynamic component (except Shafts). Returns a vector with the parameter values of the argument of each component.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._populate_defaults!-Tuple{Dict}","page":"Internals","title":"PowerSystems._populate_defaults!","text":"_populate_defaults!(data::Dict)\n\n\n_populate_defaults!(pti_data)\n\nInternal function. Populates empty fields with PSS(R)E PTI v33 default values\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._process_get_cost-Union{Tuple{T}, Tuple{Type{T}, Any, T, Any, Union{Nothing, Dates.DateTime}, Union{Nothing, Int64}}} where T","page":"Internals","title":"PowerSystems._process_get_cost","text":"_process_get_cost(\n _::Type{T},\n _,\n cost,\n transform_fn,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64}\n) -> TimeSeries.TimeArray\n\n\nHelper function for cost getters.\n\nArguments\n\nT: type/eltype we expect\ncomponent::Component: the component\ncost: the data: either a single element of type T or a TimeSeriesKey\ntransform_fn: a function to apply to the elements of the time series\nstart_time: as in get_time_series\nlen: as in get_time_series\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._process_set_cost-Tuple{Any, Any, Any, Any, Nothing}","page":"Internals","title":"PowerSystems._process_set_cost","text":"_process_set_cost(_, _, _, _, _::Nothing)\n\n\nHelper function for cost setters.\n\nArguments\n\nT1: type we expect if it's not a time series\nT2: eltype we expect if it is a time series\nsys::System: the system\ncomponent::Component: the component\ncost: the data: either a single element of type T1 or a IS.TimeSeriesData of eltype T2\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._propagate_topology_status!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._propagate_topology_status!","text":"_propagate_topology_status!(data::Dict{String}) -> Bool\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_branch!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_branch!","text":"_psse2pm_branch!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_branch!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_bus!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_bus!","text":"_psse2pm_bus!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_bus!(pm_data, pti_data)\n\nParses PSS(R)E-style Bus data into a PowerModels-style Dict. \"source_id\" is given by [\"I\", \"NAME\"] in PSS(R)E Bus specification.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_dcline!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_dcline!","text":"_psse2pm_dcline!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_dcline!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_generator!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_generator!","text":"_psse2pm_generator!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n) -> Union{Nothing, Vector{Dict{String, Any}}}\n\n\n_psse2pm_generator!(pm_data, pti_data)\n\nParses PSS(R)E-style Generator data in a PowerModels-style Dict. \"source_id\" is given by [\"I\", \"ID\"] in PSS(R)E Generator specification.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_load!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_load!","text":"_psse2pm_load!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_load!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_shunt!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_shunt!","text":"_psse2pm_shunt!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_shunt!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_transformer!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_transformer!","text":"_psse2pm_transformer!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_transformer!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._pti_to_powermodels!-Tuple{Dict}","page":"Internals","title":"PowerSystems._pti_to_powermodels!","text":"_pti_to_powermodels!(\n pti_data::Dict;\n import_all,\n validate,\n correct_branch_rating\n) -> Dict{String, Any}\n\n\n_pti_to_powermodels!(pti_data)\n\nConverts 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).\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._read_data_row-Tuple{PowerSystemTableData, Any, Any}","page":"Internals","title":"PowerSystems._read_data_row","text":"_read_data_row(\n data::PowerSystemTableData,\n row,\n field_infos;\n na_to_nothing\n) -> NamedTuple\n\n\nReads values from dataframe row and performs necessary conversions.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._remove_aggregration_topology!-Tuple{ACBus, LoadZone}","page":"Internals","title":"PowerSystems._remove_aggregration_topology!","text":"_remove_aggregration_topology!(bus::ACBus, _::LoadZone)\n\n\nRemove the aggregation topology in a ACBus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._remove_pwl_cost_duplicates!","page":"Internals","title":"PowerSystems._remove_pwl_cost_duplicates!","text":"_remove_pwl_cost_duplicates!(id, comp, type_name) -> Bool\n_remove_pwl_cost_duplicates!(\n id,\n comp,\n type_name,\n tolerance\n) -> Bool\n\n\nchecks that each point in the a pwl function is unique, simplifies the function if duplicates appear\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems._remove_service!-Tuple{Device, Service}","page":"Internals","title":"PowerSystems._remove_service!","text":"_remove_service!(device::Device, service::Service) -> Bool\n\n\nRemove service from device if it is attached.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._rescale_cost_model!-Tuple{Dict{String}, Real}","page":"Internals","title":"PowerSystems._rescale_cost_model!","text":"_rescale_cost_model!(comp::Dict{String}, scale::Real)\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._resolve_swithces!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._resolve_swithces!","text":"_resolve_swithces!(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._select_largest_component!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._select_largest_component!","text":"_select_largest_component!(data::Dict{String}) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._simplify_pwl_cost!","page":"Internals","title":"PowerSystems._simplify_pwl_cost!","text":"_simplify_pwl_cost!(id, comp, type_name) -> Bool\n_simplify_pwl_cost!(id, comp, type_name, tolerance) -> Bool\n\n\nchecks the slope of each segment in a pwl function, simplifies the function if the slope changes is below a tolerance\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems._split_loads_shunts!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._split_loads_shunts!","text":"_split_loads_shunts!(data::Dict{String, Any})\n\n\n_split_loads_shunts!(data)\n\nSeperates 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._standardize_cost_terms!-Tuple{Dict{String}, Int64, String}","page":"Internals","title":"PowerSystems._standardize_cost_terms!","text":"_standardize_cost_terms!(\n components::Dict{String},\n comp_order::Int64,\n cost_comp_name::String\n) -> Set{Int64}\n\n\nensures all polynomial costs functions have at exactly comp_order terms\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._type_array-Union{Tuple{Vector{T}}, Tuple{T}} where T<:AbstractString","page":"Internals","title":"PowerSystems._type_array","text":"_type_array(\n string_array::Array{T<:AbstractString, 1}\n) -> Vector\n\n\nAttempts to determine the type of an array of strings extracted from a matlab file\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._type_value-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._type_value","text":"_type_value(\n value_string::AbstractString\n) -> Union{Float64, Int64, InlineStrings.InlineString, SubString}\n\n\nAttempts to determine the type of a string extracted from a matlab file\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._update_data!-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems._update_data!","text":"_update_data!(data::Dict{String}, new_data::Dict{String})\n\n\nrecursive call of updatedata\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._value2string-Tuple{Any, Int64}","page":"Internals","title":"PowerSystems._value2string","text":"_value2string(v, float_precision::Int64) -> Any\n\n\nconverts any value to a string, summarizes arrays and dicts\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.add_service_internal!-Tuple{Device, Service}","page":"Internals","title":"PowerSystems.add_service_internal!","text":"add_service_internal!(device::Device, service::Service)\n\n\nThis function add a service to the component without checking if the component and the service are attached to the same system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.adequacy_check-Tuple{System}","page":"Internals","title":"PowerSystems.adequacy_check","text":"adequacy_check(sys::System)\n\n\nadequacy_check(sys::System)\n\nChecks the system for sum(generator ratings) >= sum(load ratings).\n\nArguments\n\nsys::System: system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.arrays_to_dicts!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.arrays_to_dicts!","text":"arrays_to_dicts!(data::Dict{String})\n\n\nturns top level arrays into dicts\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.branch_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.branch_csv_parser!","text":"branch_csv_parser!(sys::System, data::PowerSystemTableData)\n\n\nAdd branches to the System from the raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.bus_csv_parser!","text":"bus_csv_parser!(sys::System, data::PowerSystemTableData)\n\n\nAdd buses and areas to the System from the raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_gen_lookup-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.bus_gen_lookup","text":"bus_gen_lookup(\n gen_data::Dict{String},\n bus_data::Dict{String}\n) -> Dict\n\n\nbuilds a lookup list of what generators are connected to a given bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_load_lookup-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.bus_load_lookup","text":"bus_load_lookup(\n load_data::Dict{String},\n bus_data::Dict{String}\n) -> Dict\n\n\nbuilds a lookup list of what loads are connected to a given bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_shunt_lookup-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.bus_shunt_lookup","text":"bus_shunt_lookup(\n shunt_data::Dict{String},\n bus_data::Dict{String}\n) -> Dict\n\n\nbuilds a lookup list of what shunts are connected to a given bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_storage_lookup-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.bus_storage_lookup","text":"bus_storage_lookup(\n storage_data::Dict{String},\n bus_data::Dict{String}\n) -> Dict\n\n\nbuilds a lookup list of what storage is connected to a given bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_branch_flow_ac-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_branch_flow_ac","text":"calc_branch_flow_ac(data::Dict{String}) -> Dict{String, Any}\n\n\nassumes a vaild ac solution is included in the data and computes the branch flow values\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_branch_flow_dc-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_branch_flow_dc","text":"calc_branch_flow_dc(data::Dict{String}) -> Dict{String, Any}\n\n\nassumes a vaild dc solution is included in the data and computes the branch flow values\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_branch_t-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_branch_t","text":"calc_branch_t(branch::Dict{String}) -> Tuple{Any, Any}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_branch_y-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_branch_y","text":"calc_branch_y(branch::Dict{String}) -> Tuple{Any, Any}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_connected_components-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_connected_components","text":"calc_connected_components(\n pm_data::Dict{String};\n edges\n) -> Set{Set{Int64}}\n\n\ncomputes the connected components of the network graph returns a set of sets of bus ids, each set is a connected component\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_cost_pwl_lines-Tuple{Dict}","page":"Internals","title":"PowerSystems.calc_cost_pwl_lines","text":"calc_cost_pwl_lines(comp_dict::Dict) -> Dict{Any, Any}\n\n\ncompute lines in m and b from from pwl cost models data is a list of components.\n\nCan be run on data or ref data structures\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_dcline_cost-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_dcline_cost","text":"calc_dcline_cost(data::Dict{String}) -> Any\n\n\ncomputes the dcline cost from given network data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_gen_cost-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_gen_cost","text":"calc_gen_cost(data::Dict{String}) -> Any\n\n\ncomputes the generator cost from given network data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_max_cost_index-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.calc_max_cost_index","text":"calc_max_cost_index(data::Dict{String, Any}) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_power_balance-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_power_balance","text":"calc_power_balance(data::Dict{String}) -> Dict{String, Any}\n\n\nassumes a vaild solution is included in the data and computes the power balance at each bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_theta_delta_bounds-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_theta_delta_bounds","text":"calc_theta_delta_bounds(\n data::Dict{String}\n) -> Tuple{Real, Real}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calculate_saturation_coefficients-Tuple{Tuple{Float64, Float64}, Tuple{Float64, Float64}}","page":"Internals","title":"PowerSystems.calculate_saturation_coefficients","text":"calculate_saturation_coefficients(\n E::Tuple{Float64, Float64},\n Se::Tuple{Float64, Float64}\n) -> Tuple{Float64, Float64}\n\n\nObtain 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 \n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_ascending_order-Tuple{Array{Int64}, AbstractString}","page":"Internals","title":"PowerSystems.check_ascending_order","text":"check_ascending_order(\n array::Array{Int64},\n name::AbstractString\n)\n\n\nThrows DataFormatError if the array is not in ascending order.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_attached_buses-Tuple{System, Component}","page":"Internals","title":"PowerSystems.check_attached_buses","text":"check_attached_buses(sys::System, component::Component)\n\n\nThrows ArgumentError if any bus attached to the component is invalid.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_branch_loops-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_branch_loops","text":"check_branch_loops(data::Dict{String})\n\n\nchecks that all branches connect two distinct buses\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_component_addition-Tuple{System, Component}","page":"Internals","title":"PowerSystems.check_component_addition","text":"check_component_addition(\n sys::System,\n component::Component;\n kwargs...\n)\n\n\nThrows ArgumentError if a PowerSystems rule blocks addition to the system.\n\nThis method is tied with handlecomponentaddition!. If the methods are re-implemented for a subtype then whatever is added in handlecomponentaddition! must be checked here.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_component_removal-Tuple{System, Component}","page":"Internals","title":"PowerSystems.check_component_removal","text":"check_component_removal(sys::System, component::Component)\n\n\nThrows ArgumentError if a PowerSystems rule blocks removal from the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_component_removal-Union{Tuple{T}, Tuple{System, T}} where T<:Service","page":"Internals","title":"PowerSystems.check_component_removal","text":"check_component_removal(sys::System, service::Service)\n\n\nThrows ArgumentError if a PowerSystems rule blocks removal from the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_conductors-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_conductors","text":"check_conductors(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_connectivity-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_connectivity","text":"check_connectivity(data::Dict{String})\n\n\nchecks that all buses are unique and other components link to valid buses\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_reference_bus-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_reference_bus","text":"check_reference_bus(data::Dict{String})\n\n\nchecks that contains at least one refrence bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_reference_buses-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.check_reference_buses","text":"check_reference_buses(data::Dict{String, Any})\n\n\nchecks that each connected components has a reference bus, if not, adds one\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_status-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_status","text":"check_status(data::Dict{String})\n\n\nchecks that active components are not connected to inactive buses, otherwise prints warnings\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_storage_parameters-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.check_storage_parameters","text":"check_storage_parameters(data::Dict{String, Any})\n\n\nchecks that each storage unit has a reasonable parameters\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_subsystems-Tuple{System}","page":"Internals","title":"PowerSystems.check_subsystems","text":"check_subsystems(sys::System)\n\n\nCheck the the consistency of subsystems.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_switch_parameters-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_switch_parameters","text":"check_switch_parameters(data::Dict{String})\n\n\nchecks that each switch has a reasonable parameters\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_type-Tuple{Any, Any}","page":"Internals","title":"PowerSystems.check_type","text":"check_type(typ, value) -> Any\n\n\nChecks if the given value is of a given type, if not tries to make it that type\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_voltage_setpoints-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_voltage_setpoints","text":"check_voltage_setpoints(data::Dict{String})\n\n\nthrows warnings if generator and dc line voltage setpoints are not consistent with the bus voltage setpoint\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.compare_dict-Tuple{Any, Any}","page":"Internals","title":"PowerSystems.compare_dict","text":"compare_dict(d1, d2) -> Bool\n\n\ntests if two dicts are equal, up to floating point precision\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_branch_directions!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_branch_directions!","text":"correct_branch_directions!(data::Dict{String}) -> Set{Int64}\n\n\nchecks that all parallel branches have the same orientation\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_bus_types!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_bus_types!","text":"correct_bus_types!(data::Dict{String}) -> Set{Int64}\n\n\nchecks bus types are consistent with generator connections, if not, fixes them\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_component_refrence_bus!-Tuple{Any, Any, Any}","page":"Internals","title":"PowerSystems.correct_component_refrence_bus!","text":"correct_component_refrence_bus!(\n component_bus_ids,\n bus_lookup,\n component_gens\n)\n\n\nchecks that a connected component has a reference bus, if not, tries to add one\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_cost_functions!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_cost_functions!","text":"correct_cost_functions!(\n data::Dict{String}\n) -> Tuple{Set{Int64}, Set{Int64}}\n\n\nthrows warnings if cost functions are malformed\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_current_limits!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_current_limits!","text":"correct_current_limits!(data::Dict{String}) -> Set{Int64}\n\n\nchecks that each branch has a reasonable current rating-a, if not computes one\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_dcline_limits!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.correct_dcline_limits!","text":"correct_dcline_limits!(\n data::Dict{String, Any}\n) -> Set{Int64}\n\n\nchecks that parameters for dc lines are reasonable\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_network_data!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_network_data!","text":"correct_network_data!(\n data::Dict{String};\n correct_branch_rating\n) -> Dict{String, Dict{Symbol, Set{Int64}}}\n\n\nRuns various data quality checks on a PowerModels data dictionary. Applies modifications in some cases. Reports modified component ids.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_thermal_limits!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_thermal_limits!","text":"correct_thermal_limits!(data::Dict{String}) -> Set{Int64}\n\n\nchecks that each branch has a reasonable thermal rating-a, if not computes one\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_transformer_parameters!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_transformer_parameters!","text":"correct_transformer_parameters!(\n data::Dict{String}\n) -> Set{Int64}\n\n\nchecks that each branch has a reasonable transformer parameters\n\nthis is important because setting tap == 0.0 leads to NaN computations, which are hard to debug\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_voltage_angle_differences!","page":"Internals","title":"PowerSystems.correct_voltage_angle_differences!","text":"correct_voltage_angle_differences!(\n data::Dict{String}\n) -> Set{Int64}\ncorrect_voltage_angle_differences!(\n data::Dict{String},\n default_pad\n) -> Set{Int64}\n\n\nchecks that voltage angle differences are within 90 deg., if not tightens\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems.dc_branch_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.dc_branch_csv_parser!","text":"dc_branch_csv_parser!(\n sys::System,\n data::PowerSystemTableData\n)\n\n\nAdd DC branches to the System from raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.deactivate_isolated_components!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.deactivate_isolated_components!","text":"deactivate_isolated_components!(data::Dict{String}) -> Bool\n\n\nremoves buses with single branch connections and without any other attached components. Also removes connected components without suffuceint generation or loads.\n\nalso deactivates 0 valued loads and shunts.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.deserialize_uuid_handling-Tuple{Any, Any, Any}","page":"Internals","title":"PowerSystems.deserialize_uuid_handling","text":"deserialize_uuid_handling(\n field_type,\n val,\n component_cache\n) -> Any\n\n\nDeserialize the value, converting UUIDs to components where necessary.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_active_power_control-Tuple{OuterControl}","page":"Internals","title":"PowerSystems.get_active_power_control","text":"get_active_power_control(\n value::OuterControl\n) -> PowerSystems.ActivePowerControl\n\n\nGet active_power_control from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_avr_saturation-Tuple{Tuple{Float64, Float64}, Tuple{Float64, Float64}}","page":"Internals","title":"PowerSystems.get_avr_saturation","text":"get_avr_saturation(\n E::Tuple{Float64, Float64},\n Se::Tuple{Float64, Float64}\n) -> Tuple{Float64, Float64}\n\n\nObtain coefficients for an AVR \n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_branch-Tuple{DynamicBranch}","page":"Internals","title":"PowerSystems.get_branch","text":"get_branch(value::DynamicBranch) -> ACBranch\n\n\nGet branch\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_dataframe-Tuple{PowerSystemTableData, PowerSystems.InputCategoryModule.InputCategory}","page":"Internals","title":"PowerSystems.get_dataframe","text":"get_dataframe(\n data::PowerSystemTableData,\n category::PowerSystems.InputCategoryModule.InputCategory\n) -> DataFrames.DataFrame\n\n\nReturn the dataframe for the category.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_enum_value-Tuple{Any, AbstractString}","page":"Internals","title":"PowerSystems.get_enum_value","text":"get_enum_value(enum, value::AbstractString) -> Any\n\n\nGet the enum value for the string. Case insensitive.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_exponential_saturation-Tuple{Tuple{Float64, Float64}}","page":"Internals","title":"PowerSystems.get_exponential_saturation","text":"get_exponential_saturation(\n Se::Tuple{Float64, Float64}\n) -> Tuple{Float64, Float64}\n\n\nObtain 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)\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_generator_mapping","page":"Internals","title":"PowerSystems.get_generator_mapping","text":"get_generator_mapping() -> Dict{NamedTuple, DataType}\nget_generator_mapping(\n filename\n) -> Dict{NamedTuple, DataType}\n\n\nReturn a dict where keys are a tuple of input parameters (fuel, unit_type) and values are generator types.\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems.get_generator_type-Tuple{Any, Any, Dict{NamedTuple, DataType}}","page":"Internals","title":"PowerSystems.get_generator_type","text":"get_generator_type(\n fuel,\n unit_type,\n mappings::Dict{NamedTuple, DataType}\n) -> Union{Nothing, DataType}\n\n\nReturn the PowerSystems generator type for this fuel and unit_type.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_interconnection_efficiency-Tuple{HybridSystem}","page":"Internals","title":"PowerSystems.get_interconnection_efficiency","text":"get_interconnection_efficiency(\n value::HybridSystem\n) -> Union{Nothing, @NamedTuple{in::Float64, out::Float64}}\n\n\nget HybridSystem interconnection efficiency\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_outage_status_scenario-Tuple{TimeSeriesForcedOutage}","page":"Internals","title":"PowerSystems.get_outage_status_scenario","text":"get_outage_status_scenario(\n value::TimeSeriesForcedOutage\n) -> String\n\n\nGet TimeSeriesForcedOutage outage_status_scenario.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_quadratic_saturation-Tuple{Tuple{Float64, Float64}}","page":"Internals","title":"PowerSystems.get_quadratic_saturation","text":"get_quadratic_saturation(\n Se::Tuple{Float64, Float64}\n) -> Tuple{Float64, Float64}\n\n\nObtain 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_reactive_power_control-Tuple{OuterControl}","page":"Internals","title":"PowerSystems.get_reactive_power_control","text":"get_reactive_power_control(\n value::OuterControl\n) -> PowerSystems.ReactivePowerControl\n\n\nGet reactive_power_control from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_series_susceptance-Tuple{ACBranch}","page":"Internals","title":"PowerSystems.get_series_susceptance","text":"get_series_susceptance(b::ACBranch) -> Float64\n\n\nCalculate the admittance of AC branches\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_series_susceptance-Tuple{Union{PhaseShiftingTransformer, TapTransformer}}","page":"Internals","title":"PowerSystems.get_series_susceptance","text":"get_series_susceptance(\n b::Union{PhaseShiftingTransformer, TapTransformer}\n) -> Float64\n\n\nReturns 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_user_field-Tuple{PowerSystemTableData, PowerSystems.InputCategoryModule.InputCategory, AbstractString}","page":"Internals","title":"PowerSystems.get_user_field","text":"get_user_field(\n data::PowerSystemTableData,\n category::PowerSystems.InputCategoryModule.InputCategory,\n field::AbstractString\n) -> Any\n\n\nReturn the custom name stored in the user descriptor file.\n\nThrows DataFormatError if a required value is not found in the file.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_user_fields-Tuple{PowerSystemTableData, PowerSystems.InputCategoryModule.InputCategory}","page":"Internals","title":"PowerSystems.get_user_fields","text":"get_user_fields(\n data::PowerSystemTableData,\n category::PowerSystems.InputCategoryModule.InputCategory\n) -> Any\n\n\nReturn a vector of user-defined fields for the category.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_component_addition!-Tuple{System, Component}","page":"Internals","title":"PowerSystems.handle_component_addition!","text":"handle_component_addition!(\n sys::System,\n component::Component;\n kwargs...\n)\n\n\nRefer to docstring for checkcomponentaddition!\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_component_addition_to_subsystem!-Tuple{System, AbstractString, Component}","page":"Internals","title":"PowerSystems.handle_component_addition_to_subsystem!","text":"handle_component_addition_to_subsystem!(\n _::System,\n subsystem_name::AbstractString,\n _::Component\n)\n\n\nPeforms component-type-specific postprocessing when a component is added to a subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_component_removal!-Tuple{System, ACBus}","page":"Internals","title":"PowerSystems.handle_component_removal!","text":"handle_component_removal!(sys::System, bus::ACBus)\n\n\nThrows ArgumentError if the bus number is not stored in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_component_removal_from_subsystem!-Tuple{System, AbstractString, Component}","page":"Internals","title":"PowerSystems.handle_component_removal_from_subsystem!","text":"handle_component_removal_from_subsystem!(\n _::System,\n subsystem_name::AbstractString,\n _::Component\n)\n\n\nPeforms component-type-specific postprocessing when a component is removed from a subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_deserialization_special_cases!-Tuple{Dict, Type{<:Component}}","page":"Internals","title":"PowerSystems.handle_deserialization_special_cases!","text":"handle_deserialization_special_cases!(\n component::Dict,\n _::Type{<:Component}\n)\n\n\nAllow types to implement handling of special cases during deserialization.\n\nArguments\n\ncomponent::Dict: The component serialized as a dictionary.\n::Type: The type of the component.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.im_replicate-Tuple{Dict{String}, Int64, Set{String}}","page":"Internals","title":"PowerSystems.im_replicate","text":"im_replicate(\n sn_data::Dict{String},\n count::Int64,\n global_keys::Set{String}\n) -> Dict{String, Any}\n\n\nTransforms a single network into a multinetwork with several deepcopies of the original network\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.is_attached-Union{Tuple{T}, Tuple{T, System}} where T<:Component","page":"Internals","title":"PowerSystems.is_attached","text":"is_attached(component::Component, sys::System) -> Bool\n\n\nReturn true if the component is attached to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.isafield-Tuple{Component, Symbol}","page":"Internals","title":"PowerSystems.isafield","text":"isafield(component::Component, field::Symbol) -> Any\n\n\nChecks if a PowerSystemDevice has a field or subfield name.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.ismultinetwork-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.ismultinetwork","text":"ismultinetwork(data::Dict{String}) -> Any\n\n\nchecks if a given network data is a multinetwork\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.iterate_rows-Tuple{PowerSystemTableData, Any}","page":"Internals","title":"PowerSystems.iterate_rows","text":"iterate_rows(\n data::PowerSystemTableData,\n category;\n na_to_nothing\n) -> Channel{Any}\n\n\nReturn a NamedTuple of parameters from the descriptor file for each row of a dataframe, making type conversions as necessary.\n\nRefer to the PowerSystems descriptor file for field names that will be created.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.load_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.load_csv_parser!","text":"load_csv_parser!(sys::System, data::PowerSystemTableData)\n\n\nload_csv_parser!(sys::System, data::PowerSystemTableData)\n\nAdd loads to the System from the raw load data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.loadzone_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.loadzone_csv_parser!","text":"loadzone_csv_parser!(\n sys::System,\n data::PowerSystemTableData\n)\n\n\nloadzone_csv_parser!(sys::System, data::PowerSystemTableData)\n\nAdd branches to the System from the raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_bus-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.make_bus","text":"make_bus(bus_dict::Dict{String, Any}) -> ACBus\n\n\nCreates a PowerSystems.ACBus from a PowerSystems bus dictionary\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_generator-Tuple{PowerSystemTableData, Vararg{Any, 4}}","page":"Internals","title":"PowerSystems.make_generator","text":"make_generator(\n data::PowerSystemTableData,\n gen,\n cost_colnames,\n bus,\n gen_storage\n) -> Union{Nothing, EnergyReservoirStorage, HydroDispatch, HydroEnergyReservoir, HydroPumpedStorage, RenewableDispatch, RenewableNonDispatch, ThermalStandard}\n\n\nCreates a generator of any type.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_mixed_units!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.make_mixed_units!","text":"make_mixed_units!(data::Dict{String})\n\n\nTransforms network data into mixed-units (inverse of per-unit)\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_per_unit!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.make_per_unit!","text":"make_per_unit!(data::Dict{String})\n\n\nTransforms network data into per-unit\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_thermal_gen-Tuple{Union{SubString{String}, String}, Dict, ACBus, Float64}","page":"Internals","title":"PowerSystems.make_thermal_gen","text":"make_thermal_gen(\n gen_name::Union{SubString{String}, String},\n d::Dict,\n bus::ACBus,\n sys_mbase::Float64\n) -> ThermalStandard\n\n\nThe 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\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.move_genfuel_and_gentype!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.move_genfuel_and_gentype!","text":"move_genfuel_and_gentype!(data::Dict{String, Any})\n\n\nMove gentype and genfuel fields to be subfields of gen\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_matpower-Tuple{IO}","page":"Internals","title":"PowerSystems.parse_matpower","text":"parse_matpower(io::IO; validate) -> Dict{String, Any}\n\n\nParses the matpwer data from either a filename or an IO object\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_psse-Tuple{IO}","page":"Internals","title":"PowerSystems.parse_psse","text":"parse_psse(io::IO; kwargs...) -> Dict{String, Any}\n\n\nfunction parse_psse(io::IO; kwargs...)::Dict\n\nParses directly from iostream\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_psse-Tuple{String}","page":"Internals","title":"PowerSystems.parse_psse","text":"parse_psse(filename::String; kwargs...) -> Dict{String, Any}\n\n\nparse_psse(filename::String; kwargs...)::Dict\n\nParses directly from file\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_pti-Tuple{IO}","page":"Internals","title":"PowerSystems.parse_pti","text":"parse_pti(io::IO) -> Dict{String, Array{Dict}}\n\n\nparse_pti(io::IO)\n\nReads PTI data in io::IO, returning a Dict of the data parsed into the proper types.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_pti-Tuple{String}","page":"Internals","title":"PowerSystems.parse_pti","text":"parse_pti(filename::String) -> Dict{String, Array{Dict}}\n\n\nparse_pti(filename::String)\n\nOpen PTI raw file given by filename, returning a Dict of the data parsed into the proper types.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.propagate_topology_status!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.propagate_topology_status!","text":"propagate_topology_status!(\n data::Dict{String}\n) -> Union{Nothing, Bool}\n\n\nfinds active network buses and branches that are not necessary for the computation and sets their status to off.\n\nWorks on a PowerModels data dict, so that a it can be used without a GenericPowerModel object\n\nWarning: this implementation has quadratic complexity, in the worst case\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.read_and_convert_ts","page":"Internals","title":"PowerSystems.read_and_convert_ts","text":"read_and_convert_ts(\n ts::TimeSeriesData,\n component::Component\n) -> TimeSeries.TimeArray\nread_and_convert_ts(\n ts::TimeSeriesData,\n component::Component,\n start_time::Union{Nothing, Dates.DateTime}\n) -> TimeSeries.TimeArray\nread_and_convert_ts(\n ts::TimeSeriesData,\n component::Component,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64}\n) -> TimeSeries.TimeArray\nread_and_convert_ts(\n ts::TimeSeriesData,\n component::Component,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64},\n transform_fn\n) -> TimeSeries.TimeArray\n\n\nCall gettimeseriesarray on the given time series and return a TimeArray of the results, values mapped by `transformfn` if it is not nothing\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems.read_gen!-Tuple{System, Dict, Dict{Int64, ACBus}}","page":"Internals","title":"PowerSystems.read_gen!","text":"read_gen!(\n sys::System,\n data::Dict,\n bus_number_to_bus::Dict{Int64, ACBus};\n kwargs...\n)\n\n\nTransfer generators to ps_dict according to their classification\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.replicate-Tuple{Dict{String}, Int64}","page":"Internals","title":"PowerSystems.replicate","text":"replicate(\n sn_data::Dict{String},\n count::Int64;\n global_keys\n) -> Dict{String, Any}\n\n\nTurns 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.resolve_swithces!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.resolve_swithces!","text":"resolve_swithces!(data::Dict{String})\n\n\ngiven a network data dict merges buses that are connected by closed switches converting the dataset into a pure bus-branch model.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.row_to_dict-Tuple{Any, Any}","page":"Internals","title":"PowerSystems.row_to_dict","text":"row_to_dict(row_data, columns) -> Dict{String, Any}\n\n\ntakes a row from a matrix and assigns the values names\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.row_to_typed_dict-Tuple{Any, Any}","page":"Internals","title":"PowerSystems.row_to_typed_dict","text":"row_to_typed_dict(row_data, columns) -> Dict{String, Any}\n\n\ntakes a row from a matrix and assigns the values names and types\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.select_largest_component-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.select_largest_component","text":"select_largest_component(data::Dict{String, Any}) -> Any\n\n\ndetermines the largest connected component of the network and turns everything else off\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.serialize_uuid_handling-Tuple{Any}","page":"Internals","title":"PowerSystems.serialize_uuid_handling","text":"serialize_uuid_handling(val) -> Any\n\n\nSerialize the value, encoding as UUIDs where necessary.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.services_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.services_csv_parser!","text":"services_csv_parser!(\n sys::System,\n data::PowerSystemTableData\n)\n\n\nAdd services to the System from the raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_active_power_control!-Tuple{OuterControl, Any}","page":"Internals","title":"PowerSystems.set_active_power_control!","text":"set_active_power_control!(value::OuterControl, val) -> Any\n\n\nSet OuterControl active_power_control.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_branch!-Tuple{DynamicBranch, ACBranch}","page":"Internals","title":"PowerSystems.set_branch!","text":"set_branch!(value::DynamicBranch, val::ACBranch) -> ACBranch\n\n\nSet branch\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_electric_load!-Tuple{HybridSystem, ElectricLoad}","page":"Internals","title":"PowerSystems.set_electric_load!","text":"set_electric_load!(hybrid::HybridSystem, val::ElectricLoad)\n\n\nSet HybridSystem load\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_interconnection_efficiency!-Tuple{HybridSystem, Any}","page":"Internals","title":"PowerSystems.set_interconnection_efficiency!","text":"set_interconnection_efficiency!(\n value::HybridSystem,\n val\n) -> Any\n\n\nSet HybridSystem interconnection_efficiency.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_interconnection_impedance!-Tuple{HybridSystem, Any}","page":"Internals","title":"PowerSystems.set_interconnection_impedance!","text":"set_interconnection_impedance!(\n value::HybridSystem,\n val\n) -> Any\n\n\nset HybridSystem interconnection impedance\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_interconnection_rating!-Tuple{HybridSystem, Any}","page":"Internals","title":"PowerSystems.set_interconnection_rating!","text":"set_interconnection_rating!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem interconnection_rating.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_reactive_power_control!-Tuple{OuterControl, Any}","page":"Internals","title":"PowerSystems.set_reactive_power_control!","text":"set_reactive_power_control!(value::OuterControl, val) -> Any\n\n\nSet OuterControl reactive_power_control.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_renewable_unit!-Tuple{HybridSystem, RenewableGen}","page":"Internals","title":"PowerSystems.set_renewable_unit!","text":"set_renewable_unit!(hybrid::HybridSystem, val::RenewableGen)\n\n\nSet HybridSystem renewable unit\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_storage!-Tuple{HybridSystem, Storage}","page":"Internals","title":"PowerSystems.set_storage!","text":"set_storage!(hybrid::HybridSystem, val::Storage)\n\n\nSet HybridSystem storage unit\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_thermal_unit!-Tuple{HybridSystem, ThermalGen}","page":"Internals","title":"PowerSystems.set_thermal_unit!","text":"set_thermal_unit!(hybrid::HybridSystem, val::ThermalGen)\n\n\nSet HybridSystem thermal unit\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.simplify_cost_terms!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.simplify_cost_terms!","text":"simplify_cost_terms!(\n data::Dict{String}\n) -> Tuple{Set{Int64}, Set{Int64}}\n\n\ntrims zeros from higher order cost terms\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.simplify_network!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.simplify_network!","text":"simplify_network!(data::Dict{String}) -> Bool\n\n\nattempts to deactive components that are not needed in the network by repeated calls to propagate_topology_status! and deactivate_isolated_components!\n\nwarning: this implementation has quadratic complexity, in the worst case\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.split_line-Tuple{AbstractString}","page":"Internals","title":"PowerSystems.split_line","text":"split_line(mp_line::AbstractString) -> Vector{Any}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.standardize_cost_terms!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.standardize_cost_terms!","text":"standardize_cost_terms!(data::Dict{String}; order)\n\n\nensures all polynomial costs functions have the same number of terms\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.throw_if_not_attached-Tuple{Component, System}","page":"Internals","title":"PowerSystems.throw_if_not_attached","text":"throw_if_not_attached(component::Component, sys::System)\n\n\nThrows ArgumentError if the component is not attached to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.total_capacity_rating-Tuple{System}","page":"Internals","title":"PowerSystems.total_capacity_rating","text":"total_capacity_rating(sys::System) -> Any\n\n\ntotal_capacity_rating(sys::System)\n\nSum of system generator and storage ratings.\n\nArguments\n\nsys::System: system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.total_load_rating-Tuple{System}","page":"Internals","title":"PowerSystems.total_load_rating","text":"total_load_rating(sys::System) -> Any\n\n\ntotal_load_rating(sys::System)\n\nChecks the system for sum(generator ratings) >= sum(load ratings).\n\nArguments\n\nsys::System: system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.update_bus_ids!-Tuple{Dict{String}, Dict{Int64, Int64}}","page":"Internals","title":"PowerSystems.update_bus_ids!","text":"update_bus_ids!(\n data::Dict{String},\n bus_id_map::Dict{Int64, Int64};\n injective\n)\n\n\ngiven 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.update_data!-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.update_data!","text":"update_data!(data::Dict{String}, new_data::Dict{String})\n\n\nrecursively applies new_data to data, overwriting information\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.verify_device_eligibility-Tuple{System, StaticInjection, Service}","page":"Internals","title":"PowerSystems.verify_device_eligibility","text":"verify_device_eligibility(\n sys::System,\n component::StaticInjection,\n service::Service\n)\n\n\nValidates if a device is eligible to contribute to a service.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\nservice::Service,: Service for which the device is eligible to contribute\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#FrequencyEstimator","page":"FrequencyEstimator","title":"FrequencyEstimator","text":"","category":"section"},{"location":"model_library/generated_FrequencyEstimator/#FixedFrequency","page":"FrequencyEstimator","title":"FixedFrequency","text":"","category":"section"},{"location":"model_library/generated_FrequencyEstimator/","page":"FrequencyEstimator","title":"FrequencyEstimator","text":"Modules = [PowerSystems]\nPages = [\"/FixedFrequency.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.FixedFrequency","page":"FrequencyEstimator","title":"PowerSystems.FixedFrequency","text":"mutable struct FixedFrequency <: FrequencyEstimator\n frequency::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Fixed Frequency Estimator (i.e. no PLL)\n\nArguments\n\nfrequency::Float64: (default: 1.0) Reference Frequency (pu)\next::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.\nstates::Vector{Symbol}: (Do not modify.) FixedFrequency has no states\nn_states::Int: (Do not modify.) FixedFrequency has no states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ext-Tuple{FixedFrequency}","page":"FrequencyEstimator","title":"PowerSystems.get_ext","text":"get_ext(value::FixedFrequency) -> Dict{String, Any}\n\n\nGet FixedFrequency ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_frequency-Tuple{FixedFrequency}","page":"FrequencyEstimator","title":"PowerSystems.get_frequency","text":"get_frequency(value::FixedFrequency) -> Float64\n\n\nGet FixedFrequency frequency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_n_states-Tuple{FixedFrequency}","page":"FrequencyEstimator","title":"PowerSystems.get_n_states","text":"get_n_states(value::FixedFrequency) -> Int64\n\n\nGet FixedFrequency n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_states-Tuple{FixedFrequency}","page":"FrequencyEstimator","title":"PowerSystems.get_states","text":"get_states(value::FixedFrequency) -> Vector{Symbol}\n\n\nGet FixedFrequency states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ext!-Tuple{FixedFrequency, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ext!","text":"set_ext!(value::FixedFrequency, val) -> Any\n\n\nSet FixedFrequency ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_frequency!-Tuple{FixedFrequency, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_frequency!","text":"set_frequency!(value::FixedFrequency, val) -> Any\n\n\nSet FixedFrequency frequency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#KauraPLL","page":"FrequencyEstimator","title":"KauraPLL","text":"","category":"section"},{"location":"model_library/generated_FrequencyEstimator/","page":"FrequencyEstimator","title":"FrequencyEstimator","text":"Modules = [PowerSystems]\nPages = [\"/KauraPLL.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.KauraPLL","page":"FrequencyEstimator","title":"PowerSystems.KauraPLL","text":"mutable struct KauraPLL <: FrequencyEstimator\n ω_lp::Float64\n kp_pll::Float64\n ki_pll::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters 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\n\nArguments\n\nω_lp::Float64: PLL low-pass filter frequency (rad/sec), validation range: (0, nothing)\nkp_pll::Float64: PLL proportional gain, validation range: (0, nothing)\nki_pll::Float64: PLL integral gain, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the KauraPLL model are:\n\nvd_pll: d-axis of the measured voltage in the PLL synchronous reference frame (SRF),\nvq_pll: q-axis of the measured voltage in the PLL SRF,\nε_pll: Integrator state of the PI controller,\nθ_pll: Phase angle displacement in the PLL SRF\n\nn_states::Int: (Do not modify.) KauraPLL has 4 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ext-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ext","text":"get_ext(value::KauraPLL) -> Dict{String, Any}\n\n\nGet KauraPLL ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ki_pll-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ki_pll","text":"get_ki_pll(value::KauraPLL) -> Float64\n\n\nGet KauraPLL ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_kp_pll-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_kp_pll","text":"get_kp_pll(value::KauraPLL) -> Float64\n\n\nGet KauraPLL kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_n_states-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_n_states","text":"get_n_states(value::KauraPLL) -> Int64\n\n\nGet KauraPLL n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_states-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_states","text":"get_states(value::KauraPLL) -> Vector{Symbol}\n\n\nGet KauraPLL states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ω_lp-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ω_lp","text":"get_ω_lp(value::KauraPLL) -> Float64\n\n\nGet KauraPLL ω_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ext!-Tuple{KauraPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ext!","text":"set_ext!(value::KauraPLL, val) -> Any\n\n\nSet KauraPLL ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ki_pll!-Tuple{KauraPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ki_pll!","text":"set_ki_pll!(value::KauraPLL, val) -> Any\n\n\nSet KauraPLL ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_kp_pll!-Tuple{KauraPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_kp_pll!","text":"set_kp_pll!(value::KauraPLL, val) -> Any\n\n\nSet KauraPLL kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ω_lp!-Tuple{KauraPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ω_lp!","text":"set_ω_lp!(value::KauraPLL, val) -> Any\n\n\nSet KauraPLL ω_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#ReducedOrderPLL","page":"FrequencyEstimator","title":"ReducedOrderPLL","text":"","category":"section"},{"location":"model_library/generated_FrequencyEstimator/","page":"FrequencyEstimator","title":"FrequencyEstimator","text":"Modules = [PowerSystems]\nPages = [\"/ReducedOrderPLL.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.ReducedOrderPLL","page":"FrequencyEstimator","title":"PowerSystems.ReducedOrderPLL","text":"mutable struct ReducedOrderPLL <: FrequencyEstimator\n ω_lp::Float64\n kp_pll::Float64\n ki_pll::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Phase-Locked Loop (PLL) based on \"Reduced-order Structure-preserving Model for Parallel-connected Three-phase Grid-tied Inverters.\"\n\nArguments\n\nω_lp::Float64: PLL low-pass filter frequency (rad/sec), validation range: (0, nothing)\nkp_pll::Float64: PLL proportional gain, validation range: (0, nothing)\nki_pll::Float64: PLL integral gain, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReducedOrderPLL model are:\n\nvq_pll: q-axis of the measured voltage in the PLL synchronous reference frame (SRF),\nε_pll: Integrator state of the PI controller,\nθ_pll: Phase angle displacement in the PLL SRF\n\nn_states::Int: (Do not modify.) ReducedOrderPLL has 3 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ext-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ext","text":"get_ext(value::ReducedOrderPLL) -> Dict{String, Any}\n\n\nGet ReducedOrderPLL ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ki_pll-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ki_pll","text":"get_ki_pll(value::ReducedOrderPLL) -> Float64\n\n\nGet ReducedOrderPLL ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_kp_pll-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_kp_pll","text":"get_kp_pll(value::ReducedOrderPLL) -> Float64\n\n\nGet ReducedOrderPLL kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_n_states-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReducedOrderPLL) -> Int64\n\n\nGet ReducedOrderPLL n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_states-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_states","text":"get_states(value::ReducedOrderPLL) -> Vector{Symbol}\n\n\nGet ReducedOrderPLL states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ω_lp-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ω_lp","text":"get_ω_lp(value::ReducedOrderPLL) -> Float64\n\n\nGet ReducedOrderPLL ω_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ext!-Tuple{ReducedOrderPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReducedOrderPLL, val) -> Any\n\n\nSet ReducedOrderPLL ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ki_pll!-Tuple{ReducedOrderPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ki_pll!","text":"set_ki_pll!(value::ReducedOrderPLL, val) -> Any\n\n\nSet ReducedOrderPLL ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_kp_pll!-Tuple{ReducedOrderPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_kp_pll!","text":"set_kp_pll!(value::ReducedOrderPLL, val) -> Any\n\n\nSet ReducedOrderPLL kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ω_lp!-Tuple{ReducedOrderPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ω_lp!","text":"set_ω_lp!(value::ReducedOrderPLL, val) -> Any\n\n\nSet ReducedOrderPLL ω_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#ExponentialLoad","page":"ExponentialLoad","title":"ExponentialLoad","text":"","category":"section"},{"location":"model_library/generated_ExponentialLoad/","page":"ExponentialLoad","title":"ExponentialLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/ExponentialLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.ExponentialLoad","page":"ExponentialLoad","title":"PowerSystems.ExponentialLoad","text":"mutable struct ExponentialLoad <: StaticLoad\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n α::Float64\n β::Float64\n base_power::Float64\n max_active_power::Float64\n max_reactive_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA voltage-dependent ZIP load, most commonly used for dynamics modeling.\n\nAn 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_power::Float64: Active power coefficient, P0 (MW)\nreactive_power::Float64: Reactive power coefficient, Q0 (MVAR)\nα::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)\nβ::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)\nbase_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)\nmax_active_power::Float64: Maximum active power (MW) that this load can demand\nmax_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ExponentialLoad/#InfrastructureSystems.get_name-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::ExponentialLoad) -> String\n\n\nGet ExponentialLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_active_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_active_power","text":"get_active_power(value::ExponentialLoad) -> Any\n\n\nGet ExponentialLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_available-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_available","text":"get_available(value::ExponentialLoad) -> Bool\n\n\nGet ExponentialLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_base_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::ExponentialLoad) -> Float64\n\n\nGet ExponentialLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_bus-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_bus","text":"get_bus(value::ExponentialLoad) -> ACBus\n\n\nGet ExponentialLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_dynamic_injector-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::ExponentialLoad\n) -> Union{Nothing, DynamicInjection}\n\n\nGet ExponentialLoad dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_ext-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_ext","text":"get_ext(value::ExponentialLoad) -> Dict{String, Any}\n\n\nGet ExponentialLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_max_active_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(value::ExponentialLoad) -> Any\n\n\nGet ExponentialLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_max_reactive_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(value::ExponentialLoad) -> Any\n\n\nGet ExponentialLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_reactive_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::ExponentialLoad) -> Any\n\n\nGet ExponentialLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_services-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_services","text":"get_services(value::ExponentialLoad) -> Vector{Service}\n\n\nGet ExponentialLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_α-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_α","text":"get_α(value::ExponentialLoad) -> Float64\n\n\nGet ExponentialLoad α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_β-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_β","text":"get_β(value::ExponentialLoad) -> Float64\n\n\nGet ExponentialLoad β.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_active_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_available!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_available!","text":"set_available!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_base_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_bus!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_bus!","text":"set_bus!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_ext!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_max_active_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_max_active_power!","text":"set_max_active_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_max_reactive_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_max_reactive_power!","text":"set_max_reactive_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_reactive_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_services!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_services!","text":"set_services!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_α!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_α!","text":"set_α!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_β!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_β!","text":"set_β!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad β.\n\n\n\n\n\n","category":"method"}] +[{"location":"model_library/generated_Filter/#Filter","page":"Filter","title":"Filter","text":"","category":"section"},{"location":"model_library/generated_Filter/#LCFilter","page":"Filter","title":"LCFilter","text":"","category":"section"},{"location":"model_library/generated_Filter/","page":"Filter","title":"Filter","text":"Modules = [PowerSystems]\nPages = [\"/LCFilter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Filter/#PowerSystems.LCFilter","page":"Filter","title":"PowerSystems.LCFilter","text":"mutable struct LCFilter <: Filter\n lf::Float64\n rf::Float64\n cf::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a LCL filter outside the converter\n\nArguments\n\nlf::Float64: filter inductance, validation range: (0, nothing)\nrf::Float64: filter resistance, validation range: (0, nothing)\ncf::Float64: filter capacitance, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the LCFilter model are:\n\nir_filter: Real current out of the filter,\nii_filter: Imaginary current out of the filter\n\nn_states::Int: (Do not modify.) LCFilter has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Filter/#PowerSystems.get_cf-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_cf","text":"get_cf(value::LCFilter) -> Float64\n\n\nGet LCFilter cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_ext-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_ext","text":"get_ext(value::LCFilter) -> Dict{String, Any}\n\n\nGet LCFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_lf-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_lf","text":"get_lf(value::LCFilter) -> Float64\n\n\nGet LCFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_n_states-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_n_states","text":"get_n_states(value::LCFilter) -> Int64\n\n\nGet LCFilter n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_rf-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_rf","text":"get_rf(value::LCFilter) -> Float64\n\n\nGet LCFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_states-Tuple{LCFilter}","page":"Filter","title":"PowerSystems.get_states","text":"get_states(value::LCFilter) -> Vector{Symbol}\n\n\nGet LCFilter states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_cf!-Tuple{LCFilter, Any}","page":"Filter","title":"PowerSystems.set_cf!","text":"set_cf!(value::LCFilter, val) -> Any\n\n\nSet LCFilter cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_ext!-Tuple{LCFilter, Any}","page":"Filter","title":"PowerSystems.set_ext!","text":"set_ext!(value::LCFilter, val) -> Any\n\n\nSet LCFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_lf!-Tuple{LCFilter, Any}","page":"Filter","title":"PowerSystems.set_lf!","text":"set_lf!(value::LCFilter, val) -> Any\n\n\nSet LCFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_rf!-Tuple{LCFilter, Any}","page":"Filter","title":"PowerSystems.set_rf!","text":"set_rf!(value::LCFilter, val) -> Any\n\n\nSet LCFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#LCLFilter","page":"Filter","title":"LCLFilter","text":"","category":"section"},{"location":"model_library/generated_Filter/","page":"Filter","title":"Filter","text":"Modules = [PowerSystems]\nPages = [\"/LCLFilter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Filter/#PowerSystems.LCLFilter","page":"Filter","title":"PowerSystems.LCLFilter","text":"mutable struct LCLFilter <: Filter\n lf::Float64\n rf::Float64\n cf::Float64\n lg::Float64\n rg::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a LCL filter outside the converter, the states are in the grid's reference frame\n\nArguments\n\nlf::Float64: Series inductance in p.u. of converter filter, validation range: (0, nothing)\nrf::Float64: Series resistance in p.u. of converter filter, validation range: (0, nothing)\ncf::Float64: Shunt capacitance in p.u. of converter filter, validation range: (0, nothing)\nlg::Float64: Series inductance in p.u. of converter filter to the grid, validation range: (0, nothing)\nrg::Float64: Series resistance in p.u. of converter filter to the grid, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the LCLFilter model are:\n\nir_cnv: Real current out of the converter,\nii_cnv: Imaginary current out of the converter,\nvr_filter: Real voltage at the filter's capacitor,\nvi_filter: Imaginary voltage at the filter's capacitor,\nir_filter: Real current out of the filter,\nii_filter: Imaginary current out of the filter\n\nn_states::Int: (Do not modify.) LCLFilter has 6 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Filter/#PowerSystems.get_cf-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_cf","text":"get_cf(value::LCLFilter) -> Float64\n\n\nGet LCLFilter cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_ext-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_ext","text":"get_ext(value::LCLFilter) -> Dict{String, Any}\n\n\nGet LCLFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_lf-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_lf","text":"get_lf(value::LCLFilter) -> Float64\n\n\nGet LCLFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_lg-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_lg","text":"get_lg(value::LCLFilter) -> Float64\n\n\nGet LCLFilter lg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_n_states-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_n_states","text":"get_n_states(value::LCLFilter) -> Int64\n\n\nGet LCLFilter n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_rf-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_rf","text":"get_rf(value::LCLFilter) -> Float64\n\n\nGet LCLFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_rg-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_rg","text":"get_rg(value::LCLFilter) -> Float64\n\n\nGet LCLFilter rg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_states-Tuple{LCLFilter}","page":"Filter","title":"PowerSystems.get_states","text":"get_states(value::LCLFilter) -> Vector{Symbol}\n\n\nGet LCLFilter states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_cf!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_cf!","text":"set_cf!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_ext!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_ext!","text":"set_ext!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_lf!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_lf!","text":"set_lf!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_lg!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_lg!","text":"set_lg!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter lg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_rf!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_rf!","text":"set_rf!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_rg!-Tuple{LCLFilter, Any}","page":"Filter","title":"PowerSystems.set_rg!","text":"set_rg!(value::LCLFilter, val) -> Any\n\n\nSet LCLFilter rg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#RLFilter","page":"Filter","title":"RLFilter","text":"","category":"section"},{"location":"model_library/generated_Filter/","page":"Filter","title":"Filter","text":"Modules = [PowerSystems]\nPages = [\"/RLFilter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Filter/#PowerSystems.RLFilter","page":"Filter","title":"PowerSystems.RLFilter","text":"mutable struct RLFilter <: Filter\n rf::Float64\n lf::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of RL series filter in algebraic representation\n\nArguments\n\nrf::Float64: Series resistance in p.u. of converter filter to the grid, validation range: (0, nothing)\nlf::Float64: Series inductance in p.u. of converter filter to the grid, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) RLFilter has zero states\nn_states::Int: (Do not modify.) RLFilter has zero states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Filter/#PowerSystems.get_ext-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_ext","text":"get_ext(value::RLFilter) -> Dict{String, Any}\n\n\nGet RLFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_lf-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_lf","text":"get_lf(value::RLFilter) -> Float64\n\n\nGet RLFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_n_states-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_n_states","text":"get_n_states(value::RLFilter) -> Int64\n\n\nGet RLFilter n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_rf-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_rf","text":"get_rf(value::RLFilter) -> Float64\n\n\nGet RLFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.get_states-Tuple{RLFilter}","page":"Filter","title":"PowerSystems.get_states","text":"get_states(value::RLFilter) -> Vector{Symbol}\n\n\nGet RLFilter states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_ext!-Tuple{RLFilter, Any}","page":"Filter","title":"PowerSystems.set_ext!","text":"set_ext!(value::RLFilter, val) -> Any\n\n\nSet RLFilter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_lf!-Tuple{RLFilter, Any}","page":"Filter","title":"PowerSystems.set_lf!","text":"set_lf!(value::RLFilter, val) -> Any\n\n\nSet RLFilter lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Filter/#PowerSystems.set_rf!-Tuple{RLFilter, Any}","page":"Filter","title":"PowerSystems.set_rf!","text":"set_rf!(value::RLFilter, val) -> Any\n\n\nSet RLFilter rf.\n\n\n\n\n\n","category":"method"},{"location":"how_to/powersystembuilder/#psb","page":"...load a system from PowerSystemCaseBuilder","title":"Load a system from PowerSystemCaseBuilder","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"Originally Contributed by: Clayton Barrows","category":"page"},{"location":"how_to/powersystembuilder/#Introduction","page":"...load a system from PowerSystemCaseBuilder","title":"Introduction","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"PowerSystemCaseBuilder.jl provides a utility to manage a library of Systems. The package has utilities to list the available system data and to create instances of each system. By keeping track of which systems have been constructed locally, it makes the re-instantiation of systems efficient by utilizing the serialization features and avoiding the parsing process for systems that have been previously constructed.","category":"page"},{"location":"how_to/powersystembuilder/#Dependencies","page":"...load a system from PowerSystemCaseBuilder","title":"Dependencies","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"using PowerSystemCaseBuilder","category":"page"},{"location":"how_to/powersystembuilder/#List-all-systems-in-library","page":"...load a system from PowerSystemCaseBuilder","title":"List all systems in library","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"show_systems()","category":"page"},{"location":"how_to/powersystembuilder/#Systems-can-be-listed-by-category","page":"...load a system from PowerSystemCaseBuilder","title":"Systems can be listed by category","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"The available categories can be displayed with:","category":"page"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"show_categories()","category":"page"},{"location":"how_to/powersystembuilder/#Create-a-System","page":"...load a system from PowerSystemCaseBuilder","title":"Create a System","text":"","category":"section"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"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","category":"page"},{"location":"how_to/powersystembuilder/","page":"...load a system from PowerSystemCaseBuilder","title":"...load a system from PowerSystemCaseBuilder","text":"sys = build_system(PSITestSystems, \"c_sys5_uc\")","category":"page"},{"location":"model_library/generated_Machine/#Machine","page":"Machine","title":"Machine","text":"","category":"section"},{"location":"model_library/generated_Machine/#AndersonFouadMachine","page":"Machine","title":"AndersonFouadMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/AndersonFouadMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.AndersonFouadMachine","page":"Machine","title":"PowerSystems.AndersonFouadMachine","text":"mutable struct AndersonFouadMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 6-states synchronous machine: Anderson-Fouad model\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψq: q-axis stator flux,\nψd: d-axis stator flux,\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage,\neq_pp: q-axis subtransient voltage,\ned_pp: d-axis subtransient voltage\n\nn_states::Int: (Do not modify.) The states AndersonFouadMachine has 6 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::AndersonFouadMachine) -> Float64\n\n\nGet AndersonFouadMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::AndersonFouadMachine) -> Dict{String, Any}\n\n\nGet AndersonFouadMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::AndersonFouadMachine) -> Int64\n\n\nGet AndersonFouadMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{AndersonFouadMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::AndersonFouadMachine) -> Vector{Symbol}\n\n\nGet AndersonFouadMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{AndersonFouadMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::AndersonFouadMachine, val) -> Any\n\n\nSet AndersonFouadMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#BaseMachine","page":"Machine","title":"BaseMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/BaseMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.BaseMachine","page":"Machine","title":"PowerSystems.BaseMachine","text":"mutable struct BaseMachine <: Machine\n R::Float64\n Xd_p::Float64\n eq_p::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Classic Machine: GENCLS in PSSE and PSLF\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd_p::Float64: Reactance after EMF in machine per unit, validation range: (0, nothing)\neq_p::Float64: Fixed EMF behind the impedance, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) BaseMachine has no states\nn_states::Int: (Do not modify.) BaseMachine has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::BaseMachine) -> Float64\n\n\nGet BaseMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::BaseMachine) -> Float64\n\n\nGet BaseMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_eq_p-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_eq_p","text":"get_eq_p(value::BaseMachine) -> Float64\n\n\nGet BaseMachine eq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::BaseMachine) -> Dict{String, Any}\n\n\nGet BaseMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::BaseMachine) -> Int64\n\n\nGet BaseMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{BaseMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::BaseMachine) -> Vector{Symbol}\n\n\nGet BaseMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{BaseMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::BaseMachine, val) -> Any\n\n\nSet BaseMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{BaseMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::BaseMachine, val) -> Any\n\n\nSet BaseMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_eq_p!-Tuple{BaseMachine, Any}","page":"Machine","title":"PowerSystems.set_eq_p!","text":"set_eq_p!(value::BaseMachine, val) -> Any\n\n\nSet BaseMachine eq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{BaseMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::BaseMachine, val) -> Any\n\n\nSet BaseMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#FullMachine","page":"Machine","title":"FullMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/FullMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.FullMachine","page":"Machine","title":"PowerSystems.FullMachine","text":"mutable struct FullMachine <: Machine\n R::Float64\n R_f::Float64\n R_1d::Float64\n R_1q::Float64\n L_d::Float64\n L_q::Float64\n L_ad::Float64\n L_aq::Float64\n L_f1d::Float64\n L_ff::Float64\n L_1d::Float64\n L_1q::Float64\n ext::Dict{String, Any}\n inv_d_fluxlink::Array{Float64,2}\n inv_q_fluxlink::Array{Float64,2}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameter of a full order flux stator-rotor model without zero sequence flux in the stator. The derivative of stator fluxes (ψd and ψq) is NOT neglected. Only one q-axis damping circuit is considered. All parameters 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nR_f::Float64: Field rotor winding resistance in per unit, validation range: (0, nothing)\nR_1d::Float64: Damping rotor winding resistance on d-axis in per unit. This value is denoted as RD in Machowski, validation range: (0, nothing)\nR_1q::Float64: Damping rotor winding resistance on q-axis in per unit. This value is denoted as RQ in Machowski, validation range: (0, nothing)\nL_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)\nL_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)\nL_ad::Float64: Mutual inductance between stator winding and rotor field (and damping) winding inductance on d-axis, in per unit, validation range: (0, nothing)\nL_aq::Float64: Mutual inductance between stator winding and rotor damping winding inductance on q-axis, in per unit, validation range: (0, nothing)\nL_f1d::Float64: Mutual inductance between rotor field winding and rotor damping winding inductance on d-axis, in per unit, validation range: (0, nothing)\nL_ff::Float64: Field rotor winding inductance, in per unit, validation range: (0, nothing)\nL_1d::Float64: Inductance of the d-axis rotor damping circuit, in per unit, validation range: (0, nothing)\nL_1q::Float64: Inductance of the q-axis rotor damping circuit, in per unit, validation range: (0, nothing)\next::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.\ninv_d_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.127, 3.130, 3.131 From Kundur\ninv_q_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.128, 3.132 From Kundur\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψd: d-axis stator flux,\nψq: q-axis stator flux,\nψf: field rotor flux,\nψ1d: d-axis rotor damping flux,\nψ1q: q-axis rotor damping flux\n\nn_states::Int: (Do not modify.) FullMachine has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_1d-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_1d","text":"get_L_1d(value::FullMachine) -> Float64\n\n\nGet FullMachine L_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_1q-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_1q","text":"get_L_1q(value::FullMachine) -> Float64\n\n\nGet FullMachine L_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_ad-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_ad","text":"get_L_ad(value::FullMachine) -> Float64\n\n\nGet FullMachine L_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_aq-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_aq","text":"get_L_aq(value::FullMachine) -> Float64\n\n\nGet FullMachine L_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_d-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_d","text":"get_L_d(value::FullMachine) -> Float64\n\n\nGet FullMachine L_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_f1d-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_f1d","text":"get_L_f1d(value::FullMachine) -> Float64\n\n\nGet FullMachine L_f1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_ff-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_ff","text":"get_L_ff(value::FullMachine) -> Float64\n\n\nGet FullMachine L_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_q-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_L_q","text":"get_L_q(value::FullMachine) -> Float64\n\n\nGet FullMachine L_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::FullMachine) -> Float64\n\n\nGet FullMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_1d-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_R_1d","text":"get_R_1d(value::FullMachine) -> Float64\n\n\nGet FullMachine R_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_1q-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_R_1q","text":"get_R_1q(value::FullMachine) -> Float64\n\n\nGet FullMachine R_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_f-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_R_f","text":"get_R_f(value::FullMachine) -> Float64\n\n\nGet FullMachine R_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::FullMachine) -> Dict{String, Any}\n\n\nGet FullMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_inv_d_fluxlink-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_inv_d_fluxlink","text":"get_inv_d_fluxlink(value::FullMachine) -> Matrix{Float64}\n\n\nGet FullMachine inv_d_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_inv_q_fluxlink-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_inv_q_fluxlink","text":"get_inv_q_fluxlink(value::FullMachine) -> Matrix{Float64}\n\n\nGet FullMachine inv_q_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::FullMachine) -> Int64\n\n\nGet FullMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{FullMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::FullMachine) -> Vector{Symbol}\n\n\nGet FullMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_1d!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_1d!","text":"set_L_1d!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_1q!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_1q!","text":"set_L_1q!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_ad!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_ad!","text":"set_L_ad!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_aq!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_aq!","text":"set_L_aq!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_d!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_d!","text":"set_L_d!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_f1d!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_f1d!","text":"set_L_f1d!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_f1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_ff!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_ff!","text":"set_L_ff!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_q!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_q!","text":"set_L_q!(value::FullMachine, val) -> Any\n\n\nSet FullMachine L_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::FullMachine, val) -> Any\n\n\nSet FullMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_1d!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_1d!","text":"set_R_1d!(value::FullMachine, val) -> Any\n\n\nSet FullMachine R_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_1q!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_1q!","text":"set_R_1q!(value::FullMachine, val) -> Any\n\n\nSet FullMachine R_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_f!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_f!","text":"set_R_f!(value::FullMachine, val) -> Any\n\n\nSet FullMachine R_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::FullMachine, val) -> Any\n\n\nSet FullMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_inv_d_fluxlink!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_inv_d_fluxlink!","text":"set_inv_d_fluxlink!(value::FullMachine, val) -> Any\n\n\nSet FullMachine inv_d_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_inv_q_fluxlink!-Tuple{FullMachine, Any}","page":"Machine","title":"PowerSystems.set_inv_q_fluxlink!","text":"set_inv_q_fluxlink!(value::FullMachine, val) -> Any\n\n\nSet FullMachine inv_q_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#MarconatoMachine","page":"Machine","title":"MarconatoMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/MarconatoMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.MarconatoMachine","page":"Machine","title":"PowerSystems.MarconatoMachine","text":"mutable struct MarconatoMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n T_AA::Float64\n ext::Dict{String, Any}\n γd::Float64\n γq::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 6-states synchronous machine: Marconato model\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\nT_AA::Float64: Time constant of d-axis additional leakage, validation range: (0, nothing)\next::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.\nγd::Float64: (Do not modify.) Internal equation\nγq::Float64: (Do not modify.) Internal equation\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψq: q-axis stator flux,\nψd: d-axis stator flux,\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage,\neq_pp: q-axis subtransient voltage,\ned_pp: d-axis subtransient voltage\n\nn_states::Int: (Do not modify.) MarconatoMachine has 6 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_T_AA-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_T_AA","text":"get_T_AA(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine T_AA.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::MarconatoMachine) -> Dict{String, Any}\n\n\nGet MarconatoMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::MarconatoMachine) -> Int64\n\n\nGet MarconatoMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::MarconatoMachine) -> Vector{Symbol}\n\n\nGet MarconatoMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γd-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_γd","text":"get_γd(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine γd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γq-Tuple{MarconatoMachine}","page":"Machine","title":"PowerSystems.get_γq","text":"get_γq(value::MarconatoMachine) -> Float64\n\n\nGet MarconatoMachine γq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_T_AA!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_T_AA!","text":"set_T_AA!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine T_AA.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γd!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_γd!","text":"set_γd!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine γd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γq!-Tuple{MarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_γq!","text":"set_γq!(value::MarconatoMachine, val) -> Any\n\n\nSet MarconatoMachine γq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#OneDOneQMachine","page":"Machine","title":"OneDOneQMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/OneDOneQMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.OneDOneQMachine","page":"Machine","title":"PowerSystems.OneDOneQMachine","text":"mutable struct OneDOneQMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Td0_p::Float64\n Tq0_p::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage\n\nn_states::Int: (Do not modify.) OneDOneQMachine has 2 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::OneDOneQMachine) -> Float64\n\n\nGet OneDOneQMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::OneDOneQMachine) -> Dict{String, Any}\n\n\nGet OneDOneQMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::OneDOneQMachine) -> Int64\n\n\nGet OneDOneQMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{OneDOneQMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::OneDOneQMachine) -> Vector{Symbol}\n\n\nGet OneDOneQMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{OneDOneQMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::OneDOneQMachine, val) -> Any\n\n\nSet OneDOneQMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#RoundRotorExponential","page":"Machine","title":"RoundRotorExponential","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/RoundRotorExponential.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.RoundRotorExponential","page":"Machine","title":"PowerSystems.RoundRotorExponential","text":"mutable struct RoundRotorExponential <: Machine\n base_machine::RoundRotorMachine\n saturation_coeffs::Tuple{Float64, Float64}\n\n4-states round-rotor synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROE model in PSSE and PSLF.\n\nArguments\n\nbase_machine::RoundRotorMachine: Round Rotor Machine model.\nsaturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for exponential model.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#RoundRotorMachine","page":"Machine","title":"RoundRotorMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/RoundRotorMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.RoundRotorMachine","page":"Machine","title":"PowerSystems.RoundRotorMachine","text":"mutable struct RoundRotorMachine <: Machine\n R::Float64\n Td0_p::Float64\n Td0_pp::Float64\n Tq0_p::Float64\n Tq0_pp::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xl::Float64\n Se::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n γ_d1::Float64\n γ_q1::Float64\n γ_d2::Float64\n γ_q2::Float64\n γ_qd::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Armature resistance, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit. Note: Xdpp = Xqpp, validation range: (0, nothing)\nXl::Float64: Stator leakage reactance, validation range: (0, nothing)\nSe::Tuple{Float64, Float64}: Saturation factor at 1 and 1.2 pu flux: S(1.0) = B(|ψ_pp|-A)^2\next::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.\nγ_d1::Float64: (Do not modify.) γ_d1 parameter\nγ_q1::Float64: (Do not modify.) γ_q1 parameter\nγ_d2::Float64: (Do not modify.) γ_d2 parameter\nγ_q2::Float64: (Do not modify.) γ_q2 parameter\nγ_qd::Float64: (Do not modify.) γ_qd parameter\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis generator voltage behind the transient reactance,\ned_p: d-axis generator voltage behind the transient reactance,\nψ_kd: flux linkage in the first equivalent damping circuit in the d-axis,\nψ_kq: flux linkage in the first equivalent damping circuit in the d-axis\n\nn_states::Int: (Do not modify.) RoundRotorMachine has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Se-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Se","text":"get_Se(value::RoundRotorMachine) -> Tuple{Float64, Float64}\n\n\nGet RoundRotorMachine Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xl-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xl","text":"get_Xl(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::RoundRotorMachine) -> Dict{String, Any}\n\n\nGet RoundRotorMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::RoundRotorMachine) -> Int64\n\n\nGet RoundRotorMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::RoundRotorMachine) -> Vector{Symbol}\n\n\nGet RoundRotorMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d1-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_d1","text":"get_γ_d1(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d2-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_d2","text":"get_γ_d2(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q1-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_q1","text":"get_γ_q1(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q2-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_q2","text":"get_γ_q2(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_q2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_qd-Tuple{RoundRotorMachine}","page":"Machine","title":"PowerSystems.get_γ_qd","text":"get_γ_qd(value::RoundRotorMachine) -> Float64\n\n\nGet RoundRotorMachine γ_qd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Se!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Se!","text":"set_Se!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xl!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xl!","text":"set_Xl!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d1!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d1!","text":"set_γ_d1!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d2!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d2!","text":"set_γ_d2!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q1!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q1!","text":"set_γ_q1!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q2!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q2!","text":"set_γ_q2!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_q2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_qd!-Tuple{RoundRotorMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_qd!","text":"set_γ_qd!(value::RoundRotorMachine, val) -> Any\n\n\nSet RoundRotorMachine γ_qd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#RoundRotorQuadratic","page":"Machine","title":"RoundRotorQuadratic","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/RoundRotorQuadratic.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.RoundRotorQuadratic","page":"Machine","title":"PowerSystems.RoundRotorQuadratic","text":"mutable struct RoundRotorQuadratic <: Machine\n base_machine::RoundRotorMachine\n saturation_coeffs::Tuple{Float64, Float64}\n\n4-states round-rotor synchronous machine with quadratic saturation: IEEE Std 1110 §5.3.2 (Model 2.2). GENROU model in PSSE and PSLF.\n\nArguments\n\nbase_machine::RoundRotorMachine: Round Rotor Machine model.\nsaturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for quadratic model.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#SalientPoleExponential","page":"Machine","title":"SalientPoleExponential","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SalientPoleExponential.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SalientPoleExponential","page":"Machine","title":"PowerSystems.SalientPoleExponential","text":"mutable struct SalientPoleExponential <: Machine\n base_machine::SalientPoleMachine\n saturation_coeffs::Tuple{Float64, Float64}\n\n3-states salient-pole synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.1). GENSAE in PSSE and PSLF.\n\nArguments:\n\nbase_machine::SalientPoleMachine: Salient Pole Machine model.\nsaturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for exponential model.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#SalientPoleMachine","page":"Machine","title":"SalientPoleMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SalientPoleMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SalientPoleMachine","page":"Machine","title":"PowerSystems.SalientPoleMachine","text":"mutable struct SalientPoleMachine <: Machine\n R::Float64\n Td0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xd_pp::Float64\n Xl::Float64\n Se::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n γ_d1::Float64\n γ_q1::Float64\n γ_d2::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Armature resistance, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit. Note: Xdpp = Xqpp, validation range: (0, nothing)\nXl::Float64: Stator leakage reactance, validation range: (0, nothing)\nSe::Tuple{Float64, Float64}: Saturation factor at 1 and 1.2 pu flux: Se(eqp) = B(eqp-A)^2\next::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.\nγ_d1::Float64: (Do not modify.) γ_d1 parameter\nγ_q1::Float64: (Do not modify.) γ_q1 parameter\nγ_d2::Float64: (Do not modify.) γ_d2 parameter\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis generator voltage behind the transient reactance,\nψ_kd: flux linkage in the first equivalent damping circuit in the d-axis,\nψq_pp: phasonf of the subtransient flux linkage in the q-axis\n\nn_states::Int: (Do not modify.) SalientPoleMachine has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Se-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Se","text":"get_Se(value::SalientPoleMachine) -> Tuple{Float64, Float64}\n\n\nGet SalientPoleMachine Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xl-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xl","text":"get_Xl(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SalientPoleMachine) -> Dict{String, Any}\n\n\nGet SalientPoleMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SalientPoleMachine) -> Int64\n\n\nGet SalientPoleMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SalientPoleMachine) -> Vector{Symbol}\n\n\nGet SalientPoleMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d1-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_γ_d1","text":"get_γ_d1(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d2-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_γ_d2","text":"get_γ_d2(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q1-Tuple{SalientPoleMachine}","page":"Machine","title":"PowerSystems.get_γ_q1","text":"get_γ_q1(value::SalientPoleMachine) -> Float64\n\n\nGet SalientPoleMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Se!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Se!","text":"set_Se!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xl!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xl!","text":"set_Xl!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d1!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d1!","text":"set_γ_d1!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d2!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d2!","text":"set_γ_d2!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q1!-Tuple{SalientPoleMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q1!","text":"set_γ_q1!(value::SalientPoleMachine, val) -> Any\n\n\nSet SalientPoleMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#SalientPoleQuadratic","page":"Machine","title":"SalientPoleQuadratic","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SalientPoleQuadratic.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SalientPoleQuadratic","page":"Machine","title":"PowerSystems.SalientPoleQuadratic","text":"mutable struct SalientPoleQuadratic <: Machine\n base_machine::SalientPoleMachine\n saturation_coeffs::Tuple{Float64, Float64}\n\n3-states salient-pole synchronous machine with exponential saturation: IEEE Std 1110 §5.3.2 (Model 2.1). GENSAL in PSSE and PSLF.\n\nArguments:\n\nbase_machine::SalientPoleMachine: Salient Pole Machine model.\nsaturation_coeffs::Tuple{Float64, Float64}`: Saturation coefficients for quadratic model.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#SauerPaiMachine","page":"Machine","title":"SauerPaiMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SauerPaiMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SauerPaiMachine","page":"Machine","title":"PowerSystems.SauerPaiMachine","text":"mutable struct SauerPaiMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Xl::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n ext::Dict{String, Any}\n γ_d1::Float64\n γ_q1::Float64\n γ_d2::Float64\n γ_q2::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of synchronous machine: Sauer Pai model\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXl::Float64: Stator Leakage Reactance, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\next::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.\nγ_d1::Float64: (Do not modify.) Internal equation\nγ_q1::Float64: (Do not modify.) Internal equation\nγ_d2::Float64: (Do not modify.) Internal equation\nγ_q2::Float64: (Do not modify.) Internal equation\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψq: q-axis stator flux,\nψd: d-axis stator flux,\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage\nψd_pp: subtransient flux linkage in the d-axis\nψq_pp: subtransient flux linkage in the q-axis\n\nn_states::Int: (Do not modify.) SauerPaiMachine has 6 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xl-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xl","text":"get_Xl(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SauerPaiMachine) -> Dict{String, Any}\n\n\nGet SauerPaiMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SauerPaiMachine) -> Int64\n\n\nGet SauerPaiMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SauerPaiMachine) -> Vector{Symbol}\n\n\nGet SauerPaiMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d1-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_γ_d1","text":"get_γ_d1(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_d2-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_γ_d2","text":"get_γ_d2(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q1-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_γ_q1","text":"get_γ_q1(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γ_q2-Tuple{SauerPaiMachine}","page":"Machine","title":"PowerSystems.get_γ_q2","text":"get_γ_q2(value::SauerPaiMachine) -> Float64\n\n\nGet SauerPaiMachine γ_q2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xl!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xl!","text":"set_Xl!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d1!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d1!","text":"set_γ_d1!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine γ_d1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_d2!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_d2!","text":"set_γ_d2!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine γ_d2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q1!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q1!","text":"set_γ_q1!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine γ_q1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γ_q2!-Tuple{SauerPaiMachine, Any}","page":"Machine","title":"PowerSystems.set_γ_q2!","text":"set_γ_q2!(value::SauerPaiMachine, val) -> Any\n\n\nSet SauerPaiMachine γ_q2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#SimpleAFMachine","page":"Machine","title":"SimpleAFMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SimpleAFMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SimpleAFMachine","page":"Machine","title":"PowerSystems.SimpleAFMachine","text":"mutable struct SimpleAFMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage,\neq_pp: q-axis subtransient voltage,\ned_pp: d-axis subtransient voltage\n\nn_states::Int: (Do not modify.) SimpleAFMachine has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::SimpleAFMachine) -> Float64\n\n\nGet SimpleAFMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SimpleAFMachine) -> Dict{String, Any}\n\n\nGet SimpleAFMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SimpleAFMachine) -> Int64\n\n\nGet SimpleAFMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SimpleAFMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SimpleAFMachine) -> Vector{Symbol}\n\n\nGet SimpleAFMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SimpleAFMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SimpleAFMachine, val) -> Any\n\n\nSet SimpleAFMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#SimpleFullMachine","page":"Machine","title":"SimpleFullMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SimpleFullMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SimpleFullMachine","page":"Machine","title":"PowerSystems.SimpleFullMachine","text":"mutable struct SimpleFullMachine <: Machine\n R::Float64\n R_f::Float64\n R_1d::Float64\n R_1q::Float64\n L_d::Float64\n L_q::Float64\n L_ad::Float64\n L_aq::Float64\n L_f1d::Float64\n L_ff::Float64\n L_1d::Float64\n L_1q::Float64\n ext::Dict{String, Any}\n inv_d_fluxlink::Array{Float64,2}\n inv_q_fluxlink::Array{Float64,2}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameter 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nR_f::Float64: Field rotor winding resistance in per unit, validation range: (0, nothing)\nR_1d::Float64: Damping rotor winding resistance on d-axis in per unit. This value is denoted as RD in Machowski, validation range: (0, nothing)\nR_1q::Float64: Damping rotor winding resistance on q-axis in per unit. This value is denoted as RQ in Machowski, validation range: (0, nothing)\nL_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)\nL_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)\nL_ad::Float64: Mutual inductance between stator winding and rotor field (and damping) winding inductance on d-axis, in per unit, validation range: (0, nothing)\nL_aq::Float64: Mutual inductance between stator winding and rotor damping winding inductance on q-axis, in per unit, validation range: (0, nothing)\nL_f1d::Float64: Mutual inductance between rotor field winding and rotor damping winding inductance on d-axis, in per unit, validation range: (0, nothing)\nL_ff::Float64: Field rotor winding inductance, in per unit, validation range: (0, nothing)\nL_1d::Float64: Inductance of the d-axis rotor damping circuit, in per unit, validation range: (0, nothing)\nL_1q::Float64: Inductance of the q-axis rotor damping circuit, in per unit, validation range: (0, nothing)\next::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.\ninv_d_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.127, 3.130, 3.131 From Kundur\ninv_q_fluxlink::Array{Float64,2}: (Do not modify.) Equations 3.128, 3.132 From Kundur\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψf: field rotor flux,\nψ1d: d-axis rotor damping flux,\nψ1q: q-axis rotor damping flux\n\nn_states::Int: (Do not modify.) SimpleFullMachine has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_1d-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_1d","text":"get_L_1d(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_1q-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_1q","text":"get_L_1q(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_ad-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_ad","text":"get_L_ad(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_aq-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_aq","text":"get_L_aq(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_d-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_d","text":"get_L_d(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_f1d-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_f1d","text":"get_L_f1d(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_f1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_ff-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_ff","text":"get_L_ff(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_L_q-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_L_q","text":"get_L_q(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine L_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_1d-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_R_1d","text":"get_R_1d(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine R_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_1q-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_R_1q","text":"get_R_1q(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine R_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_R_f-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_R_f","text":"get_R_f(value::SimpleFullMachine) -> Float64\n\n\nGet SimpleFullMachine R_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SimpleFullMachine) -> Dict{String, Any}\n\n\nGet SimpleFullMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_inv_d_fluxlink-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_inv_d_fluxlink","text":"get_inv_d_fluxlink(\n value::SimpleFullMachine\n) -> Matrix{Float64}\n\n\nGet SimpleFullMachine inv_d_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_inv_q_fluxlink-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_inv_q_fluxlink","text":"get_inv_q_fluxlink(\n value::SimpleFullMachine\n) -> Matrix{Float64}\n\n\nGet SimpleFullMachine inv_q_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SimpleFullMachine) -> Int64\n\n\nGet SimpleFullMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SimpleFullMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SimpleFullMachine) -> Vector{Symbol}\n\n\nGet SimpleFullMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_1d!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_1d!","text":"set_L_1d!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_1q!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_1q!","text":"set_L_1q!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_ad!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_ad!","text":"set_L_ad!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_aq!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_aq!","text":"set_L_aq!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_d!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_d!","text":"set_L_d!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_f1d!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_f1d!","text":"set_L_f1d!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_f1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_ff!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_ff!","text":"set_L_ff!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_L_q!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_L_q!","text":"set_L_q!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine L_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_1d!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_1d!","text":"set_R_1d!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine R_1d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_1q!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_1q!","text":"set_R_1q!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine R_1q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R_f!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_R_f!","text":"set_R_f!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine R_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_inv_d_fluxlink!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_inv_d_fluxlink!","text":"set_inv_d_fluxlink!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine inv_d_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_inv_q_fluxlink!-Tuple{SimpleFullMachine, Any}","page":"Machine","title":"PowerSystems.set_inv_q_fluxlink!","text":"set_inv_q_fluxlink!(value::SimpleFullMachine, val) -> Any\n\n\nSet SimpleFullMachine inv_q_fluxlink.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#SimpleMarconatoMachine","page":"Machine","title":"SimpleMarconatoMachine","text":"","category":"section"},{"location":"model_library/generated_Machine/","page":"Machine","title":"Machine","text":"Modules = [PowerSystems]\nPages = [\"/SimpleMarconatoMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Machine/#PowerSystems.SimpleMarconatoMachine","page":"Machine","title":"PowerSystems.SimpleMarconatoMachine","text":"mutable struct SimpleMarconatoMachine <: Machine\n R::Float64\n Xd::Float64\n Xq::Float64\n Xd_p::Float64\n Xq_p::Float64\n Xd_pp::Float64\n Xq_pp::Float64\n Td0_p::Float64\n Tq0_p::Float64\n Td0_pp::Float64\n Tq0_pp::Float64\n T_AA::Float64\n ext::Dict{String, Any}\n γd::Float64\n γq::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters 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\n\nArguments\n\nR::Float64: Resistance after EMF in machine per unit, validation range: (0, nothing)\nXd::Float64: Reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq::Float64: Reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_p::Float64: Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_p::Float64: Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nXd_pp::Float64: Sub-Transient reactance after EMF in d-axis per unit, validation range: (0, nothing)\nXq_pp::Float64: Sub-Transient reactance after EMF in q-axis per unit, validation range: (0, nothing)\nTd0_p::Float64: Time constant of transient d-axis voltage, validation range: (0, nothing)\nTq0_p::Float64: Time constant of transient q-axis voltage, validation range: (0, nothing)\nTd0_pp::Float64: Time constant of sub-transient d-axis voltage, validation range: (0, nothing)\nTq0_pp::Float64: Time constant of sub-transient q-axis voltage, validation range: (0, nothing)\nT_AA::Float64: Time constant of d-axis additional leakage, validation range: (0, nothing)\next::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.\nγd::Float64: (Do not modify.) Internal equation\nγq::Float64: (Do not modify.) Internal equation\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\neq_p: q-axis transient voltage,\ned_p: d-axis transient voltage,\neq_pp: q-axis subtransient voltage,\ned_pp: d-axis subtransient voltage\n\nn_states::Int: (Do not modify.) SimpleMarconatoMachine has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Machine/#PowerSystems.get_R-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_R","text":"get_R(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_T_AA-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_T_AA","text":"get_T_AA(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine T_AA.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_p-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Td0_p","text":"get_Td0_p(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Td0_pp-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Td0_pp","text":"get_Td0_pp(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_p-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Tq0_p","text":"get_Tq0_p(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Tq0_pp-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Tq0_pp","text":"get_Tq0_pp(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd","text":"get_Xd(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_p-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd_p","text":"get_Xd_p(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xd_pp-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xd_pp","text":"get_Xd_pp(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq","text":"get_Xq(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_p-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq_p","text":"get_Xq_p(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_Xq_pp-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_Xq_pp","text":"get_Xq_pp(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_ext-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_ext","text":"get_ext(value::SimpleMarconatoMachine) -> Dict{String, Any}\n\n\nGet SimpleMarconatoMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_n_states-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SimpleMarconatoMachine) -> Int64\n\n\nGet SimpleMarconatoMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_states-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_states","text":"get_states(value::SimpleMarconatoMachine) -> Vector{Symbol}\n\n\nGet SimpleMarconatoMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γd-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_γd","text":"get_γd(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine γd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.get_γq-Tuple{SimpleMarconatoMachine}","page":"Machine","title":"PowerSystems.get_γq","text":"get_γq(value::SimpleMarconatoMachine) -> Float64\n\n\nGet SimpleMarconatoMachine γq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_R!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_R!","text":"set_R!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_T_AA!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_T_AA!","text":"set_T_AA!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine T_AA.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_p!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_p!","text":"set_Td0_p!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Td0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Td0_pp!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Td0_pp!","text":"set_Td0_pp!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Td0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_p!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_p!","text":"set_Tq0_p!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Tq0_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Tq0_pp!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Tq0_pp!","text":"set_Tq0_pp!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Tq0_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd!","text":"set_Xd!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_p!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_p!","text":"set_Xd_p!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xd_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xd_pp!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xd_pp!","text":"set_Xd_pp!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xd_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq!","text":"set_Xq!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_p!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_p!","text":"set_Xq_p!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xq_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_Xq_pp!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_Xq_pp!","text":"set_Xq_pp!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine Xq_pp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_ext!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γd!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_γd!","text":"set_γd!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine γd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Machine/#PowerSystems.set_γq!-Tuple{SimpleMarconatoMachine, Any}","page":"Machine","title":"PowerSystems.set_γq!","text":"set_γq!(value::SimpleMarconatoMachine, val) -> Any\n\n\nSet SimpleMarconatoMachine γq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hydro_generation_cost/#HydroGenerationCost","page":"HydroGenerationCost","title":"HydroGenerationCost","text":"","category":"section"},{"location":"model_library/hydro_generation_cost/","page":"HydroGenerationCost","title":"HydroGenerationCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/HydroGenerationCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/hydro_generation_cost/#PowerSystems.HydroGenerationCost","page":"HydroGenerationCost","title":"PowerSystems.HydroGenerationCost","text":"mutable struct HydroGenerationCost <: OperationalCost\n\nvariable::ProductionVariableCostCurve: Production variable cost represented by a FuelCurve, where the fuel is water, or a CostCurve in currency.\nfixed::Float64: (default: 0) Fixed cost of keeping the unit online. For some cost represenations this field can be duplicative\n\nHydroGenerationCost(variable, fixed)\nHydroGenerationCost(; variable, fixed)\n\nAn 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. \n\nThe variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.\n\n\n\n\n\n","category":"type"},{"location":"model_library/hydro_generation_cost/#PowerSystems.get_fixed-Tuple{HydroGenerationCost}","page":"HydroGenerationCost","title":"PowerSystems.get_fixed","text":"get_fixed(value::HydroGenerationCost) -> Float64\n\n\nGet HydroGenerationCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hydro_generation_cost/#PowerSystems.get_variable-Tuple{HydroGenerationCost}","page":"HydroGenerationCost","title":"PowerSystems.get_variable","text":"get_variable(\n value::HydroGenerationCost\n) -> ProductionVariableCostCurve\n\n\nGet HydroGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hydro_generation_cost/#PowerSystems.set_fixed!-Tuple{HydroGenerationCost, Any}","page":"HydroGenerationCost","title":"PowerSystems.set_fixed!","text":"set_fixed!(value::HydroGenerationCost, val) -> Any\n\n\nSet HydroGenerationCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hydro_generation_cost/#PowerSystems.set_variable!-Tuple{HydroGenerationCost, Any}","page":"HydroGenerationCost","title":"PowerSystems.set_variable!","text":"set_variable!(value::HydroGenerationCost, val) -> Any\n\n\nSet HydroGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"explanation/type_structure/#type_structure","page":"Type Structure","title":"Type Structure","text":"","category":"section"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"PowerSystems.jl provides a type hierarchy to contain power system data.","category":"page"},{"location":"explanation/type_structure/#Types-in-PowerSystems","page":"Type Structure","title":"Types in PowerSystems","text":"","category":"section"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"In PowerSystems.jl, data that describes infrastructure components is held in structs. For example, an ACBus is a struct with the following parameters to describe a bus on an AC network:","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"using PowerSystems #hide\nimport TypeTree: tt #hide\ndocs_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"utils\"); #hide\ninclude(joinpath(docs_dir, \"docs_utils.jl\")); #hide\nprint_struct(ACBus) #hide","category":"page"},{"location":"explanation/type_structure/#Type-Hierarchy","page":"Type Structure","title":"Type Hierarchy","text":"","category":"section"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"PowerSystems is intended to organize data by the behavior of the devices that the data represents. A type hierarchy has been defined with several levels of abstract types starting with InfrastructureSystemsType. There are a bunch of subtypes of InfrastructureSystemsType, but the important ones to know about are:","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"System: overarching struct that collects all of the Components\nComponent: includes all elements of power system data\nTopology: includes non physical elements describing network connectivity\nService: includes descriptions of system requirements (other than energy balance)\nDevice: includes descriptions of all the physical devices in a power system\nInfrastructureSystems.DeviceParameter: includes structs that hold data describing the dynamic, or economic capabilities of Device.\nTimeSeriesData: Includes all time series types\nForecast: includes structs to define time series of forecasted data where multiple values can represent each time stamp\nStaticTimeSeries: includes structs to define time series with a single value for each time stamp","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"The abstract hierarchy enables categorization of the devices by their operational characteristics and modeling requirements.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"For instance, generation is classified by the distinctive data requirements for modeling in three categories: ThermalGen, RenewableGen, and HydroGen.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"PowerSystems.jl has a category Topology of topological components (e.g., ACBus, Arc), separate from the physical components.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"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.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"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.","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"","category":"page"},{"location":"explanation/type_structure/","page":"Type Structure","title":"Type Structure","text":"⠀ ```","category":"page"},{"location":"model_library/generated_ConstantReserveNonSpinning/#ConstantReserveNonSpinning","page":"ConstantReserveNonSpinning","title":"ConstantReserveNonSpinning","text":"","category":"section"},{"location":"model_library/generated_ConstantReserveNonSpinning/","page":"ConstantReserveNonSpinning","title":"ConstantReserveNonSpinning","text":"Modules = [PowerSystems]\nPages = [\"generated/ConstantReserveNonSpinning.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.ConstantReserveNonSpinning","page":"ConstantReserveNonSpinning","title":"PowerSystems.ConstantReserveNonSpinning","text":"mutable struct ConstantReserveNonSpinning <: ReserveNonSpinning\n name::String\n available::Bool\n time_frame::Float64\n requirement::Float64\n sustained_time::Float64\n max_output_fraction::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA non-spinning reserve product with a constant procurement requirement, such as 3% of the system base power at all times.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time frame in minutes that a participating device must provide its reserve contribution, validation range: (0, nothing)\nrequirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)\nsustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ConstantReserveNonSpinning/#InfrastructureSystems.get_name-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"InfrastructureSystems.get_name","text":"get_name(value::ConstantReserveNonSpinning) -> String\n\n\nGet ConstantReserveNonSpinning name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_available-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_available","text":"get_available(value::ConstantReserveNonSpinning) -> Bool\n\n\nGet ConstantReserveNonSpinning available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_deployed_fraction-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(\n value::ConstantReserveNonSpinning\n) -> Float64\n\n\nGet ConstantReserveNonSpinning deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_ext-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_ext","text":"get_ext(\n value::ConstantReserveNonSpinning\n) -> Dict{String, Any}\n\n\nGet ConstantReserveNonSpinning ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_max_output_fraction-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_max_output_fraction","text":"get_max_output_fraction(\n value::ConstantReserveNonSpinning\n) -> Float64\n\n\nGet ConstantReserveNonSpinning max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_max_participation_factor-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::ConstantReserveNonSpinning\n) -> Float64\n\n\nGet ConstantReserveNonSpinning max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_requirement-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_requirement","text":"get_requirement(value::ConstantReserveNonSpinning) -> Any\n\n\nGet ConstantReserveNonSpinning requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_sustained_time-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(\n value::ConstantReserveNonSpinning\n) -> Float64\n\n\nGet ConstantReserveNonSpinning sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.get_time_frame-Tuple{ConstantReserveNonSpinning}","page":"ConstantReserveNonSpinning","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::ConstantReserveNonSpinning) -> Float64\n\n\nGet ConstantReserveNonSpinning time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_available!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_available!","text":"set_available!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_deployed_fraction!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_ext!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_ext!","text":"set_ext!(value::ConstantReserveNonSpinning, val) -> Any\n\n\nSet ConstantReserveNonSpinning ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_max_output_fraction!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_max_output_fraction!","text":"set_max_output_fraction!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_max_participation_factor!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_requirement!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_requirement!","text":"set_requirement!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_sustained_time!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ConstantReserveNonSpinning/#PowerSystems.set_time_frame!-Tuple{ConstantReserveNonSpinning, Any}","page":"ConstantReserveNonSpinning","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(\n value::ConstantReserveNonSpinning,\n val\n) -> Any\n\n\nSet ConstantReserveNonSpinning time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSS","page":"PSS","title":"PSS","text":"","category":"section"},{"location":"model_library/generated_PSS/#IEEEST","page":"PSS","title":"IEEEST","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/IEEEST.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.IEEEST","page":"PSS","title":"PowerSystems.IEEEST","text":"mutable struct IEEEST <: PSS\n input_code::Int\n remote_bus_control::Int\n A1::Float64\n A2::Float64\n A3::Float64\n A4::Float64\n A5::Float64\n A6::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n T5::Float64\n T6::Float64\n Ks::Float64\n Ls_lim::Tuple{Float64, Float64}\n Vcu::Float64\n Vcl::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Stabilizing Model PSS. \n\nArguments\n\ninput_code::Int: Code input for stabilizer, validation range: (1, 6)\nremote_bus_control::Int: ACBus identification number for control. 0 identifies the bus connected to this component\nA1::Float64: Filter coefficient, validation range: (0, nothing)\nA2::Float64: Filter coefficient, validation range: (0, nothing)\nA3::Float64: Filter coefficient, validation range: (0, nothing)\nA4::Float64: Filter coefficient, validation range: (0, nothing)\nA5::Float64: Filter coefficient, validation range: (0, nothing)\nA6::Float64: Filter coefficient, validation range: (0, nothing)\nT1::Float64: Time constant, validation range: (0, 10)\nT2::Float64: Time constant, validation range: (0, 10)\nT3::Float64: Time constant, validation range: (0, 10)\nT4::Float64: Time constant, validation range: (0, 10)\nT5::Float64: Time constant, validation range: (0, 10)\nT6::Float64: Time constant, validation range: (eps(), 2.0)\nKs::Float64: Proportional gain, validation range: (0, nothing)\nLs_lim::Tuple{Float64, Float64}: PSS output limits for regulator output (Ls_min, Ls_max)\nVcu::Float64: Cutoff limiter upper bound, validation range: (0, 1.25)\nVcl::Float64: Cutoff limiter lower bound, validation range: (0, 1.0)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: 1st filter integration,\nx_p2: 2nd filter integration, \nx_p3: 3rd filter integration, \nx_p4: 4rd filter integration, \nx_p5: T1/T2 lead-lag integrator, \nx_p6: T3/T4 lead-lag integrator, \n:x_p7 last integer,\n\nn_states::Int: (Do not modify.) IEEEST has 7 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEST has 7 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_A1-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A1","text":"get_A1(value::IEEEST) -> Float64\n\n\nGet IEEEST A1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A2-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A2","text":"get_A2(value::IEEEST) -> Float64\n\n\nGet IEEEST A2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A3-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A3","text":"get_A3(value::IEEEST) -> Float64\n\n\nGet IEEEST A3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A4-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A4","text":"get_A4(value::IEEEST) -> Float64\n\n\nGet IEEEST A4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A5-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A5","text":"get_A5(value::IEEEST) -> Float64\n\n\nGet IEEEST A5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_A6-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_A6","text":"get_A6(value::IEEEST) -> Float64\n\n\nGet IEEEST A6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_Ks","text":"get_Ks(value::IEEEST) -> Float64\n\n\nGet IEEEST Ks.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ls_lim-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_Ls_lim","text":"get_Ls_lim(value::IEEEST) -> Tuple{Float64, Float64}\n\n\nGet IEEEST Ls_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T1","text":"get_T1(value::IEEEST) -> Float64\n\n\nGet IEEEST T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T2","text":"get_T2(value::IEEEST) -> Float64\n\n\nGet IEEEST T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::IEEEST) -> Float64\n\n\nGet IEEEST T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::IEEEST) -> Float64\n\n\nGet IEEEST T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T5-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T5","text":"get_T5(value::IEEEST) -> Float64\n\n\nGet IEEEST T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T6-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_T6","text":"get_T6(value::IEEEST) -> Float64\n\n\nGet IEEEST T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vcl-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_Vcl","text":"get_Vcl(value::IEEEST) -> Float64\n\n\nGet IEEEST Vcl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vcu-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_Vcu","text":"get_Vcu(value::IEEEST) -> Float64\n\n\nGet IEEEST Vcu.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::IEEEST) -> Dict{String, Any}\n\n\nGet IEEEST ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_input_code","text":"get_input_code(value::IEEEST) -> Int64\n\n\nGet IEEEST input_code.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::IEEEST) -> Int64\n\n\nGet IEEEST n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_remote_bus_control","text":"get_remote_bus_control(value::IEEEST) -> Int64\n\n\nGet IEEEST remote_bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::IEEEST) -> Vector{Symbol}\n\n\nGet IEEEST states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{IEEEST}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::IEEEST) -> Vector{StateTypes}\n\n\nGet IEEEST states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A1!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A1!","text":"set_A1!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A2!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A2!","text":"set_A2!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A3!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A3!","text":"set_A3!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A4!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A4!","text":"set_A4!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A5!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A5!","text":"set_A5!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_A6!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_A6!","text":"set_A6!(value::IEEEST, val) -> Any\n\n\nSet IEEEST A6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_Ks!","text":"set_Ks!(value::IEEEST, val) -> Any\n\n\nSet IEEEST Ks.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ls_lim!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_Ls_lim!","text":"set_Ls_lim!(value::IEEEST, val) -> Any\n\n\nSet IEEEST Ls_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T1!","text":"set_T1!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T2!","text":"set_T2!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T5!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T5!","text":"set_T5!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T6!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_T6!","text":"set_T6!(value::IEEEST, val) -> Any\n\n\nSet IEEEST T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vcl!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_Vcl!","text":"set_Vcl!(value::IEEEST, val) -> Any\n\n\nSet IEEEST Vcl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vcu!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_Vcu!","text":"set_Vcu!(value::IEEEST, val) -> Any\n\n\nSet IEEEST Vcu.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::IEEEST, val) -> Any\n\n\nSet IEEEST ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_input_code!","text":"set_input_code!(value::IEEEST, val) -> Any\n\n\nSet IEEEST input_code.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control!","text":"set_remote_bus_control!(value::IEEEST, val) -> Any\n\n\nSet IEEEST remote_bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{IEEEST, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::IEEEST, val) -> Any\n\n\nSet IEEEST states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSS2A","page":"PSS","title":"PSS2A","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSS2A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSS2A","page":"PSS","title":"PowerSystems.PSS2A","text":"mutable struct PSS2A <: PSS\n input_code_1::Int\n remote_bus_control_1::Int\n input_code_2::Int\n remote_bus_control_2::Int\n M_rtf::Int\n N_rtf::Int\n Tw1::Float64\n Tw2::Float64\n T6::Float64\n Tw3::Float64\n Tw4::Float64\n T7::Float64\n Ks2::Float64\n Ks3::Float64\n T8::Float64\n T9::Float64\n Ks1::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n Vst_lim::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Dual-Input Stabilizer Model\n\nArguments\n\ninput_code_1::Int: First Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_1::Int: First Input remote bus identification number for control. 0 identifies the local bus connected to this component\ninput_code_2::Int: Second Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_2::Int: Second Input remote bus identification number for control. 0 identifies the local bus connected to this component\nM_rtf::Int: M parameter for ramp tracking filter, validation range: (0, 8)\nN_rtf::Int: N parameter for ramp tracking filter, validation range: (0, 8)\nTw1::Float64: Time constant for first washout filter for first input, validation range: (eps(), nothing)\nTw2::Float64: Time constant for second washout filter for first input, validation range: (0, nothing)\nT6::Float64: Time constant for low-pass filter for first input, validation range: (0, nothing)\nTw3::Float64: Time constant for first washout filter for second input, validation range: (eps(), nothing)\nTw4::Float64: Time constant for second washout filter for second input, validation range: (0, nothing)\nT7::Float64: Time constant for low-pass filter for second input, validation range: (0, nothing)\nKs2::Float64: Gain for low-pass filter for second input, validation range: (0, nothing)\nKs3::Float64: Gain for second input, validation range: (0, nothing)\nT8::Float64: Time constant for ramp tracking filter, validation range: (0, nothing)\nT9::Float64: Time constant for ramp tracking filter, validation range: (eps(), nothing)\nKs1::Float64: Gain before lead-lag blocks, validation range: (0, nothing)\nT1::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT2::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT3::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT4::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nVst_lim::Tuple{Float64, Float64}: PSS output limits (Vst_min, Vst_max)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: 1st washout 1st input, \nx_p2: 2nd washout 1st input, \nx_p3: transducer 1st input, \nx_p4: 1st washout 2nd input, \nx_p5: 2nd washout 2nd input, \nx_p6: transducer 2nd input, \nx_p7: ramp tracking filter state 1, \nx_p8: ramp tracking filter state 2, \nx_p9: ramp tracking filter state 3, \nx_p10: ramp tracking filter state 4, \nx_p11: ramp tracking filter state 5, \nx_p12: ramp tracking filter state 6, \nx_p13: ramp tracking filter state 7, \nx_p14: ramp tracking filter state 8, \nx_p15: 1st lead-lag, \nx_p16: 2nd lead-lag,\n\nn_states::Int: (Do not modify.) IEEEST has 16 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEST has 16 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Ks1","text":"get_Ks1(value::PSS2A) -> Float64\n\n\nGet PSS2A Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Ks2","text":"get_Ks2(value::PSS2A) -> Float64\n\n\nGet PSS2A Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks3-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Ks3","text":"get_Ks3(value::PSS2A) -> Float64\n\n\nGet PSS2A Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_M_rtf-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_M_rtf","text":"get_M_rtf(value::PSS2A) -> Int64\n\n\nGet PSS2A M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_N_rtf-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_N_rtf","text":"get_N_rtf(value::PSS2A) -> Int64\n\n\nGet PSS2A N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T1","text":"get_T1(value::PSS2A) -> Float64\n\n\nGet PSS2A T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T2","text":"get_T2(value::PSS2A) -> Float64\n\n\nGet PSS2A T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::PSS2A) -> Float64\n\n\nGet PSS2A T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::PSS2A) -> Float64\n\n\nGet PSS2A T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T6-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T6","text":"get_T6(value::PSS2A) -> Float64\n\n\nGet PSS2A T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T7-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T7","text":"get_T7(value::PSS2A) -> Float64\n\n\nGet PSS2A T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T8-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T8","text":"get_T8(value::PSS2A) -> Float64\n\n\nGet PSS2A T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T9-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_T9","text":"get_T9(value::PSS2A) -> Float64\n\n\nGet PSS2A T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Tw1","text":"get_Tw1(value::PSS2A) -> Float64\n\n\nGet PSS2A Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Tw2","text":"get_Tw2(value::PSS2A) -> Float64\n\n\nGet PSS2A Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw3-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Tw3","text":"get_Tw3(value::PSS2A) -> Float64\n\n\nGet PSS2A Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw4-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Tw4","text":"get_Tw4(value::PSS2A) -> Float64\n\n\nGet PSS2A Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vst_lim-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_Vst_lim","text":"get_Vst_lim(value::PSS2A) -> Tuple{Float64, Float64}\n\n\nGet PSS2A Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSS2A) -> Dict{String, Any}\n\n\nGet PSS2A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_input_code_1","text":"get_input_code_1(value::PSS2A) -> Int64\n\n\nGet PSS2A input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_input_code_2","text":"get_input_code_2(value::PSS2A) -> Int64\n\n\nGet PSS2A input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSS2A) -> Int64\n\n\nGet PSS2A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_1-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_remote_bus_control_1","text":"get_remote_bus_control_1(value::PSS2A) -> Int64\n\n\nGet PSS2A remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_2-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_remote_bus_control_2","text":"get_remote_bus_control_2(value::PSS2A) -> Int64\n\n\nGet PSS2A remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSS2A) -> Vector{Symbol}\n\n\nGet PSS2A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{PSS2A}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::PSS2A) -> Vector{StateTypes}\n\n\nGet PSS2A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Ks1!","text":"set_Ks1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Ks2!","text":"set_Ks2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks3!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Ks3!","text":"set_Ks3!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_M_rtf!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_M_rtf!","text":"set_M_rtf!(value::PSS2A, val) -> Any\n\n\nSet PSS2A M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_N_rtf!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_N_rtf!","text":"set_N_rtf!(value::PSS2A, val) -> Any\n\n\nSet PSS2A N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T1!","text":"set_T1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T2!","text":"set_T2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T6!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T6!","text":"set_T6!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T7!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T7!","text":"set_T7!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T8!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T8!","text":"set_T8!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T9!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_T9!","text":"set_T9!(value::PSS2A, val) -> Any\n\n\nSet PSS2A T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Tw1!","text":"set_Tw1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Tw2!","text":"set_Tw2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw3!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Tw3!","text":"set_Tw3!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw4!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Tw4!","text":"set_Tw4!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vst_lim!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_Vst_lim!","text":"set_Vst_lim!(value::PSS2A, val) -> Any\n\n\nSet PSS2A Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSS2A, val) -> Any\n\n\nSet PSS2A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_input_code_1!","text":"set_input_code_1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_input_code_2!","text":"set_input_code_2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_1!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_1!","text":"set_remote_bus_control_1!(value::PSS2A, val) -> Any\n\n\nSet PSS2A remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_2!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_2!","text":"set_remote_bus_control_2!(value::PSS2A, val) -> Any\n\n\nSet PSS2A remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{PSS2A, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::PSS2A, val) -> Any\n\n\nSet PSS2A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSS2B","page":"PSS","title":"PSS2B","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSS2B.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSS2B","page":"PSS","title":"PowerSystems.PSS2B","text":"mutable struct PSS2B <: PSS\n input_code_1::Int\n remote_bus_control_1::Int\n input_code_2::Int\n remote_bus_control_2::Int\n M_rtf::Int\n N_rtf::Int\n Tw1::Float64\n Tw2::Float64\n T6::Float64\n Tw3::Float64\n Tw4::Float64\n T7::Float64\n Ks2::Float64\n Ks3::Float64\n T8::Float64\n T9::Float64\n Ks1::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n T10::Float64\n T11::Float64\n Vs1_lim::Tuple{Float64, Float64}\n Vs2_lim::Tuple{Float64, Float64}\n Vst_lim::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE 421.5 2005 PSS2B IEEE Dual-Input Stabilizer Model\n\nArguments\n\ninput_code_1::Int: First Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_1::Int: First Input remote bus identification number for control. 0 identifies the local bus connected to this component\ninput_code_2::Int: Second Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_2::Int: Second Input remote bus identification number for control. 0 identifies the local bus connected to this component\nM_rtf::Int: M parameter for ramp tracking filter, validation range: (0, 8)\nN_rtf::Int: N parameter for ramp tracking filter, validation range: (0, 8)\nTw1::Float64: Time constant for first washout filter for first input, validation range: (eps(), nothing)\nTw2::Float64: Time constant for second washout filter for first input, validation range: (0, nothing)\nT6::Float64: Time constant for low-pass filter for first input, validation range: (0, nothing)\nTw3::Float64: Time constant for first washout filter for second input, validation range: (eps(), nothing)\nTw4::Float64: Time constant for second washout filter for second input, validation range: (0, nothing)\nT7::Float64: Time constant for low-pass filter for second input, validation range: (0, nothing)\nKs2::Float64: Gain for low-pass filter for second input, validation range: (0, nothing)\nKs3::Float64: Gain for second input, validation range: (0, nothing)\nT8::Float64: Time constant for ramp tracking filter, validation range: (0, nothing)\nT9::Float64: Time constant for ramp tracking filter, validation range: (eps(), nothing)\nKs1::Float64: Gain before lead-lag blocks, validation range: (0, nothing)\nT1::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT2::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT3::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT4::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT10::Float64: Time constant for third lead-lag block, validation range: (0, nothing)\nT11::Float64: Time constant for third lead-lag block, validation range: (0, nothing)\nVs1_lim::Tuple{Float64, Float64}: First input limits (Vs1_min, Vs1_max)\nVs2_lim::Tuple{Float64, Float64}: Second input limits (Vs2_min, Vs2_max)\nVst_lim::Tuple{Float64, Float64}: PSS output limits (Vst_min, Vst_max)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: 1st washout 1st input, \nx_p2: 2nd washout 1st input, \nx_p3: transducer 1st input, \nx_p4: 1st washout 2nd input, \nx_p5: 2nd washout 2nd input, \nx_p6: transducer 2nd input, \nx_p7: ramp tracking filter state 1, \nx_p8: ramp tracking filter state 2, \nx_p9: ramp tracking filter state 3, \nx_p10: ramp tracking filter state 4, \nx_p11: ramp tracking filter state 5, \nx_p12: ramp tracking filter state 6, \nx_p13: ramp tracking filter state 7, \nx_p14: ramp tracking filter state 8, \nx_p15: 1st lead-lag, \nx_p16: 2nd lead-lag, \nx_p17: 3rd lead-lag,\n\nn_states::Int: (Do not modify.) IEEEST has 17 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEST has 17 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Ks1","text":"get_Ks1(value::PSS2B) -> Float64\n\n\nGet PSS2B Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Ks2","text":"get_Ks2(value::PSS2B) -> Float64\n\n\nGet PSS2B Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks3-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Ks3","text":"get_Ks3(value::PSS2B) -> Float64\n\n\nGet PSS2B Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_M_rtf-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_M_rtf","text":"get_M_rtf(value::PSS2B) -> Int64\n\n\nGet PSS2B M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_N_rtf-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_N_rtf","text":"get_N_rtf(value::PSS2B) -> Int64\n\n\nGet PSS2B N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T1","text":"get_T1(value::PSS2B) -> Float64\n\n\nGet PSS2B T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T10-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T10","text":"get_T10(value::PSS2B) -> Float64\n\n\nGet PSS2B T10.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T11-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T11","text":"get_T11(value::PSS2B) -> Float64\n\n\nGet PSS2B T11.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T2","text":"get_T2(value::PSS2B) -> Float64\n\n\nGet PSS2B T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::PSS2B) -> Float64\n\n\nGet PSS2B T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::PSS2B) -> Float64\n\n\nGet PSS2B T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T6-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T6","text":"get_T6(value::PSS2B) -> Float64\n\n\nGet PSS2B T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T7-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T7","text":"get_T7(value::PSS2B) -> Float64\n\n\nGet PSS2B T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T8-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T8","text":"get_T8(value::PSS2B) -> Float64\n\n\nGet PSS2B T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T9-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_T9","text":"get_T9(value::PSS2B) -> Float64\n\n\nGet PSS2B T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Tw1","text":"get_Tw1(value::PSS2B) -> Float64\n\n\nGet PSS2B Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Tw2","text":"get_Tw2(value::PSS2B) -> Float64\n\n\nGet PSS2B Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw3-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Tw3","text":"get_Tw3(value::PSS2B) -> Float64\n\n\nGet PSS2B Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw4-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Tw4","text":"get_Tw4(value::PSS2B) -> Float64\n\n\nGet PSS2B Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vs1_lim-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Vs1_lim","text":"get_Vs1_lim(value::PSS2B) -> Tuple{Float64, Float64}\n\n\nGet PSS2B Vs1_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vs2_lim-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Vs2_lim","text":"get_Vs2_lim(value::PSS2B) -> Tuple{Float64, Float64}\n\n\nGet PSS2B Vs2_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vst_lim-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_Vst_lim","text":"get_Vst_lim(value::PSS2B) -> Tuple{Float64, Float64}\n\n\nGet PSS2B Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSS2B) -> Dict{String, Any}\n\n\nGet PSS2B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_input_code_1","text":"get_input_code_1(value::PSS2B) -> Int64\n\n\nGet PSS2B input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_input_code_2","text":"get_input_code_2(value::PSS2B) -> Int64\n\n\nGet PSS2B input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSS2B) -> Int64\n\n\nGet PSS2B n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_1-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_remote_bus_control_1","text":"get_remote_bus_control_1(value::PSS2B) -> Int64\n\n\nGet PSS2B remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_2-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_remote_bus_control_2","text":"get_remote_bus_control_2(value::PSS2B) -> Int64\n\n\nGet PSS2B remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSS2B) -> Vector{Symbol}\n\n\nGet PSS2B states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{PSS2B}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::PSS2B) -> Vector{StateTypes}\n\n\nGet PSS2B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Ks1!","text":"set_Ks1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Ks2!","text":"set_Ks2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks3!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Ks3!","text":"set_Ks3!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_M_rtf!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_M_rtf!","text":"set_M_rtf!(value::PSS2B, val) -> Any\n\n\nSet PSS2B M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_N_rtf!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_N_rtf!","text":"set_N_rtf!(value::PSS2B, val) -> Any\n\n\nSet PSS2B N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T1!","text":"set_T1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T10!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T10!","text":"set_T10!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T10.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T11!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T11!","text":"set_T11!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T11.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T2!","text":"set_T2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T6!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T6!","text":"set_T6!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T7!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T7!","text":"set_T7!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T8!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T8!","text":"set_T8!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T9!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_T9!","text":"set_T9!(value::PSS2B, val) -> Any\n\n\nSet PSS2B T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Tw1!","text":"set_Tw1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Tw2!","text":"set_Tw2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw3!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Tw3!","text":"set_Tw3!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw4!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Tw4!","text":"set_Tw4!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vs1_lim!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Vs1_lim!","text":"set_Vs1_lim!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Vs1_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vs2_lim!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Vs2_lim!","text":"set_Vs2_lim!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Vs2_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vst_lim!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_Vst_lim!","text":"set_Vst_lim!(value::PSS2B, val) -> Any\n\n\nSet PSS2B Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSS2B, val) -> Any\n\n\nSet PSS2B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_input_code_1!","text":"set_input_code_1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_input_code_2!","text":"set_input_code_2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_1!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_1!","text":"set_remote_bus_control_1!(value::PSS2B, val) -> Any\n\n\nSet PSS2B remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_2!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_2!","text":"set_remote_bus_control_2!(value::PSS2B, val) -> Any\n\n\nSet PSS2B remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{PSS2B, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::PSS2B, val) -> Any\n\n\nSet PSS2B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSS2C","page":"PSS","title":"PSS2C","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSS2C.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSS2C","page":"PSS","title":"PowerSystems.PSS2C","text":"mutable struct PSS2C <: PSS\n input_code_1::Int\n remote_bus_control_1::Int\n input_code_2::Int\n remote_bus_control_2::Int\n M_rtf::Int\n N_rtf::Int\n Tw1::Float64\n Tw2::Float64\n T6::Float64\n Tw3::Float64\n Tw4::Float64\n T7::Float64\n Ks2::Float64\n Ks3::Float64\n T8::Float64\n T9::Float64\n Ks1::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n T10::Float64\n T11::Float64\n Vs1_lim::Tuple{Float64, Float64}\n Vs2_lim::Tuple{Float64, Float64}\n Vst_lim::Tuple{Float64, Float64}\n T12::Float64\n T13::Float64\n PSS_Hysteresis_param::Tuple{Float64, Float64}\n Xcomp::Float64\n Tcomp::Float64\n hysteresis_binary_logic::Int\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE 421.5 2016 PSS2C IEEE Dual-Input Stabilizer Model\n\nArguments\n\ninput_code_1::Int: First Input Code for stabilizer, validation range: (1, 7)\nremote_bus_control_1::Int: First Input remote bus identification number for control. 0 identifies the local bus connected to this component\ninput_code_2::Int: Second Input Code for stabilizer, validation range: (1, 6)\nremote_bus_control_2::Int: Second Input remote bus identification number for control. 0 identifies the local bus connected to this component\nM_rtf::Int: M parameter for ramp tracking filter, validation range: (0, 8)\nN_rtf::Int: N parameter for ramp tracking filter, validation range: (0, 8)\nTw1::Float64: Time constant for first washout filter for first input, validation range: (eps(), nothing)\nTw2::Float64: Time constant for second washout filter for first input, validation range: (0, nothing)\nT6::Float64: Time constant for low-pass filter for first input, validation range: (0, nothing)\nTw3::Float64: Time constant for first washout filter for second input, validation range: (eps(), nothing)\nTw4::Float64: Time constant for second washout filter for second input, validation range: (0, nothing)\nT7::Float64: Time constant for low-pass filter for second input, validation range: (0, nothing)\nKs2::Float64: Gain for low-pass filter for second input, validation range: (0, nothing)\nKs3::Float64: Gain for second input, validation range: (0, nothing)\nT8::Float64: Time constant for ramp tracking filter, validation range: (0, nothing)\nT9::Float64: Time constant for ramp tracking filter, validation range: (eps(), nothing)\nKs1::Float64: Gain before lead-lag blocks, validation range: (0, nothing)\nT1::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT2::Float64: Time constant for first lead-lag block, validation range: (0, nothing)\nT3::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT4::Float64: Time constant for second lead-lag block, validation range: (0, nothing)\nT10::Float64: Time constant for third lead-lag block, validation range: (0, nothing)\nT11::Float64: Time constant for third lead-lag block, validation range: (0, nothing)\nVs1_lim::Tuple{Float64, Float64}: First input limits (Vs1_min, Vs1_max)\nVs2_lim::Tuple{Float64, Float64}: Second input limits (Vs2_min, Vs2_max)\nVst_lim::Tuple{Float64, Float64}: PSS output limits (Vst_min, Vst_max)\nT12::Float64: Time constant for fourth lead-lag block, validation range: (0, nothing)\nT13::Float64: Time constant for fourth lead-lag block, validation range: (0, nothing)\nPSS_Hysteresis_param::Tuple{Float64, Float64}: PSS output hysteresis parameters (PSSOFF, PSSON)\nXcomp::Float64: Stator Leakage Reactance, validation range: (0, nothing)\nTcomp::Float64: Time measured with compensated frequency, validation range: (eps(), nothing)\nhysteresis_binary_logic::Int: (default: 1) Hysteresis memory variable\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: 1st washout 1st input, \nx_p2: 2nd washout 1st input, \nx_p3: transducer 1st input, \nx_p4: 1st washout 2nd input, \nx_p5: 2nd washout 2nd input, \nx_p6: transducer 2nd input, \nx_p7: ramp tracking filter state 1, \nx_p8: ramp tracking filter state 2, \nx_p9: ramp tracking filter state 3, \nx_p10: ramp tracking filter state 4, \nx_p11: ramp tracking filter state 5, \nx_p12: ramp tracking filter state 6, \nx_p13: ramp tracking filter state 7, \nx_p14: ramp tracking filter state 8, \nx_p15: 1st lead-lag, \nx_p16: 2nd lead-lag, \nx_p17: 3rd lead-lag, \nx_p18: 4th lead-lag, \nx_p19: washout block for compensated frequency,\n\nn_states::Int: (Do not modify.) IEEEST has 19 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEST has 19 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Ks1","text":"get_Ks1(value::PSS2C) -> Float64\n\n\nGet PSS2C Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Ks2","text":"get_Ks2(value::PSS2C) -> Float64\n\n\nGet PSS2C Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Ks3-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Ks3","text":"get_Ks3(value::PSS2C) -> Float64\n\n\nGet PSS2C Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_M_rtf-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_M_rtf","text":"get_M_rtf(value::PSS2C) -> Int64\n\n\nGet PSS2C M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_N_rtf-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_N_rtf","text":"get_N_rtf(value::PSS2C) -> Int64\n\n\nGet PSS2C N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_PSS_Hysteresis_param-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_PSS_Hysteresis_param","text":"get_PSS_Hysteresis_param(\n value::PSS2C\n) -> Tuple{Float64, Float64}\n\n\nGet PSS2C PSS_Hysteresis_param.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T1","text":"get_T1(value::PSS2C) -> Float64\n\n\nGet PSS2C T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T10-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T10","text":"get_T10(value::PSS2C) -> Float64\n\n\nGet PSS2C T10.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T11-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T11","text":"get_T11(value::PSS2C) -> Float64\n\n\nGet PSS2C T11.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T12-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T12","text":"get_T12(value::PSS2C) -> Float64\n\n\nGet PSS2C T12.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T13-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T13","text":"get_T13(value::PSS2C) -> Float64\n\n\nGet PSS2C T13.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T2","text":"get_T2(value::PSS2C) -> Float64\n\n\nGet PSS2C T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::PSS2C) -> Float64\n\n\nGet PSS2C T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::PSS2C) -> Float64\n\n\nGet PSS2C T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T6-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T6","text":"get_T6(value::PSS2C) -> Float64\n\n\nGet PSS2C T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T7-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T7","text":"get_T7(value::PSS2C) -> Float64\n\n\nGet PSS2C T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T8-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T8","text":"get_T8(value::PSS2C) -> Float64\n\n\nGet PSS2C T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T9-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_T9","text":"get_T9(value::PSS2C) -> Float64\n\n\nGet PSS2C T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tcomp-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tcomp","text":"get_Tcomp(value::PSS2C) -> Float64\n\n\nGet PSS2C Tcomp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tw1","text":"get_Tw1(value::PSS2C) -> Float64\n\n\nGet PSS2C Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tw2","text":"get_Tw2(value::PSS2C) -> Float64\n\n\nGet PSS2C Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw3-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tw3","text":"get_Tw3(value::PSS2C) -> Float64\n\n\nGet PSS2C Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Tw4-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Tw4","text":"get_Tw4(value::PSS2C) -> Float64\n\n\nGet PSS2C Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vs1_lim-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Vs1_lim","text":"get_Vs1_lim(value::PSS2C) -> Tuple{Float64, Float64}\n\n\nGet PSS2C Vs1_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vs2_lim-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Vs2_lim","text":"get_Vs2_lim(value::PSS2C) -> Tuple{Float64, Float64}\n\n\nGet PSS2C Vs2_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Vst_lim-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Vst_lim","text":"get_Vst_lim(value::PSS2C) -> Tuple{Float64, Float64}\n\n\nGet PSS2C Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_Xcomp-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_Xcomp","text":"get_Xcomp(value::PSS2C) -> Float64\n\n\nGet PSS2C Xcomp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSS2C) -> Dict{String, Any}\n\n\nGet PSS2C ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_hysteresis_binary_logic-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_hysteresis_binary_logic","text":"get_hysteresis_binary_logic(value::PSS2C) -> Int64\n\n\nGet PSS2C hysteresis_binary_logic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_input_code_1","text":"get_input_code_1(value::PSS2C) -> Int64\n\n\nGet PSS2C input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_input_code_2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_input_code_2","text":"get_input_code_2(value::PSS2C) -> Int64\n\n\nGet PSS2C input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSS2C) -> Int64\n\n\nGet PSS2C n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_1-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_remote_bus_control_1","text":"get_remote_bus_control_1(value::PSS2C) -> Int64\n\n\nGet PSS2C remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_remote_bus_control_2-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_remote_bus_control_2","text":"get_remote_bus_control_2(value::PSS2C) -> Int64\n\n\nGet PSS2C remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSS2C) -> Vector{Symbol}\n\n\nGet PSS2C states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{PSS2C}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::PSS2C) -> Vector{StateTypes}\n\n\nGet PSS2C states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Ks1!","text":"set_Ks1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Ks1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Ks2!","text":"set_Ks2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Ks2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Ks3!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Ks3!","text":"set_Ks3!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Ks3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_M_rtf!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_M_rtf!","text":"set_M_rtf!(value::PSS2C, val) -> Any\n\n\nSet PSS2C M_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_N_rtf!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_N_rtf!","text":"set_N_rtf!(value::PSS2C, val) -> Any\n\n\nSet PSS2C N_rtf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_PSS_Hysteresis_param!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_PSS_Hysteresis_param!","text":"set_PSS_Hysteresis_param!(value::PSS2C, val) -> Any\n\n\nSet PSS2C PSS_Hysteresis_param.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T1!","text":"set_T1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T10!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T10!","text":"set_T10!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T10.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T11!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T11!","text":"set_T11!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T11.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T12!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T12!","text":"set_T12!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T12.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T13!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T13!","text":"set_T13!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T13.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T2!","text":"set_T2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T6!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T6!","text":"set_T6!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T7!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T7!","text":"set_T7!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T8!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T8!","text":"set_T8!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T9!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_T9!","text":"set_T9!(value::PSS2C, val) -> Any\n\n\nSet PSS2C T9.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tcomp!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tcomp!","text":"set_Tcomp!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tcomp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tw1!","text":"set_Tw1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tw1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tw2!","text":"set_Tw2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tw2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw3!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tw3!","text":"set_Tw3!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tw3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Tw4!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Tw4!","text":"set_Tw4!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Tw4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vs1_lim!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Vs1_lim!","text":"set_Vs1_lim!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Vs1_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vs2_lim!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Vs2_lim!","text":"set_Vs2_lim!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Vs2_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Vst_lim!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Vst_lim!","text":"set_Vst_lim!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Vst_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_Xcomp!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_Xcomp!","text":"set_Xcomp!(value::PSS2C, val) -> Any\n\n\nSet PSS2C Xcomp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSS2C, val) -> Any\n\n\nSet PSS2C ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_hysteresis_binary_logic!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_hysteresis_binary_logic!","text":"set_hysteresis_binary_logic!(value::PSS2C, val) -> Any\n\n\nSet PSS2C hysteresis_binary_logic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_input_code_1!","text":"set_input_code_1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C input_code_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_input_code_2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_input_code_2!","text":"set_input_code_2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C input_code_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_1!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_1!","text":"set_remote_bus_control_1!(value::PSS2C, val) -> Any\n\n\nSet PSS2C remote_bus_control_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_remote_bus_control_2!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_remote_bus_control_2!","text":"set_remote_bus_control_2!(value::PSS2C, val) -> Any\n\n\nSet PSS2C remote_bus_control_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{PSS2C, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::PSS2C, val) -> Any\n\n\nSet PSS2C states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSSFixed","page":"PSS","title":"PSSFixed","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSSFixed.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSSFixed","page":"PSS","title":"PowerSystems.PSSFixed","text":"mutable struct PSSFixed <: PSS\n V_pss::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a PSS that returns a fixed voltage to add to the reference for the AVR\n\nArguments\n\nV_pss::Float64: Fixed voltage stabilization signal in pu (DEVICE_BASE), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) PSSFixed has no states\nn_states::Int: (Do not modify.) PSSFixed has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_V_pss-Tuple{PSSFixed}","page":"PSS","title":"PowerSystems.get_V_pss","text":"get_V_pss(value::PSSFixed) -> Float64\n\n\nGet PSSFixed V_pss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSSFixed}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSSFixed) -> Dict{String, Any}\n\n\nGet PSSFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSSFixed}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSSFixed) -> Int64\n\n\nGet PSSFixed n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSSFixed}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSSFixed) -> Vector{Symbol}\n\n\nGet PSSFixed states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_V_pss!-Tuple{PSSFixed, Any}","page":"PSS","title":"PowerSystems.set_V_pss!","text":"set_V_pss!(value::PSSFixed, val) -> Any\n\n\nSet PSSFixed V_pss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSSFixed, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSSFixed, val) -> Any\n\n\nSet PSSFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PSSSimple","page":"PSS","title":"PSSSimple","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/PSSSimple.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.PSSSimple","page":"PSS","title":"PowerSystems.PSSSimple","text":"mutable struct PSSSimple <: PSS\n K_ω::Float64\n K_p::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a PSS that returns a proportional droop voltage to add to the reference for the AVR\n\nArguments\n\nK_ω::Float64: Proportional gain for frequency, validation range: (0, nothing)\nK_p::Float64: Proportional gain for active power, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) PSSSimple has no states\nn_states::Int: (Do not modify.) PSSSimple has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_K_p-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_K_p","text":"get_K_p(value::PSSSimple) -> Float64\n\n\nGet PSSSimple K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_K_ω-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_K_ω","text":"get_K_ω(value::PSSSimple) -> Float64\n\n\nGet PSSSimple K_ω.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::PSSSimple) -> Dict{String, Any}\n\n\nGet PSSSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::PSSSimple) -> Int64\n\n\nGet PSSSimple n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{PSSSimple}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::PSSSimple) -> Vector{Symbol}\n\n\nGet PSSSimple states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_K_p!-Tuple{PSSSimple, Any}","page":"PSS","title":"PowerSystems.set_K_p!","text":"set_K_p!(value::PSSSimple, val) -> Any\n\n\nSet PSSSimple K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_K_ω!-Tuple{PSSSimple, Any}","page":"PSS","title":"PowerSystems.set_K_ω!","text":"set_K_ω!(value::PSSSimple, val) -> Any\n\n\nSet PSSSimple K_ω.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{PSSSimple, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::PSSSimple, val) -> Any\n\n\nSet PSSSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#STAB1","page":"PSS","title":"STAB1","text":"","category":"section"},{"location":"model_library/generated_PSS/","page":"PSS","title":"PSS","text":"Modules = [PowerSystems]\nPages = [\"/STAB1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PSS/#PowerSystems.STAB1","page":"PSS","title":"PowerSystems.STAB1","text":"mutable struct STAB1 <: PSS\n KT::Float64\n T::Float64\n T1T3::Float64\n T3::Float64\n T2T4::Float64\n T4::Float64\n H_lim::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nSpeed-Sensitive Stabilizing Model\n\nArguments\n\nKT::Float64: K/T for washout filter, validation range: (0, nothing)\nT::Float64: Time constant for washout filter, validation range: (0.01, nothing)\nT1T3::Float64: Time constant division T1/T3, validation range: (0, nothing)\nT3::Float64: Time constant, validation range: (0.01, nothing)\nT2T4::Float64: Time constant division T2/T4, validation range: (0, nothing)\nT4::Float64: Time constant, validation range: (0.01, nothing)\nH_lim::Float64: PSS output limit, validation range: (0, 0.5)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p1: washout filter,\nx_p2: T1/T3 lead-lag block, \nx_p3: T2/T4 lead-lag block,\n\nn_states::Int: (Do not modify.) STAB1 has 3 states\nstates_types::Vector{StateTypes}: (Do not modify.) STAB1 has 3 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PSS/#PowerSystems.get_H_lim-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_H_lim","text":"get_H_lim(value::STAB1) -> Float64\n\n\nGet STAB1 H_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_KT-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_KT","text":"get_KT(value::STAB1) -> Float64\n\n\nGet STAB1 KT.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T","text":"get_T(value::STAB1) -> Float64\n\n\nGet STAB1 T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T1T3-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T1T3","text":"get_T1T3(value::STAB1) -> Float64\n\n\nGet STAB1 T1T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T2T4-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T2T4","text":"get_T2T4(value::STAB1) -> Float64\n\n\nGet STAB1 T2T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T3-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T3","text":"get_T3(value::STAB1) -> Float64\n\n\nGet STAB1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_T4-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_T4","text":"get_T4(value::STAB1) -> Float64\n\n\nGet STAB1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_ext-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_ext","text":"get_ext(value::STAB1) -> Dict{String, Any}\n\n\nGet STAB1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_n_states-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_n_states","text":"get_n_states(value::STAB1) -> Int64\n\n\nGet STAB1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_states","text":"get_states(value::STAB1) -> Vector{Symbol}\n\n\nGet STAB1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.get_states_types-Tuple{STAB1}","page":"PSS","title":"PowerSystems.get_states_types","text":"get_states_types(value::STAB1) -> Vector{StateTypes}\n\n\nGet STAB1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_H_lim!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_H_lim!","text":"set_H_lim!(value::STAB1, val) -> Any\n\n\nSet STAB1 H_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_KT!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_KT!","text":"set_KT!(value::STAB1, val) -> Any\n\n\nSet STAB1 KT.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T!","text":"set_T!(value::STAB1, val) -> Any\n\n\nSet STAB1 T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T1T3!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T1T3!","text":"set_T1T3!(value::STAB1, val) -> Any\n\n\nSet STAB1 T1T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T2T4!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T2T4!","text":"set_T2T4!(value::STAB1, val) -> Any\n\n\nSet STAB1 T2T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T3!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T3!","text":"set_T3!(value::STAB1, val) -> Any\n\n\nSet STAB1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_T4!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_T4!","text":"set_T4!(value::STAB1, val) -> Any\n\n\nSet STAB1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_ext!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_ext!","text":"set_ext!(value::STAB1, val) -> Any\n\n\nSet STAB1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PSS/#PowerSystems.set_states_types!-Tuple{STAB1, Any}","page":"PSS","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::STAB1, val) -> Any\n\n\nSet STAB1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#TwoTerminalHVDCLine","page":"TwoTerminalHVDCLine","title":"TwoTerminalHVDCLine","text":"","category":"section"},{"location":"model_library/generated_TwoTerminalHVDCLine/","page":"TwoTerminalHVDCLine","title":"TwoTerminalHVDCLine","text":"Modules = [PowerSystems]\nPages = [\"generated/TwoTerminalHVDCLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.TwoTerminalHVDCLine","page":"TwoTerminalHVDCLine","title":"PowerSystems.TwoTerminalHVDCLine","text":"mutable struct TwoTerminalHVDCLine <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n arc::Arc\n active_power_limits_from::MinMax\n active_power_limits_to::MinMax\n reactive_power_limits_from::MinMax\n reactive_power_limits_to::MinMax\n loss::Union{LinearCurve, PiecewiseIncrementalCurve}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA High Voltage DC line, which must be connected to an ACBus on each end.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\narc::Arc: An Arc defining this line from a bus to another bus\nactive_power_limits_from::MinMax: Minimum and maximum active power flows to the FROM node (MW)\nactive_power_limits_to::MinMax: Minimum and maximum active power flows to the TO node (MW)\nreactive_power_limits_from::MinMax: Minimum and maximum reactive power limits to the FROM node (MVAR)\nreactive_power_limits_to::MinMax: Minimum and maximum reactive power limits to the TO node (MVAR)\nloss::Union{LinearCurve, PiecewiseIncrementalCurve}: (default: LinearCurve(0.0)) Loss model coefficients. It accepts a linear model with a constant loss (MW) and a proportional loss rate (MW of loss per MW of flow). It also accepts a Piecewise loss, with N segments to specify different proportional losses for different segments.\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TwoTerminalHVDCLine/#InfrastructureSystems.get_name-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"InfrastructureSystems.get_name","text":"get_name(value::TwoTerminalHVDCLine) -> String\n\n\nGet TwoTerminalHVDCLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_active_power_flow-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::TwoTerminalHVDCLine) -> Any\n\n\nGet TwoTerminalHVDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_active_power_limits_from-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_active_power_limits_from","text":"get_active_power_limits_from(\n value::TwoTerminalHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_active_power_limits_to-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_active_power_limits_to","text":"get_active_power_limits_to(\n value::TwoTerminalHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_arc-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_arc","text":"get_arc(value::TwoTerminalHVDCLine) -> Arc\n\n\nGet TwoTerminalHVDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_available-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_available","text":"get_available(value::TwoTerminalHVDCLine) -> Bool\n\n\nGet TwoTerminalHVDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_ext-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_ext","text":"get_ext(value::TwoTerminalHVDCLine) -> Dict{String, Any}\n\n\nGet TwoTerminalHVDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_loss-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_loss","text":"get_loss(\n value::TwoTerminalHVDCLine\n) -> Union{LinearCurve, PiecewiseIncrementalCurve}\n\n\nGet TwoTerminalHVDCLine loss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_reactive_power_limits_from-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_reactive_power_limits_from","text":"get_reactive_power_limits_from(\n value::TwoTerminalHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCLine reactive_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_reactive_power_limits_to-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_reactive_power_limits_to","text":"get_reactive_power_limits_to(\n value::TwoTerminalHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCLine reactive_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.get_services-Tuple{TwoTerminalHVDCLine}","page":"TwoTerminalHVDCLine","title":"PowerSystems.get_services","text":"get_services(value::TwoTerminalHVDCLine) -> Vector{Service}\n\n\nGet TwoTerminalHVDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_active_power_flow!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_active_power_limits_from!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_active_power_limits_from!","text":"set_active_power_limits_from!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_active_power_limits_to!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_active_power_limits_to!","text":"set_active_power_limits_to!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_arc!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_available!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_available!","text":"set_available!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_ext!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_loss!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_loss!","text":"set_loss!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine loss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_reactive_power_limits_from!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_reactive_power_limits_from!","text":"set_reactive_power_limits_from!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine reactive_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_reactive_power_limits_to!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_reactive_power_limits_to!","text":"set_reactive_power_limits_to!(\n value::TwoTerminalHVDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCLine reactive_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCLine/#PowerSystems.set_services!-Tuple{TwoTerminalHVDCLine, Any}","page":"TwoTerminalHVDCLine","title":"PowerSystems.set_services!","text":"set_services!(value::TwoTerminalHVDCLine, val) -> Any\n\n\nSet TwoTerminalHVDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"api/developer_guidelines/#Developer-Guidelines","page":"Developer Guidelines","title":"Developer Guidelines","text":"","category":"section"},{"location":"api/developer_guidelines/","page":"Developer Guidelines","title":"Developer Guidelines","text":"In order to contribute to PowerSystems.jl repository please read the following sections of InfrastructureSystems.jl documentation in detail:","category":"page"},{"location":"api/developer_guidelines/","page":"Developer Guidelines","title":"Developer Guidelines","text":"Style Guide\nContributing Guidelines","category":"page"},{"location":"api/developer_guidelines/","page":"Developer Guidelines","title":"Developer Guidelines","text":"Pull requests are always welcome to fix bugs or add additional modeling capabilities.","category":"page"},{"location":"api/developer_guidelines/","page":"Developer Guidelines","title":"Developer Guidelines","text":"All the code contributions need to include tests with a minimum coverage of 70%","category":"page"},{"location":"tutorials/creating_system/#Create-and-Explore-a-Power-System","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Welcome to PowerSystems.jl!","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"In this tutorial, we will create a power system and add some components to it, including some nodes, a transmission line, load, and both renewable and fossil fuel generators. Then we will retrieve data from the system and explore the system settings.","category":"page"},{"location":"tutorials/creating_system/#Setup","page":"Create and Explore a Power System","title":"Setup","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"To get started, ensure you have followed the installation instructions.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Start Julia from the command line if you haven't already:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"$ julia","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Load the PowerSystems.jl package:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"using PowerSystems","category":"page"},{"location":"tutorials/creating_system/#Creating-a-Power-System","page":"Create and Explore a Power System","title":"Creating a Power System","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"In PowerSystems.jl, data is held in a System that holds all of the individual components along with some metadata about the power system itself.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"There are many ways to define a System, but let's start with an empty system. All we need to define is a base power of 100 MVA for per-unitization.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys = System(100.0)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that this system is a 60 Hz system with a base power of 100 MVA.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now, let's add some components to our system.","category":"page"},{"location":"tutorials/creating_system/#Adding-Buses","page":"Create and Explore a Power System","title":"Adding Buses","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We'll start by creating some buses. By referring to the documentation for ACBus, notice that we need define some basic data, including the bus's unique identifier and name, base voltage, and whether it's a load, generator, or reference bus.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's start with a reference bus:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"bus1 = ACBus(;\n number = 1,\n name = \"bus1\",\n bustype = ACBusTypes.REF,\n angle = 0.0,\n magnitude = 1.0,\n voltage_limits = (min = 0.9, max = 1.05),\n base_voltage = 230.0,\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"This bus is on a 230 kV AC transmission network, with an allowable voltage range of 0.9 to 1.05 p.u. We are assuming it is currently operating at 1.0 p.u. voltage and an angle of 0 radians.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's add this bus to our System with add_component!:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_component!(sys, bus1)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We can see the impact this has on the System simply by printing it:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that System now shows a summary of components in the system.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's create a second bus:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"bus2 = ACBus(;\n number = 2,\n name = \"bus2\",\n bustype = ACBusTypes.PV,\n angle = 0.0,\n magnitude = 1.0,\n voltage_limits = (min = 0.9, max = 1.05),\n base_voltage = 230.0,\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that we've defined this bus with power and voltage variables, suitable for power flow studies.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's also add this to our System:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_component!(sys, bus2)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now, let's use show_components to quickly see some basic information about the buses:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"show_components(sys, ACBus)","category":"page"},{"location":"tutorials/creating_system/#Adding-a-Transmission-Line","page":"Create and Explore a Power System","title":"Adding a Transmission Line","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's connect our buses. We'll add a transmission Line between bus1 and bus2.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"warning: Warning\nWhen defining a line that isn't attached to a System yet, you must define the thermal rating of the transmission line in per-unit using the base power of the System you plan to connect it to – in this case, 100 MVA.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"line = Line(;\n name = \"line1\",\n available = true,\n active_power_flow = 0.0,\n reactive_power_flow = 0.0,\n arc = Arc(; from = bus1, to = bus2),\n r = 0.00281, # Per-unit\n x = 0.0281, # Per-unit\n b = (from = 0.00356, to = 0.00356), # Per-unit\n rating = 2.0, # Line rating of 200 MVA / System base of 100 MVA\n angle_limits = (min = -0.7, max = 0.7),\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Note that we also had to define an Arc in the process to define the connection between the two buses.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's also add this to our System:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_component!(sys, line)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Finally, let's check our System summary to see all the network topology components we have added are attached:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys","category":"page"},{"location":"tutorials/creating_system/#Adding-Loads-and-Generators","page":"Create and Explore a Power System","title":"Adding Loads and Generators","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now that our network topology is complete, we'll start adding components that inject or withdraw power from the network.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"warning: Warning\nWhen you define components that aren't attached to a System yet, you must define all fields related to power (with units such as MW, MVA, MVAR, or MW/min) in per-unit using the base_power of the component (with the exception of base_power itself, which is in MVA).","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We'll start with defining a 10 MW load to bus1:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"load = PowerLoad(;\n name = \"load1\",\n available = true,\n bus = bus1,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n base_power = 10.0, # MVA\n max_active_power = 1.0, # 10 MW per-unitized by device base_power\n max_reactive_power = 0.0,\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that we defined the max_active_power, which is 10 MW, as 1.0 in per-unit using the base_power of 10 MVA. We've also used the bus1 component itself to define where this load is located in the network.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now add the load to the system:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_component!(sys, load)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Finally, we'll add two generators: one renewable and one thermal.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We'll add a 5 MW solar power plant to bus2:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"solar = RenewableDispatch(;\n name = \"solar1\",\n available = true,\n bus = bus2,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n rating = 1.0, # 5 MW per-unitized by device base_power\n prime_mover_type = PrimeMovers.PVe,\n reactive_power_limits = (min = 0.0, max = 0.05), # 0 MVAR to 0.25 MVAR per-unitized by device base_power\n power_factor = 1.0,\n operation_cost = RenewableGenerationCost(nothing),\n base_power = 5.0, # MVA\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Note that we've used a generic renewable generator to model solar, but we can specify that it is solar through the prime mover.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Finally, we'll also add a 30 MW gas thermal generator:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"gas = ThermalStandard(;\n name = \"gas1\",\n available = true,\n status = true,\n bus = bus2,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n rating = 1.0, # 30 MW per-unitized by device base_power\n active_power_limits = (min = 0.2, max = 1.0), # 6 MW to 30 MW per-unitized by device base_power\n reactive_power_limits = nothing, # Per-unitized by device base_power\n ramp_limits = (up = 0.2, down = 0.2), # 6 MW/min up or down, per-unitized by device base_power\n operation_cost = ThermalGenerationCost(nothing),\n base_power = 30.0, # MVA\n time_limits = (up = 8.0, down = 8.0), # Hours\n must_run = false,\n prime_mover_type = PrimeMovers.CC,\n fuel = ThermalFuels.NATURAL_GAS,\n);","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"This time, let's add these components to our System using add_components! to add them both at the same time:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"add_components!(sys, [solar, gas])","category":"page"},{"location":"tutorials/creating_system/#Explore-the-System-and-its-Components","page":"Create and Explore a Power System","title":"Explore the System and its Components","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Congratulations! You have built a power system including buses, a transmission line, a load, and different types of generators. Now let's take a look around.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Remember that we can see a summary of our System using the print statement:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now, let's double-check some of our data by retrieving it from the System. Let's use show_components again to get an overview of our renewable generators:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"show_components(sys, RenewableDispatch)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"We just have the one renewable generator named solar1. Use get_component to retrieve it by name:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"retrieved_component = get_component(RenewableDispatch, sys, \"solar1\");","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's double-check what type of renewable generator this is using a get_ function:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_prime_mover_type(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Verify that this a PVe, or solar photovoltaic, generator.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's also use a get_ function to double-check where this generator is connected in the transmission network:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_bus(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"See that the generator's bus is linked to the actual bus2 component in our System.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"These \"getter\" functions are available for all the data fields in a component.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"tip: Tip\nAlways use the get_* functions to retrieve the data within a component. While in Julia a user can use . to access the fields of a component, we make no guarantees on the stability of field names and locations. We do however promise to keep the getter functions stable. PowerSystems.jl also does many internal data calculations that the getter functions will properly handle for you, as you'll see below.","category":"page"},{"location":"tutorials/creating_system/#Changing-System-Per-Unit-Settings","page":"Create and Explore a Power System","title":"Changing System Per-Unit Settings","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now, let's use a getter function to look up the solar generator's rating:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_rating(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"tip: Important\nWhen we defined the solar generator, we defined the rating as 1.0 per-unit with a device base_power of 5.0 MVA. Notice that the rating now reads 0.05. After we attached this component to our System, its power data is being returned to us in the System's units base.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Let's double-check the System's units base:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_units_base(sys)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"SYSTEM_BASE means all power-related (MW, MVA, MVAR, MW/min) component data in the System, except for each component's base_power, is per-unitized by the system base power for consistency.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Check the System's base_power again:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_base_power(sys)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that when we called get_rating above, the solar generator's rating, 5.0 MW, is being returned as 0.05 = (5 MVA)/(100 MVA) using the system base power.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Instead of using the System base power, let's view everything in MW or MVA – or what we call \"NATURAL_UNITS\" in PowerSystems.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Change the System's unit system:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"set_units_base_system!(sys, \"NATURAL_UNITS\")","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Now retrieve the solar generator's rating again:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_rating(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Notice that the value is now its \"natural\" value, 5.0 MVA.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Finally, let's change the System's unit system to the final option, \"DEVICE_BASE\":","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"set_units_base_system!(sys, \"DEVICE_BASE\")","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"And retrieve the solar generator's rating once more:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"get_rating(retrieved_component)","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"See that now the data is now 1.0 (5.0 MVA per-unitized by the generator (i.e., the device's) base_power of 5.0 MVA), which is the format we used to originally define the device.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Recall that if you ever need to check a System's settings, including the unit system being used by all the getter functions, you can always just print the System:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"sys","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"See the units base is printed as one of the System properties.","category":"page"},{"location":"tutorials/creating_system/#Next-Steps","page":"Create and Explore a Power System","title":"Next Steps","text":"","category":"section"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"In this tutorial, you manually created a power System, added and then retrieved its components, and modified the System per-unit settings.","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Next, you might want to:","category":"page"},{"location":"tutorials/creating_system/","page":"Create and Explore a Power System","title":"Create and Explore a Power System","text":"Add time series data to components in the System\nAdd necessary data for dynamic simulations\nImport a System from an existing Matpower or PSSE file or with PSSE dynamic data instead of creating it manually\nCreate your own System from .csv files instead of creating it manually\nRead more to understand per-unitization in PowerSystems.jl\nSee a workaround for how to Add a Component in Natural Units","category":"page"},{"location":"model_library/generated_LoadZone/#LoadZone","page":"LoadZone","title":"LoadZone","text":"","category":"section"},{"location":"model_library/generated_LoadZone/","page":"LoadZone","title":"LoadZone","text":"Modules = [PowerSystems]\nPages = [\"generated/LoadZone.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_LoadZone/#PowerSystems.LoadZone","page":"LoadZone","title":"PowerSystems.LoadZone","text":"mutable struct LoadZone <: AggregationTopology\n name::String\n peak_active_power::Float64\n peak_reactive_power::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA load zone for electricity price analysis.\n\nThe load zone can be specified when defining each ACBus or DCBus in the zone\n\nArguments\n\nname::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\npeak_active_power::Float64: Peak active power in the zone (MW)\npeak_reactive_power::Float64: Peak reactive power in the zone (MVAR)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_LoadZone/#InfrastructureSystems.get_name-Tuple{LoadZone}","page":"LoadZone","title":"InfrastructureSystems.get_name","text":"get_name(value::LoadZone) -> String\n\n\nGet LoadZone name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.get_ext-Tuple{LoadZone}","page":"LoadZone","title":"PowerSystems.get_ext","text":"get_ext(value::LoadZone) -> Dict{String, Any}\n\n\nGet LoadZone ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.get_peak_active_power-Tuple{LoadZone}","page":"LoadZone","title":"PowerSystems.get_peak_active_power","text":"get_peak_active_power(value::LoadZone) -> Any\n\n\nGet LoadZone peak_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.get_peak_reactive_power-Tuple{LoadZone}","page":"LoadZone","title":"PowerSystems.get_peak_reactive_power","text":"get_peak_reactive_power(value::LoadZone) -> Any\n\n\nGet LoadZone peak_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.set_ext!-Tuple{LoadZone, Any}","page":"LoadZone","title":"PowerSystems.set_ext!","text":"set_ext!(value::LoadZone, val) -> Any\n\n\nSet LoadZone ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.set_peak_active_power!-Tuple{LoadZone, Any}","page":"LoadZone","title":"PowerSystems.set_peak_active_power!","text":"set_peak_active_power!(value::LoadZone, val) -> Any\n\n\nSet LoadZone peak_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_LoadZone/#PowerSystems.set_peak_reactive_power!-Tuple{LoadZone, Any}","page":"LoadZone","title":"PowerSystems.set_peak_reactive_power!","text":"set_peak_reactive_power!(value::LoadZone, val) -> Any\n\n\nSet LoadZone peak_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"how_to/add_cost_curve/#cost_how_to","page":"...add an Operating Cost","title":"Adding an Operating Cost","text":"","category":"section"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"This how-to guide covers the steps to select and add an operating cost to a component, such as a generator, load, or energy storage system.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"using PowerSystems #hide","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"To begin, the user must make 2 or 3 decisions before defining the operating cost:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Select an appropriate OperationalCost from the OperationalCost options. In general, each operating cost has parameters to define fixed and variable costs. To be able to define an OperationalCost, you must first select a curve to represent the variable cost(s).\nIf you selected ThermalGenerationCost or HydroGenerationCost, select either a FuelCurve or CostCurve to represent the variable cost, based on the units of the generator's data.\nIf you have data in terms of heat rate or water flow, use FuelCurve.\nIf you have data in units of currency, such as $/MWh, use CostCurve. If you selected another OperationalCost type, the variable cost is represented as a CostCurve.\nSelect a ValueCurve to represent the variable cost data by comparing the format of your variable cost data to the Variable Cost Representations table and the ValueCurve options.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Then, the user defines the cost by working backwards:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Define the variable cost's ValueCurve\nUse the ValueCurve to define the selected CostCurve or FuelCurve\nUse the CostCurve or FuelCurve to define the OperationalCost","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Let's look at a few examples.","category":"page"},{"location":"how_to/add_cost_curve/#Example-1:-A-Renewable-Generator","page":"...add an Operating Cost","title":"Example 1: A Renewable Generator","text":"","category":"section"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"We have a renewable unit that produces at $22/MWh.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Following the decision steps above:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"We select RenewableGenerationCost to represent this renewable generator.\nWe select a LinearCurve to represent the $22/MWh variable cost.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Following the implementation steps, we define RenewableGenerationCost by nesting the definitions:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"RenewableGenerationCost(; variable = CostCurve(; value_curve = LinearCurve(22.0)))","category":"page"},{"location":"how_to/add_cost_curve/#Example-2:-A-Thermal-Generator","page":"...add an Operating Cost","title":"Example 2: A Thermal Generator","text":"","category":"section"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"We have a thermal generating unit that has a heat rate of 7 GJ/MWh at 100 MW and 9 GJ/MWh at 200 MW, plus a fixed cost of $6.0/hr, a start-up cost of $2000, and a shut-down cost of $1000. Its fuel cost is $20/GJ.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Following the decision steps above:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"We select ThermalGenerationCost to represent this thermal generator.\nWe select FuelCurve because we have consumption in units of fuel (GJ/MWh) instead of currency.\nWe select a PiecewisePointCurve to represent the piecewise linear heat rate curve.","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"This time, we'll define each step individually, beginning with the heat rate curve:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"heat_rate_curve = PiecewisePointCurve([(100.0, 7.0), (200.0, 9.0)])","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Use the heat rate to define the fuel curve, including the cost of fuel:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"fuel_curve = FuelCurve(; value_curve = heat_rate_curve, fuel_cost = 20.0)","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"Finally, define the full operating cost:","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"cost = ThermalGenerationCost(;\n variable = fuel_curve,\n fixed = 6.0,\n start_up = 2000.0,\n shut_down = 1000.0,\n)","category":"page"},{"location":"how_to/add_cost_curve/","page":"...add an Operating Cost","title":"...add an Operating Cost","text":"This OperationalCost can be used when defining a component or added to an existing component using set_operation_cost!.","category":"page"},{"location":"model_library/dynamic_branch/#Dynamic-Branch","page":"Dynamic Lines","title":"Dynamic Branch","text":"","category":"section"},{"location":"model_library/dynamic_branch/","page":"Dynamic Lines","title":"Dynamic Lines","text":"Modules = [PowerSystems]\nPages = [\"models/dynamic_branch.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/dynamic_branch/#PowerSystems.DynamicBranch","page":"Dynamic Lines","title":"PowerSystems.DynamicBranch","text":"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\n\nArguments\n\nbranch::ACBranch\n\n\n\n\n\n","category":"type"},{"location":"model_library/dynamic_branch/#PowerSystems.get_active_power_flow-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::DynamicBranch)\n\n\nGet DynamicBranch activepowerflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_angle_limits-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_angle_limits","text":"get_angle_limits(\n value::DynamicBranch\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet DynamicBranch angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_arc-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_arc","text":"get_arc(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_available-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_available","text":"get_available(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_b-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_b","text":"get_b(\n value::DynamicBranch\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet DynamicBranch b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_ext-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_ext","text":"get_ext(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_n_states-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_n_states","text":"get_n_states(value::DynamicBranch) -> Int64\n\n\nGet n_states\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_r-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_r","text":"get_r(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_rating-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_rating","text":"get_rating(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_reactive_power_flow-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::DynamicBranch)\n\n\nGet DynamicBranch reactivepowerflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_services-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_services","text":"get_services(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_states-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_states","text":"get_states(value::DynamicBranch) -> Vector{Symbol}\n\n\nGet states\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.get_x-Tuple{DynamicBranch}","page":"Dynamic Lines","title":"PowerSystems.get_x","text":"get_x(value::DynamicBranch) -> Any\n\n\nGet DynamicBranch x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_active_power_flow!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::DynamicBranch,\n val::Float64\n) -> Any\n\n\nSet DynamicBranch activepowerflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_angle_limits!-Tuple{DynamicBranch, @NamedTuple{min::Float64, max::Float64}}","page":"Dynamic Lines","title":"PowerSystems.set_angle_limits!","text":"set_angle_limits!(\n value::DynamicBranch,\n val::@NamedTuple{min::Float64, max::Float64}\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nSet DynamicBranch angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_arc!-Tuple{DynamicBranch, Arc}","page":"Dynamic Lines","title":"PowerSystems.set_arc!","text":"set_arc!(value::DynamicBranch, val::Arc) -> Any\n\n\nSet DynamicBranch arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_available!-Tuple{DynamicBranch, Bool}","page":"Dynamic Lines","title":"PowerSystems.set_available!","text":"set_available!(value::DynamicBranch, val::Bool) -> Any\n\n\nSet DynamicBranch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_b!-Tuple{DynamicBranch, Any}","page":"Dynamic Lines","title":"PowerSystems.set_b!","text":"set_b!(value::DynamicBranch, val) -> Any\n\n\nSet DynamicBranch b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_ext!-Tuple{DynamicBranch, Dict{String, Any}}","page":"Dynamic Lines","title":"PowerSystems.set_ext!","text":"set_ext!(\n value::DynamicBranch,\n val::Dict{String, Any}\n) -> Any\n\n\nSet DynamicBranch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_n_states!-Tuple{DynamicBranch, Int64}","page":"Dynamic Lines","title":"PowerSystems.set_n_states!","text":"set_n_states!(value::DynamicBranch, val::Int64) -> Int64\n\n\nSet n_states\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_r!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_r!","text":"set_r!(value::DynamicBranch, val::Float64) -> Any\n\n\nSet DynamicBranch r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_rating!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_rating!","text":"set_rating!(value::DynamicBranch, val::Float64) -> Any\n\n\nSet DynamicBranch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_reactive_power_flow!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(\n value::DynamicBranch,\n val::Float64\n) -> Any\n\n\nSet DynamicBranch reactivepowerflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_services!-Tuple{DynamicBranch, Vector{Service}}","page":"Dynamic Lines","title":"PowerSystems.set_services!","text":"set_services!(\n value::DynamicBranch,\n val::Vector{Service}\n) -> Any\n\n\nSet DynamicBranch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_states!-Tuple{DynamicBranch, Vector{Symbol}}","page":"Dynamic Lines","title":"PowerSystems.set_states!","text":"set_states!(\n value::DynamicBranch,\n val::Vector{Symbol}\n) -> Vector{Symbol}\n\n\nSet states\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_branch/#PowerSystems.set_x!-Tuple{DynamicBranch, Float64}","page":"Dynamic Lines","title":"PowerSystems.set_x!","text":"set_x!(value::DynamicBranch, val::Float64) -> Any\n\n\nSet DynamicBranch x.\n\n\n\n\n\n","category":"method"},{"location":"how_to/reduce_repl_printing/#Reduce-REPL-printing","page":"...reduce REPL printing","title":"Reduce REPL printing","text":"","category":"section"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"By default PowerSystems.jl outputs to the REPL all Logging statements, which can be overwhelming in some cases.","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"Use configure_logging to create a logger with your preferences for which logging statements should be printed to the console or a log file:","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"Example: Set log output to only see error messages in the console","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"using PowerSystems\nusing Logging\nconfigure_logging(; console_level = Logging.Error)","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"Note: log messages are not automatically flushed to files. Call flush(logger) to make this happen.","category":"page"},{"location":"how_to/reduce_repl_printing/","page":"...reduce REPL printing","title":"...reduce REPL printing","text":"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.","category":"page"},{"location":"how_to/improve_ts_performance/#Improve-Performance-with-Time-Series-Data","page":"...improve performance with time series data","title":"Improve Performance with Time Series Data","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"Use the steps here to improve performance with small or large data sets, but particularly large data sets. These improvements can help handle adding large numbers of data sets or reduce overhead when accessing time series data multiple times.","category":"page"},{"location":"how_to/improve_ts_performance/#Choosing-the-Storage-Location","page":"...improve performance with time series data","title":"Choosing the Storage Location","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"By default, time series data is stored in an HDF5 file in the tmp file system to prevent large datasets from overwhelming system memory. However, you can change its location.","category":"page"},{"location":"how_to/improve_ts_performance/#Small-data-sets","page":"...improve performance with time series data","title":"Small data sets","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"If your dataset will fit in your computer's memory, then you can increase performance by storing it in memory:","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"sys = System(100.0; time_series_in_memory = true)","category":"page"},{"location":"how_to/improve_ts_performance/#Large-data-sets","page":"...improve performance with time series data","title":"Large data sets","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"If the system's time series data will be larger than the amount of tmp space available, use the time_series_directory parameter to change its location.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"sys = System(100.0; time_series_directory = \"bigger_directory\")","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"You can also override the location by setting the environment variable SIENNA_TIME_SERIES_DIRECTORY to another directory.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"HDF5 compression is not enabled by default, but you can enable it with enable_compression to get significant storage savings at the cost of CPU time. CompressionSettings can be used to customize the HDF5 compression.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"sys = System(100.0; enable_compression = true)\nsys = System(\n 100.0;\n compression = CompressionSettings(;\n enabled = true,\n type = CompressionTypes.DEFLATE, # BLOSC is also supported\n level = 3,\n shuffle = true,\n ),\n)","category":"page"},{"location":"how_to/improve_ts_performance/#Adding-Timeseries-To-The-System","page":"...improve performance with time series data","title":"Adding Timeseries To The System","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"In order to optimize the storage of time series data, time series can be shared across devices to avoid duplication. If the same forecast applies to multiple components then can call add_time_series!, passing the collection of components that share the time series data. Time series data can also be shared on a component level. Suppose a time series array applies to both the max_active_power and max_reactive_power attributes of a generator. You can share the data.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"resolution = Dates.Hour(1)\ndata = Dict(\n DateTime(\"2020-01-01T00:00:00\") => ones(24),\n DateTime(\"2020-01-01T01:00:00\") => ones(24),\n)\n# Define a Deterministic for the first attribute\nforecast_max_active_power = Deterministic(\n \"max_active_power\",\n data,\n resolution;\n scaling_factor_multiplier = get_max_active_power,\n)\nadd_time_series!(sys, generator, forecast_max_active_power)\n# Reuse time series for second attribute\nforecast_max_reactive_power = Deterministic(\n forecast_max_active_power,\n \"max_reactive_power\";\n scaling_factor_multiplier = get_max_reactive_power,\n)\nadd_time_series!(sys, generator, forecast_max_reactive_power)","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"By default, the call to add_time_series! will open the HDF5 file, write the data to the file, and close the file. It will also add a row to an SQLite database. These operations have overhead. If you will add thousands of time series arrays, consider using bulk_add_time_series!. All arrays will be written with one file handle. The bulk SQLite operations are much more efficient. As a fallback option, use open_time_series_store! if timeseries must be added one at a time.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"# Assumes `read_time_series` will return data appropriate for Deterministic forecasts\n# based on the generator name and the filenames match the component and time series names.\nresolution = Dates.Hour(1)\nassociations = (\n IS.TimeSeriesAssociation(\n gen,\n Deterministic(;\n data = read_time_series(get_name(gen) * \".csv\"),\n name = \"get_max_active_power\",\n resolution = resolution),\n )\n for gen in get_components(ThermalStandard, sys)\n)\nbulk_add_time_series!(sys, associations)","category":"page"},{"location":"how_to/improve_ts_performance/#Using-Forecast-Caches-for-Simulations","page":"...improve performance with time series data","title":"Using Forecast Caches for Simulations","text":"","category":"section"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"Each retrieval of a forecast window from the HDF5 file will involve a small disk read. In the case of production cost modeling or other analyses that access forecast windows repeatedly, this can slow down processes significantly, especially if the underlying storage uses spinning disks.","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"PowerSystems provides an alternate interface – the forecast cache – that pre-fetches data into the system memory with large reads in order to mitigate this potential problem. It is highly recommended that you use this interface for modeling implementations. This is particularly relevant for models using large datasets. For example:","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"cache = ForecastCache(Deterministic, component, \"max_active_power\")\nwindow1 = get_next_time_series_array!(cache)\nwindow2 = get_next_time_series_array!(cache)\n# or\nfor window in cache\n @show window\nend","category":"page"},{"location":"how_to/improve_ts_performance/","page":"...improve performance with time series data","title":"...improve performance with time series data","text":"Each iteration of on the cache object will deliver the next forecast window (see get_next_time_series_array!).","category":"page"},{"location":"how_to/parse_ts_from_csvs/#parsing_time_series","page":"...parse time series data from .csv files","title":"Parse Time Series Data from .csv's","text":"","category":"section"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"This example shows how to parse time series data from .csv files to add to a System. For example, a System created by parsing a MATPOWER file doesn't contain any time series data, so a user may want to add time series to be able to run a production cost model.","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"using PowerSystems\nusing JSON3\n\nfile_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"tutorials_data\"); #hide\nsys = System(joinpath(file_dir, \"case5_re.m\"));","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"Let's use a predefined 5-bus System with some renewable generators and loads that we want to add time-series data to:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"sys","category":"page"},{"location":"how_to/parse_ts_from_csvs/#Define-pointers-to-time-series-files","page":"...parse time series data from .csv files","title":"Define pointers to time series files","text":"","category":"section"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"PowerSystems requires a metadata file that maps components to their time series data in order to be able to automatically construct time_series from .csv data files.","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"For example, if we want to add a bunch of time series files, say one for each load and one for each renewable generator, we need to define pointers to each time series .csv file with the following fields:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"simulation: User description of simulation\nresolution: Resolution of time series in seconds\nmodule: Module that defines the abstract type of the component\ncategory: Type of component. Must map to abstract types defined by the \"module\" entry (Bus, ElectricLoad, Generator, LoadZone, Reserve)\ncomponent_name: Name of component\nname: User-defined name for the time series data.\nnormalization_factor: Controls normalization of the data. Use 1.0 for pre-normalized data. Use 'Max' to divide the time series by the max value in the column. Use any float for a custom scaling factor.\nscaling_factor_multiplier_module: Module that defines the accessor function for the scaling factor\nscaling_factor_multiplier: Accessor function of the scaling factor\ndata_file: Path to the time series data file","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"Notes:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"The module, category, and component_name entries must be valid arguments to retrieve a component using get_component(${module}.${category}, sys, $name).\nThe scaling_factor_multiplier_module and the scaling_factor_multiplier entries must be sufficient to return the scaling factor data using ${scaling_factor_multiplier_module}.${scaling_factor_multiplier}(component).","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"PowerSystems supports this metadata in either CSV or JSON formats.","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"In this example, we will use the JSON format. The example file can be found here, and this is what its pointers look like in the required format:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"using PowerSystemCaseBuilder #hide\nDATA_DIR = PowerSystemCaseBuilder.DATA_DIR #hide\nFORECASTS_DIR = joinpath(DATA_DIR, \"5-Bus\", \"5bus_ts\"); #hide\nfname = joinpath(FORECASTS_DIR, \"timeseries_pointers_da.json\"); # hide\nopen(fname, \"r\") do f # hide\n JSON3.@pretty JSON3.read(f) # hide\nend #hide","category":"page"},{"location":"how_to/parse_ts_from_csvs/#Read-and-assign-time-series-to-System-using-these-parameters.","page":"...parse time series data from .csv files","title":"Read and assign time series to System using these parameters.","text":"","category":"section"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"fname = joinpath(FORECASTS_DIR, \"timeseries_pointers_da.json\")\nadd_time_series!(sys, fname)","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"You can print the System to see a new table summarizing the time series data that has been added:","category":"page"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"sys","category":"page"},{"location":"how_to/parse_ts_from_csvs/#See-also:","page":"...parse time series data from .csv files","title":"See also:","text":"","category":"section"},{"location":"how_to/parse_ts_from_csvs/","page":"...parse time series data from .csv files","title":"...parse time series data from .csv files","text":"Improve Performance with Time Series Data\nParsing Matpower or PSS/e RAW Files\nParsing PSS/e DYR Files\nParsing table data (CSV Files)","category":"page"},{"location":"api/citation/#Citation","page":"Citation","title":"Citation","text":"","category":"section"},{"location":"api/citation/","page":"Citation","title":"Citation","text":"Users are requested to please cite the following paper:","category":"page"},{"location":"api/citation/","page":"Citation","title":"Citation","text":"@article{LARA2021100747,\ntitle = {PowerSystems.jl — A power system data management package for large scale modeling},\njournal = {SoftwareX},\nvolume = {15},\npages = {100747},\nyear = {2021},\nissn = {2352-7110},\ndoi = {https://doi.org/10.1016/j.softx.2021.100747},\nurl = {https://www.sciencedirect.com/science/article/pii/S2352711021000765},\nauthor = {José Daniel Lara and Clayton Barrows and Daniel Thom and Dheepak Krishnamurthy and Duncan Callaway},\nkeywords = {Power Systems, Julia, Energy},","category":"page"},{"location":"api/citation/","page":"Citation","title":"Citation","text":"PowerSystems has been developed as part of the Sienna platform by the U.S. Department of Energy's National Renewable Energy Laboratory (NREL).","category":"page"},{"location":"model_library/generated_AreaInterchange/#AreaInterchange","page":"AreaInterchange","title":"AreaInterchange","text":"","category":"section"},{"location":"model_library/generated_AreaInterchange/","page":"AreaInterchange","title":"AreaInterchange","text":"Modules = [PowerSystems]\nPages = [\"generated/AreaInterchange.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.AreaInterchange","page":"AreaInterchange","title":"PowerSystems.AreaInterchange","text":"mutable struct AreaInterchange <: Branch\n name::String\n available::Bool\n active_power_flow::Float64\n from_area::Area\n to_area::Area\n flow_limits::FromTo_ToFrom\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nFlow 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\nfrom_area::Area: Area from which the power is extracted\nto_area::Area: Area to which the power is injected\nflow_limits::FromTo_ToFrom: Max flow between the areas. It ignores lines and other branches totals\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AreaInterchange/#InfrastructureSystems.get_name-Tuple{AreaInterchange}","page":"AreaInterchange","title":"InfrastructureSystems.get_name","text":"get_name(value::AreaInterchange) -> String\n\n\nGet AreaInterchange name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_active_power_flow-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::AreaInterchange) -> Any\n\n\nGet AreaInterchange active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_available-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_available","text":"get_available(value::AreaInterchange) -> Bool\n\n\nGet AreaInterchange available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_ext-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_ext","text":"get_ext(value::AreaInterchange) -> Dict{String, Any}\n\n\nGet AreaInterchange ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_flow_limits-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_flow_limits","text":"get_flow_limits(\n value::AreaInterchange\n) -> NamedTuple{(:from_to, :to_from), <:Tuple{Any, Any}}\n\n\nGet AreaInterchange flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_from_area-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_from_area","text":"get_from_area(value::AreaInterchange) -> Area\n\n\nGet AreaInterchange from_area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.get_to_area-Tuple{AreaInterchange}","page":"AreaInterchange","title":"PowerSystems.get_to_area","text":"get_to_area(value::AreaInterchange) -> Area\n\n\nGet AreaInterchange to_area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_active_power_flow!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_available!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_available!","text":"set_available!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_ext!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_ext!","text":"set_ext!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_flow_limits!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_flow_limits!","text":"set_flow_limits!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_from_area!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_from_area!","text":"set_from_area!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange from_area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AreaInterchange/#PowerSystems.set_to_area!-Tuple{AreaInterchange, Any}","page":"AreaInterchange","title":"PowerSystems.set_to_area!","text":"set_to_area!(value::AreaInterchange, val) -> Any\n\n\nSet AreaInterchange to_area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TurbineGov","page":"TurbineGov","title":"TurbineGov","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/#DEGOV","page":"TurbineGov","title":"DEGOV","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/DEGOV.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.DEGOV","page":"TurbineGov","title":"PowerSystems.DEGOV","text":"mutable struct DEGOV <: TurbineGov\n T1::Float64\n T2::Float64\n T3::Float64\n K::Float64\n T4::Float64\n T5::Float64\n T6::Float64\n Td::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters Woodward Diesel Governor Model. DEGOV in PowerWorld\n\nArguments\n\nT1::Float64: Governor mechanism time constant, validation range: (eps(), 100)\nT2::Float64: Turbine power time constant, validation range: (eps(), 100)\nT3::Float64: Turbine exhaust temperature time constant, validation range: (eps(), 100)\nK::Float64: Governor gain (reciprocal of droop), validation range: (eps(), 100)\nT4::Float64: Governor lead time constant, validation range: (eps(), 100)\nT5::Float64: Governor lag time constant, validation range: (eps(), 100)\nT6::Float64: Actuator time constant, validation range: (eps(), 100)\nTd::Float64: Engine time delay, validation range: (eps(), 100)\nP_ref::Float64: (default: 1.0) Reference Load Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the DEGOV model are:\n\nx_ecb1: Electric control box 1,\nx_ecb2: Electric control box 2,\nx_a1: Actuator 1,\nx_a2: Actuator 2,\nx_a3: Actuator 3,\n\nn_states::Int: (Do not modify.) DEGOV has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) DEGOV has 5 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_K","text":"get_K(value::DEGOV) -> Float64\n\n\nGet DEGOV K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::DEGOV) -> Float64\n\n\nGet DEGOV P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::DEGOV) -> Float64\n\n\nGet DEGOV T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::DEGOV) -> Float64\n\n\nGet DEGOV T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::DEGOV) -> Float64\n\n\nGet DEGOV T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T4-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T4","text":"get_T4(value::DEGOV) -> Float64\n\n\nGet DEGOV T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T5-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T5","text":"get_T5(value::DEGOV) -> Float64\n\n\nGet DEGOV T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T6-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_T6","text":"get_T6(value::DEGOV) -> Float64\n\n\nGet DEGOV T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Td-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_Td","text":"get_Td(value::DEGOV) -> Float64\n\n\nGet DEGOV Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::DEGOV) -> Dict{String, Any}\n\n\nGet DEGOV ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::DEGOV) -> Int64\n\n\nGet DEGOV n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::DEGOV) -> Vector{Symbol}\n\n\nGet DEGOV states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{DEGOV}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(value::DEGOV) -> Vector{StateTypes}\n\n\nGet DEGOV states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_K!","text":"set_K!(value::DEGOV, val) -> Any\n\n\nSet DEGOV K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::DEGOV, val) -> Any\n\n\nSet DEGOV P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T4!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T4!","text":"set_T4!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T5!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T5!","text":"set_T5!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T6!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T6!","text":"set_T6!(value::DEGOV, val) -> Any\n\n\nSet DEGOV T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Td!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Td!","text":"set_Td!(value::DEGOV, val) -> Any\n\n\nSet DEGOV Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::DEGOV, val) -> Any\n\n\nSet DEGOV ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{DEGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::DEGOV, val) -> Any\n\n\nSet DEGOV states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#DEGOV1","page":"TurbineGov","title":"DEGOV1","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/DEGOV1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.DEGOV1","page":"TurbineGov","title":"PowerSystems.DEGOV1","text":"mutable struct DEGOV1 <: TurbineGov\n droop_flag::Int\n T1::Float64\n T2::Float64\n T3::Float64\n K::Float64\n T4::Float64\n T5::Float64\n T6::Float64\n Td::Float64\n T_lim::Tuple{Float64, Float64}\n R::Float64\n Te::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters Woodward Diesel Governor Model. DEGOV1 in PSSE\n\nArguments\n\ndroop_flag::Int: Droop control Flag. 0 for throttle feedback and 1 for electric power feedback, validation range: (0, 1)\nT1::Float64: Governor mechanism time constant in s, validation range: (0, 100)\nT2::Float64: Turbine power time constant in s, validation range: (0, 100)\nT3::Float64: Turbine exhaust temperature time constant in s, validation range: (0, 100)\nK::Float64: Governor gain for actuator, validation range: (0, 100)\nT4::Float64: Governor lead time constant in s, validation range: (0, 100)\nT5::Float64: Governor lag time constant in s, validation range: (0, 100)\nT6::Float64: Actuator time constant in s, validation range: (0, 100)\nTd::Float64: Engine time delay in s, validation range: (0, 100)\nT_lim::Tuple{Float64, Float64}: Operational control limits on actuator (Tmin, Tmax)\nR::Float64: Steady state droop parameter, validation range: (0, 100)\nTe::Float64: Power transducer time constant in s, validation range: (0, 100)\nP_ref::Float64: (default: 1.0) Reference Load Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the DEGOV1 model depends on the droop flag\nn_states::Int: (Do not modify.) The number of states of the DEGOV1 model depends on the droop flag\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_K","text":"get_K(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T4-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T4","text":"get_T4(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T5-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T5","text":"get_T5(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T6-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T6","text":"get_T6(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_lim-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_T_lim","text":"get_T_lim(value::DEGOV1) -> Tuple{Float64, Float64}\n\n\nGet DEGOV1 T_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Td-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_Td","text":"get_Td(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Te-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_Te","text":"get_Te(value::DEGOV1) -> Float64\n\n\nGet DEGOV1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_droop_flag-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_droop_flag","text":"get_droop_flag(value::DEGOV1) -> Int64\n\n\nGet DEGOV1 droop_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::DEGOV1) -> Dict{String, Any}\n\n\nGet DEGOV1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::DEGOV1) -> Int64\n\n\nGet DEGOV1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{DEGOV1}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::DEGOV1) -> Vector{Symbol}\n\n\nGet DEGOV1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_K!","text":"set_K!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T4!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T4!","text":"set_T4!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T5!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T5!","text":"set_T5!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T6!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T6!","text":"set_T6!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_lim!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_T_lim!","text":"set_T_lim!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 T_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Td!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_Td!","text":"set_Td!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Te!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_Te!","text":"set_Te!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_droop_flag!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_droop_flag!","text":"set_droop_flag!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 droop_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{DEGOV1, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::DEGOV1, val) -> Any\n\n\nSet DEGOV1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#GasTG","page":"TurbineGov","title":"GasTG","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/GasTG.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.GasTG","page":"TurbineGov","title":"PowerSystems.GasTG","text":"mutable struct GasTG <: TurbineGov\n R::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n AT::Float64\n Kt::Float64\n V_lim::Tuple{Float64, Float64}\n D_turb::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of Gas Turbine-Governor. GAST in PSSE and GAST_PTI in PowerWorld\n\nArguments\n\nR::Float64: Speed droop parameter, validation range: (eps(), 0.1)\nT1::Float64: Governor time constant in s, validation range: (eps(), 0.5)\nT2::Float64: Combustion chamber time constant, validation range: (eps(), 0.5)\nT3::Float64: Load limit time constant (exhaust gas measurement time), validation range: (eps(), 5)\nAT::Float64: Ambient temperature load limit, validation range: (0, 1)\nKt::Float64: Load limit feedback gain, validation range: (0, 5)\nV_lim::Tuple{Float64, Float64}: Operational control limits on fuel valve opening (Vmin, Vmax)\nD_turb::Float64: Speed damping coefficient of gas turbine rotor, validation range: (0, 0.5)\nP_ref::Float64: (default: 1.0) Reference Load Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the GAST model are:\n\nx_g1: Fuel valve opening,\nx_g2: Fuel flow,\nx_g3: Exhaust temperature load\n\nn_states::Int: (Do not modify.) GasTG has 3 states\nstates_types::Vector{StateTypes}: (Do not modify.) GAST has 3 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_AT-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_AT","text":"get_AT(value::GasTG) -> Float64\n\n\nGet GasTG AT.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D_turb-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_D_turb","text":"get_D_turb(value::GasTG) -> Float64\n\n\nGet GasTG D_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kt-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_Kt","text":"get_Kt(value::GasTG) -> Float64\n\n\nGet GasTG Kt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::GasTG) -> Float64\n\n\nGet GasTG P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::GasTG) -> Float64\n\n\nGet GasTG R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::GasTG) -> Float64\n\n\nGet GasTG T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::GasTG) -> Float64\n\n\nGet GasTG T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::GasTG) -> Float64\n\n\nGet GasTG T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_V_lim-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_V_lim","text":"get_V_lim(value::GasTG) -> Tuple{Float64, Float64}\n\n\nGet GasTG V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::GasTG) -> Dict{String, Any}\n\n\nGet GasTG ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::GasTG) -> Int64\n\n\nGet GasTG n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::GasTG) -> Vector{Symbol}\n\n\nGet GasTG states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{GasTG}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(value::GasTG) -> Vector{StateTypes}\n\n\nGet GasTG states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_AT!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_AT!","text":"set_AT!(value::GasTG, val) -> Any\n\n\nSet GasTG AT.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D_turb!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_D_turb!","text":"set_D_turb!(value::GasTG, val) -> Any\n\n\nSet GasTG D_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kt!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_Kt!","text":"set_Kt!(value::GasTG, val) -> Any\n\n\nSet GasTG Kt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::GasTG, val) -> Any\n\n\nSet GasTG P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::GasTG, val) -> Any\n\n\nSet GasTG R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::GasTG, val) -> Any\n\n\nSet GasTG T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::GasTG, val) -> Any\n\n\nSet GasTG T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::GasTG, val) -> Any\n\n\nSet GasTG T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_V_lim!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::GasTG, val) -> Any\n\n\nSet GasTG V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::GasTG, val) -> Any\n\n\nSet GasTG ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{GasTG, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::GasTG, val) -> Any\n\n\nSet GasTG states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#GeneralGovModel","page":"TurbineGov","title":"GeneralGovModel","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/GeneralGovModel.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.GeneralGovModel","page":"TurbineGov","title":"PowerSystems.GeneralGovModel","text":"mutable struct GeneralGovModel <: TurbineGov\n Rselect::Int\n fuel_flag::Int\n R::Float64\n Tpelec::Float64\n speed_error_signal::MinMax\n Kp_gov::Float64\n Ki_gov::Float64\n Kd_gov::Float64\n Td_gov::Float64\n valve_position_limits::MinMax\n T_act::Float64\n K_turb::Float64\n Wf_nl::Float64\n Tb::Float64\n Tc::Float64\n T_eng::Float64\n Tf_load::Float64\n Kp_load::Float64\n Ki_load::Float64\n Ld_ref::Float64\n Dm::Float64\n R_open::Float64\n R_close::Float64\n Ki_mw::Float64\n A_set::Float64\n Ka::Float64\n Ta::Float64\n T_rate::Float64\n db::Float64\n Tsa::Float64\n Tsb::Float64\n R_lim::UpDown\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nGE General Governor/Turbine Model. The GeneralGovModel (GGOV1) model is a general purpose governor model used for a variety of prime movers controlled by proportional-integral-derivative (PID) governors including gas turbines\n\nArguments\n\nRselect::Int: Feedback signal for governor droop, validation range: (-2, 1)\nfuel_flag::Int: Flag Switch for fuel source characteristic, validation range: (0, 1)\nR::Float64: Speed droop parameter, validation range: (eps(), nothing)\nTpelec::Float64: Electrical power transducer time constant, seconds, validation range: (eps(), nothing)\nspeed_error_signal::MinMax: Speed error signal limits\nKp_gov::Float64: Governor proportional gain, validation range: (0, nothing)\nKi_gov::Float64: Governor integral gain, validation range: (0, nothing)\nKd_gov::Float64: Governor derivative gain, validation range: (0, nothing)\nTd_gov::Float64: Governor derivative time constant, validation range: (0, nothing)\nvalve_position_limits::MinMax: Valve position limits\nT_act::Float64: Actuator time constant, validation range: (0, nothing)\nK_turb::Float64: Turbine gain, validation range: (0, nothing)\nWf_nl::Float64: No load fuel flow, pu, validation range: (0, nothing)\nTb::Float64: Turbine lag time constant, sec, validation range: (0, nothing)\nTc::Float64: Turbine lead time constant, sec, validation range: (0, nothing)\nT_eng::Float64: Transport lag time constant for diesel engine, sec, validation range: (0, nothing)\nTf_load::Float64: Load limiter time constant, validation range: (0, nothing)\nKp_load::Float64: Load limiter proportional gain for PI controller, validation range: (0, nothing)\nKi_load::Float64: Load integral gain for PI controller, validation range: (0, nothing)\nLd_ref::Float64: Load limiter integral gain for PI controller, validation range: (0, nothing)\nDm::Float64: Mechanical damping coefficient, pu, validation range: (0, nothing)\nR_open::Float64: Maximum valve opening rate, pu/sec, validation range: (0, nothing)\nR_close::Float64: Maximum valve closing rate, pu/sec, validation range: (0, nothing)\nKi_mw::Float64: Power controller (reset) gain, validation range: (0, nothing)\nA_set::Float64: Acceleration limiter setpoint, pu/sec, validation range: (0, nothing)\nKa::Float64: Acceleration limiter gain, validation range: (0, nothing)\nTa::Float64: Acceleration limiter time constant , validation range: (eps(), nothing)\nT_rate::Float64: Turbine rating, validation range: (0, nothing)\ndb::Float64: Speed governor deadband, validation range: (0, nothing)\nTsa::Float64: Temperature detection lead time constant, validation range: (0, nothing)\nTsb::Float64: Temperature detection lag time constant, validation range: (0, nothing)\nR_lim::UpDown: Maximum rate of load increase\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the GGOV1 model are:\n\nPe: Machine Electrical Power Measurement,\nx_g1: Governor differential control,\nx_g2: Governor integral control, \nx_g3: Turbine actuator, \nx_g4: Turbine Lead-Lag, \nx_g5: Turbine load limiter measurement, \nx_g6: Turbine Load Limiter Integral Control, \nx_g7: Supervisory Load Control, \nx_g8: Acceleration Control, \nx_g9 Temperature Detection Lead - Lag:\n\nn_states::Int: (Do not modify.) GeneralGovModel has 10 states\nstates_types::Vector{StateTypes}: (Do not modify.) GGOV1 has 10 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_A_set-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_A_set","text":"get_A_set(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel A_set.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Dm-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Dm","text":"get_Dm(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Dm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K_turb-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_K_turb","text":"get_K_turb(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel K_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ka-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ka","text":"get_Ka(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kd_gov-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Kd_gov","text":"get_Kd_gov(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Kd_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki_gov-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ki_gov","text":"get_Ki_gov(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ki_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki_load-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ki_load","text":"get_Ki_load(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ki_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki_mw-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ki_mw","text":"get_Ki_mw(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ki_mw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kp_gov-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Kp_gov","text":"get_Kp_gov(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Kp_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kp_load-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Kp_load","text":"get_Kp_load(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Kp_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ld_ref-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ld_ref","text":"get_Ld_ref(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ld_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R_close-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_R_close","text":"get_R_close(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel R_close.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R_lim-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_R_lim","text":"get_R_lim(\n value::GeneralGovModel\n) -> @NamedTuple{up::Float64, down::Float64}\n\n\nGet GeneralGovModel R_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R_open-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_R_open","text":"get_R_open(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel R_open.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Rselect-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Rselect","text":"get_Rselect(value::GeneralGovModel) -> Int64\n\n\nGet GeneralGovModel Rselect.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_act-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_T_act","text":"get_T_act(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel T_act.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_eng-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_T_eng","text":"get_T_eng(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel T_eng.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_rate-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_T_rate","text":"get_T_rate(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel T_rate.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ta-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Ta","text":"get_Ta(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tb-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tb","text":"get_Tb(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tc-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tc","text":"get_Tc(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Td_gov-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Td_gov","text":"get_Td_gov(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Td_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tf_load-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tf_load","text":"get_Tf_load(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tf_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tpelec-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tpelec","text":"get_Tpelec(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tpelec.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tsa-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tsa","text":"get_Tsa(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tsa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tsb-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Tsb","text":"get_Tsb(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Tsb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Wf_nl-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_Wf_nl","text":"get_Wf_nl(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel Wf_nl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_db-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_db","text":"get_db(value::GeneralGovModel) -> Float64\n\n\nGet GeneralGovModel db.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::GeneralGovModel) -> Dict{String, Any}\n\n\nGet GeneralGovModel ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_fuel_flag-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_fuel_flag","text":"get_fuel_flag(value::GeneralGovModel) -> Int64\n\n\nGet GeneralGovModel fuel_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::GeneralGovModel) -> Int64\n\n\nGet GeneralGovModel n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_speed_error_signal-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_speed_error_signal","text":"get_speed_error_signal(\n value::GeneralGovModel\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GeneralGovModel speed_error_signal.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::GeneralGovModel) -> Vector{Symbol}\n\n\nGet GeneralGovModel states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(\n value::GeneralGovModel\n) -> Vector{StateTypes}\n\n\nGet GeneralGovModel states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_valve_position_limits-Tuple{GeneralGovModel}","page":"TurbineGov","title":"PowerSystems.get_valve_position_limits","text":"get_valve_position_limits(\n value::GeneralGovModel\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GeneralGovModel valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_A_set!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_A_set!","text":"set_A_set!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel A_set.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Dm!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Dm!","text":"set_Dm!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Dm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K_turb!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_K_turb!","text":"set_K_turb!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel K_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ka!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kd_gov!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Kd_gov!","text":"set_Kd_gov!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Kd_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki_gov!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki_gov!","text":"set_Ki_gov!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ki_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki_load!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki_load!","text":"set_Ki_load!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ki_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki_mw!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki_mw!","text":"set_Ki_mw!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ki_mw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kp_gov!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Kp_gov!","text":"set_Kp_gov!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Kp_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kp_load!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Kp_load!","text":"set_Kp_load!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Kp_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ld_ref!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ld_ref!","text":"set_Ld_ref!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ld_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R_close!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_R_close!","text":"set_R_close!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel R_close.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R_lim!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_R_lim!","text":"set_R_lim!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel R_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R_open!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_R_open!","text":"set_R_open!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel R_open.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Rselect!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Rselect!","text":"set_Rselect!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Rselect.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_act!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_T_act!","text":"set_T_act!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel T_act.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_eng!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_T_eng!","text":"set_T_eng!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel T_eng.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_rate!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_T_rate!","text":"set_T_rate!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel T_rate.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ta!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tb!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tc!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Td_gov!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Td_gov!","text":"set_Td_gov!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Td_gov.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tf_load!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tf_load!","text":"set_Tf_load!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tf_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tpelec!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tpelec!","text":"set_Tpelec!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tpelec.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tsa!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tsa!","text":"set_Tsa!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tsa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tsb!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Tsb!","text":"set_Tsb!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Tsb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Wf_nl!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_Wf_nl!","text":"set_Wf_nl!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel Wf_nl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_db!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_db!","text":"set_db!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel db.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_fuel_flag!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_fuel_flag!","text":"set_fuel_flag!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel fuel_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_speed_error_signal!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_speed_error_signal!","text":"set_speed_error_signal!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel speed_error_signal.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::GeneralGovModel, val) -> Any\n\n\nSet GeneralGovModel states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_valve_position_limits!-Tuple{GeneralGovModel, Any}","page":"TurbineGov","title":"PowerSystems.set_valve_position_limits!","text":"set_valve_position_limits!(\n value::GeneralGovModel,\n val\n) -> Any\n\n\nSet GeneralGovModel valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#HydroTurbineGov","page":"TurbineGov","title":"HydroTurbineGov","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/HydroTurbineGov.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.HydroTurbineGov","page":"TurbineGov","title":"PowerSystems.HydroTurbineGov","text":"mutable struct HydroTurbineGov <: TurbineGov\n R::Float64\n r::Float64\n Tr::Float64\n Tf::Float64\n Tg::Float64\n VELM::Float64\n gate_position_limits::MinMax\n Tw::Float64\n At::Float64\n D_T::Float64\n q_nl::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nHydro Turbine-Governor\n\nArguments\n\nR::Float64: Permanent droop parameter, validation range: (0, 0.1)\nr::Float64: Temporary Droop, validation range: (0, 2)\nTr::Float64: Governor time constant, validation range: (eps(), 30)\nTf::Float64: Filter Time constant, validation range: (eps(), 0.1)\nTg::Float64: Servo time constant, validation range: (eps(), 1)\nVELM::Float64: gate velocity limit, validation range: (eps(), 0.3)\ngate_position_limits::MinMax: Gate position limits\nTw::Float64: water time constant, validation range: (eps(), 3)\nAt::Float64: Turbine gain, validation range: (0.8, 1.5)\nD_T::Float64: Turbine Damping, validation range: (0, 0.5)\nq_nl::Float64: No-power flow, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the HydroTurbineGov model are:\n\nx_g1: filter_output,\nx_g2: desired gate, \nx_g3: gate opening, \nx_g4: turbine flow\n\nn_states::Int: (Do not modify.) HYGOV has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) HYGOV has 4 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_At-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_At","text":"get_At(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov At.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D_T-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_D_T","text":"get_D_T(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov D_T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tf-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_Tf","text":"get_Tf(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tg-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_Tg","text":"get_Tg(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tr-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_Tr","text":"get_Tr(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tw-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_Tw","text":"get_Tw(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_VELM-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_VELM","text":"get_VELM(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov VELM.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::HydroTurbineGov) -> Dict{String, Any}\n\n\nGet HydroTurbineGov ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_gate_position_limits-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_gate_position_limits","text":"get_gate_position_limits(\n value::HydroTurbineGov\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet HydroTurbineGov gate_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::HydroTurbineGov) -> Int64\n\n\nGet HydroTurbineGov n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_q_nl-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_q_nl","text":"get_q_nl(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov q_nl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_r-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_r","text":"get_r(value::HydroTurbineGov) -> Float64\n\n\nGet HydroTurbineGov r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::HydroTurbineGov) -> Vector{Symbol}\n\n\nGet HydroTurbineGov states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{HydroTurbineGov}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(\n value::HydroTurbineGov\n) -> Vector{StateTypes}\n\n\nGet HydroTurbineGov states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_At!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_At!","text":"set_At!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov At.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D_T!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_D_T!","text":"set_D_T!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov D_T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tf!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tg!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_Tg!","text":"set_Tg!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tr!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tw!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_Tw!","text":"set_Tw!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_VELM!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_VELM!","text":"set_VELM!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov VELM.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_gate_position_limits!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_gate_position_limits!","text":"set_gate_position_limits!(\n value::HydroTurbineGov,\n val\n) -> Any\n\n\nSet HydroTurbineGov gate_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_q_nl!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_q_nl!","text":"set_q_nl!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov q_nl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_r!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_r!","text":"set_r!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{HydroTurbineGov, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::HydroTurbineGov, val) -> Any\n\n\nSet HydroTurbineGov states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#IEEETurbineGov1","page":"TurbineGov","title":"IEEETurbineGov1","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/IEEETurbineGov1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.IEEETurbineGov1","page":"TurbineGov","title":"PowerSystems.IEEETurbineGov1","text":"mutable struct IEEETurbineGov1 <: TurbineGov\n K::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n U0::Float64\n U_c::Float64\n valve_position_limits::MinMax\n T4::Float64\n K1::Float64\n K2::Float64\n T5::Float64\n K3::Float64\n K4::Float64\n T6::Float64\n K5::Float64\n K6::Float64\n T7::Float64\n K7::Float64\n K8::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Type 1 Speed-Governing Model\n\nArguments\n\nK::Float64: Governor Gain, validation range: (5, 30)\nT1::Float64: Input Filter Lag, validation range: (0, 5)\nT2::Float64: Input Filter Lead, validation range: (0, 10)\nT3::Float64: Valve position Time Constant, validation range: (eps(), 1)\nU0::Float64: Maximum Valve Opening Rate, validation range: (0.01, 0.03)\nU_c::Float64: Maximum Valve closing rate, validation range: (-0.3, 0)\nvalve_position_limits::MinMax: Valve position limits in MW\nT4::Float64: Time Constant inlet steam, validation range: (0, 1)\nK1::Float64: Fraction of high presure shaft power, validation range: (-2, 1)\nK2::Float64: Fraction of low presure shaft power, validation range: (0, nothing)\nT5::Float64: Time constant for second boiler pass, validation range: (0, 10)\nK3::Float64: Fraction of high presure shaft power second boiler pass, validation range: (0, 0.5)\nK4::Float64: Fraction of low presure shaft power second boiler pass, validation range: (0, 0.5)\nT6::Float64: Time constant for third boiler pass, validation range: (0, 10)\nK5::Float64: Fraction of high presure shaft power third boiler pass, validation range: (0, 0.35)\nK6::Float64: Fraction of low presure shaft power third boiler pass, validation range: (0, 0.55)\nT7::Float64: Time constant for fourth boiler pass, validation range: (0, 10)\nK7::Float64: Fraction of high presure shaft power fourth boiler pass, validation range: (0, 0.3)\nK8::Float64: Fraction of low presure shaft power fourth boiler pass, validation range: (0, 0.3)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the IEEETurbineGov model are:\n\nx_g1: First Governor integrator,\nx_g2: Governor output,\nx_g3: First Turbine integrator, \nx_g4: Second Turbine Integrator, \nx_g5: Third Turbine Integrator, \nx_g6: Fourth Turbine Integrator,\n\nn_states::Int: (Do not modify.) IEEEG1 has 6 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEEG1 has 6 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K","text":"get_K(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K1-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K1","text":"get_K1(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K2-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K2","text":"get_K2(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K3-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K3","text":"get_K3(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K4-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K4","text":"get_K4(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K5-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K5","text":"get_K5(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K6-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K6","text":"get_K6(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K7-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K7","text":"get_K7(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_K8-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_K8","text":"get_K8(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 K8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T4-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T4","text":"get_T4(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T5-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T5","text":"get_T5(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T6-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T6","text":"get_T6(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T7-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T7","text":"get_T7(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_U0-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_U0","text":"get_U0(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 U0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_U_c-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_U_c","text":"get_U_c(value::IEEETurbineGov1) -> Float64\n\n\nGet IEEETurbineGov1 U_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::IEEETurbineGov1) -> Dict{String, Any}\n\n\nGet IEEETurbineGov1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::IEEETurbineGov1) -> Int64\n\n\nGet IEEETurbineGov1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::IEEETurbineGov1) -> Vector{Symbol}\n\n\nGet IEEETurbineGov1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(\n value::IEEETurbineGov1\n) -> Vector{StateTypes}\n\n\nGet IEEETurbineGov1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_valve_position_limits-Tuple{IEEETurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_valve_position_limits","text":"get_valve_position_limits(\n value::IEEETurbineGov1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet IEEETurbineGov1 valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K!","text":"set_K!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K1!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K1!","text":"set_K1!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K2!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K2!","text":"set_K2!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K3!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K3!","text":"set_K3!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K4!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K4!","text":"set_K4!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K5!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K5!","text":"set_K5!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K6!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K6!","text":"set_K6!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K7!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K7!","text":"set_K7!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_K8!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_K8!","text":"set_K8!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 K8.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T4!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T4!","text":"set_T4!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T5!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T5!","text":"set_T5!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T6!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T6!","text":"set_T6!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T6.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T7!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T7!","text":"set_T7!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 T7.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_U0!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_U0!","text":"set_U0!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 U0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_U_c!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_U_c!","text":"set_U_c!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 U_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::IEEETurbineGov1, val) -> Any\n\n\nSet IEEETurbineGov1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_valve_position_limits!-Tuple{IEEETurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_valve_position_limits!","text":"set_valve_position_limits!(\n value::IEEETurbineGov1,\n val\n) -> Any\n\n\nSet IEEETurbineGov1 valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PIDGOV","page":"TurbineGov","title":"PIDGOV","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/PIDGOV.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.PIDGOV","page":"TurbineGov","title":"PowerSystems.PIDGOV","text":"mutable struct PIDGOV <: TurbineGov\n feedback_flag::Int\n Rperm::Float64\n T_reg::Float64\n Kp::Float64\n Ki::Float64\n Kd::Float64\n Ta::Float64\n Tb::Float64\n D_turb::Float64\n gate_openings::Tuple{Float64, Float64, Float64}\n power_gate_openings::Tuple{Float64, Float64, Float64}\n G_lim::MinMax\n A_tw::Float64\n Tw::Float64\n V_lim::MinMax\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nHydro Turbine-Governor with PID controller.\n\nArguments\n\nfeedback_flag::Int: Feedback signal for governor droop: 0 for electrical power, and 1 for gate position., validation range: (0, 1)\nRperm::Float64: Speed permanent droop parameter, validation range: (0, nothing)\nT_reg::Float64: Speed detector time constant, validation range: (0, nothing)\nKp::Float64: Governor proportional gain, validation range: (0, nothing)\nKi::Float64: Governor integral gain, validation range: (0, nothing)\nKd::Float64: Governor derivative gain, validation range: (0, nothing)\nTa::Float64: Governor derivative time constant, validation range: (0, nothing)\nTb::Float64: Gate-servo time constant, validation range: (0, nothing)\nD_turb::Float64: Turbine damping factor, validation range: (0, nothing)\ngate_openings::Tuple{Float64, Float64, Float64}: Gate-opening speed at different loads\npower_gate_openings::Tuple{Float64, Float64, Float64}: Power at gate_openings\nG_lim::MinMax: Minimum/Maximum Gate openings (G_min, G_max).\nA_tw::Float64: Factor multiplying Tw, validation range: (eps(), nothing)\nTw::Float64: Water inertia time constant, sec, validation range: (eps(), nothing)\nV_lim::MinMax: Gate opening velocity limits (G_min, G_max).\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the PIDGOV model are:\n\nx_g1: Filtered input measurement,\nx_g2: PI block internal state,\nx_g3: First regulator state, \nx_g4: Derivative block internal state, \nx_g5: Second regulator state, \nx_g6: Gate position state, \nx_g7: Water inertia state\n\nn_states::Int: (Do not modify.) PIDGOV has 7 states\nstates_types::Vector{StateTypes}: (Do not modify.) PIDGOV has 7 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_A_tw-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_A_tw","text":"get_A_tw(value::PIDGOV) -> Float64\n\n\nGet PIDGOV A_tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D_turb-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_D_turb","text":"get_D_turb(value::PIDGOV) -> Float64\n\n\nGet PIDGOV D_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_G_lim-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_G_lim","text":"get_G_lim(\n value::PIDGOV\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet PIDGOV G_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kd-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Kd","text":"get_Kd(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Ki","text":"get_Ki(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kp-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Kp","text":"get_Kp(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::PIDGOV) -> Float64\n\n\nGet PIDGOV P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Rperm-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Rperm","text":"get_Rperm(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Rperm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_reg-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_T_reg","text":"get_T_reg(value::PIDGOV) -> Float64\n\n\nGet PIDGOV T_reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ta-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Ta","text":"get_Ta(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tb-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Tb","text":"get_Tb(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tw-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_Tw","text":"get_Tw(value::PIDGOV) -> Float64\n\n\nGet PIDGOV Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_V_lim-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_V_lim","text":"get_V_lim(\n value::PIDGOV\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet PIDGOV V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::PIDGOV) -> Dict{String, Any}\n\n\nGet PIDGOV ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_feedback_flag-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_feedback_flag","text":"get_feedback_flag(value::PIDGOV) -> Int64\n\n\nGet PIDGOV feedback_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_gate_openings-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_gate_openings","text":"get_gate_openings(\n value::PIDGOV\n) -> Tuple{Float64, Float64, Float64}\n\n\nGet PIDGOV gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::PIDGOV) -> Int64\n\n\nGet PIDGOV n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_power_gate_openings-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_power_gate_openings","text":"get_power_gate_openings(\n value::PIDGOV\n) -> Tuple{Float64, Float64, Float64}\n\n\nGet PIDGOV power_gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::PIDGOV) -> Vector{Symbol}\n\n\nGet PIDGOV states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{PIDGOV}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(value::PIDGOV) -> Vector{StateTypes}\n\n\nGet PIDGOV states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_A_tw!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_A_tw!","text":"set_A_tw!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV A_tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D_turb!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_D_turb!","text":"set_D_turb!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV D_turb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_G_lim!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_G_lim!","text":"set_G_lim!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV G_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kd!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kp!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Rperm!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Rperm!","text":"set_Rperm!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Rperm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_reg!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_T_reg!","text":"set_T_reg!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV T_reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ta!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tb!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tw!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_Tw!","text":"set_Tw!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_V_lim!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_feedback_flag!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_feedback_flag!","text":"set_feedback_flag!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV feedback_flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_gate_openings!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_gate_openings!","text":"set_gate_openings!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_power_gate_openings!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_power_gate_openings!","text":"set_power_gate_openings!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV power_gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{PIDGOV, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::PIDGOV, val) -> Any\n\n\nSet PIDGOV states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#SteamTurbineGov1","page":"TurbineGov","title":"SteamTurbineGov1","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/SteamTurbineGov1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.SteamTurbineGov1","page":"TurbineGov","title":"PowerSystems.SteamTurbineGov1","text":"mutable struct SteamTurbineGov1 <: TurbineGov\n R::Float64\n T1::Float64\n valve_position_limits::MinMax\n T2::Float64\n T3::Float64\n D_T::Float64\n DB_h::Float64\n DB_l::Float64\n T_rate::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nSteam Turbine-Governor. This model considers both TGOV1 or TGOV1DU in PSS/E\n\nArguments\n\nR::Float64: Droop parameter, validation range: (0, 0.1)\nT1::Float64: Governor time constant, validation range: (eps(), 0.5)\nvalve_position_limits::MinMax: Valve position limits\nT2::Float64: Lead Lag Lead Time constant , validation range: (0, nothing)\nT3::Float64: Lead Lag Lag Time constant , validation range: (eps(), 10)\nD_T::Float64: Turbine Damping, validation range: (0, 0.5)\nDB_h::Float64: Deadband for overspeed, validation range: (0, nothing)\nDB_l::Float64: Deadband for underspeed, validation range: (nothing, 0)\nT_rate::Float64: Turbine Rate (MW). If zero, generator base is used, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the SteamTurbineGov1 model are:\n\nx_g1: Valve Opening,\nx_g2: Lead-lag state\n\nn_states::Int: (Do not modify.) TGOV1 has 2 states\nstates_types::Vector{StateTypes}: (Do not modify.) TGOV1 has 2 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_DB_h-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_DB_h","text":"get_DB_h(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 DB_h.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_DB_l-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_DB_l","text":"get_DB_l(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 DB_l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D_T-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_D_T","text":"get_D_T(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 D_T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_rate-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_T_rate","text":"get_T_rate(value::SteamTurbineGov1) -> Float64\n\n\nGet SteamTurbineGov1 T_rate.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::SteamTurbineGov1) -> Dict{String, Any}\n\n\nGet SteamTurbineGov1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::SteamTurbineGov1) -> Int64\n\n\nGet SteamTurbineGov1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::SteamTurbineGov1) -> Vector{Symbol}\n\n\nGet SteamTurbineGov1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(\n value::SteamTurbineGov1\n) -> Vector{StateTypes}\n\n\nGet SteamTurbineGov1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_valve_position_limits-Tuple{SteamTurbineGov1}","page":"TurbineGov","title":"PowerSystems.get_valve_position_limits","text":"get_valve_position_limits(\n value::SteamTurbineGov1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet SteamTurbineGov1 valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_DB_h!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_DB_h!","text":"set_DB_h!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 DB_h.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_DB_l!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_DB_l!","text":"set_DB_l!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 DB_l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D_T!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_D_T!","text":"set_D_T!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 D_T.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_rate!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_T_rate!","text":"set_T_rate!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 T_rate.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::SteamTurbineGov1, val) -> Any\n\n\nSet SteamTurbineGov1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_valve_position_limits!-Tuple{SteamTurbineGov1, Any}","page":"TurbineGov","title":"PowerSystems.set_valve_position_limits!","text":"set_valve_position_limits!(\n value::SteamTurbineGov1,\n val\n) -> Any\n\n\nSet SteamTurbineGov1 valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TGFixed","page":"TurbineGov","title":"TGFixed","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/TGFixed.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.TGFixed","page":"TurbineGov","title":"PowerSystems.TGFixed","text":"mutable struct TGFixed <: TurbineGov\n efficiency::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a fixed Turbine Governor that returns a fixed mechanical torque given by the product of P_ref*efficiency\n\nArguments\n\nefficiency::Float64: Efficiency factor that multiplies P_ref, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) TGFixed has no states\nn_states::Int: (Do not modify.) TGFixed has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::TGFixed) -> Float64\n\n\nGet TGFixed P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_efficiency-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_efficiency","text":"get_efficiency(value::TGFixed) -> Float64\n\n\nGet TGFixed efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::TGFixed) -> Dict{String, Any}\n\n\nGet TGFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::TGFixed) -> Int64\n\n\nGet TGFixed n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{TGFixed}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::TGFixed) -> Vector{Symbol}\n\n\nGet TGFixed states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{TGFixed, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::TGFixed, val) -> Any\n\n\nSet TGFixed P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_efficiency!-Tuple{TGFixed, Any}","page":"TurbineGov","title":"PowerSystems.set_efficiency!","text":"set_efficiency!(value::TGFixed, val) -> Any\n\n\nSet TGFixed efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{TGFixed, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::TGFixed, val) -> Any\n\n\nSet TGFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TGSimple","page":"TurbineGov","title":"TGSimple","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/TGSimple.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.TGSimple","page":"TurbineGov","title":"PowerSystems.TGSimple","text":"mutable struct TGSimple <: TurbineGov\n d_t::Float64\n Tm::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Simple one-state Turbine Governor\n\nArguments\n\nd_t::Float64: Inverse Droop parameter, validation range: (0, nothing)\nTm::Float64: Turbine Governor Low-Pass Time Constant [s], validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the TGSimple model are:\n\nτm: mechanical torque\n\nn_states::Int: (Do not modify.) TGSimple has 1 state\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::TGSimple) -> Float64\n\n\nGet TGSimple P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tm-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_Tm","text":"get_Tm(value::TGSimple) -> Float64\n\n\nGet TGSimple Tm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_d_t-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_d_t","text":"get_d_t(value::TGSimple) -> Float64\n\n\nGet TGSimple d_t.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::TGSimple) -> Dict{String, Any}\n\n\nGet TGSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::TGSimple) -> Int64\n\n\nGet TGSimple n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{TGSimple}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::TGSimple) -> Vector{Symbol}\n\n\nGet TGSimple states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{TGSimple, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::TGSimple, val) -> Any\n\n\nSet TGSimple P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tm!-Tuple{TGSimple, Any}","page":"TurbineGov","title":"PowerSystems.set_Tm!","text":"set_Tm!(value::TGSimple, val) -> Any\n\n\nSet TGSimple Tm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_d_t!-Tuple{TGSimple, Any}","page":"TurbineGov","title":"PowerSystems.set_d_t!","text":"set_d_t!(value::TGSimple, val) -> Any\n\n\nSet TGSimple d_t.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{TGSimple, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::TGSimple, val) -> Any\n\n\nSet TGSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TGTypeI","page":"TurbineGov","title":"TGTypeI","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/TGTypeI.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.TGTypeI","page":"TurbineGov","title":"PowerSystems.TGTypeI","text":"mutable struct TGTypeI <: TurbineGov\n R::Float64\n Ts::Float64\n Tc::Float64\n T3::Float64\n T4::Float64\n T5::Float64\n valve_position_limits::MinMax\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Turbine Governor Type I\n\nArguments\n\nR::Float64: Droop parameter, validation range: (0, nothing)\nTs::Float64: Governor time constant, validation range: (0, nothing)\nTc::Float64: Servo time constant, validation range: (0, nothing)\nT3::Float64: Transient gain time constant, validation range: (0, nothing)\nT4::Float64: Power fraction time constant, validation range: (0, nothing)\nT5::Float64: Reheat time constant, validation range: (0, nothing)\nvalve_position_limits::MinMax: Valve position limits in MW\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the TGTypeI model are:\n\nx_g1: Governor state,\nx_g2: Servo state,\nx_g3: Reheat state\n\nn_states::Int: (Do not modify.) TGTypeI has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::TGTypeI) -> Float64\n\n\nGet TGTypeI P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::TGTypeI) -> Float64\n\n\nGet TGTypeI R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T3-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_T3","text":"get_T3(value::TGTypeI) -> Float64\n\n\nGet TGTypeI T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T4-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_T4","text":"get_T4(value::TGTypeI) -> Float64\n\n\nGet TGTypeI T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T5-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_T5","text":"get_T5(value::TGTypeI) -> Float64\n\n\nGet TGTypeI T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tc-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_Tc","text":"get_Tc(value::TGTypeI) -> Float64\n\n\nGet TGTypeI Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ts-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_Ts","text":"get_Ts(value::TGTypeI) -> Float64\n\n\nGet TGTypeI Ts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::TGTypeI) -> Dict{String, Any}\n\n\nGet TGTypeI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::TGTypeI) -> Int64\n\n\nGet TGTypeI n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::TGTypeI) -> Vector{Symbol}\n\n\nGet TGTypeI states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_valve_position_limits-Tuple{TGTypeI}","page":"TurbineGov","title":"PowerSystems.get_valve_position_limits","text":"get_valve_position_limits(\n value::TGTypeI\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TGTypeI valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T3!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_T3!","text":"set_T3!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T4!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_T4!","text":"set_T4!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T5!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_T5!","text":"set_T5!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tc!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ts!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_Ts!","text":"set_Ts!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI Ts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_valve_position_limits!-Tuple{TGTypeI, Any}","page":"TurbineGov","title":"PowerSystems.set_valve_position_limits!","text":"set_valve_position_limits!(value::TGTypeI, val) -> Any\n\n\nSet TGTypeI valve_position_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#TGTypeII","page":"TurbineGov","title":"TGTypeII","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/TGTypeII.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.TGTypeII","page":"TurbineGov","title":"PowerSystems.TGTypeII","text":"mutable struct TGTypeII <: TurbineGov\n R::Float64\n T1::Float64\n T2::Float64\n τ_limits::MinMax\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Turbine Governor Type II\n\nArguments\n\nR::Float64: Droop parameter, validation range: (0, nothing)\nT1::Float64: Transient gain time constant, validation range: (0, nothing)\nT2::Float64: Power fraction time constant, validation range: (0, nothing)\nτ_limits::MinMax: Power into the governor limits\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the TGTypeI model are:\n\nx_g1: lead-lag state\n\nn_states::Int: (Do not modify.) TGTypeII has 1 state\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::TGTypeII) -> Float64\n\n\nGet TGTypeII P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_R-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_R","text":"get_R(value::TGTypeII) -> Float64\n\n\nGet TGTypeII R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T1-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_T1","text":"get_T1(value::TGTypeII) -> Float64\n\n\nGet TGTypeII T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T2-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_T2","text":"get_T2(value::TGTypeII) -> Float64\n\n\nGet TGTypeII T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::TGTypeII) -> Dict{String, Any}\n\n\nGet TGTypeII ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::TGTypeII) -> Int64\n\n\nGet TGTypeII n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::TGTypeII) -> Vector{Symbol}\n\n\nGet TGTypeII states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_τ_limits-Tuple{TGTypeII}","page":"TurbineGov","title":"PowerSystems.get_τ_limits","text":"get_τ_limits(\n value::TGTypeII\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TGTypeII τ_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_R!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_R!","text":"set_R!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII R.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T1!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_T1!","text":"set_T1!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T2!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_T2!","text":"set_T2!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_τ_limits!-Tuple{TGTypeII, Any}","page":"TurbineGov","title":"PowerSystems.set_τ_limits!","text":"set_τ_limits!(value::TGTypeII, val) -> Any\n\n\nSet TGTypeII τ_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#WPIDHY","page":"TurbineGov","title":"WPIDHY","text":"","category":"section"},{"location":"model_library/generated_TurbineGov/","page":"TurbineGov","title":"TurbineGov","text":"Modules = [PowerSystems]\nPages = [\"/WPIDHY.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TurbineGov/#PowerSystems.WPIDHY","page":"TurbineGov","title":"PowerSystems.WPIDHY","text":"mutable struct WPIDHY <: TurbineGov\n T_reg::Float64\n reg::Float64\n Kp::Float64\n Ki::Float64\n Kd::Float64\n Ta::Float64\n Tb::Float64\n V_lim::MinMax\n G_lim::MinMax\n Tw::Float64\n P_lim::MinMax\n D::Float64\n gate_openings::Tuple{Float64, Float64, Float64}\n power_gate_openings::Tuple{Float64, Float64, Float64}\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nWoodward PID Hydro Governor\n\nArguments\n\nT_reg::Float64: Input time constant of the governor in s, validation range: (0, nothing)\nreg::Float64: Input governor gain, validation range: (0, nothing)\nKp::Float64: Governor proportional gain, validation range: (0, nothing)\nKi::Float64: Governor integral gain, validation range: (0, nothing)\nKd::Float64: Governor derivative gain, validation range: (0, nothing)\nTa::Float64: Governor derivative/high-frequency time constant, validation range: (0, nothing)\nTb::Float64: Gate-servo time constant, validation range: (0, nothing)\nV_lim::MinMax: Gate opening velocity limits (G_min, G_max).\nG_lim::MinMax: Minimum/Maximum Gate velocity (G_min, G_max).\nTw::Float64: Water inertia time constant, sec, validation range: (eps(), nothing)\nP_lim::MinMax: Minimum/Maximum Gate openings (P_min, P_max).\nD::Float64: Turbine damping coefficient, validation range: (0, nothing)\ngate_openings::Tuple{Float64, Float64, Float64}: Gate-opening speed at different loads\npower_gate_openings::Tuple{Float64, Float64, Float64}: Power at gate_openings\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the PIDGOV model are:\n\nx_g1: Filtered input measurement,\nx_g2: PI block internal state,\nx_g3: First regulator state, \nx_g4: Derivative block internal state, \nx_g5: Second regulator state, \nx_g6: Gate position state, \nx_g7: Water inertia state\n\nn_states::Int: (Do not modify.) PIDGOV has 7 states\nstates_types::Vector{StateTypes}: (Do not modify.) PIDGOV has 7 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_D-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_D","text":"get_D(value::WPIDHY) -> Float64\n\n\nGet WPIDHY D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_G_lim-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_G_lim","text":"get_G_lim(\n value::WPIDHY\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet WPIDHY G_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kd-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Kd","text":"get_Kd(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ki-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Ki","text":"get_Ki(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Kp-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Kp","text":"get_Kp(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_lim-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_P_lim","text":"get_P_lim(\n value::WPIDHY\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet WPIDHY P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_P_ref-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::WPIDHY) -> Float64\n\n\nGet WPIDHY P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_T_reg-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_T_reg","text":"get_T_reg(value::WPIDHY) -> Float64\n\n\nGet WPIDHY T_reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Ta-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Ta","text":"get_Ta(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tb-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Tb","text":"get_Tb(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_Tw-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_Tw","text":"get_Tw(value::WPIDHY) -> Float64\n\n\nGet WPIDHY Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_V_lim-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_V_lim","text":"get_V_lim(\n value::WPIDHY\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet WPIDHY V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_ext-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_ext","text":"get_ext(value::WPIDHY) -> Dict{String, Any}\n\n\nGet WPIDHY ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_gate_openings-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_gate_openings","text":"get_gate_openings(\n value::WPIDHY\n) -> Tuple{Float64, Float64, Float64}\n\n\nGet WPIDHY gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_n_states-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_n_states","text":"get_n_states(value::WPIDHY) -> Int64\n\n\nGet WPIDHY n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_power_gate_openings-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_power_gate_openings","text":"get_power_gate_openings(\n value::WPIDHY\n) -> Tuple{Float64, Float64, Float64}\n\n\nGet WPIDHY power_gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_reg-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_reg","text":"get_reg(value::WPIDHY) -> Float64\n\n\nGet WPIDHY reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_states","text":"get_states(value::WPIDHY) -> Vector{Symbol}\n\n\nGet WPIDHY states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.get_states_types-Tuple{WPIDHY}","page":"TurbineGov","title":"PowerSystems.get_states_types","text":"get_states_types(value::WPIDHY) -> Vector{StateTypes}\n\n\nGet WPIDHY states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_D!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_D!","text":"set_D!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_G_lim!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_G_lim!","text":"set_G_lim!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY G_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kd!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ki!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Kp!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_lim!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_P_lim!","text":"set_P_lim!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_P_ref!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_T_reg!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_T_reg!","text":"set_T_reg!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY T_reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Ta!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tb!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_Tw!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_Tw!","text":"set_Tw!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY Tw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_V_lim!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_ext!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_ext!","text":"set_ext!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_gate_openings!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_gate_openings!","text":"set_gate_openings!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_power_gate_openings!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_power_gate_openings!","text":"set_power_gate_openings!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY power_gate_openings.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_reg!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_reg!","text":"set_reg!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY reg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TurbineGov/#PowerSystems.set_states_types!-Tuple{WPIDHY, Any}","page":"TurbineGov","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::WPIDHY, val) -> Any\n\n\nSet WPIDHY states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/renewable_generation_cost/#RenewableGenerationCost","page":"RenewableGenerationCost","title":"RenewableGenerationCost","text":"","category":"section"},{"location":"model_library/renewable_generation_cost/","page":"RenewableGenerationCost","title":"RenewableGenerationCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/RenewableGenerationCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/renewable_generation_cost/#PowerSystems.RenewableGenerationCost","page":"RenewableGenerationCost","title":"PowerSystems.RenewableGenerationCost","text":"mutable struct RenewableGenerationCost <: OperationalCost\n\nvariable::CostCurve: Variable cost represented as a CostCurve\ncurtailment_cost::CostCurve: (default of 0) Cost of curtailing power represented as a CostCurve\n\nRenewableGenerationCost(variable, curtailment_cost)\nRenewableGenerationCost(variable; curtailment_cost)\nRenewableGenerationCost(; variable, curtailment_cost)\n\nAn 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.\n\nThe variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.\n\n\n\n\n\n","category":"type"},{"location":"model_library/renewable_generation_cost/#PowerSystems.get_curtailment_cost-Tuple{RenewableGenerationCost}","page":"RenewableGenerationCost","title":"PowerSystems.get_curtailment_cost","text":"get_curtailment_cost(\n value::RenewableGenerationCost\n) -> CostCurve\n\n\nGet RenewableGenerationCost curtailment_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/renewable_generation_cost/#PowerSystems.get_variable-Tuple{RenewableGenerationCost}","page":"RenewableGenerationCost","title":"PowerSystems.get_variable","text":"get_variable(value::RenewableGenerationCost) -> CostCurve\n\n\nGet RenewableGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/renewable_generation_cost/#PowerSystems.set_curtailment_cost!-Tuple{RenewableGenerationCost, Any}","page":"RenewableGenerationCost","title":"PowerSystems.set_curtailment_cost!","text":"set_curtailment_cost!(\n value::RenewableGenerationCost,\n val\n) -> Any\n\n\nSet RenewableGenerationCost curtailment_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/renewable_generation_cost/#PowerSystems.set_variable!-Tuple{RenewableGenerationCost, Any}","page":"RenewableGenerationCost","title":"PowerSystems.set_variable!","text":"set_variable!(value::RenewableGenerationCost, val) -> Any\n\n\nSet RenewableGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"api/type_tree/#Type-Hierarchy","page":"Type Hierarchy","title":"Type Hierarchy","text":"","category":"section"},{"location":"api/type_tree/","page":"Type Hierarchy","title":"Type Hierarchy","text":"Here is the complete PowerSystems.jl type hierarchy:","category":"page"},{"location":"api/type_tree/","page":"Type Hierarchy","title":"Type Hierarchy","text":"using PowerSystems #hide\nimport TypeTree: tt #hide\ndocs_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"utils\"); #hide\ninclude(joinpath(docs_dir, \"docs_utils.jl\")); #hide\nprint(join(tt(PowerSystems.IS.InfrastructureSystemsType), \"\")) #hide","category":"page"},{"location":"model_library/generated_HydroDispatch/#HydroDispatch","page":"HydroDispatch","title":"HydroDispatch","text":"","category":"section"},{"location":"model_library/generated_HydroDispatch/","page":"HydroDispatch","title":"HydroDispatch","text":"Modules = [PowerSystems]\nPages = [\"generated/HydroDispatch.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.HydroDispatch","page":"HydroDispatch","title":"PowerSystems.HydroDispatch","text":"mutable struct HydroDispatch <: HydroGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n time_limits::Union{Nothing, UpDown}\n base_power::Float64\n operation_cost::Union{HydroGenerationCost, MarketBidCost}\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA hydropower generator without a reservoir, suitable for modeling run-of-river hydropower.\n\nFor hydro generators with an upper reservoir, see HydroEnergyReservoir\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\noperation_cost::Union{HydroGenerationCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_HydroDispatch/#InfrastructureSystems.get_name-Tuple{HydroDispatch}","page":"HydroDispatch","title":"InfrastructureSystems.get_name","text":"get_name(value::HydroDispatch) -> String\n\n\nGet HydroDispatch name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_active_power-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_active_power","text":"get_active_power(value::HydroDispatch) -> Any\n\n\nGet HydroDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_active_power_limits-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::HydroDispatch\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet HydroDispatch active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_available-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_available","text":"get_available(value::HydroDispatch) -> Bool\n\n\nGet HydroDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_base_power-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_base_power","text":"get_base_power(value::HydroDispatch) -> Float64\n\n\nGet HydroDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_bus-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_bus","text":"get_bus(value::HydroDispatch) -> ACBus\n\n\nGet HydroDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_dynamic_injector-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::HydroDispatch\n) -> Union{Nothing, DynamicInjection}\n\n\nGet HydroDispatch dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_ext-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_ext","text":"get_ext(value::HydroDispatch) -> Dict{String, Any}\n\n\nGet HydroDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_operation_cost-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::HydroDispatch\n) -> Union{HydroGenerationCost, MarketBidCost}\n\n\nGet HydroDispatch operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_prime_mover_type-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(value::HydroDispatch) -> PrimeMovers\n\n\nGet HydroDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_ramp_limits-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::HydroDispatch\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet HydroDispatch ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_rating-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_rating","text":"get_rating(value::HydroDispatch) -> Any\n\n\nGet HydroDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_reactive_power-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::HydroDispatch) -> Any\n\n\nGet HydroDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_reactive_power_limits-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::HydroDispatch\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HydroDispatch reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_services-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_services","text":"get_services(value::HydroDispatch) -> Vector{Service}\n\n\nGet HydroDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.get_time_limits-Tuple{HydroDispatch}","page":"HydroDispatch","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::HydroDispatch\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet HydroDispatch time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_active_power!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_active_power_limits!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_available!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_available!","text":"set_available!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_base_power!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_bus!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_bus!","text":"set_bus!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_ext!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_ext!","text":"set_ext!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_operation_cost!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_prime_mover_type!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_ramp_limits!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_rating!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_rating!","text":"set_rating!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_reactive_power!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_reactive_power_limits!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_services!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_services!","text":"set_services!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroDispatch/#PowerSystems.set_time_limits!-Tuple{HydroDispatch, Any}","page":"HydroDispatch","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::HydroDispatch, val) -> Any\n\n\nSet HydroDispatch time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#Line","page":"Line","title":"Line","text":"","category":"section"},{"location":"model_library/generated_Line/","page":"Line","title":"Line","text":"Modules = [PowerSystems]\nPages = [\"generated/Line.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Line/#PowerSystems.Line","page":"Line","title":"PowerSystems.Line","text":"mutable struct Line <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n b::FromTo\n rating::Float64\n angle_limits::MinMax\n g::FromTo\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn AC transmission line\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow on the line (MVAR)\narc::Arc: An Arc defining this line from a bus to another bus\nr::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)\nx::Float64: Reactance in pu (SYSTEM_BASE), validation range: (0, 4)\nb::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)\nrating::Float64: Thermal rating (MVA). Flow on the line must be between -rating and rating. When defining a line before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to\nangle_limits::MinMax: Minimum and maximum angle limits (radians), validation range: (-1.571, 1.571)\ng::FromTo: (default: (from=0.0, to=0.0)) Shunt conductance 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)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Line/#InfrastructureSystems.get_name-Tuple{Line}","page":"Line","title":"InfrastructureSystems.get_name","text":"get_name(value::Line) -> String\n\n\nGet Line name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_active_power_flow-Tuple{Line}","page":"Line","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::Line) -> Any\n\n\nGet Line active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_angle_limits-Tuple{Line}","page":"Line","title":"PowerSystems.get_angle_limits","text":"get_angle_limits(\n value::Line\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet Line angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_arc-Tuple{Line}","page":"Line","title":"PowerSystems.get_arc","text":"get_arc(value::Line) -> Arc\n\n\nGet Line arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_available-Tuple{Line}","page":"Line","title":"PowerSystems.get_available","text":"get_available(value::Line) -> Bool\n\n\nGet Line available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_b-Tuple{Line}","page":"Line","title":"PowerSystems.get_b","text":"get_b(\n value::Line\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet Line b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_ext-Tuple{Line}","page":"Line","title":"PowerSystems.get_ext","text":"get_ext(value::Line) -> Dict{String, Any}\n\n\nGet Line ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_g-Tuple{Line}","page":"Line","title":"PowerSystems.get_g","text":"get_g(\n value::Line\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet Line g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_r-Tuple{Line}","page":"Line","title":"PowerSystems.get_r","text":"get_r(value::Line) -> Float64\n\n\nGet Line r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_rating-Tuple{Line}","page":"Line","title":"PowerSystems.get_rating","text":"get_rating(value::Line) -> Any\n\n\nGet Line rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_reactive_power_flow-Tuple{Line}","page":"Line","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::Line) -> Any\n\n\nGet Line reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_services-Tuple{Line}","page":"Line","title":"PowerSystems.get_services","text":"get_services(value::Line) -> Vector{Service}\n\n\nGet Line services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.get_x-Tuple{Line}","page":"Line","title":"PowerSystems.get_x","text":"get_x(value::Line) -> Float64\n\n\nGet Line x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_active_power_flow!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::Line, val) -> Any\n\n\nSet Line active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_angle_limits!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_angle_limits!","text":"set_angle_limits!(value::Line, val) -> Any\n\n\nSet Line angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_arc!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_arc!","text":"set_arc!(value::Line, val) -> Any\n\n\nSet Line arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_available!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_available!","text":"set_available!(value::Line, val) -> Any\n\n\nSet Line available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_b!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_b!","text":"set_b!(value::Line, val) -> Any\n\n\nSet Line b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_ext!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_ext!","text":"set_ext!(value::Line, val) -> Any\n\n\nSet Line ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_g!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_g!","text":"set_g!(value::Line, val) -> Any\n\n\nSet Line g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_r!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_r!","text":"set_r!(value::Line, val) -> Any\n\n\nSet Line r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_rating!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_rating!","text":"set_rating!(value::Line, val) -> Any\n\n\nSet Line rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_reactive_power_flow!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(value::Line, val) -> Any\n\n\nSet Line reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_services!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_services!","text":"set_services!(value::Line, val) -> Any\n\n\nSet Line services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Line/#PowerSystems.set_x!-Tuple{Line, Any}","page":"Line","title":"PowerSystems.set_x!","text":"set_x!(value::Line, val) -> Any\n\n\nSet Line x.\n\n\n\n\n\n","category":"method"},{"location":"explanation/per_unit/#per_unit","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"","category":"section"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"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:","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"\"NATURAL_UNITS\": The naturally defined units of each parameter (typically MW).\n\"SYSTEM_BASE\": Parameter values are divided by the system base_power.\n\"DEVICE_BASE\": Parameter values are divided by the device base_power.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"PowerSystems.jl supports these unit systems because different power system tools and data sets use different units systems by convention, such as:","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"Dynamics data is often defined in device base\nNetwork data (e.g., reactance, resistance) is often defined in system base\nProduction cost modeling data is often gathered from variety of data sources, which are typically defined in natural units","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"These three unit bases allow easy conversion between unit systems. This allows PowerSystems.jl users to input data in the formats they have available, as well as view data in the unit system that is most intuitive to them.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"You can get and set the unit system setting of a System with get_units_base and set_units_base_system!.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"Conversion between unit systems does not change the stored parameter values. Instead, unit system conversions are made when accessing parameters using the accessor functions, thus making it imperative to utilize the accessor functions instead of the \"dot\" accessor methods to ensure the return of the correct values. The units of the parameter values stored in each struct are defined in src/descriptors/power_system_structs.json.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"There are some unit system conventions in PowerSystems.jl when defining new components. Currently, when you define components that aren't attached to a System, you must define all fields in \"DEVICE_BASE\", except for certain components that don't have their own base_power rating, such as Lines, where the rating must be defined in \"SYSTEM_BASE\".","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"In the future, PowerSystems.jl hopes to support defining components in natural units. For now, if you want to define data in natural units, you must first set the system units to \"NATURAL_UNITS\", define an empty component, and then use the accessor functions (e.g., getters and setters), to define each field within the component. The accessor functions will then do the data conversion from your input data in natural units (e.g., MW or MVA) to per-unit.","category":"page"},{"location":"explanation/per_unit/","page":"Per-unit Conventions","title":"Per-unit Conventions","text":"By default, PowerSystems.jl uses \"SYSTEM_BASE\" because many optimization problems won't converge when using natural units. If you change the unit setting, it's suggested that you switch back to \"SYSTEM_BASE\" before solving an optimization problem (for example in PowerSimulations.jl).","category":"page"},{"location":"model_library/generated_Arc/#Arc","page":"Arc","title":"Arc","text":"","category":"section"},{"location":"model_library/generated_Arc/","page":"Arc","title":"Arc","text":"Modules = [PowerSystems]\nPages = [\"generated/Arc.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Arc/#PowerSystems.Arc","page":"Arc","title":"PowerSystems.Arc","text":"mutable struct Arc <: Topology\n from::Bus\n to::Bus\n internal::InfrastructureSystemsInternal\nend\n\nA topological directed edge connecting two buses.\n\nArcs are used to define the from and to buses when defining a line or transformer\n\nArguments\n\nfrom::Bus: The initial bus\nto::Bus: The terminal bus\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Arc/#PowerSystems.get_from-Tuple{Arc}","page":"Arc","title":"PowerSystems.get_from","text":"get_from(value::Arc) -> Bus\n\n\nGet Arc from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Arc/#PowerSystems.get_to-Tuple{Arc}","page":"Arc","title":"PowerSystems.get_to","text":"get_to(value::Arc) -> Bus\n\n\nGet Arc to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Arc/#PowerSystems.set_from!-Tuple{Arc, Any}","page":"Arc","title":"PowerSystems.set_from!","text":"set_from!(value::Arc, val) -> Any\n\n\nSet Arc from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Arc/#PowerSystems.set_to!-Tuple{Arc, Any}","page":"Arc","title":"PowerSystems.set_to!","text":"set_to!(value::Arc, val) -> Any\n\n\nSet Arc to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#InterruptiblePowerLoad","page":"InterruptiblePowerLoad","title":"InterruptiblePowerLoad","text":"","category":"section"},{"location":"model_library/generated_InterruptiblePowerLoad/","page":"InterruptiblePowerLoad","title":"InterruptiblePowerLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/InterruptiblePowerLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.InterruptiblePowerLoad","page":"InterruptiblePowerLoad","title":"PowerSystems.InterruptiblePowerLoad","text":"mutable struct InterruptiblePowerLoad <: ControllableLoad\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n max_active_power::Float64\n max_reactive_power::Float64\n base_power::Float64\n operation_cost::Union{LoadCost, MarketBidCost}\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA static power load that can be compensated for temporary or continuous interruptions to its requested demand.\n\nThese 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_power::Float64: Initial steady state active power demand (MW)\nreactive_power::Float64: Initial steady state reactive power demand (MVAR)\nmax_active_power::Float64: Maximum active power (MW) that this load can demand\nmax_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand\nbase_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)\noperation_cost::Union{LoadCost, MarketBidCost}: OperationalCost of interrupting load\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InterruptiblePowerLoad/#InfrastructureSystems.get_name-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::InterruptiblePowerLoad) -> String\n\n\nGet InterruptiblePowerLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_active_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_active_power","text":"get_active_power(value::InterruptiblePowerLoad) -> Any\n\n\nGet InterruptiblePowerLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_available-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_available","text":"get_available(value::InterruptiblePowerLoad) -> Bool\n\n\nGet InterruptiblePowerLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_base_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::InterruptiblePowerLoad) -> Float64\n\n\nGet InterruptiblePowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_bus-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_bus","text":"get_bus(value::InterruptiblePowerLoad) -> ACBus\n\n\nGet InterruptiblePowerLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_dynamic_injector-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::InterruptiblePowerLoad\n) -> Union{Nothing, DynamicInjection}\n\n\nGet InterruptiblePowerLoad dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_ext-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_ext","text":"get_ext(value::InterruptiblePowerLoad) -> Dict{String, Any}\n\n\nGet InterruptiblePowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_max_active_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(value::InterruptiblePowerLoad) -> Any\n\n\nGet InterruptiblePowerLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_max_reactive_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(value::InterruptiblePowerLoad) -> Any\n\n\nGet InterruptiblePowerLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_operation_cost-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::InterruptiblePowerLoad\n) -> Union{LoadCost, MarketBidCost}\n\n\nGet InterruptiblePowerLoad operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_reactive_power-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::InterruptiblePowerLoad) -> Any\n\n\nGet InterruptiblePowerLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.get_services-Tuple{InterruptiblePowerLoad}","page":"InterruptiblePowerLoad","title":"PowerSystems.get_services","text":"get_services(\n value::InterruptiblePowerLoad\n) -> Vector{Service}\n\n\nGet InterruptiblePowerLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_active_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_available!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_available!","text":"set_available!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_base_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_bus!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_bus!","text":"set_bus!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_ext!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_max_active_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_max_active_power!","text":"set_max_active_power!(\n value::InterruptiblePowerLoad,\n val\n) -> Any\n\n\nSet InterruptiblePowerLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_max_reactive_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_max_reactive_power!","text":"set_max_reactive_power!(\n value::InterruptiblePowerLoad,\n val\n) -> Any\n\n\nSet InterruptiblePowerLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_operation_cost!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(\n value::InterruptiblePowerLoad,\n val\n) -> Any\n\n\nSet InterruptiblePowerLoad operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_reactive_power!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(\n value::InterruptiblePowerLoad,\n val\n) -> Any\n\n\nSet InterruptiblePowerLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterruptiblePowerLoad/#PowerSystems.set_services!-Tuple{InterruptiblePowerLoad, Any}","page":"InterruptiblePowerLoad","title":"PowerSystems.set_services!","text":"set_services!(value::InterruptiblePowerLoad, val) -> Any\n\n\nSet InterruptiblePowerLoad services.\n\n\n\n\n\n","category":"method"},{"location":"explanation/time_series/#ts_data","page":"Time Series Data","title":"Time Series Data","text":"","category":"section"},{"location":"explanation/time_series/#Categories-of-Time-Series","page":"Time Series Data","title":"Categories of Time Series","text":"","category":"section"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"The bulk of the data in many power system models is time series data. Given the potential complexity, PowerSystems.jl has a set of definitions to organize this data and enable consistent modeling.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"PowerSystems.jl supports two categories of time series data depending on the process to obtain the data and its interpretation:","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Static Time Series Data\nForecasts","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"These categories are are all subtypes of TimeSeriesData and fall within this time series type hierarchy:","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"using PowerSystems #hide\nimport TypeTree: tt #hide\ndocs_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"utils\"); #hide\ninclude(joinpath(docs_dir, \"docs_utils.jl\")); #hide\nprint(join(tt(TimeSeriesData), \"\")) #hide","category":"page"},{"location":"explanation/time_series/#Static-Time-Series-Data","page":"Time Series Data","title":"Static Time Series Data","text":"","category":"section"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"A static time series data is a single column of data where each time period has a single value assigned to a component field, such as its maximum active power. This data commonly is obtained from historical information or the realization of a time-varying quantity.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Static time series usually comes in the following format, with a set resolution between the time-stamps:","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"DateTime Value\n2020-09-01T00:00:00 100.0\n2020-09-01T01:00:00 101.0\n2020-09-01T02:00:00 99.0","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"This example is a 1-hour resolution static time-series.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"In PowerSystems, a static time series is represented using SingleTimeSeries.","category":"page"},{"location":"explanation/time_series/#Forecasts","page":"Time Series Data","title":"Forecasts","text":"","category":"section"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"A forecast time series includes predicted values of a time-varying quantity that commonly includes a look-ahead window 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.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Key forecast format parameters are the forecast resolution, the interval of time between forecast initial times, and the number of forecast windows (or forecasted values) in the forecast horizon.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Forecast data usually comes in the following format, where a column represents the time stamp associated with the initial time of the forecast, and the remaining columns represent the forecasted values at each step in the forecast horizon.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"DateTime 0 1 2 3 4 5 6 7\n2020-09-01T00:00:00 100.0 101.0 101.3 90.0 98.0 87.0 88.0 67.0\n2020-09-01T01:00:00 101.0 101.3 99.0 98.0 88.9 88.3 67.1 89.4\n2020-09-01T02:00:00 99.0 67.0 89.0 99.9 100.0 101.0 112.0 101.3","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"This example forecast has a interval of 1 hour and a horizon of 8.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"PowerSystems defines the following Julia structs to represent forecasts:","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Deterministic: Point forecast without any uncertainty representation.\nProbabilistic: Stores a discretized cumulative distribution functions (CDFs) or probability distribution functions (PDFs) at each time step in the look-ahead window.\nScenarios: Stores a set of probable trajectories for forecasted quantity with equal probability.","category":"page"},{"location":"explanation/time_series/#Data-Storage","page":"Time Series Data","title":"Data Storage","text":"","category":"section"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"By default PowerSystems stores time series data in an HDF5 file. This prevents large datasets from overwhelming system memory. Refer to this page for details on how the time series data is stored in HDF5 files.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Time series data can be stored actual component values (for instance MW) or scaling factors intended to be multiplied by a scalar to generate the component values. By default PowerSystems treats the values in the time series data as physical units. In order to specify them as scaling factors, you must pass the accessor function that provides the multiplier value (e.g., get_time_series_array). The scaling factor multiplier must be passed into the forecast when you create it to use this option.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"The time series contains fields for scaling_factor_multiplier and data to identify the details of th Component field that the time series describes, and the time series data. For example: we commonly want to use a time series to describe the maximum active power capability of a renewable generator. In this case, we can create a SingleTimeSeries with a TimeArray and an accessor function to the maximum active power field in the struct describing the generator. In this way, we can store a scaling factor time series that will get multiplied by the maximum active power rather than the magnitudes of the maximum active power time series.","category":"page"},{"location":"explanation/time_series/","page":"Time Series Data","title":"Time Series Data","text":"Examples of how to create and add time series to system can be found in the Add Time Series Example","category":"page"},{"location":"how_to/adding_additional_fields/#additional_fields","page":"...add additional data to a component","title":"Adding additional data to a component","text":"","category":"section"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"All PowerSystems.jl components have an ext field that contains an empty Dictionary. This Dictionary is useful to contain additional required data where there is no need to create new behaviors with that data. A simple example is the addition of geographic information, if needed.","category":"page"},{"location":"how_to/adding_additional_fields/#Example","page":"...add additional data to a component","title":"Example","text":"","category":"section"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"using PowerSystems #hide\nusing PowerSystemCaseBuilder #hide\nsystem = build_system(PSISystems, \"modified_RTS_GMLC_DA_sys\"); #hide","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"Step 1: Use get_ext to get the ext field of the desired components and assign your data:","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"for g in get_components(ThermalStandard, system)\n external_field = get_ext(g)\n external_field[\"my_data\"] = 1.0\nend","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"Here, we added additional data called my_data to the ThermalStandard generators in a previously defined System.","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"Step 2: Retrieve your data using get_ext again","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"First, retrieve the first ThermalStandard generator:","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"gen = collect(get_components(ThermalStandard, system))[1];","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"Then, retrieve my_data from the generator and verify it is 1.0, as assigned.","category":"page"},{"location":"how_to/adding_additional_fields/","page":"...add additional data to a component","title":"...add additional data to a component","text":"retrieved_data = get_ext(gen)[\"my_data\"]","category":"page"},{"location":"how_to/add_new_types/#Add-a-New-or-Custom-Type","page":"...customize or add a new Type","title":"Add a New or Custom Type","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"This page describes how developers should add types to PowerSystems.jl","category":"page"},{"location":"how_to/add_new_types/#Type-Hierarchy","page":"...customize or add a new Type","title":"Type Hierarchy","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"All structs that correlate to power system components must be subtypes of the Component abstract type. Browse its type hierachy to choose an appropriate supertype for your new struct.","category":"page"},{"location":"how_to/add_new_types/#Interfaces","page":"...customize or add a new Type","title":"Interfaces","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Refer to the managing components guide for component requirements.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"In particular, please note the methods supports_time_series (default = false) and supports_supplemental_attributes (default = true) that you may need to implement.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Note: get_internal and get_name are imported into PowerSystems, so you should implement your methods as PowerSystems methods.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Some abstract types define required interface functions in docstring. Be sure to implement each of them for your new type.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Formalized documentation for each abstract type is TBD.","category":"page"},{"location":"how_to/add_new_types/#Specialize-an-Existing-Type","page":"...customize or add a new Type","title":"Specialize an Existing Type","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"There are scenarios where you may want to make a new type that is identical to an existing type except for one attribute or behavior, and don't want to duplicate the entire existing type and methods. In programming languages that support inheritance you would derive a new class from the existing class and automatically inherit its fields and methods. Julia doesn't support that. However, you can achieve a similar result with a forwarding macro. The basic idea is that you include the existing type within your struct and then use a macro to automatically forward specific methods to that instance.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"A few PowerSystems structs use the macro InfrastructureSystems.@forward to do this. Refer to the struct RoundRotorQuadratic for an example of how to use this.","category":"page"},{"location":"how_to/add_new_types/#Custom-Rules","page":"...customize or add a new Type","title":"Custom Rules","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Some types require special checks before they can be added to or removed from a system. One example is the case where a component includes another component that is also stored in the system. We must ensure that the parent component does not contain a reference to another component that is not already attached to the system.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Similarly, if the child object is removed from the system we must also remove the parent's reference to that child.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The source file src/base.jl provides functions that you can implement for your new type to manage these scenarios.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"check_component_addition(sys::System, component::Component; kwargs...)\nhandle_component_addition!(sys::System, component::Component; kwargs...)\ncheck_component_removal(sys::System, component::Component; kwargs...)\nhandle_component_removal!(sys::System, component::Component; kwargs...)","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The functions add_component!() and remove_component!() call the check function before performing actions and then call the handle function afterwards. The default behavior of these functions is to do nothing. Implement versions that take your type in order to add your own checks or perform additional actions.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Beware of the condition where a custom method is already implemented for a supertype of your type.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Note that you can call the helper functions is_attached(component, system) and throw_if_not_attached(component, system).","category":"page"},{"location":"how_to/add_new_types/#Custom-Validation","page":"...customize or add a new Type","title":"Custom Validation","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"You can implement three methods to perform custom validation or correction for your type. PowerSystems calls all of these functions in add_component!.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"sanitize_component!(component::Component, sys::System): intended to make standard data corrections (e.g. voltage angle in degrees -> radians)\nvalidate_component(component::Component): intended to check component field values for internal consistency\nvalidate_component_with_system(component::Component, sys::System): intended to check component field values for consistency with system","category":"page"},{"location":"how_to/add_new_types/#Struct-Requirements-for-Serialization-of-custom-components","page":"...customize or add a new Type","title":"Struct Requirements for Serialization of custom components","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"One key feature of PowerSystems.jl is the serialization capabilities. Supporting serialization and de-serialization of custom components requires the implementation of several methods. The serialization code converts structs to dictionaries where the struct fields become dictionary keys.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The code imposes these requirements:","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The InfrastructureSystems methods serialize and deserialize must be implemented for the struct. InfrastructureSystems implements a method that covers all subtypes of InfrastructureSystemsType. All PowerSystems components should be subtypes of PowerSystems.Component which is a subtype InfrastructureSystemsType, so any new structs should be covered as well.\nAll struct fields must be able to be encoded in JSON format or be covered be covered by serialize and deserialize methods. Basic types, such as numbers and strings or arrays and dictionaries of numbers and strings, should just work. Complex containers with symbols may not.\nStructs relying on the default deserialize method must have a kwarg-only constructor. The deserialization code constructs objects by splatting the dictionary key/value pairs into the constructor.\nStructs that contain other PowerSystem components (like a generator contains a bus) must serialize those components as UUIDs instead of actual values. The deserialization code uses the UUIDs as a mechanism to restore a reference to the actual object rather a new object with identical values. It also significantly reduces the size of the JSON file.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Refer to InfrastructureSystems.serialize_struct for example behavior. New structs that are not subtypes of InfrastructureSystemsType may be able to call it directly.","category":"page"},{"location":"how_to/add_new_types/#How-to-trouble-shoot-serialization-issues","page":"...customize or add a new Type","title":"How to trouble-shoot serialization issues","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Here are some examples of potential problems and solutions if you need to implement custom InfrastructureSystems.serialize and InfrastructureSystems.deserialize methods for your type.:","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Problem: Your struct contains a field defined as an abstract type. The deserialization process doesn't know what concrete type to construct.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Solution: Encode the concrete type into the serialized dictionary as a string.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Example: serialize and deserialize methods for DynamicBranch in src/models/dynamic_branch.jl.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Problem: Similar to above in that a field is defined as an abstract type but the struct is parameterized on the actual concrete type.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"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.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Example: deserialize method for OuterControl in src/models/OuterControl.jl.","category":"page"},{"location":"how_to/add_new_types/#Adding-PowerSystems.jl-as-a-dependency-in-a-modeling-package","page":"...customize or add a new Type","title":"Adding PowerSystems.jl as a dependency in a modeling package","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"module MyModelingModule\n\nimport PowerSystems\nimport InfrastructureSystems\nconst PSY = PowerSystems\nconst IS = InfrastructureSystems\n\nexport MyDevice\nexport get_name\n\nmutable struct MyDevice <: PSY.Device\n name::String\n internal::IS.InfrastructureSystemsInternal\nend\n\nfunction MyDevice(name::String)\n return MyDevice(name, IS.InfrastructureSystemsInternal())\nend\n\nPSY.get_name(val::MyDevice) = val.name\n\nend","category":"page"},{"location":"how_to/add_new_types/#autogen","page":"...customize or add a new Type","title":"Auto-generating Structs","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"Most PowerSystems.jl structs are auto-generated from the JSON descriptor file src/descriptors/power_system_structs.json. You can add your new struct here or write it manually when contributing code to the repository.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"If all you need is the basic struct definition and getter/setter functions then you will likely find the auto-generation helpful.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"If you will need to write specialized functions for the type then you will probably want to write it manually.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"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/.","category":"page"},{"location":"how_to/add_new_types/#Testing-the-addition-of-new-struct-to-the-code-base","page":"...customize or add a new Type","title":"Testing the addition of new struct to the code base","text":"","category":"section"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"In order to merge new structs to the code base, your struct needs to pass several tests.","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"addition to System\nretrieval from System\nserialization/de-serialization","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"The following code block is an example of the code that the new struct needs to pass","category":"page"},{"location":"how_to/add_new_types/","page":"...customize or add a new Type","title":"...customize or add a new Type","text":"using PowerSystems\n\nsys = System(100.0)\ndevice = NewType(data)\n\n# add your component to the system\nadd_component!(sys, device)\nretrived_device = get_component(NewType, sys, \"component_name\")\n\n# Serialize\nto_json(sys, \"sys.json\")\n\n# Re-create the system and find your component.\nsys2 = System(\"sys.json\")\nserialized_device = get_component(NewType, sys, \"component_name\")\n\n@test get_name(retrieved_device) == get_name(serialized_device)","category":"page"},{"location":"model_library/generated_DCBus/#DCBus","page":"DCBus","title":"DCBus","text":"","category":"section"},{"location":"model_library/generated_DCBus/","page":"DCBus","title":"DCBus","text":"Modules = [PowerSystems]\nPages = [\"generated/DCBus.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_DCBus/#PowerSystems.DCBus","page":"DCBus","title":"PowerSystems.DCBus","text":"mutable struct DCBus <: Bus\n number::Int\n name::String\n magnitude::Union{Nothing, Float64}\n voltage_limits::Union{Nothing, MinMax}\n base_voltage::Union{Nothing, Float64}\n area::Union{Nothing, Area}\n load_zone::Union{Nothing, LoadZone}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA DC bus\n\nArguments\n\nnumber::Int: A unique bus identification number (positive integer)\nname::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\nmagnitude::Union{Nothing, Float64}: voltage as a multiple of base_voltage, validation range: voltage_limits\nvoltage_limits::Union{Nothing, MinMax}: limits on the voltage variation as multiples of base_voltage\nbase_voltage::Union{Nothing, Float64}: the base voltage in kV, validation range: (0, nothing)\narea::Union{Nothing, Area}: (default: nothing) the area containing the DC bus\nload_zone::Union{Nothing, LoadZone}: (default: nothing) the load zone containing the DC bus\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_DCBus/#InfrastructureSystems.get_name-Tuple{DCBus}","page":"DCBus","title":"InfrastructureSystems.get_name","text":"get_name(value::DCBus) -> String\n\n\nGet DCBus name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_area-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_area","text":"get_area(value::DCBus) -> Union{Nothing, Area}\n\n\nGet DCBus area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_base_voltage-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_base_voltage","text":"get_base_voltage(value::DCBus) -> Union{Nothing, Float64}\n\n\nGet DCBus base_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_ext-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_ext","text":"get_ext(value::DCBus) -> Dict{String, Any}\n\n\nGet DCBus ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_load_zone-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_load_zone","text":"get_load_zone(value::DCBus) -> Union{Nothing, LoadZone}\n\n\nGet DCBus load_zone.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_magnitude-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_magnitude","text":"get_magnitude(value::DCBus) -> Union{Nothing, Float64}\n\n\nGet DCBus magnitude.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_number-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_number","text":"get_number(value::DCBus) -> Int64\n\n\nGet DCBus number.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.get_voltage_limits-Tuple{DCBus}","page":"DCBus","title":"PowerSystems.get_voltage_limits","text":"get_voltage_limits(\n value::DCBus\n) -> Union{Nothing, @NamedTuple{min::Float64, max::Float64}}\n\n\nGet DCBus voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_area!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_area!","text":"set_area!(value::DCBus, val) -> Any\n\n\nSet DCBus area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_base_voltage!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_base_voltage!","text":"set_base_voltage!(value::DCBus, val) -> Any\n\n\nSet DCBus base_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_ext!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_ext!","text":"set_ext!(value::DCBus, val) -> Any\n\n\nSet DCBus ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_load_zone!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_load_zone!","text":"set_load_zone!(value::DCBus, val) -> Any\n\n\nSet DCBus load_zone.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_magnitude!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_magnitude!","text":"set_magnitude!(value::DCBus, val) -> Any\n\n\nSet DCBus magnitude.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_number!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_number!","text":"set_number!(value::DCBus, val) -> Any\n\n\nSet DCBus number.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCBus/#PowerSystems.set_voltage_limits!-Tuple{DCBus, Any}","page":"DCBus","title":"PowerSystems.set_voltage_limits!","text":"set_voltage_limits!(value::DCBus, val) -> Any\n\n\nSet DCBus voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#SwitchedAdmittance","page":"SwitchedAdmittance","title":"SwitchedAdmittance","text":"","category":"section"},{"location":"model_library/generated_SwitchedAdmittance/","page":"SwitchedAdmittance","title":"SwitchedAdmittance","text":"Modules = [PowerSystems]\nPages = [\"generated/SwitchedAdmittance.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.SwitchedAdmittance","page":"SwitchedAdmittance","title":"PowerSystems.SwitchedAdmittance","text":"mutable struct SwitchedAdmittance <: ElectricLoad\n name::String\n available::Bool\n bus::ACBus\n Y::Complex{Float64}\n number_of_steps::Int\n Y_increase::Complex{Float64}\n dynamic_injector::Union{Nothing, DynamicInjection}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA switched admittance, with discrete steps to adjust the admittance.\n\nMost 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nY::Complex{Float64}: Initial admittance at N = 0\nnumber_of_steps::Int: (default: 0) Number of steps for adjustable shunt\nY_increase::Complex{Float64}: (default: 0) Admittance increment for each of step increase\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection model for admittance\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_SwitchedAdmittance/#InfrastructureSystems.get_name-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"InfrastructureSystems.get_name","text":"get_name(value::SwitchedAdmittance) -> String\n\n\nGet SwitchedAdmittance name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_Y-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_Y","text":"get_Y(value::SwitchedAdmittance) -> ComplexF64\n\n\nGet SwitchedAdmittance Y.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_Y_increase-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_Y_increase","text":"get_Y_increase(value::SwitchedAdmittance) -> ComplexF64\n\n\nGet SwitchedAdmittance Y_increase.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_available-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_available","text":"get_available(value::SwitchedAdmittance) -> Bool\n\n\nGet SwitchedAdmittance available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_bus-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_bus","text":"get_bus(value::SwitchedAdmittance) -> ACBus\n\n\nGet SwitchedAdmittance bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_dynamic_injector-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::SwitchedAdmittance\n) -> Union{Nothing, DynamicInjection}\n\n\nGet SwitchedAdmittance dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_ext-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_ext","text":"get_ext(value::SwitchedAdmittance) -> Dict{String, Any}\n\n\nGet SwitchedAdmittance ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_number_of_steps-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_number_of_steps","text":"get_number_of_steps(value::SwitchedAdmittance) -> Int64\n\n\nGet SwitchedAdmittance number_of_steps.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.get_services-Tuple{SwitchedAdmittance}","page":"SwitchedAdmittance","title":"PowerSystems.get_services","text":"get_services(value::SwitchedAdmittance) -> Vector{Service}\n\n\nGet SwitchedAdmittance services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_Y!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_Y!","text":"set_Y!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance Y.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_Y_increase!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_Y_increase!","text":"set_Y_increase!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance Y_increase.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_available!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_available!","text":"set_available!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_bus!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_bus!","text":"set_bus!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_ext!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_ext!","text":"set_ext!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_number_of_steps!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_number_of_steps!","text":"set_number_of_steps!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance number_of_steps.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SwitchedAdmittance/#PowerSystems.set_services!-Tuple{SwitchedAdmittance, Any}","page":"SwitchedAdmittance","title":"PowerSystems.set_services!","text":"set_services!(value::SwitchedAdmittance, val) -> Any\n\n\nSet SwitchedAdmittance services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#StandardLoad","page":"StandardLoad","title":"StandardLoad","text":"","category":"section"},{"location":"model_library/generated_StandardLoad/","page":"StandardLoad","title":"StandardLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/StandardLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_StandardLoad/#PowerSystems.StandardLoad","page":"StandardLoad","title":"PowerSystems.StandardLoad","text":"mutable struct StandardLoad <: StaticLoad\n name::String\n available::Bool\n bus::ACBus\n base_power::Float64\n constant_active_power::Float64\n constant_reactive_power::Float64\n impedance_active_power::Float64\n impedance_reactive_power::Float64\n current_active_power::Float64\n current_reactive_power::Float64\n max_constant_active_power::Float64\n max_constant_reactive_power::Float64\n max_impedance_active_power::Float64\n max_impedance_reactive_power::Float64\n max_current_active_power::Float64\n max_current_reactive_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA voltage-dependent ZIP load, most commonly used for dynamics modeling.\n\nA 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.)\n\nFor an alternative exponential formulation of the ZIP model, see ExponentialLoad. For a simpler load model with no voltage dependency, see PowerLoad\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nbase_power::Float64: Base power of the load (MVA) for per unitization, validation range: (0, nothing)\nconstant_active_power::Float64: (default: 0.0) Constant active power demand in MW (P_P)\nconstant_reactive_power::Float64: (default: 0.0) Constant reactive power demand in MVAR (Q_P)\nimpedance_active_power::Float64: (default: 0.0) Active power coefficient in MW for constant impedance load (P_Z)\nimpedance_reactive_power::Float64: (default: 0.0) Reactive power coefficient in MVAR for constant impedance load (Q_Z)\ncurrent_active_power::Float64: (default: 0.0) Active power coefficient in MW for constant current load (P_I)\ncurrent_reactive_power::Float64: (default: 0.0) Reactive power coefficient in MVAR for constant current load (Q_I)\nmax_constant_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant power load\nmax_constant_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant power load\nmax_impedance_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant impedance load\nmax_impedance_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant impedance load\nmax_current_active_power::Float64: (default: 0.0) Maximum active power (MW) drawn by constant current load\nmax_current_reactive_power::Float64: (default: 0.0) Maximum reactive power (MVAR) drawn by constant current load\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_StandardLoad/#InfrastructureSystems.get_name-Tuple{StandardLoad}","page":"StandardLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::StandardLoad) -> String\n\n\nGet StandardLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_available-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_available","text":"get_available(value::StandardLoad) -> Bool\n\n\nGet StandardLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_base_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::StandardLoad) -> Float64\n\n\nGet StandardLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_bus-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_bus","text":"get_bus(value::StandardLoad) -> ACBus\n\n\nGet StandardLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_constant_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_constant_active_power","text":"get_constant_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad constant_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_constant_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_constant_reactive_power","text":"get_constant_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad constant_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_current_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_current_active_power","text":"get_current_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad current_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_current_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_current_reactive_power","text":"get_current_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad current_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_dynamic_injector-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::StandardLoad\n) -> Union{Nothing, DynamicInjection}\n\n\nGet StandardLoad dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_ext-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_ext","text":"get_ext(value::StandardLoad) -> Dict{String, Any}\n\n\nGet StandardLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_impedance_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_impedance_active_power","text":"get_impedance_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad impedance_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_impedance_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_impedance_reactive_power","text":"get_impedance_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad impedance_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_constant_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_constant_active_power","text":"get_max_constant_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_constant_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_constant_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_constant_reactive_power","text":"get_max_constant_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_constant_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_current_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_current_active_power","text":"get_max_current_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_current_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_current_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_current_reactive_power","text":"get_max_current_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_current_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_impedance_active_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_impedance_active_power","text":"get_max_impedance_active_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_impedance_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_max_impedance_reactive_power-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_max_impedance_reactive_power","text":"get_max_impedance_reactive_power(value::StandardLoad) -> Any\n\n\nGet StandardLoad max_impedance_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.get_services-Tuple{StandardLoad}","page":"StandardLoad","title":"PowerSystems.get_services","text":"get_services(value::StandardLoad) -> Vector{Service}\n\n\nGet StandardLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_available!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_available!","text":"set_available!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_base_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_bus!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_bus!","text":"set_bus!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_constant_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_constant_active_power!","text":"set_constant_active_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad constant_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_constant_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_constant_reactive_power!","text":"set_constant_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad constant_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_current_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_current_active_power!","text":"set_current_active_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad current_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_current_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_current_reactive_power!","text":"set_current_reactive_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad current_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_ext!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_impedance_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_impedance_active_power!","text":"set_impedance_active_power!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad impedance_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_impedance_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_impedance_reactive_power!","text":"set_impedance_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad impedance_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_constant_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_constant_active_power!","text":"set_max_constant_active_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_constant_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_constant_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_constant_reactive_power!","text":"set_max_constant_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_constant_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_current_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_current_active_power!","text":"set_max_current_active_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_current_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_current_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_current_reactive_power!","text":"set_max_current_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_current_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_impedance_active_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_impedance_active_power!","text":"set_max_impedance_active_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_impedance_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_max_impedance_reactive_power!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_max_impedance_reactive_power!","text":"set_max_impedance_reactive_power!(\n value::StandardLoad,\n val\n) -> Any\n\n\nSet StandardLoad max_impedance_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_StandardLoad/#PowerSystems.set_services!-Tuple{StandardLoad, Any}","page":"StandardLoad","title":"PowerSystems.set_services!","text":"set_services!(value::StandardLoad, val) -> Any\n\n\nSet StandardLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#Area","page":"Area","title":"Area","text":"","category":"section"},{"location":"model_library/generated_Area/","page":"Area","title":"Area","text":"Modules = [PowerSystems]\nPages = [\"generated/Area.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Area/#PowerSystems.Area","page":"Area","title":"PowerSystems.Area","text":"mutable struct Area <: AggregationTopology\n name::String\n peak_active_power::Float64\n peak_reactive_power::Float64\n load_response::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA collection of buses for control purposes.\n\nThe Area can be specified when defining each ACBus or DCBus in the area\n\nArguments\n\nname::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\npeak_active_power::Float64: (default: 0.0) Peak active power in the area\npeak_reactive_power::Float64: (default: 0.0) Peak reactive power in the area\nload_response::Float64: (default: 0.0) Load-frequency damping parameter modeling how much the load in the area changes due to changes in frequency (MW/Hz). Example here.\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Area/#InfrastructureSystems.get_name-Tuple{Area}","page":"Area","title":"InfrastructureSystems.get_name","text":"get_name(value::Area) -> String\n\n\nGet Area name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.get_ext-Tuple{Area}","page":"Area","title":"PowerSystems.get_ext","text":"get_ext(value::Area) -> Dict{String, Any}\n\n\nGet Area ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.get_load_response-Tuple{Area}","page":"Area","title":"PowerSystems.get_load_response","text":"get_load_response(value::Area) -> Float64\n\n\nGet Area load_response.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.get_peak_active_power-Tuple{Area}","page":"Area","title":"PowerSystems.get_peak_active_power","text":"get_peak_active_power(value::Area) -> Any\n\n\nGet Area peak_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.get_peak_reactive_power-Tuple{Area}","page":"Area","title":"PowerSystems.get_peak_reactive_power","text":"get_peak_reactive_power(value::Area) -> Any\n\n\nGet Area peak_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.set_ext!-Tuple{Area, Any}","page":"Area","title":"PowerSystems.set_ext!","text":"set_ext!(value::Area, val) -> Any\n\n\nSet Area ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.set_load_response!-Tuple{Area, Any}","page":"Area","title":"PowerSystems.set_load_response!","text":"set_load_response!(value::Area, val) -> Any\n\n\nSet Area load_response.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.set_peak_active_power!-Tuple{Area, Any}","page":"Area","title":"PowerSystems.set_peak_active_power!","text":"set_peak_active_power!(value::Area, val) -> Any\n\n\nSet Area peak_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Area/#PowerSystems.set_peak_reactive_power!-Tuple{Area, Any}","page":"Area","title":"PowerSystems.set_peak_reactive_power!","text":"set_peak_reactive_power!(value::Area, val) -> Any\n\n\nSet Area peak_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"api/glossary/#Glossary-and-Acronyms","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"A | D | E | F | H | I | O | P | R | S | V | W | Z","category":"page"},{"location":"api/glossary/#A","page":"Glossary and Acronyms","title":"A","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"AC: Alternating current\nACE: Area control error\nAGC: Automatic generation control\nAVR: Automatic Voltage Regulator","category":"page"},{"location":"api/glossary/#D","page":"Glossary and Acronyms","title":"D","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"DC: Direct current\nDERA1:\nDynamic: 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.","category":"page"},{"location":"api/glossary/#E","page":"Glossary and Acronyms","title":"E","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"EMF: Electromotive force\nESAC: IEEE Type AC Excitation System model\nESDC: IEEE Type DC Excitation System model\nEXAC: IEEE Type AC Excitation System (modified) model\nEXPIC: Proportional/Integral Excitation System from PSS/E\nEXST: IEEE Type ST (Static) Excitation System model\nEX4VSA: IEEE Excitation System for Voltage Security Assessment with Over-Excitation Limits.","category":"page"},{"location":"api/glossary/#F","page":"Glossary and Acronyms","title":"F","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"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.\nForecast window: Represents the forecasted value starting at a particular initial time. See the article on Time Series Data.","category":"page"},{"location":"api/glossary/#H","page":"Glossary and Acronyms","title":"H","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"Horizon: Is the duration of all time steps in one forecast. As of PowerSystems.jl version 4.0, all horizons in PowerSystems.jl are represented as a Dates.Period. For instance, many Day-ahead markets will have an hourly-resolution forecast for the next day, which would have a horizon of Dates.Hour(24) or Dates.Day(1). If the forecast included the next day plus a 24-hour lookahead window, the horizon would be Dates.Hour(48) or Dates.Day(2). See the article on Time Series Data.\nHVDC: High-voltage DC","category":"page"},{"location":"api/glossary/#I","page":"Glossary and Acronyms","title":"I","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"IEEET: IEEE Type I Excitation System.\nInjector 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.\nInterval: 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).\nInitial time: The first time-stamp in a forecast window. See the article on Time Series Data.\nIPC: Interconnecting power converter","category":"page"},{"location":"api/glossary/#O","page":"Glossary and Acronyms","title":"O","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"OEL: Over Excitation Limiter","category":"page"},{"location":"api/glossary/#P","page":"Glossary and Acronyms","title":"P","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"PLL: Phase-locked loop\nPSS: Power System Stabilizer\nPSSE or PSS/E: Siemens' PSS®E Power System Simulator for Engineering\nPPA: Power purchase agreement\nPSI: PowerSimulations.jl\nPSID: PowerSimulationsDynamics.jl\nPSLF: GE Vernova's Positive Sequence Load Flow Software\nPSY: PowerSystems.jl (this package)\npu or p.u.: Per-unit","category":"page"},{"location":"api/glossary/#R","page":"Glossary and Acronyms","title":"R","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"REECB1: Renewable Energy Electric Controller Type B1\nREPCA1: REPCA1: Renewable Energy Power Controller Type A1\nResolution: 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).","category":"page"},{"location":"api/glossary/#S","page":"Glossary and Acronyms","title":"S","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"SCRX: Bus Fed or Solid Fed Static Exciter\nSEXS: Simplified Excitation System model from PSS/E\nSIL: Surge impedance loading\nStates: 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.\nStatic: 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.\nSTAB: Speed Sensitive Stabilizing PSS Model","category":"page"},{"location":"api/glossary/#V","page":"Glossary and Acronyms","title":"V","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"VSCDCLine: Voltage-Source Converter Direct Current Line\nVSM: Virtual Synchronous Machine","category":"page"},{"location":"api/glossary/#W","page":"Glossary and Acronyms","title":"W","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"Window: A forecast window is one forecast run that starts at one initial time and extends through the forecast horizon. Typically, a forecast data set contains multiple forecast windows, with sequential initial times. For example, a year-long data set of day-ahead forecasts contains 365 forecast windows","category":"page"},{"location":"api/glossary/#Z","page":"Glossary and Acronyms","title":"Z","text":"","category":"section"},{"location":"api/glossary/","page":"Glossary and Acronyms","title":"Glossary and Acronyms","text":"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.","category":"page"},{"location":"tutorials/add_dynamic_data/#Adding-Data-for-Dynamic-Simulations","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"In this tutorial, we are going to add dynamic data to a power System, including a dynamic generator suitable for phasor-type simulations, as well as a dynamic inverter and dynamic lines necessary for more complex EMT (electro-magnetic transient) simulations.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"To run a dynamic simulation in Sienna\\Dyn using PowerSimulationsDynamics.jl, two data layers are required:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"A base layer of static components, which includes the data needed to run a power flow problem\nAn additional layer of dynamic components, which define differential equations to run a transient simulation","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"We'll define these two layers sequentially.","category":"page"},{"location":"tutorials/add_dynamic_data/#Defining-the-Static-Data-Layer","page":"Adding Data for Dynamic Simulations","title":"Defining the Static Data Layer","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Instead of defining the static data in the System manually, we will load an existing three-bus system using PowerSystemCaseBuilder.jl to use as a starting point.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Start by importing these packages:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"using PowerSystems\nusing PowerSystemCaseBuilder\nconst PSY = PowerSystems;","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"To create the system, load pre-existing data for a 3-bus system using PowerSystemCaseBuilder.jl:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"threebus_sys = build_system(PSIDSystems, \"3 Bus Inverter Base\")","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that there is a table of \"Static Components\", but no \"Dynamic\" data yet.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's view the generators in the system with show_components, including which bus they are connected at:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"show_components(ThermalStandard, threebus_sys, [:bus])","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that there are generators connected at Buses 2 and 3, but not Bus 1.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Now, we are going to add the data needed to run an EMT simulation. We will add an infinite voltage source to Bus 1, which is the last component we need to complete the static data layer. Then, we will a dynamic generator or inverter model to the two generators, as well as adding dynamic lines.","category":"page"},{"location":"tutorials/add_dynamic_data/#Add-an-Infinite-Voltage-Source","page":"Adding Data for Dynamic Simulations","title":"Add an Infinite Voltage Source","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Add a infinite voltage source with small impedance to Bus 1 (the reference bus). First, retrieve the reference bus using get_components:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"slack_bus = first(get_components(x -> get_bustype(x) == ACBusTypes.REF, Bus, threebus_sys))","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice we filtered by the bus type to get the bus(es) we wanted.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Next, manually define a Source:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"inf_source = Source(;\n name = \"InfBus\", #name\n available = true, #availability\n active_power = 0.0,\n reactive_power = 0.0,\n bus = slack_bus, #bus\n R_th = 0.0, #Rth\n X_th = 5e-6, #Xth\n);","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"And add it to the system:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"add_component!(threebus_sys, inf_source)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"This completes the first layer of static data, using components similar to those we added manually in the Create and Explore a Power System tutorial.","category":"page"},{"location":"tutorials/add_dynamic_data/#Adding-a-Dynamic-Generator","page":"Adding Data for Dynamic Simulations","title":"Adding a Dynamic Generator","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Now, we will connect a classic machine model to the generator at bus 102. Dynamic generator devices are composed by 5 components: a Machine, Shaft, Automatic Voltage Regulator (AVR), Power System Stabilizer (PSS), and Prime Mover and Turbine Governor. For each of those 5 components, we will select a specific model that defines the data and differential equations for that component, and then use those 5 components to define the complete dynamic generator.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"note: Note\nWhen defining dynamic data, by convention PowerSystems.jl assumes that all data is in DEVICE_BASE.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"First, define a Machine that describes the the stator electro-magnetic dynamics:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"# Create the machine\nmachine_oneDoneQ = OneDOneQMachine(;\n R = 0.0,\n Xd = 1.3125,\n Xq = 1.2578,\n Xd_p = 0.1813,\n Xq_p = 0.25,\n Td0_p = 5.89,\n Tq0_p = 0.6,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that we selected a specific model, OneDOneQMachine, with the parameters tailored to a One-d-one-q dynamic machine model.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Next, define a specific Shaft model, SingleMass that describes the rotor electro-mechanical dynamics:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"# Shaft\nshaft_no_damping = SingleMass(;\n H = 3.01, #(M = 6.02 -> H = M/2)\n D = 0.0,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Represent the electromotive dynamics of the AVR controller using a specific Automatic Voltage Regulator model, AVRTypeI:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"# AVR: Type I: Resembles a DC1 AVR\navr_type1 = AVRTypeI(;\n Ka = 20.0,\n Ke = 0.01,\n Kf = 0.063,\n Ta = 0.2,\n Te = 0.314,\n Tf = 0.35,\n Tr = 0.001,\n Va_lim = (min = -5.0, max = 5.0),\n Ae = 0.0039, #1st ceiling coefficient\n Be = 1.555, #2nd ceiling coefficient\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define a fixed efficiency Prime Mover and Turbine Governor with TGFixed:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"#No TG\ntg_none = TGFixed(; efficiency = 1.0) #efficiency","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that we are modeling a machine that does not include a Turbine Governor (or PSS below), but you must define components for them to build a complete machine model.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Similarly, define a PSS using PSSFixed, which is used to describe the stabilization signal for the AVR:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"#No PSS\npss_none = PSSFixed(; V_pss = 0.0)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Now, we are ready to add a dynamic generator to the static generator at bus 102. First, let's get that static generator:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"static_gen = get_component(Generator, threebus_sys, \"generator-102-1\")","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that its dynamic_injector field is currently nothing.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Use its name and the 5 components above to define its DynamicGenerator model:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"dynamic_gen = DynamicGenerator(;\n name = get_name(static_gen),\n ω_ref = 1.0, # frequency reference set-point\n machine = machine_oneDoneQ,\n shaft = shaft_no_damping,\n avr = avr_type1,\n prime_mover = tg_none,\n pss = pss_none,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that the specific component models that we selected and defined above were used to specify the states needed to model this generator in a dynamic simulation.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Finally, use the dynamic version of add_component! to add this data to the System:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"add_component!(threebus_sys, dynamic_gen, static_gen)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that unlike static components, which are just added to the System, this dynamic component is added to a specific static component within the System.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"tip: Tip\nTo define identical dynamic devices for multiple generators at once, define the pieces of the generator model as functions, such as:avr_type1() = AVRTypeI(...When called in the DynamicGenerator constructor, this will create a new AVR for each generator, so they are different in memory. Later, if you decide to modify the AVR parameters for a specific generator, it will not modify the AVR in another generator.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Recall that you can print the system to see a summary of its data:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"threebus_sys","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that a new table has been added: \"Dynamic Components.\"","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Also, print the static generator to double-check the dynamic layer has been added:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"static_gen","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Verify that dynamic_injector now contains our dynamic generator model.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Up to this point, you have added the dynamic data necessary to do a phaser-type simulation, which focuses on machine behavior. Now we will also add dynamic inverters and lines to enable EMT simulations.","category":"page"},{"location":"tutorials/add_dynamic_data/#Adding-a-Dynamic-Inverter","page":"Adding Data for Dynamic Simulations","title":"Adding a Dynamic Inverter","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Next we will connect a Virtual Synchronous Generator Inverter at bus 103.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"An inverter is composed of Converter, OuterControl, InnerControl, DCSource, FrequencyEstimator, and Filter components:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"As we did for the generator, we will define each of these six components with a specific model, which defines its differential equations.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"First, define an AverageConverter as the specific model for the Converter component:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"converter_high_power() = AverageConverter(;\n rated_voltage = 138.0,\n rated_current = 100.0,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Recall from the tip above that we can define these components as functions instead of objects for reusability across multiple generators, and notice that that is what we have done here.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define OuterControl using Virtual Inertia for the active power control and ReactivePowerDroop for the reactive power control:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"outer_control() = OuterControl(\n VirtualInertia(; Ta = 2.0, kd = 400.0, kω = 20.0),\n ReactivePowerDroop(; kq = 0.2, ωf = 1000.0),\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define an InnerControl as a Voltage+Current Controller with Virtual Impedance, using VoltageModeControl:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"inner_control() = VoltageModeControl(;\n kpv = 0.59, #Voltage controller proportional gain\n kiv = 736.0, #Voltage controller integral gain\n kffv = 0.0, #Binary variable enabling voltage feed-forward in current controllers\n rv = 0.0, #Virtual resistance in pu\n lv = 0.2, #Virtual inductance in pu\n kpc = 1.27, #Current controller proportional gain\n kic = 14.3, #Current controller integral gain\n kffi = 0.0, #Binary variable enabling the current feed-forward in output of current controllers\n ωad = 50.0, #Active damping low pass filter cut-off frequency\n kad = 0.2, #Active damping gain\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define a FixedDCSource for the DCSource:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"dc_source_lv() = FixedDCSource(; voltage = 600.0)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Define a FrequencyEstimator as a phase-locked loop (PLL) using KauraPLL:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"pll() = KauraPLL(;\n ω_lp = 500.0, #Cut-off frequency for LowPass filter of PLL filter.\n kp_pll = 0.084, #PLL proportional gain\n ki_pll = 4.69, #PLL integral gain\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Finally, define an LCLFilter for the Filter:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"filt() = LCLFilter(;\n lf = 0.08,\n rf = 0.003,\n cf = 0.074,\n lg = 0.2,\n rg = 0.01,\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Now, use those six functions to define a complete dynamic inverter by getting the static component at bus 103:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"gen_103 = get_component(Generator, threebus_sys, \"generator-103-1\");","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"using it and our six functions to define a DynamicInverter:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"dynamic_inv = DynamicInverter(;\n name = get_name(gen_103),\n ω_ref = 1.0, # frequency reference set-point\n converter = converter_high_power(),\n outer_control = outer_control(),\n inner_control = inner_control(),\n dc_source = dc_source_lv(),\n freq_estimator = pll(),\n filter = filt(),\n)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"and adding it to the System:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"add_component!(threebus_sys, dynamic_inv, gen_103)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Both generators have now been updated with dynamic data. Let's complete the System updates by adding dynamic lines.","category":"page"},{"location":"tutorials/add_dynamic_data/#Adding-Dynamic-Lines","page":"Adding Data for Dynamic Simulations","title":"Adding Dynamic Lines","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"warning: Warning\nA System must have at least two buses and one branch to run a dynamic simulation in PowerSimulationsDynamics.jl.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's review the AC branches currently in the system:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"get_components(ACBranch, threebus_sys)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that we have three static Line components.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's also print the first line to review its format:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"first(get_components(Line, threebus_sys))","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"See that these components do not have the fields for dynamic modeling, such as fields for different states.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's update that by cycling through these lines and using DynamicBranch to extend each static line with the necessary fields:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"for l in get_components(Line, threebus_sys)\n # create a dynamic branch\n dyn_branch = DynamicBranch(l)\n # add dynamic branch to the system, replacing the static branch\n add_component!(threebus_sys, dyn_branch)\nend","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Take a look at the AC branches in the system again:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"branches = get_components(ACBranch, threebus_sys)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Notice that now there are 3 DynamicBranch components instead the Line components.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Let's take a look by printing first one:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"first(branches)","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Observe that this is a wrapper around the static data, with the additional states data for dynamic modeling.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Finally, let's print the System again to summarize our additions:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"threebus_sys","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Verify that the additions were successful, with an added voltage Source, DynamicBranches replacing the static Lines, and two new dynamic components with the generator and inverter models.","category":"page"},{"location":"tutorials/add_dynamic_data/#Next-Steps","page":"Adding Data for Dynamic Simulations","title":"Next Steps","text":"","category":"section"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"In this tutorial, you have updated a static system with a second dynamic data layer. The data you added can enable a phasor-based simulation using the dynamic generator, or a more complex EMT simulation with the additional dynamic inverter and dynamic lines.","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Next, you might like to:","category":"page"},{"location":"tutorials/add_dynamic_data/","page":"Adding Data for Dynamic Simulations","title":"Adding Data for Dynamic Simulations","text":"Read more about the static and dynamic data layers and the dynamic data format in Dynamic Devices.\nReview the specific sub-system models available in PowerSystems.jl for Machine, Shaft, AVR, PSS, Prime Mover and Turbine Governor, Converter, OuterControl, InnerControl, DCSource, FrequencyEstimator, and Filter components\nExplore PowerSimulationsDynamics.jl for dynamics modeling in Sienna\\Dyn","category":"page"},{"location":"model_library/generated_ThermalStandard/#ThermalStandard","page":"ThermalStandard","title":"ThermalStandard","text":"","category":"section"},{"location":"model_library/generated_ThermalStandard/","page":"ThermalStandard","title":"ThermalStandard","text":"Modules = [PowerSystems]\nPages = [\"generated/ThermalStandard.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.ThermalStandard","page":"ThermalStandard","title":"PowerSystems.ThermalStandard","text":"mutable struct ThermalStandard <: ThermalGen\n name::String\n available::Bool\n status::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n operation_cost::Union{ThermalGenerationCost, MarketBidCost}\n base_power::Float64\n time_limits::Union{Nothing, UpDown}\n must_run::Bool\n prime_mover_type::PrimeMovers\n fuel::ThermalFuels\n services::Vector{Service}\n time_at_status::Float64\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA thermal generator, such as a fossil fuel and nuclear generator.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nstatus::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)\noperation_cost::Union{ThermalGenerationCost, MarketBidCost}: OperationalCost of generation\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: (default: nothing) Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nmust_run::Bool: (default: false) Set to true if the unit is must run\nprime_mover_type::PrimeMovers: (default: PrimeMovers.OT) Prime mover technology according to EIA 923. Options are listed here\nfuel::ThermalFuels: (default: ThermalFuels.OTHER) Prime mover fuel according to EIA 923. Options are listed here\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ntime_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ThermalStandard/#InfrastructureSystems.get_name-Tuple{ThermalStandard}","page":"ThermalStandard","title":"InfrastructureSystems.get_name","text":"get_name(value::ThermalStandard) -> String\n\n\nGet ThermalStandard name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_active_power-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_active_power","text":"get_active_power(value::ThermalStandard) -> Any\n\n\nGet ThermalStandard active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_active_power_limits-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::ThermalStandard\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet ThermalStandard active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_available-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_available","text":"get_available(value::ThermalStandard) -> Bool\n\n\nGet ThermalStandard available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_base_power-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_base_power","text":"get_base_power(value::ThermalStandard) -> Float64\n\n\nGet ThermalStandard base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_bus-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_bus","text":"get_bus(value::ThermalStandard) -> ACBus\n\n\nGet ThermalStandard bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_dynamic_injector-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::ThermalStandard\n) -> Union{Nothing, DynamicInjection}\n\n\nGet ThermalStandard dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_ext-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_ext","text":"get_ext(value::ThermalStandard) -> Dict{String, Any}\n\n\nGet ThermalStandard ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_fuel-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_fuel","text":"get_fuel(value::ThermalStandard) -> ThermalFuels\n\n\nGet ThermalStandard fuel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_must_run-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_must_run","text":"get_must_run(value::ThermalStandard) -> Bool\n\n\nGet ThermalStandard must_run.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_operation_cost-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::ThermalStandard\n) -> Union{MarketBidCost, ThermalGenerationCost}\n\n\nGet ThermalStandard operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_prime_mover_type-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(value::ThermalStandard) -> PrimeMovers\n\n\nGet ThermalStandard prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_ramp_limits-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::ThermalStandard\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet ThermalStandard ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_rating-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_rating","text":"get_rating(value::ThermalStandard) -> Any\n\n\nGet ThermalStandard rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_reactive_power-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::ThermalStandard) -> Any\n\n\nGet ThermalStandard reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_reactive_power_limits-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::ThermalStandard\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet ThermalStandard reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_services-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_services","text":"get_services(value::ThermalStandard) -> Vector{Service}\n\n\nGet ThermalStandard services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_status-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_status","text":"get_status(value::ThermalStandard) -> Bool\n\n\nGet ThermalStandard status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_time_at_status-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_time_at_status","text":"get_time_at_status(value::ThermalStandard) -> Float64\n\n\nGet ThermalStandard time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.get_time_limits-Tuple{ThermalStandard}","page":"ThermalStandard","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::ThermalStandard\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet ThermalStandard time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_active_power!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_active_power_limits!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_available!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_available!","text":"set_available!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_base_power!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_bus!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_bus!","text":"set_bus!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_ext!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_ext!","text":"set_ext!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_fuel!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_fuel!","text":"set_fuel!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard fuel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_must_run!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_must_run!","text":"set_must_run!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard must_run.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_operation_cost!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_prime_mover_type!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_ramp_limits!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_rating!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_rating!","text":"set_rating!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_reactive_power!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_reactive_power_limits!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::ThermalStandard,\n val\n) -> Any\n\n\nSet ThermalStandard reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_services!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_services!","text":"set_services!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_status!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_status!","text":"set_status!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_time_at_status!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_time_at_status!","text":"set_time_at_status!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalStandard/#PowerSystems.set_time_limits!-Tuple{ThermalStandard, Any}","page":"ThermalStandard","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::ThermalStandard, val) -> Any\n\n\nSet ThermalStandard time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#VariableReserveNonSpinning","page":"VariableReserveNonSpinning","title":"VariableReserveNonSpinning","text":"","category":"section"},{"location":"model_library/generated_VariableReserveNonSpinning/","page":"VariableReserveNonSpinning","title":"VariableReserveNonSpinning","text":"Modules = [PowerSystems]\nPages = [\"generated/VariableReserveNonSpinning.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.VariableReserveNonSpinning","page":"VariableReserveNonSpinning","title":"PowerSystems.VariableReserveNonSpinning","text":"mutable struct VariableReserveNonSpinning <: ReserveNonSpinning\n name::String\n available::Bool\n time_frame::Float64\n requirement::Float64\n sustained_time::Float64\n max_output_fraction::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA 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.\n\nThis 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.\n\nThis is only an upwards reserve. For faster-responding upwards or downwards reserves from components already synchronized with the system, see VariableReserve\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)\nrequirement::Float64: the required quantity of the product should be scaled by a TimeSeriesData\nsustained_time::Float64: (default: 14400.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_VariableReserveNonSpinning/#InfrastructureSystems.get_name-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"InfrastructureSystems.get_name","text":"get_name(value::VariableReserveNonSpinning) -> String\n\n\nGet VariableReserveNonSpinning name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_available-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_available","text":"get_available(value::VariableReserveNonSpinning) -> Bool\n\n\nGet VariableReserveNonSpinning available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_deployed_fraction-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(\n value::VariableReserveNonSpinning\n) -> Float64\n\n\nGet VariableReserveNonSpinning deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_ext-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_ext","text":"get_ext(\n value::VariableReserveNonSpinning\n) -> Dict{String, Any}\n\n\nGet VariableReserveNonSpinning ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_max_output_fraction-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_max_output_fraction","text":"get_max_output_fraction(\n value::VariableReserveNonSpinning\n) -> Float64\n\n\nGet VariableReserveNonSpinning max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_max_participation_factor-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::VariableReserveNonSpinning\n) -> Float64\n\n\nGet VariableReserveNonSpinning max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_requirement-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_requirement","text":"get_requirement(value::VariableReserveNonSpinning) -> Any\n\n\nGet VariableReserveNonSpinning requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_sustained_time-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(\n value::VariableReserveNonSpinning\n) -> Float64\n\n\nGet VariableReserveNonSpinning sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.get_time_frame-Tuple{VariableReserveNonSpinning}","page":"VariableReserveNonSpinning","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::VariableReserveNonSpinning) -> Float64\n\n\nGet VariableReserveNonSpinning time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_available!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_available!","text":"set_available!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_deployed_fraction!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_ext!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_ext!","text":"set_ext!(value::VariableReserveNonSpinning, val) -> Any\n\n\nSet VariableReserveNonSpinning ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_max_output_fraction!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_max_output_fraction!","text":"set_max_output_fraction!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_max_participation_factor!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_requirement!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_requirement!","text":"set_requirement!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_sustained_time!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_VariableReserveNonSpinning/#PowerSystems.set_time_frame!-Tuple{VariableReserveNonSpinning, Any}","page":"VariableReserveNonSpinning","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(\n value::VariableReserveNonSpinning,\n val\n) -> Any\n\n\nSet VariableReserveNonSpinning time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#Converter","page":"Converter","title":"Converter","text":"","category":"section"},{"location":"model_library/generated_Converter/#AverageConverter","page":"Converter","title":"AverageConverter","text":"","category":"section"},{"location":"model_library/generated_Converter/","page":"Converter","title":"Converter","text":"Modules = [PowerSystems]\nPages = [\"/AverageConverter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Converter/#PowerSystems.AverageConverter","page":"Converter","title":"PowerSystems.AverageConverter","text":"mutable struct AverageConverter <: Converter\n rated_voltage::Float64\n rated_current::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an average converter model\n\nArguments\n\nrated_voltage::Float64: Rated voltage (V), validation range: (0, nothing)\nrated_current::Float64: Rated current (A), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) AverageConverter has no states\nn_states::Int: (Do not modify.) AverageConverter has no states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Converter/#PowerSystems.get_ext-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_ext","text":"get_ext(value::AverageConverter) -> Dict{String, Any}\n\n\nGet AverageConverter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_n_states-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_n_states","text":"get_n_states(value::AverageConverter) -> Int64\n\n\nGet AverageConverter n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_rated_current-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_rated_current","text":"get_rated_current(value::AverageConverter) -> Float64\n\n\nGet AverageConverter rated_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_rated_voltage-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_rated_voltage","text":"get_rated_voltage(value::AverageConverter) -> Float64\n\n\nGet AverageConverter rated_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_states-Tuple{AverageConverter}","page":"Converter","title":"PowerSystems.get_states","text":"get_states(value::AverageConverter) -> Vector{Symbol}\n\n\nGet AverageConverter states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_ext!-Tuple{AverageConverter, Any}","page":"Converter","title":"PowerSystems.set_ext!","text":"set_ext!(value::AverageConverter, val) -> Any\n\n\nSet AverageConverter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_rated_current!-Tuple{AverageConverter, Any}","page":"Converter","title":"PowerSystems.set_rated_current!","text":"set_rated_current!(value::AverageConverter, val) -> Any\n\n\nSet AverageConverter rated_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_rated_voltage!-Tuple{AverageConverter, Any}","page":"Converter","title":"PowerSystems.set_rated_voltage!","text":"set_rated_voltage!(value::AverageConverter, val) -> Any\n\n\nSet AverageConverter rated_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#RenewableEnergyConverterTypeA","page":"Converter","title":"RenewableEnergyConverterTypeA","text":"","category":"section"},{"location":"model_library/generated_Converter/","page":"Converter","title":"Converter","text":"Modules = [PowerSystems]\nPages = [\"/RenewableEnergyConverterTypeA.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Converter/#PowerSystems.RenewableEnergyConverterTypeA","page":"Converter","title":"PowerSystems.RenewableEnergyConverterTypeA","text":"mutable struct RenewableEnergyConverterTypeA <: Converter\n T_g::Float64\n Rrpwr::Float64\n Brkpt::Float64\n Zerox::Float64\n Lvpl1::Float64\n Vo_lim::Float64\n Lv_pnts::MinMax\n Io_lim::Float64\n T_fltr::Float64\n K_hv::Float64\n Iqr_lims::MinMax\n Accel::Float64\n Lvpl_sw::Int\n Q_ref::Float64\n R_source::Float64\n X_source::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a renewable energy generator/converter model, this model corresponds to REGCA1 in PSSE\n\nArguments\n\nT_g::Float64: Converter time constant (s), validation range: (0, nothing)\nRrpwr::Float64: Low Voltage Power Logic (LVPL) ramp rate limit (pu/s), validation range: (0, nothing)\nBrkpt::Float64: LVPL characteristic voltage 2 (pu), validation range: (0, nothing)\nZerox::Float64: LVPL characteristic voltage 1 (pu), validation range: (0, nothing)\nLvpl1::Float64: LVPL gain (pu), validation range: (0, nothing)\nVo_lim::Float64: Voltage limit for high voltage reactive current management (pu), validation range: (0, nothing)\nLv_pnts::MinMax: Voltage points for low voltage active current management (pu) (Lvpnt0, Lvpnt1)\nIo_lim::Float64: Current limit (pu) for high voltage reactive current management (specified as a negative value), validation range: (nothing, 0)\nT_fltr::Float64: Voltage filter time constant for low voltage active current management (s), validation range: (0, nothing)\nK_hv::Float64: Overvoltage compensation gain used in the high voltage reactive current management, validation range: (0, nothing)\nIqr_lims::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)\nAccel::Float64: Acceleration factor, validation range: (0, 1)\nLvpl_sw::Int: Low voltage power logic (LVPL) switch. (0: LVPL not present, 1: LVPL present), validation range: (0, 1)\nQ_ref::Float64: (default: 1.0) Initial condition of reactive power from power flow, validation range: (0, nothing)\nR_source::Float64: (default: 0.0) Output resistor used for the Thevenin Equivalent, validation range: (0, nothing)\nX_source::Float64: (default: 1.0e5) Output reactance used for the Thevenin Equivalent, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\tIp: Converter lag for Ipcmd,\tIq: Converter lag for Iqcmd,\tVmeas: Voltage filter for low voltage active current management\nn_states::Int: (Do not modify.) RenewableEnergyConverterTypeA has 3 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Converter/#PowerSystems.get_Accel-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Accel","text":"get_Accel(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Accel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Brkpt-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Brkpt","text":"get_Brkpt(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Brkpt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Io_lim-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Io_lim","text":"get_Io_lim(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Io_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Iqr_lims-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Iqr_lims","text":"get_Iqr_lims(\n value::RenewableEnergyConverterTypeA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RenewableEnergyConverterTypeA Iqr_lims.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_K_hv-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_K_hv","text":"get_K_hv(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA K_hv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lv_pnts-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lv_pnts","text":"get_Lv_pnts(\n value::RenewableEnergyConverterTypeA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RenewableEnergyConverterTypeA Lv_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lvpl1-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lvpl1","text":"get_Lvpl1(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Lvpl1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lvpl_sw-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lvpl_sw","text":"get_Lvpl_sw(value::RenewableEnergyConverterTypeA) -> Int64\n\n\nGet RenewableEnergyConverterTypeA Lvpl_sw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Q_ref-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_R_source-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_R_source","text":"get_R_source(\n value::RenewableEnergyConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyConverterTypeA R_source.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Rrpwr-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Rrpwr","text":"get_Rrpwr(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_T_fltr-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_T_fltr","text":"get_T_fltr(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_T_g-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_T_g","text":"get_T_g(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Vo_lim-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Vo_lim","text":"get_Vo_lim(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Vo_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_X_source-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_X_source","text":"get_X_source(\n value::RenewableEnergyConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyConverterTypeA X_source.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Zerox-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_Zerox","text":"get_Zerox(value::RenewableEnergyConverterTypeA) -> Float64\n\n\nGet RenewableEnergyConverterTypeA Zerox.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_ext-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_ext","text":"get_ext(\n value::RenewableEnergyConverterTypeA\n) -> Dict{String, Any}\n\n\nGet RenewableEnergyConverterTypeA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_n_states-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_n_states","text":"get_n_states(value::RenewableEnergyConverterTypeA) -> Int64\n\n\nGet RenewableEnergyConverterTypeA n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_states-Tuple{RenewableEnergyConverterTypeA}","page":"Converter","title":"PowerSystems.get_states","text":"get_states(\n value::RenewableEnergyConverterTypeA\n) -> Vector{Symbol}\n\n\nGet RenewableEnergyConverterTypeA states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Accel!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Accel!","text":"set_Accel!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Accel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Brkpt!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Brkpt!","text":"set_Brkpt!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Brkpt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Io_lim!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Io_lim!","text":"set_Io_lim!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Io_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Iqr_lims!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Iqr_lims!","text":"set_Iqr_lims!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Iqr_lims.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_K_hv!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_K_hv!","text":"set_K_hv!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA K_hv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lv_pnts!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lv_pnts!","text":"set_Lv_pnts!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Lv_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lvpl1!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lvpl1!","text":"set_Lvpl1!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Lvpl1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lvpl_sw!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lvpl_sw!","text":"set_Lvpl_sw!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Lvpl_sw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Q_ref!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_R_source!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_R_source!","text":"set_R_source!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA R_source.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Rrpwr!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Rrpwr!","text":"set_Rrpwr!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_T_fltr!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_T_fltr!","text":"set_T_fltr!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_T_g!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_T_g!","text":"set_T_g!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Vo_lim!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Vo_lim!","text":"set_Vo_lim!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA Vo_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_X_source!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_X_source!","text":"set_X_source!(\n value::RenewableEnergyConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyConverterTypeA X_source.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Zerox!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Zerox!","text":"set_Zerox!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA Zerox.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_ext!-Tuple{RenewableEnergyConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_ext!","text":"set_ext!(value::RenewableEnergyConverterTypeA, val) -> Any\n\n\nSet RenewableEnergyConverterTypeA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#RenewableEnergyVoltageConverterTypeA","page":"Converter","title":"RenewableEnergyVoltageConverterTypeA","text":"","category":"section"},{"location":"model_library/generated_Converter/","page":"Converter","title":"Converter","text":"Modules = [PowerSystems]\nPages = [\"/RenewableEnergyVoltageConverterTypeA.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Converter/#PowerSystems.RenewableEnergyVoltageConverterTypeA","page":"Converter","title":"PowerSystems.RenewableEnergyVoltageConverterTypeA","text":"mutable struct RenewableEnergyVoltageConverterTypeA <: Converter\n T_g::Float64\n Rrpwr::Float64\n Brkpt::Float64\n Zerox::Float64\n Lvpl1::Float64\n Vo_lim::Float64\n Lv_pnts::MinMax\n Io_lim::Float64\n T_fltr::Float64\n K_hv::Float64\n Iqr_lims::MinMax\n Accel::Float64\n Lvpl_sw::Int\n Q_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters 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\n\nArguments\n\nT_g::Float64: Converter time constant (s), validation range: (0, nothing)\nRrpwr::Float64: Low Voltage Power Logic (LVPL) ramp rate limit (pu/s), validation range: (0, nothing)\nBrkpt::Float64: LVPL characteristic voltage 2 (pu), validation range: (0, nothing)\nZerox::Float64: LVPL characteristic voltage 1 (pu), validation range: (0, nothing)\nLvpl1::Float64: LVPL gain (pu), validation range: (0, nothing)\nVo_lim::Float64: Voltage limit for high voltage reactive current management (pu), validation range: (0, nothing)\nLv_pnts::MinMax: Voltage points for low voltage active current management (pu) (Lvpnt0, Lvpnt1)\nIo_lim::Float64: Current limit (pu) for high voltage reactive current management (specified as a negative value), validation range: (nothing, 0)\nT_fltr::Float64: Voltage filter time constant for low voltage active current management (s), validation range: (0, nothing)\nK_hv::Float64: Overvoltage compensation gain used in the high voltage reactive current management, validation range: (0, nothing)\nIqr_lims::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)\nAccel::Float64: Acceleration factor, validation range: (0, 1)\nLvpl_sw::Int: Low voltage power logic (LVPL) switch. (0: LVPL not present, 1: LVPL present), validation range: (0, 1)\nQ_ref::Float64: (default: 1.0) Initial condition of reactive power from power flow, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\tIp: Converter lag for Ipcmd,\tIq: Converter lag for Iqcmd,\tVmeas: Voltage filter for low voltage active current management\nn_states::Int: (Do not modify.) RenewableEnergyVoltageConverterTypeA has 3 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Converter/#PowerSystems.get_Accel-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Accel","text":"get_Accel(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Accel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Brkpt-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Brkpt","text":"get_Brkpt(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Brkpt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Io_lim-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Io_lim","text":"get_Io_lim(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Io_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Iqr_lims-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Iqr_lims","text":"get_Iqr_lims(\n value::RenewableEnergyVoltageConverterTypeA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RenewableEnergyVoltageConverterTypeA Iqr_lims.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_K_hv-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_K_hv","text":"get_K_hv(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA K_hv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lv_pnts-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lv_pnts","text":"get_Lv_pnts(\n value::RenewableEnergyVoltageConverterTypeA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RenewableEnergyVoltageConverterTypeA Lv_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lvpl1-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lvpl1","text":"get_Lvpl1(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Lvpl1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Lvpl_sw-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Lvpl_sw","text":"get_Lvpl_sw(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Int64\n\n\nGet RenewableEnergyVoltageConverterTypeA Lvpl_sw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Q_ref-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Rrpwr-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Rrpwr","text":"get_Rrpwr(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_T_fltr-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_T_fltr","text":"get_T_fltr(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_T_g-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_T_g","text":"get_T_g(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Vo_lim-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Vo_lim","text":"get_Vo_lim(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Vo_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_Zerox-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_Zerox","text":"get_Zerox(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Float64\n\n\nGet RenewableEnergyVoltageConverterTypeA Zerox.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_ext-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_ext","text":"get_ext(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Dict{String, Any}\n\n\nGet RenewableEnergyVoltageConverterTypeA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_n_states-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_n_states","text":"get_n_states(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Int64\n\n\nGet RenewableEnergyVoltageConverterTypeA n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.get_states-Tuple{RenewableEnergyVoltageConverterTypeA}","page":"Converter","title":"PowerSystems.get_states","text":"get_states(\n value::RenewableEnergyVoltageConverterTypeA\n) -> Vector{Symbol}\n\n\nGet RenewableEnergyVoltageConverterTypeA states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Accel!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Accel!","text":"set_Accel!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Accel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Brkpt!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Brkpt!","text":"set_Brkpt!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Brkpt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Io_lim!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Io_lim!","text":"set_Io_lim!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Io_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Iqr_lims!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Iqr_lims!","text":"set_Iqr_lims!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Iqr_lims.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_K_hv!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_K_hv!","text":"set_K_hv!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA K_hv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lv_pnts!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lv_pnts!","text":"set_Lv_pnts!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Lv_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lvpl1!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lvpl1!","text":"set_Lvpl1!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Lvpl1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Lvpl_sw!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Lvpl_sw!","text":"set_Lvpl_sw!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Lvpl_sw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Q_ref!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Rrpwr!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Rrpwr!","text":"set_Rrpwr!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_T_fltr!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_T_fltr!","text":"set_T_fltr!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_T_g!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_T_g!","text":"set_T_g!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Vo_lim!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Vo_lim!","text":"set_Vo_lim!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Vo_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_Zerox!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_Zerox!","text":"set_Zerox!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA Zerox.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Converter/#PowerSystems.set_ext!-Tuple{RenewableEnergyVoltageConverterTypeA, Any}","page":"Converter","title":"PowerSystems.set_ext!","text":"set_ext!(\n value::RenewableEnergyVoltageConverterTypeA,\n val\n) -> Any\n\n\nSet RenewableEnergyVoltageConverterTypeA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#AggregateDistributedGenerationA","page":"AggregateDistributedGenerationA","title":"AggregateDistributedGenerationA","text":"","category":"section"},{"location":"model_library/generated_AggregateDistributedGenerationA/","page":"AggregateDistributedGenerationA","title":"AggregateDistributedGenerationA","text":"Modules = [PowerSystems]\nPages = [\"generated/AggregateDistributedGenerationA.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.AggregateDistributedGenerationA","page":"AggregateDistributedGenerationA","title":"PowerSystems.AggregateDistributedGenerationA","text":"mutable struct AggregateDistributedGenerationA <: DynamicInjection\n name::String\n Pf_Flag::Int\n Freq_Flag::Int\n PQ_Flag::Int\n Gen_Flag::Int\n Vtrip_Flag::Int\n Ftrip_Flag::Int\n T_rv::Float64\n Trf::Float64\n dbd_pnts::Tuple{Float64, Float64}\n K_qv::Float64\n Tp::Float64\n T_iq::Float64\n D_dn::Float64\n D_up::Float64\n fdbd_pnts::Tuple{Float64, Float64}\n fe_lim::MinMax\n P_lim::MinMax\n dP_lim::MinMax\n Tpord::Float64\n Kpg::Float64\n Kig::Float64\n I_max::Float64\n vl_pnts::Vector{Tuple{Float64,Float64}}\n vh_pnts::Vector{Tuple{Float64,Float64}}\n Vrfrac::Float64\n fl::Float64\n fh::Float64\n tfl::Float64\n tfh::Float64\n Tg::Float64\n rrpwr::Float64\n Tv::Float64\n Vpr::Float64\n Iq_lim::MinMax\n V_ref::Float64\n Pfa_ref::Float64\n ω_ref::Float64\n Q_ref::Float64\n P_ref::Float64\n base_power::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of the DERA1 model in PSS/E\n\nArguments\n\nname::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\nPf_Flag::Int: Flag for Power Factor Control, validation range: (0, 1)\nFreq_Flag::Int: Flag to enable/disable frequency control, validation range: (0, 1)\nPQ_Flag::Int: Flag used to enforce maximum current, validation range: (0, 1)\nGen_Flag::Int: Flag to specify generator or storage, validation range: (0, 1)\nVtrip_Flag::Int: Flag to enable/disable voltage trip logic, validation range: (0, 1)\nFtrip_Flag::Int: Flag to enable/disable frequency trip logic, validation range: (0, 1)\nT_rv::Float64: Voltage measurement transducer time constant, validation range: (0, nothing)\nTrf::Float64: Frequency measurement transducer time constant, validation range: (0, nothing)\ndbd_pnts::Tuple{Float64, Float64}: Voltage deadband thresholds (dbd1, dbd2)\nK_qv::Float64: Proportional voltage control gain (pu), validation range: (0, nothing)\nTp::Float64: Power measurement transducer time constant, validation range: (0, nothing)\nT_iq::Float64: Time constant for low-pass filter for state q_V when QFlag = 0, validation range: (0, nothing)\nD_dn::Float64: Reciprocal of droop for over-frequency conditions (>0) (pu), validation range: (0, nothing)\nD_up::Float64: Reciprocal of droop for under-frequency conditions <=0) (pu), validation range: (0, nothing)\nfdbd_pnts::Tuple{Float64, Float64}: Frequency control deadband thresholds (fdbd1, fdbd2)\nfe_lim::MinMax: Frequency error limits (femin, femax)\nP_lim::MinMax: Power limits (Pmin, Pmax)\ndP_lim::MinMax: Power reference ramp rate limits (dPmin, dPmax)\nTpord::Float64: Power filter time constant, validation range: (0, nothing)\nKpg::Float64: PI controller proportional gain (pu), validation range: (0, nothing)\nKig::Float64: PI controller integral gain (pu), validation range: (0, nothing)\nI_max::Float64: Maximum limit on total converter current (pu), validation range: (0, nothing)\nvl_pnts::Vector{Tuple{Float64,Float64}}: Low voltage cutout points [(tv10, vl0), (tv11, vl1)]\nvh_pnts::Vector{Tuple{Float64,Float64}}: High voltage cutout points [(tvh0, vh0), (tvh1, vh1)]\nVrfrac::Float64: Fraction of device that recovers after voltage comes back to within vl1 < V < vh1 (0 <= Vrfrac <= 1), validation range: (0, 1)\nfl::Float64: Inverter frequency break-point for low frequency cut-out (Hz), validation range: (0, nothing)\nfh::Float64: Inverter frequency break-point for high frequency cut-out (Hz), validation range: (0, nothing)\ntfl::Float64: Low frequency cut-out timer corresponding to frequency fl (s), validation range: (0, nothing)\ntfh::Float64: High frequency cut-out timer corresponding to frequency fh (s), validation range: (0, nothing)\nTg::Float64: Current control time constant (to represent behavior of inner control loops) (> 0) (s), validation range: (0, nothing)\nrrpwr::Float64: Ramp rate for real power increase following a fault (pu/s), validation range: (0, nothing)\nTv::Float64: Time constant on the output of the multiplier (s), validation range: (0, nothing)\nVpr::Float64: Voltage below which frequency tripping is disabled (pu), validation range: (0, nothing)\nIq_lim::MinMax: Reactive current injection limits (Iqll, Iqhl)\nV_ref::Float64: (default: 1.0) User defined voltage reference. If 0, PowerSimulationsDynamics.jl initializes to initial terminal voltage, validation range: (0, nothing)\nPfa_ref::Float64: (default: 0.0) Reference power factor, validation range: (0, nothing)\nω_ref::Float64: (default: 1.0) Reference Frequency (pu), validation range: (0, nothing)\nQ_ref::Float64: (default: 0.0) Reference reactive power, in pu, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference active power, in pu, validation range: (0, nothing)\nbase_power::Float64: (default: 100.0) Base power (MVA) for per unitization\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of AggregateDistributedGenerationA depends on the Flags\nn_states::Int: (Do not modify.) The states of AggregateDistributedGenerationA depends on the Flags\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AggregateDistributedGenerationA/#InfrastructureSystems.get_name-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"InfrastructureSystems.get_name","text":"get_name(value::AggregateDistributedGenerationA) -> String\n\n\nGet AggregateDistributedGenerationA name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_D_dn-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_D_dn","text":"get_D_dn(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_D_up-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_D_up","text":"get_D_up(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Freq_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Freq_Flag","text":"get_Freq_Flag(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA Freq_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Ftrip_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Ftrip_Flag","text":"get_Ftrip_Flag(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA Ftrip_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Gen_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Gen_Flag","text":"get_Gen_Flag(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA Gen_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_I_max-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_I_max","text":"get_I_max(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Iq_lim-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Iq_lim","text":"get_Iq_lim(\n value::AggregateDistributedGenerationA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AggregateDistributedGenerationA Iq_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_K_qv-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_K_qv","text":"get_K_qv(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA K_qv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Kig-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Kig","text":"get_Kig(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Kig.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Kpg-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Kpg","text":"get_Kpg(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Kpg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_PQ_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_PQ_Flag","text":"get_PQ_Flag(value::AggregateDistributedGenerationA) -> Int64\n\n\nGet AggregateDistributedGenerationA PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_P_lim-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_P_lim","text":"get_P_lim(\n value::AggregateDistributedGenerationA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AggregateDistributedGenerationA P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_P_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Pf_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Pf_Flag","text":"get_Pf_Flag(value::AggregateDistributedGenerationA) -> Int64\n\n\nGet AggregateDistributedGenerationA Pf_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Pfa_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Pfa_ref","text":"get_Pfa_ref(\n value::AggregateDistributedGenerationA\n) -> Float64\n\n\nGet AggregateDistributedGenerationA Pfa_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Q_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_T_iq-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_T_iq","text":"get_T_iq(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA T_iq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_T_rv-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_T_rv","text":"get_T_rv(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA T_rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Tg-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Tg","text":"get_Tg(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Tp-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Tp","text":"get_Tp(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Tp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Tpord-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Tpord","text":"get_Tpord(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Tpord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Trf-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Trf","text":"get_Trf(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Trf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Tv-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Tv","text":"get_Tv(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Tv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_V_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Vpr-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Vpr","text":"get_Vpr(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA Vpr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Vrfrac-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Vrfrac","text":"get_Vrfrac(\n value::AggregateDistributedGenerationA\n) -> Float64\n\n\nGet AggregateDistributedGenerationA Vrfrac.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_Vtrip_Flag-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_Vtrip_Flag","text":"get_Vtrip_Flag(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA Vtrip_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_base_power-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_base_power","text":"get_base_power(\n value::AggregateDistributedGenerationA\n) -> Float64\n\n\nGet AggregateDistributedGenerationA base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_dP_lim-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_dP_lim","text":"get_dP_lim(\n value::AggregateDistributedGenerationA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AggregateDistributedGenerationA dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_dbd_pnts-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_dbd_pnts","text":"get_dbd_pnts(\n value::AggregateDistributedGenerationA\n) -> Tuple{Float64, Float64}\n\n\nGet AggregateDistributedGenerationA dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_ext-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_ext","text":"get_ext(\n value::AggregateDistributedGenerationA\n) -> Dict{String, Any}\n\n\nGet AggregateDistributedGenerationA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_fdbd_pnts-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_fdbd_pnts","text":"get_fdbd_pnts(\n value::AggregateDistributedGenerationA\n) -> Tuple{Float64, Float64}\n\n\nGet AggregateDistributedGenerationA fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_fe_lim-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_fe_lim","text":"get_fe_lim(\n value::AggregateDistributedGenerationA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AggregateDistributedGenerationA fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_fh-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_fh","text":"get_fh(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA fh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_fl-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_fl","text":"get_fl(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA fl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_n_states-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_n_states","text":"get_n_states(\n value::AggregateDistributedGenerationA\n) -> Int64\n\n\nGet AggregateDistributedGenerationA n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_rrpwr-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_rrpwr","text":"get_rrpwr(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_states-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_states","text":"get_states(\n value::AggregateDistributedGenerationA\n) -> Vector{Symbol}\n\n\nGet AggregateDistributedGenerationA states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_tfh-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_tfh","text":"get_tfh(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA tfh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_tfl-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_tfl","text":"get_tfl(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA tfl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_vh_pnts-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_vh_pnts","text":"get_vh_pnts(\n value::AggregateDistributedGenerationA\n) -> Vector{Tuple{Float64, Float64}}\n\n\nGet AggregateDistributedGenerationA vh_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_vl_pnts-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_vl_pnts","text":"get_vl_pnts(\n value::AggregateDistributedGenerationA\n) -> Vector{Tuple{Float64, Float64}}\n\n\nGet AggregateDistributedGenerationA vl_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.get_ω_ref-Tuple{AggregateDistributedGenerationA}","page":"AggregateDistributedGenerationA","title":"PowerSystems.get_ω_ref","text":"get_ω_ref(value::AggregateDistributedGenerationA) -> Float64\n\n\nGet AggregateDistributedGenerationA ω_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_D_dn!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_D_dn!","text":"set_D_dn!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_D_up!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_D_up!","text":"set_D_up!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Freq_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Freq_Flag!","text":"set_Freq_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Freq_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Ftrip_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Ftrip_Flag!","text":"set_Ftrip_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Ftrip_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Gen_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Gen_Flag!","text":"set_Gen_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Gen_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_I_max!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_I_max!","text":"set_I_max!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Iq_lim!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Iq_lim!","text":"set_Iq_lim!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Iq_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_K_qv!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_K_qv!","text":"set_K_qv!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA K_qv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Kig!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Kig!","text":"set_Kig!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Kig.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Kpg!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Kpg!","text":"set_Kpg!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Kpg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_PQ_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_PQ_Flag!","text":"set_PQ_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_P_lim!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_P_lim!","text":"set_P_lim!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_P_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Pf_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Pf_Flag!","text":"set_Pf_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Pf_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Pfa_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Pfa_ref!","text":"set_Pfa_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Pfa_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Q_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_T_iq!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_T_iq!","text":"set_T_iq!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA T_iq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_T_rv!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_T_rv!","text":"set_T_rv!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA T_rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Tg!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Tg!","text":"set_Tg!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Tp!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Tp!","text":"set_Tp!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Tp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Tpord!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Tpord!","text":"set_Tpord!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Tpord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Trf!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Trf!","text":"set_Trf!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Trf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Tv!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Tv!","text":"set_Tv!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Tv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_V_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Vpr!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Vpr!","text":"set_Vpr!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA Vpr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Vrfrac!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Vrfrac!","text":"set_Vrfrac!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Vrfrac.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_Vtrip_Flag!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_Vtrip_Flag!","text":"set_Vtrip_Flag!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA Vtrip_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_base_power!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_base_power!","text":"set_base_power!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_dP_lim!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_dP_lim!","text":"set_dP_lim!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_dbd_pnts!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_dbd_pnts!","text":"set_dbd_pnts!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_ext!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_ext!","text":"set_ext!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_fdbd_pnts!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_fdbd_pnts!","text":"set_fdbd_pnts!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_fe_lim!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_fe_lim!","text":"set_fe_lim!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_fh!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_fh!","text":"set_fh!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA fh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_fl!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_fl!","text":"set_fl!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA fl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_rrpwr!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_rrpwr!","text":"set_rrpwr!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_tfh!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_tfh!","text":"set_tfh!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA tfh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_tfl!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_tfl!","text":"set_tfl!(value::AggregateDistributedGenerationA, val) -> Any\n\n\nSet AggregateDistributedGenerationA tfl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_vh_pnts!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_vh_pnts!","text":"set_vh_pnts!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA vh_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_vl_pnts!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_vl_pnts!","text":"set_vl_pnts!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA vl_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AggregateDistributedGenerationA/#PowerSystems.set_ω_ref!-Tuple{AggregateDistributedGenerationA, Any}","page":"AggregateDistributedGenerationA","title":"PowerSystems.set_ω_ref!","text":"set_ω_ref!(\n value::AggregateDistributedGenerationA,\n val\n) -> Any\n\n\nSet AggregateDistributedGenerationA ω_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PhaseShiftingTransformer","page":"PhaseShiftingTransformer","title":"PhaseShiftingTransformer","text":"","category":"section"},{"location":"model_library/generated_PhaseShiftingTransformer/","page":"PhaseShiftingTransformer","title":"PhaseShiftingTransformer","text":"Modules = [PowerSystems]\nPages = [\"generated/PhaseShiftingTransformer.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.PhaseShiftingTransformer","page":"PhaseShiftingTransformer","title":"PowerSystems.PhaseShiftingTransformer","text":"mutable struct PhaseShiftingTransformer <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n primary_shunt::Float64\n tap::Float64\n α::Float64\n rating::Union{Nothing, Float64}\n phase_angle_limits::MinMax\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA phase-shifting transformer regulating the phase angle between two buses to control active power flow in the system.\n\nThe 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow through the transformer (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow through the transformer (MVAR)\narc::Arc: An Arc defining this transformer from a bus to another bus\nr::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)\nx::Float64: Reactance in pu (SYSTEM_BASE), validation range: (-2, 4)\nprimary_shunt::Float64:, validation range: (0, 2)\ntap::Float64: Normalized tap changer position for voltage control, varying between 0 and 2, with 1 centered at the nominal voltage, validation range: (0, 2)\nα::Float64: Initial condition of phase shift (radians) between the from and to buses , validation range: (-1.571, 1.571)\nrating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating and rating. When defining a transformer before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to, validation range: (0, nothing)\nphase_angle_limits::MinMax: (default: (min=-1.571, max=1.571)) Minimum and maximum phase angle limits (radians), validation range: (-1.571, 1.571)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PhaseShiftingTransformer/#InfrastructureSystems.get_name-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"InfrastructureSystems.get_name","text":"get_name(value::PhaseShiftingTransformer) -> String\n\n\nGet PhaseShiftingTransformer name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_active_power_flow-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(\n value::PhaseShiftingTransformer\n) -> Any\n\n\nGet PhaseShiftingTransformer active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_arc-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_arc","text":"get_arc(value::PhaseShiftingTransformer) -> Arc\n\n\nGet PhaseShiftingTransformer arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_available-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_available","text":"get_available(value::PhaseShiftingTransformer) -> Bool\n\n\nGet PhaseShiftingTransformer available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_ext-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_ext","text":"get_ext(\n value::PhaseShiftingTransformer\n) -> Dict{String, Any}\n\n\nGet PhaseShiftingTransformer ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_phase_angle_limits-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_phase_angle_limits","text":"get_phase_angle_limits(\n value::PhaseShiftingTransformer\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet PhaseShiftingTransformer phase_angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_primary_shunt-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_primary_shunt","text":"get_primary_shunt(\n value::PhaseShiftingTransformer\n) -> Float64\n\n\nGet PhaseShiftingTransformer primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_r-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_r","text":"get_r(value::PhaseShiftingTransformer) -> Float64\n\n\nGet PhaseShiftingTransformer r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_rating-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_rating","text":"get_rating(value::PhaseShiftingTransformer) -> Any\n\n\nGet PhaseShiftingTransformer rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_reactive_power_flow-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(\n value::PhaseShiftingTransformer\n) -> Any\n\n\nGet PhaseShiftingTransformer reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_services-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_services","text":"get_services(\n value::PhaseShiftingTransformer\n) -> Vector{Service}\n\n\nGet PhaseShiftingTransformer services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_tap-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_tap","text":"get_tap(value::PhaseShiftingTransformer) -> Float64\n\n\nGet PhaseShiftingTransformer tap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_x-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_x","text":"get_x(value::PhaseShiftingTransformer) -> Float64\n\n\nGet PhaseShiftingTransformer x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.get_α-Tuple{PhaseShiftingTransformer}","page":"PhaseShiftingTransformer","title":"PowerSystems.get_α","text":"get_α(value::PhaseShiftingTransformer) -> Float64\n\n\nGet PhaseShiftingTransformer α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_active_power_flow!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::PhaseShiftingTransformer,\n val\n) -> Any\n\n\nSet PhaseShiftingTransformer active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_arc!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_arc!","text":"set_arc!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_available!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_available!","text":"set_available!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_ext!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_ext!","text":"set_ext!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_phase_angle_limits!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_phase_angle_limits!","text":"set_phase_angle_limits!(\n value::PhaseShiftingTransformer,\n val\n) -> Any\n\n\nSet PhaseShiftingTransformer phase_angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_primary_shunt!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_primary_shunt!","text":"set_primary_shunt!(\n value::PhaseShiftingTransformer,\n val\n) -> Any\n\n\nSet PhaseShiftingTransformer primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_r!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_r!","text":"set_r!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_rating!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_rating!","text":"set_rating!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_reactive_power_flow!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(\n value::PhaseShiftingTransformer,\n val\n) -> Any\n\n\nSet PhaseShiftingTransformer reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_services!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_services!","text":"set_services!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_tap!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_tap!","text":"set_tap!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer tap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_x!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_x!","text":"set_x!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PhaseShiftingTransformer/#PowerSystems.set_α!-Tuple{PhaseShiftingTransformer, Any}","page":"PhaseShiftingTransformer","title":"PowerSystems.set_α!","text":"set_α!(value::PhaseShiftingTransformer, val) -> Any\n\n\nSet PhaseShiftingTransformer α.\n\n\n\n\n\n","category":"method"},{"location":"explanation/system/#system_doc","page":"System","title":"System","text":"","category":"section"},{"location":"explanation/system/","page":"System","title":"System","text":"The System is the main container of components and the time series data references. PowerSystems.jl uses a hybrid approach to data storage, where the component data and time series references are stored in volatile memory while the actual time series data is stored in an HDF5 file. This design loads into memory the portions of the data that are relevant at time of the query, and so avoids overwhelming the memory resources.","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"","category":"page"},{"location":"explanation/system/#Accessing-components-stored-in-the-System","page":"System","title":"Accessing components stored in the System","text":"","category":"section"},{"location":"explanation/system/","page":"System","title":"System","text":"PowerSystems.jl implements a wide variety of methods to search for components to aid in data manipulation. Most of these use the Type Structure to retrieve all components of a certain Type.","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"For example, the most common search function is get_components, which takes a desired device Type (concrete or abstract) and retrieves all components in that category from the System. It also accepts filter functions for a more refined search.","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"Given the potential size of the return, PowerSystems.jl returns Julia iterators in order to avoid unnecessary memory allocations. The container is optimized for iteration over abstract or concrete component types as described by the Type Structure.","category":"page"},{"location":"explanation/system/#dot_access","page":"System","title":"Accessing data stored in a component","text":"","category":"section"},{"location":"explanation/system/","page":"System","title":"System","text":"Using the \"dot\" access to get a parameter value from a component is actively discouraged, use \"getter\" functions instead","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"Using code autogeneration, PowerSystems.jl implements accessor (or \"getter\") functions to enable the retrieval of parameters defined in the component struct fields. Julia syntax enables access to this data using the \"dot\" access (e.g. component.field), however this is actively discouraged for two reasons:","category":"page"},{"location":"explanation/system/","page":"System","title":"System","text":"We make no guarantees on the stability of component structure definitions. We will maintain version stability on the accessor methods.\nPer-unit conversions are made in the return of data from the accessor functions. (see the per-unit section for more details)","category":"page"},{"location":"model_library/generated_PeriodicVariableSource/#PeriodicVariableSource","page":"PeriodicVariableSource","title":"PeriodicVariableSource","text":"","category":"section"},{"location":"model_library/generated_PeriodicVariableSource/","page":"PeriodicVariableSource","title":"PeriodicVariableSource","text":"Modules = [PowerSystems]\nPages = [\"generated/PeriodicVariableSource.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.PeriodicVariableSource","page":"PeriodicVariableSource","title":"PowerSystems.PeriodicVariableSource","text":"mutable struct PeriodicVariableSource <: DynamicInjection\n name::String\n R_th::Float64\n X_th::Float64\n internal_voltage_bias::Float64\n internal_voltage_frequencies::Vector{Float64}\n internal_voltage_coefficients::Vector{Tuple{Float64,Float64}}\n internal_angle_bias::Float64\n internal_angle_frequencies::Vector{Float64}\n internal_angle_coefficients::Vector{Tuple{Float64,Float64}}\n base_power::Float64\n states::Vector{Symbol}\n n_states::Int\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nThis struct acts as an infinity bus with time varying phasor values magnitude and angle V(t) \theta(t). Time varying functions are represented using fourier series\n\nArguments\n\nname::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\nR_th::Float64: Source Thevenin resistance, validation range: (0, nothing)\nX_th::Float64: Source Thevenin reactance, validation range: (0, nothing)\ninternal_voltage_bias::Float64: (default: 0.0) a0 term of the Fourier Series for the voltage\ninternal_voltage_frequencies::Vector{Float64}: (default: [0.0]) Frequencies in radians/s\ninternal_voltage_coefficients::Vector{Tuple{Float64,Float64}}: (default: [(0.0, 0.0)]) Coefficients for terms n > 1. First component corresponds to sin and second component to cos\ninternal_angle_bias::Float64: (default: 0.0) a0 term of the Fourier Series for the angle\ninternal_angle_frequencies::Vector{Float64}: (default: [0.0]) Frequencies in radians/s\ninternal_angle_coefficients::Vector{Tuple{Float64,Float64}}: (default: [(0.0, 0.0)]) Coefficients for terms n > 1. First component corresponds to sin and second component to cos\nbase_power::Float64: (default: 100.0) Base power of the source (MVA) for per unitization\nstates::Vector{Symbol}: (Do not modify.) The states for time, voltage and angle\nn_states::Int: (Do not modify.) PeriodicVariableSource has 2 states\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PeriodicVariableSource/#InfrastructureSystems.get_name-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"InfrastructureSystems.get_name","text":"get_name(value::PeriodicVariableSource) -> String\n\n\nGet PeriodicVariableSource name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_R_th-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_R_th","text":"get_R_th(value::PeriodicVariableSource) -> Float64\n\n\nGet PeriodicVariableSource R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_X_th-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_X_th","text":"get_X_th(value::PeriodicVariableSource) -> Float64\n\n\nGet PeriodicVariableSource X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_base_power-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_base_power","text":"get_base_power(value::PeriodicVariableSource) -> Float64\n\n\nGet PeriodicVariableSource base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_ext-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_ext","text":"get_ext(value::PeriodicVariableSource) -> Dict{String, Any}\n\n\nGet PeriodicVariableSource ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_angle_bias-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_angle_bias","text":"get_internal_angle_bias(\n value::PeriodicVariableSource\n) -> Float64\n\n\nGet PeriodicVariableSource internal_angle_bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_angle_coefficients-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_angle_coefficients","text":"get_internal_angle_coefficients(\n value::PeriodicVariableSource\n) -> Vector{Tuple{Float64, Float64}}\n\n\nGet PeriodicVariableSource internal_angle_coefficients.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_angle_frequencies-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_angle_frequencies","text":"get_internal_angle_frequencies(\n value::PeriodicVariableSource\n) -> Vector{Float64}\n\n\nGet PeriodicVariableSource internal_angle_frequencies.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_voltage_bias-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_voltage_bias","text":"get_internal_voltage_bias(\n value::PeriodicVariableSource\n) -> Float64\n\n\nGet PeriodicVariableSource internal_voltage_bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_voltage_coefficients-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_voltage_coefficients","text":"get_internal_voltage_coefficients(\n value::PeriodicVariableSource\n) -> Vector{Tuple{Float64, Float64}}\n\n\nGet PeriodicVariableSource internal_voltage_coefficients.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_internal_voltage_frequencies-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_internal_voltage_frequencies","text":"get_internal_voltage_frequencies(\n value::PeriodicVariableSource\n) -> Vector{Float64}\n\n\nGet PeriodicVariableSource internal_voltage_frequencies.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_n_states-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_n_states","text":"get_n_states(value::PeriodicVariableSource) -> Int64\n\n\nGet PeriodicVariableSource n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.get_states-Tuple{PeriodicVariableSource}","page":"PeriodicVariableSource","title":"PowerSystems.get_states","text":"get_states(value::PeriodicVariableSource) -> Vector{Symbol}\n\n\nGet PeriodicVariableSource states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_R_th!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_R_th!","text":"set_R_th!(value::PeriodicVariableSource, val) -> Any\n\n\nSet PeriodicVariableSource R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_X_th!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_X_th!","text":"set_X_th!(value::PeriodicVariableSource, val) -> Any\n\n\nSet PeriodicVariableSource X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_base_power!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::PeriodicVariableSource, val) -> Any\n\n\nSet PeriodicVariableSource base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_ext!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_ext!","text":"set_ext!(value::PeriodicVariableSource, val) -> Any\n\n\nSet PeriodicVariableSource ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_angle_bias!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_angle_bias!","text":"set_internal_angle_bias!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_angle_bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_angle_coefficients!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_angle_coefficients!","text":"set_internal_angle_coefficients!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_angle_coefficients.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_angle_frequencies!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_angle_frequencies!","text":"set_internal_angle_frequencies!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_angle_frequencies.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_voltage_bias!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_voltage_bias!","text":"set_internal_voltage_bias!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_voltage_bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_voltage_coefficients!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_voltage_coefficients!","text":"set_internal_voltage_coefficients!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_voltage_coefficients.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PeriodicVariableSource/#PowerSystems.set_internal_voltage_frequencies!-Tuple{PeriodicVariableSource, Any}","page":"PeriodicVariableSource","title":"PowerSystems.set_internal_voltage_frequencies!","text":"set_internal_voltage_frequencies!(\n value::PeriodicVariableSource,\n val\n) -> Any\n\n\nSet PeriodicVariableSource internal_voltage_frequencies.\n\n\n\n\n\n","category":"method"},{"location":"api/enumerated_types/#Specifying-the-type-of...","page":"Specifying the category of...","title":"Specifying the type of...","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Some fields in PowerSystems.jl are specified with an option from a pre-defined list (Specified with IS.scoped_enums).","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Example syntax:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"set_fuel!(gen, ThermalFuels.COAL)","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"These predefined lists are below:","category":"page"},{"location":"api/enumerated_types/#acbustypes_list","page":"Specifying the category of...","title":"AC Buses","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"ACBusTypes categorize buses for modeling activities and denote which quantities are specified for load flow calculations. ACBusTypes has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name Description\nISOLATED Disconnected from network\nPQ Active and reactive power defined (load bus)\nPV Active power and voltage magnitude defined (generator bus)\nREF Reference bus (θ = 0)\nSLACK Slack bus","category":"page"},{"location":"api/enumerated_types/#pm_list","page":"Specifying the category of...","title":"Prime Movers","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Each generator contains a field for prime_mover::PrimeMovers, based on the options in EIA form 923. PrimeMovers has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name Description\nBA Energy Storage, Battery\nBT Turbines Used in a Binary Cycle (including those used for geothermal applications)\nCA Combined-Cycle – Steam Part\nCC Combined-Cycle - Aggregated Plant *augmentation of EIA\nCE Energy Storage, Compressed Air\nCP Energy Storage, Concentrated Solar Power\nCS Combined-Cycle Single-Shaft Combustion turbine and steam turbine share a single generator\nCT Combined-Cycle Combustion Turbine Part\nES Energy Storage, Other\nFC Fuel Cell\nFW Energy Storage, Flywheel\nGT Combustion (Gas) Turbine (including jet engine design)\nHA Hydrokinetic, Axial Flow Turbine\nHB Hydrokinetic, Wave Buoy\nHK Hydrokinetic, Other\nHY Hydraulic Turbine (including turbines associated with delivery of water by pipeline)\nIC Internal Combustion (diesel, piston, reciprocating) Engine\nPS Energy Storage, Reversible Hydraulic Turbine (Pumped Storage)\nOT Other\nST Steam Turbine (including nuclear, geothermal and solar steam; does not include combined-cycle turbine)\nPVe Photovoltaic (Note: renaming from EIA PV to PVe to avoid conflict with ACBusType.PV)\nWT Wind Turbine, Onshore\nWS Wind Turbine, Offshore","category":"page"},{"location":"api/enumerated_types/#tf_list","page":"Specifying the category of...","title":"Fuels for Thermal Generators","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Each ThermalGen generator has a field for fuel::ThermalFuels where ThermalFuels are intended to reflect the options in the Aggregated Fuel Codes from the EIA Annual Energy Review. ThermalFuels has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name EIA Fuel Code Description\nCOAL COL Anthracite Coal and Bituminous Coal\nWASTE_COAL WOC Waste/Other Coal (includes anthracite culm, gob, fine coal, lignite waste, waste coal)\nDISTILLATE_FUEL_OIL DFO Distillate Fuel Oil (Diesel, No. 1, No. 2, and No. 4)\nWASTE_OIL WOO Waste Oil Kerosene and JetFuel Butane, Propane\nPETROLEUM_COKE PC Petroleum Coke\nRESIDUAL_FUEL_OIL RFO Residual Fuel Oil (No. 5, No. 6 Fuel Oils, and Bunker Oil)\nNATURAL_GAS NG Natural Gas\nOTHER_GAS OOG Other Gas and blast furnace gas\nNUCLEAR NUC Nuclear Fission (Uranium, Plutonium, Thorium)\nAG_BIPRODUCT ORW Agricultural Crop Byproducts/Straw/Energy Crops\nMUNICIPAL_WASTE MLG Municipal Solid Waste – Biogenic component\nWOOD_WASTE WWW Wood Waste Liquids excluding Black Liquor (BLQ) (Includes red liquor, sludge wood, spent sulfite liquor, and other wood-based liquids)\nGEOTHERMAL GEO Geothermal\nOTHER OTH Other","category":"page"},{"location":"api/enumerated_types/#storagetech_list","page":"Specifying the category of...","title":"Energy Storage","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"StorageTech defines the storage technology used in an energy Storage system, based on the options in EIA form 923. StorageTech has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name Description\nPTES Pumped thermal energy storage\nLIB LiON Battery\nLAB Lead Acid Battery\nFLWB Redox Flow Battery\nSIB Sodium Ion Battery\nZIB Zinc Ion Battery\nHGS Hydrogen Gas Storage\nLAES Liquid Air Storage\nOTHER_CHEM Other Chemical Storage\nOTHER_MECH Other Mechanical Storage\nOTHER_THERM Other Thermal Storage","category":"page"},{"location":"api/enumerated_types/#states_list","page":"Specifying the category of...","title":"Dynamic States","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"StateTypes are used to denote the type of dynamic equation a specific state is subject to in PowerSimulationsDynamics.jl. StateTypes has the options:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name Description\nDifferential State evolves over time via a differential equation dotx = f(x)\nAlgebraic State evolves over time by satisfying an algebraic equation 0 = g(x)\nHybrid Depending on specific parameters, the state can be Differential or Algebraic","category":"page"},{"location":"api/enumerated_types/#angleunits_list","page":"Specifying the category of...","title":"Angle Units","text":"","category":"section"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"AngleUnits can be specified in:","category":"page"},{"location":"api/enumerated_types/","page":"Specifying the category of...","title":"Specifying the category of...","text":"Name\nDEGREES\nRADIANS","category":"page"},{"location":"model_library/load_cost/#LoadCost","page":"LoadCost","title":"LoadCost","text":"","category":"section"},{"location":"model_library/load_cost/","page":"LoadCost","title":"LoadCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/LoadCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/load_cost/#PowerSystems.LoadCost","page":"LoadCost","title":"PowerSystems.LoadCost","text":"mutable struct LoadCost <: OperationalCost\n\nvariable::CostCurve: Variable cost represented as a CostCurve\nfixed::Float64: (default: 0) Fixed cost. For some cost represenations this field can be duplicative\n\nLoadCost(variable, fixed)\nLoadCost(; variable, fixed)\n\nAn operational cost for controllable loads (e.g., InterruptiblePowerLoad), including fixed and variable cost components.\n\nThe variable cost is a required parameter, but zero(CostCurve) can be used to set it to 0.\n\n\n\n\n\n","category":"type"},{"location":"model_library/load_cost/#PowerSystems.get_fixed-Tuple{LoadCost}","page":"LoadCost","title":"PowerSystems.get_fixed","text":"get_fixed(value::LoadCost) -> Float64\n\n\nGet LoadCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/load_cost/#PowerSystems.get_variable-Tuple{LoadCost}","page":"LoadCost","title":"PowerSystems.get_variable","text":"get_variable(value::LoadCost) -> CostCurve\n\n\nGet LoadCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/load_cost/#PowerSystems.set_fixed!-Tuple{LoadCost, Any}","page":"LoadCost","title":"PowerSystems.set_fixed!","text":"set_fixed!(value::LoadCost, val) -> Any\n\n\nSet LoadCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/load_cost/#PowerSystems.set_variable!-Tuple{LoadCost, Any}","page":"LoadCost","title":"PowerSystems.set_variable!","text":"set_variable!(value::LoadCost, val) -> Any\n\n\nSet LoadCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#ThermalGenerationCost","page":"ThermalGenerationCost","title":"ThermalGenerationCost","text":"","category":"section"},{"location":"model_library/thermal_generation_cost/","page":"ThermalGenerationCost","title":"ThermalGenerationCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/ThermalGenerationCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/thermal_generation_cost/#PowerSystems.ThermalGenerationCost","page":"ThermalGenerationCost","title":"PowerSystems.ThermalGenerationCost","text":"mutable struct ThermalGenerationCost <: OperationalCost\n\nvariable::ProductionVariableCostCurve: Variable production cost. Can take a CostCurve or FuelCurve\nfixed::Float64: Fixed cost of keeping the unit online. For some cost represenations this field can be duplicative\nstart_up::Union{Float64, @NamedTuple{hot::Float64, warm::Float64, cold::Float64}}: Start-up cost can take linear or multi-stage cost\nshut_down::Float64: Cost to turn the unit off\n\nThermalGenerationCost(variable, fixed, start_up, shut_down)\nThermalGenerationCost(; variable, fixed, start_up, shut_down)\n\nAn operational cost for thermal generators which includes fixed cost, variable cost, shut-down cost, and multiple options for start up costs.\n\n\n\n\n\n","category":"type"},{"location":"model_library/thermal_generation_cost/#PowerSystems.get_fixed-Tuple{ThermalGenerationCost}","page":"ThermalGenerationCost","title":"PowerSystems.get_fixed","text":"get_fixed(value::ThermalGenerationCost) -> Float64\n\n\nGet ThermalGenerationCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.get_shut_down-Tuple{ThermalGenerationCost}","page":"ThermalGenerationCost","title":"PowerSystems.get_shut_down","text":"get_shut_down(value::ThermalGenerationCost) -> Float64\n\n\nGet ThermalGenerationCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.get_start_up-Tuple{ThermalGenerationCost}","page":"ThermalGenerationCost","title":"PowerSystems.get_start_up","text":"get_start_up(\n value::ThermalGenerationCost\n) -> Union{Float64, @NamedTuple{hot::Float64, warm::Float64, cold::Float64}}\n\n\nGet ThermalGenerationCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.get_variable-Tuple{ThermalGenerationCost}","page":"ThermalGenerationCost","title":"PowerSystems.get_variable","text":"get_variable(\n value::ThermalGenerationCost\n) -> ProductionVariableCostCurve\n\n\nGet ThermalGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.set_fixed!-Tuple{ThermalGenerationCost, Any}","page":"ThermalGenerationCost","title":"PowerSystems.set_fixed!","text":"set_fixed!(value::ThermalGenerationCost, val) -> Any\n\n\nSet ThermalGenerationCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.set_shut_down!-Tuple{ThermalGenerationCost, Any}","page":"ThermalGenerationCost","title":"PowerSystems.set_shut_down!","text":"set_shut_down!(value::ThermalGenerationCost, val) -> Any\n\n\nSet ThermalGenerationCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.set_start_up!-Tuple{ThermalGenerationCost, Any}","page":"ThermalGenerationCost","title":"PowerSystems.set_start_up!","text":"set_start_up!(value::ThermalGenerationCost, val) -> Any\n\n\nSet ThermalGenerationCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/thermal_generation_cost/#PowerSystems.set_variable!-Tuple{ThermalGenerationCost, Any}","page":"ThermalGenerationCost","title":"PowerSystems.set_variable!","text":"set_variable!(value::ThermalGenerationCost, val) -> Any\n\n\nSet ThermalGenerationCost variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerLoad","page":"PowerLoad","title":"PowerLoad","text":"","category":"section"},{"location":"model_library/generated_PowerLoad/","page":"PowerLoad","title":"PowerLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/PowerLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_PowerLoad/#PowerSystems.PowerLoad","page":"PowerLoad","title":"PowerSystems.PowerLoad","text":"mutable struct PowerLoad <: StaticLoad\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n base_power::Float64\n max_active_power::Float64\n max_reactive_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA static power load, most commonly used for operational models such as power flow and operational optimizations.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_power::Float64: Initial steady-state active power demand (MW)\nreactive_power::Float64: Initial steady-state reactive power demand (MVAR)\nbase_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)\nmax_active_power::Float64: Maximum active power (MW) that this load can demand\nmax_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_PowerLoad/#InfrastructureSystems.get_name-Tuple{PowerLoad}","page":"PowerLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::PowerLoad) -> String\n\n\nGet PowerLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_active_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_active_power","text":"get_active_power(value::PowerLoad) -> Any\n\n\nGet PowerLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_available-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_available","text":"get_available(value::PowerLoad) -> Bool\n\n\nGet PowerLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_base_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::PowerLoad) -> Float64\n\n\nGet PowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_bus-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_bus","text":"get_bus(value::PowerLoad) -> ACBus\n\n\nGet PowerLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_dynamic_injector-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::PowerLoad\n) -> Union{Nothing, DynamicInjection}\n\n\nGet PowerLoad dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_ext-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_ext","text":"get_ext(value::PowerLoad) -> Dict{String, Any}\n\n\nGet PowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_max_active_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(value::PowerLoad) -> Any\n\n\nGet PowerLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_max_reactive_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(value::PowerLoad) -> Any\n\n\nGet PowerLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_reactive_power-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::PowerLoad) -> Any\n\n\nGet PowerLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.get_services-Tuple{PowerLoad}","page":"PowerLoad","title":"PowerSystems.get_services","text":"get_services(value::PowerLoad) -> Vector{Service}\n\n\nGet PowerLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_active_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_available!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_available!","text":"set_available!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_base_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_bus!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_bus!","text":"set_bus!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_ext!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_max_active_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_max_active_power!","text":"set_max_active_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_max_reactive_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_max_reactive_power!","text":"set_max_reactive_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_reactive_power!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_PowerLoad/#PowerSystems.set_services!-Tuple{PowerLoad, Any}","page":"PowerLoad","title":"PowerSystems.set_services!","text":"set_services!(value::PowerLoad, val) -> Any\n\n\nSet PowerLoad services.\n\n\n\n\n\n","category":"method"},{"location":"tutorials/working_with_time_series/#tutorial_time_series","page":"Working with Time Series","title":"Working with Time Series Data","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"In this tutorial, we will manually add, retrieve, and inspect time-series data in different formats, including identifying which components in a power System have time series data. Along the way, we will also use workarounds for missing forecast data and reuse identical time series profiles to avoid unnecessary memory usage.","category":"page"},{"location":"tutorials/working_with_time_series/#Example-Data-and-Setup","page":"Working with Time Series","title":"Example Data and Setup","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"We will make an example System with a wind generator and two loads, and add the time series needed to model, for example, the impacts of wind forecast uncertainty.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Here is the available data:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"For the wind generator, we have the historical point (deterministic) forecasts of power output. The forecasts were generated every 30 minutes with a 5-minute resolution and 1-hour horizon. We also have measurements what actually happened at 5-minute resolution over the 2 hours.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"For the loads, note that the forecast data is missing. We only have the historical measurements of total load for the system, which is normalized to the system's peak load.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Load the PowerSystems, Dates, and TimeSeries packages to get started:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"using PowerSystems\nusing Dates\nusing TimeSeries","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"As usual, we need to define a power System that holds all our data. Let's define a simple system with a bus, a wind generator, and two loads:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"system = System(100.0); # 100 MVA base power\n\nbus1 = ACBus(;\n number = 1,\n name = \"bus1\",\n bustype = ACBusTypes.REF,\n angle = 0.0,\n magnitude = 1.0,\n voltage_limits = (min = 0.9, max = 1.05),\n base_voltage = 230.0,\n);\n\nwind1 = RenewableDispatch(;\n name = \"wind1\",\n available = true,\n bus = bus1,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n rating = 1.0, # 10 MW per-unitized by device base_power\n prime_mover_type = PrimeMovers.WT,\n reactive_power_limits = (min = 0.0, max = 0.0), # per-unitized by device base_power\n power_factor = 1.0,\n operation_cost = RenewableGenerationCost(nothing),\n base_power = 10.0, # MVA\n);\n\nload1 = PowerLoad(;\n name = \"load1\",\n available = true,\n bus = bus1,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n base_power = 10.0, # MVA\n max_active_power = 1.0, # 10 MW per-unitized by device base_power\n max_reactive_power = 0.0,\n);\n\nload2 = PowerLoad(;\n name = \"load2\",\n available = true,\n bus = bus1,\n active_power = 0.0, # Per-unitized by device base_power\n reactive_power = 0.0, # Per-unitized by device base_power\n base_power = 30.0, # MVA\n max_active_power = 1.0, # 10 MW per-unitized by device base_power\n max_reactive_power = 0.0,\n);\n\nadd_components!(system, [bus1, wind1, load1, load2])","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Recall that we can also set the System's unit base to natural units (MW) to make it easier to inspect results:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"set_units_base_system!(system, \"NATURAL_UNITS\")","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Before we get started, print wind1 to see its data:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind1","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See the has_time_series field at the bottom is false.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Recall that we also can see a summary of the system by printing it:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"system","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Observe that there is no mention of time series data in the system yet.","category":"page"},{"location":"tutorials/working_with_time_series/#Add-and-Retrieve-a-Single-Time-Series","page":"Working with Time Series","title":"Add and Retrieve a Single Time Series","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's start by defining and attaching the wind measurements shown in the data above. This is a single time series profile, so we will use a SingleTimeSeries.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"First, define a TimeSeries.TimeArray of input data, using the 5-minute resolution to define the time-stamps in the example data:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind_values = [6.0, 7, 7, 6, 7, 9, 9, 9, 8, 8, 7, 6, 5, 5, 5, 5, 5, 6, 6, 6, 7, 6, 7, 7];\nresolution = Dates.Minute(5);\ntimestamps = range(DateTime(\"2020-01-01T08:00:00\"); step = resolution, length = 24);\nwind_timearray = TimeArray(timestamps, wind_values);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now, use the input data to define a Single Time Series in PowerSystems:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind_time_series = SingleTimeSeries(;\n name = \"max_active_power\",\n data = wind_timearray,\n);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Note that we've chosen the name max_active_power, which is the default time series profile name when using PowerSimulations.jl for simulations.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"So far, this time series has been defined, but not attached to our System in any way. Now, attach it to wind1 using add_time_series!:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"add_time_series!(system, wind1, wind_time_series);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's double-check this worked by calling show_time_series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now wind1 has the first time-series data set. Recall that you can also print wind1 and check the has_time_series field like we did above.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, let's retrieve and inspect the new timeseries, using get_time_series_array:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(SingleTimeSeries, wind1, \"max_active_power\")","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Verify this matches your expectation based on the input data.","category":"page"},{"location":"tutorials/working_with_time_series/#Add-and-Retrieve-a-Forecast","page":"Working with Time Series","title":"Add and Retrieve a Forecast","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Next, let's add the wind power forecasts. We will use a Deterministic format for the point forecasts.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Because we have forecasts with at different initial times, the input data must be a dictionary where the keys are the initial times and the values are vectors or TimeSeries.TimeArrays of the forecast data. Set up the example input data:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind_forecast_data = Dict(\n DateTime(\"2020-01-01T08:00:00\") => [5.0, 6, 7, 7, 7, 8, 9, 10, 10, 9, 7, 5],\n DateTime(\"2020-01-01T08:30:00\") => [9.0, 9, 9, 9, 8, 7, 6, 5, 4, 5, 4, 4],\n DateTime(\"2020-01-01T09:00:00\") => [6.0, 6, 5, 5, 4, 5, 6, 7, 7, 7, 6, 6],\n);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Define the Deterministic forecast and attach it to wind1:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"wind_forecast = Deterministic(\"max_active_power\", wind_forecast_data, resolution);\nadd_time_series!(system, wind1, wind_forecast);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's call show_time_series once again:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that we now have two types of time series listed – the single time series and the forecasts.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, let's retrieve the forecast data to double check it was added properly, specifying the initial time to get the 2nd forecast window starting at 8:30:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(\n Deterministic,\n wind1,\n \"max_active_power\";\n start_time = DateTime(\"2020-01-01T08:30:00\"),\n)","category":"page"},{"location":"tutorials/working_with_time_series/#Add-A-Time-Series-Using-Scaling-Factors","page":"Working with Time Series","title":"Add A Time Series Using Scaling Factors","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's add the load time series. Recall that this data is normalized to the peak system power, so we'll use it to scale both of our loads. We call normalized time series data scaling factors.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"First, let's create our input data TimeSeries.TimeArray with the example data and the same time stamps we used in the wind time series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"load_values = [0.3, 0.3, 0.3, 0.3, 0.4, 0.4, 0.4, 0.4, 0.5, 0.5, 0.6, 0.6,\n 0.7, 0.8, 0.8, 0.8, 0.8, 0.8, 0.9, 0.8, 0.8, 0.8, 0.8, 0.8];\nload_timearray = TimeArray(timestamps, load_values);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Again, define a SingleTimeSeries, but this time use the scaling_factor_multiplierparameter to scale this time series from normalized values to power values:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"load_time_series = SingleTimeSeries(;\n name = \"max_active_power\",\n data = load_timearray,\n scaling_factor_multiplier = get_max_active_power,\n);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that we assigned the get_max_active_power function to scale the time series, rather than a value, making the time series reusable for multiple components or multiple fields in a component.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now, add the scaling factor time series to both loads to save memory and avoid data duplication:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"add_time_series!(system, [load1, load2], load_time_series);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's take a look at load1, including printing its parameters...","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"load1","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"...as well as its time series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(load1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"tip: Important\nNotice that each load now has two references to max_active_power. This is intentional. There is the parameter, max_active_power, which is the maximum demand of each load at any time (10 MW). There is also max_active_power the time series, which is the time varying demand over the 2-hour window, calculated using the scaling factors and the max_active_power parameter.This means that if we change the max_active_power parameter, the time series will also change when we retrieve it! This is also true when we apply the same scaling factors to multiple components or parameters.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's check the impact that these two max_active_power data sources have on the times series data when we retrieve it. Get the max_active_power time series for load1:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(SingleTimeSeries, load1, \"max_active_power\") # in MW","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See that the normalized values have been scaled up by 10 MW.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now let's at load2. First check its max_active_power parameter:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_max_active_power(load2)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"This has a higher peak maximum demand of 30 MW.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Next, retrieve it's max_active_power time series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(SingleTimeSeries, load2, \"max_active_power\") # in MW","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Observe the difference compared to load1's time series.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, retrieve the underlying time series data with no scaling factor multiplier applied:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(SingleTimeSeries,\n load2,\n \"max_active_power\";\n ignore_scaling_factors = true,\n)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that this is the normalized input data, which is still being stored underneath. Each load is using a reference to that data when we call get_time_series_array to avoid unnecessary data duplication.","category":"page"},{"location":"tutorials/working_with_time_series/#Transform-a-SingleTimeSeries-into-a-Forecast","page":"Working with Time Series","title":"Transform a SingleTimeSeries into a Forecast","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, let's use a workaround to handle the missing load forecast data. We will assume a perfect forecast where the forecast is based on the SingleTimeSeries we just added.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Rather than unnecessarily duplicating and reformatting data, use PowerSystems.jl's dedicated transform_single_time_series! function to generate a DeterministicSingleTimeSeries, which saves memory while behaving just like a Deterministic forecast:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"transform_single_time_series!(\n system,\n Dates.Hour(1), # horizon\n Dates.Minute(30), # interval\n);","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's see the results for load1's time series summary:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(load1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice we now have a load forecast data set with the resolution, horizon, and, interval matching our wind forecasts.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Retrieve the first forecast window:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_time_series_array(\n DeterministicSingleTimeSeries,\n load1,\n \"max_active_power\";\n start_time = DateTime(\"2020-01-01T08:00:00\"),\n)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See that load1's scaling factor multiplier is still being applied as expected.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Continue to the next section to address one more impact of calling transform_single_time_series! on the entire System.","category":"page"},{"location":"tutorials/working_with_time_series/#Finding,-Retrieving,-and-Inspecting-Time-Series","page":"Working with Time Series","title":"Finding, Retrieving, and Inspecting Time Series","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Now, let's complete this tutorial by doing a few sanity checks on the data that we've added, where are we will also examine components with time series and retrieve the time series data in a few more ways.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"First, recall that we can print a component to check its has_time_series field:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"load1","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Also, recall we can print the System to summarize the data in our system:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"system","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that a new table has been added – the Time Series Summary, showing the count of each Type of component that has a given time series type.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Additionally, see that there are both Deterministic and DeterministicSingleTimeSeries forecasts for our RenewableDispatch generator (wind1). This was a side effect of transform_single_time_series! which added DeterministicSingleTimeSeries for all StaticTimeSeries in the system, even though we don't need one for wind.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's remove it with remove_time_series!. Since we have one wind generator, we could easily do it for that component, but let's do programmatically instead by its Type:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"for g in get_components(x -> has_time_series(x), RenewableDispatch, system)\n remove_time_series!(system, DeterministicSingleTimeSeries, g, \"max_active_power\")\nend","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Notice that we also filtered for components where has_time_series is true, which is a simple way to find and manipulate components with time series.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Let's double check wind1 now:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"show_time_series(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See the unnecessary data is gone.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, let's do a last data sanity check on the forecasts. Since we defined the wind time series in MW instead of scaling factors, let's make sure none of our forecasts exceeds the max_active_power parameter.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Instead of using get_time_series_array where we need to remember some details of the time series we're looking up, let's use get_time_series_keys to refresh our memories:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"keys = get_time_series_keys(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See the forecast key is first, so let's retrieve it using get_time_series:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"forecast = get_time_series(wind1, keys[1])","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See that unlike when we used get_time_series_array, this returns an object we can manipulate.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Use iterate_windows to cycle through the 3 forecast windows and inspect the peak value:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"for window in iterate_windows(forecast)\n @show values(maximum(window))\nend","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Finally, use get_max_active_power to check the expected maximum:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"get_max_active_power(wind1)","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"See that the forecasts are not exceeding this maximum – sanity check complete.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"tip: Tip\nUnlike PowerLoad components, RenewableDispatch components do not have a max_active_power field, so check get_max_active_power to see how its calculated.","category":"page"},{"location":"tutorials/working_with_time_series/#Next-Steps","page":"Working with Time Series","title":"Next Steps","text":"","category":"section"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"In this tutorial, you defined, added, and retrieved four time series data sets, including static time series and deterministic forecasts. Along the way, we reduced data duplication using normalized scaling factors for reuse by multiple components or component fields, as well as by referencing a StaticTimeSeries to address missing forecast data.","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Next you might like to:","category":"page"},{"location":"tutorials/working_with_time_series/","page":"Working with Time Series","title":"Working with Time Series","text":"Parse many timeseries data sets from CSV's\nSee how to improve performance efficiency with your own time series data\nReview the available time series data formats\nLearn more about how times series data is stored","category":"page"},{"location":"#Welcome-to-PowerSystems.jl","page":"Welcome Page","title":"Welcome to PowerSystems.jl","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"CurrentModule = PowerSystems","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"tip: Announcement\nPowerSystems.jl upgraded to version 4.0 in June 2024, which included breaking changes. Visit the v4.0 migration guide for information on how to update your existing code.We also have re-organized and updated this documentation, including new tutorials! Check out How To Use This Documentation below to orient yourself.","category":"page"},{"location":"#About","page":"Welcome Page","title":"About","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerSystems.jl is part of the National Renewable Energy Laboratory's Sienna ecosystem, an open source framework for scheduling problems and dynamic simulations for power systems. The Sienna ecosystem can be found on github. It contains three applications:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Sienna\\Data enables efficient data input, analysis, and transformation\nSienna\\Ops enables enables system scheduling simulations by formulating and solving optimization problems\nSienna\\Dyn enables system transient analysis including small signal stability and full system dynamic simulations","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Each application uses multiple packages in the Julia programming language.","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerSystems.jl is the foundation of Sienna\\Data, and it is used with all three applications. It provides a rigorous data model using Julia structures to enable power systems modeling. PowerSystems.jl is agnostic to a specific mathematical model and can be used for many model categories.","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerSystems.jl provides tools to prepare and process data useful for electric energy systems modeling. This package serves two purposes:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"It facilitates the development and open sharing of large data sets for Power Systems modeling\nIt provides a data model that imposes discipline on model specification, addressing the challenge of design and terminology choices when sharing code and data.","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"The main features include:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Comprehensive and extensible library of data structures for electric systems modeling.\nLarge scale data set development tools based on common text based data formats (PSS/e .raw and .dyr, and MATPOWER) and configurable tabular data (e.g. CSV) parsing capabilities.\nOptimized container for component data and time series supporting serialization to portable file formats and configurable validation routines.","category":"page"},{"location":"#How-To-Use-This-Documentation","page":"Welcome Page","title":"How To Use This Documentation","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"There are five main sections containing different information:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Tutorials - Detailed walk-throughs to help you learn how to use PowerSystems.jl\nHow to... - Directions to help guide your work for a particular task\nExplanation - Additional details and background information to help you understand PowerSystems.jl, its structure, and how it works behind the scenes\nReference - Technical references and API for a quick look-up during your work\nModel Library - Technical references of the data types and their functions that PowerSystems.jl uses to model power system components","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerSystems.jl strives to follow the Diataxis documentation framework.","category":"page"},{"location":"#Getting-Started","page":"Welcome Page","title":"Getting Started","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"If you are new to PowerSystems.jl, here's how we suggest getting started:","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"Install\nWork through the introductory tutorial: Create and Explore a Power System to familiarize yourself with how PowerSystems.jl works\nWork through the other basic tutorials based on your interests\nSee Working with Time Series Data if you will be doing production cost modeling or working with time series\nSee Adding Data for Dynamic Simulations if you are interested in dynamic simulations\nThen, see the how-to's on parsing Matpower or PSS/e files or CSV files to begin loading your own data into PowerSystems.jl","category":"page"},{"location":"how_to/add_component_natural_units/#Add-a-Component-in-Natural-Units","page":"...add a component using natural units (MW)","title":"Add a Component in Natural Units","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"using PowerSystems; #hide\nusing PowerSystemCaseBuilder #hide\nsystem = build_system(PSISystems, \"modified_RTS_GMLC_DA_sys\"); #hide","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"PowerSystems.jl has three per-unitization options for getting, setting and displaying data.","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Currently, only one of these options – \"DEVICE_BASE\" – is supported when using a constructor function define a component. You can see an example of the default capabilities using \"DEVICE_BASE\" here.","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"We hope to add capability to define components in \"NATURAL_UNITS\" with constructors in the future, but for now, below is a workaround for users who prefer to define data using \"NATURAL_UNITS\" (e.g., MW, MVA, MVAR, or MW/min):","category":"page"},{"location":"how_to/add_component_natural_units/#Step-1:-Set-Units-Base","page":"...add a component using natural units (MW)","title":"Step 1: Set Units Base","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Set your (previously-defined) System's units base to \"NATURAL_UNITS\":","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"set_units_base_system!(system, \"NATURAL_UNITS\")","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Now, the \"setter\" functions have been switched to define data using natural units (MW, MVA, etc.), taking care of the necessary data conversions behind the scenes.","category":"page"},{"location":"how_to/add_component_natural_units/#Step-2:-Define-Empty-Component","page":"...add a component using natural units (MW)","title":"Step 2: Define Empty Component","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Define an empty component with 0.0 or nothing for all the power-related fields except base_power, which is always in MVA.","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"For example:","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"gas1 = ThermalStandard(;\n name = \"gas1\",\n available = true,\n status = true,\n bus = get_component(ACBus, system, \"Cobb\"), # Attach to a previously-defined bus named Cobb\n active_power = 0.0,\n reactive_power = 0.0,\n rating = 0.0,\n active_power_limits = (min = 0.0, max = 0.0),\n reactive_power_limits = nothing,\n ramp_limits = nothing,\n operation_cost = ThermalGenerationCost(nothing),\n base_power = 30.0, # MVA\n time_limits = (up = 8.0, down = 8.0), # Hours, unaffected by per-unitization\n must_run = false,\n prime_mover_type = PrimeMovers.CC,\n fuel = ThermalFuels.NATURAL_GAS,\n);","category":"page"},{"location":"how_to/add_component_natural_units/#Step-3:-Attach-the-Component","page":"...add a component using natural units (MW)","title":"Step 3: Attach the Component","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Attach the component to your System:","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"add_component!(system, gas1)","category":"page"},{"location":"how_to/add_component_natural_units/#Step-4:-Add-Data-with-\"setter\"-Functions","page":"...add a component using natural units (MW)","title":"Step 4: Add Data with \"setter\" Functions","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Use individual \"setter\" functions to set each the value of each numeric field in natural units:","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"set_rating!(gas1, 30.0) #MVA\nset_active_power_limits!(gas1, (min = 6.0, max = 30.0)) # MW\nset_reactive_power_limits!(gas1, (min = 6.0, max = 30.0)) # MVAR\nset_ramp_limits!(gas1, (up = 6.0, down = 6.0)) #MW/min","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Notice the return values are divided by the base_power of 30 MW, showing the setters have done the per-unit conversion into \"DEVICE_BASE\" behind the scenes.","category":"page"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"tip: Tip\nSteps 2-4 can be called within a for loop to define many components at once (or step 3 can be replaced with add_components! to add all components at once).","category":"page"},{"location":"how_to/add_component_natural_units/#See-Also","page":"...add a component using natural units (MW)","title":"See Also","text":"","category":"section"},{"location":"how_to/add_component_natural_units/","page":"...add a component using natural units (MW)","title":"...add a component using natural units (MW)","text":"Read more to understand per-unitization in PowerSystems.jl\nLearn how to use the default constructors and explore the per-unitization settings in Create and Explore a Power System","category":"page"},{"location":"how_to/get_buses/#Get-the-buses-in-a-System","page":"...get all the buses in a system","title":"Get the buses in a System","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"using PowerSystems; #hide\nusing PowerSystemCaseBuilder #hide\nsystem = build_system(PSISystems, \"modified_RTS_GMLC_DA_sys\"); #hide","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"You can access all the buses in a System to view or manipulate their data using two key functions: get_components or get_buses.","category":"page"},{"location":"how_to/get_buses/#Option-1a:-Get-an-iterator-for-all-the-buses","page":"...get all the buses in a system","title":"Option 1a: Get an iterator for all the buses","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Use get_components to get an iterator of all the AC buses in an existing system:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"bus_iter = get_components(ACBus, system)","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"The iterator avoids unnecessary memory allocations if there are many buses, and it can be used to view or update the bus data. For example, we can set the base voltage of all buses to 330 kV:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"for b in bus_iter\n set_base_voltage!(b, 330.0)\nend","category":"page"},{"location":"how_to/get_buses/#Option-1b:-Get-a-vector-of-all-the-buses","page":"...get all the buses in a system","title":"Option 1b: Get a vector of all the buses","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Use collect to get a vector of the buses instead of an iterator, which could require a lot of memory:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"buses = collect(get_components(ACBus, system))","category":"page"},{"location":"how_to/get_buses/#Option-2a:-Get-the-buses-in-an-Area-or-LoadZone","page":"...get all the buses in a system","title":"Option 2a: Get the buses in an Area or LoadZone","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Use get_buses to get a vector of buses when you know which Area or LoadZone you are interested in.","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"First, we select an Area:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"show_components(Area, system) # See available Areas\narea2 = get_component(Area, system, \"2\"); # Get Area named 2","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Then call get_buses for that Area:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"area_buses = get_buses(system, area2)","category":"page"},{"location":"how_to/get_buses/#Option-2b:-Get-buses-by-ID-number","page":"...get all the buses in a system","title":"Option 2b: Get buses by ID number","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Finally, use get_buses to get a vector of buses by their ID numbers.","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"Example getting buses with ID numbers from 101 to 110:","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"buses_by_ID = get_buses(system, Set(101:110))","category":"page"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"note: Note\nYou can combine this with Option 1 to first view all the bus numbers if needed:get_number.(get_components(ACBus, system))","category":"page"},{"location":"how_to/get_buses/#See-Also","page":"...get all the buses in a system","title":"See Also","text":"","category":"section"},{"location":"how_to/get_buses/","page":"...get all the buses in a system","title":"...get all the buses in a system","text":"How to: Get the available generators in a System","category":"page"},{"location":"model_library/hybrid_system/#Hybrid-System","page":"HybridSystem","title":"Hybrid System","text":"","category":"section"},{"location":"model_library/hybrid_system/","page":"HybridSystem","title":"HybridSystem","text":"Modules = [PowerSystems]\nPages = [\"HybridSystem.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/hybrid_system/#PowerSystems.HybridSystem","page":"HybridSystem","title":"PowerSystems.HybridSystem","text":"mutable struct HybridSystem <: StaticInjectionSubsystem\n name::String\n available::Bool\n status::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n base_power::Float64\n operation_cost::MarketBidCost\n thermal_unit::Union{Nothing, ThermalGen}\n electric_load::Union{Nothing, ElectricLoad}\n storage::Union{Nothing, Storage}\n renewable_unit::Union{Nothing, RenewableGen}\n interconnection_impedance::ComplexF64\n interconnection_rating::Union{Nothing, Float64}\n input_active_power_limits::Union{Nothing, MinMax}\n output_active_power_limits::Union{Nothing, MinMax}\n reactive_power_limits::Union{Nothing, MinMax}\n interconnection_efficiency::Union{\n Nothing,\n NamedTuple{(:in, :out), Tuple{Float64, Float64}},\n }\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA Hybrid System that includes a combination of renewable generation, load, thermal generation and/or energy storage.\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nstatus::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, which is commonly the same as rating\noperation_cost::MarketBidCost: Market bid cost to operate, MarketBidCost\nthermal_unit::Union{Nothing, ThermalGen}: A thermal generator with supertype ThermalGen\nelectric_load::Union{Nothing, ElectricLoad}: A load with supertype ElectricLoad\nstorage::Union{Nothing, Storage}: An energy storage system with supertype Storage\nrenewable_unit::Union{Nothing, RenewableGen}: A renewable generator with supertype RenewableGen\ninterconnection_impedance::ComplexF64: Impedance (typically in p.u.) between the hybrid system and the grid interconnection\ninterconnection_rating::Union{Nothing, Float64}: Maximum rating of the hybrid system's interconnection with the transmission network (MVA)\ninput_active_power_limits::MinMax: Minimum and maximum stable input active power levels (MW)\noutput_active_power_limits::MinMax: Minimum and maximum stable output active power levels (MW)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits (MVAR). Set to Nothing if not applicable.\ninterconnection_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\nservices::Vector{Service}: (optional) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (optional) corresponding dynamic injection device\next::Dict{String, Any}: (optional) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference.\n\n\n\n\n\n","category":"type"},{"location":"model_library/hybrid_system/#PowerSystems.get_active_power-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_active_power","text":"get_active_power(value::HybridSystem) -> Any\n\n\nGet HybridSystem active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_available-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_available","text":"get_available(value::HybridSystem) -> Bool\n\n\nGet HybridSystem available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_base_power-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_base_power","text":"get_base_power(value::HybridSystem) -> Float64\n\n\nGet HybridSystem base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_bus-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_bus","text":"get_bus(value::HybridSystem) -> ACBus\n\n\nGet HybridSystem bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_dynamic_injector-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::HybridSystem\n) -> Union{Nothing, DynamicInjection}\n\n\nGet HybridSystem dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_electric_load-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_electric_load","text":"get_electric_load(\n value::HybridSystem\n) -> Union{Nothing, ElectricLoad}\n\n\nGet HybridSystem load\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_ext-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_ext","text":"get_ext(value::HybridSystem) -> Dict{String, Any}\n\n\nGet HybridSystem ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_input_active_power_limits-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_input_active_power_limits","text":"get_input_active_power_limits(\n value::HybridSystem\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HybridSystem input_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_interconnection_impedance-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_interconnection_impedance","text":"get_interconnection_impedance(\n value::HybridSystem\n) -> ComplexF64\n\n\nget HybridSystem interconnection impedance\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_interconnection_rating-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_interconnection_rating","text":"get_interconnection_rating(value::HybridSystem) -> Any\n\n\nGet HybridSystem interconnection_rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_operation_cost-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(value::HybridSystem) -> MarketBidCost\n\n\nGet HybridSystem operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_output_active_power_limits-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_output_active_power_limits","text":"get_output_active_power_limits(\n value::HybridSystem\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HybridSystem output_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_reactive_power-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::HybridSystem) -> Any\n\n\nGet HybridSystem reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_reactive_power_limits-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::HybridSystem\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HybridSystem reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_renewable_unit-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_renewable_unit","text":"get_renewable_unit(\n value::HybridSystem\n) -> Union{Nothing, RenewableGen}\n\n\nGet HybridSystem renewable unit\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_services-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_services","text":"get_services(value::HybridSystem) -> Vector{Service}\n\n\nGet HybridSystem services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_status-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_status","text":"get_status(value::HybridSystem) -> Bool\n\n\nGet HybridSystem status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_storage-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_storage","text":"get_storage(value::HybridSystem) -> Union{Nothing, Storage}\n\n\nGet HybridSystem storage unit\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_subcomponents-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_subcomponents","text":"get_subcomponents(hybrid::HybridSystem) -> Channel{Any}\n\n\nReturn an iterator over the subcomponents in the HybridSystem.\n\nExamples\n\nfor subcomponent in get_subcomponents(hybrid_sys)\n @show subcomponent\nend\nsubcomponents = collect(get_subcomponents(hybrid_sys))\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.get_thermal_unit-Tuple{HybridSystem}","page":"HybridSystem","title":"PowerSystems.get_thermal_unit","text":"get_thermal_unit(\n value::HybridSystem\n) -> Union{Nothing, ThermalGen}\n\n\nGet HybridSystem thermal unit\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_active_power!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_available!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_available!","text":"set_available!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_base_power!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_bus!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_bus!","text":"set_bus!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_ext!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_ext!","text":"set_ext!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_input_active_power_limits!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_input_active_power_limits!","text":"set_input_active_power_limits!(\n value::HybridSystem,\n val\n) -> Any\n\n\nSet HybridSystem input_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_operation_cost!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_output_active_power_limits!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_output_active_power_limits!","text":"set_output_active_power_limits!(\n value::HybridSystem,\n val\n) -> Any\n\n\nSet HybridSystem output_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_reactive_power!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_reactive_power_limits!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_services!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_services!","text":"set_services!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/hybrid_system/#PowerSystems.set_status!-Tuple{HybridSystem, Any}","page":"HybridSystem","title":"PowerSystems.set_status!","text":"set_status!(value::HybridSystem, val) -> Any\n\n\nGet HybridSystem status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#RenewableNonDispatch","page":"RenewableNonDispatch","title":"RenewableNonDispatch","text":"","category":"section"},{"location":"model_library/generated_RenewableNonDispatch/","page":"RenewableNonDispatch","title":"RenewableNonDispatch","text":"Modules = [PowerSystems]\nPages = [\"generated/RenewableNonDispatch.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.RenewableNonDispatch","page":"RenewableNonDispatch","title":"PowerSystems.RenewableNonDispatch","text":"mutable struct RenewableNonDispatch <: RenewableGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n power_factor::Float64\n base_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA non-dispatchable (i.e., non-curtailable or must-take) renewable generator.\n\nIts 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.\n\nRenewable generators do not have a max_active_power parameter, which is instead calculated when calling get_max_active_power()\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), used in some production cost modeling simulations. To set the reactive power in a load flow, use power_factor\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\npower_factor::Float64: Power factor [0, 1] set-point, used in some production cost modeling and in load flow if the unit is connected to a PQ bus, validation range: (0, 1)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_RenewableNonDispatch/#InfrastructureSystems.get_name-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"InfrastructureSystems.get_name","text":"get_name(value::RenewableNonDispatch) -> String\n\n\nGet RenewableNonDispatch name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_active_power-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_active_power","text":"get_active_power(value::RenewableNonDispatch) -> Any\n\n\nGet RenewableNonDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_available-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_available","text":"get_available(value::RenewableNonDispatch) -> Bool\n\n\nGet RenewableNonDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_base_power-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_base_power","text":"get_base_power(value::RenewableNonDispatch) -> Float64\n\n\nGet RenewableNonDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_bus-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_bus","text":"get_bus(value::RenewableNonDispatch) -> ACBus\n\n\nGet RenewableNonDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_dynamic_injector-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::RenewableNonDispatch\n) -> Union{Nothing, DynamicInjection}\n\n\nGet RenewableNonDispatch dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_ext-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_ext","text":"get_ext(value::RenewableNonDispatch) -> Dict{String, Any}\n\n\nGet RenewableNonDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_power_factor-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_power_factor","text":"get_power_factor(value::RenewableNonDispatch) -> Float64\n\n\nGet RenewableNonDispatch power_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_prime_mover_type-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::RenewableNonDispatch\n) -> PrimeMovers\n\n\nGet RenewableNonDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_rating-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_rating","text":"get_rating(value::RenewableNonDispatch) -> Any\n\n\nGet RenewableNonDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_reactive_power-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::RenewableNonDispatch) -> Any\n\n\nGet RenewableNonDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.get_services-Tuple{RenewableNonDispatch}","page":"RenewableNonDispatch","title":"PowerSystems.get_services","text":"get_services(value::RenewableNonDispatch) -> Vector{Service}\n\n\nGet RenewableNonDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_active_power!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_available!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_available!","text":"set_available!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_base_power!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_bus!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_bus!","text":"set_bus!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_ext!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_ext!","text":"set_ext!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_power_factor!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_power_factor!","text":"set_power_factor!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch power_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_prime_mover_type!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(\n value::RenewableNonDispatch,\n val\n) -> Any\n\n\nSet RenewableNonDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_rating!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_rating!","text":"set_rating!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_reactive_power!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableNonDispatch/#PowerSystems.set_services!-Tuple{RenewableNonDispatch, Any}","page":"RenewableNonDispatch","title":"PowerSystems.set_services!","text":"set_services!(value::RenewableNonDispatch, val) -> Any\n\n\nSet RenewableNonDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#OutputCurrentLimiter","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/#HybridOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"HybridOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/HybridOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.HybridOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.HybridOutputCurrentLimiter","text":"mutable struct HybridOutputCurrentLimiter <: OutputCurrentLimiter\n I_max::Float64\n rv::Float64\n lv::Float64\n ext::Dict{String, Any}\nend\n\nParameters 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 \n\nArguments\n\nI_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)\nrv::Float64: Real part of the virtual impedance, validation range: (0, nothing)\nlv::Float64: Imaginary part of the virtual impedance, validation range: (0, nothing)\next::Dict{String, Any}: (default: Dict{String, Any}())\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_I_max-Tuple{HybridOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_I_max","text":"get_I_max(value::HybridOutputCurrentLimiter) -> Float64\n\n\nGet HybridOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{HybridOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::HybridOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet HybridOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_lv-Tuple{HybridOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_lv","text":"get_lv(value::HybridOutputCurrentLimiter) -> Float64\n\n\nGet HybridOutputCurrentLimiter lv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_rv-Tuple{HybridOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_rv","text":"get_rv(value::HybridOutputCurrentLimiter) -> Float64\n\n\nGet HybridOutputCurrentLimiter rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_I_max!-Tuple{HybridOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::HybridOutputCurrentLimiter, val) -> Any\n\n\nSet HybridOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{HybridOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(value::HybridOutputCurrentLimiter, val) -> Any\n\n\nSet HybridOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_lv!-Tuple{HybridOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_lv!","text":"set_lv!(value::HybridOutputCurrentLimiter, val) -> Any\n\n\nSet HybridOutputCurrentLimiter lv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_rv!-Tuple{HybridOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_rv!","text":"set_rv!(value::HybridOutputCurrentLimiter, val) -> Any\n\n\nSet HybridOutputCurrentLimiter rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#InstantaneousOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"InstantaneousOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/InstantaneousOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.InstantaneousOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.InstantaneousOutputCurrentLimiter","text":"mutable struct InstantaneousOutputCurrentLimiter <: OutputCurrentLimiter\n Id_max::Float64\n Iq_max::Float64\n ext::Dict{String, Any}\nend\n\nParameters of Instantaneous (Square) Current Controller Limiter. Regulates inverter output current on the d and q axis separately\n\nArguments\n\nId_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)\nIq_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)\next::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.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_Id_max-Tuple{InstantaneousOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_Id_max","text":"get_Id_max(\n value::InstantaneousOutputCurrentLimiter\n) -> Float64\n\n\nGet InstantaneousOutputCurrentLimiter Id_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_Iq_max-Tuple{InstantaneousOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_Iq_max","text":"get_Iq_max(\n value::InstantaneousOutputCurrentLimiter\n) -> Float64\n\n\nGet InstantaneousOutputCurrentLimiter Iq_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{InstantaneousOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::InstantaneousOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet InstantaneousOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_Id_max!-Tuple{InstantaneousOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_Id_max!","text":"set_Id_max!(\n value::InstantaneousOutputCurrentLimiter,\n val\n) -> Any\n\n\nSet InstantaneousOutputCurrentLimiter Id_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_Iq_max!-Tuple{InstantaneousOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_Iq_max!","text":"set_Iq_max!(\n value::InstantaneousOutputCurrentLimiter,\n val\n) -> Any\n\n\nSet InstantaneousOutputCurrentLimiter Iq_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{InstantaneousOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(\n value::InstantaneousOutputCurrentLimiter,\n val\n) -> Any\n\n\nSet InstantaneousOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#MagnitudeOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"MagnitudeOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/MagnitudeOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.MagnitudeOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.MagnitudeOutputCurrentLimiter","text":"mutable struct MagnitudeOutputCurrentLimiter <: OutputCurrentLimiter\n I_max::Float64\n ext::Dict{String, Any}\nend\n\nParameters of Magnitude (Circular) Current Controller Limiter. Regulates only the magnitude of the inverter output current\n\nArguments\n\nI_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)\next::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.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_I_max-Tuple{MagnitudeOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_I_max","text":"get_I_max(value::MagnitudeOutputCurrentLimiter) -> Float64\n\n\nGet MagnitudeOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{MagnitudeOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::MagnitudeOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet MagnitudeOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_I_max!-Tuple{MagnitudeOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::MagnitudeOutputCurrentLimiter, val) -> Any\n\n\nSet MagnitudeOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{MagnitudeOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(value::MagnitudeOutputCurrentLimiter, val) -> Any\n\n\nSet MagnitudeOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PriorityOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PriorityOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/PriorityOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.PriorityOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.PriorityOutputCurrentLimiter","text":"mutable struct PriorityOutputCurrentLimiter <: OutputCurrentLimiter\n I_max::Float64\n ϕ_I::Float64\n ext::Dict{String, Any}\nend\n\nParameters of Priority-Based Current Controller Limiter. Regulates the magnitude of the inverter output current and prioritizes a specific angle for the resultant current signal\n\nArguments\n\nI_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)\nϕ_I::Float64: Pre-defined angle (measured against the d-axis) for Iref once limit Imax is hit, validation range: (-1.571, 1.571)\next::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.\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_I_max-Tuple{PriorityOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_I_max","text":"get_I_max(value::PriorityOutputCurrentLimiter) -> Float64\n\n\nGet PriorityOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{PriorityOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::PriorityOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet PriorityOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ϕ_I-Tuple{PriorityOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ϕ_I","text":"get_ϕ_I(value::PriorityOutputCurrentLimiter) -> Float64\n\n\nGet PriorityOutputCurrentLimiter ϕ_I.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_I_max!-Tuple{PriorityOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::PriorityOutputCurrentLimiter, val) -> Any\n\n\nSet PriorityOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{PriorityOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(value::PriorityOutputCurrentLimiter, val) -> Any\n\n\nSet PriorityOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ϕ_I!-Tuple{PriorityOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ϕ_I!","text":"set_ϕ_I!(value::PriorityOutputCurrentLimiter, val) -> Any\n\n\nSet PriorityOutputCurrentLimiter ϕ_I.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#SaturationOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"SaturationOutputCurrentLimiter","text":"","category":"section"},{"location":"model_library/generated_OutputCurrentLimiter/","page":"OutputCurrentLimiter","title":"OutputCurrentLimiter","text":"Modules = [PowerSystems]\nPages = [\"/SaturationOutputCurrentLimiter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.SaturationOutputCurrentLimiter","page":"OutputCurrentLimiter","title":"PowerSystems.SaturationOutputCurrentLimiter","text":"mutable struct SaturationOutputCurrentLimiter <: OutputCurrentLimiter\n I_max::Float64\n kw::Float64\n ext::Dict{String, Any}\nend\n\nParameters 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\n\nArguments\n\nI_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)\nkw::Float64: Defined feedback gain, validation range: (0, nothing)\next::Dict{String, Any}: (default: Dict{String, Any}())\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_I_max-Tuple{SaturationOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_I_max","text":"get_I_max(value::SaturationOutputCurrentLimiter) -> Float64\n\n\nGet SaturationOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_ext-Tuple{SaturationOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_ext","text":"get_ext(\n value::SaturationOutputCurrentLimiter\n) -> Dict{String, Any}\n\n\nGet SaturationOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.get_kw-Tuple{SaturationOutputCurrentLimiter}","page":"OutputCurrentLimiter","title":"PowerSystems.get_kw","text":"get_kw(value::SaturationOutputCurrentLimiter) -> Float64\n\n\nGet SaturationOutputCurrentLimiter kw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_I_max!-Tuple{SaturationOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_I_max!","text":"set_I_max!(\n value::SaturationOutputCurrentLimiter,\n val\n) -> Any\n\n\nSet SaturationOutputCurrentLimiter I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_ext!-Tuple{SaturationOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_ext!","text":"set_ext!(value::SaturationOutputCurrentLimiter, val) -> Any\n\n\nSet SaturationOutputCurrentLimiter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_OutputCurrentLimiter/#PowerSystems.set_kw!-Tuple{SaturationOutputCurrentLimiter, Any}","page":"OutputCurrentLimiter","title":"PowerSystems.set_kw!","text":"set_kw!(value::SaturationOutputCurrentLimiter, val) -> Any\n\n\nSet SaturationOutputCurrentLimiter kw.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#TapTransformer","page":"TapTransformer","title":"TapTransformer","text":"","category":"section"},{"location":"model_library/generated_TapTransformer/","page":"TapTransformer","title":"TapTransformer","text":"Modules = [PowerSystems]\nPages = [\"generated/TapTransformer.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TapTransformer/#PowerSystems.TapTransformer","page":"TapTransformer","title":"PowerSystems.TapTransformer","text":"mutable struct TapTransformer <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n primary_shunt::Float64\n tap::Float64\n rating::Union{Nothing, Float64}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA 2-winding transformer, with a tap changer for variable turns ratio.\n\nThe 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow through the transformer (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow through the transformer (MVAR)\narc::Arc: An Arc defining this transformer from a bus to another bus\nr::Float64: Resistance in p.u. (SYSTEM_BASE), validation range: (-2, 2)\nx::Float64: Reactance in p.u. (SYSTEM_BASE), validation range: (-2, 4)\nprimary_shunt::Float64: Shunt reactance in p.u. (SYSTEM_BASE), validation range: (0, 2)\ntap::Float64: Normalized tap changer position for voltage control, varying between 0 and 2, with 1 centered at the nominal voltage, validation range: (0, 2)\nrating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating. When defining a transformer before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TapTransformer/#InfrastructureSystems.get_name-Tuple{TapTransformer}","page":"TapTransformer","title":"InfrastructureSystems.get_name","text":"get_name(value::TapTransformer) -> String\n\n\nGet TapTransformer name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_active_power_flow-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::TapTransformer) -> Any\n\n\nGet TapTransformer active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_arc-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_arc","text":"get_arc(value::TapTransformer) -> Arc\n\n\nGet TapTransformer arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_available-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_available","text":"get_available(value::TapTransformer) -> Bool\n\n\nGet TapTransformer available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_ext-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_ext","text":"get_ext(value::TapTransformer) -> Dict{String, Any}\n\n\nGet TapTransformer ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_primary_shunt-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_primary_shunt","text":"get_primary_shunt(value::TapTransformer) -> Float64\n\n\nGet TapTransformer primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_r-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_r","text":"get_r(value::TapTransformer) -> Float64\n\n\nGet TapTransformer r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_rating-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_rating","text":"get_rating(value::TapTransformer) -> Any\n\n\nGet TapTransformer rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_reactive_power_flow-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::TapTransformer) -> Any\n\n\nGet TapTransformer reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_services-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_services","text":"get_services(value::TapTransformer) -> Vector{Service}\n\n\nGet TapTransformer services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_tap-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_tap","text":"get_tap(value::TapTransformer) -> Float64\n\n\nGet TapTransformer tap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.get_x-Tuple{TapTransformer}","page":"TapTransformer","title":"PowerSystems.get_x","text":"get_x(value::TapTransformer) -> Float64\n\n\nGet TapTransformer x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_active_power_flow!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_arc!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_arc!","text":"set_arc!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_available!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_available!","text":"set_available!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_ext!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_ext!","text":"set_ext!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_primary_shunt!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_primary_shunt!","text":"set_primary_shunt!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_r!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_r!","text":"set_r!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_rating!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_rating!","text":"set_rating!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_reactive_power_flow!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_services!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_services!","text":"set_services!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_tap!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_tap!","text":"set_tap!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer tap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TapTransformer/#PowerSystems.set_x!-Tuple{TapTransformer, Any}","page":"TapTransformer","title":"PowerSystems.set_x!","text":"set_x!(value::TapTransformer, val) -> Any\n\n\nSet TapTransformer x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#StorageCost","page":"StorageCost","title":"StorageCost","text":"","category":"section"},{"location":"model_library/storage_cost/","page":"StorageCost","title":"StorageCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/StorageCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/storage_cost/#PowerSystems.StorageCost","page":"StorageCost","title":"PowerSystems.StorageCost","text":"mutable struct StorageCost <: OperationalCost\n\ncharge_variable_cost::CostCurve: (default of 0) Variable cost of charging represented as a CostCurve\ndischarge_variable_cost::CostCurve: (default of 0) Variable cost of discharging represented as a CostCurve\nfixed::Float64: (default: 0) Fixed cost of operating the storage system\nstart_up::Union{Float64, @NamedTuple{charge::Float64, discharge::Float64}}: (default: 0) Start-up cost\nshut_down::Float64: (default: 0) Shut-down cost\nenergy_shortage_cost::Float64: (default: 0) Cost incurred by the model for being short of the energy target\nenergy_surplus_cost::Float64: (default: 0) Cost incurred by the model for surplus energy stored\n\nStorageCost(charge_variable_cost, discharge_variable_cost, fixed, start_up, shut_down, energy_shortage_cost, energy_surplus_cost)\nStorageCost(; charge_variable_cost, discharge_variable_cost, fixed, start_up, shut_down, energy_shortage_cost, energy_surplus_cost)\n\nAn operational cost for storage units including fixed costs and variable costs to charge or discharge.\n\nThis data structure is not intended to represent market storage systems market operations like the submission of buy/sell bids – see MarketBidCost instead.\n\n\n\n\n\n","category":"type"},{"location":"model_library/storage_cost/#PowerSystems.get_charge_variable_cost-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_charge_variable_cost","text":"get_charge_variable_cost(value::StorageCost) -> CostCurve\n\n\nGet StorageCost charge_variable_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_discharge_variable_cost-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_discharge_variable_cost","text":"get_discharge_variable_cost(value::StorageCost) -> CostCurve\n\n\nGet StorageCost discharge_variable_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_energy_shortage_cost-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_energy_shortage_cost","text":"get_energy_shortage_cost(value::StorageCost) -> Float64\n\n\nGet StorageCost energy_shortage_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_energy_surplus_cost-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_energy_surplus_cost","text":"get_energy_surplus_cost(value::StorageCost) -> Float64\n\n\nGet StorageCost energy_surplus_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_fixed-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_fixed","text":"get_fixed(value::StorageCost) -> Float64\n\n\nGet StorageCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_shut_down-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_shut_down","text":"get_shut_down(value::StorageCost) -> Float64\n\n\nGet StorageCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.get_start_up-Tuple{StorageCost}","page":"StorageCost","title":"PowerSystems.get_start_up","text":"get_start_up(\n value::StorageCost\n) -> Union{Float64, @NamedTuple{charge::Float64, discharge::Float64}}\n\n\nGet StorageCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_charge_variable_cost!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_charge_variable_cost!","text":"set_charge_variable_cost!(value::StorageCost, val) -> Any\n\n\nSet StorageCost charge_variable_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_discharge_variable_cost!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_discharge_variable_cost!","text":"set_discharge_variable_cost!(value::StorageCost, val) -> Any\n\n\nSet StorageCost discharge_variable_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_energy_shortage_cost!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_energy_shortage_cost!","text":"set_energy_shortage_cost!(value::StorageCost, val) -> Any\n\n\nSet StorageCost energy_shortage_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_energy_surplus_cost!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_energy_surplus_cost!","text":"set_energy_surplus_cost!(value::StorageCost, val) -> Any\n\n\nSet StorageCost energy_surplus_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_fixed!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_fixed!","text":"set_fixed!(value::StorageCost, val) -> Any\n\n\nSet StorageCost fixed.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_shut_down!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_shut_down!","text":"set_shut_down!(value::StorageCost, val) -> Any\n\n\nSet StorageCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/storage_cost/#PowerSystems.set_start_up!-Tuple{StorageCost, Any}","page":"StorageCost","title":"PowerSystems.set_start_up!","text":"set_start_up!(value::StorageCost, val) -> Any\n\n\nSet StorageCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"explanation/dynamic_data/#Dynamic-Devices","page":"Dynamic Devices","title":"Dynamic Devices","text":"","category":"section"},{"location":"explanation/dynamic_data/#Static-and-Dynamic-Data-Layers","page":"Dynamic Devices","title":"Static and Dynamic Data Layers","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"PowerSystems.jl uses two categories to define data for dynamic simulations:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Static components, which includes the data needed to run a power flow problem\nDynamic components are those that define differential equations to run a transient simulation. These dynamic data are attached to the static components.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Although PowerSystems.jl is not constrained to only PSS/e files, commonly the data for a dynamic simulation comes in a pair of files: One for the static data power flow case (e.g., .raw file) and a second one with the dynamic components information (e.g., .dyr file). However, PowerSystems.jl is able to take any power flow case and specify dynamic components to it. The two data layers in PowerSystems.jl are similar to the data division between those two files.","category":"page"},{"location":"explanation/dynamic_data/#Layer-1:-Static-Components","page":"Dynamic Devices","title":"Layer 1: Static Components","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"The first data layer contains all the information necessary to run a power flow problem:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Vector of Bus elements, that define all the buses in the network.\nVector of Branch elements, that define all the branches elements (that connect two buses) in the network.\nVector of StaticInjection elements, that define all the devices connected to buses that can inject (or withdraw) power. These static devices, typically generators, in PowerSimulationsDynamics are used to solve the Power Flow problem that determines the active and reactive power provided for each device.\nVector of PowerLoad elements, that define all the loads connected to buses that can withdraw current. These are also used to solve the Power Flow.\nVector of Source elements, that define source components behind a reactance that can inject or withdraw current.\nThe base of power used to define per unit values, in MVA as a Float64 value.\nThe base frequency used in the system, in Hz as a Float64 value.","category":"page"},{"location":"explanation/dynamic_data/#Layer-2:-Dynamic-Components","page":"Dynamic Devices","title":"Layer 2: Dynamic Components","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"The second data layer contains the additional information describing the dynamic response of certain components in the System. This data is all attached to components defined in the static data layer:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"(Optional) Selecting which of the Lines (of the Branch vector) elements must be modeled of DynamicLines elements, that can be used to model lines with differential equations.\nVector of DynamicInjection elements. These components must be attached to a StaticInjection that connects the power flow solution to the dynamic formulation of such device.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"DynamicInjection can be DynamicGenerator or DynamicInverter, and its specific formulation (i.e. differential equations) will depend on the specific components that define each device (see the sections below). As a result, it is possible to flexibly define dynamic data models and methods according to the analysis requirements. DynamicInjection components use 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.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"DynamicInjection components also implement some additional information useful for the modeling, like the usual states assumed by the model and the number of states. 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.","category":"page"},{"location":"explanation/dynamic_data/#Dynamic-Generator-Structure","page":"Dynamic Devices","title":"Dynamic Generator Structure","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Each generator is a data structure that is defined by the following components:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Machine: That defines the stator electro-magnetic dynamics.\nShaft: That describes the rotor electro-mechanical dynamics.\nAutomatic Voltage Regulator: Electromotive dynamics to model an AVR controller.\nPower System Stabilizer: Control dynamics to define an stabilization signal for the AVR.\nPrime Mover and Turbine Governor: Thermo-mechanical dynamics and associated controllers.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"","category":"page"},{"location":"explanation/dynamic_data/#Dynamic-Inverter-Structure","page":"Dynamic Devices","title":"Dynamic Inverter Structure","text":"","category":"section"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"Each inverter is a data structure that is defined by the following components:","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"DC Source: Defines the dynamics of the DC side of the converter.\nFrequency Estimator: That describes how the frequency of the grid can be estimated using the grid voltages. Typically a phase-locked loop (PLL).\nOuter Loop Control: That describes the active and reactive power control dynamics.\nInner Loop Control: That can describe virtual impedance, voltage control and current control dynamics.\nConverter: That describes the dynamics of the pulse width modulation (PWM) or space vector modulation (SVM).\nFilter: Used to connect the converter output to the grid.","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"","category":"page"},{"location":"explanation/dynamic_data/","page":"Dynamic Devices","title":"Dynamic Devices","text":"⠀ ```","category":"page"},{"location":"model_library/generated_HydroPumpedStorage/#HydroPumpedStorage","page":"HydroPumpedStorage","title":"HydroPumpedStorage","text":"","category":"section"},{"location":"model_library/generated_HydroPumpedStorage/","page":"HydroPumpedStorage","title":"HydroPumpedStorage","text":"Modules = [PowerSystems]\nPages = [\"generated/HydroPumpedStorage.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.HydroPumpedStorage","page":"HydroPumpedStorage","title":"PowerSystems.HydroPumpedStorage","text":"mutable struct HydroPumpedStorage <: HydroGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n base_power::Float64\n prime_mover_type::PrimeMovers\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n time_limits::Union{Nothing, UpDown}\n rating_pump::Float64\n active_power_limits_pump::MinMax\n reactive_power_limits_pump::Union{Nothing, MinMax}\n ramp_limits_pump::Union{Nothing, UpDown}\n time_limits_pump::Union{Nothing, UpDown}\n storage_capacity::UpDown\n inflow::Float64\n outflow::Float64\n initial_storage::UpDown\n storage_target::UpDown\n operation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}\n pump_efficiency::Float64\n conversion_factor::Float64\n status::PumpHydroStatus\n time_at_status::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA hydropower generator with pumped storage and upper and lower reservoirs. \n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR)\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nrating_pump::Float64: Maximum power withdrawal (MVA) of the pump, validation range: (0, nothing)\nactive_power_limits_pump::MinMax:\nreactive_power_limits_pump::Union{Nothing, MinMax}:\nramp_limits_pump::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min of pump, validation range: (0, nothing)\ntime_limits_pump::Union{Nothing, UpDown}: Minimum up and Minimum down time limits of pump in hours, validation range: (0, nothing)\nstorage_capacity::UpDown: Maximum storage capacity in the upper and lower reservoirs (units can be p.u-hr or m^3), validation range: (0, nothing)\ninflow::Float64: Baseline inflow into the upper reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)\noutflow::Float64: Baseline outflow from the lower reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)\ninitial_storage::UpDown: Initial storage capacity in the upper and lower reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)\nstorage_target::UpDown: (default: (up=1.0, down=1.0)) Storage target of upper reservoir at the end of simulation as ratio of storage capacity\noperation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation\npump_efficiency::Float64: (default: 1.0) Pumping efficiency [0, 1.0], validation range: (0, 1)\nconversion_factor::Float64: (default: 1.0) Conversion factor from flow/volume to energy: m^3 -> p.u-hr\nstatus::PumpHydroStatus: (default: PumpHydroStatus.OFF) Initial commitment condition at the start of a simulation (PumpHydroStatus.PUMP, PumpHydroStatus.GEN, or PumpHydroStatus.OFF)\ntime_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been generating, pumping, or off, as indicated by status\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_HydroPumpedStorage/#InfrastructureSystems.get_name-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"InfrastructureSystems.get_name","text":"get_name(value::HydroPumpedStorage) -> String\n\n\nGet HydroPumpedStorage name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_active_power-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_active_power","text":"get_active_power(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_active_power_limits-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::HydroPumpedStorage\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet HydroPumpedStorage active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_active_power_limits_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_active_power_limits_pump","text":"get_active_power_limits_pump(\n value::HydroPumpedStorage\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet HydroPumpedStorage active_power_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_available-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_available","text":"get_available(value::HydroPumpedStorage) -> Bool\n\n\nGet HydroPumpedStorage available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_base_power-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_base_power","text":"get_base_power(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_bus-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_bus","text":"get_bus(value::HydroPumpedStorage) -> ACBus\n\n\nGet HydroPumpedStorage bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_conversion_factor-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_conversion_factor","text":"get_conversion_factor(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_dynamic_injector-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::HydroPumpedStorage\n) -> Union{Nothing, DynamicInjection}\n\n\nGet HydroPumpedStorage dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_ext-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_ext","text":"get_ext(value::HydroPumpedStorage) -> Dict{String, Any}\n\n\nGet HydroPumpedStorage ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_inflow-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_inflow","text":"get_inflow(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage inflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_initial_storage-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_initial_storage","text":"get_initial_storage(\n value::HydroPumpedStorage\n) -> NamedTuple{(:up, :down), <:Tuple{Any, Any}}\n\n\nGet HydroPumpedStorage initial_storage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_operation_cost-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::HydroPumpedStorage\n) -> Union{HydroGenerationCost, MarketBidCost, StorageCost}\n\n\nGet HydroPumpedStorage operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_outflow-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_outflow","text":"get_outflow(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage outflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_prime_mover_type-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::HydroPumpedStorage\n) -> PrimeMovers\n\n\nGet HydroPumpedStorage prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_pump_efficiency-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_pump_efficiency","text":"get_pump_efficiency(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage pump_efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_ramp_limits-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::HydroPumpedStorage\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet HydroPumpedStorage ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_ramp_limits_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_ramp_limits_pump","text":"get_ramp_limits_pump(\n value::HydroPumpedStorage\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet HydroPumpedStorage ramp_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_rating-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_rating","text":"get_rating(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_rating_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_rating_pump","text":"get_rating_pump(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage rating_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_reactive_power-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::HydroPumpedStorage) -> Any\n\n\nGet HydroPumpedStorage reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_reactive_power_limits-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::HydroPumpedStorage\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HydroPumpedStorage reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_reactive_power_limits_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_reactive_power_limits_pump","text":"get_reactive_power_limits_pump(\n value::HydroPumpedStorage\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HydroPumpedStorage reactive_power_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_services-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_services","text":"get_services(value::HydroPumpedStorage) -> Vector{Service}\n\n\nGet HydroPumpedStorage services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_status-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_status","text":"get_status(\n value::HydroPumpedStorage\n) -> PowerSystems.PumpHydroStatusModule.PumpHydroStatus\n\n\nGet HydroPumpedStorage status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_storage_capacity-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_storage_capacity","text":"get_storage_capacity(\n value::HydroPumpedStorage\n) -> NamedTuple{(:up, :down), <:Tuple{Any, Any}}\n\n\nGet HydroPumpedStorage storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_storage_target-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_storage_target","text":"get_storage_target(\n value::HydroPumpedStorage\n) -> @NamedTuple{up::Float64, down::Float64}\n\n\nGet HydroPumpedStorage storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_time_at_status-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_time_at_status","text":"get_time_at_status(value::HydroPumpedStorage) -> Float64\n\n\nGet HydroPumpedStorage time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_time_limits-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::HydroPumpedStorage\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet HydroPumpedStorage time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.get_time_limits_pump-Tuple{HydroPumpedStorage}","page":"HydroPumpedStorage","title":"PowerSystems.get_time_limits_pump","text":"get_time_limits_pump(\n value::HydroPumpedStorage\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet HydroPumpedStorage time_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_active_power!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_active_power_limits!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_active_power_limits_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_active_power_limits_pump!","text":"set_active_power_limits_pump!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage active_power_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_available!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_available!","text":"set_available!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_base_power!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_bus!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_bus!","text":"set_bus!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_conversion_factor!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_conversion_factor!","text":"set_conversion_factor!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_ext!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_ext!","text":"set_ext!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_inflow!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_inflow!","text":"set_inflow!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage inflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_initial_storage!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_initial_storage!","text":"set_initial_storage!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage initial_storage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_operation_cost!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_outflow!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_outflow!","text":"set_outflow!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage outflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_prime_mover_type!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_pump_efficiency!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_pump_efficiency!","text":"set_pump_efficiency!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage pump_efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_ramp_limits!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_ramp_limits_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_ramp_limits_pump!","text":"set_ramp_limits_pump!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage ramp_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_rating!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_rating!","text":"set_rating!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_rating_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_rating_pump!","text":"set_rating_pump!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage rating_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_reactive_power!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_reactive_power_limits!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_reactive_power_limits_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_reactive_power_limits_pump!","text":"set_reactive_power_limits_pump!(\n value::HydroPumpedStorage,\n val\n) -> Any\n\n\nSet HydroPumpedStorage reactive_power_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_services!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_services!","text":"set_services!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_status!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_status!","text":"set_status!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_storage_capacity!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_storage_capacity!","text":"set_storage_capacity!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_storage_target!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_storage_target!","text":"set_storage_target!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_time_at_status!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_time_at_status!","text":"set_time_at_status!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_time_limits!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroPumpedStorage/#PowerSystems.set_time_limits_pump!-Tuple{HydroPumpedStorage, Any}","page":"HydroPumpedStorage","title":"PowerSystems.set_time_limits_pump!","text":"set_time_limits_pump!(value::HydroPumpedStorage, val) -> Any\n\n\nSet HydroPumpedStorage time_limits_pump.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#DynamicExponentialLoad","page":"DynamicExponentialLoad","title":"DynamicExponentialLoad","text":"","category":"section"},{"location":"model_library/generated_DynamicExponentialLoad/","page":"DynamicExponentialLoad","title":"DynamicExponentialLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/DynamicExponentialLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.DynamicExponentialLoad","page":"DynamicExponentialLoad","title":"PowerSystems.DynamicExponentialLoad","text":"mutable struct DynamicExponentialLoad <: DynamicInjection\n name::String\n a::Float64\n b::Float64\n α::Float64\n β::Float64\n T_p::Float64\n T_q::Float64\n ext::Dict{String, Any}\n base_power::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 2-states of a generic dynamic load model based on \"Voltage stability analysis using generic dynamic load models.\"\n\nArguments\n\nname::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\na::Float64: Active power static exponential coefficient, validation range: (0, nothing)\nb::Float64: Reactive power static exponential coefficient, validation range: (0, nothing)\nα::Float64: Active power transient exponential coefficient, validation range: (0, nothing)\nβ::Float64: Reactive power transient exponential coefficient, validation range: (0, nothing)\nT_p::Float64: Active Power Time Constant, validation range: (0, nothing)\nT_q::Float64: Reactive Power Time Constant, validation range: (0, nothing)\next::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.\nbase_power::Float64: Base power of the load (MVA) for per unitization\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nx_p: Integrator state of the active power,\nx_q: Integrator state of the reactive power,\n\nn_states::Int: (Do not modify.) DynamicExponentialLoad has 2 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_DynamicExponentialLoad/#InfrastructureSystems.get_name-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::DynamicExponentialLoad) -> String\n\n\nGet DynamicExponentialLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_T_p-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_T_p","text":"get_T_p(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_T_q-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_T_q","text":"get_T_q(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad T_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_a-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_a","text":"get_a(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_b-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_b","text":"get_b(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_base_power-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_ext-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_ext","text":"get_ext(value::DynamicExponentialLoad) -> Dict{String, Any}\n\n\nGet DynamicExponentialLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_n_states-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_n_states","text":"get_n_states(value::DynamicExponentialLoad) -> Int64\n\n\nGet DynamicExponentialLoad n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_states-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_states","text":"get_states(value::DynamicExponentialLoad) -> Vector{Symbol}\n\n\nGet DynamicExponentialLoad states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_α-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_α","text":"get_α(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.get_β-Tuple{DynamicExponentialLoad}","page":"DynamicExponentialLoad","title":"PowerSystems.get_β","text":"get_β(value::DynamicExponentialLoad) -> Float64\n\n\nGet DynamicExponentialLoad β.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_T_p!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_T_p!","text":"set_T_p!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_T_q!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_T_q!","text":"set_T_q!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad T_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_a!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_a!","text":"set_a!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_b!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_b!","text":"set_b!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_base_power!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_ext!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_α!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_α!","text":"set_α!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DynamicExponentialLoad/#PowerSystems.set_β!-Tuple{DynamicExponentialLoad, Any}","page":"DynamicExponentialLoad","title":"PowerSystems.set_β!","text":"set_β!(value::DynamicExponentialLoad, val) -> Any\n\n\nSet DynamicExponentialLoad β.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#ActiveConstantPowerLoad","page":"ActiveConstantPowerLoad","title":"ActiveConstantPowerLoad","text":"","category":"section"},{"location":"model_library/generated_ActiveConstantPowerLoad/","page":"ActiveConstantPowerLoad","title":"ActiveConstantPowerLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/ActiveConstantPowerLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.ActiveConstantPowerLoad","page":"ActiveConstantPowerLoad","title":"PowerSystems.ActiveConstantPowerLoad","text":"mutable struct ActiveConstantPowerLoad <: DynamicInjection\n name::String\n r_load::Float64\n c_dc::Float64\n rf::Float64\n lf::Float64\n cf::Float64\n rg::Float64\n lg::Float64\n kp_pll::Float64\n ki_pll::Float64\n kpv::Float64\n kiv::Float64\n kpc::Float64\n kic::Float64\n base_power::Float64\n ext::Dict{String, Any}\n P_ref::Float64\n Q_ref::Float64\n V_ref::Float64\n ω_ref::Float64\n is_filter_differential::Int\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 12-states active power load based on the paper, \"Dynamic Stability of a Microgrid With an Active Load.\"\n\nArguments\n\nname::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\nr_load::Float64: DC-side resistor, validation range: (0, nothing)\nc_dc::Float64: DC-side capacitor, validation range: (0, nothing)\nrf::Float64: Converter side filter resistance, validation range: (0, nothing)\nlf::Float64: Converter side filter inductance, validation range: (0, nothing)\ncf::Float64: AC Converter filter capacitance, validation range: (0, nothing)\nrg::Float64: Network side filter resistance, validation range: (0, nothing)\nlg::Float64: Network side filter inductance, validation range: (0, nothing)\nkp_pll::Float64: Proportional constant for PI-PLL block, validation range: (0, nothing)\nki_pll::Float64: Integral constant for PI-PLL block, validation range: (0, nothing)\nkpv::Float64: Proportional constant for Voltage Control block, validation range: (0, nothing)\nkiv::Float64: Integral constant for Voltage Control block, validation range: (0, nothing)\nkpc::Float64: Proportional constant for Current Control block, validation range: (0, nothing)\nkic::Float64: Integral constant for Current Control block, validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\next::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.\nP_ref::Float64: Reference active power (pu)\nQ_ref::Float64: Reference reactive power (pu)\nV_ref::Float64: Reference voltage (pu)\nω_ref::Float64: Reference frequency (pu)\nis_filter_differential::Int: Boolean to decide if filter states are differential or algebraic\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nθ_pll: PLL deviation angle, \nϵ_pll: PLL integrator state, \nη: DC-voltage controller integrator state, \nv_dc: DC voltage at the capacitor, \nγd: d-axis Current controller integrator state, \nγq: q-axis Current controller integrator state, \nir_cnv: Real current out of the converter,\nii_cnv: Imaginary current out of the converter,\nvr_filter: Real voltage at the filter's capacitor,\nvi_filter: Imaginary voltage at the filter's capacitor,\nir_filter: Real current out of the filter,\nii_filter: Imaginary current out of the filter\n\nn_states::Int: (Do not modify.) ActiveConstantPowerLoad has 12 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ActiveConstantPowerLoad/#InfrastructureSystems.get_name-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::ActiveConstantPowerLoad) -> String\n\n\nGet ActiveConstantPowerLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_P_ref-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_Q_ref-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_V_ref-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_base_power-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_c_dc-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_c_dc","text":"get_c_dc(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad c_dc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_cf-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_cf","text":"get_cf(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_ext-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_ext","text":"get_ext(value::ActiveConstantPowerLoad) -> Dict{String, Any}\n\n\nGet ActiveConstantPowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_is_filter_differential-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_is_filter_differential","text":"get_is_filter_differential(\n value::ActiveConstantPowerLoad\n) -> Int64\n\n\nGet ActiveConstantPowerLoad is_filter_differential.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_ki_pll-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_ki_pll","text":"get_ki_pll(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kic-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kic","text":"get_kic(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kiv-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kiv","text":"get_kiv(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kp_pll-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kp_pll","text":"get_kp_pll(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kpc-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kpc","text":"get_kpc(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_kpv-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_kpv","text":"get_kpv(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_lf-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_lf","text":"get_lf(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_lg-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_lg","text":"get_lg(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad lg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_n_states-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActiveConstantPowerLoad) -> Int64\n\n\nGet ActiveConstantPowerLoad n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_r_load-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_r_load","text":"get_r_load(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad r_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_rf-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_rf","text":"get_rf(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_rg-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_rg","text":"get_rg(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad rg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_states-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_states","text":"get_states(value::ActiveConstantPowerLoad) -> Vector{Symbol}\n\n\nGet ActiveConstantPowerLoad states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.get_ω_ref-Tuple{ActiveConstantPowerLoad}","page":"ActiveConstantPowerLoad","title":"PowerSystems.get_ω_ref","text":"get_ω_ref(value::ActiveConstantPowerLoad) -> Float64\n\n\nGet ActiveConstantPowerLoad ω_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_P_ref!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_Q_ref!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_V_ref!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_base_power!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_c_dc!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_c_dc!","text":"set_c_dc!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad c_dc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_cf!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_cf!","text":"set_cf!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad cf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_ext!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_is_filter_differential!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_is_filter_differential!","text":"set_is_filter_differential!(\n value::ActiveConstantPowerLoad,\n val\n) -> Any\n\n\nSet ActiveConstantPowerLoad is_filter_differential.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_ki_pll!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_ki_pll!","text":"set_ki_pll!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kic!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kic!","text":"set_kic!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kiv!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kiv!","text":"set_kiv!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kp_pll!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kp_pll!","text":"set_kp_pll!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kpc!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kpc!","text":"set_kpc!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_kpv!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_kpv!","text":"set_kpv!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_lf!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_lf!","text":"set_lf!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad lf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_lg!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_lg!","text":"set_lg!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad lg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_r_load!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_r_load!","text":"set_r_load!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad r_load.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_rf!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_rf!","text":"set_rf!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad rf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_rg!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_rg!","text":"set_rg!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad rg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ActiveConstantPowerLoad/#PowerSystems.set_ω_ref!-Tuple{ActiveConstantPowerLoad, Any}","page":"ActiveConstantPowerLoad","title":"PowerSystems.set_ω_ref!","text":"set_ω_ref!(value::ActiveConstantPowerLoad, val) -> Any\n\n\nSet ActiveConstantPowerLoad ω_ref.\n\n\n\n\n\n","category":"method"},{"location":"how_to/get_available_generators/#Get-the-available-generators-in-a-System","page":"...get the available generators in a system","title":"Get the available generators in a System","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"using PowerSystems; #hide\nusing PowerSystemCaseBuilder #hide\nsystem = build_system(PSISystems, \"modified_RTS_GMLC_DA_sys\"); #hide","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"You can access use get_available_components or get_components to access all the available generators in an existing system.","category":"page"},{"location":"how_to/get_available_generators/#Option-1a:-Using-get_available_components-to-get-an-iterator","page":"...get the available generators in a system","title":"Option 1a: Using get_available_components to get an iterator","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"Use get_available_components to get an iterator of all the available generators in an existing system, which also prints a summary:","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"gen_iter = get_available_components(Generator, system)","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"The iterator avoids unnecessary memory allocations if there are many generators, and it can be used to view or update the generator data, such as seeing each of the names:","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"get_name.(gen_iter)","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"tip: Tip\nAbove, we use the abstract supertype Generator to get all components that are subtypes of it. You can instead get all the components of a concrete type, such as:gen_iter = get_available_components(RenewableDispatch, system)","category":"page"},{"location":"how_to/get_available_generators/#Option-1b:-Using-get_available_components-to-get-a-vector","page":"...get the available generators in a system","title":"Option 1b: Using get_available_components to get a vector","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"Use collect to get a vector of the generators instead of an iterator, which could require a lot of memory:","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"gens = collect(get_available_components(Generator, system));","category":"page"},{"location":"how_to/get_available_generators/#Option-2:-Using-get_components-to-get-an-iterator","page":"...get the available generators in a system","title":"Option 2: Using get_components to get an iterator","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"Alternatively, use get_components with a filter to check for availability:","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"gen_iter = get_components(get_available, Generator, system)","category":"page"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"collect can also be used to turn this iterator into a vector.","category":"page"},{"location":"how_to/get_available_generators/#See-Also","page":"...get the available generators in a system","title":"See Also","text":"","category":"section"},{"location":"how_to/get_available_generators/","page":"...get the available generators in a system","title":"...get the available generators in a system","text":"How to: Get the buses in a System","category":"page"},{"location":"how_to/parse_tabular_data/#table_data","page":"...parse tabular data from .csv files","title":"Parse Tabular Data from .csv Files","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"warning: Warning\nThis parser will be deprecated sometime in the fall of 2024. PowerSystems.jl will be moving to a database solution for handling data. There are plans to eventually include utility functions to translate from .csv files to the database, but there will probably be a gap in support. Users are recommended to write their own custom Julia code to import data from their unique data formats, rather than relying on this parsing code.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"This parser, called the tabular data parser, is a custom format that allows users to define power system component data by category and column with custom names, types, and units.","category":"page"},{"location":"how_to/parse_tabular_data/#Categories","page":"...parse tabular data from .csv files","title":"Categories","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Components for each category must be defined in their own CSV file. The following categories are currently supported:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"branch.csv\nbus.csv (required)\ncolumns specifying area and zone will create a corresponding set of Area and LoadZone objects.\ncolumns specifying max_active_power or max_reactive_power will create PowerLoad objects when nonzero values are encountered and will contribute to the peak_active_power and peak_reactive_power values for the corresponding LoadZone object.\ndc_branch.csv\ngen.csv\nload.csv\nreserves.csv\nstorage.csv","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"These must reside in the directory passed when constructing PowerSystemTableData.","category":"page"},{"location":"how_to/parse_tabular_data/#Customization","page":"...parse tabular data from .csv files","title":"Customization","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"The tabular data parser in PowerSystems.jl can be customized to read a variety of datasets by configuring:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"which type of generator (<:Generator) to create based on the fuel and prime mover specifications\nproperty names, units, and per units conversions in *.csv files","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Here is an example of how to construct a System with all customizations listed in this section:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"data_dir = \"/data/my-data-dir\"\nbase_power = 100.0\ndescriptors = \"./user_descriptors.yaml\"\ntimeseries_metadata_file = \"./timeseries_pointers.json\"\ngenerator_mapping_file = \"./generator_mapping.yaml\"\ndata = PowerSystemTableData(\n data_dir,\n base_power,\n descriptors;\n timeseries_metadata_file = timeseries_metadata_file,\n generator_mapping_file = generator_mapping_file,\n)\nsys = System(data; time_series_in_memory = true)","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Examples configuration files can be found in the RTS-GMLC repo:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"user_descriptors.yaml\ngenerator_mapping.yaml","category":"page"},{"location":"how_to/parse_tabular_data/#csv_data","page":"...parse tabular data from .csv files","title":"CSV Data Configurations","text":"","category":"section"},{"location":"how_to/parse_tabular_data/#csv_genmap","page":"...parse tabular data from .csv files","title":"Custom construction of generators","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/#csv_columns","page":"...parse tabular data from .csv files","title":"Column names","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"PowerSystems provides am input mapping capability that allows you to keep your own column names.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"python ./bin/generate_config_file.py ./user_descriptors.yaml","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Next, edit this file with your customizations.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/#csv_per_unit","page":"...parse tabular data from .csv files","title":"Per-unit conversion","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"For more info on the per-unit conventions in PowerSystems.jl, refer to the per-unit section of the system documentation.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/#csv_units","page":"...parse tabular data from .csv files","title":"Unit conversion","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"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.","category":"page"},{"location":"how_to/parse_tabular_data/#Extending-the-Tabular-Data-Parser","page":"...parse tabular data from .csv files","title":"Extending the Tabular Data Parser","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"This section describes how developers should read columns from raw data files, and assumes you are familiar with the sections above.","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"The main point is that you should not read individual hard-coded column names from DataFrames. The parsing code includes mapping functionality that allows you to use PowerSystems-standard names while letting the users define their own custom names.","category":"page"},{"location":"how_to/parse_tabular_data/#Procedure","page":"...parse tabular data from .csv files","title":"Procedure","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Add an entry to the array of parameters for your category in src/descriptors/power_system_inputs.json according to the following:\nUse snake_case for the name field.\nThe fields name and description are required.\nTry to use a name that is generic and not specific to one dataset.\nIt is recommended that you define unit.\nIf PowerSystems expects the value to be per-unit then you must specify system_per_unit=true.\nPowerSystems has two commonly-used datasets with customized user config files: PowerSystemsTestData and RTS_GMLC. Update both of these files and submit pull requests.\nParse the raw data like in this example:","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"function demo_bus_csv_parser!(data::PowerSystemTableData)\n for bus in iterate_rows(data, BUS::InputCategory)\n @show bus.name, bus.max_active_power, bus.max_reactive_power\n end\nend","category":"page"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"iterate_rows returns a NamedTuple where each name defined in src/descriptors/power_system_inputs.json is a field.","category":"page"},{"location":"how_to/parse_tabular_data/#See-also:","page":"...parse tabular data from .csv files","title":"See also:","text":"","category":"section"},{"location":"how_to/parse_tabular_data/","page":"...parse tabular data from .csv files","title":"...parse tabular data from .csv files","text":"Parsing Matpower or PSS/e RAW Files\nParsing PSS/e DYR Files\nParsing time series","category":"page"},{"location":"api/valuecurve_options/#curve_table","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"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.","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"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 is done by constructing various subtypes of ValueCurve.","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"This summary table shows each way to construct a ValueCurve with the user-friendly subtype aliases. The ValueCurves make no assumption about units; the example interpretation given here assumes that the variable cost ValueCurve will be wrapped in a CostCurve with natural units. Note that all four Piecewise options here fundamentally represent the same curve. More information and explanatory plots are provided for each subtype alias in the subheadings below.","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Description Example Example interpretation\nLinear input-output curve with zero no-load cost (constant average rate) LinearCurve(5.0) $5/MWh\nLinear input-output curve with potentially nonzero no-load cost (constant marginal rate) LinearCurve(5.0, 15.0) $5/MWh + $15/hr\nQuadratic input-output curve with potentially nonzero no-load cost QuadraticCurve(1.0, 1.0, 18.0) C(P) = 1 P^2 + 1 P + 18 where C is $/hr, P is MW\nPiecewise linear curve specified by cost values at production points PiecewisePointCurve([(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\nPiecewise linear curve specified by initial value and marginal rates (slopes) between production points PiecewiseIncrementalCurve(20.0, [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\nNo-load cost plus piecewise linear curve specified by initial value and marginal rates (slopes) between production points PiecewiseIncrementalCurve(18.0, 20.0, [1.0, 2.0, 3.0], [4.0, 6.0]) $18/hr no-load cost; $20/hr @ 1 MW plus additional $4/MWh from 1 MW to 2 MW plus additional $6/MWh from 2 MW to 3 MW\nPiecewise linear curve specified by initial value and average rates between production points PiecewiseAverageCurve(20.0, [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","category":"page"},{"location":"api/valuecurve_options/#[LinearCurve](@ref)","page":"ValueCurve Options","title":"LinearCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify the marginal cost of production M and optionally the no-load cost C, which defaults to zero. Here is a graphical representation:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"api/valuecurve_options/#[QuadraticCurve](@ref)","page":"ValueCurve Options","title":"QuadraticCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify the quadratic (Q), proportional (M), and constant (C) terms of a function that defines the input-output curve:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"api/valuecurve_options/#[PiecewisePointCurve](@ref)","page":"ValueCurve Options","title":"PiecewisePointCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify a vector of K (production, cost) pairs (i.e., (P_k C_k) for k = 1 dots K) to define the input-output curve:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"api/valuecurve_options/#[PiecewiseIncrementalCurve](@ref)","page":"ValueCurve Options","title":"PiecewiseIncrementalCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify the cost C_1 at the least production point given (NOT the cost at zero production), a vector of K production points P_1 dots P_k, and a vector of K-1 marginal rates M_1 dots M_k-1, that represent the slopes of the curve segments between the points. C_1 may be nothing, which results in a not-fully-defined curve. The no-load cost C_0 can optionally be specified as a first argument; it is not part of the representation of the curve, just another piece of data that may be stored:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"api/valuecurve_options/#[PiecewiseAverageCurve](@ref)","page":"ValueCurve Options","title":"PiecewiseAverageCurve","text":"","category":"section"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"Specify the cost C_1 at the least production point given (NOT the cost at zero production), a vector of K production points P_1 dots P_k, and a vector of K-1 average rates R_1 dots R_k-1 at the K-1 latter production points:","category":"page"},{"location":"api/valuecurve_options/","page":"ValueCurve Options","title":"ValueCurve Options","text":"","category":"page"},{"location":"how_to/migrating_to_psy4/#psy4_migration","page":"...migrate from version 3.0 to 4.0","title":"Migrating from version 3.0 to 4.0","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"This guide outlines the code updates required to upgrade from PowerSystems.jl version 3.0 to 4.0, which was released in June 2024 and includes breaking changes. These are:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Renamed Types and Parameters\nNew and Eliminated Types\nUpdates to Energy Storage Parameters\nHydropower status added\nNew Cost Functions\nNew Time Series Horizon Format\nMinor Type Hierarchy Change\n(Temporary) Use Version 3.0 for HybridSystem (+ new parameter)","category":"page"},{"location":"how_to/migrating_to_psy4/#Renamed-Types-and-Parameters","page":"...migrate from version 3.0 to 4.0","title":"Renamed Types and Parameters","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Some Types and fields were renamed, which should require a trivial search and replace:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Renamed Types:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"RenewableFix is now named RenewableNonDispatch\nStaticReserve is now named ConstantReserve\nStaticReserveGroup is now named ConstantReserveGroup\nStaticReserveNonSpinning is now named ConstantReserveNonSpinning\nPriorityCurrentLimiter is now named PriorityOutputCurrentLimiter\nMagnitudeCurrentLimiter is now named MagnitudeOutputCurrentLimiter\nInstantaneousCurrentLimiter is now named InstantaneousOutputCurrentLimiter","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Renamed parameters:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The rate parameter is now named rating for subtypes of Branch, for consistency with other Types. Affected Types are:\nLine\nMonitoredLine\nPhaseShiftingTransformer\nTapTransformer\nTransformer2W","category":"page"},{"location":"how_to/migrating_to_psy4/#New-and-Eliminated-Types","page":"...migrate from version 3.0 to 4.0","title":"New and Eliminated Types","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"In addition to cost-related types detailed in New Cost Functions, these new types have been added:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"AreaInterchange\nHybridOutputCurrentLimiter\nSaturationOutputCurrentLimiter","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"These types are no longer part of PowerSystems.jl, although there are future plans to rework some of them:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"RegulationDevice\nTransfer\nBatteryEMS\nGenericBattery (see Updates to Energy Storage Parameters)","category":"page"},{"location":"how_to/migrating_to_psy4/#esr_migration","page":"...migrate from version 3.0 to 4.0","title":"Updates to Energy Storage Parameters","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"EnergyReservoirStorage is now the default battery and energy storage model, replacing GenericBattery.","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"There are also changes to the data fields compared to GenericBattery to improve clarity and modeling flexibility.","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"New data fields:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"storage_capacity for the maximum storage capacity (can be in units of, e.g., MWh for batteries or liters for hydrogen)\nExample: 10000.0 for 10,000 liters hydrogen\nstorage_level_limits for the minimum and maximum allowable storage levels on [0, 1], which can be used to model derates or other restrictions, such as state-of-charge restrictions on battery cycling\nExample: Minimum of 0.2 and maximum of 1.0 to restrict the storage from dropping below 20% capacity to keep some reserve margin available at all times\ninitial_storage_capacity_level for the initial storage capacity level as a ratio [0, 1.0] of storage_capacity\nExample: 0.5 to start the storage at 50% full\nconversion_factor is the (optional) conversion factor of storage_capacity to MWh, if different than 1.0 (i.e., no conversion is needed if the storage_capacity is in MWh)\nExample: 0.0005 for 0.5 kWh/l hydrogen","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Removed data fields:","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"state_of_charge_limits with units of p.u.-hr\ninitial_energy with units of p.u.-hr","category":"page"},{"location":"how_to/migrating_to_psy4/#Hydropower-status-added","page":"...migrate from version 3.0 to 4.0","title":"Hydropower status added","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"A new required parameter, status, was added to HydroEnergyReservoir and HydroPumpedStorage, for the initial condition of the generator.","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"For HydroEnergyReservoir, status can be true = on or false = off.\nFor HydroPumpedStorage, status can be PumpHydroStatus.PUMP, PumpHydroStatus.GEN, or PumpHydroStatus.OFF","category":"page"},{"location":"how_to/migrating_to_psy4/#New-Cost-Functions","page":"...migrate from version 3.0 to 4.0","title":"New Cost Functions","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/#New-Time-Series-Horizon-Format","page":"...migrate from version 3.0 to 4.0","title":"New Time Series Horizon Format","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The horizon for a forecast has changed from a count of time steps (as an Int) to a duration, as a Dates.Period","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Example day-ahead forecast: A forecast with hourly resolution for the next 24 hours, with a new forecast available every 24 hours (i.e., 24-hour interval)","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The horizon is now Dates.Hour(24) or Dates.Day(1)\nPreviously in version 3.0, the horizon would have been 24 for the 24 1-hour time-steps in each forecast","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"Example hour-ahead forecast: A forecast with 5-minute resolution for the next 1 hour, with a new forecast available every hour (i.e., 1-hour interval)","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The horizon is now Dates.Hour(1)\nPreviously in version 3.0, the horizon would have been 12 for the 12 5-minute time-steps in each forecast","category":"page"},{"location":"how_to/migrating_to_psy4/#Minor-Type-Hierarchy-Change","page":"...migrate from version 3.0 to 4.0","title":"Minor Type Hierarchy Change","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"ControllableLoad is now a subtype of StaticLoad rather than ElectricLoad","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The vast majority of users are not expected to be impacted by this change.","category":"page"},{"location":"how_to/migrating_to_psy4/#(Temporary)-Use-Version-3.0-for-HybridSystem-(-new-parameter)","page":"...migrate from version 3.0 to 4.0","title":"(Temporary) Use Version 3.0 for HybridSystem (+ new parameter)","text":"","category":"section"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"The HybridSystem is currently not supported in the rest of the Sienna ecosystem, such as PowerSimulations.jl. To use HybridSystem in simulation, revert to version 3.0. There are plans to update HybridSystem for version 4.0, but they have not been completed.","category":"page"},{"location":"how_to/migrating_to_psy4/","page":"...migrate from version 3.0 to 4.0","title":"...migrate from version 3.0 to 4.0","text":"In addition, HybridSystem has a new required parameter: interconnection_efficiency","category":"page"},{"location":"how_to/market_bid_cost/#Add-a-Market-Bid","page":"...add a market bid","title":"Add a Market Bid","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"A MarketBidCost is an OperationalCost data structure that allows the user to run a production cost model that is very similar to most US electricity market auctions with bids for energy and ancillary services jointly. This page showcases how to create data for this cost function.","category":"page"},{"location":"how_to/market_bid_cost/#Adding-a-Single-Incremental-Energy-bids-to-MarketBidCost","page":"...add a market bid","title":"Adding a Single Incremental Energy bids to MarketBidCost","text":"","category":"section"},{"location":"how_to/market_bid_cost/#Construct-directly-the-MarketBidCost-using-the-make_market_bid_curve-method.","page":"...add a market bid","title":"Construct directly the MarketBidCost using the make_market_bid_curve method.","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"The make_market_bid_curve creates an incremental or decremental offer curve from a vector of n power values, a vector of n-1 marginal costs and single initial input. For example, the following code creates an incremental offer curve:","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"using PowerSystems, Dates\nproposed_offer_curve =\n make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0)","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Then a device with MarketBidCost can be directly instantiated using:","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"using PowerSystems, Dates\nbus = ACBus(1, \"nodeE\", \"REF\", 0, 1.0, (min = 0.9, max = 1.05), 230, nothing, nothing)\n\ngenerator = ThermalStandard(;\n name = \"Brighton\",\n available = true,\n status = true,\n bus = bus,\n active_power = 6.0,\n reactive_power = 1.50,\n rating = 0.75,\n prime_mover_type = PrimeMovers.ST,\n fuel = ThermalFuels.COAL,\n active_power_limits = (min = 0.0, max = 6.0),\n reactive_power_limits = (min = -4.50, max = 4.50),\n time_limits = (up = 0.015, down = 0.015),\n ramp_limits = (up = 5.0, down = 3.0),\n operation_cost = MarketBidCost(;\n no_load_cost = 0.0,\n start_up = (hot = 0.0, warm = 0.0, cold = 0.0),\n shut_down = 0.0,\n incremental_offer_curves = proposed_offer_curve,\n ),\n base_power = 100.0,\n)","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Similarly, a decremental offer curve can also be created directly using the same helper method:","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"using PowerSystems, Dates\ndecremental_offer =\n make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [30.0, 28.0, 26.0, 25.0], 50.0)","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"and can be added to a MarketBidCost using the field decremental_offer_curves.","category":"page"},{"location":"how_to/market_bid_cost/#Adding-Time-Series-Energy-bids-to-MarketBidCost","page":"...add a market bid","title":"Adding Time Series Energy bids to MarketBidCost","text":"","category":"section"},{"location":"how_to/market_bid_cost/#Step-1:-Constructing-device-with-MarketBidCost","page":"...add a market bid","title":"Step 1: Constructing device with MarketBidCost","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"When using MarketBidCost, the user can add the cost struct to the device specifying only certain elements, at this point the actual energy cost bids don't need to be populated/passed.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"The code below shows an example how we can create a thermal device with MarketBidCost.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"using PowerSystems, Dates\nbus = ACBus(1, \"nodeE\", \"REF\", 0, 1.0, (min = 0.9, max = 1.05), 230, nothing, nothing)\n\ngenerator = ThermalStandard(;\n name = \"Brighton\",\n available = true,\n status = true,\n bus = bus,\n active_power = 6.0,\n reactive_power = 1.50,\n rating = 0.75,\n prime_mover_type = PrimeMovers.ST,\n fuel = ThermalFuels.COAL,\n active_power_limits = (min = 0.0, max = 6.0),\n reactive_power_limits = (min = -4.50, max = 4.50),\n time_limits = (up = 0.015, down = 0.015),\n ramp_limits = (up = 5.0, down = 3.0),\n operation_cost = MarketBidCost(;\n no_load_cost = 0.0,\n start_up = (hot = 0.0, warm = 0.0, cold = 0.0),\n shut_down = 0.0,\n ),\n base_power = 100.0,\n)","category":"page"},{"location":"how_to/market_bid_cost/#Step-2:-Creating-the-TimeSeriesData-for-the-Market-Bid","page":"...add a market bid","title":"Step 2: Creating the TimeSeriesData for the Market Bid","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"The user is expected to pass the TimeSeriesData that holds the energy bid data which can be of any type (i.e. SingleTimeSeries or Deterministic) and data must be PiecewiseStepData. This data type is created by specifying a vector of n powers, and n-1 marginal costs. The data must be specified in natural units, that is power in MW and marginal cost in /MWh or it will not be accepted when adding to the system. Code below shows an example of how to build a Deterministic TimeSeries.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"initial_time = Dates.DateTime(\"2020-01-01\")\npsd1 = PiecewiseStepData([5.0, 7.33, 9.67, 12.0], [2.901, 5.8272, 8.941])\npsd2 = PiecewiseStepData([5.0, 7.33, 9.67, 12.0], [3.001, 6.0072, 9.001])\ndata =\n Dict(\n initial_time => [\n psd1,\n psd2,\n ],\n )\ntime_series_data = Deterministic(;\n name = \"variable_cost\",\n data = data,\n resolution = Dates.Hour(1),\n)","category":"page"},{"location":"how_to/market_bid_cost/#Step-3a:-Adding-Energy-Bid-TimeSeriesData-to-the-device","page":"...add a market bid","title":"Step 3a: Adding Energy Bid TimeSeriesData to the device","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"To add energy market bids time-series to the MarketBidCost, use set_variable_cost!. The arguments for set_variable_cost! are:","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"sys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::TimeSeriesData: TimeSeriesData\npower_units::UnitSystem: UnitSystem","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Currently, time series data only supports natural units for time series data, i.e. MW for power and /MWh for marginal costs.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"sys = System(100.0, [bus], [generator])\nset_variable_cost!(sys, generator, time_series_data, UnitSystem.NATURAL_UNITS)","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Note: set_variable_cost! add curves to the incremental_offer_curves in the MarketBidCost. Similarly, set_incremental_variable_cost! can be used to add curves to the incremental_offer_curves. On the other hand, set_decremental_variable_cost! must be used to decremental curves (usually for storage or demand). The creation of the TimeSeriesData is similar to Step 2, using PiecewiseStepData","category":"page"},{"location":"how_to/market_bid_cost/#Step-3b:-Adding-Service-Bid-TimeSeriesData-to-the-device","page":"...add a market bid","title":"Step 3b: Adding Service Bid TimeSeriesData to the device","text":"","category":"section"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"Similar to adding energy market bids, for adding bids for ancillary services, use set_service_bid!.","category":"page"},{"location":"how_to/market_bid_cost/","page":"...add a market bid","title":"...add a market bid","text":"service = VariableReserve{ReserveUp}(\"example_reserve\", true, 0.6, 2.0)\nadd_service!(sys, service, get_component(ThermalStandard, sys, \"Brighton\"))\n\npsd3 = PiecewiseStepData([0.0, 10.0], [650.3])\npsd4 = PiecewiseStepData([0.0, 10.0], [750.0])\ndata = Dict(Dates.DateTime(\"2020-01-01\") => [psd3, psd4])\ntime_series_data = Deterministic(;\n name = get_name(service),\n data = data,\n resolution = Dates.Hour(1),\n)\nset_service_bid!(sys, generator, service, time_series_data, UnitSystem.NATURAL_UNITS)","category":"page"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#SimplifiedSingleCageInductionMachine","page":"SimplifiedSingleCageInductionMachine","title":"SimplifiedSingleCageInductionMachine","text":"","category":"section"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/","page":"SimplifiedSingleCageInductionMachine","title":"SimplifiedSingleCageInductionMachine","text":"Modules = [PowerSystems]\nPages = [\"generated/SimplifiedSingleCageInductionMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.SimplifiedSingleCageInductionMachine","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.SimplifiedSingleCageInductionMachine","text":"mutable struct SimplifiedSingleCageInductionMachine <: DynamicInjection\n name::String\n R_s::Float64\n R_r::Float64\n X_ls::Float64\n X_lr::Float64\n X_m::Float64\n H::Float64\n A::Float64\n B::Float64\n base_power::Float64\n ext::Dict{String, Any}\n C::Float64\n τ_ref::Float64\n B_shunt::Float64\n X_ss::Float64\n X_rr::Float64\n X_p::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 3-states three-phase single cage induction machine with quadratic torque-speed relationship\n\nArguments\n\nname::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\nR_s::Float64: Armature stator resistance, validation range: (0, nothing)\nR_r::Float64: Rotor resistance, validation range: (0, nothing)\nX_ls::Float64: Stator Leakage Reactance, validation range: (0, nothing)\nX_lr::Float64: Rotor Leakage Reactance, validation range: (0, nothing)\nX_m::Float64: Stator-Rotor Mutual Reactance, validation range: (0, nothing)\nH::Float64: Motor Inertia Constant [s], validation range: (0, nothing)\nA::Float64: Torque-Speed Quadratic Term, validation range: (0, 1)\nB::Float64: Torque-Speed Linear Term, validation range: (0, 1)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\next::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.\nC::Float64: (Do not modify.) Torque-Speed Constant Term\nτ_ref::Float64: Reference torque parameter\nB_shunt::Float64: Susceptance Initialization Corrector Term\nX_ss::Float64: (Do not modify.) Stator self reactance\nX_rr::Float64: (Do not modify.) Rotor self reactance\nX_p::Float64: (Do not modify.) Transient reactance\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψ_qr: rotor flux in the q-axis,\nψ_dr: rotor flux in the d-axis, \nωr: Rotor speed [pu],\n\nn_states::Int: (Do not modify.) SimplifiedSingleCageInductionMachine has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#InfrastructureSystems.get_name-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"InfrastructureSystems.get_name","text":"get_name(\n value::SimplifiedSingleCageInductionMachine\n) -> String\n\n\nGet SimplifiedSingleCageInductionMachine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_A-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_A","text":"get_A(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine A.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_B-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_B","text":"get_B(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine B.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_B_shunt-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_B_shunt","text":"get_B_shunt(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine B_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_C-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_C","text":"get_C(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine C.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_H-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_H","text":"get_H(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_R_r-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_R_r","text":"get_R_r(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine R_r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_R_s-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_R_s","text":"get_R_s(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine R_s.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_lr-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_lr","text":"get_X_lr(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_ls-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_ls","text":"get_X_ls(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_ls.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_m-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_m","text":"get_X_m(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_p-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_p","text":"get_X_p(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_rr-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_rr","text":"get_X_rr(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_rr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_X_ss-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_X_ss","text":"get_X_ss(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine X_ss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_base_power-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_base_power","text":"get_base_power(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_ext-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_ext","text":"get_ext(\n value::SimplifiedSingleCageInductionMachine\n) -> Dict{String, Any}\n\n\nGet SimplifiedSingleCageInductionMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_n_states-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_n_states","text":"get_n_states(\n value::SimplifiedSingleCageInductionMachine\n) -> Int64\n\n\nGet SimplifiedSingleCageInductionMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_states-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_states","text":"get_states(\n value::SimplifiedSingleCageInductionMachine\n) -> Vector{Symbol}\n\n\nGet SimplifiedSingleCageInductionMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.get_τ_ref-Tuple{SimplifiedSingleCageInductionMachine}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.get_τ_ref","text":"get_τ_ref(\n value::SimplifiedSingleCageInductionMachine\n) -> Float64\n\n\nGet SimplifiedSingleCageInductionMachine τ_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_A!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_A!","text":"set_A!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine A.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_B!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_B!","text":"set_B!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine B.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_B_shunt!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_B_shunt!","text":"set_B_shunt!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine B_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_C!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_C!","text":"set_C!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine C.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_H!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_H!","text":"set_H!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_R_r!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_R_r!","text":"set_R_r!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine R_r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_R_s!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_R_s!","text":"set_R_s!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine R_s.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_lr!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_lr!","text":"set_X_lr!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_ls!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_ls!","text":"set_X_ls!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_ls.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_m!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_m!","text":"set_X_m!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_p!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_p!","text":"set_X_p!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_rr!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_rr!","text":"set_X_rr!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_rr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_X_ss!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_X_ss!","text":"set_X_ss!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine X_ss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_base_power!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_base_power!","text":"set_base_power!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_ext!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_ext!","text":"set_ext!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SimplifiedSingleCageInductionMachine/#PowerSystems.set_τ_ref!-Tuple{SimplifiedSingleCageInductionMachine, Any}","page":"SimplifiedSingleCageInductionMachine","title":"PowerSystems.set_τ_ref!","text":"set_τ_ref!(\n value::SimplifiedSingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SimplifiedSingleCageInductionMachine τ_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#ACBus","page":"ACBus","title":"ACBus","text":"","category":"section"},{"location":"model_library/generated_ACBus/","page":"ACBus","title":"ACBus","text":"Modules = [PowerSystems]\nPages = [\"generated/ACBus.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ACBus/#PowerSystems.ACBus","page":"ACBus","title":"PowerSystems.ACBus","text":"mutable struct ACBus <: Bus\n number::Int\n name::String\n bustype::Union{Nothing, ACBusTypes}\n angle::Union{Nothing, Float64}\n magnitude::Union{Nothing, Float64}\n voltage_limits::Union{Nothing, MinMax}\n base_voltage::Union{Nothing, Float64}\n area::Union{Nothing, Area}\n load_zone::Union{Nothing, LoadZone}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn AC bus\n\nArguments\n\nnumber::Int: A unique bus identification number (positive integer)\nname::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\nbustype::Union{Nothing, ACBusTypes}: Used to describe the connectivity and behavior of this bus. Options are listed here.\nangle::Union{Nothing, Float64}: angle of the bus in radians, validation range: (-1.571, 1.571)\nmagnitude::Union{Nothing, Float64}: voltage as a multiple of base_voltage, validation range: voltage_limits\nvoltage_limits::Union{Nothing, MinMax}: limits on the voltage variation as multiples of base_voltage\nbase_voltage::Union{Nothing, Float64}: the base voltage in kV, validation range: (0, nothing)\narea::Union{Nothing, Area}: (default: nothing) the area containing the bus\nload_zone::Union{Nothing, LoadZone}: (default: nothing) the load zone containing the bus\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ACBus/#InfrastructureSystems.get_name-Tuple{ACBus}","page":"ACBus","title":"InfrastructureSystems.get_name","text":"get_name(value::ACBus) -> String\n\n\nGet ACBus name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_angle-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_angle","text":"get_angle(value::ACBus) -> Union{Nothing, Float64}\n\n\nGet ACBus angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_area-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_area","text":"get_area(value::ACBus) -> Union{Nothing, Area}\n\n\nGet ACBus area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_base_voltage-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_base_voltage","text":"get_base_voltage(value::ACBus) -> Union{Nothing, Float64}\n\n\nGet ACBus base_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_bustype-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_bustype","text":"get_bustype(value::ACBus) -> Union{Nothing, ACBusTypes}\n\n\nGet ACBus bustype.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_ext-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_ext","text":"get_ext(value::ACBus) -> Dict{String, Any}\n\n\nGet ACBus ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_load_zone-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_load_zone","text":"get_load_zone(value::ACBus) -> Union{Nothing, LoadZone}\n\n\nGet ACBus load_zone.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_magnitude-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_magnitude","text":"get_magnitude(value::ACBus) -> Union{Nothing, Float64}\n\n\nGet ACBus magnitude.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_number-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_number","text":"get_number(value::ACBus) -> Int64\n\n\nGet ACBus number.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.get_voltage_limits-Tuple{ACBus}","page":"ACBus","title":"PowerSystems.get_voltage_limits","text":"get_voltage_limits(\n value::ACBus\n) -> Union{Nothing, @NamedTuple{min::Float64, max::Float64}}\n\n\nGet ACBus voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_angle!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_angle!","text":"set_angle!(value::ACBus, val) -> Any\n\n\nSet ACBus angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_area!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_area!","text":"set_area!(value::ACBus, val) -> Area\n\n\nSet ACBus area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_base_voltage!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_base_voltage!","text":"set_base_voltage!(value::ACBus, val) -> Any\n\n\nSet ACBus base_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_bustype!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_bustype!","text":"set_bustype!(value::ACBus, val) -> Any\n\n\nSet ACBus bustype.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_ext!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_ext!","text":"set_ext!(value::ACBus, val) -> Any\n\n\nSet ACBus ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_load_zone!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_load_zone!","text":"set_load_zone!(value::ACBus, val) -> LoadZone\n\n\nSet ACBus load_zone.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_magnitude!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_magnitude!","text":"set_magnitude!(value::ACBus, val) -> Any\n\n\nSet ACBus magnitude.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_number!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_number!","text":"set_number!(value::ACBus, val) -> Any\n\n\nSet ACBus number.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ACBus/#PowerSystems.set_voltage_limits!-Tuple{ACBus, Any}","page":"ACBus","title":"PowerSystems.set_voltage_limits!","text":"set_voltage_limits!(value::ACBus, val) -> Any\n\n\nSet ACBus voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#EnergyReservoirStorage","page":"EnergyReservoirStorage","title":"EnergyReservoirStorage","text":"","category":"section"},{"location":"model_library/generated_EnergyReservoirStorage/","page":"EnergyReservoirStorage","title":"EnergyReservoirStorage","text":"Modules = [PowerSystems]\nPages = [\"generated/EnergyReservoirStorage.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.EnergyReservoirStorage","page":"EnergyReservoirStorage","title":"PowerSystems.EnergyReservoirStorage","text":"mutable struct EnergyReservoirStorage <: Storage\n name::String\n available::Bool\n bus::ACBus\n prime_mover_type::PrimeMovers\n storage_technology_type::StorageTech\n storage_capacity::Float64\n storage_level_limits::MinMax\n initial_storage_capacity_level::Float64\n rating::Float64\n active_power::Float64\n input_active_power_limits::MinMax\n output_active_power_limits::MinMax\n efficiency::NamedTuple{(:in, :out), Tuple{Float64, Float64}}\n reactive_power::Float64\n reactive_power_limits::Union{Nothing, MinMax}\n base_power::Float64\n operation_cost::StorageCost\n conversion_factor::Float64\n storage_target::Float64\n cycle_limits::Int\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn energy storage device, modeled as a generic energy reservoir.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nstorage_technology_type::StorageTech: Storage Technology Complementary to EIA 923. Options are listed here\nstorage_capacity::Float64: Maximum storage capacity (can be in units of, e.g., MWh for batteries or liters for hydrogen), validation range: (0, nothing)\nstorage_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)\ninitial_storage_capacity_level::Float64: Initial storage capacity level as a ratio [0, 1.0] of storage_capacity, validation range: (0, 1)\nrating::Float64: Maximum output power rating of the unit (MVA)\nactive_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\ninput_active_power_limits::MinMax: Minimum and maximum limits on the input active power (i.e., charging), validation range: (0, nothing)\noutput_active_power_limits::MinMax: Minimum and maximum limits on the output active power (i.e., discharging), validation range: (0, nothing)\nefficiency::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)\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\noperation_cost::StorageCost: (default: StorageCost(nothing)) OperationalCost of storage\nconversion_factor::Float64: (default: 1.0) Conversion factor of storage_capacity to MWh, if different than 1.0. For example, X MWh/liter hydrogen\nstorage_target::Float64: (default: 0.0) Storage target at the end of simulation as ratio of storage capacity\ncycle_limits::Int: (default: 1e4) Storage Maximum number of cycles per year\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_EnergyReservoirStorage/#InfrastructureSystems.get_name-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"InfrastructureSystems.get_name","text":"get_name(value::EnergyReservoirStorage) -> String\n\n\nGet EnergyReservoirStorage name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_active_power-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_active_power","text":"get_active_power(value::EnergyReservoirStorage) -> Any\n\n\nGet EnergyReservoirStorage active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_available-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_available","text":"get_available(value::EnergyReservoirStorage) -> Bool\n\n\nGet EnergyReservoirStorage available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_base_power-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_base_power","text":"get_base_power(value::EnergyReservoirStorage) -> Float64\n\n\nGet EnergyReservoirStorage base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_bus-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_bus","text":"get_bus(value::EnergyReservoirStorage) -> ACBus\n\n\nGet EnergyReservoirStorage bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_conversion_factor-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_conversion_factor","text":"get_conversion_factor(\n value::EnergyReservoirStorage\n) -> Float64\n\n\nGet EnergyReservoirStorage conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_cycle_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_cycle_limits","text":"get_cycle_limits(value::EnergyReservoirStorage) -> Int64\n\n\nGet EnergyReservoirStorage cycle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_dynamic_injector-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::EnergyReservoirStorage\n) -> Union{Nothing, DynamicInjection}\n\n\nGet EnergyReservoirStorage dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_efficiency-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_efficiency","text":"get_efficiency(\n value::EnergyReservoirStorage\n) -> @NamedTuple{in::Float64, out::Float64}\n\n\nGet EnergyReservoirStorage efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_ext-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_ext","text":"get_ext(value::EnergyReservoirStorage) -> Dict{String, Any}\n\n\nGet EnergyReservoirStorage ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_initial_storage_capacity_level-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_initial_storage_capacity_level","text":"get_initial_storage_capacity_level(\n value::EnergyReservoirStorage\n) -> Float64\n\n\nGet EnergyReservoirStorage initial_storage_capacity_level.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_input_active_power_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_input_active_power_limits","text":"get_input_active_power_limits(\n value::EnergyReservoirStorage\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet EnergyReservoirStorage input_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_operation_cost-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::EnergyReservoirStorage\n) -> StorageCost\n\n\nGet EnergyReservoirStorage operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_output_active_power_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_output_active_power_limits","text":"get_output_active_power_limits(\n value::EnergyReservoirStorage\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet EnergyReservoirStorage output_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_prime_mover_type-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::EnergyReservoirStorage\n) -> PrimeMovers\n\n\nGet EnergyReservoirStorage prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_rating-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_rating","text":"get_rating(value::EnergyReservoirStorage) -> Any\n\n\nGet EnergyReservoirStorage rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_reactive_power-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::EnergyReservoirStorage) -> Any\n\n\nGet EnergyReservoirStorage reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_reactive_power_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::EnergyReservoirStorage\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet EnergyReservoirStorage reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_services-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_services","text":"get_services(\n value::EnergyReservoirStorage\n) -> Vector{Service}\n\n\nGet EnergyReservoirStorage services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_storage_capacity-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_storage_capacity","text":"get_storage_capacity(value::EnergyReservoirStorage) -> Any\n\n\nGet EnergyReservoirStorage storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_storage_level_limits-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_storage_level_limits","text":"get_storage_level_limits(\n value::EnergyReservoirStorage\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EnergyReservoirStorage storage_level_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_storage_target-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_storage_target","text":"get_storage_target(value::EnergyReservoirStorage) -> Float64\n\n\nGet EnergyReservoirStorage storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.get_storage_technology_type-Tuple{EnergyReservoirStorage}","page":"EnergyReservoirStorage","title":"PowerSystems.get_storage_technology_type","text":"get_storage_technology_type(\n value::EnergyReservoirStorage\n) -> StorageTech\n\n\nGet EnergyReservoirStorage storage_technology_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_active_power!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_available!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_available!","text":"set_available!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_base_power!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_bus!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_bus!","text":"set_bus!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_conversion_factor!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_conversion_factor!","text":"set_conversion_factor!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_cycle_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_cycle_limits!","text":"set_cycle_limits!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage cycle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_efficiency!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_efficiency!","text":"set_efficiency!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage efficiency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_ext!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_ext!","text":"set_ext!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_initial_storage_capacity_level!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_initial_storage_capacity_level!","text":"set_initial_storage_capacity_level!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage initial_storage_capacity_level.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_input_active_power_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_input_active_power_limits!","text":"set_input_active_power_limits!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage input_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_operation_cost!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_output_active_power_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_output_active_power_limits!","text":"set_output_active_power_limits!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage output_active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_prime_mover_type!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_rating!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_rating!","text":"set_rating!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_reactive_power!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_reactive_power_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_services!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_services!","text":"set_services!(value::EnergyReservoirStorage, val) -> Any\n\n\nSet EnergyReservoirStorage services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_storage_capacity!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_storage_capacity!","text":"set_storage_capacity!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_storage_level_limits!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_storage_level_limits!","text":"set_storage_level_limits!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage storage_level_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_storage_target!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_storage_target!","text":"set_storage_target!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_EnergyReservoirStorage/#PowerSystems.set_storage_technology_type!-Tuple{EnergyReservoirStorage, Any}","page":"EnergyReservoirStorage","title":"PowerSystems.set_storage_technology_type!","text":"set_storage_technology_type!(\n value::EnergyReservoirStorage,\n val\n) -> Any\n\n\nSet EnergyReservoirStorage storage_technology_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#MonitoredLine","page":"MonitoredLine","title":"MonitoredLine","text":"","category":"section"},{"location":"model_library/generated_MonitoredLine/","page":"MonitoredLine","title":"MonitoredLine","text":"Modules = [PowerSystems]\nPages = [\"generated/MonitoredLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.MonitoredLine","page":"MonitoredLine","title":"PowerSystems.MonitoredLine","text":"mutable struct MonitoredLine <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n b::FromTo\n flow_limits::FromTo_ToFrom\n rating::Float64\n angle_limits::MinMax\n g::FromTo\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn AC transmission line with additional power flow constraints specified by the system operator, more restrictive than the line's thermal limits.\n\nFor 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow on the line (MVAR)\narc::Arc: An Arc defining this line from a bus to another bus\nr::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)\nx::Float64: Reactance in pu (SYSTEM_BASE), validation range: (0, 4)\nb::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)\nflow_limits::FromTo_ToFrom: Minimum and maximum permissable flow on the line (MVA), if different from the thermal rating defined in rating\nrating::Float64: Thermal rating (MVA). Flow through the transformer must be between -rating and rating. When defining a line before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to\nangle_limits::MinMax: Minimum and maximum angle limits (radians), validation range: (-1.571, 1.571)\ng::FromTo: (default: (from=0.0, to=0.0)) Shunt conductance 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)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_MonitoredLine/#InfrastructureSystems.get_name-Tuple{MonitoredLine}","page":"MonitoredLine","title":"InfrastructureSystems.get_name","text":"get_name(value::MonitoredLine) -> String\n\n\nGet MonitoredLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_active_power_flow-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::MonitoredLine) -> Any\n\n\nGet MonitoredLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_angle_limits-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_angle_limits","text":"get_angle_limits(\n value::MonitoredLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet MonitoredLine angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_arc-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_arc","text":"get_arc(value::MonitoredLine) -> Arc\n\n\nGet MonitoredLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_available-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_available","text":"get_available(value::MonitoredLine) -> Bool\n\n\nGet MonitoredLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_b-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_b","text":"get_b(\n value::MonitoredLine\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet MonitoredLine b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_ext-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_ext","text":"get_ext(value::MonitoredLine) -> Dict{String, Any}\n\n\nGet MonitoredLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_flow_limits-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_flow_limits","text":"get_flow_limits(\n value::MonitoredLine\n) -> NamedTuple{(:from_to, :to_from), <:Tuple{Any, Any}}\n\n\nGet MonitoredLine flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_g-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_g","text":"get_g(\n value::MonitoredLine\n) -> @NamedTuple{from::Float64, to::Float64}\n\n\nGet MonitoredLine g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_r-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_r","text":"get_r(value::MonitoredLine) -> Float64\n\n\nGet MonitoredLine r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_rating-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_rating","text":"get_rating(value::MonitoredLine) -> Any\n\n\nGet MonitoredLine rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_reactive_power_flow-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::MonitoredLine) -> Any\n\n\nGet MonitoredLine reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_services-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_services","text":"get_services(value::MonitoredLine) -> Vector{Service}\n\n\nGet MonitoredLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.get_x-Tuple{MonitoredLine}","page":"MonitoredLine","title":"PowerSystems.get_x","text":"get_x(value::MonitoredLine) -> Float64\n\n\nGet MonitoredLine x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_active_power_flow!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_angle_limits!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_angle_limits!","text":"set_angle_limits!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine angle_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_arc!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_available!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_available!","text":"set_available!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_b!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_b!","text":"set_b!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine b.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_ext!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_flow_limits!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_flow_limits!","text":"set_flow_limits!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_g!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_g!","text":"set_g!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_r!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_r!","text":"set_r!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_rating!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_rating!","text":"set_rating!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_reactive_power_flow!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_services!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_services!","text":"set_services!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_MonitoredLine/#PowerSystems.set_x!-Tuple{MonitoredLine, Any}","page":"MonitoredLine","title":"PowerSystems.set_x!","text":"set_x!(value::MonitoredLine, val) -> Any\n\n\nSet MonitoredLine x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_inverter/#DynamicInverter","page":"Dynamic Inverter","title":"DynamicInverter","text":"","category":"section"},{"location":"model_library/dynamic_inverter/","page":"Dynamic Inverter","title":"Dynamic Inverter","text":"Modules = [PowerSystems]\nPages = [\"dynamic_inverter.jl\"]\nOrder = [:type, :function]\nPublic = true","category":"page"},{"location":"model_library/dynamic_inverter/#PowerSystems.DynamicInverter","page":"Dynamic Inverter","title":"PowerSystems.DynamicInverter","text":"mutable struct DynamicInverter{\n C <: Converter,\n O <: OuterControl,\n IC <: InnerControl,\n DC <: DCSource,\n P <: FrequencyEstimator,\n F <: Filter,\n} <: DynamicInjection\n name::String\n ω_ref::Float64\n converter::C\n outer_control::O\n inner_control::IC\n dc_source::DC\n freq_estimator::P\n filter::F\n limiter::Union{nothing, OutputCurrentLimiter}\n base_power::Float64\n n_states::Int\n states::Vector{Symbol}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA dynamic inverter with the necessary data for modeling the dynamic response of an inverter in a phasor or electromagnetic transient simulation.\n\nA dynamic inverter is composed by 6 components, namely a Converter, Outer Loop Control, Inner Loop Control, a DC Source, a Frequency Estimator and a Filter.\n\nIt must be attached to a StaticInjection device using add_component!, which contains all the rest of the generator's data that isn't specific to its dynamic response.\n\nArguments\n\nname::String: Name of inverter.\nω_ref::Float64: Frequency reference set-point in pu.\nconverter <: Converter: Converter model for the PWM transformation.\nouter_control <: OuterControl: An OuterControl controller model.\ninner_control <: InnerControl: An InnerControl controller model.\ndc_source <: DCSource: DCSource model.\nfreq_estimator <: FrequencyEstimator: a FrequencyEstimator (typically a PLL) model.\nfilter <: Filter: Filter model.\nlimiter <: Union{nothing, OutputCurrentLimiter}: (default: nothing) Inner Control Current Limiter model\nbase_power::Float64: (default: 100.0) Base power of the unit (MVA) for per unitization. Although this has a default, in almost all cases base_power should be updated to equal the base_power field of the StaticInjection device that this dynamic generator will be attached to.\nn_states::Int: (Do not modify.) Number of states (will depend on the inputs above).\nstates::Vector{Symbol}: (Do not modify.) Vector of states (will depend on the inputs above).\next::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AGC/#AGC","page":"AGC","title":"AGC","text":"","category":"section"},{"location":"model_library/generated_AGC/","page":"AGC","title":"AGC","text":"Modules = [PowerSystems]\nPages = [\"generated/AGC.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AGC/#PowerSystems.AGC","page":"AGC","title":"PowerSystems.AGC","text":"mutable struct AGC <: Service\n name::String\n available::Bool\n bias::Float64\n K_p::Float64\n K_i::Float64\n K_d::Float64\n delta_t::Float64\n area::Union{Nothing, Area}\n initial_ace::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAutomatic generation control (AGC) for the system or a certain Area within the system.\n\nThis 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.\"\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbias::Float64: Area frequency bias in MW/Hz\nK_p::Float64: PID Proportional Constant\nK_i::Float64: PID Integral Constant\nK_d::Float64: PID Derivative Constant\ndelta_t::Float64: PID Discretization period [Seconds]\narea::Union{Nothing, Area}: (default: nothing) the area controlled by the AGC\ninitial_ace::Float64: (default: 0.0) Initial condition for ACE\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AGC/#InfrastructureSystems.get_name-Tuple{AGC}","page":"AGC","title":"InfrastructureSystems.get_name","text":"get_name(value::AGC) -> String\n\n\nGet AGC name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_K_d-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_K_d","text":"get_K_d(value::AGC) -> Float64\n\n\nGet AGC K_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_K_i-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_K_i","text":"get_K_i(value::AGC) -> Float64\n\n\nGet AGC K_i.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_K_p-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_K_p","text":"get_K_p(value::AGC) -> Float64\n\n\nGet AGC K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_area-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_area","text":"get_area(value::AGC) -> Union{Nothing, Area}\n\n\nGet AGC area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_available-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_available","text":"get_available(value::AGC) -> Bool\n\n\nGet AGC available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_bias-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_bias","text":"get_bias(value::AGC) -> Float64\n\n\nGet AGC bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_delta_t-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_delta_t","text":"get_delta_t(value::AGC) -> Float64\n\n\nGet AGC delta_t.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_ext-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_ext","text":"get_ext(value::AGC) -> Dict{String, Any}\n\n\nGet AGC ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.get_initial_ace-Tuple{AGC}","page":"AGC","title":"PowerSystems.get_initial_ace","text":"get_initial_ace(value::AGC) -> Float64\n\n\nGet AGC initial_ace.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_K_d!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_K_d!","text":"set_K_d!(value::AGC, val) -> Any\n\n\nSet AGC K_d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_K_i!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_K_i!","text":"set_K_i!(value::AGC, val) -> Any\n\n\nSet AGC K_i.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_K_p!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_K_p!","text":"set_K_p!(value::AGC, val) -> Any\n\n\nSet AGC K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_area!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_area!","text":"set_area!(value::AGC, val) -> Any\n\n\nSet AGC area.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_available!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_available!","text":"set_available!(value::AGC, val) -> Any\n\n\nSet AGC available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_bias!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_bias!","text":"set_bias!(value::AGC, val) -> Any\n\n\nSet AGC bias.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_delta_t!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_delta_t!","text":"set_delta_t!(value::AGC, val) -> Any\n\n\nSet AGC delta_t.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_ext!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_ext!","text":"set_ext!(value::AGC, val) -> Any\n\n\nSet AGC ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AGC/#PowerSystems.set_initial_ace!-Tuple{AGC, Any}","page":"AGC","title":"PowerSystems.set_initial_ace!","text":"set_initial_ace!(value::AGC, val) -> Any\n\n\nSet AGC initial_ace.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#Transformer2W","page":"Transformer2W","title":"Transformer2W","text":"","category":"section"},{"location":"model_library/generated_Transformer2W/","page":"Transformer2W","title":"Transformer2W","text":"Modules = [PowerSystems]\nPages = [\"generated/Transformer2W.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Transformer2W/#PowerSystems.Transformer2W","page":"Transformer2W","title":"PowerSystems.Transformer2W","text":"mutable struct Transformer2W <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n reactive_power_flow::Float64\n arc::Arc\n r::Float64\n x::Float64\n primary_shunt::Float64\n rating::Union{Nothing, Float64}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA basic 2-winding transformer.\n\nThe 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow through the transformer (MW)\nreactive_power_flow::Float64: Initial condition of reactive power flow through the transformer (MVAR)\narc::Arc: An Arc defining this transformer from a bus to another bus\nr::Float64: Resistance in pu (SYSTEM_BASE), validation range: (-2, 4)\nx::Float64: Reactance in pu (SYSTEM_BASE), validation range: (-2, 4)\nprimary_shunt::Float64: Shunt reactance in pu (SYSTEM_BASE), validation range: (0, 2)\nrating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating and rating. When defining a transformer before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Transformer2W/#InfrastructureSystems.get_name-Tuple{Transformer2W}","page":"Transformer2W","title":"InfrastructureSystems.get_name","text":"get_name(value::Transformer2W) -> String\n\n\nGet Transformer2W name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_active_power_flow-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::Transformer2W) -> Any\n\n\nGet Transformer2W active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_arc-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_arc","text":"get_arc(value::Transformer2W) -> Arc\n\n\nGet Transformer2W arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_available-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_available","text":"get_available(value::Transformer2W) -> Bool\n\n\nGet Transformer2W available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_ext-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_ext","text":"get_ext(value::Transformer2W) -> Dict{String, Any}\n\n\nGet Transformer2W ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_primary_shunt-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_primary_shunt","text":"get_primary_shunt(value::Transformer2W) -> Float64\n\n\nGet Transformer2W primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_r-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_r","text":"get_r(value::Transformer2W) -> Float64\n\n\nGet Transformer2W r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_rating-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_rating","text":"get_rating(value::Transformer2W) -> Any\n\n\nGet Transformer2W rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_reactive_power_flow-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_reactive_power_flow","text":"get_reactive_power_flow(value::Transformer2W) -> Any\n\n\nGet Transformer2W reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_services-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_services","text":"get_services(value::Transformer2W) -> Vector{Service}\n\n\nGet Transformer2W services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.get_x-Tuple{Transformer2W}","page":"Transformer2W","title":"PowerSystems.get_x","text":"get_x(value::Transformer2W) -> Float64\n\n\nGet Transformer2W x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_active_power_flow!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_arc!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_arc!","text":"set_arc!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_available!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_available!","text":"set_available!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_ext!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_ext!","text":"set_ext!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_primary_shunt!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_primary_shunt!","text":"set_primary_shunt!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W primary_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_r!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_r!","text":"set_r!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_rating!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_rating!","text":"set_rating!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_reactive_power_flow!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_reactive_power_flow!","text":"set_reactive_power_flow!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W reactive_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_services!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_services!","text":"set_services!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Transformer2W/#PowerSystems.set_x!-Tuple{Transformer2W, Any}","page":"Transformer2W","title":"PowerSystems.set_x!","text":"set_x!(value::Transformer2W, val) -> Any\n\n\nSet Transformer2W x.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#HydroEnergyReservoir","page":"HydroEnergyReservoir","title":"HydroEnergyReservoir","text":"","category":"section"},{"location":"model_library/generated_HydroEnergyReservoir/","page":"HydroEnergyReservoir","title":"HydroEnergyReservoir","text":"Modules = [PowerSystems]\nPages = [\"generated/HydroEnergyReservoir.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.HydroEnergyReservoir","page":"HydroEnergyReservoir","title":"PowerSystems.HydroEnergyReservoir","text":"mutable struct HydroEnergyReservoir <: HydroGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n time_limits::Union{Nothing, UpDown}\n base_power::Float64\n storage_capacity::Float64\n inflow::Float64\n initial_storage::Float64\n operation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}\n storage_target::Float64\n conversion_factor::Float64\n status::Bool\n time_at_status::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA hydropower generator with an upper reservoir, offering some energy storage and operational flexibility.\n\nFor hydro generators with pumped storage, see HydroPumpedStorage\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nstorage_capacity::Float64: Maximum storage capacity in the reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)\ninflow::Float64: Baseline inflow into the reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)\ninitial_storage::Float64: Initial storage capacity in the reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)\noperation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation\nstorage_target::Float64: (default: 1.0) Storage target at the end of simulation as a fraction of storage capacity\nconversion_factor::Float64: (default: 1.0) Conversion factor from flow/volume to energy: m^3 -> p.u-hr\nstatus::Bool: (default: false) Initial commitment condition at the start of a simulation (true = on or false = off)\ntime_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_HydroEnergyReservoir/#InfrastructureSystems.get_name-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"InfrastructureSystems.get_name","text":"get_name(value::HydroEnergyReservoir) -> String\n\n\nGet HydroEnergyReservoir name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_active_power-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_active_power","text":"get_active_power(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_active_power_limits-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::HydroEnergyReservoir\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet HydroEnergyReservoir active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_available-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_available","text":"get_available(value::HydroEnergyReservoir) -> Bool\n\n\nGet HydroEnergyReservoir available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_base_power-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_base_power","text":"get_base_power(value::HydroEnergyReservoir) -> Float64\n\n\nGet HydroEnergyReservoir base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_bus-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_bus","text":"get_bus(value::HydroEnergyReservoir) -> ACBus\n\n\nGet HydroEnergyReservoir bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_conversion_factor-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_conversion_factor","text":"get_conversion_factor(\n value::HydroEnergyReservoir\n) -> Float64\n\n\nGet HydroEnergyReservoir conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_dynamic_injector-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::HydroEnergyReservoir\n) -> Union{Nothing, DynamicInjection}\n\n\nGet HydroEnergyReservoir dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_ext-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_ext","text":"get_ext(value::HydroEnergyReservoir) -> Dict{String, Any}\n\n\nGet HydroEnergyReservoir ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_inflow-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_inflow","text":"get_inflow(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir inflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_initial_storage-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_initial_storage","text":"get_initial_storage(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir initial_storage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_operation_cost-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::HydroEnergyReservoir\n) -> Union{HydroGenerationCost, MarketBidCost, StorageCost}\n\n\nGet HydroEnergyReservoir operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_prime_mover_type-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::HydroEnergyReservoir\n) -> PrimeMovers\n\n\nGet HydroEnergyReservoir prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_ramp_limits-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::HydroEnergyReservoir\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet HydroEnergyReservoir ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_rating-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_rating","text":"get_rating(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_reactive_power-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_reactive_power_limits-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::HydroEnergyReservoir\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet HydroEnergyReservoir reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_services-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_services","text":"get_services(value::HydroEnergyReservoir) -> Vector{Service}\n\n\nGet HydroEnergyReservoir services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_status-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_status","text":"get_status(value::HydroEnergyReservoir) -> Bool\n\n\nGet HydroEnergyReservoir status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_storage_capacity-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_storage_capacity","text":"get_storage_capacity(value::HydroEnergyReservoir) -> Any\n\n\nGet HydroEnergyReservoir storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_storage_target-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_storage_target","text":"get_storage_target(value::HydroEnergyReservoir) -> Float64\n\n\nGet HydroEnergyReservoir storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_time_at_status-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_time_at_status","text":"get_time_at_status(value::HydroEnergyReservoir) -> Float64\n\n\nGet HydroEnergyReservoir time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.get_time_limits-Tuple{HydroEnergyReservoir}","page":"HydroEnergyReservoir","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::HydroEnergyReservoir\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet HydroEnergyReservoir time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_active_power!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_active_power_limits!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_available!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_available!","text":"set_available!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_base_power!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_bus!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_bus!","text":"set_bus!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_conversion_factor!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_conversion_factor!","text":"set_conversion_factor!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir conversion_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_ext!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_ext!","text":"set_ext!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_inflow!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_inflow!","text":"set_inflow!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir inflow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_initial_storage!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_initial_storage!","text":"set_initial_storage!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir initial_storage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_operation_cost!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_prime_mover_type!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_ramp_limits!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_rating!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_rating!","text":"set_rating!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_reactive_power!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_reactive_power_limits!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_services!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_services!","text":"set_services!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_status!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_status!","text":"set_status!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_storage_capacity!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_storage_capacity!","text":"set_storage_capacity!(\n value::HydroEnergyReservoir,\n val\n) -> Any\n\n\nSet HydroEnergyReservoir storage_capacity.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_storage_target!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_storage_target!","text":"set_storage_target!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir storage_target.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_time_at_status!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_time_at_status!","text":"set_time_at_status!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_HydroEnergyReservoir/#PowerSystems.set_time_limits!-Tuple{HydroEnergyReservoir, Any}","page":"HydroEnergyReservoir","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::HydroEnergyReservoir, val) -> Any\n\n\nSet HydroEnergyReservoir time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/dynamic_generator/#DynamicGenerator","page":"Dynamic Generator","title":"DynamicGenerator","text":"","category":"section"},{"location":"model_library/dynamic_generator/","page":"Dynamic Generator","title":"Dynamic Generator","text":"Modules = [PowerSystems]\nPages = [\"dynamic_generator.jl\"]\nOrder = [:type, :function]\nPublic = true","category":"page"},{"location":"model_library/dynamic_generator/#PowerSystems.DynamicGenerator","page":"Dynamic Generator","title":"PowerSystems.DynamicGenerator","text":"mutable struct DynamicGenerator{\n M <: Machine,\n S <: Shaft,\n A <: AVR,\n TG <: TurbineGov,\n P <: PSS,\n} <: DynamicInjection\n name::String\n ω_ref::Float64\n machine::M\n shaft::S\n avr::A\n prime_mover::TG\n pss::P\n base_power::Float64\n n_states::Int\n states::Vector{Symbol}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA dynamic generator with the necessary data for modeling the dynamic response of a generator in a phasor or electromagnetic transient simulation.\n\nDynamic generator is composed by 5 components, namely a Machine, a Shaft, an Automatic Voltage Regulator (AVR), a Prime Mover and Turbine Governor, and Power System Stabilizer (PSS). It must be attached to a StaticInjection device using add_component!, which contains all the rest of the generator's data that isn't specific to its dynamic response.\n\nArguments\n\nname::String: Name of generator.\nω_ref::Float64: Frequency reference set-point in pu.\nmachine <: Machine: Machine model for modeling the electro-magnetic phenomena.\nshaft <: Shaft: Shaft model for modeling the electro-mechanical phenomena.\navr <: AVR: AVR model of the excitacion system.\nprime_mover <: TurbineGov: Prime Mover and Turbine Governor model for mechanical power.\npss <: PSS: PSS model.\nbase_power::Float64: (default: 100.0) Base power of the unit (MVA) for per unitization. Although this has a default, in almost all cases base_power should be updated to equal the base_power field of the StaticInjection device that this dynamic generator will be attached to.\nn_states::Int: (Do not modify.) Number of states (will depend on the inputs above).\nstates::Vector{Symbol}: (Do not modify.) Vector of states (will depend on the inputs above).\next::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_RenewableDispatch/#RenewableDispatch","page":"RenewableDispatch","title":"RenewableDispatch","text":"","category":"section"},{"location":"model_library/generated_RenewableDispatch/","page":"RenewableDispatch","title":"RenewableDispatch","text":"Modules = [PowerSystems]\nPages = [\"generated/RenewableDispatch.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.RenewableDispatch","page":"RenewableDispatch","title":"PowerSystems.RenewableDispatch","text":"mutable struct RenewableDispatch <: RenewableGen\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n reactive_power_limits::Union{Nothing, MinMax}\n power_factor::Float64\n operation_cost::Union{RenewableGenerationCost, MarketBidCost}\n base_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA renewable (e.g., wind or solar) generator whose output can be curtailed to satisfy power system constraints.\n\nThese 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.\n\nRenewable generators do not have a max_active_power parameter, which is instead calculated when calling get_max_active_power()\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), used in some production cost modeling simulations. To set the reactive power in a load flow, use power_factor\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits, used in some production cost model simulations and in power flow if the unit is connected to a PV bus. Set to nothing if not applicable\npower_factor::Float64: Power factor [0, 1] set-point, used in some production cost modeling and in load flow if the unit is connected to a PQ bus, validation range: (0, 1)\noperation_cost::Union{RenewableGenerationCost, MarketBidCost}: OperationalCost of generation\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_RenewableDispatch/#InfrastructureSystems.get_name-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"InfrastructureSystems.get_name","text":"get_name(value::RenewableDispatch) -> String\n\n\nGet RenewableDispatch name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_active_power-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_active_power","text":"get_active_power(value::RenewableDispatch) -> Any\n\n\nGet RenewableDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_available-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_available","text":"get_available(value::RenewableDispatch) -> Bool\n\n\nGet RenewableDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_base_power-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_base_power","text":"get_base_power(value::RenewableDispatch) -> Float64\n\n\nGet RenewableDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_bus-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_bus","text":"get_bus(value::RenewableDispatch) -> ACBus\n\n\nGet RenewableDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_dynamic_injector-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::RenewableDispatch\n) -> Union{Nothing, DynamicInjection}\n\n\nGet RenewableDispatch dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_ext-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_ext","text":"get_ext(value::RenewableDispatch) -> Dict{String, Any}\n\n\nGet RenewableDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_operation_cost-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::RenewableDispatch\n) -> Union{MarketBidCost, RenewableGenerationCost}\n\n\nGet RenewableDispatch operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_power_factor-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_power_factor","text":"get_power_factor(value::RenewableDispatch) -> Float64\n\n\nGet RenewableDispatch power_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_prime_mover_type-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::RenewableDispatch\n) -> PrimeMovers\n\n\nGet RenewableDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_rating-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_rating","text":"get_rating(value::RenewableDispatch) -> Any\n\n\nGet RenewableDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_reactive_power-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::RenewableDispatch) -> Any\n\n\nGet RenewableDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_reactive_power_limits-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::RenewableDispatch\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet RenewableDispatch reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.get_services-Tuple{RenewableDispatch}","page":"RenewableDispatch","title":"PowerSystems.get_services","text":"get_services(value::RenewableDispatch) -> Vector{Service}\n\n\nGet RenewableDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_active_power!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_available!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_available!","text":"set_available!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_base_power!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_bus!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_bus!","text":"set_bus!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_ext!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_ext!","text":"set_ext!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_operation_cost!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_power_factor!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_power_factor!","text":"set_power_factor!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch power_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_prime_mover_type!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_rating!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_rating!","text":"set_rating!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_reactive_power!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_reactive_power_limits!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::RenewableDispatch,\n val\n) -> Any\n\n\nSet RenewableDispatch reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_RenewableDispatch/#PowerSystems.set_services!-Tuple{RenewableDispatch, Any}","page":"RenewableDispatch","title":"PowerSystems.set_services!","text":"set_services!(value::RenewableDispatch, val) -> Any\n\n\nSet RenewableDispatch services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#TwoTerminalVSCDCLine","page":"TwoTerminalVSCDCLine","title":"TwoTerminalVSCDCLine","text":"","category":"section"},{"location":"model_library/generated_TwoTerminalVSCDCLine/","page":"TwoTerminalVSCDCLine","title":"TwoTerminalVSCDCLine","text":"Modules = [PowerSystems]\nPages = [\"generated/TwoTerminalVSCDCLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.TwoTerminalVSCDCLine","page":"TwoTerminalVSCDCLine","title":"PowerSystems.TwoTerminalVSCDCLine","text":"mutable struct TwoTerminalVSCDCLine <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n arc::Arc\n rectifier_tap_limits::MinMax\n rectifier_xrc::Float64\n rectifier_firing_angle::MinMax\n inverter_tap_limits::MinMax\n inverter_xrc::Float64\n inverter_extinction_angle::MinMax\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA Voltage Sourced Converter (VSC)-HVDC transmission line.\n\nAs implemented in \"Power System Modelling and Scripting\" by Federico Milano, Chapter 18, Page 397. This model is suitable for dynamic simulations\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\narc::Arc: An Arc defining this line from a bus to another bus\nrectifier_tap_limits::MinMax: Minimum and maximum rectifier tap limits as a ratio between the primary and secondary side voltages\nrectifier_xrc::Float64: Rectifier commutation reactance in p.u. (DEVICE_BASE)\nrectifier_firing_angle::MinMax: Minimum and maximum rectifier firing angle (α) (radians)\ninverter_tap_limits::MinMax: Minimum and maximum inverter tap limits as a ratio between the primary and secondary side voltages\ninverter_xrc::Float64: Inverter commutation reactance in p.u. (DEVICE_BASE)\ninverter_extinction_angle::MinMax: Minimum and maximum inverter extinction angle (γ) (radians)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#InfrastructureSystems.get_name-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"InfrastructureSystems.get_name","text":"get_name(value::TwoTerminalVSCDCLine) -> String\n\n\nGet TwoTerminalVSCDCLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_active_power_flow-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::TwoTerminalVSCDCLine) -> Any\n\n\nGet TwoTerminalVSCDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_arc-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_arc","text":"get_arc(value::TwoTerminalVSCDCLine) -> Arc\n\n\nGet TwoTerminalVSCDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_available-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_available","text":"get_available(value::TwoTerminalVSCDCLine) -> Bool\n\n\nGet TwoTerminalVSCDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_ext-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_ext","text":"get_ext(value::TwoTerminalVSCDCLine) -> Dict{String, Any}\n\n\nGet TwoTerminalVSCDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_inverter_extinction_angle-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_inverter_extinction_angle","text":"get_inverter_extinction_angle(\n value::TwoTerminalVSCDCLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalVSCDCLine inverter_extinction_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_inverter_tap_limits-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_inverter_tap_limits","text":"get_inverter_tap_limits(\n value::TwoTerminalVSCDCLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalVSCDCLine inverter_tap_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_inverter_xrc-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_inverter_xrc","text":"get_inverter_xrc(value::TwoTerminalVSCDCLine) -> Float64\n\n\nGet TwoTerminalVSCDCLine inverter_xrc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_rectifier_firing_angle-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_rectifier_firing_angle","text":"get_rectifier_firing_angle(\n value::TwoTerminalVSCDCLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalVSCDCLine rectifier_firing_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_rectifier_tap_limits-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_rectifier_tap_limits","text":"get_rectifier_tap_limits(\n value::TwoTerminalVSCDCLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalVSCDCLine rectifier_tap_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_rectifier_xrc-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_rectifier_xrc","text":"get_rectifier_xrc(value::TwoTerminalVSCDCLine) -> Float64\n\n\nGet TwoTerminalVSCDCLine rectifier_xrc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.get_services-Tuple{TwoTerminalVSCDCLine}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.get_services","text":"get_services(value::TwoTerminalVSCDCLine) -> Vector{Service}\n\n\nGet TwoTerminalVSCDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_active_power_flow!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_arc!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_available!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_available!","text":"set_available!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_ext!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_inverter_extinction_angle!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_inverter_extinction_angle!","text":"set_inverter_extinction_angle!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine inverter_extinction_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_inverter_tap_limits!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_inverter_tap_limits!","text":"set_inverter_tap_limits!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine inverter_tap_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_inverter_xrc!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_inverter_xrc!","text":"set_inverter_xrc!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine inverter_xrc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_rectifier_firing_angle!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_rectifier_firing_angle!","text":"set_rectifier_firing_angle!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine rectifier_firing_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_rectifier_tap_limits!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_rectifier_tap_limits!","text":"set_rectifier_tap_limits!(\n value::TwoTerminalVSCDCLine,\n val\n) -> Any\n\n\nSet TwoTerminalVSCDCLine rectifier_tap_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_rectifier_xrc!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_rectifier_xrc!","text":"set_rectifier_xrc!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine rectifier_xrc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalVSCDCLine/#PowerSystems.set_services!-Tuple{TwoTerminalVSCDCLine, Any}","page":"TwoTerminalVSCDCLine","title":"PowerSystems.set_services!","text":"set_services!(value::TwoTerminalVSCDCLine, val) -> Any\n\n\nSet TwoTerminalVSCDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#Source","page":"Source","title":"Source","text":"","category":"section"},{"location":"model_library/generated_Source/","page":"Source","title":"Source","text":"Modules = [PowerSystems]\nPages = [\"generated/Source.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Source/#PowerSystems.Source","page":"Source","title":"PowerSystems.Source","text":"mutable struct Source <: StaticInjection\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n R_th::Float64\n X_th::Float64\n internal_voltage::Float64\n internal_angle::Float64\n base_power::Float64\n dynamic_injector::Union{Nothing, DynamicInjection}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nAn infinite bus with a constant voltage output.\n\nCommonly used in dynamics simulations to represent a very large machine on a single bus\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR)\nR_th::Float64: Source Thevenin resistance, validation range: (0, nothing)\nX_th::Float64: Source Thevenin reactance, validation range: (0, nothing)\ninternal_voltage::Float64: (default: 1.0) Internal Voltage (pu), validation range: (0, nothing)\ninternal_angle::Float64: (default: 0.0) Internal Angle\nbase_power::Float64: (default: 100.0) Base Power in MVA\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Source/#InfrastructureSystems.get_name-Tuple{Source}","page":"Source","title":"InfrastructureSystems.get_name","text":"get_name(value::Source) -> String\n\n\nGet Source name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_R_th-Tuple{Source}","page":"Source","title":"PowerSystems.get_R_th","text":"get_R_th(value::Source) -> Float64\n\n\nGet Source R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_X_th-Tuple{Source}","page":"Source","title":"PowerSystems.get_X_th","text":"get_X_th(value::Source) -> Float64\n\n\nGet Source X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_active_power-Tuple{Source}","page":"Source","title":"PowerSystems.get_active_power","text":"get_active_power(value::Source) -> Float64\n\n\nGet Source active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_available-Tuple{Source}","page":"Source","title":"PowerSystems.get_available","text":"get_available(value::Source) -> Bool\n\n\nGet Source available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_base_power-Tuple{Source}","page":"Source","title":"PowerSystems.get_base_power","text":"get_base_power(value::Source) -> Float64\n\n\nGet Source base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_bus-Tuple{Source}","page":"Source","title":"PowerSystems.get_bus","text":"get_bus(value::Source) -> ACBus\n\n\nGet Source bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_dynamic_injector-Tuple{Source}","page":"Source","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::Source\n) -> Union{Nothing, DynamicInjection}\n\n\nGet Source dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_ext-Tuple{Source}","page":"Source","title":"PowerSystems.get_ext","text":"get_ext(value::Source) -> Dict{String, Any}\n\n\nGet Source ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_internal_angle-Tuple{Source}","page":"Source","title":"PowerSystems.get_internal_angle","text":"get_internal_angle(value::Source) -> Float64\n\n\nGet Source internal_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_internal_voltage-Tuple{Source}","page":"Source","title":"PowerSystems.get_internal_voltage","text":"get_internal_voltage(value::Source) -> Float64\n\n\nGet Source internal_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_reactive_power-Tuple{Source}","page":"Source","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::Source) -> Float64\n\n\nGet Source reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.get_services-Tuple{Source}","page":"Source","title":"PowerSystems.get_services","text":"get_services(value::Source) -> Vector{Service}\n\n\nGet Source services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_R_th!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_R_th!","text":"set_R_th!(value::Source, val) -> Any\n\n\nSet Source R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_X_th!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_X_th!","text":"set_X_th!(value::Source, val) -> Any\n\n\nSet Source X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_active_power!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::Source, val) -> Any\n\n\nSet Source active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_available!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_available!","text":"set_available!(value::Source, val) -> Any\n\n\nSet Source available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_base_power!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::Source, val) -> Any\n\n\nSet Source base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_bus!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_bus!","text":"set_bus!(value::Source, val) -> Any\n\n\nSet Source bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_ext!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_ext!","text":"set_ext!(value::Source, val) -> Any\n\n\nSet Source ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_internal_angle!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_internal_angle!","text":"set_internal_angle!(value::Source, val) -> Any\n\n\nSet Source internal_angle.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_internal_voltage!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_internal_voltage!","text":"set_internal_voltage!(value::Source, val) -> Any\n\n\nSet Source internal_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_reactive_power!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::Source, val) -> Any\n\n\nSet Source reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Source/#PowerSystems.set_services!-Tuple{Source, Any}","page":"Source","title":"PowerSystems.set_services!","text":"set_services!(value::Source, val) -> Any\n\n\nSet Source services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#FixedAdmittance","page":"FixedAdmittance","title":"FixedAdmittance","text":"","category":"section"},{"location":"model_library/generated_FixedAdmittance/","page":"FixedAdmittance","title":"FixedAdmittance","text":"Modules = [PowerSystems]\nPages = [\"generated/FixedAdmittance.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.FixedAdmittance","page":"FixedAdmittance","title":"PowerSystems.FixedAdmittance","text":"mutable struct FixedAdmittance <: ElectricLoad\n name::String\n available::Bool\n bus::ACBus\n Y::Complex{Float64}\n dynamic_injector::Union{Nothing, DynamicInjection}\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA fixed admittance.\n\nMost often used in dynamics or AC power flow studies as a source of reactive power\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nY::Complex{Float64}: Fixed admittance in p.u. (SYSTEM_BASE)\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection model for admittance\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_FixedAdmittance/#InfrastructureSystems.get_name-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"InfrastructureSystems.get_name","text":"get_name(value::FixedAdmittance) -> String\n\n\nGet FixedAdmittance name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_Y-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_Y","text":"get_Y(value::FixedAdmittance) -> ComplexF64\n\n\nGet FixedAdmittance Y.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_available-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_available","text":"get_available(value::FixedAdmittance) -> Bool\n\n\nGet FixedAdmittance available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_bus-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_bus","text":"get_bus(value::FixedAdmittance) -> ACBus\n\n\nGet FixedAdmittance bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_dynamic_injector-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::FixedAdmittance\n) -> Union{Nothing, DynamicInjection}\n\n\nGet FixedAdmittance dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_ext-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_ext","text":"get_ext(value::FixedAdmittance) -> Dict{String, Any}\n\n\nGet FixedAdmittance ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.get_services-Tuple{FixedAdmittance}","page":"FixedAdmittance","title":"PowerSystems.get_services","text":"get_services(value::FixedAdmittance) -> Vector{Service}\n\n\nGet FixedAdmittance services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_Y!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_Y!","text":"set_Y!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance Y.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_available!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_available!","text":"set_available!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_bus!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_bus!","text":"set_bus!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_ext!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_ext!","text":"set_ext!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FixedAdmittance/#PowerSystems.set_services!-Tuple{FixedAdmittance, Any}","page":"FixedAdmittance","title":"PowerSystems.set_services!","text":"set_services!(value::FixedAdmittance, val) -> Any\n\n\nSet FixedAdmittance services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#InterconnectingConverter","page":"InterconnectingConverter","title":"InterconnectingConverter","text":"","category":"section"},{"location":"model_library/generated_InterconnectingConverter/","page":"InterconnectingConverter","title":"InterconnectingConverter","text":"Modules = [PowerSystems]\nPages = [\"generated/InterconnectingConverter.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.InterconnectingConverter","page":"InterconnectingConverter","title":"PowerSystems.InterconnectingConverter","text":"mutable struct InterconnectingConverter <: StaticInjection\n name::String\n available::Bool\n bus::ACBus\n dc_bus::DCBus\n active_power::Float64\n rating::Float64\n active_power_limits::MinMax\n base_power::Float64\n dc_current::Float64\n max_dc_current::Float64\n loss_function::Union{LinearCurve, QuadraticCurve}\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nInterconnecting Power Converter (IPC) for transforming power from an ACBus to a DCBus\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus on the AC side of this converter\ndc_bus::DCBus: Bus on the DC side of this converter\nactive_power::Float64: Active power (MW) on the DC side, validation range: active_power_limits\nrating::Float64: Maximum output power rating of the converter (MVA), validation range: (0, nothing)\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW)\nbase_power::Float64: Base power of the converter in MVA, validation range: (0, nothing)\ndc_current::Float64: (default: 0.0) DC current (A) on the converter\nmax_dc_current::Float64: (default: 1e8) Maximum stable dc current limits (A)\nloss_function::Union{LinearCurve, QuadraticCurve}: (default: LinearCurve(0.0)) Linear or quadratic loss function with respect to the converter current\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InterconnectingConverter/#InfrastructureSystems.get_name-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"InfrastructureSystems.get_name","text":"get_name(value::InterconnectingConverter) -> String\n\n\nGet InterconnectingConverter name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_active_power-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_active_power","text":"get_active_power(value::InterconnectingConverter) -> Any\n\n\nGet InterconnectingConverter active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_active_power_limits-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::InterconnectingConverter\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet InterconnectingConverter active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_available-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_available","text":"get_available(value::InterconnectingConverter) -> Bool\n\n\nGet InterconnectingConverter available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_base_power-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_base_power","text":"get_base_power(value::InterconnectingConverter) -> Float64\n\n\nGet InterconnectingConverter base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_bus-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_bus","text":"get_bus(value::InterconnectingConverter) -> ACBus\n\n\nGet InterconnectingConverter bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_dc_bus-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_dc_bus","text":"get_dc_bus(value::InterconnectingConverter) -> DCBus\n\n\nGet InterconnectingConverter dc_bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_dc_current-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_dc_current","text":"get_dc_current(value::InterconnectingConverter) -> Float64\n\n\nGet InterconnectingConverter dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_dynamic_injector-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::InterconnectingConverter\n) -> Union{Nothing, DynamicInjection}\n\n\nGet InterconnectingConverter dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_ext-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_ext","text":"get_ext(\n value::InterconnectingConverter\n) -> Dict{String, Any}\n\n\nGet InterconnectingConverter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_loss_function-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_loss_function","text":"get_loss_function(\n value::InterconnectingConverter\n) -> Union{LinearCurve, QuadraticCurve}\n\n\nGet InterconnectingConverter loss_function.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_max_dc_current-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_max_dc_current","text":"get_max_dc_current(\n value::InterconnectingConverter\n) -> Float64\n\n\nGet InterconnectingConverter max_dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_rating-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_rating","text":"get_rating(value::InterconnectingConverter) -> Any\n\n\nGet InterconnectingConverter rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.get_services-Tuple{InterconnectingConverter}","page":"InterconnectingConverter","title":"PowerSystems.get_services","text":"get_services(\n value::InterconnectingConverter\n) -> Vector{Service}\n\n\nGet InterconnectingConverter services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_active_power!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_active_power!","text":"set_active_power!(\n value::InterconnectingConverter,\n val\n) -> Any\n\n\nSet InterconnectingConverter active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_active_power_limits!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::InterconnectingConverter,\n val\n) -> Any\n\n\nSet InterconnectingConverter active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_available!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_available!","text":"set_available!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_base_power!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_bus!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_bus!","text":"set_bus!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_dc_bus!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_dc_bus!","text":"set_dc_bus!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter dc_bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_dc_current!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_dc_current!","text":"set_dc_current!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_ext!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_ext!","text":"set_ext!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_loss_function!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_loss_function!","text":"set_loss_function!(\n value::InterconnectingConverter,\n val\n) -> Any\n\n\nSet InterconnectingConverter loss_function.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_max_dc_current!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_max_dc_current!","text":"set_max_dc_current!(\n value::InterconnectingConverter,\n val\n) -> Any\n\n\nSet InterconnectingConverter max_dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_rating!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_rating!","text":"set_rating!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InterconnectingConverter/#PowerSystems.set_services!-Tuple{InterconnectingConverter, Any}","page":"InterconnectingConverter","title":"PowerSystems.set_services!","text":"set_services!(value::InterconnectingConverter, val) -> Any\n\n\nSet InterconnectingConverter services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#TModelHVDCLine","page":"TModelHVDCLine","title":"TModelHVDCLine","text":"","category":"section"},{"location":"model_library/generated_TModelHVDCLine/","page":"TModelHVDCLine","title":"TModelHVDCLine","text":"Modules = [PowerSystems]\nPages = [\"generated/TModelHVDCLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.TModelHVDCLine","page":"TModelHVDCLine","title":"PowerSystems.TModelHVDCLine","text":"mutable struct TModelHVDCLine <: DCBranch\n name::String\n available::Bool\n active_power_flow::Float64\n arc::Arc\n r::Float64\n l::Float64\n c::Float64\n active_power_limits_from::MinMax\n active_power_limits_to::MinMax\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA High Voltage DC transmission line for modeling DC transmission networks.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flow on the line (MW)\narc::Arc: An Arc defining this line from a bus to another bus\nr::Float64: Total series Resistance in p.u. (SYSTEM_BASE), split equally on both sides of the shunt capacitance\nl::Float64: Total series Inductance in p.u. (SYSTEM_BASE), split equally on both sides of the shunt capacitance\nc::Float64: Shunt capacitance in p.u. (SYSTEM_BASE)\nactive_power_limits_from::MinMax: Minimum and maximum active power flows to the FROM node (MW)\nactive_power_limits_to::MinMax: Minimum and maximum active power flows to the TO node (MW)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TModelHVDCLine/#InfrastructureSystems.get_name-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"InfrastructureSystems.get_name","text":"get_name(value::TModelHVDCLine) -> String\n\n\nGet TModelHVDCLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_active_power_flow-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(value::TModelHVDCLine) -> Any\n\n\nGet TModelHVDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_active_power_limits_from-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_active_power_limits_from","text":"get_active_power_limits_from(\n value::TModelHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TModelHVDCLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_active_power_limits_to-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_active_power_limits_to","text":"get_active_power_limits_to(\n value::TModelHVDCLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TModelHVDCLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_arc-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_arc","text":"get_arc(value::TModelHVDCLine) -> Arc\n\n\nGet TModelHVDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_available-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_available","text":"get_available(value::TModelHVDCLine) -> Bool\n\n\nGet TModelHVDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_c-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_c","text":"get_c(value::TModelHVDCLine) -> Float64\n\n\nGet TModelHVDCLine c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_ext-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_ext","text":"get_ext(value::TModelHVDCLine) -> Dict{String, Any}\n\n\nGet TModelHVDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_l-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_l","text":"get_l(value::TModelHVDCLine) -> Float64\n\n\nGet TModelHVDCLine l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_r-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_r","text":"get_r(value::TModelHVDCLine) -> Float64\n\n\nGet TModelHVDCLine r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.get_services-Tuple{TModelHVDCLine}","page":"TModelHVDCLine","title":"PowerSystems.get_services","text":"get_services(value::TModelHVDCLine) -> Vector{Service}\n\n\nGet TModelHVDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_active_power_flow!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_active_power_limits_from!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_active_power_limits_from!","text":"set_active_power_limits_from!(\n value::TModelHVDCLine,\n val\n) -> Any\n\n\nSet TModelHVDCLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_active_power_limits_to!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_active_power_limits_to!","text":"set_active_power_limits_to!(\n value::TModelHVDCLine,\n val\n) -> Any\n\n\nSet TModelHVDCLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_arc!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_available!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_available!","text":"set_available!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_c!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_c!","text":"set_c!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_ext!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_l!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_l!","text":"set_l!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_r!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_r!","text":"set_r!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TModelHVDCLine/#PowerSystems.set_services!-Tuple{TModelHVDCLine, Any}","page":"TModelHVDCLine","title":"PowerSystems.set_services!","text":"set_services!(value::TModelHVDCLine, val) -> Any\n\n\nSet TModelHVDCLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#GenericDER","page":"GenericDER","title":"GenericDER","text":"","category":"section"},{"location":"model_library/generated_GenericDER/","page":"GenericDER","title":"GenericDER","text":"Modules = [PowerSystems]\nPages = [\"generated/GenericDER.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_GenericDER/#PowerSystems.GenericDER","page":"GenericDER","title":"PowerSystems.GenericDER","text":"mutable struct GenericDER <: DynamicInjection\n name::String\n Qref_Flag::Int\n PQ_Flag::Int\n Gen_Flag::Int\n PerOp_Flag::Int\n Recon_Flag::Int\n Trv::Float64\n VV_pnts::NamedTuple{(:V1, :V2, :V3, :V4), Tuple{Float64, Float64, Float64, Float64}}\n Q_lim::MinMax\n Tp::Float64\n e_lim::MinMax\n Kpq::Float64\n Kiq::Float64\n Iqr_lim::MinMax\n I_max::Float64\n Tg::Float64\n kWh_Cap::Float64\n SOC_ini::Float64\n SOC_lim::MinMax\n Trf::Float64\n fdbd_pnts::NamedTuple{(:fdbd1, :fdbd2), Tuple{Float64, Float64}}\n D_dn::Float64\n D_up::Float64\n fe_lim::MinMax\n Kpp::Float64\n Kip::Float64\n P_lim::MinMax\n dP_lim::MinMax\n T_pord::Float64\n rrpwr::Float64\n VRT_pnts::NamedTuple{(:vrt1, :vrt2, :vrt3, :vrt4, :vrt5), Tuple{Float64, Float64, Float64, Float64, Float64}}\n TVRT_pnts::NamedTuple{(:tvrt1, :tvrt2, :tvrt3), Tuple{Float64, Float64, Float64}}\n tV_delay::Float64\n VES_lim::MinMax\n FRT_pnts::NamedTuple{(:frt1, :frt2, :frt3, :frt4), Tuple{Float64, Float64, Float64, Float64}}\n TFRT_pnts::NamedTuple{(:tfrt1, :tfrt2), Tuple{Float64, Float64}}\n tF_delay::Float64\n FES_lim::MinMax\n Pfa_ref::Float64\n Q_ref::Float64\n P_ref::Float64\n base_power::Float64\n states::Vector{Symbol}\n n_states::Int\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Generic Distributed Energy Resource Model. Based on \"Modeling Framework and Coordination of DER and Flexible Loads for Ancillary Service Provision.\"\n\nArguments\n\nname::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\nQref_Flag::Int: Reactive Power Control Mode. 1 VoltVar Control, 2 Constant Q Control, 3 Constant PF Control, validation range: (1, 3)\nPQ_Flag::Int: Active and reactive power priority mode. 0 for Q priority, 1 for P priority, validation range: (0, 1)\nGen_Flag::Int: Define generator or storage system. 0 unit is a storage device, 1 unit is a generator, validation range: (0, 1)\nPerOp_Flag::Int: Defines operation of permisible region in VRT characteristic. 0 for cease, 1 for continuous operation, validation range: (0, 1)\nRecon_Flag::Int: Defines if DER can reconnect after voltage ride-through disconnection, validation range: (0, 1)\nTrv::Float64: Voltage measurement transducer's time constant, in s, validation range: (0, nothing)\nVV_pnts::NamedTuple{(:V1, :V2, :V3, :V4), Tuple{Float64, Float64, Float64, Float64}}: Y-axis Volt-var curve points (V1,V2,V3,V4)\nQ_lim::MinMax: Reactive power limits in pu (Qmin, Qmax)\nTp::Float64: Power measurement transducer's time constant, in s, validation range: (0, nothing)\ne_lim::MinMax: Error limit in PI controller for q control (emin, emax)\nKpq::Float64: PI controller proportional gain for q control, validation range: (0, nothing)\nKiq::Float64: PI controller integral gain for q control, validation range: (0, nothing)\nIqr_lim::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)\nI_max::Float64: Max. inverter's current, validation range: (0, nothing)\nTg::Float64: Current control's time constant, in s, validation range: (0, nothing)\nkWh_Cap::Float64: BESS capacity in kWh, validation range: (0, nothing)\nSOC_ini::Float64: Initial state of charge (SOC) in pu, validation range: (0, 1)\nSOC_lim::MinMax: Battery's SOC limits (SOCmin, SOCmax)\nTrf::Float64: Time constant to estimate system frequency, in s, validation range: (0, nothing)\nfdbd_pnts::NamedTuple{(:fdbd1, :fdbd2), Tuple{Float64, Float64}}: Frequency error dead band thresholds (fdbd1, fdbd2)\nD_dn::Float64: reciprocal of droop for over-frequency conditions, in pu, validation range: (0, nothing)\nD_up::Float64: reciprocal of droop for under-frequency conditions, in pu, validation range: (0, nothing)\nfe_lim::MinMax: Frequency error limits in pu (femin, femax)\nKpp::Float64: PI controller proportional gain for p control, validation range: (0, nothing)\nKip::Float64: PI controller integral gain for p control, validation range: (0, nothing)\nP_lim::MinMax: Active power limits in pu (Pmin, Pmax)\ndP_lim::MinMax: Ramp rate limits for active power in pu/s (dPmin, dPmax)\nT_pord::Float64: Power filter time constant in s, validation range: (0, nothing)\nrrpwr::Float64: Ramp rate for real power increase following a fault, in pu/s, validation range: (0, nothing)\nVRT_pnts::NamedTuple{(:vrt1, :vrt2, :vrt3, :vrt4, :vrt5), Tuple{Float64, Float64, Float64, Float64, Float64}}: Voltage ride through v points (vrt1,vrt2,vrt3,vrt4,vrt5)\nTVRT_pnts::NamedTuple{(:tvrt1, :tvrt2, :tvrt3), Tuple{Float64, Float64, Float64}}: Voltage ride through time points (tvrt1,tvrt2,tvrt3)\ntV_delay::Float64: Time delay for reconnection after voltage ride-through disconnection, validation range: (0, nothing)\nVES_lim::MinMax: Min and max voltage for entering service (VESmin,VESmax)\nFRT_pnts::NamedTuple{(:frt1, :frt2, :frt3, :frt4), Tuple{Float64, Float64, Float64, Float64}}: Frequency ride through v points (frt1,frt2,frt3,frt4)\nTFRT_pnts::NamedTuple{(:tfrt1, :tfrt2), Tuple{Float64, Float64}}: Frequency ride through time points (tfrt1,tfrt2)\ntF_delay::Float64: Time delay for reconnection after frequency ride-through disconnection, validation range: (0, nothing)\nFES_lim::MinMax: Min and max frequency for entering service (FESmin,FESmax)\nPfa_ref::Float64: (default: 0.0) Reference power factor, validation range: (0, nothing)\nQ_ref::Float64: (default: 0.0) Reference reactive power, in pu, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference active power, in pu, validation range: (0, nothing)\nbase_power::Float64: (default: 100.0) Base power of the unit (MVA) for per unitization\nstates::Vector{Symbol}: (Do not modify.) The states of GenericDER depend on the Flags\nn_states::Int: (Do not modify.) The states of GenericDER depend on the Flags\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_GenericDER/#InfrastructureSystems.get_name-Tuple{GenericDER}","page":"GenericDER","title":"InfrastructureSystems.get_name","text":"get_name(value::GenericDER) -> String\n\n\nGet GenericDER name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_D_dn-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_D_dn","text":"get_D_dn(value::GenericDER) -> Float64\n\n\nGet GenericDER D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_D_up-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_D_up","text":"get_D_up(value::GenericDER) -> Float64\n\n\nGet GenericDER D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_FES_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_FES_lim","text":"get_FES_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER FES_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_FRT_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_FRT_pnts","text":"get_FRT_pnts(\n value::GenericDER\n) -> @NamedTuple{frt1::Float64, frt2::Float64, frt3::Float64, frt4::Float64}\n\n\nGet GenericDER FRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Gen_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Gen_Flag","text":"get_Gen_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER Gen_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_I_max-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_I_max","text":"get_I_max(value::GenericDER) -> Float64\n\n\nGet GenericDER I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Iqr_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Iqr_lim","text":"get_Iqr_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER Iqr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Kip-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Kip","text":"get_Kip(value::GenericDER) -> Float64\n\n\nGet GenericDER Kip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Kiq-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Kiq","text":"get_Kiq(value::GenericDER) -> Float64\n\n\nGet GenericDER Kiq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Kpp-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Kpp","text":"get_Kpp(value::GenericDER) -> Float64\n\n\nGet GenericDER Kpp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Kpq-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Kpq","text":"get_Kpq(value::GenericDER) -> Float64\n\n\nGet GenericDER Kpq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_PQ_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_PQ_Flag","text":"get_PQ_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_P_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_P_lim","text":"get_P_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_P_ref-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::GenericDER) -> Float64\n\n\nGet GenericDER P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_PerOp_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_PerOp_Flag","text":"get_PerOp_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER PerOp_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Pfa_ref-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Pfa_ref","text":"get_Pfa_ref(value::GenericDER) -> Float64\n\n\nGet GenericDER Pfa_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Q_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Q_lim","text":"get_Q_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER Q_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Q_ref-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::GenericDER) -> Float64\n\n\nGet GenericDER Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Qref_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Qref_Flag","text":"get_Qref_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER Qref_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Recon_Flag-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Recon_Flag","text":"get_Recon_Flag(value::GenericDER) -> Int64\n\n\nGet GenericDER Recon_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_SOC_ini-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_SOC_ini","text":"get_SOC_ini(value::GenericDER) -> Float64\n\n\nGet GenericDER SOC_ini.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_SOC_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_SOC_lim","text":"get_SOC_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER SOC_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_TFRT_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_TFRT_pnts","text":"get_TFRT_pnts(\n value::GenericDER\n) -> @NamedTuple{tfrt1::Float64, tfrt2::Float64}\n\n\nGet GenericDER TFRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_TVRT_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_TVRT_pnts","text":"get_TVRT_pnts(\n value::GenericDER\n) -> @NamedTuple{tvrt1::Float64, tvrt2::Float64, tvrt3::Float64}\n\n\nGet GenericDER TVRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_T_pord-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_T_pord","text":"get_T_pord(value::GenericDER) -> Float64\n\n\nGet GenericDER T_pord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Tg-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Tg","text":"get_Tg(value::GenericDER) -> Float64\n\n\nGet GenericDER Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Tp-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Tp","text":"get_Tp(value::GenericDER) -> Float64\n\n\nGet GenericDER Tp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Trf-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Trf","text":"get_Trf(value::GenericDER) -> Float64\n\n\nGet GenericDER Trf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_Trv-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_Trv","text":"get_Trv(value::GenericDER) -> Float64\n\n\nGet GenericDER Trv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_VES_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_VES_lim","text":"get_VES_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER VES_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_VRT_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_VRT_pnts","text":"get_VRT_pnts(\n value::GenericDER\n) -> @NamedTuple{vrt1::Float64, vrt2::Float64, vrt3::Float64, vrt4::Float64, vrt5::Float64}\n\n\nGet GenericDER VRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_VV_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_VV_pnts","text":"get_VV_pnts(\n value::GenericDER\n) -> @NamedTuple{V1::Float64, V2::Float64, V3::Float64, V4::Float64}\n\n\nGet GenericDER VV_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_base_power-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_base_power","text":"get_base_power(value::GenericDER) -> Float64\n\n\nGet GenericDER base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_dP_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_dP_lim","text":"get_dP_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_e_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_e_lim","text":"get_e_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER e_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_ext-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_ext","text":"get_ext(value::GenericDER) -> Dict{String, Any}\n\n\nGet GenericDER ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_fdbd_pnts-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_fdbd_pnts","text":"get_fdbd_pnts(\n value::GenericDER\n) -> @NamedTuple{fdbd1::Float64, fdbd2::Float64}\n\n\nGet GenericDER fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_fe_lim-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_fe_lim","text":"get_fe_lim(\n value::GenericDER\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet GenericDER fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_kWh_Cap-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_kWh_Cap","text":"get_kWh_Cap(value::GenericDER) -> Float64\n\n\nGet GenericDER kWh_Cap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_n_states-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_n_states","text":"get_n_states(value::GenericDER) -> Int64\n\n\nGet GenericDER n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_rrpwr-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_rrpwr","text":"get_rrpwr(value::GenericDER) -> Float64\n\n\nGet GenericDER rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_states-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_states","text":"get_states(value::GenericDER) -> Vector{Symbol}\n\n\nGet GenericDER states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_tF_delay-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_tF_delay","text":"get_tF_delay(value::GenericDER) -> Float64\n\n\nGet GenericDER tF_delay.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.get_tV_delay-Tuple{GenericDER}","page":"GenericDER","title":"PowerSystems.get_tV_delay","text":"get_tV_delay(value::GenericDER) -> Float64\n\n\nGet GenericDER tV_delay.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_D_dn!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_D_dn!","text":"set_D_dn!(value::GenericDER, val) -> Any\n\n\nSet GenericDER D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_D_up!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_D_up!","text":"set_D_up!(value::GenericDER, val) -> Any\n\n\nSet GenericDER D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_FES_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_FES_lim!","text":"set_FES_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER FES_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_FRT_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_FRT_pnts!","text":"set_FRT_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER FRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Gen_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Gen_Flag!","text":"set_Gen_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Gen_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_I_max!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::GenericDER, val) -> Any\n\n\nSet GenericDER I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Iqr_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Iqr_lim!","text":"set_Iqr_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Iqr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Kip!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Kip!","text":"set_Kip!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Kip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Kiq!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Kiq!","text":"set_Kiq!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Kiq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Kpp!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Kpp!","text":"set_Kpp!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Kpp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Kpq!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Kpq!","text":"set_Kpq!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Kpq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_PQ_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_PQ_Flag!","text":"set_PQ_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_P_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_P_lim!","text":"set_P_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_P_ref!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::GenericDER, val) -> Any\n\n\nSet GenericDER P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_PerOp_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_PerOp_Flag!","text":"set_PerOp_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER PerOp_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Pfa_ref!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Pfa_ref!","text":"set_Pfa_ref!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Pfa_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Q_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Q_lim!","text":"set_Q_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Q_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Q_ref!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Qref_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Qref_Flag!","text":"set_Qref_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Qref_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Recon_Flag!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Recon_Flag!","text":"set_Recon_Flag!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Recon_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_SOC_ini!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_SOC_ini!","text":"set_SOC_ini!(value::GenericDER, val) -> Any\n\n\nSet GenericDER SOC_ini.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_SOC_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_SOC_lim!","text":"set_SOC_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER SOC_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_TFRT_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_TFRT_pnts!","text":"set_TFRT_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER TFRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_TVRT_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_TVRT_pnts!","text":"set_TVRT_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER TVRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_T_pord!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_T_pord!","text":"set_T_pord!(value::GenericDER, val) -> Any\n\n\nSet GenericDER T_pord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Tg!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Tg!","text":"set_Tg!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Tp!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Tp!","text":"set_Tp!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Tp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Trf!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Trf!","text":"set_Trf!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Trf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_Trv!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_Trv!","text":"set_Trv!(value::GenericDER, val) -> Any\n\n\nSet GenericDER Trv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_VES_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_VES_lim!","text":"set_VES_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER VES_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_VRT_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_VRT_pnts!","text":"set_VRT_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER VRT_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_VV_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_VV_pnts!","text":"set_VV_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER VV_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_base_power!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::GenericDER, val) -> Any\n\n\nSet GenericDER base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_dP_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_dP_lim!","text":"set_dP_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_e_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_e_lim!","text":"set_e_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER e_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_ext!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_ext!","text":"set_ext!(value::GenericDER, val) -> Any\n\n\nSet GenericDER ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_fdbd_pnts!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_fdbd_pnts!","text":"set_fdbd_pnts!(value::GenericDER, val) -> Any\n\n\nSet GenericDER fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_fe_lim!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_fe_lim!","text":"set_fe_lim!(value::GenericDER, val) -> Any\n\n\nSet GenericDER fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_kWh_Cap!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_kWh_Cap!","text":"set_kWh_Cap!(value::GenericDER, val) -> Any\n\n\nSet GenericDER kWh_Cap.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_rrpwr!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_rrpwr!","text":"set_rrpwr!(value::GenericDER, val) -> Any\n\n\nSet GenericDER rrpwr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_tF_delay!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_tF_delay!","text":"set_tF_delay!(value::GenericDER, val) -> Any\n\n\nSet GenericDER tF_delay.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_GenericDER/#PowerSystems.set_tV_delay!-Tuple{GenericDER, Any}","page":"GenericDER","title":"PowerSystems.set_tV_delay!","text":"set_tV_delay!(value::GenericDER, val) -> Any\n\n\nSet GenericDER tV_delay.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#AVR","page":"AVR","title":"AVR","text":"","category":"section"},{"location":"model_library/generated_AVR/#AVRFixed","page":"AVR","title":"AVRFixed","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/AVRFixed.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.AVRFixed","page":"AVR","title":"PowerSystems.AVRFixed","text":"mutable struct AVRFixed <: AVR\n Vf::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a AVR that returns a fixed voltage to the rotor winding\n\nArguments\n\nVf::Float64: Fixed voltage field applied to the rotor winding in pu (DEVICE_BASE), validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) Fixed AVR has no states\nn_states::Int: (Do not modify.) Fixed AVR has no states\nstates_types::Vector{StateTypes}: (Do not modify.) Fixed AVR has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AVRFixed) -> Float64\n\n\nGet AVRFixed V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vf-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_Vf","text":"get_Vf(value::AVRFixed) -> Float64\n\n\nGet AVRFixed Vf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::AVRFixed) -> Dict{String, Any}\n\n\nGet AVRFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::AVRFixed) -> Int64\n\n\nGet AVRFixed n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::AVRFixed) -> Vector{Symbol}\n\n\nGet AVRFixed states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{AVRFixed}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::AVRFixed) -> Vector{StateTypes}\n\n\nGet AVRFixed states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{AVRFixed, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::AVRFixed, val) -> Any\n\n\nSet AVRFixed V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vf!-Tuple{AVRFixed, Any}","page":"AVR","title":"PowerSystems.set_Vf!","text":"set_Vf!(value::AVRFixed, val) -> Any\n\n\nSet AVRFixed Vf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{AVRFixed, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::AVRFixed, val) -> Any\n\n\nSet AVRFixed ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{AVRFixed, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::AVRFixed, val) -> Any\n\n\nSet AVRFixed states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#AVRSimple","page":"AVR","title":"AVRSimple","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/AVRSimple.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.AVRSimple","page":"AVR","title":"PowerSystems.AVRSimple","text":"mutable struct AVRSimple <: AVR\n Kv::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a simple proportional AVR in the derivative of EMF i.e. an integrator controller on EMF\n\nArguments\n\nKv::Float64: Proportional Gain, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVf: field voltage\n\nn_states::Int: (Do not modify.) Fixed AVR has 1 state\nstates_types::Vector{StateTypes}: (Do not modify.) Simple AVR has 1 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kv-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_Kv","text":"get_Kv(value::AVRSimple) -> Float64\n\n\nGet AVRSimple Kv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AVRSimple) -> Float64\n\n\nGet AVRSimple V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::AVRSimple) -> Dict{String, Any}\n\n\nGet AVRSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::AVRSimple) -> Int64\n\n\nGet AVRSimple n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::AVRSimple) -> Vector{Symbol}\n\n\nGet AVRSimple states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{AVRSimple}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::AVRSimple) -> Vector{StateTypes}\n\n\nGet AVRSimple states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kv!-Tuple{AVRSimple, Any}","page":"AVR","title":"PowerSystems.set_Kv!","text":"set_Kv!(value::AVRSimple, val) -> Any\n\n\nSet AVRSimple Kv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{AVRSimple, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::AVRSimple, val) -> Any\n\n\nSet AVRSimple V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{AVRSimple, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::AVRSimple, val) -> Any\n\n\nSet AVRSimple ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{AVRSimple, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::AVRSimple, val) -> Any\n\n\nSet AVRSimple states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#AVRTypeI","page":"AVR","title":"AVRTypeI","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/AVRTypeI.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.AVRTypeI","page":"AVR","title":"PowerSystems.AVRTypeI","text":"mutable struct AVRTypeI <: AVR\n Ka::Float64\n Ke::Float64\n Kf::Float64\n Ta::Float64\n Te::Float64\n Tf::Float64\n Tr::Float64\n Va_lim::MinMax\n Ae::Float64\n Be::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of an Automatic Voltage Regulator Type I - Resembles IEEE Type DC1\n\nArguments\n\nKa::Float64: Amplifier Gain, validation range: (0, nothing)\nKe::Float64: Field circuit integral deviation, validation range: (0, nothing)\nKf::Float64: Stabilizer Gain in s * pu/pu, validation range: (0, nothing)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, nothing)\nTe::Float64: Field Circuit Time Constant in s, validation range: (0, nothing)\nTf::Float64: Stabilizer Time Constant in s, validation range: (0, nothing)\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)\nVa_lim::MinMax: Limits for pi controler (Va_min, Va_max)\nAe::Float64: 1st ceiling coefficient, validation range: (0, nothing)\nBe::Float64: 2nd ceiling coefficient, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVf: Voltage field,\nVr1: Amplifier State,\nVr2: Stabilizing Feedback State,\nVm: Measured voltage\n\nn_states::Int: (Do not modify.) The AVR Type I has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) AVR Type I has 4 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ae-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Ae","text":"get_Ae(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Ae.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Be-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Be","text":"get_Be(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Be.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AVRTypeI) -> Float64\n\n\nGet AVRTypeI V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::AVRTypeI\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AVRTypeI Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::AVRTypeI) -> Dict{String, Any}\n\n\nGet AVRTypeI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::AVRTypeI) -> Int64\n\n\nGet AVRTypeI n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::AVRTypeI) -> Vector{Symbol}\n\n\nGet AVRTypeI states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{AVRTypeI}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::AVRTypeI) -> Vector{StateTypes}\n\n\nGet AVRTypeI states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ae!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Ae!","text":"set_Ae!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Ae.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Be!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Be!","text":"set_Be!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Be.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{AVRTypeI, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::AVRTypeI, val) -> Any\n\n\nSet AVRTypeI states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#AVRTypeII","page":"AVR","title":"AVRTypeII","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/AVRTypeII.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.AVRTypeII","page":"AVR","title":"PowerSystems.AVRTypeII","text":"mutable struct AVRTypeII <: AVR\n K0::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n Te::Float64\n Tr::Float64\n Va_lim::MinMax\n Ae::Float64\n Be::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of an Automatic Voltage Regulator Type II - Typical static exciter model\n\nArguments\n\nK0::Float64: Regulator Gain, validation range: (0, nothing)\nT1::Float64: First Pole in s, validation range: (0, nothing)\nT2::Float64: First zero in s, validation range: (0, nothing)\nT3::Float64: First Pole in s, validation range: (0, nothing)\nT4::Float64: First zero in s, validation range: (0, nothing)\nTe::Float64: Field Circuit Time Constant in s, validation range: (0, nothing)\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)\nVa_lim::MinMax: Limits for pi controler (Va_min, Va_max)\nAe::Float64: 1st ceiling coefficient, validation range: (0, nothing)\nBe::Float64: 2nd ceiling coefficient, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVf: Voltage field,\nVr1: First Lead-Lag state,\nVr2: Second lead-lag state,\nVm: Measured voltage\n\nn_states::Int: (Do not modify.) AVR Type II has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) AVR Type II has 4 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ae-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Ae","text":"get_Ae(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII Ae.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Be-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Be","text":"get_Be(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII Be.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K0-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_K0","text":"get_K0(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII K0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T1-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_T1","text":"get_T1(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T2-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_T2","text":"get_T2(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T3-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_T3","text":"get_T3(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T4-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_T4","text":"get_T4(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::AVRTypeII) -> Float64\n\n\nGet AVRTypeII V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::AVRTypeII\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet AVRTypeII Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::AVRTypeII) -> Dict{String, Any}\n\n\nGet AVRTypeII ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::AVRTypeII) -> Int64\n\n\nGet AVRTypeII n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::AVRTypeII) -> Vector{Symbol}\n\n\nGet AVRTypeII states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{AVRTypeII}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::AVRTypeII) -> Vector{StateTypes}\n\n\nGet AVRTypeII states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ae!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Ae!","text":"set_Ae!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Ae.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Be!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Be!","text":"set_Be!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Be.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K0!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_K0!","text":"set_K0!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII K0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T1!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_T1!","text":"set_T1!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T2!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_T2!","text":"set_T2!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T3!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_T3!","text":"set_T3!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T4!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_T4!","text":"set_T4!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{AVRTypeII, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::AVRTypeII, val) -> Any\n\n\nSet AVRTypeII states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESAC1A","page":"AVR","title":"ESAC1A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESAC1A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESAC1A","page":"AVR","title":"PowerSystems.ESAC1A","text":"mutable struct ESAC1A <: AVR\n Tr::Float64\n Tb::Float64\n Tc::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Te::Float64\n Kf::Float64\n Tf::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n Vr_lim::MinMax\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nThis excitation systems consists of an alternator main exciter feeding its output via non-controlled rectifiers. The exciter does not employ self-excitation, and the voltage regulator power is taken from a source that is not affected by external transients. Parameters of IEEE Std 421.5 Type AC1A Excitacion System. This model corresponds to ESAC1A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output time constant in s, validation range: (0, 10)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nTe::Float64: Exciter field time constant in s, validation range: (eps(), 2)\nKf::Float64: Rate feedback excitation system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant, validation range: (eps(), 1.5)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 1)\nKe::Float64: Exciter field proportional constant, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nVr_lim::MinMax: Limits for exciter field voltage: (Vr_min, Vr_max)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_coeffs::Tuple{Float64, Float64}: (default: PowerSystems.get_avr_saturation(E_sat, Se)) (Do not modify.) Coefficients (A,B) of the function: Se(x) = B(x - A)^2/x\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) ESAC1A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESAC1A has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESAC1A) -> Tuple{Float64, Float64}\n\n\nGet ESAC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESAC1A) -> Tuple{Float64, Float64}\n\n\nGet ESAC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESAC1A) -> Float64\n\n\nGet ESAC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESAC1A) -> Float64\n\n\nGet ESAC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ESAC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESAC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESAC1A) -> Dict{String, Any}\n\n\nGet ESAC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESAC1A) -> Int64\n\n\nGet ESAC1A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESAC1A\n) -> Tuple{Float64, Float64}\n\n\nGet ESAC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESAC1A) -> Vector{Symbol}\n\n\nGet ESAC1A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESAC1A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESAC1A) -> Vector{StateTypes}\n\n\nGet ESAC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESAC1A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESAC1A, val) -> Any\n\n\nSet ESAC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESAC6A","page":"AVR","title":"ESAC6A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESAC6A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESAC6A","page":"AVR","title":"PowerSystems.ESAC6A","text":"mutable struct ESAC6A <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Tk::Float64\n Tb::Float64\n Tc::Float64\n Va_lim::MinMax\n Vr_lim::MinMax\n Te::Float64\n VFE_lim::Float64\n Kh::Float64\n VH_max::Float64\n Th::Float64\n Tj::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nModified AC6A. Used to represent field-controlled alternator-rectifier excitation systems with system-supplied electronic voltage regulators. Parameters of IEEE Std 421.5 Type AC6A Excitacion System. ESAC6A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output lag time constant in s, validation range: (0, 10)\nTk::Float64: Voltage Regulator lead time constant, validation range: (0, 10)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nVr_lim::MinMax: Limits for exciter field voltage (Vr_min, Vr_max)\nTe::Float64: Exciter field time constant, validation range: (eps(), 2)\nVFE_lim::Float64: Exciter field current limiter reference, validation range: (-5, 20)\nKh::Float64: Exciter field current regulator feedback gain, validation range: (0, 100)\nVH_max::Float64: Exciter field current limiter maximum output, validation range: (0, 100)\nTh::Float64: Exciter field current limiter denominator (lag) time constant, validation range: (0, 1)\nTj::Float64: Exciter field current limiter numerator (lead) time constant, validation range: (0, 1)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 2)\nKe::Float64: Exciter field proportional constant, validation range: (0, 2)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) ESAC6A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESAC6A has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESAC6A) -> Tuple{Float64, Float64}\n\n\nGet ESAC6A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kh-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Kh","text":"get_Kh(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Kh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESAC6A) -> Tuple{Float64, Float64}\n\n\nGet ESAC6A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Th-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Th","text":"get_Th(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tj-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tj","text":"get_Tj(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tj.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tk-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tk","text":"get_Tk(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tk.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESAC6A) -> Float64\n\n\nGet ESAC6A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VFE_lim-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_VFE_lim","text":"get_VFE_lim(value::ESAC6A) -> Float64\n\n\nGet ESAC6A VFE_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VH_max-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_VH_max","text":"get_VH_max(value::ESAC6A) -> Float64\n\n\nGet ESAC6A VH_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESAC6A) -> Float64\n\n\nGet ESAC6A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ESAC6A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC6A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESAC6A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC6A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESAC6A) -> Dict{String, Any}\n\n\nGet ESAC6A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESAC6A) -> Int64\n\n\nGet ESAC6A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESAC6A\n) -> Tuple{Float64, Float64}\n\n\nGet ESAC6A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESAC6A) -> Vector{Symbol}\n\n\nGet ESAC6A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESAC6A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESAC6A) -> Vector{StateTypes}\n\n\nGet ESAC6A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kh!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Kh!","text":"set_Kh!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Kh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Th!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Th!","text":"set_Th!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tj!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tj!","text":"set_Tj!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tj.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tk!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tk!","text":"set_Tk!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tk.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VFE_lim!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_VFE_lim!","text":"set_VFE_lim!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A VFE_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VH_max!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_VH_max!","text":"set_VH_max!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A VH_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESAC6A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESAC6A, val) -> Any\n\n\nSet ESAC6A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESAC8B","page":"AVR","title":"ESAC8B","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESAC8B.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESAC8B","page":"AVR","title":"PowerSystems.ESAC8B","text":"mutable struct ESAC8B <: AVR\n Tr::Float64\n Kp::Float64\n Ki::Float64\n Kd::Float64\n Td::Float64\n Ka::Float64\n Ta::Float64\n Vr_lim::MinMax\n Te::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nExcitation System AC8B. Used to represent the Basler Digital Excitation Control System (DECS) with PID controller in PSSE.\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, nothing)\nKp::Float64: Regulator proportional PID gain, validation range: (0, nothing)\nKi::Float64: Regulator integral PID gain, validation range: (0, nothing)\nKd::Float64: Regulator derivative PID gain, validation range: (0, nothing)\nTd::Float64: Regulator derivative PID time constant., validation range: (0, 10)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output lag time constant in s, validation range: (0, 10)\nVr_lim::MinMax: Limits for exciter field voltage (Vr_min, Vr_max)\nTe::Float64: Exciter field time constant, validation range: (eps(), 2)\nKe::Float64: Exciter field proportional constant, validation range: (0, 2)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nx_i: Internal PI-block state,\nx_d: Internal Derivative-block state,\nVr: Voltage regulator state,\nEfd: Exciter output state\n\nn_states::Int: (Do not modify.) ESAC8B has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESAC8B has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESAC8B) -> Tuple{Float64, Float64}\n\n\nGet ESAC8B E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ki-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Ki","text":"get_Ki(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kp-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Kp","text":"get_Kp(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESAC8B) -> Tuple{Float64, Float64}\n\n\nGet ESAC8B Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Td-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Td","text":"get_Td(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESAC8B) -> Float64\n\n\nGet ESAC8B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESAC8B) -> Float64\n\n\nGet ESAC8B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESAC8B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESAC8B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESAC8B) -> Dict{String, Any}\n\n\nGet ESAC8B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESAC8B) -> Int64\n\n\nGet ESAC8B n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESAC8B\n) -> Tuple{Float64, Float64}\n\n\nGet ESAC8B saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESAC8B) -> Vector{Symbol}\n\n\nGet ESAC8B states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESAC8B}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESAC8B) -> Vector{StateTypes}\n\n\nGet ESAC8B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ki!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kp!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Td!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Td!","text":"set_Td!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Td.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESAC8B, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESAC8B, val) -> Any\n\n\nSet ESAC8B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESDC1A","page":"AVR","title":"ESDC1A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESDC1A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESDC1A","page":"AVR","title":"PowerSystems.ESDC1A","text":"mutable struct ESDC1A <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Tb::Float64\n Tc::Float64\n Vr_lim::MinMax\n Ke::Float64\n Te::Float64\n Kf::Float64\n Tf::Float64\n switch::Int\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nSelf-excited shunt fields with the voltage regulator operating in a mode commonly termed buck-boost. Parameters of IEEE Std 421.5 Type DC1A Excitacion System. This model corresponds to ESDC1A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, 0.5)\nKa::Float64: Amplifier Gain, validation range: (10, 500)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, 1)\nTb::Float64: Regulator input Time Constant in s, validation range: (0, nothing)\nTc::Float64: Regulator input Time Constant in s, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)\nKe::Float64: Exciter constant related to self-excited field, validation range: (0, nothing)\nTe::Float64: Exciter time constant, integration rate associated with exciter control, validation range: (eps(), 1)\nKf::Float64: Excitation control system stabilizer gain, validation range: (eps(), 0.3)\nTf::Float64: Excitation control system stabilizer time constant, validation range: (eps(), nothing)\nswitch::Int: Switch, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVt: Terminal Voltage,\nVr1: input lead lag,\nVr2: Regulator Output,\nVf: Exciter Output, \nVr3: Rate feedback integrator\n\nn_states::Int: (Do not modify.) The ESDC1A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESDC1A has 5 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESDC1A) -> Tuple{Float64, Float64}\n\n\nGet ESDC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESDC1A) -> Tuple{Float64, Float64}\n\n\nGet ESDC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESDC1A) -> Float64\n\n\nGet ESDC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESDC1A) -> Float64\n\n\nGet ESDC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESDC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESDC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESDC1A) -> Dict{String, Any}\n\n\nGet ESDC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESDC1A) -> Int64\n\n\nGet ESDC1A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESDC1A\n) -> Tuple{Float64, Float64}\n\n\nGet ESDC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESDC1A) -> Vector{Symbol}\n\n\nGet ESDC1A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESDC1A) -> Vector{StateTypes}\n\n\nGet ESDC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_switch-Tuple{ESDC1A}","page":"AVR","title":"PowerSystems.get_switch","text":"get_switch(value::ESDC1A) -> Int64\n\n\nGet ESDC1A switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_switch!-Tuple{ESDC1A, Any}","page":"AVR","title":"PowerSystems.set_switch!","text":"set_switch!(value::ESDC1A, val) -> Any\n\n\nSet ESDC1A switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESDC2A","page":"AVR","title":"ESDC2A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESDC2A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESDC2A","page":"AVR","title":"PowerSystems.ESDC2A","text":"mutable struct ESDC2A <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Tb::Float64\n Tc::Float64\n Vr_lim::MinMax\n Ke::Float64\n Te::Float64\n Kf::Float64\n Tf::Float64\n switch::Int\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIs used to represent field-controlled dc commutator exciters with continuously acting voltage regulators having power supplies derived from the generator or auxiliaries bus. Parameters of IEEE Std 421.5 Type DC2A Excitacion System. This model corresponds to ESDC2A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, 0.5)\nKa::Float64: Amplifier Gain, validation range: (10, 500)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, 1)\nTb::Float64: Regulator input Time Constant in s, validation range: (0, nothing)\nTc::Float64: Regulator input Time Constant in s, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)\nKe::Float64: Exciter constant related to self-excited field, validation range: (-1, 1)\nTe::Float64: Exciter time constant, integration rate associated with exciter control, validation range: (eps(), 2)\nKf::Float64: Excitation control system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Excitation control system stabilizer time constant. Appropiate Data: 5.0 <= Tf/Kf <= 15.0, validation range: (eps(), 1.5)\nswitch::Int: Switch, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVt: Terminal Voltage,\nVr1: input lead lag,\nVr2: Regulator Output,\nVf: Exciter Output, \nVr3: Rate feedback integrator\n\nn_states::Int: (Do not modify.) The ESDC2A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ESDC2A has 5 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::ESDC2A) -> Tuple{Float64, Float64}\n\n\nGet ESDC2A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::ESDC2A) -> Tuple{Float64, Float64}\n\n\nGet ESDC2A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESDC2A) -> Float64\n\n\nGet ESDC2A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESDC2A) -> Float64\n\n\nGet ESDC2A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESDC2A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESDC2A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESDC2A) -> Dict{String, Any}\n\n\nGet ESDC2A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESDC2A) -> Int64\n\n\nGet ESDC2A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::ESDC2A\n) -> Tuple{Float64, Float64}\n\n\nGet ESDC2A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESDC2A) -> Vector{Symbol}\n\n\nGet ESDC2A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESDC2A) -> Vector{StateTypes}\n\n\nGet ESDC2A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_switch-Tuple{ESDC2A}","page":"AVR","title":"PowerSystems.get_switch","text":"get_switch(value::ESDC2A) -> Int64\n\n\nGet ESDC2A switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_switch!-Tuple{ESDC2A, Any}","page":"AVR","title":"PowerSystems.set_switch!","text":"set_switch!(value::ESDC2A, val) -> Any\n\n\nSet ESDC2A switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESST1A","page":"AVR","title":"ESST1A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESST1A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESST1A","page":"AVR","title":"PowerSystems.ESST1A","text":"mutable struct ESST1A <: AVR\n UEL_flags::Int\n PSS_flags::Int\n Tr::Float64\n Vi_lim::Tuple{Float64, Float64}\n Tc::Float64\n Tb::Float64\n Tc1::Float64\n Tb1::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Vr_lim::MinMax\n Kc::Float64\n Kf::Float64\n Tf::Float64\n K_lr::Float64\n I_lr::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nThis excitation system supplies power through a transformer from the generator terminals and its regulated by a controlled rectifier (via thyristors). Parameters of IEEE Std 421.5 Type ST1A Excitacion System. ESST1A in PSSE and PSLF\n\nArguments\n\nUEL_flags::Int: Code input for Underexcitization limiter (UEL) entry. Not supported, validation range: (1, 3)\nPSS_flags::Int: Code input for Power System Stabilizer (PSS) or (VOS) entry, validation range: (1, 2)\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.1)\nVi_lim::Tuple{Float64, Float64}: Voltage error limits (regulator input) (Vimin, Vimax)\nTc::Float64: First regulator denominator (lead) time constant in s, validation range: (0, 10)\nTb::Float64: First regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc1::Float64: Second regulator denominator (lead) time constant in s, validation range: (0, 10)\nTb1::Float64: Second regulator denominator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Voltage regulator gain, validation range: (50, 1000)\nTa::Float64: Voltage regulator time constant in s, validation range: (0, 0.5)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nVr_lim::MinMax: Limits for exciter output (Vr_min, Vr_max)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 0.3)\nKf::Float64: Rate feedback gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant in s, validation range: (eps(), 1.5)\nK_lr::Float64: Exciter output current limiter gain, validation range: (0, 5)\nI_lr::Float64: Exciter output current limit reference, validation range: (0, 5)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: First Lead-lag state,\nVr2: Second lead-lag state,\nVa: Regulator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) ST1A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ST1A has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_I_lr-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_I_lr","text":"get_I_lr(value::ESST1A) -> Float64\n\n\nGet ESST1A I_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_lr-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_K_lr","text":"get_K_lr(value::ESST1A) -> Float64\n\n\nGet ESST1A K_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::ESST1A) -> Float64\n\n\nGet ESST1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::ESST1A) -> Float64\n\n\nGet ESST1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::ESST1A) -> Float64\n\n\nGet ESST1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_PSS_flags-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_PSS_flags","text":"get_PSS_flags(value::ESST1A) -> Int64\n\n\nGet ESST1A PSS_flags.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESST1A) -> Float64\n\n\nGet ESST1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::ESST1A) -> Float64\n\n\nGet ESST1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb1-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tb1","text":"get_Tb1(value::ESST1A) -> Float64\n\n\nGet ESST1A Tb1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::ESST1A) -> Float64\n\n\nGet ESST1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc1-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tc1","text":"get_Tc1(value::ESST1A) -> Float64\n\n\nGet ESST1A Tc1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::ESST1A) -> Float64\n\n\nGet ESST1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESST1A) -> Float64\n\n\nGet ESST1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_UEL_flags-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_UEL_flags","text":"get_UEL_flags(value::ESST1A) -> Int64\n\n\nGet ESST1A UEL_flags.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESST1A) -> Float64\n\n\nGet ESST1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ESST1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESST1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vi_lim-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Vi_lim","text":"get_Vi_lim(value::ESST1A) -> Tuple{Float64, Float64}\n\n\nGet ESST1A Vi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESST1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESST1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESST1A) -> Dict{String, Any}\n\n\nGet ESST1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESST1A) -> Int64\n\n\nGet ESST1A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESST1A) -> Vector{Symbol}\n\n\nGet ESST1A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESST1A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESST1A) -> Vector{StateTypes}\n\n\nGet ESST1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_I_lr!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_I_lr!","text":"set_I_lr!(value::ESST1A, val) -> Any\n\n\nSet ESST1A I_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_lr!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_K_lr!","text":"set_K_lr!(value::ESST1A, val) -> Any\n\n\nSet ESST1A K_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_PSS_flags!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_PSS_flags!","text":"set_PSS_flags!(value::ESST1A, val) -> Any\n\n\nSet ESST1A PSS_flags.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb1!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tb1!","text":"set_Tb1!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tb1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc1!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tc1!","text":"set_Tc1!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tc1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_UEL_flags!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_UEL_flags!","text":"set_UEL_flags!(value::ESST1A, val) -> Any\n\n\nSet ESST1A UEL_flags.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESST1A, val) -> Any\n\n\nSet ESST1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vi_lim!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Vi_lim!","text":"set_Vi_lim!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Vi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESST1A, val) -> Any\n\n\nSet ESST1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESST1A, val) -> Any\n\n\nSet ESST1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESST1A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESST1A, val) -> Any\n\n\nSet ESST1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ESST4B","page":"AVR","title":"ESST4B","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ESST4B.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ESST4B","page":"AVR","title":"PowerSystems.ESST4B","text":"mutable struct ESST4B <: AVR\n Tr::Float64\n K_pr::Float64\n K_ir::Float64\n Vr_lim::MinMax\n Ta::Float64\n K_pm::Float64\n K_im::Float64\n Vm_lim::MinMax\n Kg::Float64\n Kp::Float64\n Ki::Float64\n VB_max::Float64\n Kc::Float64\n Xl::Float64\n θp::Float64\n V_ref::Float64\n θp_rad::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIn these excitation systems, voltage (and also current in compounded systems) is transformed to an appropriate level. Rectifiers, either controlled or non-controlled, provide the necessary direct current for the generator field. Parameters of IEEE Std 421.5 Type ST4B Excitacion System. ESST4B in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nK_pr::Float64: Regulator propotional gain, validation range: (0, 75)\nK_ir::Float64: Regulator integral gain, validation range: (0, 75)\nVr_lim::MinMax: Voltage regulator limits (Vimin, Vimax)\nTa::Float64: Voltage regulator time constant in s, validation range: (0, 1)\nK_pm::Float64: Voltage regulator proportional gain output, validation range: (0, 1.2)\nK_im::Float64: Voltage regulator integral gain output, validation range: (0, 18)\nVm_lim::MinMax: Limits for inner loop output (Vm_min, Vm_max)\nKg::Float64: Feedback gain constant of the inner loop field regulator, validation range: (0, 1.1)\nKp::Float64: Potential circuit (voltage) gain coefficient, validation range: (0, 10)\nKi::Float64: Compound circuit (current) gain coefficient, validation range: (0, 1.1)\nVB_max::Float64: Maximum available exciter voltage, validation range: (1, 20)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nXl::Float64: Reactance associated with potential source, validation range: (0, 0.5)\nθp::Float64: Potential circuit phase angle (degrees), validation range: (-90, 90)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nθp_rad::Float64: (default: θp*π*inv(180)) (Do not modify.) Potential circuit phase angle (radians)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVt: Sensed Terminal Voltage,\nVr1: Regulator Integrator,\nVr2: Regulator Output,\nVm: Output integrator\n\nn_states::Int: (Do not modify.) ST4B has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) ST4B has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_im-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_K_im","text":"get_K_im(value::ESST4B) -> Float64\n\n\nGet ESST4B K_im.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ir-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_K_ir","text":"get_K_ir(value::ESST4B) -> Float64\n\n\nGet ESST4B K_ir.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pm-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_K_pm","text":"get_K_pm(value::ESST4B) -> Float64\n\n\nGet ESST4B K_pm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pr-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_K_pr","text":"get_K_pr(value::ESST4B) -> Float64\n\n\nGet ESST4B K_pr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::ESST4B) -> Float64\n\n\nGet ESST4B Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kg-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Kg","text":"get_Kg(value::ESST4B) -> Float64\n\n\nGet ESST4B Kg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ki-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Ki","text":"get_Ki(value::ESST4B) -> Float64\n\n\nGet ESST4B Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kp-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Kp","text":"get_Kp(value::ESST4B) -> Float64\n\n\nGet ESST4B Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::ESST4B) -> Float64\n\n\nGet ESST4B Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ESST4B) -> Float64\n\n\nGet ESST4B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VB_max-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_VB_max","text":"get_VB_max(value::ESST4B) -> Float64\n\n\nGet ESST4B VB_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ESST4B) -> Float64\n\n\nGet ESST4B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vm_lim-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Vm_lim","text":"get_Vm_lim(\n value::ESST4B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESST4B Vm_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ESST4B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ESST4B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Xl-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_Xl","text":"get_Xl(value::ESST4B) -> Float64\n\n\nGet ESST4B Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ESST4B) -> Dict{String, Any}\n\n\nGet ESST4B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ESST4B) -> Int64\n\n\nGet ESST4B n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ESST4B) -> Vector{Symbol}\n\n\nGet ESST4B states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ESST4B) -> Vector{StateTypes}\n\n\nGet ESST4B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_θp-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_θp","text":"get_θp(value::ESST4B) -> Float64\n\n\nGet ESST4B θp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_θp_rad-Tuple{ESST4B}","page":"AVR","title":"PowerSystems.get_θp_rad","text":"get_θp_rad(value::ESST4B) -> Float64\n\n\nGet ESST4B θp_rad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_im!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_K_im!","text":"set_K_im!(value::ESST4B, val) -> Any\n\n\nSet ESST4B K_im.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ir!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_K_ir!","text":"set_K_ir!(value::ESST4B, val) -> Any\n\n\nSet ESST4B K_ir.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pm!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_K_pm!","text":"set_K_pm!(value::ESST4B, val) -> Any\n\n\nSet ESST4B K_pm.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pr!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_K_pr!","text":"set_K_pr!(value::ESST4B, val) -> Any\n\n\nSet ESST4B K_pr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kg!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Kg!","text":"set_Kg!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Kg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ki!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kp!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VB_max!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_VB_max!","text":"set_VB_max!(value::ESST4B, val) -> Any\n\n\nSet ESST4B VB_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ESST4B, val) -> Any\n\n\nSet ESST4B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vm_lim!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Vm_lim!","text":"set_Vm_lim!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Vm_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Xl!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_Xl!","text":"set_Xl!(value::ESST4B, val) -> Any\n\n\nSet ESST4B Xl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ESST4B, val) -> Any\n\n\nSet ESST4B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ESST4B, val) -> Any\n\n\nSet ESST4B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_θp!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_θp!","text":"set_θp!(value::ESST4B, val) -> Any\n\n\nSet ESST4B θp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_θp_rad!-Tuple{ESST4B, Any}","page":"AVR","title":"PowerSystems.set_θp_rad!","text":"set_θp_rad!(value::ESST4B, val) -> Any\n\n\nSet ESST4B θp_rad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXAC1","page":"AVR","title":"EXAC1","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXAC1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.EXAC1","page":"AVR","title":"PowerSystems.EXAC1","text":"mutable struct EXAC1 <: AVR\n Tr::Float64\n Tb::Float64\n Tc::Float64\n Ka::Float64\n Ta::Float64\n Vr_lim::MinMax\n Te::Float64\n Kf::Float64\n Tf::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nModified ESAC1A. This excitation systems consists of an alternator main exciter feeding its output via non-controlled rectifiers. The exciter does not employ self-excitation, and the voltage regulator power is taken from a source that is not affected by external transients. Parameters of IEEE Std 421.5 Type AC1A. EXAC1 in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output time constant in s, validation range: (0, 10)\nVr_lim::MinMax: Limits for regulator output (Vr_min, Vr_max)\nTe::Float64: Exciter field time constant in s, validation range: (eps(), 2)\nKf::Float64: Rate feedback excitation system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant, validation range: (eps(), 1.5)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 1)\nKe::Float64: Exciter field proportional constant, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) EXAC1 has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) EXAC1 has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::EXAC1) -> Tuple{Float64, Float64}\n\n\nGet EXAC1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::EXAC1) -> Float64\n\n\nGet EXAC1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::EXAC1) -> Float64\n\n\nGet EXAC1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::EXAC1) -> Float64\n\n\nGet EXAC1 Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::EXAC1) -> Float64\n\n\nGet EXAC1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::EXAC1) -> Float64\n\n\nGet EXAC1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::EXAC1) -> Tuple{Float64, Float64}\n\n\nGet EXAC1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::EXAC1) -> Float64\n\n\nGet EXAC1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::EXAC1) -> Float64\n\n\nGet EXAC1 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::EXAC1) -> Float64\n\n\nGet EXAC1 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::EXAC1) -> Float64\n\n\nGet EXAC1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::EXAC1) -> Float64\n\n\nGet EXAC1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::EXAC1) -> Float64\n\n\nGet EXAC1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::EXAC1) -> Float64\n\n\nGet EXAC1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::EXAC1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::EXAC1) -> Dict{String, Any}\n\n\nGet EXAC1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::EXAC1) -> Int64\n\n\nGet EXAC1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::EXAC1\n) -> Tuple{Float64, Float64}\n\n\nGet EXAC1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::EXAC1) -> Vector{Symbol}\n\n\nGet EXAC1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{EXAC1}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::EXAC1) -> Vector{StateTypes}\n\n\nGet EXAC1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{EXAC1, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::EXAC1, val) -> Any\n\n\nSet EXAC1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXAC1A","page":"AVR","title":"EXAC1A","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXAC1A.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.EXAC1A","page":"AVR","title":"PowerSystems.EXAC1A","text":"mutable struct EXAC1A <: AVR\n Tr::Float64\n Tb::Float64\n Tc::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Te::Float64\n Kf::Float64\n Tf::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n Vr_lim::MinMax\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nModified ESAC1A. This excitation systems consists of an alternator main exciter feeding its output via non-controlled rectifiers. The exciter does not employ self-excitation, and the voltage regulator power is taken from a source that is not affected by external transients. Parameters of IEEE Std 421.5 Type AC1A Excitacion System. EXAC1A in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output time constant in s, validation range: (0, 10)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nTe::Float64: Exciter field time constant in s, validation range: (eps(), 2)\nKf::Float64: Rate feedback excitation system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant, validation range: (eps(), 1.5)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 1)\nKe::Float64: Exciter field proportional constant, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nVr_lim::MinMax: Limits for exciter field voltage: (Vr_min, Vr_max)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_coeffs::Tuple{Float64, Float64}: (default: PowerSystems.get_avr_saturation(E_sat, Se)) (Do not modify.) Coefficients (A,B) of the function: Se(x) = B(x - A)^2/x\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) EXAC1A has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) EXAC1A has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::EXAC1A) -> Tuple{Float64, Float64}\n\n\nGet EXAC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::EXAC1A) -> Tuple{Float64, Float64}\n\n\nGet EXAC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::EXAC1A) -> Float64\n\n\nGet EXAC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::EXAC1A) -> Float64\n\n\nGet EXAC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::EXAC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::EXAC1A\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::EXAC1A) -> Dict{String, Any}\n\n\nGet EXAC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::EXAC1A) -> Int64\n\n\nGet EXAC1A n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::EXAC1A\n) -> Tuple{Float64, Float64}\n\n\nGet EXAC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::EXAC1A) -> Vector{Symbol}\n\n\nGet EXAC1A states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{EXAC1A}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::EXAC1A) -> Vector{StateTypes}\n\n\nGet EXAC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{EXAC1A, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::EXAC1A, val) -> Any\n\n\nSet EXAC1A states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXAC2","page":"AVR","title":"EXAC2","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXAC2.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.EXAC2","page":"AVR","title":"PowerSystems.EXAC2","text":"mutable struct EXAC2 <: AVR\n Tr::Float64\n Tb::Float64\n Tc::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Kb::Float64\n Vr_lim::MinMax\n Te::Float64\n Kl::Float64\n Kh::Float64\n Kf::Float64\n Tf::Float64\n Kc::Float64\n Kd::Float64\n Ke::Float64\n V_lr::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nModified AC2. This excitation systems consists of an alternator main exciter feeding its output via non-controlled rectifiers. The exciter does not employ self-excitation, and the voltage regulator power is taken from a source that is not affected by external transients. Parameters of IEEE Std 421.5 Type AC2A Excitacion System. The alternator main exciter is used, feeding its output via non-controlled rectifiers. The Type AC2C model is similar to that of Type AC1C except for the inclusion of exciter time constant compensation and exciter field current limiting elements. EXAC2 in PSSE and PSLF\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nTb::Float64: Regulator denominator (lag) time constant in s, validation range: (0, 20)\nTc::Float64: Regulator numerator (lead) time constant in s, validation range: (0, 20)\nKa::Float64: Regulator output gain, validation range: (0, 1000)\nTa::Float64: Regulator output time constant in s, validation range: (0, 10)\nVa_lim::MinMax: Limits for regulator output (Va_min, Va_max)\nKb::Float64: Second Stage regulator gain, validation range: (eps(), 500)\nVr_lim::MinMax: Limits for exciter field voltage (Vr_min, Vr_max)\nTe::Float64: Exciter field time constant, validation range: (eps(), 2)\nKl::Float64: Exciter field current limiter gain, validation range: (0, 1.1)\nKh::Float64: Exciter field current regulator feedback gain, validation range: (0, 1.1)\nKf::Float64: Rate feedback excitation system stabilizer gain, validation range: (0, 0.3)\nTf::Float64: Rate feedback time constant, validation range: (eps(), nothing)\nKc::Float64: Rectifier loading factor proportional to commutating reactance, validation range: (0, 1)\nKd::Float64: Demagnetizing factor, function of exciter alternator reactances, validation range: (0, 1)\nKe::Float64: Exciter field proportional constant, validation range: (0, 1)\nV_lr::Float64: Maximum exciter field current, validation range: (0, nothing)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: Lead-lag state,\nVr2: Regulator output state,\nVe: Integrator output state,\nVr3: Feedback output state\n\nn_states::Int: (Do not modify.) EXAC2 has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) EXAC2 has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::EXAC2) -> Tuple{Float64, Float64}\n\n\nGet EXAC2 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::EXAC2) -> Float64\n\n\nGet EXAC2 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kb-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kb","text":"get_Kb(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kd-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kd","text":"get_Kd(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::EXAC2) -> Float64\n\n\nGet EXAC2 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kh-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kh","text":"get_Kh(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kl-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Kl","text":"get_Kl(value::EXAC2) -> Float64\n\n\nGet EXAC2 Kl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::EXAC2) -> Tuple{Float64, Float64}\n\n\nGet EXAC2 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::EXAC2) -> Float64\n\n\nGet EXAC2 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::EXAC2) -> Float64\n\n\nGet EXAC2 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::EXAC2) -> Float64\n\n\nGet EXAC2 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::EXAC2) -> Float64\n\n\nGet EXAC2 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::EXAC2) -> Float64\n\n\nGet EXAC2 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::EXAC2) -> Float64\n\n\nGet EXAC2 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_lr-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_V_lr","text":"get_V_lr(value::EXAC2) -> Float64\n\n\nGet EXAC2 V_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::EXAC2) -> Float64\n\n\nGet EXAC2 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::EXAC2\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC2 Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::EXAC2\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXAC2 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::EXAC2) -> Dict{String, Any}\n\n\nGet EXAC2 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::EXAC2) -> Int64\n\n\nGet EXAC2 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::EXAC2\n) -> Tuple{Float64, Float64}\n\n\nGet EXAC2 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::EXAC2) -> Vector{Symbol}\n\n\nGet EXAC2 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{EXAC2}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::EXAC2) -> Vector{StateTypes}\n\n\nGet EXAC2 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kb!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kb!","text":"set_Kb!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kd!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kd!","text":"set_Kd!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kh!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kh!","text":"set_Kh!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kh.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kl!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Kl!","text":"set_Kl!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Kl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_lr!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_V_lr!","text":"set_V_lr!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 V_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{EXAC2, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::EXAC2, val) -> Any\n\n\nSet EXAC2 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXPIC1","page":"AVR","title":"EXPIC1","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXPIC1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.EXPIC1","page":"AVR","title":"PowerSystems.EXPIC1","text":"mutable struct EXPIC1 <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Va_lim::MinMax\n Ta_2::Float64\n Ta_3::Float64\n Ta_4::Float64\n Vr_lim::MinMax\n Kf::Float64\n Tf_1::Float64\n Tf_2::Float64\n Efd_lim::MinMax\n Ke::Float64\n Te::Float64\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n Kp::Float64\n Ki::Float64\n Kc::Float64\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nGeneric Proportional/Integral Excitation System\n\nArguments\n\nTr::Float64: Regulator input filter time constant in s, validation range: (0, 0.5)\nKa::Float64: Voltage regulator gain, validation range: (1, 500)\nTa::Float64: Voltage regulator time constant in s, validation range: (0, 10)\nVa_lim::MinMax: Limits for pi controler (Vr_min, Vr_max)\nTa_2::Float64: Voltage regulator time constant in s, validation range: (0, nothing)\nTa_3::Float64: Voltage regulator time constant in s, validation range: (0, nothing)\nTa_4::Float64: Voltage regulator time constant in s, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)\nKf::Float64: Rate feedback gain, validation range: (0, 0.3)\nTf_1::Float64: Rate Feedback time constant in s, validation range: (eps(), 15)\nTf_2::Float64: Rate Feedback time constant in s, validation range: (0, 5)\nEfd_lim::MinMax: Field Voltage regulator limits (regulator output) (Efdmin, Efdmax)\nKe::Float64: Exciter constant, validation range: (0, 1)\nTe::Float64: Exciter time constant, validation range: (0, 2)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nKp::Float64: Potential source gain, validation range: (0, 5)\nKi::Float64: current source gain, validation range: (0, 1.1)\nKc::Float64: Exciter regulation factor, validation range: (0, 2)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nVr1: First Lead-lag state,\nVr2: Second regulator lead-lag state,\nVr2: Third regulator lead-lag state \nVf: Exciter output \nVr3: First feedback integrator,\nVr4: second feedback integrator\n\nn_states::Int: (Do not modify.) EXPIC1 has 6 states\nstates_types::Vector{StateTypes}: (Do not modify.) EXPIC has 6 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::EXPIC1) -> Tuple{Float64, Float64}\n\n\nGet EXPIC1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Efd_lim-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Efd_lim","text":"get_Efd_lim(\n value::EXPIC1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXPIC1 Efd_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ki-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ki","text":"get_Ki(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kp-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Kp","text":"get_Kp(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::EXPIC1) -> Tuple{Float64, Float64}\n\n\nGet EXPIC1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_2-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ta_2","text":"get_Ta_2(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ta_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_3-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ta_3","text":"get_Ta_3(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ta_3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_4-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Ta_4","text":"get_Ta_4(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Ta_4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf_1-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Tf_1","text":"get_Tf_1(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Tf_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf_2-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Tf_2","text":"get_Tf_2(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Tf_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::EXPIC1) -> Float64\n\n\nGet EXPIC1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::EXPIC1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXPIC1 Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::EXPIC1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXPIC1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::EXPIC1) -> Dict{String, Any}\n\n\nGet EXPIC1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::EXPIC1) -> Int64\n\n\nGet EXPIC1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::EXPIC1\n) -> Tuple{Float64, Float64}\n\n\nGet EXPIC1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::EXPIC1) -> Vector{Symbol}\n\n\nGet EXPIC1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{EXPIC1}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::EXPIC1) -> Vector{StateTypes}\n\n\nGet EXPIC1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Efd_lim!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Efd_lim!","text":"set_Efd_lim!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Efd_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ki!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ki!","text":"set_Ki!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ki.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kp!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Kp!","text":"set_Kp!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Kp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_2!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ta_2!","text":"set_Ta_2!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ta_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_3!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ta_3!","text":"set_Ta_3!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ta_3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_4!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Ta_4!","text":"set_Ta_4!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Ta_4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf_1!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Tf_1!","text":"set_Tf_1!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Tf_1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf_2!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Tf_2!","text":"set_Tf_2!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Tf_2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{EXPIC1, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::EXPIC1, val) -> Any\n\n\nSet EXPIC1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#IEEET1","page":"AVR","title":"IEEET1","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/IEEET1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.IEEET1","page":"AVR","title":"PowerSystems.IEEET1","text":"mutable struct IEEET1 <: AVR\n Tr::Float64\n Ka::Float64\n Ta::Float64\n Vr_lim::MinMax\n Ke::Float64\n Te::Float64\n Kf::Float64\n Tf::Float64\n switch::Int\n E_sat::Tuple{Float64, Float64}\n Se::Tuple{Float64, Float64}\n V_ref::Float64\n saturation_coeffs::Tuple{Float64, Float64}\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\n1968 IEEE type 1 excitation system model\n\nArguments\n\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, 0.5)\nKa::Float64: Amplifier Gain, validation range: (10, 500)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, 1)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vimin, Vimax)\nKe::Float64: Exciter constant related to self-excited field, validation range: (-1, 1)\nTe::Float64: Exciter time constant, integration rate associated with exciter control, validation range: (eps(), 1)\nKf::Float64: Excitation control system stabilizer gain, validation range: (eps(), 0.3)\nTf::Float64: Excitation control system stabilizer time constant. Appropiate Data: 5 <= Tf/Kf <= 15, validation range: (eps(), nothing)\nswitch::Int: Switch, validation range: (0, 1)\nE_sat::Tuple{Float64, Float64}: Exciter output voltage for saturation factor: (E1, E2)\nSe::Tuple{Float64, Float64}: Exciter saturation factor at exciter output voltage: (Se(E1), Se(E2))\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nsaturation_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\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVt: Terminal Voltage,\nVr: Regulator Output,\nVf: Exciter Output, \nVr3: Rate feedback integrator\n\nn_states::Int: (Do not modify.) The IEEET1 has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) IEEET1 I has 4 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_sat-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_E_sat","text":"get_E_sat(value::IEEET1) -> Tuple{Float64, Float64}\n\n\nGet IEEET1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::IEEET1) -> Float64\n\n\nGet IEEET1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ke-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Ke","text":"get_Ke(value::IEEET1) -> Float64\n\n\nGet IEEET1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::IEEET1) -> Float64\n\n\nGet IEEET1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Se-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Se","text":"get_Se(value::IEEET1) -> Tuple{Float64, Float64}\n\n\nGet IEEET1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::IEEET1) -> Float64\n\n\nGet IEEET1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::IEEET1) -> Float64\n\n\nGet IEEET1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::IEEET1) -> Float64\n\n\nGet IEEET1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::IEEET1) -> Float64\n\n\nGet IEEET1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::IEEET1) -> Float64\n\n\nGet IEEET1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::IEEET1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet IEEET1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::IEEET1) -> Dict{String, Any}\n\n\nGet IEEET1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::IEEET1) -> Int64\n\n\nGet IEEET1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_saturation_coeffs-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_saturation_coeffs","text":"get_saturation_coeffs(\n value::IEEET1\n) -> Tuple{Float64, Float64}\n\n\nGet IEEET1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::IEEET1) -> Vector{Symbol}\n\n\nGet IEEET1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::IEEET1) -> Vector{StateTypes}\n\n\nGet IEEET1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_switch-Tuple{IEEET1}","page":"AVR","title":"PowerSystems.get_switch","text":"get_switch(value::IEEET1) -> Int64\n\n\nGet IEEET1 switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_sat!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_E_sat!","text":"set_E_sat!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 E_sat.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ke!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Ke!","text":"set_Ke!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Ke.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Se!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Se!","text":"set_Se!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Se.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_saturation_coeffs!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_saturation_coeffs!","text":"set_saturation_coeffs!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 saturation_coeffs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_switch!-Tuple{IEEET1, Any}","page":"AVR","title":"PowerSystems.set_switch!","text":"set_switch!(value::IEEET1, val) -> Any\n\n\nSet IEEET1 switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EX4VSA","page":"AVR","title":"EX4VSA","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EX4VSA.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.get_E_lim-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_E_lim","text":"get_E_lim(\n value::PowerSystems.EX4VSA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EX4VSA E_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_G-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_G","text":"get_G(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA G.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Iflim-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Iflim","text":"get_Iflim(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Iflim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K1-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_K1","text":"get_K1(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA K1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K2-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_K2","text":"get_K2(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA K2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Oel_lim-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Oel_lim","text":"get_Oel_lim(\n value::PowerSystems.EX4VSA\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EX4VSA Oel_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Spar-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Spar","text":"get_Spar(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Spar.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_d-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_d","text":"get_d(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::PowerSystems.EX4VSA) -> Dict{String, Any}\n\n\nGet EX4VSA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_f-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_f","text":"get_f(value::PowerSystems.EX4VSA) -> Float64\n\n\nGet EX4VSA f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::PowerSystems.EX4VSA) -> Int64\n\n\nGet EX4VSA n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{PowerSystems.EX4VSA}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::PowerSystems.EX4VSA) -> Vector{Symbol}\n\n\nGet EX4VSA states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_E_lim!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_E_lim!","text":"set_E_lim!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA E_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_G!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_G!","text":"set_G!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA G.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Iflim!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Iflim!","text":"set_Iflim!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Iflim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K1!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_K1!","text":"set_K1!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA K1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K2!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_K2!","text":"set_K2!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA K2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Oel_lim!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Oel_lim!","text":"set_Oel_lim!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Oel_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Spar!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Spar!","text":"set_Spar!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Spar.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_d!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_d!","text":"set_d!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA d.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_f!-Tuple{PowerSystems.EX4VSA, Any}","page":"AVR","title":"PowerSystems.set_f!","text":"set_f!(value::PowerSystems.EX4VSA, val) -> Any\n\n\nSet EX4VSA f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#EXST1","page":"AVR","title":"EXST1","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/EXST1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ka-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Ka","text":"get_Ka(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kc-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Kc","text":"get_Kc(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kf-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Kf","text":"get_Kf(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Ta","text":"get_Ta(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tc-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Tc","text":"get_Tc(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tf-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Tf","text":"get_Tf(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::PowerSystems.EXST1) -> Float64\n\n\nGet EXST1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vi_lim-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Vi_lim","text":"get_Vi_lim(\n value::PowerSystems.EXST1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXST1 Vi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::PowerSystems.EXST1\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet EXST1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::PowerSystems.EXST1) -> Dict{String, Any}\n\n\nGet EXST1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::PowerSystems.EXST1) -> Int64\n\n\nGet EXST1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{PowerSystems.EXST1}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::PowerSystems.EXST1) -> Vector{Symbol}\n\n\nGet EXST1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ka!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Ka!","text":"set_Ka!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Ka.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kc!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Kc!","text":"set_Kc!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Kc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kf!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Kf!","text":"set_Kf!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Kf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tc!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Tc!","text":"set_Tc!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Tc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tf!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Tf!","text":"set_Tf!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Tf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vi_lim!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Vi_lim!","text":"set_Vi_lim!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Vi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{PowerSystems.EXST1, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::PowerSystems.EXST1, val) -> Any\n\n\nSet EXST1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#SCRX","page":"AVR","title":"SCRX","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/SCRX.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.SCRX","page":"AVR","title":"PowerSystems.SCRX","text":"mutable struct SCRX <: AVR\n Ta_Tb::Float64\n Tb::Float64\n K::Float64\n Te::Float64\n Efd_lim::MinMax\n switch::Int\n rc_rfd::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nThis 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\n\nArguments\n\nTa_Tb::Float64: Lead input constant ratio, validation range: (0.05, 0.3)\nTb::Float64: Lag input constant in s, validation range: (5, 20)\nK::Float64: Regulator Gain, validation range: (20, 100)\nTe::Float64: Regulator Time Constant, validation range: (0, 1)\nEfd_lim::MinMax: Field Voltage regulator limits (regulator output) (Efdmin, Efdmax)\nswitch::Int: Switch, validation range: (0, 1)\nrc_rfd::Float64: Field current capability. Set = 0 for negative current capability. Typical value 10, validation range: (0, 10)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVr1: First integrator,\nVr2: Second integrator\n\nn_states::Int: (Do not modify.) SCRX has 2 states\nstates_types::Vector{StateTypes}: (Do not modify.) SCRX has 2 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Efd_lim-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_Efd_lim","text":"get_Efd_lim(\n value::SCRX\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet SCRX Efd_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_K","text":"get_K(value::SCRX) -> Float64\n\n\nGet SCRX K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_Tb-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_Ta_Tb","text":"get_Ta_Tb(value::SCRX) -> Float64\n\n\nGet SCRX Ta_Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::SCRX) -> Float64\n\n\nGet SCRX Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::SCRX) -> Float64\n\n\nGet SCRX Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::SCRX) -> Float64\n\n\nGet SCRX V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::SCRX) -> Dict{String, Any}\n\n\nGet SCRX ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::SCRX) -> Int64\n\n\nGet SCRX n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_rc_rfd-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_rc_rfd","text":"get_rc_rfd(value::SCRX) -> Float64\n\n\nGet SCRX rc_rfd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::SCRX) -> Vector{Symbol}\n\n\nGet SCRX states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::SCRX) -> Vector{StateTypes}\n\n\nGet SCRX states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_switch-Tuple{SCRX}","page":"AVR","title":"PowerSystems.get_switch","text":"get_switch(value::SCRX) -> Int64\n\n\nGet SCRX switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Efd_lim!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_Efd_lim!","text":"set_Efd_lim!(value::SCRX, val) -> Any\n\n\nSet SCRX Efd_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_K!","text":"set_K!(value::SCRX, val) -> Any\n\n\nSet SCRX K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_Tb!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_Ta_Tb!","text":"set_Ta_Tb!(value::SCRX, val) -> Any\n\n\nSet SCRX Ta_Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::SCRX, val) -> Any\n\n\nSet SCRX Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::SCRX, val) -> Any\n\n\nSet SCRX Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::SCRX, val) -> Any\n\n\nSet SCRX V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::SCRX, val) -> Any\n\n\nSet SCRX ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_rc_rfd!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_rc_rfd!","text":"set_rc_rfd!(value::SCRX, val) -> Any\n\n\nSet SCRX rc_rfd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::SCRX, val) -> Any\n\n\nSet SCRX states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_switch!-Tuple{SCRX, Any}","page":"AVR","title":"PowerSystems.set_switch!","text":"set_switch!(value::SCRX, val) -> Any\n\n\nSet SCRX switch.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#SEXS","page":"AVR","title":"SEXS","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/SEXS.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.SEXS","page":"AVR","title":"PowerSystems.SEXS","text":"mutable struct SEXS <: AVR\n Ta_Tb::Float64\n Tb::Float64\n K::Float64\n Te::Float64\n V_lim::MinMax\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nParameters of Simplified Excitation System Model - SEXS in PSSE\n\nArguments\n\nTa_Tb::Float64: Ratio of lead and lag time constants, validation range: (0, nothing)\nTb::Float64: Lag time constant, validation range: (eps(), nothing)\nK::Float64: Gain, validation range: (0, nothing)\nTe::Float64: Field circuit time constant in s, validation range: (0, nothing)\nV_lim::MinMax: Field voltage limits\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\tVf: Voltage field,\tVr: Lead-lag state\nn_states::Int: (Do not modify.) SEXS has 2 states\nstates_types::Vector{StateTypes}: (Do not modify.) SEXS has 2 differential states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_K-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_K","text":"get_K(value::SEXS) -> Float64\n\n\nGet SEXS K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ta_Tb-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_Ta_Tb","text":"get_Ta_Tb(value::SEXS) -> Float64\n\n\nGet SEXS Ta_Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tb-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_Tb","text":"get_Tb(value::SEXS) -> Float64\n\n\nGet SEXS Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Te-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_Te","text":"get_Te(value::SEXS) -> Float64\n\n\nGet SEXS Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_lim-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_V_lim","text":"get_V_lim(\n value::SEXS\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet SEXS V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::SEXS) -> Float64\n\n\nGet SEXS V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::SEXS) -> Dict{String, Any}\n\n\nGet SEXS ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::SEXS) -> Int64\n\n\nGet SEXS n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::SEXS) -> Vector{Symbol}\n\n\nGet SEXS states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{SEXS}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::SEXS) -> Vector{StateTypes}\n\n\nGet SEXS states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_K!","text":"set_K!(value::SEXS, val) -> Any\n\n\nSet SEXS K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ta_Tb!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_Ta_Tb!","text":"set_Ta_Tb!(value::SEXS, val) -> Any\n\n\nSet SEXS Ta_Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tb!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_Tb!","text":"set_Tb!(value::SEXS, val) -> Any\n\n\nSet SEXS Tb.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Te!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_Te!","text":"set_Te!(value::SEXS, val) -> Any\n\n\nSet SEXS Te.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_lim!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::SEXS, val) -> Any\n\n\nSet SEXS V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::SEXS, val) -> Any\n\n\nSet SEXS V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::SEXS, val) -> Any\n\n\nSet SEXS ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{SEXS, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::SEXS, val) -> Any\n\n\nSet SEXS states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ST6B","page":"AVR","title":"ST6B","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ST6B.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ST6B","page":"AVR","title":"PowerSystems.ST6B","text":"mutable struct ST6B <: AVR\n OEL_Flag::Int\n Tr::Float64\n K_pa::Float64\n K_ia::Float64\n K_da::Float64\n T_da::Float64\n Va_lim::MinMax\n K_ff::Float64\n K_m::Float64\n K_ci::Float64\n K_lr::Float64\n I_lr::Float64\n Vr_lim::MinMax\n Kg::Float64\n Tg::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIn these excitation systems, voltage (and also current in compounded systems) is transformed to an appropriate level. Rectifiers, either controlled or non-controlled, provide the necessary direct current for the generator field. Parameters of IEEE Std 421.5 Type ST6B Excitacion System. ST6B in PSSE and PSLF\n\nArguments\n\nOEL_Flag::Int: OEL Flag for ST6B: 1: before HV gate, 2: after HV gate, validation range: (0, 2)\nTr::Float64: Regulator input filter time constant in s, validation range: (0, nothing)\nK_pa::Float64: Regulator proportional gain, validation range: (0, nothing)\nK_ia::Float64: Regulator integral gain, validation range: (0, nothing)\nK_da::Float64: Regulator derivative gain, validation range: (0, nothing)\nT_da::Float64: Voltage regulator derivative channel time constant in s, validation range: (0, nothing)\nVa_lim::MinMax: Regulator output limits (Vimin, Vimax)\nK_ff::Float64: Pre-control gain of the inner loop field regulator, validation range: (0, nothing)\nK_m::Float64: Forward gain of the inner loop field regulator, validation range: (0, nothing)\nK_ci::Float64: Exciter output current limit adjustment gain, validation range: (0, nothing)\nK_lr::Float64: Exciter output current limiter gain, validation range: (0, nothing)\nI_lr::Float64: Exciter current limiter reference, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (Vimin, Vimax)\nKg::Float64: Feedback gain constant of the inner loop field regulator, validation range: (0, nothing)\nTg::Float64: Feedback time constant of the inner loop field voltage regulator in s, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nx_i: Regulator Integrator,\nx_d: Regulator Derivative,\nVg: Regulator Feedback\n\nn_states::Int: (Do not modify.) ST6B has 4 states\nstates_types::Vector{StateTypes}: (Do not modify.) ST6B has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_I_lr-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_I_lr","text":"get_I_lr(value::ST6B) -> Float64\n\n\nGet ST6B I_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ci-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_ci","text":"get_K_ci(value::ST6B) -> Float64\n\n\nGet ST6B K_ci.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_da-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_da","text":"get_K_da(value::ST6B) -> Float64\n\n\nGet ST6B K_da.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ff-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_ff","text":"get_K_ff(value::ST6B) -> Float64\n\n\nGet ST6B K_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ia-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_ia","text":"get_K_ia(value::ST6B) -> Float64\n\n\nGet ST6B K_ia.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_lr-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_lr","text":"get_K_lr(value::ST6B) -> Float64\n\n\nGet ST6B K_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_m-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_m","text":"get_K_m(value::ST6B) -> Float64\n\n\nGet ST6B K_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pa-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_K_pa","text":"get_K_pa(value::ST6B) -> Float64\n\n\nGet ST6B K_pa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Kg-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Kg","text":"get_Kg(value::ST6B) -> Float64\n\n\nGet ST6B Kg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_OEL_Flag-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_OEL_Flag","text":"get_OEL_Flag(value::ST6B) -> Int64\n\n\nGet ST6B OEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T_da-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_T_da","text":"get_T_da(value::ST6B) -> Float64\n\n\nGet ST6B T_da.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tg-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Tg","text":"get_Tg(value::ST6B) -> Float64\n\n\nGet ST6B Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ST6B) -> Float64\n\n\nGet ST6B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ST6B) -> Float64\n\n\nGet ST6B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ST6B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST6B Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ST6B\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST6B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ST6B) -> Dict{String, Any}\n\n\nGet ST6B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ST6B) -> Int64\n\n\nGet ST6B n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ST6B) -> Vector{Symbol}\n\n\nGet ST6B states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ST6B}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ST6B) -> Vector{StateTypes}\n\n\nGet ST6B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_I_lr!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_I_lr!","text":"set_I_lr!(value::ST6B, val) -> Any\n\n\nSet ST6B I_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ci!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_ci!","text":"set_K_ci!(value::ST6B, val) -> Any\n\n\nSet ST6B K_ci.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_da!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_da!","text":"set_K_da!(value::ST6B, val) -> Any\n\n\nSet ST6B K_da.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ff!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_ff!","text":"set_K_ff!(value::ST6B, val) -> Any\n\n\nSet ST6B K_ff.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ia!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_ia!","text":"set_K_ia!(value::ST6B, val) -> Any\n\n\nSet ST6B K_ia.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_lr!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_lr!","text":"set_K_lr!(value::ST6B, val) -> Any\n\n\nSet ST6B K_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_m!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_m!","text":"set_K_m!(value::ST6B, val) -> Any\n\n\nSet ST6B K_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pa!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_K_pa!","text":"set_K_pa!(value::ST6B, val) -> Any\n\n\nSet ST6B K_pa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Kg!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Kg!","text":"set_Kg!(value::ST6B, val) -> Any\n\n\nSet ST6B Kg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_OEL_Flag!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_OEL_Flag!","text":"set_OEL_Flag!(value::ST6B, val) -> Any\n\n\nSet ST6B OEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T_da!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_T_da!","text":"set_T_da!(value::ST6B, val) -> Any\n\n\nSet ST6B T_da.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tg!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Tg!","text":"set_Tg!(value::ST6B, val) -> Any\n\n\nSet ST6B Tg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ST6B, val) -> Any\n\n\nSet ST6B Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ST6B, val) -> Any\n\n\nSet ST6B V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ST6B, val) -> Any\n\n\nSet ST6B Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ST6B, val) -> Any\n\n\nSet ST6B Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ST6B, val) -> Any\n\n\nSet ST6B ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ST6B, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ST6B, val) -> Any\n\n\nSet ST6B states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#ST8C","page":"AVR","title":"ST8C","text":"","category":"section"},{"location":"model_library/generated_AVR/","page":"AVR","title":"AVR","text":"Modules = [PowerSystems]\nPages = [\"/ST8C.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_AVR/#PowerSystems.ST8C","page":"AVR","title":"PowerSystems.ST8C","text":"mutable struct ST8C <: AVR\n OEL_Flag::Int\n UEL_Flag::Int\n SCL_Flag::Int\n SW1_Flag::Int\n Tr::Float64\n K_pr::Float64\n K_ir::Float64\n Vpi_lim::MinMax\n K_pa::Float64\n K_ia::Float64\n Va_lim::MinMax\n K_a::Float64\n T_a::Float64\n Vr_lim::MinMax\n K_f::Float64\n T_f::Float64\n K_c1::Float64\n K_p::Float64\n K_i1::Float64\n X_l::Float64\n θ_p::Float64\n VB1_max::Float64\n K_c2::Float64\n K_i2::Float64\n VB2_max::Float64\n V_ref::Float64\n Ifd_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n states_types::Vector{StateTypes}\n internal::InfrastructureSystemsInternal\nend\n\nIn these excitation systems, voltage (and also current in compounded systems) is transformed to an appropriate level. Rectifiers, either controlled or non-controlled, provide the necessary direct current for the generator field. Parameters of IEEE Std 421.5 Type ST8C Excitacion System. ST8C in PSSE and PSLF\n\nArguments\n\nOEL_Flag::Int: OEL Flag for ST8C: <2: Summation at Voltage Error, 2: OEL takeover at gate, validation range: (0, 2)\nUEL_Flag::Int: UEL Flag for ST8C: <2: Summation at Voltage Error, 2: UEL takeover at gate, validation range: (0, 2)\nSCL_Flag::Int: SCL Flag for ST8C: <2: Summation at Voltage Error, 2: SCL Takeover at UEL and OEL gates, validation range: (0, 2)\nSW1_Flag::Int: SW1 Flag for Power Source Selector for ST8C: <2: Source from generator terminal voltage, 2: Independent power source, validation range: (0, 2)\nTr::Float64: Regulator input filter time constant in seconds, validation range: (0, nothing)\nK_pr::Float64: Regulator proportional gain (pu), validation range: (0, nothing)\nK_ir::Float64: Regulator integral gain (pu), validation range: (0, nothing)\nVpi_lim::MinMax: Regulator input limits (Vpimin, Vpimax)\nK_pa::Float64: Field current regulator proportional gain (pu), validation range: (0, nothing)\nK_ia::Float64: Field current regulator integral gain (pu), validation range: (0, nothing)\nVa_lim::MinMax: Field current regulator output limits (Vamin, Vamax)\nK_a::Float64: Field current regulator proportional gain (pu), validation range: (0, nothing)\nT_a::Float64: Controlled rectifier bridge equivalent time constant in seconds, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (Vrmin, Vrmax)\nK_f::Float64: Exciter field current feedback gain (pu), validation range: (0, nothing)\nT_f::Float64: Field current feedback time constant in seconds, validation range: (0, nothing)\nK_c1::Float64: Rectifier loading factor proportional to commutating reactance (pu), validation range: (0, nothing)\nK_p::Float64: Potential circuit (voltage) gain coefficient (pu), validation range: (0, nothing)\nK_i1::Float64: Potential circuit (current) gain coefficient (pu), validation range: (0, nothing)\nX_l::Float64: Reactance associated with potential source (pu), validation range: (0, nothing)\nθ_p::Float64: Potential circuit phase angle (degrees), validation range: (0, nothing)\nVB1_max::Float64: Maximum available exciter voltage (pu), validation range: (0, nothing)\nK_c2::Float64: Rectifier loading factor proportional to commutating reactance (pu), validation range: (0, nothing)\nK_i2::Float64: Potential circuit (current) gain coefficient (pu), validation range: (0, nothing)\nVB2_max::Float64: Maximum available exciter voltage (pu), validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nIfd_ref::Float64: (default: 1.0) Reference Field Current Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed terminal voltage,\nx_a1: Regulator Integrator state,\nx_a2: Field Current regulator state,\nx_a3: Controller rectifier bridge state,\nx_a4: Regulator Feedback state\n\nn_states::Int: (Do not modify.) ST8C has 5 states\nstates_types::Vector{StateTypes}: (Do not modify.) ST8C has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_AVR/#PowerSystems.get_Ifd_ref-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Ifd_ref","text":"get_Ifd_ref(value::ST8C) -> Float64\n\n\nGet ST8C Ifd_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_a-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_a","text":"get_K_a(value::ST8C) -> Float64\n\n\nGet ST8C K_a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_c1-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_c1","text":"get_K_c1(value::ST8C) -> Float64\n\n\nGet ST8C K_c1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_c2-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_c2","text":"get_K_c2(value::ST8C) -> Float64\n\n\nGet ST8C K_c2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_f-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_f","text":"get_K_f(value::ST8C) -> Float64\n\n\nGet ST8C K_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_i1-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_i1","text":"get_K_i1(value::ST8C) -> Float64\n\n\nGet ST8C K_i1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_i2-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_i2","text":"get_K_i2(value::ST8C) -> Float64\n\n\nGet ST8C K_i2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ia-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_ia","text":"get_K_ia(value::ST8C) -> Float64\n\n\nGet ST8C K_ia.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_ir-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_ir","text":"get_K_ir(value::ST8C) -> Float64\n\n\nGet ST8C K_ir.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_p-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_p","text":"get_K_p(value::ST8C) -> Float64\n\n\nGet ST8C K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pa-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_pa","text":"get_K_pa(value::ST8C) -> Float64\n\n\nGet ST8C K_pa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_K_pr-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_K_pr","text":"get_K_pr(value::ST8C) -> Float64\n\n\nGet ST8C K_pr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_OEL_Flag-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_OEL_Flag","text":"get_OEL_Flag(value::ST8C) -> Int64\n\n\nGet ST8C OEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_SCL_Flag-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_SCL_Flag","text":"get_SCL_Flag(value::ST8C) -> Int64\n\n\nGet ST8C SCL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_SW1_Flag-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_SW1_Flag","text":"get_SW1_Flag(value::ST8C) -> Int64\n\n\nGet ST8C SW1_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T_a-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_T_a","text":"get_T_a(value::ST8C) -> Float64\n\n\nGet ST8C T_a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_T_f-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_T_f","text":"get_T_f(value::ST8C) -> Float64\n\n\nGet ST8C T_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Tr-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Tr","text":"get_Tr(value::ST8C) -> Float64\n\n\nGet ST8C Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_UEL_Flag-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_UEL_Flag","text":"get_UEL_Flag(value::ST8C) -> Int64\n\n\nGet ST8C UEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VB1_max-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_VB1_max","text":"get_VB1_max(value::ST8C) -> Float64\n\n\nGet ST8C VB1_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_VB2_max-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_VB2_max","text":"get_VB2_max(value::ST8C) -> Float64\n\n\nGet ST8C VB2_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_V_ref-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ST8C) -> Float64\n\n\nGet ST8C V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Va_lim-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Va_lim","text":"get_Va_lim(\n value::ST8C\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST8C Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vpi_lim-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Vpi_lim","text":"get_Vpi_lim(\n value::ST8C\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST8C Vpi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_Vr_lim-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_Vr_lim","text":"get_Vr_lim(\n value::ST8C\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ST8C Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_X_l-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_X_l","text":"get_X_l(value::ST8C) -> Float64\n\n\nGet ST8C X_l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_ext-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_ext","text":"get_ext(value::ST8C) -> Dict{String, Any}\n\n\nGet ST8C ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_n_states-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_n_states","text":"get_n_states(value::ST8C) -> Int64\n\n\nGet ST8C n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_states","text":"get_states(value::ST8C) -> Vector{Symbol}\n\n\nGet ST8C states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_states_types-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_states_types","text":"get_states_types(value::ST8C) -> Vector{StateTypes}\n\n\nGet ST8C states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.get_θ_p-Tuple{ST8C}","page":"AVR","title":"PowerSystems.get_θ_p","text":"get_θ_p(value::ST8C) -> Float64\n\n\nGet ST8C θ_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Ifd_ref!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Ifd_ref!","text":"set_Ifd_ref!(value::ST8C, val) -> Any\n\n\nSet ST8C Ifd_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_a!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_a!","text":"set_K_a!(value::ST8C, val) -> Any\n\n\nSet ST8C K_a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_c1!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_c1!","text":"set_K_c1!(value::ST8C, val) -> Any\n\n\nSet ST8C K_c1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_c2!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_c2!","text":"set_K_c2!(value::ST8C, val) -> Any\n\n\nSet ST8C K_c2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_f!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_f!","text":"set_K_f!(value::ST8C, val) -> Any\n\n\nSet ST8C K_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_i1!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_i1!","text":"set_K_i1!(value::ST8C, val) -> Any\n\n\nSet ST8C K_i1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_i2!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_i2!","text":"set_K_i2!(value::ST8C, val) -> Any\n\n\nSet ST8C K_i2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ia!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_ia!","text":"set_K_ia!(value::ST8C, val) -> Any\n\n\nSet ST8C K_ia.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_ir!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_ir!","text":"set_K_ir!(value::ST8C, val) -> Any\n\n\nSet ST8C K_ir.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_p!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_p!","text":"set_K_p!(value::ST8C, val) -> Any\n\n\nSet ST8C K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pa!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_pa!","text":"set_K_pa!(value::ST8C, val) -> Any\n\n\nSet ST8C K_pa.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_K_pr!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_K_pr!","text":"set_K_pr!(value::ST8C, val) -> Any\n\n\nSet ST8C K_pr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_OEL_Flag!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_OEL_Flag!","text":"set_OEL_Flag!(value::ST8C, val) -> Any\n\n\nSet ST8C OEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_SCL_Flag!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_SCL_Flag!","text":"set_SCL_Flag!(value::ST8C, val) -> Any\n\n\nSet ST8C SCL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_SW1_Flag!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_SW1_Flag!","text":"set_SW1_Flag!(value::ST8C, val) -> Any\n\n\nSet ST8C SW1_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T_a!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_T_a!","text":"set_T_a!(value::ST8C, val) -> Any\n\n\nSet ST8C T_a.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_T_f!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_T_f!","text":"set_T_f!(value::ST8C, val) -> Any\n\n\nSet ST8C T_f.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Tr!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Tr!","text":"set_Tr!(value::ST8C, val) -> Any\n\n\nSet ST8C Tr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_UEL_Flag!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_UEL_Flag!","text":"set_UEL_Flag!(value::ST8C, val) -> Any\n\n\nSet ST8C UEL_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VB1_max!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_VB1_max!","text":"set_VB1_max!(value::ST8C, val) -> Any\n\n\nSet ST8C VB1_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_VB2_max!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_VB2_max!","text":"set_VB2_max!(value::ST8C, val) -> Any\n\n\nSet ST8C VB2_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_V_ref!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ST8C, val) -> Any\n\n\nSet ST8C V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Va_lim!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Va_lim!","text":"set_Va_lim!(value::ST8C, val) -> Any\n\n\nSet ST8C Va_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vpi_lim!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Vpi_lim!","text":"set_Vpi_lim!(value::ST8C, val) -> Any\n\n\nSet ST8C Vpi_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_Vr_lim!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_Vr_lim!","text":"set_Vr_lim!(value::ST8C, val) -> Any\n\n\nSet ST8C Vr_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_X_l!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_X_l!","text":"set_X_l!(value::ST8C, val) -> Any\n\n\nSet ST8C X_l.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_ext!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_ext!","text":"set_ext!(value::ST8C, val) -> Any\n\n\nSet ST8C ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_states_types!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_states_types!","text":"set_states_types!(value::ST8C, val) -> Any\n\n\nSet ST8C states_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_AVR/#PowerSystems.set_θ_p!-Tuple{ST8C, Any}","page":"AVR","title":"PowerSystems.set_θ_p!","text":"set_θ_p!(value::ST8C, val) -> Any\n\n\nSet ST8C θ_p.\n\n\n\n\n\n","category":"method"},{"location":"how_to/parse_dynamic_data/#dyr_data","page":"...parse PSS/e dynamic data","title":"Parsing PSS/e dynamic data","text":"","category":"section"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"A PowerSystems.jl system can be created using a .RAW and a .DYR file. In this example we will create a three bus system from these example files:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"using PowerSystems\nfile_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"tutorials_data\")\nRAW_dir = joinpath(file_dir, \"ThreeBusNetwork.raw\")\nDYR_dir = joinpath(file_dir, \"TestGENCLS.dyr\")","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"The data in the RAW file defines a three bus system with three generators, three loads and three branches:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"0, 100, 33, 0, 0, 60 / 24-Apr-2020 19:28:39 - MATPOWER 7.0.1-dev\n\n\n 101, 'BUS 1 ', 138, 3, 1, 1, 1, 1.02, 0, 1.1, 0.9, 1.1, 0.9\n 102, 'BUS 2 ', 138, 2, 1, 1, 1, 1.0142, 0, 1.1, 0.9, 1.1, 0.9\n 103, 'BUS 3 ', 138, 2, 1, 1, 1, 1.0059, 0, 1.1, 0.9, 1.1, 0.9\n0 / END OF BUS DATA, BEGIN LOAD DATA\n 101, 1, 1, 1, 1, 100, 20, 0, 0, 0, 0, 1, 1, 0\n 102, 1, 1, 1, 1, 70, 10, 0, 0, 0, 0, 1, 1, 0\n 103, 1, 1, 1, 1, 50, 10, 0, 0, 0, 0, 1, 1, 0\n0 / END OF LOAD DATA, BEGIN FIXED SHUNT DATA\n0 / END OF FIXED SHUNT DATA, BEGIN GENERATOR DATA\n 101, 1, 20, 0, 100, -100, 1.02, 0, 100, 0, 0, 0, 0, 1, 1, 100, 318, 0, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1\n 102, 1, 100, 0, 100, -100, 1.0142, 0, 100, 0, 0.7, 0, 0, 1, 1, 100, 318, 0, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1\n 103, 1, 100, 0, 100, -100, 1.0059, 0, 100, 0, 0.2, 0, 0, 1, 1, 100, 318, 0, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1\n0 / END OF GENERATOR DATA, BEGIN BRANCH DATA\n 101, 103, 1, 0.01000, 0.12, 0.0, 250, 250, 250, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1\n 101, 102, 1, 0.01000, 0.12, 0.0, 250, 250, 250, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1\n 102, 103, 1, 0.01000, 0.12, 0.0, 250, 250, 250, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1\n0 / END OF BRANCH DATA, BEGIN TRANSFORMER DATA\n0 / END OF TRANSFORMER DATA, BEGIN AREA DATA\n0 / END OF AREA DATA, BEGIN TWO-TERMINAL DC DATA\n0 / END OF TWO-TERMINAL DC DATA, BEGIN VOLTAGE SOURCE CONVERTER DATA\n0 / END OF VOLTAGE SOURCE CONVERTER DATA, BEGIN IMPEDANCE CORRECTION DATA\n0 / END OF IMPEDANCE CORRECTION DATA, BEGIN MULTI-TERMINAL DC DATA\n0 / END OF MULTI-TERMINAL DC DATA, BEGIN MULTI-SECTION LINE DATA\n0 / END OF MULTI-SECTION LINE DATA, BEGIN ZONE DATA\n0 / END OF ZONE DATA, BEGIN INTER-AREA TRANSFER DATA\n0 / END OF INTER-AREA TRANSFER DATA, BEGIN OWNER DATA\n0 / END OF OWNER DATA, BEGIN FACTS CONTROL DEVICE DATA\n0 / END OF FACTS CONTROL DEVICE DATA, BEGIN SWITCHED SHUNT DATA\n0 / END OF SWITCHED SHUNT DATA, BEGIN GNE DEVICE DATA\n0 / END OF GNE DEVICE DATA, BEGIN INDUCTION MACHINE DATA\n0 / END OF INDUCTION MACHINE DATA\nQ","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"The dynamic data for the generators is provided in the DYR file:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":" 101 'GENROE' 1 8.000000 0.030000 0.400000 0.050000 6.500000 0.000000 1.800000\n 1.700000 0.300000 0.550000 0.250000 0.200000 0.039200 0.267200 /\n 101 'ESST1A' 1 1 1 0.01 99 -99 1 10 1 1 200 0 4 -4 4 -4 0 0 1 0 3 /\n 102 'GENCLS' 1 0.0 0.0 /\n 103 'GENCLS' 1 3.1 2.0 /","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"That assigns a GENROU generator and a ESST1A voltage regulator at the generator located at bus 101, while classic machine models for the generators located at bus 102 and 103.","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"To create the System in PowerSystems.jl, we pass both files directories:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"dyn_system = System(RAW_dir, DYR_dir; runchecks = false)","category":"page"},{"location":"how_to/parse_dynamic_data/#Supported-PSS/e-Models","page":"...parse PSS/e dynamic data","title":"Supported PSS/e Models","text":"","category":"section"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"PSS/e's dynamic model library is extensive, we currently support parsing a limited amount of models out of the box.","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"Machine models AVR Models Prime Movers PSS models\nGENSAE IEEET1 HYGOV IEEEST\nGENSAL ESDC1A IEEEG1 \nGENROE ESAC1A GGOV1 \nGENCLS ESST4B \nGENROU EXAC2 \n EXPIC1 \n ESAC6A \n EXAC1 \n SCRX \n ESDC2A ","category":"page"},{"location":"how_to/parse_dynamic_data/#Common-Issue:-Unique-Bus-Names","page":"...parse PSS/e dynamic data","title":"Common Issue: Unique Bus Names","text":"","category":"section"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"Please note that while PSS/e does not enforce unique bus names, PowerSystems.jl does. To reparse bus names to comply with this requirement the bus_name_formatter *kwarg can be used in System() as shown in the example below:","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"dyn_system = System(\n RAW_dir,\n DYR_dir;\n bus_name_formatter = x -> strip(string(x[\"name\"])) * \"-\" * string(x[\"index\"]),\n)","category":"page"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"In this example the anonymous function x -> strip(string(x[\"name\"])) * \"-\" * string(x[\"index\"]) takes the bus name and index from PSSe and concatenates them to produce the name.","category":"page"},{"location":"how_to/parse_dynamic_data/#See-also:","page":"...parse PSS/e dynamic data","title":"See also:","text":"","category":"section"},{"location":"how_to/parse_dynamic_data/","page":"...parse PSS/e dynamic data","title":"...parse PSS/e dynamic data","text":"Parsing Matpower or PSS/e RAW Files\nParsing table data (CSV Files)\nParsing time series","category":"page"},{"location":"model_library/generated_ThermalMultiStart/#ThermalMultiStart","page":"ThermalMultiStart","title":"ThermalMultiStart","text":"","category":"section"},{"location":"model_library/generated_ThermalMultiStart/","page":"ThermalMultiStart","title":"ThermalMultiStart","text":"Modules = [PowerSystems]\nPages = [\"generated/ThermalMultiStart.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.ThermalMultiStart","page":"ThermalMultiStart","title":"PowerSystems.ThermalMultiStart","text":"mutable struct ThermalMultiStart <: ThermalGen\n name::String\n available::Bool\n status::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n rating::Float64\n prime_mover_type::PrimeMovers\n fuel::ThermalFuels\n active_power_limits::MinMax\n reactive_power_limits::Union{Nothing, MinMax}\n ramp_limits::Union{Nothing, UpDown}\n power_trajectory::Union{Nothing, StartUpShutDown}\n time_limits::Union{Nothing, UpDown}\n start_time_limits::Union{Nothing, StartUpStages}\n start_types::Int\n operation_cost::Union{ThermalGenerationCost, MarketBidCost}\n base_power::Float64\n services::Vector{Service}\n time_at_status::Float64\n must_run::Bool\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA thermal generator, such as a fossil fuel or nuclear generator, that can start-up again from a hot, warm, or cold state.\n\nThermalMultiStart 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nstatus::Bool: Initial commitment condition at the start of a simulation (true = on or false = off)\nbus::ACBus: Bus that this component is connected to\nactive_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\nreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range: reactive_power_limits\nrating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)\nprime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here\nfuel::ThermalFuels: Prime mover fuel according to EIA 923. Options are listed here\nactive_power_limits::MinMax: Minimum and maximum stable active power levels (MW)\nreactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable\nramp_limits::Union{Nothing, UpDown}:, validation range: (0, nothing)\npower_trajectory::Union{Nothing, StartUpShutDown}: Power trajectory the unit will take during the start-up and shut-down ramp process, validation range: (0, nothing)\ntime_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)\nstart_time_limits::Union{Nothing, StartUpStages}: Time limits for start-up based on turbine temperature in hours\nstart_types::Int: Number of start-up based on turbine temperature, where 1 = hot, 2 = warm, and 3 = cold, validation range: (1, 3)\noperation_cost::Union{ThermalGenerationCost, MarketBidCost}: OperationalCost of generation\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ntime_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been on or off, as indicated by status\nmust_run::Bool: (default: false) Set to true if the unit is must run\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ThermalMultiStart/#InfrastructureSystems.get_name-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"InfrastructureSystems.get_name","text":"get_name(value::ThermalMultiStart) -> String\n\n\nGet ThermalMultiStart name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_active_power-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_active_power","text":"get_active_power(value::ThermalMultiStart) -> Any\n\n\nGet ThermalMultiStart active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_active_power_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_active_power_limits","text":"get_active_power_limits(\n value::ThermalMultiStart\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet ThermalMultiStart active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_available-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_available","text":"get_available(value::ThermalMultiStart) -> Bool\n\n\nGet ThermalMultiStart available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_base_power-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_base_power","text":"get_base_power(value::ThermalMultiStart) -> Float64\n\n\nGet ThermalMultiStart base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_bus-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_bus","text":"get_bus(value::ThermalMultiStart) -> ACBus\n\n\nGet ThermalMultiStart bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_dynamic_injector-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::ThermalMultiStart\n) -> Union{Nothing, DynamicInjection}\n\n\nGet ThermalMultiStart dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_ext-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_ext","text":"get_ext(value::ThermalMultiStart) -> Dict{String, Any}\n\n\nGet ThermalMultiStart ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_fuel-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_fuel","text":"get_fuel(value::ThermalMultiStart) -> ThermalFuels\n\n\nGet ThermalMultiStart fuel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_must_run-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_must_run","text":"get_must_run(value::ThermalMultiStart) -> Bool\n\n\nGet ThermalMultiStart must_run.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_operation_cost-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_operation_cost","text":"get_operation_cost(\n value::ThermalMultiStart\n) -> Union{MarketBidCost, ThermalGenerationCost}\n\n\nGet ThermalMultiStart operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_power_trajectory-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_power_trajectory","text":"get_power_trajectory(\n value::ThermalMultiStart\n) -> Union{Nothing, NamedTuple{(:startup, :shutdown), <:Tuple{Any, Any}}}\n\n\nGet ThermalMultiStart power_trajectory.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_prime_mover_type-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_prime_mover_type","text":"get_prime_mover_type(\n value::ThermalMultiStart\n) -> PrimeMovers\n\n\nGet ThermalMultiStart prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_ramp_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_ramp_limits","text":"get_ramp_limits(\n value::ThermalMultiStart\n) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}\n\n\nGet ThermalMultiStart ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_rating-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_rating","text":"get_rating(value::ThermalMultiStart) -> Any\n\n\nGet ThermalMultiStart rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_reactive_power-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::ThermalMultiStart) -> Any\n\n\nGet ThermalMultiStart reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_reactive_power_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_reactive_power_limits","text":"get_reactive_power_limits(\n value::ThermalMultiStart\n) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}\n\n\nGet ThermalMultiStart reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_services-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_services","text":"get_services(value::ThermalMultiStart) -> Vector{Service}\n\n\nGet ThermalMultiStart services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_start_time_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_start_time_limits","text":"get_start_time_limits(\n value::ThermalMultiStart\n) -> Union{Nothing, @NamedTuple{hot::Float64, warm::Float64, cold::Float64}}\n\n\nGet ThermalMultiStart start_time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_start_types-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_start_types","text":"get_start_types(value::ThermalMultiStart) -> Int64\n\n\nGet ThermalMultiStart start_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_status-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_status","text":"get_status(value::ThermalMultiStart) -> Bool\n\n\nGet ThermalMultiStart status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_time_at_status-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_time_at_status","text":"get_time_at_status(value::ThermalMultiStart) -> Float64\n\n\nGet ThermalMultiStart time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.get_time_limits-Tuple{ThermalMultiStart}","page":"ThermalMultiStart","title":"PowerSystems.get_time_limits","text":"get_time_limits(\n value::ThermalMultiStart\n) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}\n\n\nGet ThermalMultiStart time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_active_power!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_active_power_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_active_power_limits!","text":"set_active_power_limits!(\n value::ThermalMultiStart,\n val\n) -> Any\n\n\nSet ThermalMultiStart active_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_available!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_available!","text":"set_available!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_base_power!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_bus!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_bus!","text":"set_bus!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_ext!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_ext!","text":"set_ext!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_fuel!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_fuel!","text":"set_fuel!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart fuel.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_must_run!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_must_run!","text":"set_must_run!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart must_run.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_operation_cost!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_operation_cost!","text":"set_operation_cost!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart operation_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_power_trajectory!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_power_trajectory!","text":"set_power_trajectory!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart power_trajectory.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_prime_mover_type!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_prime_mover_type!","text":"set_prime_mover_type!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart prime_mover_type.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_ramp_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_ramp_limits!","text":"set_ramp_limits!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart ramp_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_rating!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_rating!","text":"set_rating!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_reactive_power!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_reactive_power_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_reactive_power_limits!","text":"set_reactive_power_limits!(\n value::ThermalMultiStart,\n val\n) -> Any\n\n\nSet ThermalMultiStart reactive_power_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_services!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_services!","text":"set_services!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_start_time_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_start_time_limits!","text":"set_start_time_limits!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart start_time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_start_types!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_start_types!","text":"set_start_types!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart start_types.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_status!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_status!","text":"set_status!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_time_at_status!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_time_at_status!","text":"set_time_at_status!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart time_at_status.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ThermalMultiStart/#PowerSystems.set_time_limits!-Tuple{ThermalMultiStart, Any}","page":"ThermalMultiStart","title":"PowerSystems.set_time_limits!","text":"set_time_limits!(value::ThermalMultiStart, val) -> Any\n\n\nSet ThermalMultiStart time_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#CSVGN1","page":"CSVGN1","title":"CSVGN1","text":"","category":"section"},{"location":"model_library/generated_CSVGN1/","page":"CSVGN1","title":"CSVGN1","text":"Modules = [PowerSystems]\nPages = [\"generated/CSVGN1.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_CSVGN1/#PowerSystems.CSVGN1","page":"CSVGN1","title":"PowerSystems.CSVGN1","text":"mutable struct CSVGN1 <: DynamicInjection\n name::String\n K::Float64\n T1::Float64\n T2::Float64\n T3::Float64\n T4::Float64\n T5::Float64\n Rmin::Float64\n Vmax::Float64\n Vmin::Float64\n CBase::Float64\n base_power::Float64\n ext::Dict{String, Any}\n R_th::Float64\n X_th::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of static shunt compensator: CSVGN1 in PSSE\n\nArguments\n\nname::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\nK::Float64: Gain in pu (DEVICE_BASE), validation range: (0, nothing)\nT1::Float64: Time constant in s, validation range: (0, nothing)\nT2::Float64: Time constant in s, validation range: (0, nothing)\nT3::Float64: Time constant in s, validation range: (eps(), nothing)\nT4::Float64: Time constant in s, validation range: (0, nothing)\nT5::Float64: Time constant in s, validation range: (0, nothing)\nRmin::Float64: Reactor minimum Mvar, validation range: (0, nothing)\nVmax::Float64: Maximum voltage in pu, validation range: (0, nothing)\nVmin::Float64: Minimum voltage in pu, validation range: (0, nothing)\nCBase::Float64: Capacitor (MVAR), validation range: (0, nothing)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\next::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.\nR_th::Float64: Source Thevenin resistance\nX_th::Float64: Source Thevenin reactance\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nthy: thyristor,\nvr1: regulator output 1,\nvr2: regulator output 2\n\nn_states::Int: (Do not modify.) CSVGN1 has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_CSVGN1/#InfrastructureSystems.get_name-Tuple{CSVGN1}","page":"CSVGN1","title":"InfrastructureSystems.get_name","text":"get_name(value::CSVGN1) -> String\n\n\nGet CSVGN1 name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_CBase-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_CBase","text":"get_CBase(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 CBase.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_K-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_K","text":"get_K(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_R_th-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_R_th","text":"get_R_th(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_Rmin-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_Rmin","text":"get_Rmin(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 Rmin.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T1-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T1","text":"get_T1(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T2-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T2","text":"get_T2(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T3-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T3","text":"get_T3(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T4-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T4","text":"get_T4(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_T5-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_T5","text":"get_T5(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_Vmax-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_Vmax","text":"get_Vmax(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 Vmax.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_Vmin-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_Vmin","text":"get_Vmin(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 Vmin.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_X_th-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_X_th","text":"get_X_th(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_base_power-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_base_power","text":"get_base_power(value::CSVGN1) -> Float64\n\n\nGet CSVGN1 base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_ext-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_ext","text":"get_ext(value::CSVGN1) -> Dict{String, Any}\n\n\nGet CSVGN1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_n_states-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_n_states","text":"get_n_states(value::CSVGN1) -> Int64\n\n\nGet CSVGN1 n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.get_states-Tuple{CSVGN1}","page":"CSVGN1","title":"PowerSystems.get_states","text":"get_states(value::CSVGN1) -> Vector{Symbol}\n\n\nGet CSVGN1 states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_CBase!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_CBase!","text":"set_CBase!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 CBase.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_K!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_K!","text":"set_K!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 K.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_R_th!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_R_th!","text":"set_R_th!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 R_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_Rmin!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_Rmin!","text":"set_Rmin!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 Rmin.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T1!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T1!","text":"set_T1!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T2!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T2!","text":"set_T2!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T3!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T3!","text":"set_T3!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T3.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T4!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T4!","text":"set_T4!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T4.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_T5!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_T5!","text":"set_T5!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 T5.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_Vmax!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_Vmax!","text":"set_Vmax!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 Vmax.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_Vmin!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_Vmin!","text":"set_Vmin!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 Vmin.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_X_th!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_X_th!","text":"set_X_th!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 X_th.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_base_power!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_CSVGN1/#PowerSystems.set_ext!-Tuple{CSVGN1, Any}","page":"CSVGN1","title":"PowerSystems.set_ext!","text":"set_ext!(value::CSVGN1, val) -> Any\n\n\nSet CSVGN1 ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#MarketBidCost","page":"MarketBidCost","title":"MarketBidCost","text":"","category":"section"},{"location":"model_library/market_bid_cost/","page":"MarketBidCost","title":"MarketBidCost","text":"Modules = [PowerSystems]\nPages = [\"cost_functions/MarketBidCost.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/market_bid_cost/#PowerSystems.MarketBidCost","page":"MarketBidCost","title":"PowerSystems.MarketBidCost","text":"mutable struct MarketBidCost <: OperationalCost\n\nno_load_cost::Union{Nothing, Float64, TimeSeriesKey}: No load cost\nstart_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\nshut_down::Float64: Shut-down cost\nincremental_offer_curves::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}: Sell Offer Curves data, which can be a time series of PiecewiseStepData or a CostCurve of PiecewiseIncrementalCurve\ndecremental_offer_curves::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}: Buy Offer Curves data, which can be a time series of PiecewiseStepData or a CostCurve of PiecewiseIncrementalCurve\nincremental_initial_input::Union{Nothing, TimeSeriesKey}: If using a time series for incrementaloffercurves, this is a time series of Float64 representing the initial_input\ndecremental_initial_input::Union{Nothing, TimeSeriesKey}: If using a time series for decrementaloffercurves, this is a time series of Float64 representing the initial_input\nancillary_service_offers::Vector{Service}: Bids for the ancillary services\n\nMarketBidCost(no_load_cost, start_up, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)\nMarketBidCost(; no_load_cost, start_up, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)\nMarketBidCost(no_load_cost, start_up::Real, shut_down, incremental_offer_curves, decremental_offer_curves, ancillary_service_offers)\n\nAn 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.\n\n\n\n\n\n","category":"type"},{"location":"model_library/market_bid_cost/#PowerSystems.MarketBidCost-Tuple{Any, Real, Any}","page":"MarketBidCost","title":"PowerSystems.MarketBidCost","text":"MarketBidCost(\n no_load_cost,\n start_up::Real,\n shut_down;\n incremental_offer_curves,\n decremental_offer_curves,\n incremental_initial_input,\n decremental_initial_input,\n ancillary_service_offers\n) -> MarketBidCost\n\n\nAccepts a single start_up value to use as the hot value, with warm and cold set to 0.0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.MarketBidCost-Tuple{Float64, Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}, Vararg{Any, 4}}","page":"MarketBidCost","title":"PowerSystems.MarketBidCost","text":"MarketBidCost(\n no_load_cost::Float64,\n start_up::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey},\n shut_down,\n incremental_offer_curves,\n decremental_offer_curves,\n ancillary_service_offers\n) -> MarketBidCost\n\n\nAuxiliary Constructor for TestData\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.MarketBidCost-Tuple{Integer, Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}, Vararg{Any, 6}}","page":"MarketBidCost","title":"PowerSystems.MarketBidCost","text":"MarketBidCost(\n no_load_cost::Integer,\n start_up::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey},\n shut_down,\n incremental_offer_curves,\n decremental_offer_curves,\n incremental_initial_input,\n decremental_initial_input,\n ancillary_service_offers\n) -> MarketBidCost\n\n\nAuxiliary Constructor for Deserialization with Integer at no load cost\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_ancillary_service_offers-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_ancillary_service_offers","text":"get_ancillary_service_offers(\n value::MarketBidCost\n) -> Vector{Service}\n\n\nGet MarketBidCost ancillary_service_offers.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_decremental_initial_input-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_decremental_initial_input","text":"get_decremental_initial_input(\n value::MarketBidCost\n) -> Union{Nothing, TimeSeriesKey}\n\n\nGet MarketBidCost decremental_initial_input.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_decremental_offer_curves-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_decremental_offer_curves","text":"get_decremental_offer_curves(\n value::MarketBidCost\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}\n\n\nGet MarketBidCost decremental_offer_curves.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_incremental_initial_input-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_incremental_initial_input","text":"get_incremental_initial_input(\n value::MarketBidCost\n) -> Union{Nothing, TimeSeriesKey}\n\n\nGet MarketBidCost incremental_initial_input.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_incremental_offer_curves-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_incremental_offer_curves","text":"get_incremental_offer_curves(\n value::MarketBidCost\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}\n\n\nGet MarketBidCost incremental_offer_curves.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_no_load_cost-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_no_load_cost","text":"get_no_load_cost(\n value::MarketBidCost\n) -> Union{Nothing, Float64, TimeSeriesKey}\n\n\nGet MarketBidCost no_load_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_shut_down-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_shut_down","text":"get_shut_down(value::MarketBidCost) -> Float64\n\n\nGet MarketBidCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.get_start_up-Tuple{MarketBidCost}","page":"MarketBidCost","title":"PowerSystems.get_start_up","text":"get_start_up(\n value::MarketBidCost\n) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}\n\n\nGet MarketBidCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.make_market_bid_curve-Tuple{PiecewiseStepData, Float64}","page":"MarketBidCost","title":"PowerSystems.make_market_bid_curve","text":"make_market_bid_curve(\n data::PiecewiseStepData,\n initial_input::Float64;\n power_units,\n input_at_zero\n) -> CostCurve{PiecewiseIncrementalCurve}\n\n\nMake 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.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.make_market_bid_curve-Tuple{Vector{Float64}, Vector{Float64}, Float64}","page":"MarketBidCost","title":"PowerSystems.make_market_bid_curve","text":"make_market_bid_curve(\n powers::Vector{Float64},\n marginal_costs::Vector{Float64},\n initial_input::Float64;\n power_units,\n input_at_zero\n) -> CostCurve{PiecewiseIncrementalCurve}\n\n\nMake a CostCurve{PiecewiseIncrementalCurve} suitable for inclusion in a MarketBidCost from a vector of power values, a vector of marginal costs, a float of initial input, and an optional units system and input at zero.\n\nExamples\n\nmbc = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0)\nmbc2 = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0; input_at_zero = 10.0)\nmbc3 = make_market_bid_curve([0.0, 100.0, 105.0, 120.0, 130.0], [25.0, 26.0, 28.0, 30.0], 10.0; power_inputs = UnitSystem.NATURAL_UNITS)\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_ancillary_service_offers!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_ancillary_service_offers!","text":"set_ancillary_service_offers!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost ancillary_service_offers.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_decremental_initial_input!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_decremental_initial_input!","text":"set_decremental_initial_input!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost decremental_initial_input.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_decremental_offer_curves!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_decremental_offer_curves!","text":"set_decremental_offer_curves!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost incremental_offer_curves.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_incremental_initial_input!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_incremental_initial_input!","text":"set_incremental_initial_input!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost incremental_initial_input.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_incremental_offer_curves!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_incremental_offer_curves!","text":"set_incremental_offer_curves!(\n value::MarketBidCost,\n val\n) -> Any\n\n\nSet MarketBidCost incremental_offer_curves.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_no_load_cost!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_no_load_cost!","text":"set_no_load_cost!(value::MarketBidCost, val) -> Any\n\n\nSet MarketBidCost no_load_cost.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_shut_down!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_shut_down!","text":"set_shut_down!(value::MarketBidCost, val) -> Any\n\n\nSet MarketBidCost shut_down.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_start_up!-Tuple{MarketBidCost, Any}","page":"MarketBidCost","title":"PowerSystems.set_start_up!","text":"set_start_up!(\n value::MarketBidCost,\n val\n) -> NamedTuple{(:hot, :warm, :cold), <:Tuple{Any, Float64, Float64}}\n\n\nSet MarketBidCost start_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/market_bid_cost/#PowerSystems.set_start_up!-Tuple{MarketBidCost, Real}","page":"MarketBidCost","title":"PowerSystems.set_start_up!","text":"set_start_up!(\n value::MarketBidCost,\n val::Real\n) -> NamedTuple{(:hot, :warm, :cold), <:Tuple{Any, Float64, Float64}}\n\n\nAuxiliary Method for setting up start up that are not multi-start\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Public-API-Reference","page":"Public API","title":"Public API Reference","text":"","category":"section"},{"location":"api/public/#Modeling","page":"Public API","title":"Modeling","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"PowerSystems.jl\",\n \"branches.jl\",\n \"components.jl\",\n \"injection.jl\",\n \"devices.jl\",\n \"loads.jl\",\n \"supplemental_constructors\",\n \"generation.jl\",\n \"reserves.jl\",\n \"storage.jl\",\n \"services.jl\",\n \"outages.jl\",\n \"topological_elements.jl\",\n \"dynamic_models.jl\",\n \"static_models.jl\",\n \"subsystems.jl\",\n \"static_injection_subsystem.jl\",\n \"dynamic_models.jl\",\n \"operational_cost.jl\",\n \"cost_function_timeseries.jl\",\n \"definitions.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"api/public/#PowerSystems.PowerSystems","page":"Public API","title":"PowerSystems.PowerSystems","text":"Module for constructing self-contained power system objects.\n\n\n\n\n\n","category":"module"},{"location":"api/public/#PowerSystems.Component","page":"Public API","title":"PowerSystems.Component","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Device","page":"Public API","title":"PowerSystems.Device","text":"Supertype for \"devices\" (bus, line, etc.) \n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ACBranch","page":"Public API","title":"PowerSystems.ACBranch","text":"Supertype for all AC branches (branches connecting at least one AC node)\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Branch","page":"Public API","title":"PowerSystems.Branch","text":"Supertype for all branches\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.DCBranch","page":"Public API","title":"PowerSystems.DCBranch","text":"Supertype for all DC branches (branches that connect only DC nodes)\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_base_power-Tuple{Component}","page":"Public API","title":"PowerSystems.get_base_power","text":"get_base_power(c::Component) -> Float64\n\n\nDefault behavior of a component. If there is no base_power field, assume is in the system's base power.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_dynamic_injector!-Union{Tuple{U}, Tuple{T}, Tuple{T, U}} where {T<:StaticInjection, U<:Union{Nothing, DynamicInjection}}","page":"Public API","title":"PowerSystems.set_dynamic_injector!","text":"set_dynamic_injector!(\n static_injector::StaticInjection,\n dynamic_injector::Union{Nothing, DynamicInjection}\n)\n\n\nAny StaticInjection struct that wants to support dynamic injectors must implement this method to set the value.\n\nThe method is only for internal uses.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.clear_services!-Tuple{Device}","page":"Public API","title":"PowerSystems.clear_services!","text":"clear_services!(device::Device)\n\n\nRemove all services attached to the device.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_service-Tuple{Device, Service}","page":"Public API","title":"PowerSystems.has_service","text":"has_service(device::Device, service::Service) -> Bool\n\n\nReturn true if the service is attached to the device.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_service-Union{Tuple{T}, Tuple{Device, Type{T}}} where T<:Service","page":"Public API","title":"PowerSystems.has_service","text":"has_service(device::Device, _::Type{T<:Service}) -> Bool\n\n\nReturn true if a service with type T is attached to the device.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_service!-Tuple{Device, Service}","page":"Public API","title":"PowerSystems.remove_service!","text":"remove_service!(device::Device, service::Service)\n\n\nRemove a service from a device.\n\nThrows ArgumentError if the service is not attached to the device.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.ControllableLoad","page":"Public API","title":"PowerSystems.ControllableLoad","text":"Supertype for all controllable loads\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ElectricLoad","page":"Public API","title":"PowerSystems.ElectricLoad","text":"Supertype for all electric loads\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.StaticLoad","page":"Public API","title":"PowerSystems.StaticLoad","text":"Supertype for all static electric loads\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Generator","page":"Public API","title":"PowerSystems.Generator","text":"Supertype for all generation technologies\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.HydroGen","page":"Public API","title":"PowerSystems.HydroGen","text":"Supertype for all Hydropower generation technologies\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.RenewableGen","page":"Public API","title":"PowerSystems.RenewableGen","text":"Supertype for all renewable generation technologies\n\nRequires the implementation of get_ratingand get_power_factor methods\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ThermalGen","page":"Public API","title":"PowerSystems.ThermalGen","text":"Supertype for all Thermal generation technologies\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_max_active_power-Tuple{T} where T<:RenewableGen","page":"Public API","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(d::RenewableGen) -> Any\n\n\nReturn the max active power for the Renewable Generation calculated as the rating * power_factor\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_max_reactive_power-Tuple{T} where T<:RenewableGen","page":"Public API","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(d::RenewableGen) -> Any\n\n\nReturn the max reactive power for the Renewable Generation calculated as the rating * sin(acos(power_factor))\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.Reserve","page":"Public API","title":"PowerSystems.Reserve","text":"A reserve product to be able to respond to unexpected disturbances, such as the sudden loss of a transmission line or generator.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ReserveDirection","page":"Public API","title":"PowerSystems.ReserveDirection","text":"Used to specify if a Reserve is upwards, downwards, or symmetric\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ReserveDown","page":"Public API","title":"PowerSystems.ReserveDown","text":"A downwards reserve to decrease generation or increase load\n\nDownwards reserves are used when total load falls below its expected level, typically due to forecast errors or contingencies. Not work\n\nA Reserve can be specified as a ReserveDown when it is defined.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ReserveSymmetric","page":"Public API","title":"PowerSystems.ReserveSymmetric","text":"A symmetric reserve, procuring the same quantity (MW) of both upwards and downwards reserves\n\nA symmetric reserve is a special case. ReserveUp and ReserveDown can be used individually to specify different quantities of upwards and downwards reserves, respectively.\n\nA Reserve can be specified as a ReserveSymmetric when it is defined.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.ReserveUp","page":"Public API","title":"PowerSystems.ReserveUp","text":"An upwards reserve to increase generation or reduce load\n\nUpwards reserves are used when total load exceeds its expected level, typically due to forecast errors or contingencies.\n\nA Reserve can be specified as a ReserveUp when it is defined.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Storage","page":"Public API","title":"PowerSystems.Storage","text":"Supertype for energy storage technologies\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Service","page":"Public API","title":"PowerSystems.Service","text":"Supertype for all system services\n\nServices (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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.GeometricDistributionForcedOutage","page":"Public API","title":"PowerSystems.GeometricDistributionForcedOutage","text":"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.\n\nArguments\n\ntime_to_recovery::Int: Time elapsed to recovery after a failure in Milliseconds.\noutage_transition_probability::Float64: Characterizes the probability of failure (1 - p) in the geometric distribution.\ninternal::InfrastructureSystemsInternal: power system internal reference, do not modify\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.PlannedOutage","page":"Public API","title":"PowerSystems.PlannedOutage","text":"Attribute that contains information regarding planned outages.\n\nArguments\n\noutage_schedule::String: String name of the time series used for the scheduled outages\ninternal::InfrastructureSystemsInternal: power system internal reference, do not modify\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.TimeSeriesForcedOutage","page":"Public API","title":"PowerSystems.TimeSeriesForcedOutage","text":"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.\n\nArguments\n\noutage_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.\ninternal::InfrastructureSystemsInternal: power system internal reference, do not modify\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_mean_time_to_recovery-Tuple{GeometricDistributionForcedOutage}","page":"Public API","title":"PowerSystems.get_mean_time_to_recovery","text":"get_mean_time_to_recovery(\n value::GeometricDistributionForcedOutage\n) -> Float64\n\n\nGet GeometricDistributionForcedOutage time_to_recovery.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_outage_schedule-Tuple{PlannedOutage}","page":"Public API","title":"PowerSystems.get_outage_schedule","text":"get_outage_schedule(value::PlannedOutage) -> String\n\n\nGet PlannedOutage outage_schedule.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_outage_transition_probability-Tuple{GeometricDistributionForcedOutage}","page":"Public API","title":"PowerSystems.get_outage_transition_probability","text":"get_outage_transition_probability(\n value::GeometricDistributionForcedOutage\n) -> Float64\n\n\nGet GeometricDistributionForcedOutage outage_transition_probability.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.AggregationTopology","page":"Public API","title":"PowerSystems.AggregationTopology","text":"Represents a geographical region of system components.\n\nAll subtypes must implement the method get_aggregation_topology_accessor.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Bus","page":"Public API","title":"PowerSystems.Bus","text":"Abstract type to represent any type of Bus, AC or DC.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.Topology","page":"Public API","title":"PowerSystems.Topology","text":"Abstract type to represent the structure and interconnectedness of the system\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_aggregation_topology_accessor-Union{Tuple{Type{T}}, Tuple{T}} where T<:AggregationTopology","page":"Public API","title":"PowerSystems.get_aggregation_topology_accessor","text":"get_aggregation_topology_accessor(\n _::Type{T<:AggregationTopology}\n) -> typeof(get_load_zone)\n\n\nReturn the method to be called on a ACBus to get its AggregationTopology value for this type.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.StaticInjection","page":"Public API","title":"PowerSystems.StaticInjection","text":"Abstract type for devices that inject power or current\n\nA static injection is a steady state injection, such as modeling the output power of a generator held constant over a five-minute period.\n\nMany StaticInjection models can accept a DynamicInjection model as an optional add-on for conducting dynamic simulations.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.add_component_to_subsystem!-Tuple{System, AbstractString, Component}","page":"Public API","title":"PowerSystems.add_component_to_subsystem!","text":"add_component_to_subsystem!(\n sys::System,\n subsystem_name::AbstractString,\n component::Component\n)\n\n\nAdd a component to a subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_subsystem!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.add_subsystem!","text":"add_subsystem!(sys::System, subsystem_name::AbstractString)\n\n\nAdd a new subsystem to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_assigned_subsystems-Tuple{System, Component}","page":"Public API","title":"PowerSystems.get_assigned_subsystems","text":"get_assigned_subsystems(\n sys::System,\n component::Component\n) -> Vector\n\n\nReturn a Vector of subsystem names that contain the component.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_num_subsystems-Tuple{System}","page":"Public API","title":"PowerSystems.get_num_subsystems","text":"get_num_subsystems(sys::System) -> Int64\n\n\nReturn the number of subsystems stored in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_subsystem_components-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.get_subsystem_components","text":"get_subsystem_components(\n sys::System,\n subsystem_name::AbstractString\n) -> Base.Generator{Set{Base.UUID}, InfrastructureSystems.var\"#419#420\"{InfrastructureSystems.SystemData}}\n\n\nReturn a Generator of all components in the subsystem.\n\nThrows ArgumentError if the subsystem name is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_subsystems-Tuple{System}","page":"Public API","title":"PowerSystems.get_subsystems","text":"get_subsystems(\n sys::System\n) -> Base.KeySet{String, Dict{String, Set{Base.UUID}}}\n\n\nReturn an iterator of all subsystem names in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_component-Tuple{System, AbstractString, Component}","page":"Public API","title":"PowerSystems.has_component","text":"has_component(\n sys::System,\n subsystem_name::AbstractString,\n component::Component\n) -> Bool\n\n\nReturn true if the component is in the subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_subsystems-Tuple{System}","page":"Public API","title":"PowerSystems.has_subsystems","text":"has_subsystems(sys::System) -> Bool\n\n\nReturn true if the system has one or more subsystems.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.is_assigned_to_subsystem-Tuple{System, Component, AbstractString}","page":"Public API","title":"PowerSystems.is_assigned_to_subsystem","text":"is_assigned_to_subsystem(\n sys::System,\n component::Component,\n subsystem_name::AbstractString\n) -> Bool\n\n\nReturn true if the component is assigned to the subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.is_assigned_to_subsystem-Tuple{System, Component}","page":"Public API","title":"PowerSystems.is_assigned_to_subsystem","text":"is_assigned_to_subsystem(\n sys::System,\n component::Component\n) -> Bool\n\n\nReturn true if the component is assigned to any subsystems.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_component_from_subsystem!-Tuple{System, AbstractString, Component}","page":"Public API","title":"PowerSystems.remove_component_from_subsystem!","text":"remove_component_from_subsystem!(\n sys::System,\n subsystem_name::AbstractString,\n component::Component\n)\n\n\nRemove a component from a subsystem.\n\nThrows ArgumentError if the subsystem name or component is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_subsystem!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.remove_subsystem!","text":"remove_subsystem!(\n sys::System,\n subsystem_name::AbstractString\n)\n\n\nRemove a subsystem from the system.\n\nThrows ArgumentError if the subsystem name is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.StaticInjectionSubsystem","page":"Public API","title":"PowerSystems.StaticInjectionSubsystem","text":"Abstract type for a subsystem that contains multiple instances of StaticInjection\n\nSubtypes must implement:\n\nget_subcomponents(subsystem::StaticInjectionSubsystem)\n\nThe subcomponents in subtypes must be attached to the System as masked components.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.copy_subcomponent_time_series!-Tuple{StaticInjectionSubsystem, Component}","page":"Public API","title":"PowerSystems.copy_subcomponent_time_series!","text":"copy_subcomponent_time_series!(\n subsystem::StaticInjectionSubsystem,\n subcomponent::Component\n)\n\n\nEfficiently add all time series data in the subcomponent to the subsystem by copying the underlying references.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.DynamicComponent","page":"Public API","title":"PowerSystems.DynamicComponent","text":"Abstract type for all components used to compose a DynamicInjection device\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.DynamicInjection","page":"Public API","title":"PowerSystems.DynamicInjection","text":"Abstract type for all Dynamic Devices\n\nA dynamic injection is the continuous time response of a generator, typically modeled with differential equations. \n\nDynamicInjection components can added on to StaticInjection components, which together define all the information needed to model the device in a dynamic simulation.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.get_dynamic_components-Tuple{T} where T<:DynamicInjection","page":"Public API","title":"PowerSystems.get_dynamic_components","text":"get_dynamic_components(\n device::DynamicInjection\n) -> 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})}\n\n\nReturn all the dynamic components of a DynamicInjection device\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_states_types-Tuple{DynamicComponent}","page":"Public API","title":"PowerSystems.get_states_types","text":"get_states_types(d::DynamicComponent) -> Vector{StateTypes}\n\n\nDefault implementation of get_state_types for dynamic components. Assumes all states are\nDifferential\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.OperationalCost","page":"Public API","title":"PowerSystems.OperationalCost","text":"Supertype for operational cost representations\n\nCurrent concrete types include:\n\nThermalGenerationCost\nHydroGenerationCost\nRenewableGenerationCost\nStorageCost\nLoadCost\nMarketBidCost\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_fuel_cost-Tuple{StaticInjection}","page":"Public API","title":"InfrastructureSystems.get_fuel_cost","text":"get_fuel_cost(\n component::StaticInjection;\n start_time,\n len\n) -> Union{Float64, TimeSeries.TimeArray}\n\n\nGet the fuel cost of the component's variable cost, which must be a FuelCurve.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_decremental_initial_input-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_decremental_initial_input","text":"get_decremental_initial_input(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, TimeSeries.TimeArray}\n\n\nRetrieve the decremental_initial_input for a StaticInjection device with a MarketBidCost.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_decremental_offer_curves-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_decremental_offer_curves","text":"get_decremental_offer_curves(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}\n\n\nRetrieve the decremental_offer_curves 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 or Nothing.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_decremental_variable_cost-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_decremental_variable_cost","text":"get_decremental_variable_cost(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}\n\n\nRetrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (decremental_offer_curves, initial_input, no_load_cost) are 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_incremental_initial_input-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_incremental_initial_input","text":"get_incremental_initial_input(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, TimeSeries.TimeArray}\n\n\nRetrieve the incremental_initial_input for a StaticInjection device with a MarketBidCost.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_incremental_offer_curves-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_incremental_offer_curves","text":"get_incremental_offer_curves(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}\n\n\nRetrieve the incremental_offer_curves 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 or Nothing.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_incremental_variable_cost-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_incremental_variable_cost","text":"get_incremental_variable_cost(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}\n\n\nRetrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (incremental_offer_curves, initial_input, no_load_cost) are 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_no_load_cost-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_no_load_cost","text":"get_no_load_cost(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, Float64, TimeSeries.TimeArray}\n\n\nRetrieve 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 or Nothing.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_services_bid-Tuple{StaticInjection, MarketBidCost, Service}","page":"Public API","title":"PowerSystems.get_services_bid","text":"get_services_bid(\n device::StaticInjection,\n cost::MarketBidCost,\n service::Service;\n start_time,\n len\n) -> TimeSeries.TimeArray\n\n\nReturn 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_start_up-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_start_up","text":"get_start_up(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeries.TimeArray}\n\n\nRetrieve the startup 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_variable_cost-Tuple{ReserveDemandCurve}","page":"Public API","title":"PowerSystems.get_variable_cost","text":"get_variable_cost(\n service::ReserveDemandCurve;\n start_time,\n len\n) -> Union{CostCurve{PiecewiseIncrementalCurve}, TimeSeries.TimeArray}\n\n\nRetrieve the variable cost data for a ReserveDemandCurve. The user may specify start_time and len and the function returns a TimeArray of CostCurves.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_variable_cost-Tuple{StaticInjection, MarketBidCost}","page":"Public API","title":"PowerSystems.get_variable_cost","text":"get_variable_cost(\n device::StaticInjection,\n cost::MarketBidCost;\n start_time,\n len\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey, TimeSeries.TimeArray}\n\n\nRetrieve the variable cost bid for a StaticInjection device with a MarketBidCost. If any of the relevant fields (incremental_offer_curves, initial_input, no_load_cost) are 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_decremental_initial_input!-Tuple{System, StaticInjection, Union{Float64, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_decremental_initial_input!","text":"set_decremental_initial_input!(\n sys::System,\n component::StaticInjection,\n data::Union{Float64, TimeSeriesData}\n) -> TimeSeriesKey\n\n\nSet the decremental_initial_input for a StaticInjection device with a MarketBidCost to either a scalar or a time series.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Float64, IS.TimeSeriesData},: the data. If a time series, must be of eltype Float64.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_decremental_variable_cost!-Tuple{System, StaticInjection, Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData}, UnitSystem}","page":"Public API","title":"PowerSystems.set_decremental_variable_cost!","text":"set_decremental_variable_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},\n power_units::UnitSystem\n)\n\n\nSet the decremental variable cost bid for a StaticInjection device with a MarketBidCost.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Nothing, IS.TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}},: the data. If using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.\npower_units::UnitSystem: Units to be used for data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_fuel_cost!-Tuple{System, StaticInjection, Union{Float64, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_fuel_cost!","text":"set_fuel_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Float64, TimeSeriesData}\n) -> Any\n\n\nSet the fuel cost of the component's variable cost, which must be a FuelCurve.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_incremental_initial_input!-Tuple{System, StaticInjection, Union{Float64, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_incremental_initial_input!","text":"set_incremental_initial_input!(\n sys::System,\n component::StaticInjection,\n data::Union{Float64, TimeSeriesData}\n) -> TimeSeriesKey\n\n\nSet the incremental_initial_input for a StaticInjection device with a MarketBidCost to either a scalar or a time series.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Float64, IS.TimeSeriesData},: the data. If a time series, must be of eltype Float64.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_incremental_variable_cost!-Tuple{System, StaticInjection, Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData}, UnitSystem}","page":"Public API","title":"PowerSystems.set_incremental_variable_cost!","text":"set_incremental_variable_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},\n power_units::UnitSystem\n)\n\n\nSet the incremental variable cost bid for a StaticInjection device with a MarketBidCost.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Nothing, IS.TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}},: the data. If using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.\npower_units::UnitSystem: Units to be used for data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_no_load_cost!-Tuple{System, StaticInjection, Union{Float64, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_no_load_cost!","text":"set_no_load_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Float64, TimeSeriesData}\n) -> Union{Float64, TimeSeriesKey}\n\n\nSet the no-load cost for a StaticInjection device with a MarketBidCost to either a scalar or a time series.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Float64, IS.TimeSeriesData},: the data. If a time series, must be of eltype Float64.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_service_bid!-Tuple{System, StaticInjection, Service, TimeSeriesData, UnitSystem}","page":"Public API","title":"PowerSystems.set_service_bid!","text":"set_service_bid!(\n sys::System,\n component::StaticInjection,\n service::Service,\n time_series_data::TimeSeriesData,\n power_units::UnitSystem\n)\n\n\nAdds service bids time-series data to the MarketBidCost.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\nservice::Service,: Service for which the device is eligible to contribute\ntime_series_data::IS.TimeSeriesData: TimeSeriesData\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_start_up!-Tuple{System, StaticInjection, Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_start_up!","text":"set_start_up!(\n sys::System,\n component::StaticInjection,\n data::Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesData}\n) -> Union{@NamedTuple{hot::Float64, warm::Float64, cold::Float64}, TimeSeriesKey}\n\n\nSet the startup cost for a StaticInjection device with a MarketBidCost to either a single StartUpStages or a time series.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{StartUpStages, IS.TimeSeriesData},: the data. If a time series, must be of eltype NTuple{3, Float64}.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_variable_cost!-Tuple{System, ReserveDemandCurve, CostCurve{PiecewiseIncrementalCurve}}","page":"Public API","title":"PowerSystems.set_variable_cost!","text":"set_variable_cost!(\n _::System,\n component::ReserveDemandCurve,\n data::CostCurve{PiecewiseIncrementalCurve}\n) -> CostCurve{PiecewiseIncrementalCurve}\n\n\nAdds fixed energy market bids to the ReserveDemandCurve.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::ReserveDemandCurve: the curve\n`timeseriesdata::CostCurve{PiecewiseIncrementalCurve}\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_variable_cost!-Tuple{System, ReserveDemandCurve, Union{Nothing, TimeSeriesData}}","page":"Public API","title":"PowerSystems.set_variable_cost!","text":"set_variable_cost!(\n sys::System,\n component::ReserveDemandCurve,\n data::Union{Nothing, TimeSeriesData}\n) -> TimeSeriesKey\n\n\nAdds energy market bids time-series to the ReserveDemandCurve.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::ReserveDemandCurve: the curve\ntime_series_data::IS.TimeSeriesData: TimeSeriesData\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_variable_cost!-Tuple{System, StaticInjection, Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData}, UnitSystem}","page":"Public API","title":"PowerSystems.set_variable_cost!","text":"set_variable_cost!(\n sys::System,\n component::StaticInjection,\n data::Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesData},\n power_units::UnitSystem\n)\n\n\nSet the incremental variable cost bid for a StaticInjection device with a MarketBidCost.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\ntime_series_data::Union{Nothing, IS.TimeSeriesData, CostCurve{PiecewiseIncrementalCurve}},: the data. If using a time series, must be of eltype PiecewiseStepData. PiecewiseIncrementalCurve is only accepted for single CostCurve and not accepted for time series data.\npower_units::UnitSystem: Units to be used for data. Must be NATURAL_UNITS.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Operating-Costs","page":"Public API","title":"Operating Costs","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [InfrastructureSystems]\nPages = [\"production_variable_cost_curve.jl\",\n \"cost_aliases.jl\",\n \"value_curve.jl\",\n ]\nOrder = [:type, :function]\nFilter = t -> nameof(t) in names(PowerSystems)","category":"page"},{"location":"api/public/#InfrastructureSystems.CostCurve","page":"Public API","title":"InfrastructureSystems.CostCurve","text":"struct CostCurve{T<:ValueCurve} <: ProductionVariableCostCurve{T<:ValueCurve}\n\nvalue_curve::ValueCurve: The underlying ValueCurve representation of this ProductionVariableCostCurve\npower_units::UnitSystem: (default: natural units (MW)) The units for the x-axis of the curve\nvom_cost::LinearCurve: (default of 0) Additional proportional Variable Operation and Maintenance Cost in /(power_unit h), represented as a LinearCurve\n\nCostCurve(value_curve, power_units, vom_cost)\nCostCurve(; value_curve, power_units, vom_cost)\n\nDirect 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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.FuelCurve","page":"Public API","title":"InfrastructureSystems.FuelCurve","text":"struct FuelCurve{T<:ValueCurve} <: ProductionVariableCostCurve{T<:ValueCurve}\n\nvalue_curve::ValueCurve: The underlying ValueCurve representation of this ProductionVariableCostCurve\npower_units::UnitSystem: (default: natural units (MW)) The units for the x-axis of the curve\nfuel_cost::Union{Float64, TimeSeriesKey}: Either a fixed value for fuel cost or the TimeSeriesKey to a fuel cost time series\nvom_cost::LinearCurve: (default of 0) Additional proportional Variable Operation and Maintenance Cost in /(power_unit h) represented as a LinearCurve\n\nFuelCurve(value_curve, power_units, fuel_cost, vom_cost)\nFuelCurve(value_curve, fuel_cost)\nFuelCurve(value_curve, fuel_cost, vom_cost)\nFuelCurve(value_curve, power_units, fuel_cost)\nFuelCurve(; value_curve, power_units, fuel_cost, vom_cost)\n\nRepresentation 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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_fuel_cost-Tuple{FuelCurve}","page":"Public API","title":"InfrastructureSystems.get_fuel_cost","text":"get_fuel_cost(\n cost::FuelCurve\n) -> Union{Float64, TimeSeriesKey}\n\n\nGet the fuel cost or the name of the fuel cost time series\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_function_data-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_function_data","text":"get_function_data(cost::ProductionVariableCostCurve) -> Any\n\n\nGet the FunctionData representation of this ProductionVariableCostCurve's ValueCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_initial_input-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_initial_input","text":"get_initial_input(\n cost::ProductionVariableCostCurve\n) -> Union{Nothing, Float64}\n\n\nGet the initial_input field of this ProductionVariableCostCurve's ValueCurve (not defined for input-output data)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_power_units-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_power_units","text":"get_power_units(cost::ProductionVariableCostCurve) -> Any\n\n\nGet the units for the x-axis of the curve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_value_curve-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_value_curve","text":"get_value_curve(cost::ProductionVariableCostCurve) -> Any\n\n\nGet the underlying ValueCurve representation of this ProductionVariableCostCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_vom_cost-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.get_vom_cost","text":"get_vom_cost(cost::ProductionVariableCostCurve) -> Any\n\n\nGet the variable operation and maintenance cost in currency/(power_units h)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.is_convex-Tuple{ProductionVariableCostCurve}","page":"Public API","title":"InfrastructureSystems.is_convex","text":"is_convex(cost::ProductionVariableCostCurve) -> Any\n\n\nCalculate the convexity of the underlying data\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.LinearCurve","page":"Public API","title":"InfrastructureSystems.LinearCurve","text":"LinearCurve(proportional_term::Float64)\nLinearCurve(proportional_term::Float64, constant_term::Float64)\n\nA linear input-output curve, representing a constant marginal rate. May have zero no-load cost (i.e., constant average rate) or not.\n\nArguments\n\nproportional_term::Float64: marginal rate\nconstant_term::Float64: optional, cost at zero production, defaults to 0.0\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.PiecewiseAverageCurve","page":"Public API","title":"InfrastructureSystems.PiecewiseAverageCurve","text":"PiecewiseAverageCurve(initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})\n\nA piecewise linear curve specified by average rates between production points. May have nonzero initial value.\n\nArguments\n\ninitial_input::Union{Float64, Nothing}: cost at minimum production point first(x_coords) (NOT at zero production), defines the start of the curve\nx_coords::Vector{Float64}: vector of n production points\nslopes::Vector{Float64}: vector of n-1 average rates/slopes of the curve segments between the points\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.PiecewiseIncrementalCurve","page":"Public API","title":"InfrastructureSystems.PiecewiseIncrementalCurve","text":"PiecewiseIncrementalCurve(initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})\nPiecewiseIncrementalCurve(input_at_zero::Union{Nothing, Float64}, initial_input::Union{Float64, Nothing}, x_coords::Vector{Float64}, slopes::Vector{Float64})\n\nA piecewise linear curve specified by marginal rates (slopes) between production points. May have nonzero initial value.\n\nArguments\n\ninput_at_zero::Union{Nothing, Float64}: (optional, defaults to nothing) cost at zero production, does NOT represent a part of the curve\ninitial_input::Union{Float64, Nothing}: cost at minimum production point first(x_coords) (NOT at zero production), defines the start of the curve\nx_coords::Vector{Float64}: vector of n production points\nslopes::Vector{Float64}: vector of n-1 marginal rates/slopes of the curve segments between the points\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.PiecewisePointCurve","page":"Public API","title":"InfrastructureSystems.PiecewisePointCurve","text":"PiecewisePointCurve(points::Vector{Tuple{Float64, Float64}})\n\nA piecewise linear curve specified by cost values at production points.\n\nArguments\n\npoints::Vector{Tuple{Float64, Float64}} or similar: vector of (production, cost) pairs\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.QuadraticCurve","page":"Public API","title":"InfrastructureSystems.QuadraticCurve","text":"QuadraticCurve(quadratic_term::Float64, proportional_term::Float64, constant_term::Float64)\n\nA quadratic input-output curve, may have nonzero no-load cost.\n\nArguments\n\nquadratic_term::Float64: quadratic term of the curve\nproportional_term::Float64: proportional term of the curve\nconstant_term::Float64: constant term of the curve\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_average_rates-Tuple{PiecewiseAverageCurve}","page":"Public API","title":"InfrastructureSystems.get_average_rates","text":"get_average_rates(\n vc::PiecewiseAverageCurve\n) -> Vector{Float64}\n\n\nGet the average rates that define the PiecewiseAverageCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_constant_term-Tuple{LinearCurve}","page":"Public API","title":"InfrastructureSystems.get_constant_term","text":"get_constant_term(vc::LinearCurve) -> Float64\n\n\nGet the constant term (i.e., intercept) of the LinearCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_constant_term-Tuple{QuadraticCurve}","page":"Public API","title":"InfrastructureSystems.get_constant_term","text":"get_constant_term(vc::QuadraticCurve) -> Float64\n\n\nGet the constant term of the QuadraticCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_points-Tuple{PiecewisePointCurve}","page":"Public API","title":"InfrastructureSystems.get_points","text":"get_points(\n vc::PiecewisePointCurve\n) -> Vector{@NamedTuple{x::Float64, y::Float64}}\n\n\nGet the points that define the PiecewisePointCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_proportional_term-Tuple{LinearCurve}","page":"Public API","title":"InfrastructureSystems.get_proportional_term","text":"get_proportional_term(vc::LinearCurve) -> Float64\n\n\nGet the proportional term (i.e., slope) of the LinearCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_proportional_term-Tuple{QuadraticCurve}","page":"Public API","title":"InfrastructureSystems.get_proportional_term","text":"get_proportional_term(vc::QuadraticCurve) -> Float64\n\n\nGet the proportional (i.e., linear) term of the QuadraticCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_quadratic_term-Tuple{QuadraticCurve}","page":"Public API","title":"InfrastructureSystems.get_quadratic_term","text":"get_quadratic_term(vc::QuadraticCurve) -> Float64\n\n\nGet the quadratic term of the QuadraticCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_slopes-Tuple{PiecewiseIncrementalCurve}","page":"Public API","title":"InfrastructureSystems.get_slopes","text":"get_slopes(vc::PiecewiseIncrementalCurve) -> Vector{Float64}\n\n\nFetch the slopes that define the PiecewiseIncrementalCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_slopes-Tuple{PiecewisePointCurve}","page":"Public API","title":"InfrastructureSystems.get_slopes","text":"get_slopes(vc::PiecewisePointCurve) -> Vector{Float64}\n\n\nCalculate the slopes of the line segments defined by the PiecewisePointCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_x_coords-Tuple{PiecewiseAverageCurve}","page":"Public API","title":"InfrastructureSystems.get_x_coords","text":"get_x_coords(vc::PiecewiseAverageCurve) -> Vector{Float64}\n\n\nGet the x-coordinates that define the PiecewiseAverageCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_x_coords-Tuple{PiecewiseIncrementalCurve}","page":"Public API","title":"InfrastructureSystems.get_x_coords","text":"get_x_coords(\n vc::PiecewiseIncrementalCurve\n) -> Vector{Float64}\n\n\nGet the x-coordinates that define the PiecewiseIncrementalCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_x_coords-Tuple{PiecewisePointCurve}","page":"Public API","title":"InfrastructureSystems.get_x_coords","text":"get_x_coords(vc::PiecewisePointCurve) -> Vector{Float64}\n\n\nGet the x-coordinates of the points that define the PiecewisePointCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_y_coords-Tuple{PiecewisePointCurve}","page":"Public API","title":"InfrastructureSystems.get_y_coords","text":"get_y_coords(vc::PiecewisePointCurve) -> Vector{Float64}\n\n\nGet the y-coordinates of the points that define the PiecewisePointCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.AverageRateCurve","page":"Public API","title":"InfrastructureSystems.AverageRateCurve","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.IncrementalCurve","page":"Public API","title":"InfrastructureSystems.IncrementalCurve","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.InputOutputCurve","page":"Public API","title":"InfrastructureSystems.InputOutputCurve","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.ValueCurve","page":"Public API","title":"InfrastructureSystems.ValueCurve","text":"Supertype that represents a unitless cost curve\n\nConcrete subtypes are:\n\nLinearCurve\nQuadraticCurve\nPiecewisePointCurve\nPiecewiseIncrementalCurve\nPiecewiseAverageCurve\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_function_data-Tuple{ValueCurve}","page":"Public API","title":"InfrastructureSystems.get_function_data","text":"get_function_data(curve::ValueCurve) -> Any\n\n\nGet the underlying FunctionData representation of this ValueCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_initial_input-Tuple{Union{AverageRateCurve, IncrementalCurve}}","page":"Public API","title":"InfrastructureSystems.get_initial_input","text":"get_initial_input(\n curve::Union{AverageRateCurve, IncrementalCurve}\n) -> Union{Nothing, Float64}\n\n\nGet the initial_input field of this ValueCurve (not defined for InputOutputCurve)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_input_at_zero-Tuple{ValueCurve}","page":"Public API","title":"InfrastructureSystems.get_input_at_zero","text":"get_input_at_zero(curve::ValueCurve) -> Any\n\n\nGet the input_at_zero field of this ValueCurve\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.is_convex-Tuple{ValueCurve}","page":"Public API","title":"InfrastructureSystems.is_convex","text":"is_convex(curve::ValueCurve) -> Bool\n\n\nCalculate the convexity of the underlying data\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Time-Series","page":"Public API","title":"Time Series","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [InfrastructureSystems]\nPages = [\"abstract_time_series.jl\",\n \"deterministic.jl\",\n \"deterministic_single_time_series.jl\",\n \"probabilistic.jl\",\n \"scenarios.jl\",\n \"static_time_series.jl\",\n \"single_time_series.jl\",\n \"forecasts.jl\",\n ]\nOrder = [:type, :function]\nFilter = t -> nameof(t) in names(PowerSystems)","category":"page"},{"location":"api/public/#InfrastructureSystems.TimeSeriesData","page":"Public API","title":"InfrastructureSystems.TimeSeriesData","text":"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.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.Deterministic","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"mutable struct Deterministic <: AbstractDeterministic\n name::String\n data::SortedDict\n resolution::Dates.Period\n scaling_factor_multiplier::Union{Nothing, Function}\n internal::InfrastructureSystemsInternal\nend\n\nA deterministic forecast for a particular data field in a Component.\n\nArguments\n\nname::String: user-defined name\ndata::SortedDict: timestamp - scalingfactor\nresolution::Dates.Period: forecast resolution\nscaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.\ninternal::InfrastructureSystemsInternal\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{AbstractString, AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray}}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n name::AbstractString,\n input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray};\n normalization_factor,\n scaling_factor_multiplier\n) -> Deterministic\n\n\nConstruct Deterministic from a Dict of TimeArrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\ntimestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{AbstractString, AbstractString, InfrastructureSystems.InfrastructureSystemsComponent, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n name::AbstractString,\n filename::AbstractString,\n component::InfrastructureSystems.InfrastructureSystemsComponent,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Deterministic\n\n\nConstruct Deterministic from a CSV file. The first column must be a timestamp in DateTime format and the columns the values in the forecast window.\n\nArguments\n\nname::AbstractString: user-defined name\nfilename::AbstractString: name of CSV file containing data\ncomponent::InfrastructureSystemsComponent: component associated with the data\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{AbstractString, InfrastructureSystems.RawTimeSeries, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n name::AbstractString,\n series_data::InfrastructureSystems.RawTimeSeries,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Deterministic\n\n\nConstruct Deterministic from RawTimeSeries.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{Deterministic, AbstractString}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n src::Deterministic,\n name::AbstractString;\n scaling_factor_multiplier\n) -> Deterministic\n\n\nConstruct Deterministic that shares the data from an existing instance.\n\nThis is useful in cases where you want a component to use the same time series data for two different attributes.\n\nExamples\n\nresolution = Dates.Hour(1)\ndata = Dict(\n DateTime(\"2020-01-01T00:00:00\") => ones(24),\n DateTime(\"2020-01-01T01:00:00\") => ones(24),\n)\n# Define a Deterministic for the first attribute\nforecast_max_active_power = Deterministic(\n \"max_active_power\",\n data,\n resolution,\n scaling_factor_multiplier = get_max_active_power,\n)\nadd_time_series!(sys, generator, forecast_max_active_power)\n# Reuse time series for second attribute\nforecast_max_reactive_power = Deterministic(\n forecast_max_active_power,\n \"max_reactive_power\"\n scaling_factor_multiplier = get_max_reactive_power,\n)\nadd_time_series!(sys, generator, forecast_max_reactive_power)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Deterministic-Tuple{Deterministic, Any}","page":"Public API","title":"InfrastructureSystems.Deterministic","text":"Deterministic(\n forecast::Deterministic,\n data\n) -> Deterministic\n\n\nConstruct a new Deterministic from an existing instance and a subset of data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_data-Tuple{Deterministic}","page":"Public API","title":"InfrastructureSystems.get_data","text":"get_data(value::Deterministic) -> DataStructures.SortedDict\n\n\nGet Deterministic data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{Deterministic}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(value::Deterministic) -> String\n\n\nGet Deterministic name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_resolution-Tuple{Deterministic}","page":"Public API","title":"InfrastructureSystems.get_resolution","text":"get_resolution(value::Deterministic) -> Dates.Period\n\n\nGet Deterministic resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.iterate_windows-Tuple{Deterministic}","page":"Public API","title":"InfrastructureSystems.iterate_windows","text":"iterate_windows(\n forecast::Deterministic\n) -> Base.Generator{I, InfrastructureSystems.var\"#105#106\"{Deterministic}} where I<:(DataStructures.SDMKeyIteration{T} where T<:DataStructures.SortedDict)\n\n\nIterate over the windows in a forecast\n\nExamples\n\nfor window in iterate_windows(forecast)\n @show values(maximum(window))\nend\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{Deterministic, Any}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(value::Deterministic, val) -> Any\n\n\nSet Deterministic name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.DeterministicSingleTimeSeries","page":"Public API","title":"InfrastructureSystems.DeterministicSingleTimeSeries","text":"mutable struct DeterministicSingleTimeSeries <: AbstractDeterministic\n single_time_series::SingleTimeSeries\n initial_timestamp::Dates.DateTime\n interval::Dates.Period\n count::Int\n horizon::Int\nend\n\nA deterministic forecast that wraps a SingleTimeSeries\n\nDeterministicSingleTimeSeries behaves exactly like a Deterministic, but instead of storing windows at each initial time it provides a view into the existing SingleTimeSeries at incrementing offsets. This avoids large data duplications when there are the overlapping windows between forecasts. \n\nCan be used as a perfect forecast based on historical data when real forecast data is unavailable. \n\nArguments\n\nsingle_time_series::SingleTimeSeries: wrapped SingleTimeSeries object\ninitial_timestamp::Dates.DateTime: time series availability time\ninterval::Dates.Period: time step between forecast windows\ncount::Int: number of forecast windows\nhorizon::Int: length of this time series\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_horizon-Tuple{DeterministicSingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.get_horizon","text":"get_horizon(\n value::DeterministicSingleTimeSeries\n) -> Dates.Period\n\n\nGet DeterministicSingleTimeSeries horizon.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.iterate_windows-Tuple{DeterministicSingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.iterate_windows","text":"iterate_windows(\n forecast::DeterministicSingleTimeSeries\n) -> Union{Tuple{Any}, Base.Generator{I, InfrastructureSystems.var\"#134#135\"{DeterministicSingleTimeSeries}} where I<:(StepRangeLen{T, R, S, Int64} where {T, R>:Dates.DateTime, S})}\n\n\nIterate over the windows in a forecast\n\nExamples\n\nfor window in iterate_windows(forecast)\n @show values(maximum(window))\nend\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Probabilistic","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"mutable struct Probabilistic <: Forecast\n name::String\n resolution::Dates.Period\n percentiles::Vector{Float64}\n data::SortedDict\n scaling_factor_multiplier::Union{Nothing, Function}\n internal::InfrastructureSystemsInternal\nend\n\nA Probabilistic forecast for a particular data field in a Component.\n\nArguments\n\nname::String: user-defined name\nresolution::Dates.Period: forecast resolution\npercentiles::Vector{Float64}: Percentiles for the probabilistic forecast\ndata::SortedDict: timestamp - scalingfactor\nscaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.\ninternal::InfrastructureSystemsInternal\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.Probabilistic-Tuple{AbstractString, AbstractDict, Vector, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"Probabilistic(\n name::AbstractString,\n input_data::AbstractDict,\n percentiles::Vector,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Probabilistic\n\n\nConstruct Probabilistic from a SortedDict of Arrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, Matrix{Float64}}: time series data.\npercentiles: Percentiles represented in the probabilistic forecast\nresolution::Dates.Period: The resolution of the forecast in Dates.Period`\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Probabilistic-Tuple{AbstractString, AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray}, Vector{Float64}}","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"Probabilistic(\n name::AbstractString,\n input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray},\n percentiles::Vector{Float64};\n normalization_factor,\n scaling_factor_multiplier\n) -> Probabilistic\n\n\nConstruct Probabilistic from a Dict of TimeArrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.\npercentiles: Percentiles represented in the probabilistic forecast\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\ntimestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Probabilistic-Tuple{AbstractString, InfrastructureSystems.RawTimeSeries, Vector, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"Probabilistic(\n name::AbstractString,\n series_data::InfrastructureSystems.RawTimeSeries,\n percentiles::Vector,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Probabilistic\n\n\nConstruct Deterministic from RawTimeSeries.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Probabilistic-Tuple{Probabilistic, AbstractString}","page":"Public API","title":"InfrastructureSystems.Probabilistic","text":"Probabilistic(\n src::Probabilistic,\n name::AbstractString;\n scaling_factor_multiplier\n) -> Probabilistic\n\n\nConstruct a Probabilistic that shares the data from an existing instance.\n\nThis is useful in cases where you want a component to use the same time series data for two different attributes.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_data-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.get_data","text":"get_data(value::Probabilistic) -> DataStructures.SortedDict\n\n\nGet Probabilistic data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(value::Probabilistic) -> String\n\n\nGet Probabilistic name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_percentiles-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.get_percentiles","text":"get_percentiles(value::Probabilistic) -> Vector{Float64}\n\n\nGet Probabilistic percentiles.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_resolution-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.get_resolution","text":"get_resolution(value::Probabilistic) -> Dates.Period\n\n\nGet Probabilistic resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.iterate_windows-Tuple{Probabilistic}","page":"Public API","title":"InfrastructureSystems.iterate_windows","text":"iterate_windows(\n forecast::Probabilistic\n) -> Base.Generator{I, InfrastructureSystems.var\"#105#106\"{Probabilistic}} where I<:(DataStructures.SDMKeyIteration{T} where T<:DataStructures.SortedDict)\n\n\nIterate over the windows in a forecast\n\nExamples\n\nfor window in iterate_windows(forecast)\n @show values(maximum(window))\nend\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{Probabilistic, Any}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(value::Probabilistic, val) -> Any\n\n\nSet Probabilistic name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Scenarios","page":"Public API","title":"InfrastructureSystems.Scenarios","text":"mutable struct Scenarios <: Forecast\n name::String\n resolution::Dates.Period\n scenario_count::Int64\n data::SortedDict\n scaling_factor_multiplier::Union{Nothing, Function}\n internal::InfrastructureSystemsInternal\nend\n\nA Discrete Scenario Based time series for a particular data field in a Component.\n\nArguments\n\nname::String: user-defined name\nresolution::Dates.Period: forecast resolution\nscenario_count::Int64: Number of scenarios\ndata::SortedDict: timestamp - scalingfactor\nscaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.\ninternal::InfrastructureSystemsInternal\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.Scenarios-Tuple{AbstractString, AbstractDict, Dates.Period}","page":"Public API","title":"InfrastructureSystems.Scenarios","text":"Scenarios(\n name::AbstractString,\n input_data::AbstractDict,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> Scenarios\n\n\nConstruct Scenarios from a SortedDict of Arrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, Matrix{Float64}}: time series data.\nresolution::Dates.Period: The resolution of the forecast in Dates.Period`\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Scenarios-Tuple{AbstractString, AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray}}","page":"Public API","title":"InfrastructureSystems.Scenarios","text":"Scenarios(\n name::AbstractString,\n input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray};\n normalization_factor,\n scaling_factor_multiplier\n) -> Scenarios\n\n\nConstruct Scenarios from a Dict of TimeArrays.\n\nArguments\n\nname::AbstractString: user-defined name\ninput_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\ntimestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Scenarios-Tuple{Scenarios, AbstractString}","page":"Public API","title":"InfrastructureSystems.Scenarios","text":"Scenarios(\n src::Scenarios,\n name::AbstractString;\n scaling_factor_multiplier\n) -> Scenarios\n\n\nConstruct Scenarios that shares the data from an existing instance.\n\nThis is useful in cases where you want a component to use the same time series data for two different attributes.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_data-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.get_data","text":"get_data(value::Scenarios) -> DataStructures.SortedDict\n\n\nGet Scenarios data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(value::Scenarios) -> String\n\n\nGet Scenarios name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_resolution-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.get_resolution","text":"get_resolution(value::Scenarios) -> Dates.Period\n\n\nGet Scenarios resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_scenario_count-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.get_scenario_count","text":"get_scenario_count(value::Scenarios) -> Int64\n\n\nGet Scenarios scenario_count.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.iterate_windows-Tuple{Scenarios}","page":"Public API","title":"InfrastructureSystems.iterate_windows","text":"iterate_windows(\n forecast::Scenarios\n) -> Base.Generator{I, InfrastructureSystems.var\"#105#106\"{Scenarios}} where I<:(DataStructures.SDMKeyIteration{T} where T<:DataStructures.SortedDict)\n\n\nIterate over the windows in a forecast\n\nExamples\n\nfor window in iterate_windows(forecast)\n @show values(maximum(window))\nend\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{Scenarios, Any}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(value::Scenarios, val) -> Any\n\n\nSet Scenarios name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.StaticTimeSeries","page":"Public API","title":"InfrastructureSystems.StaticTimeSeries","text":"Supertype for static time series, which has one value per time point\n\nCurrent concrete subtypes are:\n\nSingleTimeSeries\n\nSee also: Forecast\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"mutable struct SingleTimeSeries <: StaticTimeSeries\n name::String\n data::TimeSeries.TimeArray\n scaling_factor_multiplier::Union{Nothing, Function}\n internal::InfrastructureSystemsInternal\nend\n\nA single column of time series data for a particular data field in a Component.\n\nIn contrast with a forecast, this can represent one continual time series, such as a series of historical measurements or realizations or a single scenario (e.g. a weather year or different input assumptions).\n\nArguments\n\nname::String: user-defined name\ndata::TimeSeries.TimeArray: timestamp - scalingfactor\nresolution::Dates.Period: Time duration between steps in the time series. The resolution must be the same throughout the time series\nscaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.\ninternal::InfrastructureSystemsInternal\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{AbstractString, AbstractString, InfrastructureSystems.InfrastructureSystemsComponent, Dates.Period}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n name::AbstractString,\n filename::AbstractString,\n component::InfrastructureSystems.InfrastructureSystemsComponent,\n resolution::Dates.Period;\n normalization_factor,\n scaling_factor_multiplier\n) -> SingleTimeSeries\n\n\nConstruct SingleTimeSeries from a CSV file. The file must have a column that is the name of the component.\n\nArguments\n\nname::AbstractString: user-defined name\nfilename::AbstractString: name of CSV file containing data\ncomponent::InfrastructureSystemsComponent: component associated with the data\nresolution::Dates.Period: resolution of the time series\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{AbstractString, Union{DataFrames.DataFrame, TimeSeries.TimeArray}}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n name::AbstractString,\n data::Union{DataFrames.DataFrame, TimeSeries.TimeArray};\n normalization_factor,\n scaling_factor_multiplier,\n timestamp\n) -> SingleTimeSeries\n\n\nConstruct SingleTimeSeries from a TimeArray or DataFrame.\n\nArguments\n\nname::AbstractString: user-defined name\ndata::Union{TimeSeries.TimeArray, DataFrames.DataFrame}: time series data\nnormalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry\nscaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.\ntimestamp = :timestamp: If a DataFrame is passed then this must be the column name that contains timestamps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{SingleTimeSeries, AbstractString}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n src::SingleTimeSeries,\n name::AbstractString;\n scaling_factor_multiplier\n) -> SingleTimeSeries\n\n\nConstruct SingleTimeSeries that shares the data from an existing instance.\n\nThis is useful in cases where you want a component to use the same time series data for two different attribtues.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{SingleTimeSeries, TimeSeries.TimeArray}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n time_series::SingleTimeSeries,\n data::TimeSeries.TimeArray\n) -> Any\n\n\nCreates a new SingleTimeSeries from an existing instance and a subset of data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.SingleTimeSeries-Tuple{String, Dates.Period, Dates.DateTime, Int64}","page":"Public API","title":"InfrastructureSystems.SingleTimeSeries","text":"SingleTimeSeries(\n name::String,\n resolution::Dates.Period,\n initial_time::Dates.DateTime,\n time_steps::Int64\n) -> SingleTimeSeries\n\n\nConstruct SingleTimeSeries after constructing a TimeArray from initial_time and time_steps.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_data-Tuple{SingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.get_data","text":"get_data(value::SingleTimeSeries) -> TimeSeries.TimeArray\n\n\nGet SingleTimeSeries data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{SingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(value::SingleTimeSeries) -> String\n\n\nGet SingleTimeSeries name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_resolution-Tuple{SingleTimeSeries}","page":"Public API","title":"InfrastructureSystems.get_resolution","text":"get_resolution(value::SingleTimeSeries) -> Dates.Period\n\n\nGet SingleTimeSeries resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{SingleTimeSeries, Any}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(value::SingleTimeSeries, val) -> Any\n\n\nSet SingleTimeSeries name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.Forecast","page":"Public API","title":"InfrastructureSystems.Forecast","text":"Supertype for forecast time series Current concrete subtypes are:\n\nDeterministic\nDeterministicSingleTimeSeries\nScenarios\nProbabilistic\n\nSubtypes of Forecast must implement:\n\nget_horizon_count\nget_initial_times\nget_initial_timestamp\nget_name\nget_scaling_factor_multiplier\nget_window\niterate_windows\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.get_window-Tuple{Forecast, Int64}","page":"Public API","title":"InfrastructureSystems.get_window","text":"get_window(forecast::Forecast, index::Int64; len) -> Any\n\n\nReturn the forecast window corresponsing to interval index.\n\n\n\n\n\n","category":"method"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [InfrastructureSystems]\nPages = [\"time_series_cache.jl\",\n \"time_series_interface.jl\",\n \"time_series_structs.jl\",\n \"time_series_storage.jl\",\n \"time_series_parser.jl\",\n \"utils/print.jl\"]\nOrder = [:type, :function]\nFilter = t -> nameof(t) in names(PowerSystems)","category":"page"},{"location":"api/public/#InfrastructureSystems.ForecastCache-Union{Tuple{T}, Tuple{Type{T}, InfrastructureSystems.InfrastructureSystemsComponent, AbstractString}} where T<:Forecast","page":"Public API","title":"InfrastructureSystems.ForecastCache","text":"Construct ForecastCache to automatically control caching of forecast data. Maintains some count of forecast windows in memory based on cache_size_bytes.\n\nCall Base.iterate or get_next_time_series_array! to retrieve data. Each iteration will return a TimeSeries.TimeArray covering one forecast window of length horizon_count.\n\nArguments\n\n::Type{T}: subtype of Forecast\ncomponent::InfrastructureSystemsComponent: component\nname::AbstractString: forecast name\nstart_time::Union{Nothing, Dates.DateTime} = nothing: forecast start time\nhorizon_count::Union{Nothing, Int} = nothing: forecast horizon count\ncache_size_bytes = TIME_SERIES_CACHE_SIZE_BYTES: maximum size of data to keep in memory\nignore_scaling_factors = false: controls whether to ignore scaling_factor_multiplier in the time series instance\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.StaticTimeSeriesCache-Union{Tuple{T}, Tuple{Type{T}, InfrastructureSystems.InfrastructureSystemsComponent, AbstractString}} where T<:StaticTimeSeries","page":"Public API","title":"InfrastructureSystems.StaticTimeSeriesCache","text":"Construct StaticTimeSeriesCache to automatically control caching of time series data. Maintains rows of data in memory based on cache_size_bytes.\n\nCall Base.iterate or get_time_series_array to retrieve data. Each iteration will return a TimeSeries.TimeArray of size 1.\n\nArguments\n\n::Type{T}: subtype of StaticTimeSeries\ncomponent::InfrastructureSystemsComponent: component\nname::AbstractString: time series name\ncache_size_bytes = TIME_SERIES_CACHE_SIZE_BYTES: maximum size of data to keep in memory\nignore_scaling_factors = false: controls whether to ignore scalingfactormultiplier in the time series instance\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_next_time-Tuple{InfrastructureSystems.TimeSeriesCache}","page":"Public API","title":"InfrastructureSystems.get_next_time","text":"get_next_time(\n cache::InfrastructureSystems.TimeSeriesCache\n) -> Any\n\n\nReturn the timestamp for the next read with get_next_time_series_array!.\n\nReturn nothing if all data has been read.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_next_time_series_array!-Tuple{InfrastructureSystems.TimeSeriesCache}","page":"Public API","title":"InfrastructureSystems.get_next_time_series_array!","text":"get_next_time_series_array!(\n cache::InfrastructureSystems.TimeSeriesCache\n) -> Any\n\n\nReturn the next TimeSeries.TimeArray.\n\nReturns nothing when all data has been read. Call reset! to restart. Call get_next_time to check the start time.\n\nReads from storage if the data is not already in cache.\n\nArguments\n\ncache::StaticTimeSeriesCache: cached instance\n\nExamples\n\ncache = ForecastCache(Deterministic, component, \"max_active_power\")\nwindow1 = get_next_time_series_array!(cache)\nwindow2 = get_next_time_series_array!(cache)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.reset!-Tuple{InfrastructureSystems.TimeSeriesCache}","page":"Public API","title":"InfrastructureSystems.reset!","text":"reset!(cache::InfrastructureSystems.TimeSeriesCache)\n\n\nReset parameters in order to start reading data from the beginning with get_next_time_series_array!\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.copy_time_series!-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}}","page":"Public API","title":"InfrastructureSystems.copy_time_series!","text":"copy_time_series!(\n dst::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n src::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute};\n name_mapping,\n scaling_factor_multiplier_mapping\n)\n\n\nEfficiently add all time_series in one component to another by copying the underlying references.\n\nArguments\n\ndst::TimeSeriesOwners: Destination owner\nsrc::TimeSeriesOwners: Source owner\nname_mapping::Dict = nothing: Optionally map src names to different dst names. If provided and src has a timeseries with a name not present in namemapping, that timeseries will not copied. If namemapping is nothing then all time_series will be copied with src's names.\nscaling_factor_multiplier_mapping::Dict = nothing: Optionally map src multipliers to different dst multipliers. If provided and src has a timeseries with a multiplier not present in scalingfactormultipliermapping, that timeseries will not copied. If scalingfactormultipliermapping is nothing then all time_series will be copied with src's multipliers.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series","page":"Public API","title":"InfrastructureSystems.get_time_series","text":"get_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n key::TimeSeriesKey\n) -> Any\nget_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n key::TimeSeriesKey,\n start_time::Union{Nothing, Dates.DateTime}\n) -> Any\nget_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n key::TimeSeriesKey,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64}\n) -> Any\nget_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n key::TimeSeriesKey,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64},\n count::Union{Nothing, Int64}\n) -> Any\n\n\nReturn the exact stored data in a time series, using a time series key look up\n\nThis will load all forecast windows into memory by default. Be aware of how much data is stored.\n\nSpecify start_time and len if you only need a subset of data.\n\nDoes not apply a scaling factor multiplier.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\nkey::TimeSeriesKey: the time series' key\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If the time series is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length in the time dimension. If nothing, use the entire length.\ncount::Union{Nothing, Int} = nothing: Only applicable to subtypes of Forecast. Number of forecast windows starting at start_time to return. Defaults to all available.\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series by name\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series-Union{Tuple{T}, Tuple{Type{T}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, AbstractString}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.get_time_series","text":"get_time_series(\n ::Type{T<:TimeSeriesData},\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n name::AbstractString;\n start_time,\n len,\n count,\n features...\n) -> Any\n\n\nReturn the exact stored data in a time series\n\nThis will load all forecast windows into memory by default. Be aware of how much data is stored.\n\nSpecify start_time and len if you only need a subset of data.\n\nDoes not apply a scaling factor multiplier.\n\nArguments\n\n::Type{T}: Concrete subtype of TimeSeriesData to return\nowner::TimeSeriesOwners: Component or attribute containing the time series\nname::AbstractString: name of time series\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length in the time dimension. If nothing, use the entire length.\ncount::Union{Nothing, Int} = nothing: Only applicable to subtypes of Forecast. Number of forecast windows starting at start_time to return. Defaults to all available.\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series_array, get_time_series_values, get_time_series by key\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_array","page":"Public API","title":"InfrastructureSystems.get_time_series_array","text":"get_time_series_array(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries;\n ...\n) -> Any\nget_time_series_array(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries,\n start_time::Union{Nothing, Dates.DateTime};\n len,\n ignore_scaling_factors\n) -> Any\n\n\nReturn a TimeSeries.TimeArray from a cached StaticTimeSeries instance.\n\nIf the time series data are scaling factors, the returned data will be scaled by the scaling factor multiplier by default.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\ntime_series::StaticTimeSeries: subtype of StaticTimeSeries (e.g., SingleTimeSeries)\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp to retrieve. If nothing, use the initial_timestamp of the time series.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\n\nSee also: get_time_series_values, get_time_series_timestamps, StaticTimeSeriesCache, get_time_series_array by name from storage, get_time_series_array from a ForecastCache\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_array-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, Forecast, Dates.DateTime}","page":"Public API","title":"InfrastructureSystems.get_time_series_array","text":"get_time_series_array(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n forecast::Forecast,\n start_time::Dates.DateTime;\n len,\n ignore_scaling_factors\n) -> Any\n\n\nReturn a TimeSeries.TimeArray for one forecast window from a cached Forecast instance\n\nIf the time series data are scaling factors, the returned data will be scaled by the scaling factor multiplier by default.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\nforecast::Forecast: a concrete subtype of Forecast\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp of one of the forecast windows\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\n\nSee also get_time_series_values, get_time_series_timestamps, ForecastCache, get_time_series_array by name from storage, get_time_series_array from a StaticTimeSeriesCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_array-Union{Tuple{T}, Tuple{Type{T}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, AbstractString}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.get_time_series_array","text":"get_time_series_array(\n ::Type{T<:TimeSeriesData},\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n name::AbstractString;\n start_time,\n len,\n ignore_scaling_factors,\n features...\n) -> Any\n\n\nReturn a TimeSeries.TimeArray from storage for the given time series parameters.\n\nIf the time series data are scaling factors, the returned data will be scaled by the scaling factor multiplier by default.\n\nThis will load all forecast windows into memory by default. Be aware of how much data is stored.\n\nSpecify start_time and len if you only need a subset of data.\n\nArguments\n\n::Type{T}: the type of time series (a concrete subtype of TimeSeriesData)\nowner::TimeSeriesOwners: Component or attribute containing the time series\nname::AbstractString: name of time series\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series_values, get_time_series_timestamps, get_time_series_array from a StaticTimeSeriesCache, get_time_series_array from a ForecastCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_keys-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}}","page":"Public API","title":"InfrastructureSystems.get_time_series_keys","text":"get_time_series_keys(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}\n) -> Vector\n\n\nReturn information about each time series array attached to the owner. This information can be used to call get_time_series(::TimeSeriesOwners, ::TimeSeriesKey).\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_multiple","page":"Public API","title":"InfrastructureSystems.get_time_series_multiple","text":"get_time_series_multiple(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute};\n ...\n) -> Union{Tuple{}, Channel{Any}}\nget_time_series_multiple(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n filter_func;\n type,\n name\n) -> Union{Tuple{}, Channel{Any}}\n\n\nReturns an iterator of TimeSeriesData instances attached to the component or attribute.\n\nNote that passing a filter function can be much slower than the other filtering parameters because it reads time series data from media.\n\nCall collect on the result to get an array.\n\nArguments\n\nowner::TimeSeriesOwners: component or attribute from which to get time_series\nfilter_func = nothing: Only return time_series for which this returns true.\ntype = nothing: Only return time_series with this type.\nname = nothing: Only return time_series matching this value.\n\nSee also: get_time_series_multiple from a System\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_timestamps","page":"Public API","title":"InfrastructureSystems.get_time_series_timestamps","text":"get_time_series_timestamps(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n forecast::Forecast;\n ...\n)\nget_time_series_timestamps(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n forecast::Forecast,\n start_time::Union{Nothing, Dates.DateTime};\n len\n) -> Vector{D} where D<:Dates.TimeType\n\n\nReturn a vector of timestamps from a cached Forecast instance.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\nforecast::Forecast: a concrete subtype of Forecast\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp of one of the forecast windows\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\n\nSee also: get_time_series_array, get_time_series_values, ForecastCache, get_time_series_timestamps by name from storage, get_time_series_timestamps from a StaticTimeSeriesCache\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_timestamps-2","page":"Public API","title":"InfrastructureSystems.get_time_series_timestamps","text":"get_time_series_timestamps(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries;\n ...\n) -> Vector{D} where D<:Dates.TimeType\nget_time_series_timestamps(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries,\n start_time::Union{Nothing, Dates.DateTime};\n len\n) -> Vector{D} where D<:Dates.TimeType\n\n\nReturn a vector of timestamps from a cached StaticTimeSeries instance.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\ntime_series::StaticTimeSeries: subtype of StaticTimeSeries (e.g., SingleTimeSeries)\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp to retrieve. If nothing, use the initial_timestamp of the time series.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length\n\nSee also: get_time_series_array, get_time_series_values, StaticTimeSeriesCache, get_time_series_timestamps by name from storage, get_time_series_timestamps from a ForecastCache\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_timestamps-Union{Tuple{T}, Tuple{Type{T}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, AbstractString}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.get_time_series_timestamps","text":"get_time_series_timestamps(\n ::Type{T<:TimeSeriesData},\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n name::AbstractString;\n start_time,\n len,\n features...\n) -> Vector{D} where D<:Dates.TimeType\n\n\nReturn a vector of timestamps from storage for the given time series parameters.\n\nArguments\n\n::Type{T}: the type of time series (a concrete subtype of TimeSeriesData)\nowner::TimeSeriesOwners: Component or attribute containing the time series\nname::AbstractString: name of time series\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series_array, get_time_series_values, get_time_series_timestamps from a StaticTimeSeriesCache, get_time_series_timestamps from a ForecastCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_values","page":"Public API","title":"InfrastructureSystems.get_time_series_values","text":"get_time_series_values(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries;\n ...\n) -> Any\nget_time_series_values(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n time_series::StaticTimeSeries,\n start_time::Union{Nothing, Dates.DateTime};\n len,\n ignore_scaling_factors\n) -> Any\n\n\nReturn an vector of timeseries data without timestamps from a cached StaticTimeSeries instance\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\ntime_series::StaticTimeSeries: subtype of StaticTimeSeries (e.g., SingleTimeSeries)\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp to retrieve. If nothing, use the initial_timestamp of the time series.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\n\nSee also: get_time_series_array, get_time_series_timestamps, StaticTimeSeriesCache, get_time_series_values by name from storage, get_time_series_values from a ForecastCache\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.get_time_series_values-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, Forecast, Dates.DateTime}","page":"Public API","title":"InfrastructureSystems.get_time_series_values","text":"get_time_series_values(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n forecast::Forecast,\n start_time::Dates.DateTime;\n len,\n ignore_scaling_factors\n) -> Any\n\n\nReturn an vector of timeseries data without timestamps for one forecast window from a cached Forecast instance.\n\nArguments\n\nowner::TimeSeriesOwners: Component or attribute containing the time series\nforecast::Forecast: a concrete subtype of Forecast\nstart_time::Union{Nothing, Dates.DateTime} = nothing: the first timestamp of one of the forecast windows\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\n\nSee also: get_time_series_array, get_time_series_timestamps, ForecastCache, get_time_series_values by name from storage, get_time_series_values from a StaticTimeSeriesCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_values-Union{Tuple{T}, Tuple{Type{T}, Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, AbstractString}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.get_time_series_values","text":"get_time_series_values(\n ::Type{T<:TimeSeriesData},\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n name::AbstractString;\n start_time,\n len,\n ignore_scaling_factors,\n features...\n) -> Any\n\n\nReturn an vector of timeseries data without timestamps from storage\n\nIf the data size is small and this will be called many times, consider using the version that accepts a cached TimeSeriesData instance.\n\nArguments\n\n::Type{T}: type of the time series (a concrete subtype of TimeSeriesData)\nowner::TimeSeriesOwners: Component or attribute containing the time series\nname::AbstractString: name of time series\nstart_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timestamp of a window.\nlen::Union{Nothing, Int} = nothing: Length of time-series to retrieve (i.e. number of timestamps). If nothing, use the entire length.\nignore_scaling_factors = false: If true, the time-series data will be multiplied by the result of calling the stored scaling_factor_multiplier function on the owner\nfeatures...: User-defined tags that differentiate multiple time series arrays for the same component attribute, such as different arrays for different scenarios or years\n\nSee also: get_time_series_array, get_time_series_timestamps, get_time_series, get_time_series_values from a StaticTimeSeriesCache, get_time_series_values from a ForecastCache\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.has_time_series-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}}","page":"Public API","title":"InfrastructureSystems.has_time_series","text":"has_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}\n) -> Any\n\n\nReturn true if the component or supplemental attribute has time series data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.has_time_series-Union{Tuple{T}, Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}, Type{T}}} where T<:TimeSeriesData","page":"Public API","title":"InfrastructureSystems.has_time_series","text":"has_time_series(\n val::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute},\n _::Type{T<:TimeSeriesData}\n) -> Any\n\n\nReturn true if the component or supplemental attribute has time series data of type T.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.ForecastKey","page":"Public API","title":"InfrastructureSystems.ForecastKey","text":"A unique key to identify and retrieve a Forecast\n\nSee: get_time_series_keys and get_time_series(::TimeSeriesOwners, ::TimeSeriesKey).\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.StaticTimeSeriesKey","page":"Public API","title":"InfrastructureSystems.StaticTimeSeriesKey","text":"A unique key to identify and retrieve a StaticTimeSeries\n\nSee: get_time_series_keys and get_time_series(::TimeSeriesOwners, ::TimeSeriesKey).\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.TimeSeriesAssociation","page":"Public API","title":"InfrastructureSystems.TimeSeriesAssociation","text":"Defines an association between a time series owner (component or supplemental attribute) and the time series metadata.\n\nExamples\n\nassociation1 = TimeSeriesAssociation(component, time_series)\nassociation2 = TimeSeriesAssociation(component, time_series, scenario = \"high\")\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.TimeSeriesCounts","page":"Public API","title":"InfrastructureSystems.TimeSeriesCounts","text":"Provides counts of time series including attachments to components and supplemental attributes.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.TimeSeriesKey","page":"Public API","title":"InfrastructureSystems.TimeSeriesKey","text":"Supertype for keys that can be used to access a desired time series dataset\n\nConcrete subtypes:\n\nStaticTimeSeriesKey\nForecastKey\n\nRequired methods:\n\nget_name\nget_time_series_type\n\nThe default methods rely on the field names name and time_series_type.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.CompressionSettings","page":"Public API","title":"InfrastructureSystems.CompressionSettings","text":"CompressionSettings(enabled, type, level, shuffle)\n\nProvides customization of HDF5 compression settings.\n\nenabled::Bool: Controls whether compression is enabled.\ntype::CompressionTypes: Specifies the type of compression to use.\nlevel::Int64: Supported values are 0-9. Higher values deliver better compression ratios but take longer.\nshuffle::Bool: Controls whether to enable the shuffle filter. Used with DEFLATE.\n\nRefer to the HDF5.jl and HDF5 documentation for more details on the options.\n\nExample\n\nsettings = CompressionSettings(\n enabled = true,\n type = CompressionTypes.DEFLATE, # BLOSC is also supported\n level = 3,\n shuffle = true,\n)\n\n\n\n\n\n","category":"type"},{"location":"api/public/#InfrastructureSystems.show_time_series-Tuple{Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}}","page":"Public API","title":"InfrastructureSystems.show_time_series","text":"show_time_series(\n owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, SupplementalAttribute}\n)\n\n\nShow a table with time series data attached to the component.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#System","page":"Public API","title":"System","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"base.jl\"]\nPublic = true\nPrivate = false\nFilter = t -> t ∈ [System]","category":"page"},{"location":"api/public/#PowerSystems.System","page":"Public API","title":"PowerSystems.System","text":"A power system\n\nSystem is the main data container in PowerSystems.jl, including basic metadata (base power, frequency), components (network topology, loads, generators, and services), and time series data.\n\nSystem(base_power)\nSystem(base_power, buses, components...)\nSystem(base_power, buses, generators, loads, branches, storage, services; kwargs...)\nSystem(base_power, buses, generators, loads; kwargs...)\nSystem(file; kwargs...)\nSystem(; buses, generators, loads, branches, storage, base_power, services, kwargs...)\nSystem(; kwargs...)\n\nArguments\n\nbase_power::Float64: the base power value for the system\nbuses::Vector{ACBus}: an array of buses\ncomponents...: Each element (e.g., buses, generators, ...) must be an iterable containing subtypes of Component.\n\nKeyword arguments\n\next::Dict: Contains user-defined parameters. Should only contain standard types.\nfrequency::Float64: (default = 60.0) Operating frequency (Hz)\nrunchecks::Bool: Run available checks on input fields and when add_component! is called. Throws InvalidValue if an error is found.\ntime_series_in_memory::Bool=false: Store time series data in memory instead of HDF5.\ntime_series_directory::Union{Nothing, String}: Directory for the time series HDF5 file. Defaults to the tmp file system\nenable_compression::Bool=false: Enable compression of time series data in HDF5.\ncompression::CompressionSettings: Allows customization of HDF5 compression settings.\nconfig_path::String: specify path to validation config file\nunit_system::String: (Default = \"SYSTEM_BASE\") Set the unit system for per-unitization while getting and setting data (\"SYSTEM_BASE\", \"DEVICE_BASE\", or \"NATURAL_UNITS\")\n\nBy default, time series data is stored in an HDF5 file in the tmp file system to prevent large datasets from overwhelming system memory (see Data Storage). If the system's time series data will be larger than the amount of tmp space available, use the time_series_directory parameter to change its location. You can also override the location by setting the environment variable SIENNA_TIME_SERIES_DIRECTORY to another directory.\n\nHDF5 compression is not enabled by default, but you can enable it with enable_compression to get significant storage savings at the cost of CPU time. CompressionSettings can be used to customize the HDF5 compression.\n\nIf you know that your dataset will fit in your computer's memory, then you can increase performance by storing it in memory with time_series_in_memory.\n\nExamples\n\nsys = System(100.0; enable_compression = true)\nsys = System(100.0; compression = CompressionSettings(\n enabled = true,\n type = CompressionTypes.DEFLATE, # BLOSC is also supported\n level = 3,\n shuffle = true)\n)\nsys = System(100.0; time_series_in_memory = true)\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.System-Tuple{AbstractString, AbstractString}","page":"Public API","title":"PowerSystems.System","text":"System(\n sys_file::AbstractString,\n dyr_file::AbstractString;\n kwargs...\n) -> Any\n\n\nParse 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\n\nEach dictionary indexed by id contains a vector with 5 of its components:\n\nMachine\nShaft\nAVR\nTurbineGov\nPSS\n\nFiles must be parsed from a .raw file (PTI data format) and a .dyr file.\n\nExamples:\n\nraw_file = \"Example.raw\"\ndyr_file = \"Example.dyr\"\nsys = System(raw_file, dyr_file)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{AbstractString}","page":"Public API","title":"PowerSystems.System","text":"System(\n file_path::AbstractString;\n assign_new_uuids,\n kwargs...\n) -> Any\n\n\nConstructs a System from a file path ending with .m, .RAW, or .json\n\nIf the file is JSON then assignnewuuids = true will generate new UUIDs for the system and all components.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{Any, Number}","page":"Public API","title":"PowerSystems.System","text":"System(\n data,\n base_power::Number;\n internal,\n kwargs...\n) -> System\n\n\nConstruct a System from InfrastructureSystems.SystemData\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{Float64, Vector{ACBus}, Vararg{Any}}","page":"Public API","title":"PowerSystems.System","text":"System(\n base_power::Float64,\n buses::Vector{ACBus},\n components...;\n kwargs...\n) -> System\n\n\nSystem constructor when components are constructed externally.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{Nothing}","page":"Public API","title":"PowerSystems.System","text":"System(\n ::Nothing;\n buses,\n generators,\n loads,\n branches,\n storage,\n base_power,\n services,\n kwargs...\n) -> System\n\n\nConstructs a non-functional System for demo purposes.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.System-Tuple{Number}","page":"Public API","title":"PowerSystems.System","text":"System(base_power::Number; kwargs...) -> System\n\n\nConstruct an empty System. Useful for building a System while parsing raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"base.jl\"]\nPublic = true\nPrivate = false\nFilter = t -> t ∉ [System]","category":"page"},{"location":"api/public/#InfrastructureSystems.from_json-Tuple{Union{IO, String}, Type{System}}","page":"Public API","title":"InfrastructureSystems.from_json","text":"from_json(\n io::Union{IO, String},\n ::Type{System};\n runchecks,\n assign_new_uuids,\n kwargs...\n) -> System\n\n\nIf assignnewuuids = true, generate new UUIDs for the system and all components.\n\nWarning: 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\").\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_name-Tuple{System}","page":"Public API","title":"InfrastructureSystems.get_name","text":"get_name(sys::System) -> Union{Nothing, String}\n\n\nGet the name of the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_supplemental_attribute-Tuple{System, Base.UUID}","page":"Public API","title":"InfrastructureSystems.get_supplemental_attribute","text":"get_supplemental_attribute(\n sys::System,\n uuid::Base.UUID\n) -> SupplementalAttribute\n\n\nReturn the supplemental attribute with the given uuid.\n\nThrows ArgumentError if the attribute is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_supplemental_attributes-Union{Tuple{T}, Tuple{Function, Type{T}, System}} where T<:SupplementalAttribute","page":"Public API","title":"InfrastructureSystems.get_supplemental_attributes","text":"get_supplemental_attributes(\n filter_func::Function,\n _::Type{T<:SupplementalAttribute},\n sys::System\n) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:SupplementalAttribute, I<:(Vector)}\n\n\nReturns an iterator of supplemental attributes. T can be concrete or abstract. Call collect on the result if an array is desired.\n\nExamples\n\niter = get_supplemental_attributes(GeometricDistributionForcedOutage, sys)\niter = get_supplemental_attributes(Outage, sys)\niter = get_supplemental_attributes(x -> get_mean_time_to_recovery(x) == >= 0.5, GeometricDistributionForcedOutage, sys)\noutages = get_supplemental_attributes(GeometricDistributionForcedOutage, sys) do outage\n get_mean_time_to_recovery(x) == >= 0.5\nend\noutages = collect(get_supplemental_attributes(GeometricDistributionForcedOutage, sys))\n\nSee also: iterate_supplemental_attributes\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.get_time_series_multiple-2","page":"Public API","title":"InfrastructureSystems.get_time_series_multiple","text":"get_time_series_multiple(sys::System; ...) -> Channel{Any}\nget_time_series_multiple(\n sys::System,\n filter_func;\n type,\n name\n) -> Channel{Any}\n\n\nReturn an iterator of time series in order of initial time.\n\nNote that passing a filter function can be much slower than the other filtering parameters because it reads time series data from media.\n\nCall collect on the result to get an array.\n\nArguments\n\ndata::SystemData: system\nfilter_func = nothing: Only return time series for which this returns true.\ntype = nothing: Only return time series with this type.\nname = nothing: Only return time series matching this value.\n\nExamples\n\nfor time_series in get_time_series_multiple(sys)\n @show time_series\nend\n\nts = collect(get_time_series_multiple(sys; type = SingleTimeSeries))\n\n\n\n\n\n","category":"function"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{Component, AbstractString}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(\n component::Component,\n name::AbstractString\n) -> AbstractString\n\n\nSet the name of a component.\n\nThrows an exception if the component is attached to a system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{System, AbstractString}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(\n sys::System,\n name::AbstractString\n) -> AbstractString\n\n\nSet the name of the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.set_name!-Tuple{System, Component, AbstractString}","page":"Public API","title":"InfrastructureSystems.set_name!","text":"set_name!(\n sys::System,\n component::Component,\n name::AbstractString\n)\n\n\nSet the name for a component that is attached to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#InfrastructureSystems.to_json-Tuple{System, AbstractString}","page":"Public API","title":"InfrastructureSystems.to_json","text":"to_json(\n sys::System,\n filename::AbstractString;\n user_data,\n pretty,\n force,\n runchecks\n)\n\n\nSerializes a system to a JSON file and saves time series to an HDF5 file.\n\nArguments\n\nsys::System: system\nfilename::AbstractString: filename to write\n\nKeyword arguments\n\nuser_data::Union{Nothing, Dict} = nothing: optional metadata to record\npretty::Bool = false: whether to pretty-print the JSON\nforce::Bool = false: whether to overwrite existing files\ncheck::Bool = false: whether to run system validation checks\n\nRefer to check_component for exceptions thrown if check = true.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_component!-Tuple{System, DynamicInjection, StaticInjection}","page":"Public API","title":"PowerSystems.add_component!","text":"add_component!(\n sys::System,\n dyn_injector::DynamicInjection,\n static_injector::StaticInjection;\n kwargs...\n)\n\n\nAdd a dynamic injector to the system.\n\nA component cannot be added to more than one System. Throws ArgumentError if the name does not match the static_injector name. Throws ArgumentError if the static_injector is not attached to the system.\n\nAll rules for the generic add_component! method also apply.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_component!-Union{Tuple{T}, Tuple{System, T}} where T<:Component","page":"Public API","title":"PowerSystems.add_component!","text":"add_component!(\n sys::System,\n component::Component;\n skip_validation,\n kwargs...\n)\n\n\nAdd a component to the system.\n\nA component cannot be added to more than one System. 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.\n\nExamples\n\nsys = System(100.0)\n\n# Add a single component.\nadd_component!(sys, bus)\n\n# Add many at once.\nbuses = [bus1, bus2, bus3]\ngenerators = [gen1, gen2, gen3]\nforeach(x -> add_component!(sys, x), Iterators.flatten((buses, generators)))\n\nSee also add_components!.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_components!-Tuple{System, Any}","page":"Public API","title":"PowerSystems.add_components!","text":"add_components!(sys::System, components)\n\n\nAdd many components to the system at once.\n\nA component cannot be added to more than one System. 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.\n\nExamples\n\nsys = System(100.0)\n\nbuses = [bus1, bus2, bus3]\ngenerators = [gen1, gen2, gen3]\nadd_components!(sys, Iterators.flatten((buses, generators))\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{Device, Service, System}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(device::Device, service::Service, sys::System)\n\n\nSimilar to add_service! but for Service and Device already stored in the system. Performs validation checks on the device and the system\n\nArguments\n\ndevice::Device: Device\nservice::Service: Service\nsys::System: system\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{System, ConstantReserveGroup, Vector{<:Service}}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(\n sys::System,\n service::ConstantReserveGroup,\n contributing_services::Vector{<:Service};\n skip_validation,\n kwargs...\n)\n\n\nSimilar to add_component! but for ConstantReserveGroup.\n\nArguments\n\nsys::System: system\nservice::ConstantReserveGroup: service to add\ncontributing_services: contributing services to the group\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{System, ConstantReserveGroup}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(\n sys::System,\n service::ConstantReserveGroup;\n skip_validation,\n kwargs...\n)\n\n\nSimilar to add_component! but for ConstantReserveGroup.\n\nArguments\n\nsys::System: system\nservice::ConstantReserveGroup: service to add\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{System, Service, Any}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(\n sys::System,\n service::Service,\n contributing_devices;\n kwargs...\n)\n\n\nSimilar to add_component! but for services.\n\nArguments\n\nsys::System: system\nservice::Service: service to add\ncontributing_devices: Must be an iterable of type Device\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_service!-Tuple{System, Service, Device}","page":"Public API","title":"PowerSystems.add_service!","text":"add_service!(\n sys::System,\n service::Service,\n contributing_device::Device;\n kwargs...\n)\n\n\nSimilar to add_component! but for services.\n\nArguments\n\nsys::System: system\nservice::Service: service to add\ncontributing_device::Device: Valid Device\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_supplemental_attribute!-Tuple{System, Component, SupplementalAttribute}","page":"Public API","title":"PowerSystems.add_supplemental_attribute!","text":"add_supplemental_attribute!(\n sys::System,\n component::Component,\n attribute::SupplementalAttribute\n)\n\n\nAdd a supplemental attribute to the component. The attribute may already be attached to a different component.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_time_series!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.add_time_series!","text":"add_time_series!(\n sys::System,\n metadata_file::AbstractString;\n resolution\n) -> Vector{TimeSeriesKey}\n\n\nAdd time series data from a metadata file or metadata descriptors.\n\nArguments\n\nsys::System: system\nmetadata_file::AbstractString: metadata file for timeseries that includes an array of IS.TimeSeriesFileMetadata instances or a vector.\nresolution::DateTime.Period=nothing: skip time series that don't match this resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_time_series!-Tuple{System, Any, TimeSeriesData}","page":"Public API","title":"PowerSystems.add_time_series!","text":"add_time_series!(\n sys::System,\n components,\n time_series::TimeSeriesData;\n features...\n) -> TimeSeriesKey\n\n\nAdd the same time series data to multiple components.\n\nThis function stores a single copy of the data. Each component will store a reference to that data. 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.\n\nThrows ArgumentError if a component is not stored in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_time_series!-Tuple{System, Component, TimeSeriesData}","page":"Public API","title":"PowerSystems.add_time_series!","text":"add_time_series!(\n sys::System,\n component::Component,\n time_series::TimeSeriesData;\n features...\n) -> TimeSeriesKey\n\n\nAdd time series data to a component.\n\nThrows ArgumentError if the component is not stored in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_time_series!-Tuple{System, Vector{InfrastructureSystems.TimeSeriesFileMetadata}}","page":"Public API","title":"PowerSystems.add_time_series!","text":"add_time_series!(\n sys::System,\n file_metadata::Vector{InfrastructureSystems.TimeSeriesFileMetadata};\n resolution\n) -> Vector{TimeSeriesKey}\n\n\nAdd time series data from a metadata file or metadata descriptors.\n\nArguments\n\nsys::System: system\ntimeseries_metadata::Vector{IS.TimeSeriesFileMetadata}: metadata for timeseries\nresolution::DateTime.Period=nothing: skip time series that don't match this resolution.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.bulk_add_time_series!-Tuple{System, Any}","page":"Public API","title":"PowerSystems.bulk_add_time_series!","text":"bulk_add_time_series!(\n sys::System,\n associations;\n batch_size\n) -> Vector{TimeSeriesKey}\n\n\nAdd many time series in bulk\n\nThis method is advantageous when adding thousands of time series arrays because of the overhead in writing the time series to the underlying storage.\n\nArguments\n\nsys::System: system\nassociations: Iterable of TimeSeriesAssociation instances. Using a Vector is not recommended. Pass a Generator or Iterator to avoid loading all time series data into system memory at once.\nbatch_size::Int: (Default = 100) Number of time series to add per batch.\n\nExamples\n\n# Assumes `read_time_series` will return data appropriate for Deterministic forecasts\n# based on the generator name and the filenames match the component and time series names.\nresolution = Dates.Hour(1)\nassociations = (\n IS.TimeSeriesAssociation(\n gen,\n Deterministic(\n data = read_time_series(get_name(gen) * \".csv\"),\n name = \"get_max_active_power\",\n resolution=resolution),\n )\n for gen in get_components(ThermalStandard, sys)\n)\nbulk_add_time_series!(sys, associations)\n\nSee also: open_time_series_store! to minimize HDF5 file handle overhead if you must add time series arrays one at a time\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check-Tuple{System}","page":"Public API","title":"PowerSystems.check","text":"check(sys::System)\n\n\nCheck system consistency and validity.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_component-Tuple{System, Component}","page":"Public API","title":"PowerSystems.check_component","text":"check_component(sys::System, component::Component)\n\n\nCheck the values of a component.\n\nThrows 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_components-Tuple{System, Any}","page":"Public API","title":"PowerSystems.check_components","text":"check_components(sys::System, components)\n\n\nCheck the values of each component in an iterable of components. See check_component for exceptions thrown.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_components-Tuple{System}","page":"Public API","title":"PowerSystems.check_components","text":"check_components(sys::System; check_masked_components)\n\n\nCheck the values of all components. See check_component for exceptions thrown.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_components-Union{Tuple{T}, Tuple{System, Type{T}}} where T<:Component","page":"Public API","title":"PowerSystems.check_components","text":"check_components(\n sys::System,\n ::Type{T<:Component};\n check_masked_components\n)\n\n\nCheck the values of components of a given abstract or concrete type. See check_component for exceptions thrown.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.check_time_series_consistency-Union{Tuple{T}, Tuple{System, Type{T}}} where T<:TimeSeriesData","page":"Public API","title":"PowerSystems.check_time_series_consistency","text":"check_time_series_consistency(\n sys::System,\n _::Type{T<:TimeSeriesData}\n) -> Union{Nothing, Tuple{Any, Any}}\n\n\nChecks time series in the system for inconsistencies.\n\nFor SingleTimeSeries, returns a Tuple of initial_timestamp and length.\n\nThis is a no-op for subtypes of Forecast because those are already guaranteed to be consistent.\n\nThrows InfrastructureSystems.InvalidValue if any time series is inconsistent.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.clear_components!-Tuple{System}","page":"Public API","title":"PowerSystems.clear_components!","text":"clear_components!(sys::System)\n\n\nRemove all components from the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.clear_ext!-Tuple{System}","page":"Public API","title":"PowerSystems.clear_ext!","text":"clear_ext!(sys::System)\n\n\nClear any value stored in ext.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.clear_time_series!-Tuple{System}","page":"Public API","title":"PowerSystems.clear_time_series!","text":"clear_time_series!(sys::System)\n\n\nClear all time series data from the system.\n\nIf you are storing time series data in an HDF5 file, this will will delete the HDF5 file and create a new one.\n\nSee also: remove_time_series!\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.convert_component!-Tuple{System, Line, Type{MonitoredLine}}","page":"Public API","title":"PowerSystems.convert_component!","text":"convert_component!(\n sys::System,\n line::Line,\n linetype::Type{MonitoredLine};\n kwargs...\n)\n\n\nConverts a Line component to a MonitoredLine component and replaces the original in the system\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.convert_component!-Tuple{System, MonitoredLine, Type{Line}}","page":"Public API","title":"PowerSystems.convert_component!","text":"convert_component!(\n sys::System,\n line::MonitoredLine,\n linetype::Type{Line};\n kwargs...\n)\n\n\nConverts a MonitoredLine component to a Line component and replaces the original in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.convert_component!-Tuple{System, PowerLoad, Type{StandardLoad}}","page":"Public API","title":"PowerSystems.convert_component!","text":"convert_component!(\n sys::System,\n old_load::PowerLoad,\n new_type::Type{StandardLoad};\n kwargs...\n)\n\n\nConverts 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.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.filter_components_by_subsystem!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.filter_components_by_subsystem!","text":"filter_components_by_subsystem!(\n sys::System,\n subsystem::AbstractString;\n runchecks\n)\n\n\nFilter out all components that are not part of the subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.from_subsystem-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.from_subsystem","text":"from_subsystem(\n sys::System,\n subsystem::AbstractString;\n runchecks\n) -> System\n\n\nConstruct a System from a subsystem of an existing system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_aggregation_topology_mapping-Union{Tuple{T}, Tuple{Type{T}, System}} where T<:AggregationTopology","page":"Public API","title":"PowerSystems.get_aggregation_topology_mapping","text":"get_aggregation_topology_mapping(\n _::Type{T<:AggregationTopology},\n sys::System\n) -> Dict{String, Vector{ACBus}}\n\n\nReturn a mapping of AggregationTopology name to vector of buses within it.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_available_components-Union{Tuple{T}, Tuple{Type{T}, System}} where T<:Component","page":"Public API","title":"PowerSystems.get_available_components","text":"get_available_components(\n _::Type{T<:Component},\n sys::System\n) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:Component, I<:(Vector)}\n\n\nGets components availability. Requires type T to have the method get_available implemented.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_base_power-Tuple{System}","page":"Public API","title":"PowerSystems.get_base_power","text":"get_base_power(sys::System) -> Float64\n\n\nReturn the system's base power.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_bus-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.get_bus","text":"get_bus(\n sys::System,\n name::AbstractString\n) -> Union{Nothing, InfrastructureSystems.InfrastructureSystemsComponent}\n\n\nReturn bus with name.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_bus-Tuple{System, Int64}","page":"Public API","title":"PowerSystems.get_bus","text":"get_bus(sys::System, bus_number::Int64) -> Any\n\n\nReturn bus with bus_number.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_bus_numbers-Tuple{System}","page":"Public API","title":"PowerSystems.get_bus_numbers","text":"get_bus_numbers(sys::System) -> Vector{Int64}\n\n\nReturn a sorted vector of bus numbers in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_buses-Tuple{System, AggregationTopology}","page":"Public API","title":"PowerSystems.get_buses","text":"get_buses(\n sys::System,\n aggregator::AggregationTopology\n) -> Vector{ACBus}\n\n\nReturn a vector of buses contained within the AggregationTopology.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_buses-Tuple{System, Set{Int64}}","page":"Public API","title":"PowerSystems.get_buses","text":"get_buses(\n sys::System,\n bus_numbers::Set{Int64}\n) -> Vector{ACBus}\n\n\nReturn all buses values with bus_numbers.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_component-Tuple{System, Base.UUID}","page":"Public API","title":"PowerSystems.get_component","text":"get_component(\n sys::System,\n uuid::Base.UUID\n) -> InfrastructureSystems.InfrastructureSystemsComponent\n\n\nGet the component by UUID.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_component-Union{Tuple{T}, Tuple{Type{T}, System, AbstractString}} where T<:Component","page":"Public API","title":"PowerSystems.get_component","text":"get_component(\n _::Type{T<:Component},\n sys::System,\n name::AbstractString\n) -> Union{Nothing, InfrastructureSystems.InfrastructureSystemsComponent}\n\n\nGet 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.\n\nSee get_components_by_name for abstract types with non-unique names across subtypes.\n\nThrows ArgumentError if T is not a concrete type and there is more than one component with requested name\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_components-Tuple{System, SupplementalAttribute}","page":"Public API","title":"PowerSystems.get_components","text":"get_components(\n sys::System,\n attribute::SupplementalAttribute\n) -> Any\n\n\nReturn a vector of components that are attached to the supplemental attribute.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_components-Union{Tuple{T}, Tuple{Type{T}, System}} where T<:Component","page":"Public API","title":"PowerSystems.get_components","text":"get_components(\n ::Type{T<:Component},\n sys::System;\n subsystem_name\n) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:Component, I<:(Vector)}\n\n\nReturns an iterator of components. T can be concrete or abstract. Call collect on the result if an array is desired.\n\nExamples\n\niter = PowerSystems.get_components(ThermalStandard, sys)\niter = PowerSystems.get_components(Generator, sys)\niter = PowerSystems.get_components(x -> PowerSystems.get_available(x), Generator, sys)\nthermal_gens = get_components(ThermalStandard, sys) do gen\n get_available(gen)\nend\ngenerators = collect(PowerSystems.get_components(Generator, sys))\n\n\nSee also: iterate_components\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_components_by_name-Union{Tuple{T}, Tuple{Type{T}, System, AbstractString}} where T<:Component","page":"Public API","title":"PowerSystems.get_components_by_name","text":"get_components_by_name(\n _::Type{T<:Component},\n sys::System,\n name::AbstractString\n) -> Vector{T} where T<:InfrastructureSystems.InfrastructureSystemsComponent\n\n\nGet the components of abstract type T with name. Note that PowerSystems enforces unique names on each concrete type but not across concrete types.\n\nSee get_component if the concrete type is known.\n\nThrows ArgumentError if T is not an abstract type.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_components_in_aggregation_topology-Union{Tuple{T}, Tuple{Type{T}, System, AggregationTopology}} where T<:StaticInjection","page":"Public API","title":"PowerSystems.get_components_in_aggregation_topology","text":"get_components_in_aggregation_topology(\n _::Type{T<:StaticInjection},\n sys::System,\n aggregator::AggregationTopology\n) -> Vector{T} where T<:StaticInjection\n\n\nReturn a vector of components with buses in the AggregationTopology.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_compression_settings-Tuple{System}","page":"Public API","title":"PowerSystems.get_compression_settings","text":"get_compression_settings(sys::System) -> CompressionSettings\n\n\nReturn the compression settings used for system data such as time series arrays.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_contributing_device_mapping-Tuple{System}","page":"Public API","title":"PowerSystems.get_contributing_device_mapping","text":"get_contributing_device_mapping(\n sys::System\n) -> Dict{@NamedTuple{type::DataType, name::String}, ServiceContributingDevices}\n\n\nReturn an instance of ServiceContributingDevicesMapping.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_contributing_devices-Union{Tuple{T}, Tuple{System, T}} where T<:Service","page":"Public API","title":"PowerSystems.get_contributing_devices","text":"get_contributing_devices(\n sys::System,\n service::Service\n) -> Vector\n\n\nReturn a vector of devices contributing to the service.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_description-Tuple{System}","page":"Public API","title":"PowerSystems.get_description","text":"get_description(sys::System) -> Union{Nothing, String}\n\n\nGet the description of the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_existing_component_types-Tuple{System}","page":"Public API","title":"PowerSystems.get_existing_component_types","text":"get_existing_component_types(\n sys::System\n) -> Vector{DataType}\n\n\nReturn all the component types in the system. It does not return masked components.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_existing_device_types-Tuple{System}","page":"Public API","title":"PowerSystems.get_existing_device_types","text":"get_existing_device_types(sys::System) -> Vector{DataType}\n\n\nReturn all the device types in the system. It does not return component types or masked components.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_ext-Tuple{System}","page":"Public API","title":"PowerSystems.get_ext","text":"get_ext(sys::System) -> Union{Nothing, Dict{String, Any}}\n\n\nReturn a user-modifiable dictionary to store extra information.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_horizon-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_horizon","text":"get_forecast_horizon(sys::System) -> Any\n\n\nReturn the horizon for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_initial_times-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_initial_times","text":"get_forecast_initial_times(\n sys::System\n) -> Union{Vector{Any}, Vector{Dates.DateTime}, StepRangeLen{T, R, S, Int64} where {T, R>:Dates.DateTime, S}}\n\n\nReturn the initial times for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_initial_timestamp-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_initial_timestamp","text":"get_forecast_initial_timestamp(sys::System) -> Any\n\n\nReturn the initial_timestamp for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_interval-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_interval","text":"get_forecast_interval(sys::System) -> Any\n\n\nReturn the interval for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_forecast_window_count-Tuple{System}","page":"Public API","title":"PowerSystems.get_forecast_window_count","text":"get_forecast_window_count(sys::System) -> Any\n\n\nReturn the window count for all forecasts.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_frequency-Tuple{System}","page":"Public API","title":"PowerSystems.get_frequency","text":"get_frequency(sys::System) -> Float64\n\n\nReturn the system's frequency.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_runchecks-Tuple{System}","page":"Public API","title":"PowerSystems.get_runchecks","text":"get_runchecks(sys::System) -> Bool\n\n\nReturn true if checks are enabled on the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_time_series_counts-Tuple{System}","page":"Public API","title":"PowerSystems.get_time_series_counts","text":"get_time_series_counts(sys::System) -> TimeSeriesCounts\n\n\nReturns counts of time series including attachments to components and supplemental attributes.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_time_series_resolutions-Tuple{System}","page":"Public API","title":"PowerSystems.get_time_series_resolutions","text":"get_time_series_resolutions(\n sys::System;\n time_series_type\n) -> Any\n\n\nReturn a sorted Vector of distinct resolutions for all time series of the given type (or all types).\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_units_base-Tuple{System}","page":"Public API","title":"PowerSystems.get_units_base","text":"get_units_base(system::System) -> String\n\n\nGet the system's unit base)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_component-Tuple{System, Type{<:Component}, AbstractString}","page":"Public API","title":"PowerSystems.has_component","text":"has_component(\n sys::System,\n T::Type{<:Component},\n name::AbstractString\n) -> Bool\n\n\nCheck to see if the component of type T with name exists.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.has_component-Tuple{System, Type{<:Component}}","page":"Public API","title":"PowerSystems.has_component","text":"has_component(sys::System, T::Type{<:Component})\n\n\nCheck to see if the component of type T exists.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.is_component_in_aggregation_topology-Union{Tuple{T}, Tuple{Component, T}} where T<:AggregationTopology","page":"Public API","title":"PowerSystems.is_component_in_aggregation_topology","text":"is_component_in_aggregation_topology(\n comp::Component,\n aggregator::AggregationTopology\n) -> Union{Missing, Bool}\n\n\nReturn whether the given component's bus is in the AggregationTopology.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.iterate_components-Tuple{System}","page":"Public API","title":"PowerSystems.iterate_components","text":"iterate_components(\n sys::System\n) -> Base.Iterators.Flatten{Base.Generator{Base.ValueIterator{Dict{DataType, Dict{String, <:InfrastructureSystems.InfrastructureSystemsComponent}}}, InfrastructureSystems.var\"#110#111\"}}\n\n\nIterates over all components.\n\nExamples\n\nfor component in iterate_components(sys)\n @show component\nend\n\nSee also: get_components\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.iterate_supplemental_attributes-Tuple{System}","page":"Public API","title":"PowerSystems.iterate_supplemental_attributes","text":"iterate_supplemental_attributes(\n sys::System\n) -> Base.Iterators.Flatten{Base.Generator{Base.ValueIterator{Dict{DataType, Dict{Base.UUID, <:SupplementalAttribute}}}, InfrastructureSystems.var\"#110#111\"}}\n\n\nIterates over all supplemental_attributes.\n\nExamples\n\nfor supplemental_attribute in iterate_supplemental_attributes(sys)\n @show supplemental_attribute\nend\n\nSee also: get_supplemental_attributes\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.open_time_series_store!","page":"Public API","title":"PowerSystems.open_time_series_store!","text":"open_time_series_store!(\n func::Function,\n sys::System;\n ...\n) -> Any\nopen_time_series_store!(\n func::Function,\n sys::System,\n mode,\n args...;\n kwargs...\n) -> Any\n\n\nOpen the time series store for bulk additions or reads\n\nThis is recommended before calling add_time_series! many times because of the overhead associated with opening and closing an HDF5 file.\n\nThis is not necessary for an in-memory time series store.\n\nExamples\n\n# Assume there is a system with an array of Components and SingleTimeSeries\n# stored in the variables components and single_time_series, respectively\nopen_time_series_store!(sys, \"r+\") do\n for (component, ts) in zip(components, single_time_series)\n add_time_series!(sys, component, ts)\n end\nend\n\nYou can also use this function to make reads faster. Change the mode from \"r+\" to \"r\" to open the file read-only.\n\nSee also: bulk_add_time_series!\n\n\n\n\n\n","category":"function"},{"location":"api/public/#PowerSystems.remove_component!-Union{Tuple{T}, Tuple{System, T}} where T<:Component","page":"Public API","title":"PowerSystems.remove_component!","text":"remove_component!(sys::System, component::Component)\n\n\nRemove a component from the system by its value.\n\nThrows ArgumentError if the component is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_component!-Union{Tuple{T}, Tuple{Type{T}, System, AbstractString}} where T<:Component","page":"Public API","title":"PowerSystems.remove_component!","text":"remove_component!(\n _::Type{T<:Component},\n sys::System,\n name::AbstractString\n)\n\n\nRemove a component from the system by its name.\n\nThrows ArgumentError if the component is not stored.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_supplemental_attribute!-Tuple{System, Component, SupplementalAttribute}","page":"Public API","title":"PowerSystems.remove_supplemental_attribute!","text":"remove_supplemental_attribute!(\n sys::System,\n component::Component,\n attribute::SupplementalAttribute\n)\n\n\nRemove the supplemental attribute from the component. The attribute will be removed from the system if it is not attached to any other component.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_supplemental_attribute!-Tuple{System, SupplementalAttribute}","page":"Public API","title":"PowerSystems.remove_supplemental_attribute!","text":"remove_supplemental_attribute!(\n sys::System,\n attribute::SupplementalAttribute\n)\n\n\nRemove the supplemental attribute from the system and all attached components.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_supplemental_attributes!-Union{Tuple{T}, Tuple{Type{T}, System}} where T<:SupplementalAttribute","page":"Public API","title":"PowerSystems.remove_supplemental_attributes!","text":"remove_supplemental_attributes!(\n _::Type{T<:SupplementalAttribute},\n sys::System\n)\n\n\nRemove all supplemental attributes with the given type from the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_time_series!-Union{Tuple{T}, Tuple{System, Type{T}, Component, String}} where T<:TimeSeriesData","page":"Public API","title":"PowerSystems.remove_time_series!","text":"remove_time_series!(\n sys::System,\n _::Type{T<:TimeSeriesData},\n component::Component,\n name::String\n)\n\n\nRemove the time series data for a component and time series type.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.remove_time_series!-Union{Tuple{T}, Tuple{System, Type{T}}} where T<:TimeSeriesData","page":"Public API","title":"PowerSystems.remove_time_series!","text":"remove_time_series!(sys::System, _::Type{T<:TimeSeriesData})\n\n\nRemove all the time series data for a time series type.\n\nSee also: clear_time_series!\n\nIf you are storing time series data in an HDF5 file, remove_time_series! does not actually free up file space (HDF5 behavior). If you want to remove all or most time series instances then consider using clear_time_series!. It will delete the HDF5 file and create a new one. PowerSystems has plans to automate this type of workflow.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.sanitize_component!-Tuple{Component, System}","page":"Public API","title":"PowerSystems.sanitize_component!","text":"sanitize_component!(component::Component, sys::System)\n\n\nSanitize component values.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_contributing_services!-Tuple{System, ConstantReserveGroup, Vector{<:Service}}","page":"Public API","title":"PowerSystems.set_contributing_services!","text":"set_contributing_services!(\n sys::System,\n service::ConstantReserveGroup,\n val::Vector{<:Service}\n)\n\n\nSet ConstantReserveGroup contributing_services with check\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_description!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.set_description!","text":"set_description!(\n sys::System,\n description::AbstractString\n) -> AbstractString\n\n\nSet the description of the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_runchecks!-Tuple{System, Bool}","page":"Public API","title":"PowerSystems.set_runchecks!","text":"set_runchecks!(sys::System, value::Bool)\n\n\nEnable or disable system checks. Applies to component addition as well as overall system consistency.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.set_units_base_system!-Tuple{System, String}","page":"Public API","title":"PowerSystems.set_units_base_system!","text":"set_units_base_system!(system::System, settings::String)\n\n\nSets the units base for the getter functions on the devices. It modifies the behavior of all getter functions\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.transform_single_time_series!-Tuple{System, Dates.Period, Dates.Period}","page":"Public API","title":"PowerSystems.transform_single_time_series!","text":"transform_single_time_series!(\n sys::System,\n horizon::Dates.Period,\n interval::Dates.Period\n)\n\n\nTransform all instances of SingleTimeSeries in a System to DeterministicSingleTimeSeries\n\nThis can be used to generate a perfect forecast from historical measurements or realizations when actual forecasts are unavailable, without unnecessarily duplicating data.\n\nIf all SingleTimeSeries instances cannot be transformed then none will be.\n\nAny existing DeterministicSingleTimeSeries forecasts will be deleted even if the inputs are invalid.\n\nArguments\n\nsys::System: System containing the components.\nhorizon::Dates.Period: desired horizon of each forecast window\ninterval::Dates.Period: desired interval between forecast windows\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.validate_component-Tuple{Component}","page":"Public API","title":"PowerSystems.validate_component","text":"validate_component(component::Component) -> Bool\n\n\nValidate the component fields using only those fields. Refer to validate_component_with_system to use other System data for the validation.\n\nReturn true if the instance is valid.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.validate_component_with_system-Tuple{Component, System}","page":"Public API","title":"PowerSystems.validate_component_with_system","text":"validate_component_with_system(\n component::Component,\n sys::System\n) -> Bool\n\n\nValidate a component against System data. Return true if the instance is valid.\n\nRefer to validate_component if the validation logic only requires data contained within the instance.\n\n\n\n\n\n","category":"method"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"utils/print.jl\",\n \"utils/generate_struct_files.jl\"]\nPublic = true\nPrivate = false\nFilter = t -> t ∉ [System]","category":"page"},{"location":"api/public/#InfrastructureSystems.show_time_series-Tuple{System}","page":"Public API","title":"InfrastructureSystems.show_time_series","text":"show_time_series(sys::System)\n\n\nShow a table with the summary of time series attached to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.show_components","page":"Public API","title":"PowerSystems.show_components","text":"show_components(\n sys::System,\n component_type::Type{<:Component};\n ...\n)\nshow_components(\n sys::System,\n component_type::Type{<:Component},\n additional_columns::Union{Dict, Vector};\n kwargs...\n)\n\n\nShow all components of the given type in a table.\n\nArguments\n\nsys::System: System containing the components.\ncomponent_type::Type{<:Component}: Type to display. Must be a concrete type.\nadditional_columns::Union{Dict, Vector}: Additional columns to display. The Dict option is a mapping of column name to function. The function must accept a component. The Vector option is an array of field names for the component_type.\n\nExtra keyword arguments are forwarded to PrettyTables.pretty_table.\n\nExamples\n\nshow_components(sys, ThermalStandard)\nshow_components(sys, ThermalStandard, Dict(\"has_time_series\" => x -> has_time_series(x)))\nshow_components(sys, ThermalStandard, [:active_power, :reactive_power])\n\n\n\n\n\n","category":"function"},{"location":"api/public/#PowerSystems.generate_struct_file-Tuple{StructDefinition}","page":"Public API","title":"PowerSystems.generate_struct_file","text":"generate_struct_file(\n definition::StructDefinition;\n filename,\n output_directory\n)\n\n\nGenerate a Julia source code file for one struct from a StructDefinition.\n\nRefer to StructDefinition and StructField for descriptions of the available fields.\n\nArguments\n\ndefinition::StructDefinition: Defines the struct and all fields.\nfilename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json\noutput_directory::AbstractString: Generate the files in this directory. Defaults to src/models/generated\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.generate_struct_files-Tuple{Any}","page":"Public API","title":"PowerSystems.generate_struct_files","text":"generate_struct_files(\n definitions;\n filename,\n output_directory\n)\n\n\nGenerate Julia source code files for multiple structs from a iterable of StructDefinition instances.\n\nRefer to StructDefinition and StructField for descriptions of the available fields.\n\nArguments\n\ndefinitions: Defines the structs and all fields.\nfilename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json\noutput_directory::AbstractString: Generate the files in this directory. Defaults to src/models/generated\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Additional-Component-Methods","page":"Public API","title":"Additional Component Methods","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"supplemental_accessors.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"api/public/#PowerSystems.get_max_active_power-Tuple{T} where T<:Device","page":"Public API","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(d::Device) -> Any\n\n\nReturn the max active power for a device from getactivepower_limits.max\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_max_reactive_power-Tuple{RenewableDispatch}","page":"Public API","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(d::RenewableDispatch) -> Any\n\n\nReturn the max reactive power for the Renewable Generation calculated as the rating * powerfactor if reactivepower_limits is nothing\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.get_max_reactive_power-Tuple{T} where T<:Device","page":"Public API","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(d::Device) -> Any\n\n\nReturn the max reactive power for a device from getreactivepower_limits.max\n\n\n\n\n\n","category":"method"},{"location":"api/public/#Parsing","page":"Public API","title":"Parsing","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"parsers/power_system_table_data.jl\",\n \"parsers/power_models_data.jl\",\n \"parsers/TAMU_data.jl\",\n \"parsers/psse_dynamic_data.jl\",\n \"parsers/pm_io/common.jl\"]\nPublic = true\nPrivate = false\nFilter = t -> t ∉ [System]","category":"page"},{"location":"api/public/#PowerSystems.PowerSystemTableData-Tuple{AbstractString, Float64, AbstractString}","page":"Public API","title":"PowerSystems.PowerSystemTableData","text":"PowerSystemTableData(\n directory::AbstractString,\n base_power::Float64,\n user_descriptor_file::AbstractString;\n descriptor_file,\n generator_mapping_file,\n timeseries_metadata_file\n) -> PowerSystemTableData\n\n\nReads in all the data stored in csv files The general format for data is folder: gen.csv branch.csv bus.csv .. load.csv\n\nArguments\n\ndirectory::AbstractString: directory containing CSV files\nbase_power::Float64: base power for System\nuser_descriptor_file::AbstractString: customized input descriptor file\ndescriptor_file=POWER_SYSTEM_DESCRIPTOR_FILE: PowerSystems descriptor file\ngenerator_mapping_file=GENERATOR_MAPPING_FILE: generator mapping configuration file\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.create_poly_cost-Tuple{Any, Any}","page":"Public API","title":"PowerSystems.create_poly_cost","text":"create_poly_cost(\n gen,\n cost_colnames\n) -> Union{Tuple{LinearCurve, Float64}, Tuple{QuadraticCurve, Float64}}\n\n\ncreate_poly_cost(gen, cost_colnames)\n\nReturn a Polynomial function cost based on the coeffiecients provided on gen.\n\nThree supported cases,\n\nIf three values are passed then we have data looking like: a2 * x^2 + a1 * x + a0,\nIf a1 and a0 are passed then we have data looking like: a1 * x + a0,\nIf only a1 is passed then we have data looking like: a1 * x.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.PowerModelsData","page":"Public API","title":"PowerSystems.PowerModelsData","text":"Container for data parsed by PowerModels\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerSystems.PowerModelsData-Tuple{Union{IO, String}}","page":"Public API","title":"PowerSystems.PowerModelsData","text":"PowerModelsData(\n file::Union{IO, String};\n kwargs...\n) -> PowerModelsData\n\n\nConstructs PowerModelsData from a raw file. Currently Supports MATPOWER and PSSE data files parsed by PowerModels.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.TamuSystem-Tuple{AbstractString}","page":"Public API","title":"PowerSystems.TamuSystem","text":"TamuSystem(tamu_folder::AbstractString; kwargs...) -> Any\n\n\nCreates 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\n\nThe general format for data is folder: [casename].raw [casename]loadtimeseriesMW.csv\n\nArguments\n\ndirectory::AbstractString: directory containing RAW and CSV files\n\nExamples\n\nsys = TamuSystem(\n \"./ACTIVSg25k\",\n config_path = \"ACTIVSg25k_validation.json\",\n bus_name_formatter = x->string(x[\"name\"]*\"-\"*string(x[\"index\"])),\n load_name_formatter = x->strip(join(x[\"source_id\"], \"_\"))\n)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.add_dyn_injectors!-Tuple{System, AbstractString}","page":"Public API","title":"PowerSystems.add_dyn_injectors!","text":"add_dyn_injectors!(sys::System, dyr_file::AbstractString)\n\n\nAdd to a system already created the dynamic components. The system should already be parsed from a .raw file.\n\nExamples:\n\ndyr_file = \"Example.dyr\"\nadd_dyn_injectors!(sys, dyr_file)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.parse_file-Tuple{IO}","page":"Public API","title":"PowerSystems.parse_file","text":"parse_file(\n io::IO;\n import_all,\n validate,\n correct_branch_rating,\n filetype\n) -> Any\n\n\nParses the iostream from a file\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerSystems.parse_file-Tuple{String}","page":"Public API","title":"PowerSystems.parse_file","text":"parse_file(\n file::String;\n import_all,\n validate,\n correct_branch_rating\n) -> Any\n\n\nparse_file(\n file;\n import_all = false,\n validate = true,\n correct_branch_rating = true,\n)\n\nParses a Matpower .m file or PTI (PSS(R)E-v33) .raw file into a PowerModels data structure. All fields from PTI files will be imported if import_all is true (Default: false).\n\n\n\n\n\n","category":"method"},{"location":"api/public/#logging","page":"Public API","title":"Logging","text":"","category":"section"},{"location":"api/public/","page":"Public API","title":"Public API","text":"Modules = [PowerSystems]\nPages = [\"utils/logging.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"api/public/#PowerSystems.configure_logging-Tuple{}","page":"Public API","title":"PowerSystems.configure_logging","text":"configure_logging(\n;\n console_level,\n file_level,\n filename\n) -> MultiLogger\n\n\nCreates console and file loggers.\n\nNote: Log messages may not be written to the file until flush() or close() is called on the returned logger.\n\nArguments\n\nconsole_level = Logging.Error: level for console messages\nfile_level = Logging.Info: level for file messages\nfilename::Union{Nothing, AbstractString} = \"power-systems.log\": log file; pass nothing to disable file logging\n\nExample\n\nlogger = configure_logging(console_level = Logging.Info)\n@info \"log message\"\nclose(logger)\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#TwoTerminalHVDCDetailedLine","page":"TwoTerminalHVDCDetailedLine","title":"TwoTerminalHVDCDetailedLine","text":"","category":"section"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/","page":"TwoTerminalHVDCDetailedLine","title":"TwoTerminalHVDCDetailedLine","text":"Modules = [PowerSystems]\nPages = [\"generated/TwoTerminalHVDCDetailedLine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.TwoTerminalHVDCDetailedLine","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.TwoTerminalHVDCDetailedLine","text":"mutable struct TwoTerminalHVDCDetailedLine <: ACBranch\n name::String\n available::Bool\n active_power_flow::Float64\n rating::Float64\n active_power_limits_from::MinMax\n active_power_limits_to::MinMax\n arc::Arc\n converter_loss::Union{LinearCurve, QuadraticCurve}\n dc_current::Float64\n max_dc_current::Float64\n g::Float64\n voltage_limits::MinMax\n services::Vector{Service}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA High Voltage DC line, which must be connected to an ACBus on each end.\n\nThis model is appropriate for operational simulations with a linearized DC power flow approximation with losses using a voltage-current model. For modeling a DC network, see TModelHVDCLine\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow::Float64: Initial condition of active power flowing from the from-bus to the to-bus in DC.\nrating::Float64: Maximum output power rating of the converter (MVA), validation range: (0, nothing)\nactive_power_limits_from::MinMax: Minimum and maximum active power flows to the FROM node (MW)\nactive_power_limits_to::MinMax: Minimum and maximum active power flows to the TO node (MW)\narc::Arc: An Arc defining this line from a bus to another bus\nconverter_loss::Union{LinearCurve, QuadraticCurve}: (default: LinearCurve(0.0)) Loss model coefficients. It accepts a linear model or quadratic. Same converter data is used in both ends.\ndc_current::Float64: (default: 0.0) DC current (A) on the converter on the from-bus DC side.\nmax_dc_current::Float64: (default: 1e8) Maximum stable dc current limits (A). Includes converter and DC line.\ng::Float64: (default: 0.0) Series conductance of the DC line in pu (SYSTEM_BASE)\nvoltage_limits::MinMax: (default: (min=0.0, max=999.9)) Limits on the Voltage at the DC Bus.\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#InfrastructureSystems.get_name-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"InfrastructureSystems.get_name","text":"get_name(value::TwoTerminalHVDCDetailedLine) -> String\n\n\nGet TwoTerminalHVDCDetailedLine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_active_power_flow-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_active_power_flow","text":"get_active_power_flow(\n value::TwoTerminalHVDCDetailedLine\n) -> Any\n\n\nGet TwoTerminalHVDCDetailedLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_active_power_limits_from-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_active_power_limits_from","text":"get_active_power_limits_from(\n value::TwoTerminalHVDCDetailedLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCDetailedLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_active_power_limits_to-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_active_power_limits_to","text":"get_active_power_limits_to(\n value::TwoTerminalHVDCDetailedLine\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TwoTerminalHVDCDetailedLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_arc-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_arc","text":"get_arc(value::TwoTerminalHVDCDetailedLine) -> Arc\n\n\nGet TwoTerminalHVDCDetailedLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_available-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_available","text":"get_available(value::TwoTerminalHVDCDetailedLine) -> Bool\n\n\nGet TwoTerminalHVDCDetailedLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_converter_loss-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_converter_loss","text":"get_converter_loss(\n value::TwoTerminalHVDCDetailedLine\n) -> Union{LinearCurve, QuadraticCurve}\n\n\nGet TwoTerminalHVDCDetailedLine converter_loss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_dc_current-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_dc_current","text":"get_dc_current(\n value::TwoTerminalHVDCDetailedLine\n) -> Float64\n\n\nGet TwoTerminalHVDCDetailedLine dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_ext-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_ext","text":"get_ext(\n value::TwoTerminalHVDCDetailedLine\n) -> Dict{String, Any}\n\n\nGet TwoTerminalHVDCDetailedLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_g-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_g","text":"get_g(value::TwoTerminalHVDCDetailedLine) -> Float64\n\n\nGet TwoTerminalHVDCDetailedLine g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_max_dc_current-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_max_dc_current","text":"get_max_dc_current(\n value::TwoTerminalHVDCDetailedLine\n) -> Float64\n\n\nGet TwoTerminalHVDCDetailedLine max_dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_rating-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_rating","text":"get_rating(value::TwoTerminalHVDCDetailedLine) -> Any\n\n\nGet TwoTerminalHVDCDetailedLine rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_services-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_services","text":"get_services(\n value::TwoTerminalHVDCDetailedLine\n) -> Vector{Service}\n\n\nGet TwoTerminalHVDCDetailedLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.get_voltage_limits-Tuple{TwoTerminalHVDCDetailedLine}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.get_voltage_limits","text":"get_voltage_limits(\n value::TwoTerminalHVDCDetailedLine\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet TwoTerminalHVDCDetailedLine voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_active_power_flow!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_active_power_flow!","text":"set_active_power_flow!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine active_power_flow.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_active_power_limits_from!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_active_power_limits_from!","text":"set_active_power_limits_from!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine active_power_limits_from.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_active_power_limits_to!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_active_power_limits_to!","text":"set_active_power_limits_to!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine active_power_limits_to.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_arc!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_arc!","text":"set_arc!(value::TwoTerminalHVDCDetailedLine, val) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine arc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_available!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_available!","text":"set_available!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_converter_loss!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_converter_loss!","text":"set_converter_loss!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine converter_loss.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_dc_current!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_dc_current!","text":"set_dc_current!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_ext!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_ext!","text":"set_ext!(value::TwoTerminalHVDCDetailedLine, val) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_g!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_g!","text":"set_g!(value::TwoTerminalHVDCDetailedLine, val) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_max_dc_current!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_max_dc_current!","text":"set_max_dc_current!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine max_dc_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_rating!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_rating!","text":"set_rating!(value::TwoTerminalHVDCDetailedLine, val) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine rating.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_services!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_services!","text":"set_services!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TwoTerminalHVDCDetailedLine/#PowerSystems.set_voltage_limits!-Tuple{TwoTerminalHVDCDetailedLine, Any}","page":"TwoTerminalHVDCDetailedLine","title":"PowerSystems.set_voltage_limits!","text":"set_voltage_limits!(\n value::TwoTerminalHVDCDetailedLine,\n val\n) -> Any\n\n\nSet TwoTerminalHVDCDetailedLine voltage_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#Reserves","page":"Reserves","title":"Reserves","text":"","category":"section"},{"location":"model_library/reserves/#Constant-Reserve","page":"Reserves","title":"Constant Reserve","text":"","category":"section"},{"location":"model_library/reserves/","page":"Reserves","title":"Reserves","text":"Modules = [PowerSystems]\nPages = [\"generated/ConstantReserve.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/reserves/#PowerSystems.ConstantReserve","page":"Reserves","title":"PowerSystems.ConstantReserve","text":"mutable struct ConstantReserve{T <: ReserveDirection} <: Reserve{T}\n name::String\n available::Bool\n time_frame::Float64\n requirement::Float64\n sustained_time::Float64\n max_output_fraction::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA reserve product with a constant procurement requirement, such as 3% of the system base power at all times.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)\nrequirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)\nsustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/reserves/#InfrastructureSystems.get_name-Tuple{ConstantReserve}","page":"Reserves","title":"InfrastructureSystems.get_name","text":"get_name(value::ConstantReserve) -> String\n\n\nGet ConstantReserve name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_available-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_available","text":"get_available(value::ConstantReserve) -> Bool\n\n\nGet ConstantReserve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_deployed_fraction-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(value::ConstantReserve) -> Float64\n\n\nGet ConstantReserve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_ext-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_ext","text":"get_ext(value::ConstantReserve) -> Dict{String, Any}\n\n\nGet ConstantReserve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_output_fraction-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_max_output_fraction","text":"get_max_output_fraction(value::ConstantReserve) -> Float64\n\n\nGet ConstantReserve max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_participation_factor-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::ConstantReserve\n) -> Float64\n\n\nGet ConstantReserve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_requirement-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_requirement","text":"get_requirement(value::ConstantReserve) -> Any\n\n\nGet ConstantReserve requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_sustained_time-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(value::ConstantReserve) -> Float64\n\n\nGet ConstantReserve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_time_frame-Tuple{ConstantReserve}","page":"Reserves","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::ConstantReserve) -> Float64\n\n\nGet ConstantReserve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_available!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_available!","text":"set_available!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_deployed_fraction!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_ext!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_ext!","text":"set_ext!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_output_fraction!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_max_output_fraction!","text":"set_max_output_fraction!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_participation_factor!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::ConstantReserve,\n val\n) -> Any\n\n\nSet ConstantReserve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_requirement!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_requirement!","text":"set_requirement!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_sustained_time!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_time_frame!-Tuple{ConstantReserve, Any}","page":"Reserves","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(value::ConstantReserve, val) -> Any\n\n\nSet ConstantReserve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#Constant-Reserve-Group","page":"Reserves","title":"Constant Reserve Group","text":"","category":"section"},{"location":"model_library/reserves/","page":"Reserves","title":"Reserves","text":"Modules = [PowerSystems]\nPages = [\"generated/ConstantReserveGroup.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/reserves/#PowerSystems.ConstantReserveGroup","page":"Reserves","title":"PowerSystems.ConstantReserveGroup","text":"mutable struct ConstantReserveGroup{T <: ReserveDirection} <: Service\n name::String\n available::Bool\n requirement::Float64\n ext::Dict{String, Any}\n contributing_services::Vector{Service}\n internal::InfrastructureSystemsInternal\nend\n\nA reserve product met by a group of individual reserves.\n\nThe 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.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nrequirement::Float64: the value of required reserves in p.u. (SYSTEM_BASE), validation range: (0, nothing)\next::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.\ncontributing_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\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/reserves/#InfrastructureSystems.get_name-Tuple{ConstantReserveGroup}","page":"Reserves","title":"InfrastructureSystems.get_name","text":"get_name(value::ConstantReserveGroup) -> String\n\n\nGet ConstantReserveGroup name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_available-Tuple{ConstantReserveGroup}","page":"Reserves","title":"PowerSystems.get_available","text":"get_available(value::ConstantReserveGroup) -> Bool\n\n\nGet ConstantReserveGroup available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_contributing_services-Tuple{ConstantReserveGroup}","page":"Reserves","title":"PowerSystems.get_contributing_services","text":"get_contributing_services(\n value::ConstantReserveGroup\n) -> Vector{Service}\n\n\nGet ConstantReserveGroup contributing_services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_ext-Tuple{ConstantReserveGroup}","page":"Reserves","title":"PowerSystems.get_ext","text":"get_ext(value::ConstantReserveGroup) -> Dict{String, Any}\n\n\nGet ConstantReserveGroup ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_requirement-Tuple{ConstantReserveGroup}","page":"Reserves","title":"PowerSystems.get_requirement","text":"get_requirement(value::ConstantReserveGroup) -> Any\n\n\nGet ConstantReserveGroup requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_available!-Tuple{ConstantReserveGroup, Any}","page":"Reserves","title":"PowerSystems.set_available!","text":"set_available!(value::ConstantReserveGroup, val) -> Any\n\n\nSet ConstantReserveGroup available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_ext!-Tuple{ConstantReserveGroup, Any}","page":"Reserves","title":"PowerSystems.set_ext!","text":"set_ext!(value::ConstantReserveGroup, val) -> Any\n\n\nSet ConstantReserveGroup ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_requirement!-Tuple{ConstantReserveGroup, Any}","page":"Reserves","title":"PowerSystems.set_requirement!","text":"set_requirement!(value::ConstantReserveGroup, val) -> Any\n\n\nSet ConstantReserveGroup requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#Variable-Reserve","page":"Reserves","title":"Variable Reserve","text":"","category":"section"},{"location":"model_library/reserves/","page":"Reserves","title":"Reserves","text":"Modules = [PowerSystems]\nPages = [\"generated/VariableReserve.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/reserves/#PowerSystems.VariableReserve","page":"Reserves","title":"PowerSystems.VariableReserve","text":"mutable struct VariableReserve{T <: ReserveDirection} <: Reserve{T}\n name::String\n available::Bool\n time_frame::Float64\n requirement::Float64\n sustained_time::Float64\n max_output_fraction::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA reserve product with a time-varying procurement requirement, such as a higher requirement during hours with an expected high load or high ramp.\n\nThis 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)\nrequirement::Float64: the required quantity of the product should be scaled by a TimeSeriesData\nsustained_time::Float64: (default: 3600.0) the time in seconds reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/reserves/#InfrastructureSystems.get_name-Tuple{VariableReserve}","page":"Reserves","title":"InfrastructureSystems.get_name","text":"get_name(value::VariableReserve) -> String\n\n\nGet VariableReserve name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_available-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_available","text":"get_available(value::VariableReserve) -> Bool\n\n\nGet VariableReserve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_deployed_fraction-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(value::VariableReserve) -> Float64\n\n\nGet VariableReserve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_ext-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_ext","text":"get_ext(value::VariableReserve) -> Dict{String, Any}\n\n\nGet VariableReserve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_output_fraction-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_max_output_fraction","text":"get_max_output_fraction(value::VariableReserve) -> Float64\n\n\nGet VariableReserve max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_participation_factor-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::VariableReserve\n) -> Float64\n\n\nGet VariableReserve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_requirement-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_requirement","text":"get_requirement(value::VariableReserve) -> Float64\n\n\nGet VariableReserve requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_sustained_time-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(value::VariableReserve) -> Float64\n\n\nGet VariableReserve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_time_frame-Tuple{VariableReserve}","page":"Reserves","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::VariableReserve) -> Float64\n\n\nGet VariableReserve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_available!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_available!","text":"set_available!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_deployed_fraction!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_ext!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_ext!","text":"set_ext!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_output_fraction!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_max_output_fraction!","text":"set_max_output_fraction!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve max_output_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_participation_factor!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::VariableReserve,\n val\n) -> Any\n\n\nSet VariableReserve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_requirement!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_requirement!","text":"set_requirement!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve requirement.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_sustained_time!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_time_frame!-Tuple{VariableReserve, Any}","page":"Reserves","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(value::VariableReserve, val) -> Any\n\n\nSet VariableReserve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#Reserve-Demand-Curve","page":"Reserves","title":"Reserve Demand Curve","text":"","category":"section"},{"location":"model_library/reserves/","page":"Reserves","title":"Reserves","text":"Modules = [PowerSystems]\nPages = [\"generated/ReserveDemandCurve.jl\"]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/reserves/#PowerSystems.ReserveDemandCurve","page":"Reserves","title":"PowerSystems.ReserveDemandCurve","text":"mutable struct ReserveDemandCurve{T <: ReserveDirection} <: Reserve{T}\n variable::Union{Nothing, TimeSeriesKey, CostCurve{PiecewiseIncrementalCurve}}\n name::String\n available::Bool\n time_frame::Float64\n sustained_time::Float64\n max_participation_factor::Float64\n deployed_fraction::Float64\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA reserve product with an Operating Reserve Demand Curve (ORDC) for operational simulations.\n\nThe 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.\n\nWhen defining the reserve, the ReserveDirection must be specified to define this as a ReserveUp, ReserveDown, or ReserveSymmetric\n\nArguments\n\nvariable::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\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\ntime_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing)\nsustained_time::Float64: (default: 3600.0) the time in seconds that the reserve contribution must sustained at a specified level, validation range: (0, nothing)\nmax_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)\ndeployed_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)\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/reserves/#InfrastructureSystems.get_name-Tuple{ReserveDemandCurve}","page":"Reserves","title":"InfrastructureSystems.get_name","text":"get_name(value::ReserveDemandCurve) -> String\n\n\nGet ReserveDemandCurve name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_available-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_available","text":"get_available(value::ReserveDemandCurve) -> Bool\n\n\nGet ReserveDemandCurve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_deployed_fraction-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_deployed_fraction","text":"get_deployed_fraction(value::ReserveDemandCurve) -> Float64\n\n\nGet ReserveDemandCurve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_ext-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_ext","text":"get_ext(value::ReserveDemandCurve) -> Dict{String, Any}\n\n\nGet ReserveDemandCurve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_max_participation_factor-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_max_participation_factor","text":"get_max_participation_factor(\n value::ReserveDemandCurve\n) -> Float64\n\n\nGet ReserveDemandCurve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_sustained_time-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_sustained_time","text":"get_sustained_time(value::ReserveDemandCurve) -> Float64\n\n\nGet ReserveDemandCurve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_time_frame-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_time_frame","text":"get_time_frame(value::ReserveDemandCurve) -> Float64\n\n\nGet ReserveDemandCurve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.get_variable-Tuple{ReserveDemandCurve}","page":"Reserves","title":"PowerSystems.get_variable","text":"get_variable(\n value::ReserveDemandCurve\n) -> Union{Nothing, CostCurve{PiecewiseIncrementalCurve}, TimeSeriesKey}\n\n\nGet ReserveDemandCurve variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_available!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_available!","text":"set_available!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_deployed_fraction!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_deployed_fraction!","text":"set_deployed_fraction!(\n value::ReserveDemandCurve,\n val\n) -> Any\n\n\nSet ReserveDemandCurve deployed_fraction.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_ext!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_max_participation_factor!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_max_participation_factor!","text":"set_max_participation_factor!(\n value::ReserveDemandCurve,\n val\n) -> Any\n\n\nSet ReserveDemandCurve max_participation_factor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_sustained_time!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_sustained_time!","text":"set_sustained_time!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve sustained_time.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_time_frame!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_time_frame!","text":"set_time_frame!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve time_frame.\n\n\n\n\n\n","category":"method"},{"location":"model_library/reserves/#PowerSystems.set_variable!-Tuple{ReserveDemandCurve, Any}","page":"Reserves","title":"PowerSystems.set_variable!","text":"set_variable!(value::ReserveDemandCurve, val) -> Any\n\n\nSet ReserveDemandCurve variable.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#DCSource","page":"DCSource","title":"DCSource","text":"","category":"section"},{"location":"model_library/generated_DCSource/#FixedDCSource","page":"DCSource","title":"FixedDCSource","text":"","category":"section"},{"location":"model_library/generated_DCSource/","page":"DCSource","title":"DCSource","text":"Modules = [PowerSystems]\nPages = [\"/FixedDCSource.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_DCSource/#PowerSystems.FixedDCSource","page":"DCSource","title":"PowerSystems.FixedDCSource","text":"mutable struct FixedDCSource <: DCSource\n voltage::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of a Fixed DC Source that returns a fixed DC voltage\n\nArguments\n\nvoltage::Float64: Voltage (V), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) FixedDCSource has no states\nn_states::Int: (Do not modify.) FixedDCSource has no states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_DCSource/#PowerSystems.get_ext-Tuple{FixedDCSource}","page":"DCSource","title":"PowerSystems.get_ext","text":"get_ext(value::FixedDCSource) -> Dict{String, Any}\n\n\nGet FixedDCSource ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_n_states-Tuple{FixedDCSource}","page":"DCSource","title":"PowerSystems.get_n_states","text":"get_n_states(value::FixedDCSource) -> Int64\n\n\nGet FixedDCSource n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_states-Tuple{FixedDCSource}","page":"DCSource","title":"PowerSystems.get_states","text":"get_states(value::FixedDCSource) -> Vector{Symbol}\n\n\nGet FixedDCSource states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_voltage-Tuple{FixedDCSource}","page":"DCSource","title":"PowerSystems.get_voltage","text":"get_voltage(value::FixedDCSource) -> Float64\n\n\nGet FixedDCSource voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_ext!-Tuple{FixedDCSource, Any}","page":"DCSource","title":"PowerSystems.set_ext!","text":"set_ext!(value::FixedDCSource, val) -> Any\n\n\nSet FixedDCSource ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_voltage!-Tuple{FixedDCSource, Any}","page":"DCSource","title":"PowerSystems.set_voltage!","text":"set_voltage!(value::FixedDCSource, val) -> Any\n\n\nSet FixedDCSource voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#ZeroOrderBESS","page":"DCSource","title":"ZeroOrderBESS","text":"","category":"section"},{"location":"model_library/generated_DCSource/","page":"DCSource","title":"DCSource","text":"Modules = [PowerSystems]\nPages = [\"/ZeroOrderBESS.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_DCSource/#PowerSystems.ZeroOrderBESS","page":"DCSource","title":"PowerSystems.ZeroOrderBESS","text":"mutable struct ZeroOrderBESS <: DCSource\n rated_voltage::Float64\n rated_current::Float64\n battery_voltage::Float64\n battery_resistance::Float64\n dc_dc_inductor::Float64\n dc_link_capacitance::Float64\n fs::Float64\n kpv::Float64\n kiv::Float64\n kpi::Float64\n kii::Float64\n Vdc_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters for the DC-side with a Battery Energy Storage System from \"Grid-Coupled Dynamic Response of Battery-Driven Voltage Source Converters.\"\n\nArguments\n\nrated_voltage::Float64: Rated voltage (V), validation range: (0, nothing)\nrated_current::Float64: Rated current (A), validation range: (0, nothing)\nbattery_voltage::Float64: battery voltage in pu (DEVICE_BASE), validation range: (0, nothing)\nbattery_resistance::Float64: Battery resistance in pu (DEVICE_BASE), validation range: (0, nothing)\ndc_dc_inductor::Float64: DC/DC inductance in pu (DEVICE_BASE), validation range: (0, nothing)\ndc_link_capacitance::Float64: DC-link capacitance in pu (DEVICE_BASE), validation range: (0, nothing)\nfs::Float64: DC/DC converter switching frequency (kHz), validation range: (0, nothing)\nkpv::Float64: voltage controller proportional gain, validation range: (0, nothing)\nkiv::Float64: voltage controller integral gain, validation range: (0, nothing)\nkpi::Float64: current controller proportional gain, validation range: (0, nothing)\nkii::Float64: current controller integral gain, validation range: (0, nothing)\nVdc_ref::Float64: (default: 1.1) Reference DC-Voltage Set-point in pu (DEVICE_BASE), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ZeroOrderBESS model are:\n\nv_dc: DC-link voltage,\ni_b: Battery current,\n ν: integrator state of the voltage controller,\n ζ: integrator state of the PI current controller\n\nn_states::Int: (Do not modify.) ZeroOrderBESS has 4 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_DCSource/#PowerSystems.get_Vdc_ref-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_Vdc_ref","text":"get_Vdc_ref(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS Vdc_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_battery_resistance-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_battery_resistance","text":"get_battery_resistance(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS battery_resistance.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_battery_voltage-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_battery_voltage","text":"get_battery_voltage(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS battery_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_dc_dc_inductor-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_dc_dc_inductor","text":"get_dc_dc_inductor(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS dc_dc_inductor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_dc_link_capacitance-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_dc_link_capacitance","text":"get_dc_link_capacitance(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS dc_link_capacitance.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_ext-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_ext","text":"get_ext(value::ZeroOrderBESS) -> Dict{String, Any}\n\n\nGet ZeroOrderBESS ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_fs-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_fs","text":"get_fs(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS fs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_kii-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_kii","text":"get_kii(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS kii.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_kiv-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_kiv","text":"get_kiv(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_kpi-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_kpi","text":"get_kpi(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS kpi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_kpv-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_kpv","text":"get_kpv(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_n_states-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_n_states","text":"get_n_states(value::ZeroOrderBESS) -> Int64\n\n\nGet ZeroOrderBESS n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_rated_current-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_rated_current","text":"get_rated_current(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS rated_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_rated_voltage-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_rated_voltage","text":"get_rated_voltage(value::ZeroOrderBESS) -> Float64\n\n\nGet ZeroOrderBESS rated_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.get_states-Tuple{ZeroOrderBESS}","page":"DCSource","title":"PowerSystems.get_states","text":"get_states(value::ZeroOrderBESS) -> Vector{Symbol}\n\n\nGet ZeroOrderBESS states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_Vdc_ref!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_Vdc_ref!","text":"set_Vdc_ref!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS Vdc_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_battery_resistance!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_battery_resistance!","text":"set_battery_resistance!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS battery_resistance.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_battery_voltage!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_battery_voltage!","text":"set_battery_voltage!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS battery_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_dc_dc_inductor!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_dc_dc_inductor!","text":"set_dc_dc_inductor!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS dc_dc_inductor.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_dc_link_capacitance!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_dc_link_capacitance!","text":"set_dc_link_capacitance!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS dc_link_capacitance.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_ext!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_ext!","text":"set_ext!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_fs!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_fs!","text":"set_fs!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS fs.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_kii!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_kii!","text":"set_kii!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS kii.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_kiv!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_kiv!","text":"set_kiv!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_kpi!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_kpi!","text":"set_kpi!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS kpi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_kpv!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_kpv!","text":"set_kpv!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_rated_current!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_rated_current!","text":"set_rated_current!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS rated_current.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_DCSource/#PowerSystems.set_rated_voltage!-Tuple{ZeroOrderBESS, Any}","page":"DCSource","title":"PowerSystems.set_rated_voltage!","text":"set_rated_voltage!(value::ZeroOrderBESS, val) -> Any\n\n\nSet ZeroOrderBESS rated_voltage.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#Shaft","page":"Shaft","title":"Shaft","text":"","category":"section"},{"location":"model_library/generated_Shaft/#FiveMassShaft","page":"Shaft","title":"FiveMassShaft","text":"","category":"section"},{"location":"model_library/generated_Shaft/","page":"Shaft","title":"Shaft","text":"Modules = [PowerSystems]\nPages = [\"/FiveMassShaft.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Shaft/#PowerSystems.FiveMassShaft","page":"Shaft","title":"PowerSystems.FiveMassShaft","text":"mutable struct FiveMassShaft <: Shaft\n H::Float64\n H_hp::Float64\n H_ip::Float64\n H_lp::Float64\n H_ex::Float64\n D::Float64\n D_hp::Float64\n D_ip::Float64\n D_lp::Float64\n D_ex::Float64\n D_12::Float64\n D_23::Float64\n D_34::Float64\n D_45::Float64\n K_hp::Float64\n K_ip::Float64\n K_lp::Float64\n K_ex::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 5 mass-spring shaft model. It contains a High-Pressure (HP) steam turbine, Intermediate-Pressure (IP) steam turbine, Low-Pressure (LP) steam turbine, the Rotor and an Exciter (EX) mover\n\nArguments\n\nH::Float64: Rotor inertia constant in MWs/MVA, validation range: (0, nothing)\nH_hp::Float64: High pressure turbine inertia constant in MWs/MVA, validation range: (0, nothing)\nH_ip::Float64: Intermediate pressure turbine inertia constant in MWs/MVA, validation range: (0, nothing)\nH_lp::Float64: Low pressure turbine inertia constant in MWs/MVA, validation range: (0, nothing)\nH_ex::Float64: Exciter inertia constant in MWs/MVA, validation range: (0, nothing)\nD::Float64: Rotor natural damping in pu, validation range: (0, nothing)\nD_hp::Float64: High pressure turbine natural damping in pu, validation range: (0, nothing)\nD_ip::Float64: Intermediate pressure turbine natural damping in pu, validation range: (0, nothing)\nD_lp::Float64: Low pressure turbine natural damping in pu, validation range: (0, nothing)\nD_ex::Float64: Exciter natural damping in pu, validation range: (0, nothing)\nD_12::Float64: High-Intermediate pressure turbine damping, validation range: (0, nothing)\nD_23::Float64: Intermediate-Low pressure turbine damping, validation range: (0, nothing)\nD_34::Float64: Low pressure turbine-Rotor damping, validation range: (0, nothing)\nD_45::Float64: Rotor-Exciter damping, validation range: (0, nothing)\nK_hp::Float64: High pressure turbine angle coefficient, validation range: (0, nothing)\nK_ip::Float64: Intermediate pressure turbine angle coefficient, validation range: (0, nothing)\nK_lp::Float64: Low pressure turbine angle coefficient, validation range: (0, nothing)\nK_ex::Float64: Exciter angle coefficient, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nδ: rotor angle,\nω: rotor speed,\nδ_hp: rotor angle of high pressure turbine,\nω_hp: rotor speed of high pressure turbine,\nδ_ip: rotor angle of intermediate pressure turbine,\nω_ip: rotor speed of intermediate pressure turbine,\nδ_lp: rotor angle of low pressure turbine,\nω_lp: rotor speed of low pressure turbine,\nδ_ex: rotor angle of exciter,\nω_lp: rotor speed of exciter\n\nn_states::Int: (Do not modify.) FiveMassShaft has 10 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D","text":"get_D(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_12-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_12","text":"get_D_12(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_12.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_23-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_23","text":"get_D_23(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_23.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_34-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_34","text":"get_D_34(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_34.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_45-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_45","text":"get_D_45(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_45.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_ex-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_ex","text":"get_D_ex(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_hp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_hp","text":"get_D_hp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_ip-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_ip","text":"get_D_ip(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D_lp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_D_lp","text":"get_D_lp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft D_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H","text":"get_H(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H_ex-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H_ex","text":"get_H_ex(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H_hp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H_hp","text":"get_H_hp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H_ip-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H_ip","text":"get_H_ip(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H_lp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_H_lp","text":"get_H_lp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft H_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_K_ex-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_K_ex","text":"get_K_ex(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft K_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_K_hp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_K_hp","text":"get_K_hp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft K_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_K_ip-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_K_ip","text":"get_K_ip(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft K_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_K_lp-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_K_lp","text":"get_K_lp(value::FiveMassShaft) -> Float64\n\n\nGet FiveMassShaft K_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_ext-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_ext","text":"get_ext(value::FiveMassShaft) -> Dict{String, Any}\n\n\nGet FiveMassShaft ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_n_states-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_n_states","text":"get_n_states(value::FiveMassShaft) -> Int64\n\n\nGet FiveMassShaft n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_states-Tuple{FiveMassShaft}","page":"Shaft","title":"PowerSystems.get_states","text":"get_states(value::FiveMassShaft) -> Vector{Symbol}\n\n\nGet FiveMassShaft states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D!","text":"set_D!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_12!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_12!","text":"set_D_12!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_12.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_23!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_23!","text":"set_D_23!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_23.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_34!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_34!","text":"set_D_34!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_34.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_45!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_45!","text":"set_D_45!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_45.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_ex!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_ex!","text":"set_D_ex!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_hp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_hp!","text":"set_D_hp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_ip!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_ip!","text":"set_D_ip!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D_lp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_D_lp!","text":"set_D_lp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft D_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H!","text":"set_H!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H_ex!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H_ex!","text":"set_H_ex!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H_hp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H_hp!","text":"set_H_hp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H_ip!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H_ip!","text":"set_H_ip!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H_lp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_H_lp!","text":"set_H_lp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft H_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_K_ex!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_K_ex!","text":"set_K_ex!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft K_ex.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_K_hp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_K_hp!","text":"set_K_hp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft K_hp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_K_ip!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_K_ip!","text":"set_K_ip!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft K_ip.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_K_lp!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_K_lp!","text":"set_K_lp!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft K_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_ext!-Tuple{FiveMassShaft, Any}","page":"Shaft","title":"PowerSystems.set_ext!","text":"set_ext!(value::FiveMassShaft, val) -> Any\n\n\nSet FiveMassShaft ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#SingleMass","page":"Shaft","title":"SingleMass","text":"","category":"section"},{"location":"model_library/generated_Shaft/","page":"Shaft","title":"Shaft","text":"Modules = [PowerSystems]\nPages = [\"/SingleMass.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_Shaft/#PowerSystems.SingleMass","page":"Shaft","title":"PowerSystems.SingleMass","text":"mutable struct SingleMass <: Shaft\n H::Float64\n D::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of single mass shaft model. Typically represents the rotor mass\n\nArguments\n\nH::Float64: Rotor inertia constant in MWs/MVA, validation range: (0, nothing)\nD::Float64: Rotor natural damping in pu, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nδ: rotor angle,\nω: rotor speed\n\nn_states::Int: (Do not modify.) SingleMass has 1 state\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_Shaft/#PowerSystems.get_D-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_D","text":"get_D(value::SingleMass) -> Float64\n\n\nGet SingleMass D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_H-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_H","text":"get_H(value::SingleMass) -> Float64\n\n\nGet SingleMass H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_ext-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_ext","text":"get_ext(value::SingleMass) -> Dict{String, Any}\n\n\nGet SingleMass ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_n_states-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_n_states","text":"get_n_states(value::SingleMass) -> Int64\n\n\nGet SingleMass n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.get_states-Tuple{SingleMass}","page":"Shaft","title":"PowerSystems.get_states","text":"get_states(value::SingleMass) -> Vector{Symbol}\n\n\nGet SingleMass states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_D!-Tuple{SingleMass, Any}","page":"Shaft","title":"PowerSystems.set_D!","text":"set_D!(value::SingleMass, val) -> Any\n\n\nSet SingleMass D.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_H!-Tuple{SingleMass, Any}","page":"Shaft","title":"PowerSystems.set_H!","text":"set_H!(value::SingleMass, val) -> Any\n\n\nSet SingleMass H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_Shaft/#PowerSystems.set_ext!-Tuple{SingleMass, Any}","page":"Shaft","title":"PowerSystems.set_ext!","text":"set_ext!(value::SingleMass, val) -> Any\n\n\nSet SingleMass ext.\n\n\n\n\n\n","category":"method"},{"location":"how_to/install/#install","page":"...install PowerSystems.jl","title":"Install PowerSystems.jl","text":"","category":"section"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"PowerSystems.jl is a command line tool written in the Julia programming language. To install:","category":"page"},{"location":"how_to/install/#Step-1:-Install-Julia","page":"...install PowerSystems.jl","title":"Step 1: Install Julia","text":"","category":"section"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Follow the instructions here","category":"page"},{"location":"how_to/install/#Step-2:-Open-Julia","page":"...install PowerSystems.jl","title":"Step 2: Open Julia","text":"","category":"section"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Start the Julia REPL from a command line:","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"$ julia","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"You should see the Julia REPL start up, which looks something like this:","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":" _\n _ _ _(_)_ | Documentation: https://docs.julialang.org\n (_) | (_) (_) |\n _ _ _| |_ __ _ | Type \"?\" for help, \"]?\" for Pkg help.\n | | | | | | |/ _` | |\n | | |_| | | | (_| | | Version 1.10.4 (2024-06-04)\n _/ |\\__'_|_|_|\\__'_| | Official https://julialang.org/ release\n|__/ |\n\njulia>","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"If not, go back to check the Julia installation steps.","category":"page"},{"location":"how_to/install/#Step-3:-Install-PowerSystems.jl","page":"...install PowerSystems.jl","title":"Step 3: Install PowerSystems.jl","text":"","category":"section"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Install the latest stable release of PowerSystems.jl using the Julia package manager with:","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"] add PowerSystems","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Once you type ], you will see the prompt change color as it activates the Julia package manager. This command may take a few minutes to download the packages and compile them.","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Press the delete or backspace key to return to the REPL. ","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"Install is complete!","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"note: Alternate\nTo use the current development version instead, \"checkout\" the main branch of this package with:] add PowerSystems#main","category":"page"},{"location":"how_to/install/","page":"...install PowerSystems.jl","title":"...install PowerSystems.jl","text":"note: Note\nPowerSystems.jl uses InfrastructureSystems.jl as a utility library. Many methods are re-exported from InfrastructureSystems.jl. For most users there is no need to import InfrastructureSystems.jl.","category":"page"},{"location":"tutorials/get_component_data/#get_components_tutorial","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"","category":"section"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"In this tutorial, we will explore the data in a System, including looking at a summary of the system and getting both its components and their data. We will also start checking for time-series data, which we will explore more in the tutorial on Working with Time Series Data.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"In Create and Explore a Power System, we created a basic System with nodes, a transmission line, and a few generators. Let's recreate that system if you don't have it already:","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"using PowerSystems;\nsys = System(100.0);\nbus1 = ACBus(1, \"bus1\", ACBusTypes.REF, 0.0, 1.0, (min = 0.9, max = 1.05), 230.0);\nbus2 = ACBus(2, \"bus2\", ACBusTypes.PV, 0.0, 1.0, (min = 0.9, max = 1.05), 230.0);\n","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"PowerSystems provides functional interfaces to all data. The following examples outline the intended approach to accessing data expressed using PowerSystems.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"PowerSystems enforces unique name fields between components of a particular concrete type. So, in order to retrieve a specific component, the user must specify the type of the component along with the name and system","category":"page"},{"location":"tutorials/get_component_data/#Accessing-components-and-their-data","page":"Getting, Setting, and Viewing Data","title":"Accessing components and their data","text":"","category":"section"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_component(ACBus, sys, \"nodeA\")\nget_component(Line, sys, \"1\")","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"Similarly, you can access all the components of a particular type: *note: the return type of get_components is a FlattenIteratorWrapper, so call collect to get an Array","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_components(ACBus, sys) |> collect","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_components also works on abstract types:","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_components(Branch, sys) |> collect","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"The fields within a component can be accessed using the get_* functions: It's highly recommended that users avoid using the . to access fields since we make no guarantees on the stability field names and locations. We do however promise to keep the accessor functions stable.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"bus1 = get_component(ACBus, sys, \"nodeA\")\n@show get_name(bus1);\n@show get_magnitude(bus1);\nnothing #hide","category":"page"},{"location":"tutorials/get_component_data/#Accessing-components-stored-in-the-system","page":"Getting, Setting, and Viewing Data","title":"Accessing components stored in the system","text":"","category":"section"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"using PowerSystems\nfile_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"tutorials_data\")\nsystem = System(joinpath(file_dir, \"RTS_GMLC.m\"));\nthermal_gens = get_components(ThermalStandard, system)","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"It is also possible to execute get_components with abstract types from the abstract tree. For instance, it is possible to retrieve all renewable generators","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"thermal_gens = get_components(RenewableGen, system)","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"The most common filtering requirement is by component name and for this case the method get_component returns a single component taking the device type, system and name as arguments.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"my_thermal_gen = get_component(ThermalStandard, system, \"323_CC_1\")","category":"page"},{"location":"tutorials/get_component_data/#Accessing-data-stored-in-a-component","page":"Getting, Setting, and Viewing Data","title":"Accessing data stored in a component","text":"","category":"section"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"Using the \"dot\" access to get a parameter value from a component is actively discouraged, use \"getter\" functions instead","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"For example, the my_thermal_gen.active_power_limits parameter of a thermal generator should be accessed as follows:","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"get_active_power_limits(my_thermal_gen)","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"You can also view data from all instances of a concrete type in one table with the function show_components. It provides a few options:","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"View the standard fields by accepting the defaults.\nPass a dictionary where the keys are column names and the values are functions that accept a component as a single argument.\nPass a vector of symbols that are field names of the type.","category":"page"},{"location":"tutorials/get_component_data/","page":"Getting, Setting, and Viewing Data","title":"Getting, Setting, and Viewing Data","text":"show_components(system, ThermalStandard)\nshow_components(system, ThermalStandard, Dict(\"has_time_series\" => x -> has_time_series(x)))\nshow_components(system, ThermalStandard, [:active_power, :reactive_power])","category":"page"},{"location":"tutorials/get_component_data/#to-do:-add-a-link-in-the-system-that-MD-explanation-to-these-examples","page":"Getting, Setting, and Viewing Data","title":"to do: add a link in the system that MD explanation to these examples","text":"","category":"section"},{"location":"model_library/outer_control/#OuterControl","page":"OuterControl","title":"OuterControl","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"The outer control is composed by the ReactivePowerControl and the ActivePowerControl types.","category":"page"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"/OuterControl.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.OuterControl","page":"OuterControl","title":"PowerSystems.OuterControl","text":"mutable struct OuterControl{\n A <: ActivePowerControl,\n R <: ReactivePowerControl\n} <: DynamicInverterComponent\n active_power_control::A\n reactive_power_control::R\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Outer-Loop controller using a active power controller and a reactive power droop controller.\n\nArguments\n\nA <: ActivePowerControl: Active power controller (typically droop or virtual inertia).\nR <: ReactivePowerControl: Reactive power controller (typically droop).\next::Dict{String, Any}\nstates::Vector{Symbol}: Vector of states (will depend on the components).\nn_states::Int: Number of states (will depend on the components).\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{OuterControl}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::OuterControl) -> Dict{String, Any}\n\n\nGet ext from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{OuterControl}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::OuterControl) -> Int64\n\n\nGet n_states from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{OuterControl}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::OuterControl) -> Vector{Symbol}\n\n\nGet states from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{OuterControl, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::OuterControl, val) -> Any\n\n\nSet OuterControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Power-Controllers","page":"OuterControl","title":"Active Power Controllers","text":"","category":"section"},{"location":"model_library/outer_control/#Virtual-Inertia","page":"OuterControl","title":"Virtual Inertia","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/VirtualInertia.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.VirtualInertia","page":"OuterControl","title":"PowerSystems.VirtualInertia","text":"mutable struct VirtualInertia <: ActivePowerControl\n Ta::Float64\n kd::Float64\n kω::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Virtual Inertia with SRF using VSM for active power controller\n\nArguments\n\nTa::Float64: VSM inertia constant, validation range: (0, nothing)\nkd::Float64: VSM damping constant, validation range: (0, nothing)\nkω::Float64: frequency droop gain, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the VirtualInertia model are:\n\nθ_oc: Phase angle displacement of the virtual synchronous generator model\nω_oc: Speed of the rotating reference frame of the virtual synchronous generator model\n\nn_states::Int: (Do not modify.) VirtualInertia has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::VirtualInertia) -> Float64\n\n\nGet VirtualInertia P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Ta-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_Ta","text":"get_Ta(value::VirtualInertia) -> Float64\n\n\nGet VirtualInertia Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::VirtualInertia) -> Dict{String, Any}\n\n\nGet VirtualInertia ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_kd-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_kd","text":"get_kd(value::VirtualInertia) -> Float64\n\n\nGet VirtualInertia kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_kω-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_kω","text":"get_kω(value::VirtualInertia) -> Float64\n\n\nGet VirtualInertia kω.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::VirtualInertia) -> Int64\n\n\nGet VirtualInertia n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{VirtualInertia}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::VirtualInertia) -> Vector{Symbol}\n\n\nGet VirtualInertia states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Ta!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_Ta!","text":"set_Ta!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia Ta.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_kd!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_kd!","text":"set_kd!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia kd.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_kω!-Tuple{VirtualInertia, Any}","page":"OuterControl","title":"PowerSystems.set_kω!","text":"set_kω!(value::VirtualInertia, val) -> Any\n\n\nSet VirtualInertia kω.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Power-Droop","page":"OuterControl","title":"Active Power Droop","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ActivePowerDroop.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ActivePowerDroop","page":"OuterControl","title":"PowerSystems.ActivePowerDroop","text":"mutable struct ActivePowerDroop <: ActivePowerControl\n Rp::Float64\n ωz::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an Active Power droop controller\n\nArguments\n\nRp::Float64: Droop Gain, validation range: (0, nothing)\nωz::Float64: filter frequency cutoff, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ActivePowerDroop model are:\n\nθ_oc: Phase angle displacement of the inverter model,\np_oc: Measured active power of the inverter model\n\nn_states::Int: (Do not modify.) ActivePowerDroop has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActivePowerDroop) -> Float64\n\n\nGet ActivePowerDroop P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Rp-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_Rp","text":"get_Rp(value::ActivePowerDroop) -> Float64\n\n\nGet ActivePowerDroop Rp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ActivePowerDroop) -> Dict{String, Any}\n\n\nGet ActivePowerDroop ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActivePowerDroop) -> Int64\n\n\nGet ActivePowerDroop n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ActivePowerDroop) -> Vector{Symbol}\n\n\nGet ActivePowerDroop states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ωz-Tuple{ActivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_ωz","text":"get_ωz(value::ActivePowerDroop) -> Float64\n\n\nGet ActivePowerDroop ωz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{ActivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActivePowerDroop, val) -> Any\n\n\nSet ActivePowerDroop P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Rp!-Tuple{ActivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_Rp!","text":"set_Rp!(value::ActivePowerDroop, val) -> Any\n\n\nSet ActivePowerDroop Rp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ActivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActivePowerDroop, val) -> Any\n\n\nSet ActivePowerDroop ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ωz!-Tuple{ActivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_ωz!","text":"set_ωz!(value::ActivePowerDroop, val) -> Any\n\n\nSet ActivePowerDroop ωz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Power-PI","page":"OuterControl","title":"Active Power PI","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ActivePowerPI.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ActivePowerPI","page":"OuterControl","title":"PowerSystems.ActivePowerPI","text":"mutable struct ActivePowerPI <: ActivePowerControl\n Kp_p::Float64\n Ki_p::Float64\n ωz::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Proportional-Integral Active Power controller for a specified power reference\n\nArguments\n\nKp_p::Float64: Proportional Gain, validation range: (0, nothing)\nKi_p::Float64: Integral Gain, validation range: (0, nothing)\nωz::Float64: filter frequency cutoff, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ActivePowerPI model are:\n\nσp_oc: Integrator state of the PI Controller,\np_oc: Measured active power of the inverter model\n\nn_states::Int: (Do not modify.) ActivePowerPI has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_Ki_p-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Ki_p","text":"get_Ki_p(value::ActivePowerPI) -> Float64\n\n\nGet ActivePowerPI Ki_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Kp_p-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Kp_p","text":"get_Kp_p(value::ActivePowerPI) -> Float64\n\n\nGet ActivePowerPI Kp_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActivePowerPI) -> Float64\n\n\nGet ActivePowerPI P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ActivePowerPI) -> Dict{String, Any}\n\n\nGet ActivePowerPI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActivePowerPI) -> Int64\n\n\nGet ActivePowerPI n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ActivePowerPI) -> Vector{Symbol}\n\n\nGet ActivePowerPI states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ωz-Tuple{ActivePowerPI}","page":"OuterControl","title":"PowerSystems.get_ωz","text":"get_ωz(value::ActivePowerPI) -> Float64\n\n\nGet ActivePowerPI ωz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Ki_p!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Ki_p!","text":"set_Ki_p!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI Ki_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Kp_p!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Kp_p!","text":"set_Kp_p!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI Kp_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ωz!-Tuple{ActivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_ωz!","text":"set_ωz!(value::ActivePowerPI, val) -> Any\n\n\nSet ActivePowerPI ωz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Virtual-Oscillator","page":"OuterControl","title":"Active Virtual Oscillator","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ActiveVirtualOscillator.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ActiveVirtualOscillator","page":"OuterControl","title":"PowerSystems.ActiveVirtualOscillator","text":"mutable struct ActiveVirtualOscillator <: ActivePowerControl\n k1::Float64\n ψ::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an Active Virtual Oscillator controller. Model is based on \"Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control.\"\n\nArguments\n\nk1::Float64: VOC Synchronization Gain, validation range: (0, nothing)\nψ::Float64: Rotation angle of the controller, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ActiveVirtualOscillator model are:\n\nθ_oc: Phase angle displacement of the inverter model\n\nn_states::Int: (Do not modify.) ActiveVirtualOscillator has one state\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActiveVirtualOscillator) -> Float64\n\n\nGet ActiveVirtualOscillator P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ActiveVirtualOscillator) -> Dict{String, Any}\n\n\nGet ActiveVirtualOscillator ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_k1-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_k1","text":"get_k1(value::ActiveVirtualOscillator) -> Float64\n\n\nGet ActiveVirtualOscillator k1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActiveVirtualOscillator) -> Int64\n\n\nGet ActiveVirtualOscillator n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ActiveVirtualOscillator) -> Vector{Symbol}\n\n\nGet ActiveVirtualOscillator states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ψ-Tuple{ActiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_ψ","text":"get_ψ(value::ActiveVirtualOscillator) -> Float64\n\n\nGet ActiveVirtualOscillator ψ.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{ActiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActiveVirtualOscillator, val) -> Any\n\n\nSet ActiveVirtualOscillator P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ActiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActiveVirtualOscillator, val) -> Any\n\n\nSet ActiveVirtualOscillator ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_k1!-Tuple{ActiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_k1!","text":"set_k1!(value::ActiveVirtualOscillator, val) -> Any\n\n\nSet ActiveVirtualOscillator k1.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ψ!-Tuple{ActiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_ψ!","text":"set_ψ!(value::ActiveVirtualOscillator, val) -> Any\n\n\nSet ActiveVirtualOscillator ψ.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Active-Renewable-Controller-Type-AB","page":"OuterControl","title":"Active Renewable Controller Type AB","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ActiveRenewableControllerAB.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ActiveRenewableControllerAB","page":"OuterControl","title":"PowerSystems.ActiveRenewableControllerAB","text":"mutable struct ActiveRenewableControllerAB <: ActivePowerControl\n bus_control::Int\n from_branch_control::Int\n to_branch_control::Int\n branch_id_control::String\n Freq_Flag::Int\n K_pg::Float64\n K_ig::Float64\n T_p::Float64\n fdbd_pnts::Tuple{Float64, Float64}\n fe_lim::MinMax\n P_lim::MinMax\n T_g::Float64\n D_dn::Float64\n D_up::Float64\n dP_lim::MinMax\n P_lim_inner::MinMax\n T_pord::Float64\n P_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of Active Power Controller including REPCA1 and REECB1\n\nArguments\n\nbus_control::Int: ACBus identification number for voltage control. 0 identifies the local bus connected to this component, validation range: (0, nothing)\nfrom_branch_control::Int: Monitored branch FROM bus number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)\nto_branch_control::Int: Monitored branch TO bus number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)\nbranch_id_control::String: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used\nFreq_Flag::Int: Frequency Flag for REPCA1: 0: disable, 1:enable, validation range: (0, 1)\nK_pg::Float64: Active power PI control proportional gain, validation range: (0, nothing)\nK_ig::Float64: Active power PI control integral gain, validation range: (0, nothing)\nT_p::Float64: Real power measurement filter time constant (s), validation range: (0, nothing)\nfdbd_pnts::Tuple{Float64, Float64}: Frequency error dead band thresholds (fdbd1, fdbd2)\nfe_lim::MinMax: Upper/Lower limit on frequency error (fe_min, fe_max)\nP_lim::MinMax: Upper/Lower limit on power reference (P_min, P_max)\nT_g::Float64: Power Controller lag time constant, validation range: (0, nothing)\nD_dn::Float64: Droop for over-frequency conditions, validation range: (nothing, 0)\nD_up::Float64: Droop for under-frequency conditions, validation range: (0, nothing)\ndP_lim::MinMax: Upper/Lower limit on power reference ramp rates(dP_min, dP_max)\nP_lim_inner::MinMax: Upper/Lower limit on power reference for REECB(P_min_inner, P_max_inner)\nT_pord::Float64: Power filter time constant REECB time constant, validation range: (0, nothing)\nP_ref::Float64: (default: 1.0) Reference Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ActiveRenewableControllerAB model depends on the Flag\nn_states::Int: (Do not modify.) The states of the ActiveRenewableControllerAB model depends on the Flag\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_D_dn-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_D_dn","text":"get_D_dn(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_D_up-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_D_up","text":"get_D_up(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Freq_Flag-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Freq_Flag","text":"get_Freq_Flag(value::ActiveRenewableControllerAB) -> Int64\n\n\nGet ActiveRenewableControllerAB Freq_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_ig-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_ig","text":"get_K_ig(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB K_ig.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_pg-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_pg","text":"get_K_pg(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB K_pg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_P_lim-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_P_lim","text":"get_P_lim(\n value::ActiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ActiveRenewableControllerAB P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_P_lim_inner-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_P_lim_inner","text":"get_P_lim_inner(\n value::ActiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ActiveRenewableControllerAB P_lim_inner.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_P_ref-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_P_ref","text":"get_P_ref(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_g-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_g","text":"get_T_g(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_p-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_p","text":"get_T_p(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_pord-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_pord","text":"get_T_pord(value::ActiveRenewableControllerAB) -> Float64\n\n\nGet ActiveRenewableControllerAB T_pord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_branch_id_control-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_branch_id_control","text":"get_branch_id_control(\n value::ActiveRenewableControllerAB\n) -> String\n\n\nGet ActiveRenewableControllerAB branch_id_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_bus_control-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_bus_control","text":"get_bus_control(value::ActiveRenewableControllerAB) -> Int64\n\n\nGet ActiveRenewableControllerAB bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_dP_lim-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_dP_lim","text":"get_dP_lim(\n value::ActiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ActiveRenewableControllerAB dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(\n value::ActiveRenewableControllerAB\n) -> Dict{String, Any}\n\n\nGet ActiveRenewableControllerAB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_fdbd_pnts-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_fdbd_pnts","text":"get_fdbd_pnts(\n value::ActiveRenewableControllerAB\n) -> Tuple{Float64, Float64}\n\n\nGet ActiveRenewableControllerAB fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_fe_lim-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_fe_lim","text":"get_fe_lim(\n value::ActiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ActiveRenewableControllerAB fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_from_branch_control-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_from_branch_control","text":"get_from_branch_control(\n value::ActiveRenewableControllerAB\n) -> Int64\n\n\nGet ActiveRenewableControllerAB from_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ActiveRenewableControllerAB) -> Int64\n\n\nGet ActiveRenewableControllerAB n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(\n value::ActiveRenewableControllerAB\n) -> Vector{Symbol}\n\n\nGet ActiveRenewableControllerAB states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_to_branch_control-Tuple{ActiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_to_branch_control","text":"get_to_branch_control(\n value::ActiveRenewableControllerAB\n) -> Int64\n\n\nGet ActiveRenewableControllerAB to_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_D_dn!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_D_dn!","text":"set_D_dn!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB D_dn.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_D_up!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_D_up!","text":"set_D_up!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB D_up.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Freq_Flag!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Freq_Flag!","text":"set_Freq_Flag!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB Freq_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_ig!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_ig!","text":"set_K_ig!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB K_ig.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_pg!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_pg!","text":"set_K_pg!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB K_pg.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_lim!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_P_lim!","text":"set_P_lim!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB P_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_lim_inner!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_P_lim_inner!","text":"set_P_lim_inner!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB P_lim_inner.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_P_ref!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_P_ref!","text":"set_P_ref!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB P_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_g!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_g!","text":"set_T_g!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB T_g.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_p!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_p!","text":"set_T_p!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_pord!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_pord!","text":"set_T_pord!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB T_pord.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_branch_id_control!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_branch_id_control!","text":"set_branch_id_control!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB branch_id_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_bus_control!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_bus_control!","text":"set_bus_control!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_dP_lim!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_dP_lim!","text":"set_dP_lim!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB dP_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_fdbd_pnts!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_fdbd_pnts!","text":"set_fdbd_pnts!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB fdbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_fe_lim!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_fe_lim!","text":"set_fe_lim!(value::ActiveRenewableControllerAB, val) -> Any\n\n\nSet ActiveRenewableControllerAB fe_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_from_branch_control!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_from_branch_control!","text":"set_from_branch_control!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB from_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_to_branch_control!-Tuple{ActiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_to_branch_control!","text":"set_to_branch_control!(\n value::ActiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ActiveRenewableControllerAB to_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Reactive-Power-Controllers","page":"OuterControl","title":"Reactive Power Controllers","text":"","category":"section"},{"location":"model_library/outer_control/#Reactive-Power-Droop","page":"OuterControl","title":"Reactive Power Droop","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ReactivePowerDroop.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ReactivePowerDroop","page":"OuterControl","title":"PowerSystems.ReactivePowerDroop","text":"mutable struct ReactivePowerDroop <: ReactivePowerControl\n kq::Float64\n ωf::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Reactive Power droop controller\n\nArguments\n\nkq::Float64: frequency droop gain, validation range: (0, nothing)\nωf::Float64: filter frequency cutoff, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReactivePowerDroop model are:\n\nq_oc: Filtered reactive output power\n\nn_states::Int: (Do not modify.) ReactivePowerDroop has 1 state\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_V_ref-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ReactivePowerDroop) -> Float64\n\n\nGet ReactivePowerDroop V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ReactivePowerDroop) -> Dict{String, Any}\n\n\nGet ReactivePowerDroop ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_kq-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_kq","text":"get_kq(value::ReactivePowerDroop) -> Float64\n\n\nGet ReactivePowerDroop kq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReactivePowerDroop) -> Int64\n\n\nGet ReactivePowerDroop n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ReactivePowerDroop) -> Vector{Symbol}\n\n\nGet ReactivePowerDroop states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ωf-Tuple{ReactivePowerDroop}","page":"OuterControl","title":"PowerSystems.get_ωf","text":"get_ωf(value::ReactivePowerDroop) -> Float64\n\n\nGet ReactivePowerDroop ωf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_ref!-Tuple{ReactivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ReactivePowerDroop, val) -> Any\n\n\nSet ReactivePowerDroop V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ReactivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReactivePowerDroop, val) -> Any\n\n\nSet ReactivePowerDroop ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_kq!-Tuple{ReactivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_kq!","text":"set_kq!(value::ReactivePowerDroop, val) -> Any\n\n\nSet ReactivePowerDroop kq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ωf!-Tuple{ReactivePowerDroop, Any}","page":"OuterControl","title":"PowerSystems.set_ωf!","text":"set_ωf!(value::ReactivePowerDroop, val) -> Any\n\n\nSet ReactivePowerDroop ωf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Reactive-Power-PI","page":"OuterControl","title":"Reactive Power PI","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ReactivePowerPI.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ReactivePowerPI","page":"OuterControl","title":"PowerSystems.ReactivePowerPI","text":"mutable struct ReactivePowerPI <: ReactivePowerControl\n Kp_q::Float64\n Ki_q::Float64\n ωf::Float64\n V_ref::Float64\n Q_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Proportional-Integral Reactive Power controller for a specified power reference\n\nArguments\n\nKp_q::Float64: Proportional Gain, validation range: (0, nothing)\nKi_q::Float64: Integral Gain, validation range: (0, nothing)\nωf::Float64: filter frequency cutoff, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Voltage Set-point (pu), validation range: (0, nothing)\nQ_ref::Float64: (default: 1.0) Reactive Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReactivePowerPI model are:\n\nσq_oc: Integrator state of the PI Controller,\nq_oc: Measured reactive power of the inverter model\n\nn_states::Int: (Do not modify.) ReactivePowerPI has two states\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_Ki_q-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Ki_q","text":"get_Ki_q(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI Ki_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Kp_q-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Kp_q","text":"get_Kp_q(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI Kp_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Q_ref-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_ref-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(value::ReactivePowerPI) -> Dict{String, Any}\n\n\nGet ReactivePowerPI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReactivePowerPI) -> Int64\n\n\nGet ReactivePowerPI n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(value::ReactivePowerPI) -> Vector{Symbol}\n\n\nGet ReactivePowerPI states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ωf-Tuple{ReactivePowerPI}","page":"OuterControl","title":"PowerSystems.get_ωf","text":"get_ωf(value::ReactivePowerPI) -> Float64\n\n\nGet ReactivePowerPI ωf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Ki_q!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Ki_q!","text":"set_Ki_q!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI Ki_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Kp_q!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Kp_q!","text":"set_Kp_q!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI Kp_q.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_ref!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_ref!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ωf!-Tuple{ReactivePowerPI, Any}","page":"OuterControl","title":"PowerSystems.set_ωf!","text":"set_ωf!(value::ReactivePowerPI, val) -> Any\n\n\nSet ReactivePowerPI ωf.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Reactive-Virtual-Oscillator","page":"OuterControl","title":"Reactive Virtual Oscillator","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ReactiveVirtualOscillator.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ReactiveVirtualOscillator","page":"OuterControl","title":"PowerSystems.ReactiveVirtualOscillator","text":"mutable struct ReactiveVirtualOscillator <: ReactivePowerControl\n k2::Float64\n V_ref::Float64\n Q_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Reactive Virtual Oscillator controller. Model is based on \"Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control.\"\n\nArguments\n\nk2::Float64: VOC voltage-amplitude control gain, validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\nQ_ref::Float64: (default: 1.0) Reference Reactive Power Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReactiveVirtualOscilator model are:\n\nE_oc: voltage reference state for inner control in the d-axis\n\nn_states::Int: (Do not modify.) ReactiveVirtualOscillator has 1 state\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_Q_ref-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::ReactiveVirtualOscillator) -> Float64\n\n\nGet ReactiveVirtualOscillator Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_ref-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ReactiveVirtualOscillator) -> Float64\n\n\nGet ReactiveVirtualOscillator V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(\n value::ReactiveVirtualOscillator\n) -> Dict{String, Any}\n\n\nGet ReactiveVirtualOscillator ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_k2-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_k2","text":"get_k2(value::ReactiveVirtualOscillator) -> Float64\n\n\nGet ReactiveVirtualOscillator k2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReactiveVirtualOscillator) -> Int64\n\n\nGet ReactiveVirtualOscillator n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ReactiveVirtualOscillator}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(\n value::ReactiveVirtualOscillator\n) -> Vector{Symbol}\n\n\nGet ReactiveVirtualOscillator states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_ref!-Tuple{ReactiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::ReactiveVirtualOscillator, val) -> Any\n\n\nSet ReactiveVirtualOscillator Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_ref!-Tuple{ReactiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ReactiveVirtualOscillator, val) -> Any\n\n\nSet ReactiveVirtualOscillator V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ReactiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReactiveVirtualOscillator, val) -> Any\n\n\nSet ReactiveVirtualOscillator ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_k2!-Tuple{ReactiveVirtualOscillator, Any}","page":"OuterControl","title":"PowerSystems.set_k2!","text":"set_k2!(value::ReactiveVirtualOscillator, val) -> Any\n\n\nSet ReactiveVirtualOscillator k2.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#Reactive-Renewable-Controller-Type-AB","page":"OuterControl","title":"Reactive Renewable Controller Type AB","text":"","category":"section"},{"location":"model_library/outer_control/","page":"OuterControl","title":"OuterControl","text":"Modules = [PowerSystems]\nPages = [\"generated/ReactiveRenewableControllerAB.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/outer_control/#PowerSystems.ReactiveRenewableControllerAB","page":"OuterControl","title":"PowerSystems.ReactiveRenewableControllerAB","text":"mutable struct ReactiveRenewableControllerAB <: ReactivePowerControl\n bus_control::Int\n from_branch_control::Int\n to_branch_control::Int\n branch_id_control::String\n VC_Flag::Int\n Ref_Flag::Int\n PF_Flag::Int\n V_Flag::Int\n T_fltr::Float64\n K_p::Float64\n K_i::Float64\n T_ft::Float64\n T_fv::Float64\n V_frz::Float64\n R_c::Float64\n X_c::Float64\n K_c::Float64\n e_lim::MinMax\n dbd_pnts::Tuple{Float64, Float64}\n Q_lim::MinMax\n T_p::Float64\n Q_lim_inner::MinMax\n V_lim::MinMax\n K_qp::Float64\n K_qi::Float64\n Q_ref::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of Reactive Power Controller including REPCA1 and REECB1\n\nArguments\n\nbus_control::Int: ACBus identification number for voltage control. 0 identifies the local bus connected to this component, validation range: (0, nothing)\nfrom_branch_control::Int: Monitored branch FROM bus identification number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)\nto_branch_control::Int: Monitored branch TO bus identification number for line drop compensation (if 0 generator power will be used), validation range: (0, nothing)\nbranch_id_control::String: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used\nVC_Flag::Int: Voltage Compensator Flag for REPCA1, validation range: (0, 1)\nRef_Flag::Int: Flag for Reactive Power Control for REPCA1. 0: Q-control, 1: V-control, validation range: (0, 1)\nPF_Flag::Int: Flag for Power Factor Control for Outer Control of REECB1. 0: Q-control, 1: Power Factor Control, validation range: (0, 1)\nV_Flag::Int: Flag for Voltage Control for Outer Control of REECB1. 0: Voltage Control, 1: Q-Control, validation range: (0, 1)\nT_fltr::Float64: Voltage or Q-power of REPCA Filter Time Constant, validation range: (0, nothing)\nK_p::Float64: Reactive power PI control proportional gain, validation range: (0, nothing)\nK_i::Float64: Reactive power PI control integral gain, validation range: (0, nothing)\nT_ft::Float64: Reactive power lead time constant (s), validation range: (0, nothing)\nT_fv::Float64: Reactive power lag time constant (s), validation range: (0, nothing)\nV_frz::Float64: Voltage below which state ξq_oc (integrator state) is freeze, validation range: (0, nothing)\nR_c::Float64: Line drop compensation resistance (used when VC_Flag = 1), validation range: (0, nothing)\nX_c::Float64: Line drop compensation reactance (used when VC_Flag = 1), validation range: (0, nothing)\nK_c::Float64: Reactive current compensation gain (pu) (used when VC_Flag = 0), validation range: (0, nothing)\ne_lim::MinMax: Upper/Lower limit on Voltage or Q-power deadband output (e_min, e_max)\ndbd_pnts::Tuple{Float64, Float64}: Voltage or Q-power error dead band thresholds (dbd1, dbd2)\nQ_lim::MinMax: Upper/Lower limit on reactive power V/Q control in REPCA (Q_min, Q_max)\nT_p::Float64: Active power lag time constant in REECB (s). Used only when PF_Flag = 1, validation range: (0, nothing)\nQ_lim_inner::MinMax: Upper/Lower limit on reactive power input in REECB (Q_min_inner, Q_max_inner). Only used when V_Flag = 1\nV_lim::MinMax: Upper/Lower limit on reactive power PI controller in REECB (V_min, V_max). Only used when V_Flag = 1\nK_qp::Float64: Reactive power regulator proportional gain (used when V_Flag = 1), validation range: (0, nothing)\nK_qi::Float64: Reactive power regulator integral gain (used when V_Flag = 1), validation range: (0, nothing)\nQ_ref::Float64: (default: 1.0) Reference Reactive Power Set-point (pu), validation range: (0, nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReactiveRenewableControllerAB model depends on the Flag\nn_states::Int: (Do not modify.) The states of the ReactiveRenewableControllerAB model depends on the Flag\n\n\n\n\n\n","category":"type"},{"location":"model_library/outer_control/#PowerSystems.get_K_c-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_c","text":"get_K_c(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_i-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_i","text":"get_K_i(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_i.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_p-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_p","text":"get_K_p(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_qi-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_qi","text":"get_K_qi(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_qi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_K_qp-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_K_qp","text":"get_K_qp(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB K_qp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_PF_Flag-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_PF_Flag","text":"get_PF_Flag(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB PF_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Q_lim-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Q_lim","text":"get_Q_lim(\n value::ReactiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ReactiveRenewableControllerAB Q_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Q_lim_inner-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Q_lim_inner","text":"get_Q_lim_inner(\n value::ReactiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ReactiveRenewableControllerAB Q_lim_inner.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Q_ref-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Q_ref","text":"get_Q_ref(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_R_c-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_R_c","text":"get_R_c(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB R_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_Ref_Flag-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_Ref_Flag","text":"get_Ref_Flag(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB Ref_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_fltr-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_fltr","text":"get_T_fltr(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_ft-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_ft","text":"get_T_ft(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB T_ft.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_fv-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_fv","text":"get_T_fv(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB T_fv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_T_p-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_T_p","text":"get_T_p(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_VC_Flag-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_VC_Flag","text":"get_VC_Flag(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB VC_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_Flag-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_V_Flag","text":"get_V_Flag(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB V_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_frz-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_V_frz","text":"get_V_frz(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB V_frz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_lim-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_V_lim","text":"get_V_lim(\n value::ReactiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ReactiveRenewableControllerAB V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_V_ref-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_V_ref","text":"get_V_ref(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_X_c-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_X_c","text":"get_X_c(value::ReactiveRenewableControllerAB) -> Float64\n\n\nGet ReactiveRenewableControllerAB X_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_branch_id_control-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_branch_id_control","text":"get_branch_id_control(\n value::ReactiveRenewableControllerAB\n) -> String\n\n\nGet ReactiveRenewableControllerAB branch_id_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_bus_control-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_bus_control","text":"get_bus_control(\n value::ReactiveRenewableControllerAB\n) -> Int64\n\n\nGet ReactiveRenewableControllerAB bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_dbd_pnts-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_dbd_pnts","text":"get_dbd_pnts(\n value::ReactiveRenewableControllerAB\n) -> Tuple{Float64, Float64}\n\n\nGet ReactiveRenewableControllerAB dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_e_lim-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_e_lim","text":"get_e_lim(\n value::ReactiveRenewableControllerAB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet ReactiveRenewableControllerAB e_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_ext-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_ext","text":"get_ext(\n value::ReactiveRenewableControllerAB\n) -> Dict{String, Any}\n\n\nGet ReactiveRenewableControllerAB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_from_branch_control-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_from_branch_control","text":"get_from_branch_control(\n value::ReactiveRenewableControllerAB\n) -> Int64\n\n\nGet ReactiveRenewableControllerAB from_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_n_states-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReactiveRenewableControllerAB) -> Int64\n\n\nGet ReactiveRenewableControllerAB n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_states-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_states","text":"get_states(\n value::ReactiveRenewableControllerAB\n) -> Vector{Symbol}\n\n\nGet ReactiveRenewableControllerAB states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.get_to_branch_control-Tuple{ReactiveRenewableControllerAB}","page":"OuterControl","title":"PowerSystems.get_to_branch_control","text":"get_to_branch_control(\n value::ReactiveRenewableControllerAB\n) -> Int64\n\n\nGet ReactiveRenewableControllerAB to_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_c!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_c!","text":"set_K_c!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_i!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_i!","text":"set_K_i!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_i.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_p!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_p!","text":"set_K_p!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_qi!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_qi!","text":"set_K_qi!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_qi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_K_qp!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_K_qp!","text":"set_K_qp!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB K_qp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_PF_Flag!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_PF_Flag!","text":"set_PF_Flag!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB PF_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_lim!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Q_lim!","text":"set_Q_lim!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB Q_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_lim_inner!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Q_lim_inner!","text":"set_Q_lim_inner!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB Q_lim_inner.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Q_ref!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Q_ref!","text":"set_Q_ref!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB Q_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_R_c!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_R_c!","text":"set_R_c!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB R_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_Ref_Flag!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_Ref_Flag!","text":"set_Ref_Flag!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB Ref_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_fltr!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_fltr!","text":"set_T_fltr!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB T_fltr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_ft!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_ft!","text":"set_T_ft!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB T_ft.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_fv!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_fv!","text":"set_T_fv!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB T_fv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_T_p!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_T_p!","text":"set_T_p!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB T_p.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_VC_Flag!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_VC_Flag!","text":"set_VC_Flag!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB VC_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_Flag!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_V_Flag!","text":"set_V_Flag!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB V_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_frz!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_V_frz!","text":"set_V_frz!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB V_frz.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_lim!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_V_lim!","text":"set_V_lim!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB V_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_V_ref!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_V_ref!","text":"set_V_ref!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB V_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_X_c!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_X_c!","text":"set_X_c!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB X_c.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_branch_id_control!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_branch_id_control!","text":"set_branch_id_control!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB branch_id_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_bus_control!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_bus_control!","text":"set_bus_control!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB bus_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_dbd_pnts!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_dbd_pnts!","text":"set_dbd_pnts!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_e_lim!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_e_lim!","text":"set_e_lim!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB e_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_ext!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReactiveRenewableControllerAB, val) -> Any\n\n\nSet ReactiveRenewableControllerAB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_from_branch_control!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_from_branch_control!","text":"set_from_branch_control!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB from_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"model_library/outer_control/#PowerSystems.set_to_branch_control!-Tuple{ReactiveRenewableControllerAB, Any}","page":"OuterControl","title":"PowerSystems.set_to_branch_control!","text":"set_to_branch_control!(\n value::ReactiveRenewableControllerAB,\n val\n) -> Any\n\n\nSet ReactiveRenewableControllerAB to_branch_control.\n\n\n\n\n\n","category":"method"},{"location":"how_to/parse_matpower_psse/#pm_data","page":"...parse data from MATPOWER or PSS/e files","title":"Parsing MATPOWER or PSS/e Files","text":"","category":"section"},{"location":"how_to/parse_matpower_psse/","page":"...parse data from MATPOWER or PSS/e files","title":"...parse data from MATPOWER or PSS/e files","text":"The following code will create a System from a MATPOWER .m or PSS/e .raw file:","category":"page"},{"location":"how_to/parse_matpower_psse/","page":"...parse data from MATPOWER or PSS/e files","title":"...parse data from MATPOWER or PSS/e files","text":"using PowerSystems\nfile_dir = joinpath(pkgdir(PowerSystems), \"docs\", \"src\", \"tutorials\", \"tutorials_data\")\nsys = System(joinpath(file_dir, \"case5.m\"))","category":"page"},{"location":"how_to/parse_matpower_psse/","page":"...parse data from MATPOWER or PSS/e files","title":"...parse data from MATPOWER or PSS/e files","text":"This parsing code was copied with permission from PowerModels.jl.","category":"page"},{"location":"how_to/parse_matpower_psse/#See-also:","page":"...parse data from MATPOWER or PSS/e files","title":"See also:","text":"","category":"section"},{"location":"how_to/parse_matpower_psse/","page":"...parse data from MATPOWER or PSS/e files","title":"...parse data from MATPOWER or PSS/e files","text":"Parsing PSS/e .dyr Files, which also includes an example of parsing a .raw file\nParsing table data (CSV Files)\nParsing time series","category":"page"},{"location":"model_library/generated_InnerControl/#InnerControl","page":"InnerControl","title":"InnerControl","text":"","category":"section"},{"location":"model_library/generated_InnerControl/#CurrentModeControl","page":"InnerControl","title":"CurrentModeControl","text":"","category":"section"},{"location":"model_library/generated_InnerControl/","page":"InnerControl","title":"InnerControl","text":"Modules = [PowerSystems]\nPages = [\"/CurrentModeControl.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InnerControl/#PowerSystems.CurrentModeControl","page":"InnerControl","title":"PowerSystems.CurrentModeControl","text":"mutable struct CurrentModeControl <: InnerControl\n kpc::Float64\n kic::Float64\n kffv::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an inner loop proportional integral (PI) current control based on \"Reduced-order Structure-preserving Model for Parallel-connected Three-phase Grid-tied Inverters.\"\n\nArguments\n\nkpc::Float64: Current controller proportional gain, validation range: (0, nothing)\nkic::Float64: Current controller integral gain, validation range: (0, nothing)\nkffv::Float64: Gain to enable feed-forward gain of voltage, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the CurrentModeControl model are:\n\nγd_ic: d-axis integrator state of the PI current controller,\nγq_ic: q-axis integrator state of the PI current controller\n\nn_states::Int: (Do not modify.) CurrentControl has 2 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_ext-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_ext","text":"get_ext(value::CurrentModeControl) -> Dict{String, Any}\n\n\nGet CurrentModeControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kffv-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_kffv","text":"get_kffv(value::CurrentModeControl) -> Float64\n\n\nGet CurrentModeControl kffv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kic-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_kic","text":"get_kic(value::CurrentModeControl) -> Float64\n\n\nGet CurrentModeControl kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kpc-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_kpc","text":"get_kpc(value::CurrentModeControl) -> Float64\n\n\nGet CurrentModeControl kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_n_states-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::CurrentModeControl) -> Int64\n\n\nGet CurrentModeControl n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_states-Tuple{CurrentModeControl}","page":"InnerControl","title":"PowerSystems.get_states","text":"get_states(value::CurrentModeControl) -> Vector{Symbol}\n\n\nGet CurrentModeControl states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_ext!-Tuple{CurrentModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::CurrentModeControl, val) -> Any\n\n\nSet CurrentModeControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kffv!-Tuple{CurrentModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kffv!","text":"set_kffv!(value::CurrentModeControl, val) -> Any\n\n\nSet CurrentModeControl kffv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kic!-Tuple{CurrentModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kic!","text":"set_kic!(value::CurrentModeControl, val) -> Any\n\n\nSet CurrentModeControl kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kpc!-Tuple{CurrentModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kpc!","text":"set_kpc!(value::CurrentModeControl, val) -> Any\n\n\nSet CurrentModeControl kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#RECurrentControlB","page":"InnerControl","title":"RECurrentControlB","text":"","category":"section"},{"location":"model_library/generated_InnerControl/","page":"InnerControl","title":"InnerControl","text":"Modules = [PowerSystems]\nPages = [\"/RECurrentControlB.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InnerControl/#PowerSystems.RECurrentControlB","page":"InnerControl","title":"PowerSystems.RECurrentControlB","text":"mutable struct RECurrentControlB <: InnerControl\n Q_Flag::Int\n PQ_Flag::Int\n Vdip_lim::MinMax\n T_rv::Float64\n dbd_pnts::Tuple{Float64, Float64}\n K_qv::Float64\n Iqinj_lim::MinMax\n V_ref0::Float64\n K_vp::Float64\n K_vi::Float64\n T_iq::Float64\n I_max::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of the Inner Control part of the REECB model in PSS/E\n\nArguments\n\nQ_Flag::Int: Q Flag used for I_qinj, validation range: (0, 1)\nPQ_Flag::Int: PQ Flag used for the Current Limit Logic, validation range: (0, 1)\nVdip_lim::MinMax: Limits for Voltage Dip Logic (Vdip, Vup)\nT_rv::Float64: Voltage Filter Time Constant, validation range: (0, nothing)\ndbd_pnts::Tuple{Float64, Float64}: Voltage error deadband thresholds (dbd1, dbd2)\nK_qv::Float64: Reactive current injection gain during over and undervoltage conditions, validation range: (0, nothing)\nIqinj_lim::MinMax: Limits for Iqinj (I_qh1, I_ql1)\nV_ref0::Float64: User defined reference. If 0, PowerSimulationsDynamics.jl initializes to initial terminal voltage, validation range: (0, nothing)\nK_vp::Float64: Voltage regulator proportional gain (used when QFlag = 1), validation range: (0, nothing)\nK_vi::Float64: Voltage regulator integral gain (used when QFlag = 1), validation range: (0, nothing)\nT_iq::Float64: Time constant for low-pass filter for state q_V when QFlag = 0, validation range: (0, nothing)\nI_max::Float64: Maximum limit on total converter current, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the RECurrentControlB depends on the Flags\nn_states::Int: (Do not modify.) The states of the RECurrentControlB depends on the Flags\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_I_max-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_I_max","text":"get_I_max(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_Iqinj_lim-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_Iqinj_lim","text":"get_Iqinj_lim(\n value::RECurrentControlB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RECurrentControlB Iqinj_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_K_qv-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_K_qv","text":"get_K_qv(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB K_qv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_K_vi-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_K_vi","text":"get_K_vi(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB K_vi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_K_vp-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_K_vp","text":"get_K_vp(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB K_vp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_PQ_Flag-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_PQ_Flag","text":"get_PQ_Flag(value::RECurrentControlB) -> Int64\n\n\nGet RECurrentControlB PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_Q_Flag-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_Q_Flag","text":"get_Q_Flag(value::RECurrentControlB) -> Int64\n\n\nGet RECurrentControlB Q_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_T_iq-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_T_iq","text":"get_T_iq(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB T_iq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_T_rv-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_T_rv","text":"get_T_rv(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB T_rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_V_ref0-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_V_ref0","text":"get_V_ref0(value::RECurrentControlB) -> Float64\n\n\nGet RECurrentControlB V_ref0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_Vdip_lim-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_Vdip_lim","text":"get_Vdip_lim(\n value::RECurrentControlB\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nGet RECurrentControlB Vdip_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_dbd_pnts-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_dbd_pnts","text":"get_dbd_pnts(\n value::RECurrentControlB\n) -> Tuple{Float64, Float64}\n\n\nGet RECurrentControlB dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_ext-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_ext","text":"get_ext(value::RECurrentControlB) -> Dict{String, Any}\n\n\nGet RECurrentControlB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_n_states-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::RECurrentControlB) -> Int64\n\n\nGet RECurrentControlB n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_states-Tuple{RECurrentControlB}","page":"InnerControl","title":"PowerSystems.get_states","text":"get_states(value::RECurrentControlB) -> Vector{Symbol}\n\n\nGet RECurrentControlB states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_I_max!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_I_max!","text":"set_I_max!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB I_max.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_Iqinj_lim!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_Iqinj_lim!","text":"set_Iqinj_lim!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB Iqinj_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_K_qv!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_K_qv!","text":"set_K_qv!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB K_qv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_K_vi!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_K_vi!","text":"set_K_vi!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB K_vi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_K_vp!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_K_vp!","text":"set_K_vp!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB K_vp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_PQ_Flag!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_PQ_Flag!","text":"set_PQ_Flag!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB PQ_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_Q_Flag!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_Q_Flag!","text":"set_Q_Flag!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB Q_Flag.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_T_iq!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_T_iq!","text":"set_T_iq!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB T_iq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_T_rv!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_T_rv!","text":"set_T_rv!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB T_rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_V_ref0!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_V_ref0!","text":"set_V_ref0!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB V_ref0.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_Vdip_lim!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_Vdip_lim!","text":"set_Vdip_lim!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB Vdip_lim.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_dbd_pnts!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_dbd_pnts!","text":"set_dbd_pnts!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB dbd_pnts.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_ext!-Tuple{RECurrentControlB, Any}","page":"InnerControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::RECurrentControlB, val) -> Any\n\n\nSet RECurrentControlB ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#VoltageModeControl","page":"InnerControl","title":"VoltageModeControl","text":"","category":"section"},{"location":"model_library/generated_InnerControl/","page":"InnerControl","title":"InnerControl","text":"Modules = [PowerSystems]\nPages = [\"/VoltageModeControl.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_InnerControl/#PowerSystems.VoltageModeControl","page":"InnerControl","title":"PowerSystems.VoltageModeControl","text":"mutable struct VoltageModeControl <: InnerControl\n kpv::Float64\n kiv::Float64\n kffv::Float64\n rv::Float64\n lv::Float64\n kpc::Float64\n kic::Float64\n kffi::Float64\n ωad::Float64\n kad::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of an inner loop current control PID using virtual impedance based on \"A Virtual Synchronous Machine implementation for distributed control of power converters in SmartGrids.\"\n\nArguments\n\nkpv::Float64: voltage controller proportional gain, validation range: (0, nothing)\nkiv::Float64: voltage controller integral gain, validation range: (0, nothing)\nkffv::Float64: Binary variable to enable feed-forward gain of voltage, validation range: (0, nothing)\nrv::Float64: virtual resistance, validation range: (0, nothing)\nlv::Float64: virtual inductance, validation range: (0, nothing)\nkpc::Float64: current controller proportional gain, validation range: (0, nothing)\nkic::Float64: current controller integral gain, validation range: (0, nothing)\nkffi::Float64: Binary variable to enable feed-forward gain of current, validation range: (0, nothing)\nωad::Float64: active damping filter cutoff frequency (rad/sec), validation range: (0, nothing)\nkad::Float64: active damping gain, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the VoltageModeControl model are:\n\nξd_ic: d-axis integrator state of the PI voltage controller,\nξq_ic: q-axis integrator state of the PI voltage controller,\nγd_ic: d-axis integrator state of the PI current controller,\nγq_ic: q-axis integrator state of the PI current controller,\nϕd_ic: d-axis low-pass filter of active damping,\nϕq_ic: q-axis low-pass filter of active damping\n\nn_states::Int: (Do not modify.) VoltageModeControl has 6 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_ext-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_ext","text":"get_ext(value::VoltageModeControl) -> Dict{String, Any}\n\n\nGet VoltageModeControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kad-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kad","text":"get_kad(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kffi-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kffi","text":"get_kffi(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kffi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kffv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kffv","text":"get_kffv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kffv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kic-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kic","text":"get_kic(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kiv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kiv","text":"get_kiv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kpc-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kpc","text":"get_kpc(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_kpv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_kpv","text":"get_kpv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_lv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_lv","text":"get_lv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl lv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_n_states-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_n_states","text":"get_n_states(value::VoltageModeControl) -> Int64\n\n\nGet VoltageModeControl n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_rv-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_rv","text":"get_rv(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_states-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_states","text":"get_states(value::VoltageModeControl) -> Vector{Symbol}\n\n\nGet VoltageModeControl states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.get_ωad-Tuple{VoltageModeControl}","page":"InnerControl","title":"PowerSystems.get_ωad","text":"get_ωad(value::VoltageModeControl) -> Float64\n\n\nGet VoltageModeControl ωad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_ext!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_ext!","text":"set_ext!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kad!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kad!","text":"set_kad!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kffi!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kffi!","text":"set_kffi!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kffi.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kffv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kffv!","text":"set_kffv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kffv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kic!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kic!","text":"set_kic!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kic.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kiv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kiv!","text":"set_kiv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kiv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kpc!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kpc!","text":"set_kpc!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kpc.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_kpv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_kpv!","text":"set_kpv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl kpv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_lv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_lv!","text":"set_lv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl lv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_rv!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_rv!","text":"set_rv!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl rv.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_InnerControl/#PowerSystems.set_ωad!-Tuple{VoltageModeControl, Any}","page":"InnerControl","title":"PowerSystems.set_ωad!","text":"set_ωad!(value::VoltageModeControl, val) -> Any\n\n\nSet VoltageModeControl ωad.\n\n\n\n\n\n","category":"method"},{"location":"how_to/serialize_data/#Write,-View,-and-Load-Data-with-a-JSON","page":"...write and read data with a JSON","title":"Write, View, and Load Data with a JSON","text":"","category":"section"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"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.","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"The sections below show how to write data to a JSON, explore the data while it is in JSON format, and load Data saved in a JSON back into PowerSystems.jl.","category":"page"},{"location":"how_to/serialize_data/#Write-data-to-a-JSON","page":"...write and read data with a JSON","title":"Write data to a JSON","text":"","category":"section"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"You can do this to save your own custom System, but we'll use an existing dataset from PowerSystemCaseBuilder.jl, simply to illustrate the process.","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"First, load the dependencies and a System from PowerSystemCaseBuilder:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"using PowerSystems\nusing PowerSystemCaseBuilder\nsys = build_system(PSISystems, \"c_sys5_pjm\")","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Set up your target path, for example in a \"mysystems\" subfolder:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"folder = mkdir(\"mysystems\");\npath = joinpath(folder, \"system.json\")","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Now write the system to JSON:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"to_json(sys, path)","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Notice in the Info statements that the serialization process stores 3 files:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"System data file (*.json file)\nValidation data file (*.json file)\nTime Series data file (*.h5 file)","category":"page"},{"location":"how_to/serialize_data/#Viewing-PowerSystems-Data-in-JSON-Format","page":"...write and read data with a JSON","title":"Viewing PowerSystems Data in JSON Format","text":"","category":"section"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Some users prefer to view and filter the PowerSystems.jl data while it is in JSON format. There are many tools available to browse JSON data.","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Here is an example GUI tool that is available online in a browser.","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"The command line utility jq offers even more features. Below are some example commands, called from the command line within the \"mysystems\" subfolder:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"View the entire file pretty-printed:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq . system.json","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"View the PowerSystems component types:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq '.data.components | .[] | .__metadata__ | .type' system.json | sort | uniq","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"View specific components:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq '.data.components | .[] | select(.__metadata__.type == \"ThermalStandard\")' system.json","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Get the count of a component type:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"# There is almost certainly a better way.\njq '.data.components | .[] | select(.__metadata__.type == \"ThermalStandard\")' system.json | grep -c ThermalStandard","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"View specific component by name:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq '.data.components | .[] | select(.__metadata__.type == \"ThermalStandard\" and .name == \"107_CC_1\")' system.json","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Filter on a field value:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"jq '.data.components | .[] | select(.__metadata__.type == \"ThermalStandard\" and .active_power > 2.3)' system.json","category":"page"},{"location":"how_to/serialize_data/#Read-the-JSON-file-and-create-a-new-System","page":"...write and read data with a JSON","title":"Read the JSON file and create a new System","text":"","category":"section"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"Finally, you can read the file back in, and verify the new system has the same data as above:","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"sys2 = System(path)\nrm(folder; recursive = true); #hide","category":"page"},{"location":"how_to/serialize_data/","page":"...write and read data with a JSON","title":"...write and read data with a JSON","text":"tip: Tip\nPowerSystems 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(path; assign_new_uuids = true)","category":"page"},{"location":"model_library/generated_TransmissionInterface/#TransmissionInterface","page":"TransmissionInterface","title":"TransmissionInterface","text":"","category":"section"},{"location":"model_library/generated_TransmissionInterface/","page":"TransmissionInterface","title":"TransmissionInterface","text":"Modules = [PowerSystems]\nPages = [\"generated/TransmissionInterface.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.TransmissionInterface","page":"TransmissionInterface","title":"PowerSystems.TransmissionInterface","text":"mutable struct TransmissionInterface <: Service\n name::String\n available::Bool\n active_power_flow_limits::MinMax\n violation_penalty::Float64\n direction_mapping::Dict{String, Int}\n internal::InfrastructureSystemsInternal\nend\n\nA collection of branches that make up an interface or corridor for the transfer of power, such as between different Areas or LoadZones.\n\nThe interface can be used to constrain the power flow across it\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nactive_power_flow_limits::MinMax: Minimum and maximum active power flow limits on the interface (MW)\nviolation_penalty::Float64: (default: INFINITE_COST) Penalty cost for violating the flow limits in the interface\ndirection_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\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_TransmissionInterface/#InfrastructureSystems.get_name-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"InfrastructureSystems.get_name","text":"get_name(value::TransmissionInterface) -> String\n\n\nGet TransmissionInterface name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.get_active_power_flow_limits-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"PowerSystems.get_active_power_flow_limits","text":"get_active_power_flow_limits(\n value::TransmissionInterface\n) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}\n\n\nGet TransmissionInterface active_power_flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.get_available-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"PowerSystems.get_available","text":"get_available(value::TransmissionInterface) -> Bool\n\n\nGet TransmissionInterface available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.get_direction_mapping-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"PowerSystems.get_direction_mapping","text":"get_direction_mapping(\n value::TransmissionInterface\n) -> Dict{String, Int64}\n\n\nGet TransmissionInterface direction_mapping.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.get_violation_penalty-Tuple{TransmissionInterface}","page":"TransmissionInterface","title":"PowerSystems.get_violation_penalty","text":"get_violation_penalty(\n value::TransmissionInterface\n) -> Float64\n\n\nGet TransmissionInterface violation_penalty.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.set_active_power_flow_limits!-Tuple{TransmissionInterface, Any}","page":"TransmissionInterface","title":"PowerSystems.set_active_power_flow_limits!","text":"set_active_power_flow_limits!(\n value::TransmissionInterface,\n val\n) -> Any\n\n\nSet TransmissionInterface active_power_flow_limits.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.set_available!-Tuple{TransmissionInterface, Any}","page":"TransmissionInterface","title":"PowerSystems.set_available!","text":"set_available!(value::TransmissionInterface, val) -> Any\n\n\nSet TransmissionInterface available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.set_direction_mapping!-Tuple{TransmissionInterface, Any}","page":"TransmissionInterface","title":"PowerSystems.set_direction_mapping!","text":"set_direction_mapping!(\n value::TransmissionInterface,\n val\n) -> Any\n\n\nSet TransmissionInterface direction_mapping.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_TransmissionInterface/#PowerSystems.set_violation_penalty!-Tuple{TransmissionInterface, Any}","page":"TransmissionInterface","title":"PowerSystems.set_violation_penalty!","text":"set_violation_penalty!(\n value::TransmissionInterface,\n val\n) -> Any\n\n\nSet TransmissionInterface violation_penalty.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#SingleCageInductionMachine","page":"SingleCageInductionMachine","title":"SingleCageInductionMachine","text":"","category":"section"},{"location":"model_library/generated_SingleCageInductionMachine/","page":"SingleCageInductionMachine","title":"SingleCageInductionMachine","text":"Modules = [PowerSystems]\nPages = [\"generated/SingleCageInductionMachine.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.SingleCageInductionMachine","page":"SingleCageInductionMachine","title":"PowerSystems.SingleCageInductionMachine","text":"mutable struct SingleCageInductionMachine <: DynamicInjection\n name::String\n R_s::Float64\n R_r::Float64\n X_ls::Float64\n X_lr::Float64\n X_m::Float64\n H::Float64\n A::Float64\n B::Float64\n base_power::Float64\n ext::Dict{String, Any}\n C::Float64\n τ_ref::Float64\n B_shunt::Float64\n X_ad::Float64\n X_aq::Float64\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nParameters of 5-states three-phase single cage induction machine with quadratic torque-speed relationship\n\nArguments\n\nname::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\nR_s::Float64: Armature stator resistance, validation range: (0, nothing)\nR_r::Float64: Rotor resistance, validation range: (0, nothing)\nX_ls::Float64: Stator Leakage Reactance, validation range: (0, nothing)\nX_lr::Float64: Rotor Leakage Reactance, validation range: (0, nothing)\nX_m::Float64: Stator-Rotor Mutual Reactance, validation range: (0, nothing)\nH::Float64: Motor Inertia Constant [s], validation range: (0, nothing)\nA::Float64: Torque-Speed Quadratic Term, validation range: (0, 1)\nB::Float64: Torque-Speed Linear Term, validation range: (0, 1)\nbase_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)\next::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.\nC::Float64: (Do not modify.) Torque-Speed Constant Term\nτ_ref::Float64: Reference torque parameter\nB_shunt::Float64: Susceptance Initialization Corrector Term\nX_ad::Float64: (Do not modify.) Equivalent d-axis reactance\nX_aq::Float64: (Do not modify.) Equivalent q-axis reactance\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nψ_qs: stator flux in the q-axis,\nψ_ds: stator flux in the d-axis,\nψ_qr: rotor flux in the q-axis,\nψ_dr: rotor flux in the d-axis, \nωr: Rotor speed [pu],\n\nn_states::Int: (Do not modify.) SingleCageInductionMachine has 5 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_SingleCageInductionMachine/#InfrastructureSystems.get_name-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"InfrastructureSystems.get_name","text":"get_name(value::SingleCageInductionMachine) -> String\n\n\nGet SingleCageInductionMachine name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_A-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_A","text":"get_A(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine A.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_B-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_B","text":"get_B(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine B.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_B_shunt-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_B_shunt","text":"get_B_shunt(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine B_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_C-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_C","text":"get_C(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine C.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_H-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_H","text":"get_H(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_R_r-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_R_r","text":"get_R_r(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine R_r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_R_s-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_R_s","text":"get_R_s(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine R_s.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_ad-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_ad","text":"get_X_ad(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_aq-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_aq","text":"get_X_aq(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_lr-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_lr","text":"get_X_lr(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_ls-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_ls","text":"get_X_ls(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_ls.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_X_m-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_X_m","text":"get_X_m(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine X_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_base_power-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_base_power","text":"get_base_power(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_ext-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_ext","text":"get_ext(\n value::SingleCageInductionMachine\n) -> Dict{String, Any}\n\n\nGet SingleCageInductionMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_n_states-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_n_states","text":"get_n_states(value::SingleCageInductionMachine) -> Int64\n\n\nGet SingleCageInductionMachine n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_states-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_states","text":"get_states(\n value::SingleCageInductionMachine\n) -> Vector{Symbol}\n\n\nGet SingleCageInductionMachine states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.get_τ_ref-Tuple{SingleCageInductionMachine}","page":"SingleCageInductionMachine","title":"PowerSystems.get_τ_ref","text":"get_τ_ref(value::SingleCageInductionMachine) -> Float64\n\n\nGet SingleCageInductionMachine τ_ref.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_A!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_A!","text":"set_A!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine A.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_B!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_B!","text":"set_B!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine B.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_B_shunt!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_B_shunt!","text":"set_B_shunt!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine B_shunt.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_C!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_C!","text":"set_C!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine C.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_H!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_H!","text":"set_H!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine H.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_R_r!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_R_r!","text":"set_R_r!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine R_r.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_R_s!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_R_s!","text":"set_R_s!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine R_s.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_ad!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_ad!","text":"set_X_ad!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_ad.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_aq!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_aq!","text":"set_X_aq!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_aq.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_lr!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_lr!","text":"set_X_lr!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_lr.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_ls!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_ls!","text":"set_X_ls!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_ls.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_X_m!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_X_m!","text":"set_X_m!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine X_m.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_base_power!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_base_power!","text":"set_base_power!(\n value::SingleCageInductionMachine,\n val\n) -> Any\n\n\nSet SingleCageInductionMachine base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_ext!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_ext!","text":"set_ext!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_SingleCageInductionMachine/#PowerSystems.set_τ_ref!-Tuple{SingleCageInductionMachine, Any}","page":"SingleCageInductionMachine","title":"PowerSystems.set_τ_ref!","text":"set_τ_ref!(value::SingleCageInductionMachine, val) -> Any\n\n\nSet SingleCageInductionMachine τ_ref.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/","page":"Internals","title":"Internals","text":"CollapsedDocStrings = true","category":"page"},{"location":"api/internal/#Internal-API","page":"Internals","title":"Internal API","text":"","category":"section"},{"location":"api/internal/","page":"Internals","title":"Internals","text":"Modules = [PowerSystems]\nPublic = false","category":"page"},{"location":"api/internal/#PowerSystems._pti_dtypes","page":"Internals","title":"PowerSystems._pti_dtypes","text":"lookup array of data types for PTI file sections given by field_name, as enumerated by PSS/E Program Operation Manual.\n\n\n\n\n\n","category":"constant"},{"location":"api/internal/#PowerSystems._pti_sections","page":"Internals","title":"PowerSystems._pti_sections","text":"A list of data file sections in the order that they appear in a PTI v33 file\n\n\n\n\n\n","category":"constant"},{"location":"api/internal/#PowerSystems.pm_component_status","page":"Internals","title":"PowerSystems.pm_component_status","text":"maps component types to status parameters\n\n\n\n\n\n","category":"constant"},{"location":"api/internal/#PowerSystems.pm_component_status_inactive","page":"Internals","title":"PowerSystems.pm_component_status_inactive","text":"maps component types to inactive status values\n\n\n\n\n\n","category":"constant"},{"location":"api/internal/#PowerSystems.EX4VSA","page":"Internals","title":"PowerSystems.EX4VSA","text":"mutable struct EX4VSA <: AVR\n Iflim::Float64\n d::Float64\n f::Float64\n Spar::Float64\n K1::Float64\n K2::Float64\n Oel_lim::MinMax\n G::Float64\n Ta::Float64\n Tb::Float64\n Te::Float64\n E_lim::MinMax\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Excitation System for Voltage Security Assesment\n\nArguments\n\nIflim::Float64: OEL Field current limit, validation range: (0, nothing)\nd::Float64: OEL parameter d, validation range: (0, nothing)\nf::Float64: OEL parameter f, validation range: (0, nothing)\nSpar::Float64: OEL parameter Spar, validation range: (0, nothing)\nK1::Float64: OEL delay time constant, validation range: (0, nothing)\nK2::Float64: OEL parameter K2, validation range: (0, nothing)\nOel_lim::MinMax: Oel integrator limits (Oelmin, Oelmax)\nG::Float64: AVR Exciter Gain, validation range: (0, nothing)\nTa::Float64: Numerator lead-lag (lag) time constant in s, validation range: (0, nothing)\nTb::Float64: Denominator lead-lag (lag) time constant in s, validation range: (0, nothing)\nTe::Float64: Exciter Time Constant in s, validation range: (0, nothing)\nE_lim::MinMax: Voltage regulator limits (regulator output) (Emin, Emax)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVll: Lead-lag internal state,\nVex: Exciter Output, \noel: OEL integrator state\n\nn_states::Int: (Do not modify.) The EX4VSA has 3 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerSystems.EXST1","page":"Internals","title":"PowerSystems.EXST1","text":"mutable struct EXST1 <: AVR\n Tr::Float64\n Vi_lim::MinMax\n Tc::Float64\n Tb::Float64\n Ka::Float64\n Ta::Float64\n Vr_lim::MinMax\n Kc::Float64\n Kf::Float64\n Tf::Float64\n V_ref::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\n internal::InfrastructureSystemsInternal\nend\n\nIEEE Type ST1 Excitation System (PTI version)\n\nArguments\n\nTr::Float64: Voltage Measurement Time Constant in s, validation range: (0, nothing)\nVi_lim::MinMax: Voltage input limits (Vimin, Vimax)\nTc::Float64: Numerator lead-lag (lead) time constant in s, validation range: (0, nothing)\nTb::Float64: Denominator lead-lag (lag) time constant in s, validation range: (0, nothing)\nKa::Float64: Amplifier Gain, validation range: (0, nothing)\nTa::Float64: Amplifier Time Constant in s, validation range: (0, nothing)\nVr_lim::MinMax: Voltage regulator limits (regulator output) (Vrmin, Vrmax)\nKc::Float64: Current field constant limiter multiplier, validation range: (0, nothing)\nKf::Float64: Excitation control system stabilizer gain, validation range: (eps(), 0.3)\nTf::Float64: Excitation control system stabilizer time constant, validation range: (eps(), nothing)\nV_ref::Float64: (default: 1.0) Reference Voltage Set-point (pu), validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states are:\n\nVm: Sensed Terminal Voltage,\nVrll: Lead-Lag state,\nVr: Regulator Output, \nVfb: Feedback state\n\nn_states::Int: (Do not modify.) The EXST1 has 4 states\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerSystems.PowerFlowDataNetwork","page":"Internals","title":"PowerSystems.PowerFlowDataNetwork","text":"Container for data parsed by PowerFlowData\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerSystems.PowerFlowDataNetwork-Tuple{Union{IO, String}}","page":"Internals","title":"PowerSystems.PowerFlowDataNetwork","text":"PowerFlowDataNetwork(\n file::Union{IO, String};\n kwargs...\n) -> PowerSystems.PowerFlowDataNetwork\n\n\nConstructs PowerFlowDataNetwork from a raw file. Currently Supports PSSE data files v30, v32 and v33\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._FieldInfo","page":"Internals","title":"PowerSystems._FieldInfo","text":"Stores user-customized information for required dataframe columns.\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerSystems._HeatRateColumns","page":"Internals","title":"PowerSystems._HeatRateColumns","text":"Add generators to the System from the raw data.\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#Base.convert-Tuple{Type{@NamedTuple{min::Float64, max::Float64}}, Tuple{Float64, Float64}}","page":"Internals","title":"Base.convert","text":"convert(\n _::Type{@NamedTuple{min::Float64, max::Float64}},\n input::Tuple{Float64, Float64}\n) -> @NamedTuple{min::Float64, max::Float64}\n\n\nConvert Tuple to Min Max Named Tuple\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#Base.convert-Tuple{Type{@NamedTuple{up::Float64, down::Float64}}, Tuple{Float64, Float64}}","page":"Internals","title":"Base.convert","text":"convert(\n _::Type{@NamedTuple{up::Float64, down::Float64}},\n input::Tuple{Float64, Float64}\n) -> @NamedTuple{up::Float64, down::Float64}\n\n\nConvert Tuple to Up Down Named Tuple\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.assign_new_uuid!-Tuple{System, Component}","page":"Internals","title":"InfrastructureSystems.assign_new_uuid!","text":"assign_new_uuid!(sys::System, x::Component)\n\n\nChange the UUID of a component.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ACBus}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ACBus\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ACBus internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AGC}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AGC\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AGC internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AVRFixed}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AVRFixed\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AVRFixed internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AVRSimple}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AVRSimple\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AVRSimple internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AVRTypeII}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AVRTypeII\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AVRTypeII internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AVRTypeI}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AVRTypeI\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AVRTypeI internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ActiveConstantPowerLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ActiveConstantPowerLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ActiveConstantPowerLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AggregateDistributedGenerationA}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AggregateDistributedGenerationA\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AggregateDistributedGenerationA internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AndersonFouadMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AndersonFouadMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AndersonFouadMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Arc}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Arc\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Arc internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{AreaInterchange}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::AreaInterchange\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet AreaInterchange internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Area}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Area\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Area internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{BaseMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::BaseMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet BaseMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{CSVGN1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::CSVGN1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet CSVGN1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ConstantReserveGroup}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ConstantReserveGroup\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ConstantReserveGroup internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ConstantReserveNonSpinning}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ConstantReserveNonSpinning\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ConstantReserveNonSpinning internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ConstantReserve}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ConstantReserve\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ConstantReserve internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DCBus}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DCBus\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DCBus internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DEGOV1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DEGOV1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DEGOV1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DEGOV}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DEGOV\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DEGOV internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DynamicBranch}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DynamicBranch\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DynamicBranch internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{DynamicExponentialLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::DynamicExponentialLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet DynamicExponentialLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESAC1A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESAC1A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESAC1A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESAC6A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESAC6A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESAC6A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESAC8B}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESAC8B\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESAC8B internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESDC1A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESDC1A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESDC1A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESDC2A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESDC2A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESDC2A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESST1A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESST1A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESST1A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ESST4B}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ESST4B\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ESST4B internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EXAC1A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EXAC1A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXAC1A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EXAC1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EXAC1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXAC1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EXAC2}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EXAC2\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXAC2 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EXPIC1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EXPIC1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXPIC1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{EnergyReservoirStorage}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::EnergyReservoirStorage\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EnergyReservoirStorage internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ExponentialLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ExponentialLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ExponentialLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{FiveMassShaft}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::FiveMassShaft\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet FiveMassShaft internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{FixedAdmittance}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::FixedAdmittance\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet FixedAdmittance internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{FixedDCSource}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::FixedDCSource\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet FixedDCSource internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{FullMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::FullMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet FullMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{GasTG}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::GasTG\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet GasTG internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{GeneralGovModel}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::GeneralGovModel\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet GeneralGovModel internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{GenericDER}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::GenericDER\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet GenericDER internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HybridSystem}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HybridSystem\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HybridSystem internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HydroDispatch}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HydroDispatch\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HydroDispatch internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HydroEnergyReservoir}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HydroEnergyReservoir\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HydroEnergyReservoir internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HydroPumpedStorage}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HydroPumpedStorage\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HydroPumpedStorage internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{HydroTurbineGov}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::HydroTurbineGov\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet HydroTurbineGov internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{IEEEST}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::IEEEST\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet IEEEST internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{IEEET1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::IEEET1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet IEEET1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{IEEETurbineGov1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::IEEETurbineGov1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet IEEETurbineGov1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{InterconnectingConverter}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::InterconnectingConverter\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet InterconnectingConverter internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{InterruptiblePowerLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::InterruptiblePowerLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet InterruptiblePowerLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Line}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Line\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Line internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{LoadZone}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::LoadZone\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet LoadZone internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{MarconatoMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::MarconatoMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet MarconatoMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{MonitoredLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::MonitoredLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet MonitoredLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{OneDOneQMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::OneDOneQMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet OneDOneQMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Outage}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(x::Outage) -> Any\n\n\nGet internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PIDGOV}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PIDGOV\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PIDGOV internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSS2A}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSS2A\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSS2A internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSS2B}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSS2B\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSS2B internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSS2C}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSS2C\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSS2C internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSSFixed}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSSFixed\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSSFixed internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PSSSimple}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PSSSimple\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PSSSimple internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PeriodicVariableSource}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PeriodicVariableSource\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PeriodicVariableSource internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PhaseShiftingTransformer}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PhaseShiftingTransformer\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PhaseShiftingTransformer internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PowerLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PowerLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet PowerLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PowerSystems.EX4VSA}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PowerSystems.EX4VSA\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EX4VSA internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{PowerSystems.EXST1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::PowerSystems.EXST1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet EXST1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{RenewableDispatch}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::RenewableDispatch\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet RenewableDispatch internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{RenewableNonDispatch}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::RenewableNonDispatch\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet RenewableNonDispatch internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ReserveDemandCurve}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ReserveDemandCurve\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ReserveDemandCurve internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{RoundRotorMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::RoundRotorMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet RoundRotorMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SCRX}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SCRX\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SCRX internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SEXS}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SEXS\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SEXS internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ST6B}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ST6B\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ST6B internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ST8C}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ST8C\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ST8C internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{STAB1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::STAB1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet STAB1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SalientPoleMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SalientPoleMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SalientPoleMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SauerPaiMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SauerPaiMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SauerPaiMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SimpleAFMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SimpleAFMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SimpleAFMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SimpleFullMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SimpleFullMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SimpleFullMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SimpleMarconatoMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SimpleMarconatoMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SimpleMarconatoMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SimplifiedSingleCageInductionMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SimplifiedSingleCageInductionMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SimplifiedSingleCageInductionMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SingleCageInductionMachine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SingleCageInductionMachine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SingleCageInductionMachine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SingleMass}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SingleMass\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SingleMass internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Source}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Source\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Source internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{StandardLoad}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::StandardLoad\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet StandardLoad internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SteamTurbineGov1}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SteamTurbineGov1\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SteamTurbineGov1 internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{SwitchedAdmittance}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::SwitchedAdmittance\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet SwitchedAdmittance internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{System}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n sys::System\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nReturn the internal of the system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TGFixed}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TGFixed\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TGFixed internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TGSimple}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TGSimple\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TGSimple internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TGTypeII}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TGTypeII\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TGTypeII internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TGTypeI}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TGTypeI\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TGTypeI internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TModelHVDCLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TModelHVDCLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TModelHVDCLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TapTransformer}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TapTransformer\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TapTransformer internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ThermalMultiStart}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ThermalMultiStart\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ThermalMultiStart internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{ThermalStandard}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::ThermalStandard\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet ThermalStandard internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{Transformer2W}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::Transformer2W\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet Transformer2W internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TransmissionInterface}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TransmissionInterface\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TransmissionInterface internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TwoTerminalHVDCDetailedLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TwoTerminalHVDCDetailedLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TwoTerminalHVDCDetailedLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TwoTerminalHVDCLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TwoTerminalHVDCLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TwoTerminalHVDCLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{TwoTerminalVSCDCLine}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::TwoTerminalVSCDCLine\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet TwoTerminalVSCDCLine internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{VariableReserveNonSpinning}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::VariableReserveNonSpinning\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet VariableReserveNonSpinning internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{VariableReserve}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::VariableReserve\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet VariableReserve internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#InfrastructureSystems.get_internal-Tuple{WPIDHY}","page":"Internals","title":"InfrastructureSystems.get_internal","text":"get_internal(\n value::WPIDHY\n) -> InfrastructureSystems.InfrastructureSystemsInternal\n\n\nGet WPIDHY internal.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._add_dcline_costs!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._add_dcline_costs!","text":"_add_dcline_costs!(data::Dict{String, Any})\n\n\nadds dcline costs, if gen costs exist\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._add_line_delimiter-Tuple{AbstractString, Any, Any}","page":"Internals","title":"PowerSystems._add_line_delimiter","text":"_add_line_delimiter(\n mp_line::AbstractString,\n start_char,\n end_char\n) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._apply_func!-Tuple{Dict{String}, String, Any}","page":"Internals","title":"PowerSystems._apply_func!","text":"_apply_func!(data::Dict{String}, key::String, func) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._biggest_generator-Tuple{Any}","page":"Internals","title":"PowerSystems._biggest_generator","text":"_biggest_generator(gens) -> Any\n\n\nfind the largest active generator in the network\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._bold-Tuple{String}","page":"Internals","title":"PowerSystems._bold","text":"_bold(s::String) -> String\n\n\nMakes a string bold in the terminal\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_branch_flow_ac-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_branch_flow_ac","text":"_calc_branch_flow_ac(\n data::Dict{String}\n) -> Dict{String, Any}\n\n\nhelper function for calcbranchflow_ac\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_branch_flow_dc-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_branch_flow_dc","text":"_calc_branch_flow_dc(\n data::Dict{String}\n) -> Dict{String, Any}\n\n\nhelper function for calcbranchflow_dc\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_comp_lines-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_comp_lines","text":"_calc_comp_lines(component::Dict{String}) -> Vector{Any}\n\n\ncompute lines in m and b from from pwl cost models\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_max_cost_index-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_max_cost_index","text":"_calc_max_cost_index(data::Dict{String}) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._calc_power_balance-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._calc_power_balance","text":"_calc_power_balance(data::Dict{String}) -> Dict{String, Any}\n\n\nhelper function for calcpowerbalance\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._cc_dfs-NTuple{4, Any}","page":"Internals","title":"PowerSystems._cc_dfs","text":"_cc_dfs(i, neighbors, component_lookup, touched)\n\n\nDFS on a graph\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._check_conductors-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._check_conductors","text":"_check_conductors(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._check_keys-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._check_keys","text":"_check_keys(data, keys)\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._compare_numbers-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._compare_numbers","text":"_compare_numbers(v1, v2) -> Bool\n\n\ntests if two numbers are equal, up to floating point precision\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._convert_argument_types!-Tuple{AbstractString, Vector}","page":"Internals","title":"PowerSystems._convert_argument_types!","text":"_convert_argument_types!(\n str::AbstractString,\n struct_args::Vector\n) -> Any\n\n\nConvert specific parameters to types that are not Float64 for specific inverter components\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._convert_argument_types_for_gen!-Tuple{AbstractString, Vector}","page":"Internals","title":"PowerSystems._convert_argument_types_for_gen!","text":"_convert_argument_types_for_gen!(\n str::AbstractString,\n struct_args::Vector\n)\n\n\nConvert specific parameters to types that are not Float64 for specific generator components\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._correct_cost_function!-Tuple{Any, Any, Any}","page":"Internals","title":"PowerSystems._correct_cost_function!","text":"_correct_cost_function!(id, comp, type_name) -> Bool\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._correct_reference_buses!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._correct_reference_buses!","text":"_correct_reference_buses!(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._create_starbus_from_transformer-Tuple{Dict, Dict, Int64}","page":"Internals","title":"PowerSystems._create_starbus_from_transformer","text":"_create_starbus_from_transformer(\n pm_data::Dict,\n transformer::Dict,\n starbus_id::Int64\n) -> Dict{String, Any}\n\n\ncreate_starbus(pm_data, transformer)\n\nCreates 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._deactivate_isolated_components!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._deactivate_isolated_components!","text":"_deactivate_isolated_components!(data::Dict{String}) -> Bool\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._extract_matlab_assignment-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._extract_matlab_assignment","text":"_extract_matlab_assignment(\n string::AbstractString\n) -> Tuple{SubString, SubString}\n\n\nbreaks up matlab strings of the form 'name = value;'\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._find_max_bus_id-Tuple{Dict}","page":"Internals","title":"PowerSystems._find_max_bus_id","text":"_find_max_bus_id(pm_data::Dict) -> Int64\n\n\n_find_max_bus_id(pm_data)\n\nReturns the maximum bus id in pm_data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._float2string-Tuple{AbstractFloat, Int64}","page":"Internals","title":"PowerSystems._float2string","text":"_float2string(\n v::AbstractFloat,\n float_precision::Int64\n) -> Any\n\n\nconverts a float value into a string of fixed precision\n\nsprintf would do the job but this work around is needed because sprintf cannot take format strings during runtime\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_bus_value-Tuple{Int64, String, Dict{String, Any}}","page":"Internals","title":"PowerSystems._get_bus_value","text":"_get_bus_value(\n bus_i::Int64,\n field::String,\n pm_data::Dict{String, Any}\n) -> Any\n\n\n_get_bus_value(bus_i, field, pm_data)\n\nReturns the value of field of bus_i from the PowerModels data. Requires \"bus\" Dict to already be populated.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_contributing_devices-Union{Tuple{T}, Tuple{System, T}} where T<:Service","page":"Internals","title":"PowerSystems._get_contributing_devices","text":"_get_contributing_devices(\n sys::System,\n service::Service\n) -> ServiceContributingDevices\n\n\nReturns a ServiceContributingDevices object.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_line_elements-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._get_line_elements","text":"_get_line_elements(\n line::AbstractString\n) -> Tuple{Array{SubString{T}, 1} where T<:AbstractString, Union{String, SubString}}\n\n\n_get_line_elements(line)\n\nInternal 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_pm_branch_name-Tuple{Any, ACBus, ACBus}","page":"Internals","title":"PowerSystems._get_pm_branch_name","text":"_get_pm_branch_name(\n device_dict,\n bus_f::ACBus,\n bus_t::ACBus\n) -> String\n\n\nInternal branch name retreval from pm2ps_dict\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._get_pm_dict_name-Tuple{Dict}","page":"Internals","title":"PowerSystems._get_pm_dict_name","text":"_get_pm_dict_name(device_dict::Dict) -> String\n\n\nInternal component name retreval from pm2ps_dict\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._grey-Tuple{String}","page":"Internals","title":"PowerSystems._grey","text":"_grey(s::String) -> String\n\n\nMakes 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\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._import_remaining_comps!-Tuple{Dict, Dict}","page":"Internals","title":"PowerSystems._import_remaining_comps!","text":"_import_remaining_comps!(\n data_out::Dict,\n data_in::Dict;\n exclude\n)\n\n\nImports remaining top level component lists from data_in into data_out, excluding keys in exclude\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._import_remaining_keys!-Tuple{Dict, Dict}","page":"Internals","title":"PowerSystems._import_remaining_keys!","text":"_import_remaining_keys!(\n comp_dest::Dict,\n comp_src::Dict;\n exclude\n)\n\n\nImports remaining keys from a source component into detestation component, excluding keys in exclude\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._init_bus!-Tuple{Dict{String, Any}, Int64}","page":"Internals","title":"PowerSystems._init_bus!","text":"_init_bus!(bus::Dict{String, Any}, id::Int64)\n\n\n_init_bus!(bus, id)\n\nInitializes a bus of id id with default values given in the PSS(R)E specification.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._instantiate_param_vector_size-Tuple{AbstractString, Dict}","page":"Internals","title":"PowerSystems._instantiate_param_vector_size","text":"_instantiate_param_vector_size(\n str::AbstractString,\n param_map::Dict\n) -> Any\n\n\nConstruct appropiate vector size for components that collect parameters from more than 2 PSS/E components\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._make_market_bid_curve-Tuple{PiecewiseStepData}","page":"Internals","title":"PowerSystems._make_market_bid_curve","text":"_make_market_bid_curve(\n data::PiecewiseStepData;\n initial_input,\n power_units,\n input_at_zero\n) -> CostCurve{PiecewiseIncrementalCurve}\n\n\nAuxiliary make market bid curve for timeseries with nothing inputs. \n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._make_mixed_units!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._make_mixed_units!","text":"_make_mixed_units!(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._make_per_unit!-Tuple{Dict{String}, Real}","page":"Internals","title":"PowerSystems._make_per_unit!","text":"_make_per_unit!(data::Dict{String}, mva_base::Real)\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._make_shaft-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._make_shaft","text":"_make_shaft(param_map, val) -> Any\n\n\nCreate a SingleMass shaft struct directly using the parameter mapping.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._matpower_to_powermodels!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._matpower_to_powermodels!","text":"_matpower_to_powermodels!(\n mp_data::Dict{String}\n) -> Dict{String}\n\n\nConverts a Matpower dict into a PowerModels dict\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._merge_bus_name_data!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._merge_bus_name_data!","text":"_merge_bus_name_data!(\n data::Dict{String, Any}\n) -> Union{Nothing, Dict{String, Any}}\n\n\nmerges bus name data into buses, if names exist\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._merge_cost_data!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._merge_cost_data!","text":"_merge_cost_data!(\n data::Dict{String, Any}\n) -> Union{Nothing, Dict{String, Any}}\n\n\nmerges generator cost functions into generator data, if costs exist\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._merge_generic_data!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._merge_generic_data!","text":"_merge_generic_data!(data::Dict{String, Any})\n\n\nmerges Matpower tables based on the table extension syntax\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._mp2pm_branch!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._mp2pm_branch!","text":"_mp2pm_branch!(data::Dict{String, Any})\n\n\nsets all branch transformer taps to 1.0, to simplify branch models\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._mp2pm_dcline!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._mp2pm_dcline!","text":"_mp2pm_dcline!(data::Dict{String, Any})\n\n\nadds pmin and pmax values at to and from buses\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._mp_cost_data-Tuple{Any}","page":"Internals","title":"PowerSystems._mp_cost_data","text":"_mp_cost_data(cost_row) -> Dict\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dera1!-Tuple{Any, Any, Any, Dict, Int64}","page":"Internals","title":"PowerSystems._parse_dera1!","text":"_parse_dera1!(\n bus_dict,\n componentID,\n componentValues,\n param_map::Dict,\n bus_num::Int64\n)\n\n\nParse 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_components-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._parse_dyr_components","text":"_parse_dyr_components(\n dyr_file::AbstractString\n) -> Dict{Int64, Any}\n\n\nParse a .dyr file directly from its name by constructing its dictionary of dictionaries.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_components-Tuple{Dict}","page":"Internals","title":"PowerSystems._parse_dyr_components","text":"_parse_dyr_components(data::Dict) -> Dict{Int64, Any}\n\n\nParse 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).\n\nFor Generators, each dictionary indexed by id contains a vector with 5 of its components:\n\nMachine\nShaft\nAVR\nTurbineGov\nPSS\n\nFor Inverters, each dictionary indexed by id contains a vector with 7 of its components:\n\nConverter\nActivePowerControl\nReactivePowerControl\nInnerControl\nDCSource\nFrequencyEstimator\nFilter\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_file-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._parse_dyr_file","text":"_parse_dyr_file(file::AbstractString) -> Dict{Int64, Dict}\n\n\nParse .dyr file into a dictionary indexed by bus number. Each bus number key has a dictionary indexed by component type and id.\n\nComments in .dyr files are not supported (beginning of lines with //).\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_generator_components!-Tuple{Dict, Any, Any, Dict, Dict}","page":"Internals","title":"PowerSystems._parse_dyr_generator_components!","text":"_parse_dyr_generator_components!(\n bus_dict::Dict,\n componentID,\n componentValues,\n gen_map::Dict,\n param_map::Dict\n)\n\n\nParse 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_dyr_inverter_components!-Tuple{Dict, Dict, Tuple{String, String}, Dict}","page":"Internals","title":"PowerSystems._parse_dyr_inverter_components!","text":"_parse_dyr_inverter_components!(\n bus_dict::Dict,\n inv_dict::Dict,\n componentID::Tuple{String, String},\n inv_map::Dict\n)\n\n\nParse 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_elements-Tuple{Array, Array, Dict, AbstractString}","page":"Internals","title":"PowerSystems._parse_elements","text":"_parse_elements(\n elements::Array,\n dtypes::Array,\n defaults::Dict,\n section::AbstractString\n) -> Dict{String, Any}\n\n\nThis 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_line_element!-Tuple{Dict, Array, AbstractString}","page":"Internals","title":"PowerSystems._parse_line_element!","text":"_parse_line_element!(\n data::Dict,\n elements::Array,\n section::AbstractString\n)\n\n\n_parse_line_element!(data, elements, section)\n\nInternal 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_matlab_cells-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._parse_matlab_cells","text":"_parse_matlab_cells(lines, index) -> Dict\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_matlab_data-NTuple{4, Any}","page":"Internals","title":"PowerSystems._parse_matlab_data","text":"_parse_matlab_data(\n lines,\n index,\n start_char,\n end_char\n) -> Dict\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_matlab_matrix-Tuple{Any, Any}","page":"Internals","title":"PowerSystems._parse_matlab_matrix","text":"_parse_matlab_matrix(lines, index) -> Dict\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_matpower_string-Tuple{String}","page":"Internals","title":"PowerSystems._parse_matpower_string","text":"_parse_matpower_string(\n data_string::String\n) -> Dict{String, Any}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._parse_pti_data-Tuple{IO}","page":"Internals","title":"PowerSystems._parse_pti_data","text":"_parse_pti_data(data_io::IO) -> Dict{String, Array{Dict}}\n\n\n_parse_pti_data(data_string, sections)\n\nInternal 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().\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._populate_args-Tuple{Vector, Any}","page":"Internals","title":"PowerSystems._populate_args","text":"_populate_args(param_map::Vector, val) -> Vector{Any}\n\n\nPopulate arguments in a vector for each dynamic component (except Shafts). Returns a vector with the parameter values of the argument of each component.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._populate_defaults!-Tuple{Dict}","page":"Internals","title":"PowerSystems._populate_defaults!","text":"_populate_defaults!(data::Dict)\n\n\n_populate_defaults!(pti_data)\n\nInternal function. Populates empty fields with PSS(R)E PTI v33 default values\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._process_get_cost-Union{Tuple{T}, Tuple{Type{T}, Any, T, Any, Union{Nothing, Dates.DateTime}, Union{Nothing, Int64}}} where T","page":"Internals","title":"PowerSystems._process_get_cost","text":"_process_get_cost(\n _::Type{T},\n _,\n cost,\n transform_fn,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64}\n) -> TimeSeries.TimeArray\n\n\nHelper function for cost getters.\n\nArguments\n\nT: type/eltype we expect\ncomponent::Component: the component\ncost: the data: either a single element of type T or a TimeSeriesKey\ntransform_fn: a function to apply to the elements of the time series\nstart_time: as in get_time_series\nlen: as in get_time_series\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._process_set_cost-Tuple{Any, Any, Any, Any, Nothing}","page":"Internals","title":"PowerSystems._process_set_cost","text":"_process_set_cost(_, _, _, _, _::Nothing)\n\n\nHelper function for cost setters.\n\nArguments\n\nT1: type we expect if it's not a time series\nT2: eltype we expect if it is a time series\nsys::System: the system\ncomponent::Component: the component\ncost: the data: either a single element of type T1 or a IS.TimeSeriesData of eltype T2\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._propagate_topology_status!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._propagate_topology_status!","text":"_propagate_topology_status!(data::Dict{String}) -> Bool\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_branch!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_branch!","text":"_psse2pm_branch!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_branch!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_bus!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_bus!","text":"_psse2pm_bus!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_bus!(pm_data, pti_data)\n\nParses PSS(R)E-style Bus data into a PowerModels-style Dict. \"source_id\" is given by [\"I\", \"NAME\"] in PSS(R)E Bus specification.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_dcline!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_dcline!","text":"_psse2pm_dcline!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_dcline!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_generator!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_generator!","text":"_psse2pm_generator!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n) -> Union{Nothing, Vector{Dict{String, Any}}}\n\n\n_psse2pm_generator!(pm_data, pti_data)\n\nParses PSS(R)E-style Generator data in a PowerModels-style Dict. \"source_id\" is given by [\"I\", \"ID\"] in PSS(R)E Generator specification.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_load!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_load!","text":"_psse2pm_load!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_load!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_shunt!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_shunt!","text":"_psse2pm_shunt!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_shunt!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._psse2pm_transformer!-Tuple{Dict, Dict, Bool}","page":"Internals","title":"PowerSystems._psse2pm_transformer!","text":"_psse2pm_transformer!(\n pm_data::Dict,\n pti_data::Dict,\n import_all::Bool\n)\n\n\n_psse2pm_transformer!(pm_data, pti_data)\n\nParses 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._pti_to_powermodels!-Tuple{Dict}","page":"Internals","title":"PowerSystems._pti_to_powermodels!","text":"_pti_to_powermodels!(\n pti_data::Dict;\n import_all,\n validate,\n correct_branch_rating\n) -> Dict{String, Any}\n\n\n_pti_to_powermodels!(pti_data)\n\nConverts 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).\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._read_data_row-Tuple{PowerSystemTableData, Any, Any}","page":"Internals","title":"PowerSystems._read_data_row","text":"_read_data_row(\n data::PowerSystemTableData,\n row,\n field_infos;\n na_to_nothing\n) -> NamedTuple\n\n\nReads values from dataframe row and performs necessary conversions.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._remove_aggregration_topology!-Tuple{ACBus, LoadZone}","page":"Internals","title":"PowerSystems._remove_aggregration_topology!","text":"_remove_aggregration_topology!(bus::ACBus, _::LoadZone)\n\n\nRemove the aggregation topology in a ACBus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._remove_pwl_cost_duplicates!","page":"Internals","title":"PowerSystems._remove_pwl_cost_duplicates!","text":"_remove_pwl_cost_duplicates!(id, comp, type_name) -> Bool\n_remove_pwl_cost_duplicates!(\n id,\n comp,\n type_name,\n tolerance\n) -> Bool\n\n\nchecks that each point in the a pwl function is unique, simplifies the function if duplicates appear\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems._remove_service!-Tuple{Device, Service}","page":"Internals","title":"PowerSystems._remove_service!","text":"_remove_service!(device::Device, service::Service) -> Bool\n\n\nRemove service from device if it is attached.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._rescale_cost_model!-Tuple{Dict{String}, Real}","page":"Internals","title":"PowerSystems._rescale_cost_model!","text":"_rescale_cost_model!(comp::Dict{String}, scale::Real)\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._resolve_swithces!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._resolve_swithces!","text":"_resolve_swithces!(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._select_largest_component!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems._select_largest_component!","text":"_select_largest_component!(data::Dict{String}) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._simplify_pwl_cost!","page":"Internals","title":"PowerSystems._simplify_pwl_cost!","text":"_simplify_pwl_cost!(id, comp, type_name) -> Bool\n_simplify_pwl_cost!(id, comp, type_name, tolerance) -> Bool\n\n\nchecks the slope of each segment in a pwl function, simplifies the function if the slope changes is below a tolerance\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems._split_loads_shunts!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems._split_loads_shunts!","text":"_split_loads_shunts!(data::Dict{String, Any})\n\n\n_split_loads_shunts!(data)\n\nSeperates 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._standardize_cost_terms!-Tuple{Dict{String}, Int64, String}","page":"Internals","title":"PowerSystems._standardize_cost_terms!","text":"_standardize_cost_terms!(\n components::Dict{String},\n comp_order::Int64,\n cost_comp_name::String\n) -> Set{Int64}\n\n\nensures all polynomial costs functions have at exactly comp_order terms\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._type_array-Union{Tuple{Vector{T}}, Tuple{T}} where T<:AbstractString","page":"Internals","title":"PowerSystems._type_array","text":"_type_array(\n string_array::Array{T<:AbstractString, 1}\n) -> Vector\n\n\nAttempts to determine the type of an array of strings extracted from a matlab file\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._type_value-Tuple{AbstractString}","page":"Internals","title":"PowerSystems._type_value","text":"_type_value(\n value_string::AbstractString\n) -> Union{Float64, Int64, InlineStrings.InlineString, SubString}\n\n\nAttempts to determine the type of a string extracted from a matlab file\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._update_data!-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems._update_data!","text":"_update_data!(data::Dict{String}, new_data::Dict{String})\n\n\nrecursive call of updatedata\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems._value2string-Tuple{Any, Int64}","page":"Internals","title":"PowerSystems._value2string","text":"_value2string(v, float_precision::Int64) -> Any\n\n\nconverts any value to a string, summarizes arrays and dicts\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.add_service_internal!-Tuple{Device, Service}","page":"Internals","title":"PowerSystems.add_service_internal!","text":"add_service_internal!(device::Device, service::Service)\n\n\nThis function add a service to the component without checking if the component and the service are attached to the same system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.adequacy_check-Tuple{System}","page":"Internals","title":"PowerSystems.adequacy_check","text":"adequacy_check(sys::System)\n\n\nadequacy_check(sys::System)\n\nChecks the system for sum(generator ratings) >= sum(load ratings).\n\nArguments\n\nsys::System: system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.arrays_to_dicts!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.arrays_to_dicts!","text":"arrays_to_dicts!(data::Dict{String})\n\n\nturns top level arrays into dicts\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.branch_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.branch_csv_parser!","text":"branch_csv_parser!(sys::System, data::PowerSystemTableData)\n\n\nAdd branches to the System from the raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.bus_csv_parser!","text":"bus_csv_parser!(sys::System, data::PowerSystemTableData)\n\n\nAdd buses and areas to the System from the raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_gen_lookup-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.bus_gen_lookup","text":"bus_gen_lookup(\n gen_data::Dict{String},\n bus_data::Dict{String}\n) -> Dict\n\n\nbuilds a lookup list of what generators are connected to a given bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_load_lookup-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.bus_load_lookup","text":"bus_load_lookup(\n load_data::Dict{String},\n bus_data::Dict{String}\n) -> Dict\n\n\nbuilds a lookup list of what loads are connected to a given bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_shunt_lookup-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.bus_shunt_lookup","text":"bus_shunt_lookup(\n shunt_data::Dict{String},\n bus_data::Dict{String}\n) -> Dict\n\n\nbuilds a lookup list of what shunts are connected to a given bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.bus_storage_lookup-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.bus_storage_lookup","text":"bus_storage_lookup(\n storage_data::Dict{String},\n bus_data::Dict{String}\n) -> Dict\n\n\nbuilds a lookup list of what storage is connected to a given bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_branch_flow_ac-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_branch_flow_ac","text":"calc_branch_flow_ac(data::Dict{String}) -> Dict{String, Any}\n\n\nassumes a vaild ac solution is included in the data and computes the branch flow values\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_branch_flow_dc-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_branch_flow_dc","text":"calc_branch_flow_dc(data::Dict{String}) -> Dict{String, Any}\n\n\nassumes a vaild dc solution is included in the data and computes the branch flow values\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_branch_t-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_branch_t","text":"calc_branch_t(branch::Dict{String}) -> Tuple{Any, Any}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_branch_y-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_branch_y","text":"calc_branch_y(branch::Dict{String}) -> Tuple{Any, Any}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_connected_components-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_connected_components","text":"calc_connected_components(\n pm_data::Dict{String};\n edges\n) -> Set{Set{Int64}}\n\n\ncomputes the connected components of the network graph returns a set of sets of bus ids, each set is a connected component\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_cost_pwl_lines-Tuple{Dict}","page":"Internals","title":"PowerSystems.calc_cost_pwl_lines","text":"calc_cost_pwl_lines(comp_dict::Dict) -> Dict{Any, Any}\n\n\ncompute lines in m and b from from pwl cost models data is a list of components.\n\nCan be run on data or ref data structures\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_dcline_cost-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_dcline_cost","text":"calc_dcline_cost(data::Dict{String}) -> Any\n\n\ncomputes the dcline cost from given network data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_gen_cost-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_gen_cost","text":"calc_gen_cost(data::Dict{String}) -> Any\n\n\ncomputes the generator cost from given network data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_max_cost_index-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.calc_max_cost_index","text":"calc_max_cost_index(data::Dict{String, Any}) -> Any\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_power_balance-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_power_balance","text":"calc_power_balance(data::Dict{String}) -> Dict{String, Any}\n\n\nassumes a vaild solution is included in the data and computes the power balance at each bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calc_theta_delta_bounds-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.calc_theta_delta_bounds","text":"calc_theta_delta_bounds(\n data::Dict{String}\n) -> Tuple{Real, Real}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.calculate_saturation_coefficients-Tuple{Tuple{Float64, Float64}, Tuple{Float64, Float64}}","page":"Internals","title":"PowerSystems.calculate_saturation_coefficients","text":"calculate_saturation_coefficients(\n E::Tuple{Float64, Float64},\n Se::Tuple{Float64, Float64}\n) -> Tuple{Float64, Float64}\n\n\nObtain 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 \n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_ascending_order-Tuple{Array{Int64}, AbstractString}","page":"Internals","title":"PowerSystems.check_ascending_order","text":"check_ascending_order(\n array::Array{Int64},\n name::AbstractString\n)\n\n\nThrows DataFormatError if the array is not in ascending order.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_attached_buses-Tuple{System, Component}","page":"Internals","title":"PowerSystems.check_attached_buses","text":"check_attached_buses(sys::System, component::Component)\n\n\nThrows ArgumentError if any bus attached to the component is invalid.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_branch_loops-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_branch_loops","text":"check_branch_loops(data::Dict{String})\n\n\nchecks that all branches connect two distinct buses\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_component_addition-Tuple{System, Component}","page":"Internals","title":"PowerSystems.check_component_addition","text":"check_component_addition(\n sys::System,\n component::Component;\n kwargs...\n)\n\n\nThrows ArgumentError if a PowerSystems rule blocks addition to the system.\n\nThis method is tied with handlecomponentaddition!. If the methods are re-implemented for a subtype then whatever is added in handlecomponentaddition! must be checked here.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_component_removal-Tuple{System, Component}","page":"Internals","title":"PowerSystems.check_component_removal","text":"check_component_removal(sys::System, component::Component)\n\n\nThrows ArgumentError if a PowerSystems rule blocks removal from the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_component_removal-Union{Tuple{T}, Tuple{System, T}} where T<:Service","page":"Internals","title":"PowerSystems.check_component_removal","text":"check_component_removal(sys::System, service::Service)\n\n\nThrows ArgumentError if a PowerSystems rule blocks removal from the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_conductors-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_conductors","text":"check_conductors(data::Dict{String})\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_connectivity-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_connectivity","text":"check_connectivity(data::Dict{String})\n\n\nchecks that all buses are unique and other components link to valid buses\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_reference_bus-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_reference_bus","text":"check_reference_bus(data::Dict{String})\n\n\nchecks that contains at least one refrence bus\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_reference_buses-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.check_reference_buses","text":"check_reference_buses(data::Dict{String, Any})\n\n\nchecks that each connected components has a reference bus, if not, adds one\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_status-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_status","text":"check_status(data::Dict{String})\n\n\nchecks that active components are not connected to inactive buses, otherwise prints warnings\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_storage_parameters-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.check_storage_parameters","text":"check_storage_parameters(data::Dict{String, Any})\n\n\nchecks that each storage unit has a reasonable parameters\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_subsystems-Tuple{System}","page":"Internals","title":"PowerSystems.check_subsystems","text":"check_subsystems(sys::System)\n\n\nCheck the the consistency of subsystems.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_switch_parameters-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_switch_parameters","text":"check_switch_parameters(data::Dict{String})\n\n\nchecks that each switch has a reasonable parameters\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_type-Tuple{Any, Any}","page":"Internals","title":"PowerSystems.check_type","text":"check_type(typ, value) -> Any\n\n\nChecks if the given value is of a given type, if not tries to make it that type\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.check_voltage_setpoints-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.check_voltage_setpoints","text":"check_voltage_setpoints(data::Dict{String})\n\n\nthrows warnings if generator and dc line voltage setpoints are not consistent with the bus voltage setpoint\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.compare_dict-Tuple{Any, Any}","page":"Internals","title":"PowerSystems.compare_dict","text":"compare_dict(d1, d2) -> Bool\n\n\ntests if two dicts are equal, up to floating point precision\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_branch_directions!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_branch_directions!","text":"correct_branch_directions!(data::Dict{String}) -> Set{Int64}\n\n\nchecks that all parallel branches have the same orientation\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_bus_types!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_bus_types!","text":"correct_bus_types!(data::Dict{String}) -> Set{Int64}\n\n\nchecks bus types are consistent with generator connections, if not, fixes them\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_component_refrence_bus!-Tuple{Any, Any, Any}","page":"Internals","title":"PowerSystems.correct_component_refrence_bus!","text":"correct_component_refrence_bus!(\n component_bus_ids,\n bus_lookup,\n component_gens\n)\n\n\nchecks that a connected component has a reference bus, if not, tries to add one\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_cost_functions!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_cost_functions!","text":"correct_cost_functions!(\n data::Dict{String}\n) -> Tuple{Set{Int64}, Set{Int64}}\n\n\nthrows warnings if cost functions are malformed\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_current_limits!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_current_limits!","text":"correct_current_limits!(data::Dict{String}) -> Set{Int64}\n\n\nchecks that each branch has a reasonable current rating-a, if not computes one\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_dcline_limits!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.correct_dcline_limits!","text":"correct_dcline_limits!(\n data::Dict{String, Any}\n) -> Set{Int64}\n\n\nchecks that parameters for dc lines are reasonable\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_network_data!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_network_data!","text":"correct_network_data!(\n data::Dict{String};\n correct_branch_rating\n) -> Dict{String, Dict{Symbol, Set{Int64}}}\n\n\nRuns various data quality checks on a PowerModels data dictionary. Applies modifications in some cases. Reports modified component ids.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_thermal_limits!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_thermal_limits!","text":"correct_thermal_limits!(data::Dict{String}) -> Set{Int64}\n\n\nchecks that each branch has a reasonable thermal rating-a, if not computes one\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_transformer_parameters!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.correct_transformer_parameters!","text":"correct_transformer_parameters!(\n data::Dict{String}\n) -> Set{Int64}\n\n\nchecks that each branch has a reasonable transformer parameters\n\nthis is important because setting tap == 0.0 leads to NaN computations, which are hard to debug\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.correct_voltage_angle_differences!","page":"Internals","title":"PowerSystems.correct_voltage_angle_differences!","text":"correct_voltage_angle_differences!(\n data::Dict{String}\n) -> Set{Int64}\ncorrect_voltage_angle_differences!(\n data::Dict{String},\n default_pad\n) -> Set{Int64}\n\n\nchecks that voltage angle differences are within 90 deg., if not tightens\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems.dc_branch_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.dc_branch_csv_parser!","text":"dc_branch_csv_parser!(\n sys::System,\n data::PowerSystemTableData\n)\n\n\nAdd DC branches to the System from raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.deactivate_isolated_components!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.deactivate_isolated_components!","text":"deactivate_isolated_components!(data::Dict{String}) -> Bool\n\n\nremoves buses with single branch connections and without any other attached components. Also removes connected components without suffuceint generation or loads.\n\nalso deactivates 0 valued loads and shunts.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.deserialize_uuid_handling-Tuple{Any, Any, Any}","page":"Internals","title":"PowerSystems.deserialize_uuid_handling","text":"deserialize_uuid_handling(\n field_type,\n val,\n component_cache\n) -> Any\n\n\nDeserialize the value, converting UUIDs to components where necessary.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_active_power_control-Tuple{OuterControl}","page":"Internals","title":"PowerSystems.get_active_power_control","text":"get_active_power_control(\n value::OuterControl\n) -> PowerSystems.ActivePowerControl\n\n\nGet active_power_control from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_avr_saturation-Tuple{Tuple{Float64, Float64}, Tuple{Float64, Float64}}","page":"Internals","title":"PowerSystems.get_avr_saturation","text":"get_avr_saturation(\n E::Tuple{Float64, Float64},\n Se::Tuple{Float64, Float64}\n) -> Tuple{Float64, Float64}\n\n\nObtain coefficients for an AVR \n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_branch-Tuple{DynamicBranch}","page":"Internals","title":"PowerSystems.get_branch","text":"get_branch(value::DynamicBranch) -> ACBranch\n\n\nGet branch\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_dataframe-Tuple{PowerSystemTableData, PowerSystems.InputCategoryModule.InputCategory}","page":"Internals","title":"PowerSystems.get_dataframe","text":"get_dataframe(\n data::PowerSystemTableData,\n category::PowerSystems.InputCategoryModule.InputCategory\n) -> DataFrames.DataFrame\n\n\nReturn the dataframe for the category.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_enum_value-Tuple{Any, AbstractString}","page":"Internals","title":"PowerSystems.get_enum_value","text":"get_enum_value(enum, value::AbstractString) -> Any\n\n\nGet the enum value for the string. Case insensitive.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_exponential_saturation-Tuple{Tuple{Float64, Float64}}","page":"Internals","title":"PowerSystems.get_exponential_saturation","text":"get_exponential_saturation(\n Se::Tuple{Float64, Float64}\n) -> Tuple{Float64, Float64}\n\n\nObtain 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)\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_generator_mapping","page":"Internals","title":"PowerSystems.get_generator_mapping","text":"get_generator_mapping() -> Dict{NamedTuple, DataType}\nget_generator_mapping(\n filename\n) -> Dict{NamedTuple, DataType}\n\n\nReturn a dict where keys are a tuple of input parameters (fuel, unit_type) and values are generator types.\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems.get_generator_type-Tuple{Any, Any, Dict{NamedTuple, DataType}}","page":"Internals","title":"PowerSystems.get_generator_type","text":"get_generator_type(\n fuel,\n unit_type,\n mappings::Dict{NamedTuple, DataType}\n) -> Union{Nothing, DataType}\n\n\nReturn the PowerSystems generator type for this fuel and unit_type.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_interconnection_efficiency-Tuple{HybridSystem}","page":"Internals","title":"PowerSystems.get_interconnection_efficiency","text":"get_interconnection_efficiency(\n value::HybridSystem\n) -> Union{Nothing, @NamedTuple{in::Float64, out::Float64}}\n\n\nget HybridSystem interconnection efficiency\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_outage_status_scenario-Tuple{TimeSeriesForcedOutage}","page":"Internals","title":"PowerSystems.get_outage_status_scenario","text":"get_outage_status_scenario(\n value::TimeSeriesForcedOutage\n) -> String\n\n\nGet TimeSeriesForcedOutage outage_status_scenario.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_quadratic_saturation-Tuple{Tuple{Float64, Float64}}","page":"Internals","title":"PowerSystems.get_quadratic_saturation","text":"get_quadratic_saturation(\n Se::Tuple{Float64, Float64}\n) -> Tuple{Float64, Float64}\n\n\nObtain 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_reactive_power_control-Tuple{OuterControl}","page":"Internals","title":"PowerSystems.get_reactive_power_control","text":"get_reactive_power_control(\n value::OuterControl\n) -> PowerSystems.ReactivePowerControl\n\n\nGet reactive_power_control from OuterControl.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_series_susceptance-Tuple{ACBranch}","page":"Internals","title":"PowerSystems.get_series_susceptance","text":"get_series_susceptance(b::ACBranch) -> Float64\n\n\nCalculate the admittance of AC branches\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_series_susceptance-Tuple{Union{PhaseShiftingTransformer, TapTransformer}}","page":"Internals","title":"PowerSystems.get_series_susceptance","text":"get_series_susceptance(\n b::Union{PhaseShiftingTransformer, TapTransformer}\n) -> Float64\n\n\nReturns 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_user_field-Tuple{PowerSystemTableData, PowerSystems.InputCategoryModule.InputCategory, AbstractString}","page":"Internals","title":"PowerSystems.get_user_field","text":"get_user_field(\n data::PowerSystemTableData,\n category::PowerSystems.InputCategoryModule.InputCategory,\n field::AbstractString\n) -> Any\n\n\nReturn the custom name stored in the user descriptor file.\n\nThrows DataFormatError if a required value is not found in the file.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.get_user_fields-Tuple{PowerSystemTableData, PowerSystems.InputCategoryModule.InputCategory}","page":"Internals","title":"PowerSystems.get_user_fields","text":"get_user_fields(\n data::PowerSystemTableData,\n category::PowerSystems.InputCategoryModule.InputCategory\n) -> Any\n\n\nReturn a vector of user-defined fields for the category.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_component_addition!-Tuple{System, Component}","page":"Internals","title":"PowerSystems.handle_component_addition!","text":"handle_component_addition!(\n sys::System,\n component::Component;\n kwargs...\n)\n\n\nRefer to docstring for checkcomponentaddition!\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_component_addition_to_subsystem!-Tuple{System, AbstractString, Component}","page":"Internals","title":"PowerSystems.handle_component_addition_to_subsystem!","text":"handle_component_addition_to_subsystem!(\n _::System,\n subsystem_name::AbstractString,\n _::Component\n)\n\n\nPeforms component-type-specific postprocessing when a component is added to a subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_component_removal!-Tuple{System, ACBus}","page":"Internals","title":"PowerSystems.handle_component_removal!","text":"handle_component_removal!(sys::System, bus::ACBus)\n\n\nThrows ArgumentError if the bus number is not stored in the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_component_removal_from_subsystem!-Tuple{System, AbstractString, Component}","page":"Internals","title":"PowerSystems.handle_component_removal_from_subsystem!","text":"handle_component_removal_from_subsystem!(\n _::System,\n subsystem_name::AbstractString,\n _::Component\n)\n\n\nPeforms component-type-specific postprocessing when a component is removed from a subsystem.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.handle_deserialization_special_cases!-Tuple{Dict, Type{<:Component}}","page":"Internals","title":"PowerSystems.handle_deserialization_special_cases!","text":"handle_deserialization_special_cases!(\n component::Dict,\n _::Type{<:Component}\n)\n\n\nAllow types to implement handling of special cases during deserialization.\n\nArguments\n\ncomponent::Dict: The component serialized as a dictionary.\n::Type: The type of the component.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.im_replicate-Tuple{Dict{String}, Int64, Set{String}}","page":"Internals","title":"PowerSystems.im_replicate","text":"im_replicate(\n sn_data::Dict{String},\n count::Int64,\n global_keys::Set{String}\n) -> Dict{String, Any}\n\n\nTransforms a single network into a multinetwork with several deepcopies of the original network\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.is_attached-Union{Tuple{T}, Tuple{T, System}} where T<:Component","page":"Internals","title":"PowerSystems.is_attached","text":"is_attached(component::Component, sys::System) -> Bool\n\n\nReturn true if the component is attached to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.isafield-Tuple{Component, Symbol}","page":"Internals","title":"PowerSystems.isafield","text":"isafield(component::Component, field::Symbol) -> Any\n\n\nChecks if a PowerSystemDevice has a field or subfield name.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.ismultinetwork-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.ismultinetwork","text":"ismultinetwork(data::Dict{String}) -> Any\n\n\nchecks if a given network data is a multinetwork\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.iterate_rows-Tuple{PowerSystemTableData, Any}","page":"Internals","title":"PowerSystems.iterate_rows","text":"iterate_rows(\n data::PowerSystemTableData,\n category;\n na_to_nothing\n) -> Channel{Any}\n\n\nReturn a NamedTuple of parameters from the descriptor file for each row of a dataframe, making type conversions as necessary.\n\nRefer to the PowerSystems descriptor file for field names that will be created.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.load_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.load_csv_parser!","text":"load_csv_parser!(sys::System, data::PowerSystemTableData)\n\n\nload_csv_parser!(sys::System, data::PowerSystemTableData)\n\nAdd loads to the System from the raw load data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.loadzone_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.loadzone_csv_parser!","text":"loadzone_csv_parser!(\n sys::System,\n data::PowerSystemTableData\n)\n\n\nloadzone_csv_parser!(sys::System, data::PowerSystemTableData)\n\nAdd branches to the System from the raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_bus-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.make_bus","text":"make_bus(bus_dict::Dict{String, Any}) -> ACBus\n\n\nCreates a PowerSystems.ACBus from a PowerSystems bus dictionary\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_generator-Tuple{PowerSystemTableData, Vararg{Any, 4}}","page":"Internals","title":"PowerSystems.make_generator","text":"make_generator(\n data::PowerSystemTableData,\n gen,\n cost_colnames,\n bus,\n gen_storage\n) -> Union{Nothing, EnergyReservoirStorage, HydroDispatch, HydroEnergyReservoir, HydroPumpedStorage, RenewableDispatch, RenewableNonDispatch, ThermalStandard}\n\n\nCreates a generator of any type.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_mixed_units!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.make_mixed_units!","text":"make_mixed_units!(data::Dict{String})\n\n\nTransforms network data into mixed-units (inverse of per-unit)\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_per_unit!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.make_per_unit!","text":"make_per_unit!(data::Dict{String})\n\n\nTransforms network data into per-unit\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.make_thermal_gen-Tuple{Union{SubString{String}, String}, Dict, ACBus, Float64}","page":"Internals","title":"PowerSystems.make_thermal_gen","text":"make_thermal_gen(\n gen_name::Union{SubString{String}, String},\n d::Dict,\n bus::ACBus,\n sys_mbase::Float64\n) -> ThermalStandard\n\n\nThe 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\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.move_genfuel_and_gentype!-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.move_genfuel_and_gentype!","text":"move_genfuel_and_gentype!(data::Dict{String, Any})\n\n\nMove gentype and genfuel fields to be subfields of gen\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_matpower-Tuple{IO}","page":"Internals","title":"PowerSystems.parse_matpower","text":"parse_matpower(io::IO; validate) -> Dict{String, Any}\n\n\nParses the matpwer data from either a filename or an IO object\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_psse-Tuple{IO}","page":"Internals","title":"PowerSystems.parse_psse","text":"parse_psse(io::IO; kwargs...) -> Dict{String, Any}\n\n\nfunction parse_psse(io::IO; kwargs...)::Dict\n\nParses directly from iostream\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_psse-Tuple{String}","page":"Internals","title":"PowerSystems.parse_psse","text":"parse_psse(filename::String; kwargs...) -> Dict{String, Any}\n\n\nparse_psse(filename::String; kwargs...)::Dict\n\nParses directly from file\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_pti-Tuple{IO}","page":"Internals","title":"PowerSystems.parse_pti","text":"parse_pti(io::IO) -> Dict{String, Array{Dict}}\n\n\nparse_pti(io::IO)\n\nReads PTI data in io::IO, returning a Dict of the data parsed into the proper types.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.parse_pti-Tuple{String}","page":"Internals","title":"PowerSystems.parse_pti","text":"parse_pti(filename::String) -> Dict{String, Array{Dict}}\n\n\nparse_pti(filename::String)\n\nOpen PTI raw file given by filename, returning a Dict of the data parsed into the proper types.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.propagate_topology_status!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.propagate_topology_status!","text":"propagate_topology_status!(\n data::Dict{String}\n) -> Union{Nothing, Bool}\n\n\nfinds active network buses and branches that are not necessary for the computation and sets their status to off.\n\nWorks on a PowerModels data dict, so that a it can be used without a GenericPowerModel object\n\nWarning: this implementation has quadratic complexity, in the worst case\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.read_and_convert_ts","page":"Internals","title":"PowerSystems.read_and_convert_ts","text":"read_and_convert_ts(\n ts::TimeSeriesData,\n component::Component\n) -> TimeSeries.TimeArray\nread_and_convert_ts(\n ts::TimeSeriesData,\n component::Component,\n start_time::Union{Nothing, Dates.DateTime}\n) -> TimeSeries.TimeArray\nread_and_convert_ts(\n ts::TimeSeriesData,\n component::Component,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64}\n) -> TimeSeries.TimeArray\nread_and_convert_ts(\n ts::TimeSeriesData,\n component::Component,\n start_time::Union{Nothing, Dates.DateTime},\n len::Union{Nothing, Int64},\n transform_fn\n) -> TimeSeries.TimeArray\n\n\nCall gettimeseriesarray on the given time series and return a TimeArray of the results, values mapped by `transformfn` if it is not nothing\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerSystems.read_gen!-Tuple{System, Dict, Dict{Int64, ACBus}}","page":"Internals","title":"PowerSystems.read_gen!","text":"read_gen!(\n sys::System,\n data::Dict,\n bus_number_to_bus::Dict{Int64, ACBus};\n kwargs...\n)\n\n\nTransfer generators to ps_dict according to their classification\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.replicate-Tuple{Dict{String}, Int64}","page":"Internals","title":"PowerSystems.replicate","text":"replicate(\n sn_data::Dict{String},\n count::Int64;\n global_keys\n) -> Dict{String, Any}\n\n\nTurns 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.resolve_swithces!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.resolve_swithces!","text":"resolve_swithces!(data::Dict{String})\n\n\ngiven a network data dict merges buses that are connected by closed switches converting the dataset into a pure bus-branch model.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.row_to_dict-Tuple{Any, Any}","page":"Internals","title":"PowerSystems.row_to_dict","text":"row_to_dict(row_data, columns) -> Dict{String, Any}\n\n\ntakes a row from a matrix and assigns the values names\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.row_to_typed_dict-Tuple{Any, Any}","page":"Internals","title":"PowerSystems.row_to_typed_dict","text":"row_to_typed_dict(row_data, columns) -> Dict{String, Any}\n\n\ntakes a row from a matrix and assigns the values names and types\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.select_largest_component-Tuple{Dict{String, Any}}","page":"Internals","title":"PowerSystems.select_largest_component","text":"select_largest_component(data::Dict{String, Any}) -> Any\n\n\ndetermines the largest connected component of the network and turns everything else off\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.serialize_uuid_handling-Tuple{Any}","page":"Internals","title":"PowerSystems.serialize_uuid_handling","text":"serialize_uuid_handling(val) -> Any\n\n\nSerialize the value, encoding as UUIDs where necessary.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.services_csv_parser!-Tuple{System, PowerSystemTableData}","page":"Internals","title":"PowerSystems.services_csv_parser!","text":"services_csv_parser!(\n sys::System,\n data::PowerSystemTableData\n)\n\n\nAdd services to the System from the raw data.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_active_power_control!-Tuple{OuterControl, Any}","page":"Internals","title":"PowerSystems.set_active_power_control!","text":"set_active_power_control!(value::OuterControl, val) -> Any\n\n\nSet OuterControl active_power_control.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_branch!-Tuple{DynamicBranch, ACBranch}","page":"Internals","title":"PowerSystems.set_branch!","text":"set_branch!(value::DynamicBranch, val::ACBranch) -> ACBranch\n\n\nSet branch\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_electric_load!-Tuple{HybridSystem, ElectricLoad}","page":"Internals","title":"PowerSystems.set_electric_load!","text":"set_electric_load!(hybrid::HybridSystem, val::ElectricLoad)\n\n\nSet HybridSystem load\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_interconnection_efficiency!-Tuple{HybridSystem, Any}","page":"Internals","title":"PowerSystems.set_interconnection_efficiency!","text":"set_interconnection_efficiency!(\n value::HybridSystem,\n val\n) -> Any\n\n\nSet HybridSystem interconnection_efficiency.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_interconnection_impedance!-Tuple{HybridSystem, Any}","page":"Internals","title":"PowerSystems.set_interconnection_impedance!","text":"set_interconnection_impedance!(\n value::HybridSystem,\n val\n) -> Any\n\n\nset HybridSystem interconnection impedance\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_interconnection_rating!-Tuple{HybridSystem, Any}","page":"Internals","title":"PowerSystems.set_interconnection_rating!","text":"set_interconnection_rating!(value::HybridSystem, val) -> Any\n\n\nSet HybridSystem interconnection_rating.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_reactive_power_control!-Tuple{OuterControl, Any}","page":"Internals","title":"PowerSystems.set_reactive_power_control!","text":"set_reactive_power_control!(value::OuterControl, val) -> Any\n\n\nSet OuterControl reactive_power_control.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_renewable_unit!-Tuple{HybridSystem, RenewableGen}","page":"Internals","title":"PowerSystems.set_renewable_unit!","text":"set_renewable_unit!(hybrid::HybridSystem, val::RenewableGen)\n\n\nSet HybridSystem renewable unit\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_storage!-Tuple{HybridSystem, Storage}","page":"Internals","title":"PowerSystems.set_storage!","text":"set_storage!(hybrid::HybridSystem, val::Storage)\n\n\nSet HybridSystem storage unit\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.set_thermal_unit!-Tuple{HybridSystem, ThermalGen}","page":"Internals","title":"PowerSystems.set_thermal_unit!","text":"set_thermal_unit!(hybrid::HybridSystem, val::ThermalGen)\n\n\nSet HybridSystem thermal unit\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.simplify_cost_terms!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.simplify_cost_terms!","text":"simplify_cost_terms!(\n data::Dict{String}\n) -> Tuple{Set{Int64}, Set{Int64}}\n\n\ntrims zeros from higher order cost terms\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.simplify_network!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.simplify_network!","text":"simplify_network!(data::Dict{String}) -> Bool\n\n\nattempts to deactive components that are not needed in the network by repeated calls to propagate_topology_status! and deactivate_isolated_components!\n\nwarning: this implementation has quadratic complexity, in the worst case\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.split_line-Tuple{AbstractString}","page":"Internals","title":"PowerSystems.split_line","text":"split_line(mp_line::AbstractString) -> Vector{Any}\n\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.standardize_cost_terms!-Tuple{Dict{String}}","page":"Internals","title":"PowerSystems.standardize_cost_terms!","text":"standardize_cost_terms!(data::Dict{String}; order)\n\n\nensures all polynomial costs functions have the same number of terms\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.throw_if_not_attached-Tuple{Component, System}","page":"Internals","title":"PowerSystems.throw_if_not_attached","text":"throw_if_not_attached(component::Component, sys::System)\n\n\nThrows ArgumentError if the component is not attached to the system.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.total_capacity_rating-Tuple{System}","page":"Internals","title":"PowerSystems.total_capacity_rating","text":"total_capacity_rating(sys::System) -> Any\n\n\ntotal_capacity_rating(sys::System)\n\nSum of system generator and storage ratings.\n\nArguments\n\nsys::System: system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.total_load_rating-Tuple{System}","page":"Internals","title":"PowerSystems.total_load_rating","text":"total_load_rating(sys::System) -> Any\n\n\ntotal_load_rating(sys::System)\n\nChecks the system for sum(generator ratings) >= sum(load ratings).\n\nArguments\n\nsys::System: system\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.update_bus_ids!-Tuple{Dict{String}, Dict{Int64, Int64}}","page":"Internals","title":"PowerSystems.update_bus_ids!","text":"update_bus_ids!(\n data::Dict{String},\n bus_id_map::Dict{Int64, Int64};\n injective\n)\n\n\ngiven 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.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.update_data!-Tuple{Dict{String}, Dict{String}}","page":"Internals","title":"PowerSystems.update_data!","text":"update_data!(data::Dict{String}, new_data::Dict{String})\n\n\nrecursively applies new_data to data, overwriting information\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerSystems.verify_device_eligibility-Tuple{System, StaticInjection, Service}","page":"Internals","title":"PowerSystems.verify_device_eligibility","text":"verify_device_eligibility(\n sys::System,\n component::StaticInjection,\n service::Service\n)\n\n\nValidates if a device is eligible to contribute to a service.\n\nArguments\n\nsys::System: PowerSystem System\ncomponent::StaticInjection: Static injection device\nservice::Service,: Service for which the device is eligible to contribute\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#FrequencyEstimator","page":"FrequencyEstimator","title":"FrequencyEstimator","text":"","category":"section"},{"location":"model_library/generated_FrequencyEstimator/#FixedFrequency","page":"FrequencyEstimator","title":"FixedFrequency","text":"","category":"section"},{"location":"model_library/generated_FrequencyEstimator/","page":"FrequencyEstimator","title":"FrequencyEstimator","text":"Modules = [PowerSystems]\nPages = [\"/FixedFrequency.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.FixedFrequency","page":"FrequencyEstimator","title":"PowerSystems.FixedFrequency","text":"mutable struct FixedFrequency <: FrequencyEstimator\n frequency::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Fixed Frequency Estimator (i.e. no PLL)\n\nArguments\n\nfrequency::Float64: (default: 1.0) Reference Frequency (pu)\next::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.\nstates::Vector{Symbol}: (Do not modify.) FixedFrequency has no states\nn_states::Int: (Do not modify.) FixedFrequency has no states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ext-Tuple{FixedFrequency}","page":"FrequencyEstimator","title":"PowerSystems.get_ext","text":"get_ext(value::FixedFrequency) -> Dict{String, Any}\n\n\nGet FixedFrequency ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_frequency-Tuple{FixedFrequency}","page":"FrequencyEstimator","title":"PowerSystems.get_frequency","text":"get_frequency(value::FixedFrequency) -> Float64\n\n\nGet FixedFrequency frequency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_n_states-Tuple{FixedFrequency}","page":"FrequencyEstimator","title":"PowerSystems.get_n_states","text":"get_n_states(value::FixedFrequency) -> Int64\n\n\nGet FixedFrequency n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_states-Tuple{FixedFrequency}","page":"FrequencyEstimator","title":"PowerSystems.get_states","text":"get_states(value::FixedFrequency) -> Vector{Symbol}\n\n\nGet FixedFrequency states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ext!-Tuple{FixedFrequency, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ext!","text":"set_ext!(value::FixedFrequency, val) -> Any\n\n\nSet FixedFrequency ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_frequency!-Tuple{FixedFrequency, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_frequency!","text":"set_frequency!(value::FixedFrequency, val) -> Any\n\n\nSet FixedFrequency frequency.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#KauraPLL","page":"FrequencyEstimator","title":"KauraPLL","text":"","category":"section"},{"location":"model_library/generated_FrequencyEstimator/","page":"FrequencyEstimator","title":"FrequencyEstimator","text":"Modules = [PowerSystems]\nPages = [\"/KauraPLL.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.KauraPLL","page":"FrequencyEstimator","title":"PowerSystems.KauraPLL","text":"mutable struct KauraPLL <: FrequencyEstimator\n ω_lp::Float64\n kp_pll::Float64\n ki_pll::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters 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\n\nArguments\n\nω_lp::Float64: PLL low-pass filter frequency (rad/sec), validation range: (0, nothing)\nkp_pll::Float64: PLL proportional gain, validation range: (0, nothing)\nki_pll::Float64: PLL integral gain, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the KauraPLL model are:\n\nvd_pll: d-axis of the measured voltage in the PLL synchronous reference frame (SRF),\nvq_pll: q-axis of the measured voltage in the PLL SRF,\nε_pll: Integrator state of the PI controller,\nθ_pll: Phase angle displacement in the PLL SRF\n\nn_states::Int: (Do not modify.) KauraPLL has 4 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ext-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ext","text":"get_ext(value::KauraPLL) -> Dict{String, Any}\n\n\nGet KauraPLL ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ki_pll-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ki_pll","text":"get_ki_pll(value::KauraPLL) -> Float64\n\n\nGet KauraPLL ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_kp_pll-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_kp_pll","text":"get_kp_pll(value::KauraPLL) -> Float64\n\n\nGet KauraPLL kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_n_states-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_n_states","text":"get_n_states(value::KauraPLL) -> Int64\n\n\nGet KauraPLL n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_states-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_states","text":"get_states(value::KauraPLL) -> Vector{Symbol}\n\n\nGet KauraPLL states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ω_lp-Tuple{KauraPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ω_lp","text":"get_ω_lp(value::KauraPLL) -> Float64\n\n\nGet KauraPLL ω_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ext!-Tuple{KauraPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ext!","text":"set_ext!(value::KauraPLL, val) -> Any\n\n\nSet KauraPLL ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ki_pll!-Tuple{KauraPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ki_pll!","text":"set_ki_pll!(value::KauraPLL, val) -> Any\n\n\nSet KauraPLL ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_kp_pll!-Tuple{KauraPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_kp_pll!","text":"set_kp_pll!(value::KauraPLL, val) -> Any\n\n\nSet KauraPLL kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ω_lp!-Tuple{KauraPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ω_lp!","text":"set_ω_lp!(value::KauraPLL, val) -> Any\n\n\nSet KauraPLL ω_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#ReducedOrderPLL","page":"FrequencyEstimator","title":"ReducedOrderPLL","text":"","category":"section"},{"location":"model_library/generated_FrequencyEstimator/","page":"FrequencyEstimator","title":"FrequencyEstimator","text":"Modules = [PowerSystems]\nPages = [\"/ReducedOrderPLL.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.ReducedOrderPLL","page":"FrequencyEstimator","title":"PowerSystems.ReducedOrderPLL","text":"mutable struct ReducedOrderPLL <: FrequencyEstimator\n ω_lp::Float64\n kp_pll::Float64\n ki_pll::Float64\n ext::Dict{String, Any}\n states::Vector{Symbol}\n n_states::Int\nend\n\nParameters of a Phase-Locked Loop (PLL) based on \"Reduced-order Structure-preserving Model for Parallel-connected Three-phase Grid-tied Inverters.\"\n\nArguments\n\nω_lp::Float64: PLL low-pass filter frequency (rad/sec), validation range: (0, nothing)\nkp_pll::Float64: PLL proportional gain, validation range: (0, nothing)\nki_pll::Float64: PLL integral gain, validation range: (0, nothing)\next::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.\nstates::Vector{Symbol}: (Do not modify.) The states of the ReducedOrderPLL model are:\n\nvq_pll: q-axis of the measured voltage in the PLL synchronous reference frame (SRF),\nε_pll: Integrator state of the PI controller,\nθ_pll: Phase angle displacement in the PLL SRF\n\nn_states::Int: (Do not modify.) ReducedOrderPLL has 3 states\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ext-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ext","text":"get_ext(value::ReducedOrderPLL) -> Dict{String, Any}\n\n\nGet ReducedOrderPLL ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ki_pll-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ki_pll","text":"get_ki_pll(value::ReducedOrderPLL) -> Float64\n\n\nGet ReducedOrderPLL ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_kp_pll-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_kp_pll","text":"get_kp_pll(value::ReducedOrderPLL) -> Float64\n\n\nGet ReducedOrderPLL kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_n_states-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_n_states","text":"get_n_states(value::ReducedOrderPLL) -> Int64\n\n\nGet ReducedOrderPLL n_states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_states-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_states","text":"get_states(value::ReducedOrderPLL) -> Vector{Symbol}\n\n\nGet ReducedOrderPLL states.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.get_ω_lp-Tuple{ReducedOrderPLL}","page":"FrequencyEstimator","title":"PowerSystems.get_ω_lp","text":"get_ω_lp(value::ReducedOrderPLL) -> Float64\n\n\nGet ReducedOrderPLL ω_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ext!-Tuple{ReducedOrderPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ext!","text":"set_ext!(value::ReducedOrderPLL, val) -> Any\n\n\nSet ReducedOrderPLL ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ki_pll!-Tuple{ReducedOrderPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ki_pll!","text":"set_ki_pll!(value::ReducedOrderPLL, val) -> Any\n\n\nSet ReducedOrderPLL ki_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_kp_pll!-Tuple{ReducedOrderPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_kp_pll!","text":"set_kp_pll!(value::ReducedOrderPLL, val) -> Any\n\n\nSet ReducedOrderPLL kp_pll.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_FrequencyEstimator/#PowerSystems.set_ω_lp!-Tuple{ReducedOrderPLL, Any}","page":"FrequencyEstimator","title":"PowerSystems.set_ω_lp!","text":"set_ω_lp!(value::ReducedOrderPLL, val) -> Any\n\n\nSet ReducedOrderPLL ω_lp.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#ExponentialLoad","page":"ExponentialLoad","title":"ExponentialLoad","text":"","category":"section"},{"location":"model_library/generated_ExponentialLoad/","page":"ExponentialLoad","title":"ExponentialLoad","text":"Modules = [PowerSystems]\nPages = [\"generated/ExponentialLoad.jl\"]\nOrder = [:type, :function]\nPublic = true\nPrivate = false","category":"page"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.ExponentialLoad","page":"ExponentialLoad","title":"PowerSystems.ExponentialLoad","text":"mutable struct ExponentialLoad <: StaticLoad\n name::String\n available::Bool\n bus::ACBus\n active_power::Float64\n reactive_power::Float64\n α::Float64\n β::Float64\n base_power::Float64\n max_active_power::Float64\n max_reactive_power::Float64\n services::Vector{Service}\n dynamic_injector::Union{Nothing, DynamicInjection}\n ext::Dict{String, Any}\n internal::InfrastructureSystemsInternal\nend\n\nA voltage-dependent ZIP load, most commonly used for dynamics modeling.\n\nAn 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\n\nArguments\n\nname::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\navailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations\nbus::ACBus: Bus that this component is connected to\nactive_power::Float64: Active power coefficient, P0 (MW)\nreactive_power::Float64: Reactive power coefficient, Q0 (MVAR)\nα::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)\nβ::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)\nbase_power::Float64: Base power (MVA) for per unitization, validation range: (0, nothing)\nmax_active_power::Float64: Maximum active power (MW) that this load can demand\nmax_reactive_power::Float64: Maximum reactive power (MVAR) that this load can demand\nservices::Vector{Service}: (default: Device[]) Services that this device contributes to\ndynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device\next::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.\ninternal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference\n\n\n\n\n\n","category":"type"},{"location":"model_library/generated_ExponentialLoad/#InfrastructureSystems.get_name-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"InfrastructureSystems.get_name","text":"get_name(value::ExponentialLoad) -> String\n\n\nGet ExponentialLoad name.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_active_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_active_power","text":"get_active_power(value::ExponentialLoad) -> Any\n\n\nGet ExponentialLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_available-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_available","text":"get_available(value::ExponentialLoad) -> Bool\n\n\nGet ExponentialLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_base_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_base_power","text":"get_base_power(value::ExponentialLoad) -> Float64\n\n\nGet ExponentialLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_bus-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_bus","text":"get_bus(value::ExponentialLoad) -> ACBus\n\n\nGet ExponentialLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_dynamic_injector-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_dynamic_injector","text":"get_dynamic_injector(\n value::ExponentialLoad\n) -> Union{Nothing, DynamicInjection}\n\n\nGet ExponentialLoad dynamic_injector.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_ext-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_ext","text":"get_ext(value::ExponentialLoad) -> Dict{String, Any}\n\n\nGet ExponentialLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_max_active_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_max_active_power","text":"get_max_active_power(value::ExponentialLoad) -> Any\n\n\nGet ExponentialLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_max_reactive_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_max_reactive_power","text":"get_max_reactive_power(value::ExponentialLoad) -> Any\n\n\nGet ExponentialLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_reactive_power-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_reactive_power","text":"get_reactive_power(value::ExponentialLoad) -> Any\n\n\nGet ExponentialLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_services-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_services","text":"get_services(value::ExponentialLoad) -> Vector{Service}\n\n\nGet ExponentialLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_α-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_α","text":"get_α(value::ExponentialLoad) -> Float64\n\n\nGet ExponentialLoad α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.get_β-Tuple{ExponentialLoad}","page":"ExponentialLoad","title":"PowerSystems.get_β","text":"get_β(value::ExponentialLoad) -> Float64\n\n\nGet ExponentialLoad β.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_active_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_active_power!","text":"set_active_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_available!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_available!","text":"set_available!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad available.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_base_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_base_power!","text":"set_base_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad base_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_bus!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_bus!","text":"set_bus!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad bus.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_ext!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_ext!","text":"set_ext!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad ext.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_max_active_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_max_active_power!","text":"set_max_active_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad max_active_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_max_reactive_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_max_reactive_power!","text":"set_max_reactive_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad max_reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_reactive_power!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_reactive_power!","text":"set_reactive_power!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad reactive_power.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_services!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_services!","text":"set_services!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad services.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_α!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_α!","text":"set_α!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad α.\n\n\n\n\n\n","category":"method"},{"location":"model_library/generated_ExponentialLoad/#PowerSystems.set_β!-Tuple{ExponentialLoad, Any}","page":"ExponentialLoad","title":"PowerSystems.set_β!","text":"set_β!(value::ExponentialLoad, val) -> Any\n\n\nSet ExponentialLoad β.\n\n\n\n\n\n","category":"method"}] } diff --git a/previews/PR1205/tutorials/add_dynamic_data/index.html b/previews/PR1205/tutorials/add_dynamic_data/index.html index 1b1e42e43e..3b2a27f3ac 100644 --- a/previews/PR1205/tutorials/add_dynamic_data/index.html +++ b/previews/PR1205/tutorials/add_dynamic_data/index.html @@ -91,11 +91,11 @@ Xq_p = 0.25, Td0_p = 5.89, Tq0_p = 0.6, - )OneDOneQMachine(0.0, 1.3125, 1.2578, 0.1813, 0.25, 5.89, 0.6, Dict{String, Any}(), [:eq_p, :ed_p], 2, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("45f3b5bc-aae2-4eba-b06f-7b970e323fd6"), nothing, nothing, nothing))

Notice that we selected a specific model, OneDOneQMachine, with the parameters tailored to a One-d-one-q dynamic machine model.

Next, define a specific Shaft model, SingleMass that describes the rotor electro-mechanical dynamics:

julia> # Shaft
+       )OneDOneQMachine(0.0, 1.3125, 1.2578, 0.1813, 0.25, 5.89, 0.6, Dict{String, Any}(), [:eq_p, :ed_p], 2, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("24a93eeb-e819-4709-96db-24786fa37680"), nothing, nothing, nothing))

Notice that we selected a specific model, OneDOneQMachine, with the parameters tailored to a One-d-one-q dynamic machine model.

Next, define a specific Shaft model, SingleMass that describes the rotor electro-mechanical dynamics:

julia> # Shaft
        shaft_no_damping = SingleMass(;
            H = 3.01, #(M = 6.02 -> H = M/2)
            D = 0.0,
-       )SingleMass(3.01, 0.0, Dict{String, Any}(), [:δ, :ω], 2, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("f65aea21-6521-40fa-8adf-54b4e2346b8e"), nothing, nothing, nothing))

Represent the electromotive dynamics of the AVR controller using a specific Automatic Voltage Regulator model, AVRTypeI:

julia> # AVR: Type I: Resembles a DC1 AVR
+       )SingleMass(3.01, 0.0, Dict{String, Any}(), [:δ, :ω], 2, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("125dbdd4-db35-4539-9048-f2640b1ee8b1"), nothing, nothing, nothing))

Represent the electromotive dynamics of the AVR controller using a specific Automatic Voltage Regulator model, AVRTypeI:

julia> # AVR: Type I: Resembles a DC1 AVR
        avr_type1 = AVRTypeI(;
            Ka = 20.0,
            Ke = 0.01,
@@ -107,9 +107,9 @@
            Va_lim = (min = -5.0, max = 5.0),
            Ae = 0.0039, #1st ceiling coefficient
            Be = 1.555, #2nd ceiling coefficient
-       )AVRTypeI(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(Base.UUID("bdc4c14d-e505-42bf-a1bd-0bb7f75659b5"), nothing, nothing, nothing))

Define a fixed efficiency Prime Mover and Turbine Governor with TGFixed:

julia> #No TG
-       tg_none = TGFixed(; efficiency = 1.0) #efficiencyTGFixed(1.0, 1.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("30dc7670-5859-4719-a95f-4b819cb783b0"), nothing, nothing, nothing))

See that we are modeling a machine that does not include a Turbine Governor (or PSS below), but you must define components for them to build a complete machine model.

Similarly, define a PSS using PSSFixed, which is used to describe the stabilization signal for the AVR:

julia> #No PSS
-       pss_none = PSSFixed(; V_pss = 0.0)PSSFixed(0.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("3fb7a331-4e00-4003-834f-df76adb73102"), nothing, nothing, nothing))

Now, we are ready to add a dynamic generator to the static generator at bus 102. First, let's get that static generator:

julia> static_gen = get_component(Generator, threebus_sys, "generator-102-1")ThermalStandard: generator-102-1:
+       )AVRTypeI(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(Base.UUID("68f941b5-91db-417b-82f5-a8345d966447"), nothing, nothing, nothing))

Define a fixed efficiency Prime Mover and Turbine Governor with TGFixed:

julia> #No TG
+       tg_none = TGFixed(; efficiency = 1.0) #efficiencyTGFixed(1.0, 1.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("913b3098-5e8b-4f8d-9f16-60ab833778d4"), nothing, nothing, nothing))

See that we are modeling a machine that does not include a Turbine Governor (or PSS below), but you must define components for them to build a complete machine model.

Similarly, define a PSS using PSSFixed, which is used to describe the stabilization signal for the AVR:

julia> #No PSS
+       pss_none = PSSFixed(; V_pss = 0.0)PSSFixed(0.0, Dict{String, Any}(), Symbol[], 0, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("93b186f7-5a45-4762-9e1d-aa21158ae9e8"), nothing, nothing, nothing))

Now, we are ready to add a dynamic generator to the static generator at bus 102. First, let's get that static generator:

julia> static_gen = get_component(Generator, threebus_sys, "generator-102-1")ThermalStandard: generator-102-1:
    name: generator-102-1
    available: true
    status: true
@@ -340,4 +340,4 @@
 │ DynamicGenerator{OneDOneQMachine, SingleMass, AVRTypeI, TGFixed, PSSFixed}   ⋯
 │ DynamicInverter{AverageConverter, OuterControl{VirtualInertia, ReactivePower ⋯
 └───────────────────────────────────────────────────────────────────────────────
-                                                               2 columns omitted

Verify that the additions were successful, with an added voltage Source, DynamicBranches replacing the static Lines, and two new dynamic components with the generator and inverter models.

Next Steps

In this tutorial, you have updated a static system with a second dynamic data layer. The data you added can enable a phasor-based simulation using the dynamic generator, or a more complex EMT simulation with the additional dynamic inverter and dynamic lines.

Next, you might like to:

+ 2 columns omitted

Verify that the additions were successful, with an added voltage Source, DynamicBranches replacing the static Lines, and two new dynamic components with the generator and inverter models.

Next Steps

In this tutorial, you have updated a static system with a second dynamic data layer. The data you added can enable a phasor-based simulation using the dynamic generator, or a more complex EMT simulation with the additional dynamic inverter and dynamic lines.

Next, you might like to:

diff --git a/previews/PR1205/tutorials/creating_system/index.html b/previews/PR1205/tutorials/creating_system/index.html index 31aa2869e5..b6e1e02372 100644 --- a/previews/PR1205/tutorials/creating_system/index.html +++ b/previews/PR1205/tutorials/creating_system/index.html @@ -180,4 +180,4 @@ │ PowerLoad │ 1 │ │ RenewableDispatch │ 1 │ │ ThermalStandard │ 1 │ -└───────────────────┴───────┘

See the units base is printed as one of the System properties.

Next Steps

In this tutorial, you manually created a power System, added and then retrieved its components, and modified the System per-unit settings.

Next, you might want to:

+└───────────────────┴───────┘

See the units base is printed as one of the System properties.

Next Steps

In this tutorial, you manually created a power System, added and then retrieved its components, and modified the System per-unit settings.

Next, you might want to:

diff --git a/previews/PR1205/tutorials/get_component_data/index.html b/previews/PR1205/tutorials/get_component_data/index.html index 9619426763..93a2547997 100644 --- a/previews/PR1205/tutorials/get_component_data/index.html +++ b/previews/PR1205/tutorials/get_component_data/index.html @@ -514,4 +514,4 @@ │ 307_CT_1 │ true │ 0.55 │ 0.19 │ │ 102_STEAM_4 │ true │ 0.76 │ -0.0231 │ │ 107_CC_1 │ true │ 3.55 │ 0.4951 │ -└─────────────────┴───────────┴──────────────┴────────────────┘

to do: add a link in the system that MD explanation to these examples

+└─────────────────┴───────────┴──────────────┴────────────────┘

to do: add a link in the system that MD explanation to these examples

diff --git a/previews/PR1205/tutorials/working_with_time_series/index.html b/previews/PR1205/tutorials/working_with_time_series/index.html index cfd186c7fd..8ebd2c38d7 100644 --- a/previews/PR1205/tutorials/working_with_time_series/index.html +++ b/previews/PR1205/tutorials/working_with_time_series/index.html @@ -332,8 +332,8 @@ │ SingleTimeSeries │ max_active_power │ 2020-01-01T08:00:00 │ 300000 milliseconds │ 24 │ Dict{String, Any}() │ └──────────────────┴──────────────────┴─────────────────────┴─────────────────────┴────────┴─────────────────────┘

See the unnecessary data is gone.

Finally, let's do a last data sanity check on the forecasts. Since we defined the wind time series in MW instead of scaling factors, let's make sure none of our forecasts exceeds the max_active_power parameter.

Instead of using get_time_series_array where we need to remember some details of the time series we're looking up, let's use get_time_series_keys to refresh our memories:

julia> keys = get_time_series_keys(wind1)2-element Vector{TimeSeriesKey}:
  ForecastKey(Deterministic, "max_active_power", Dates.DateTime("2020-01-01T08:00:00"), Dates.Minute(5), Dates.Minute(60), Dates.Millisecond(1800000), 3, Dict{String, Any}())
- StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2020-01-01T08:00:00"), Dates.Millisecond(300000), 24, Dict{String, Any}())

See the forecast key is first, so let's retrieve it using get_time_series:

julia> forecast = get_time_series(wind1, keys[1])Deterministic("max_active_power", DataStructures.SortedDict(Dates.DateTime("2020-01-01T08:00:00") => [5.0, 6.0, 7.0, 7.0, 7.0, 8.0, 9.0, 10.0, 10.0, 9.0, 7.0, 5.0], Dates.DateTime("2020-01-01T08:30:00") => [9.0, 9.0, 9.0, 9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 5.0, 4.0, 4.0], Dates.DateTime("2020-01-01T09:00:00") => [6.0, 6.0, 5.0, 5.0, 4.0, 5.0, 6.0, 7.0, 7.0, 7.0, 6.0, 6.0]), Dates.Minute(5), nothing, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("f2db844f-425a-4084-98e6-df4bdbeadefd"), nothing, nothing, nothing))

See that unlike when we used get_time_series_array, this returns an object we can manipulate.

Use iterate_windows to cycle through the 3 forecast windows and inspect the peak value:

julia> for window in iterate_windows(forecast)
+ StaticTimeSeriesKey(SingleTimeSeries, "max_active_power", Dates.DateTime("2020-01-01T08:00:00"), Dates.Millisecond(300000), 24, Dict{String, Any}())

See the forecast key is first, so let's retrieve it using get_time_series:

julia> forecast = get_time_series(wind1, keys[1])Deterministic("max_active_power", DataStructures.SortedDict(Dates.DateTime("2020-01-01T08:00:00") => [5.0, 6.0, 7.0, 7.0, 7.0, 8.0, 9.0, 10.0, 10.0, 9.0, 7.0, 5.0], Dates.DateTime("2020-01-01T08:30:00") => [9.0, 9.0, 9.0, 9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 5.0, 4.0, 4.0], Dates.DateTime("2020-01-01T09:00:00") => [6.0, 6.0, 5.0, 5.0, 4.0, 5.0, 6.0, 7.0, 7.0, 7.0, 6.0, 6.0]), Dates.Minute(5), nothing, InfrastructureSystems.InfrastructureSystemsInternal(Base.UUID("55936dae-2c27-494e-b3b2-18644b0f9e0c"), nothing, nothing, nothing))

See that unlike when we used get_time_series_array, this returns an object we can manipulate.

Use iterate_windows to cycle through the 3 forecast windows and inspect the peak value:

julia> for window in iterate_windows(forecast)
            @show values(maximum(window))
        endvalues(maximum(window)) = [10.0]
 values(maximum(window)) = [9.0]
-values(maximum(window)) = [7.0]

Finally, use get_max_active_power to check the expected maximum:

julia> get_max_active_power(wind1)10.0

See that the forecasts are not exceeding this maximum – sanity check complete.

Tip

Unlike PowerLoad components, RenewableDispatch components do not have a max_active_power field, so check get_max_active_power to see how its calculated.

Next Steps

In this tutorial, you defined, added, and retrieved four time series data sets, including static time series and deterministic forecasts. Along the way, we reduced data duplication using normalized scaling factors for reuse by multiple components or component fields, as well as by referencing a StaticTimeSeries to address missing forecast data.

Next you might like to:

+values(maximum(window)) = [7.0]

Finally, use get_max_active_power to check the expected maximum:

julia> get_max_active_power(wind1)10.0

See that the forecasts are not exceeding this maximum – sanity check complete.

Tip

Unlike PowerLoad components, RenewableDispatch components do not have a max_active_power field, so check get_max_active_power to see how its calculated.

Next Steps

In this tutorial, you defined, added, and retrieved four time series data sets, including static time series and deterministic forecasts. Along the way, we reduced data duplication using normalized scaling factors for reuse by multiple components or component fields, as well as by referencing a StaticTimeSeries to address missing forecast data.

Next you might like to: