diff --git a/previews/PR54/api/internal/index.html b/previews/PR54/api/internal/index.html index a5d8a3a..804da92 100644 --- a/previews/PR54/api/internal/index.html +++ b/previews/PR54/api/internal/index.html @@ -1,2 +1,2 @@ -Internal API Reference · PowerFlows.jl
Edit on GitHub

Internal

PowerFlows._first_choice_gen_id — Method

Try to make an informative one or two character name for the load/generator/etc.

  • "generator-1234-AB" -> "AB"
  • "123CT7" -> "7"
  • "load1234" -> "34"
source
PowerFlows._psse_bus_names — Method

Given a vector of Sienna bus names, create a dictionary from Sienna bus name to PSS/E-compatible bus name. Guarantees determinism and minimal changes.

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data

source
PowerFlows._psse_bus_numbers — Method

Given a vector of Sienna bus numbers, create a dictionary from Sienna bus number to PSS/E-compatible bus number. Assumes that the Sienna bus numbers are positive and unique. Guarantees determinism: if the input contains the same bus numbers in the same order, the output will. Guarantees minimal changes: that if an existing bus number is compliant, it will not be changed.

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data

source
PowerFlows._psse_transformer_names — Method

Given a vector of Sienna transformer names, create a dictionary from Sienna transformer name to PSS/E-compatible transformer name. Guarantees determinism and minimal changes.

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Transformer Data

source
PowerFlows.create_component_ids — Method

Given a vector of component names and a corresponding vector of container IDs (e.g., bus numbers), create unique-per-container PSS/E-compatible IDs, output a dictionary from (container ID, component name) to PSS/E-compatible component ID. The "singlesto1" flag detects components that are the only one on their bus and gives them the name "1".

source
PowerFlows.fix_nans! — Method

Iterate over all the Generators in the system and, if any active_power or reactive_power fields are NaN, make them 0.0

source
PowerFlows.flow_func — Method

Calculates the From - To complex power flow using external data of voltages of branch of type Line

source
PowerFlows.flow_func — Method

Calculates the From - To complex power flow using external data of voltages of branch of type TapTransformer

source
PowerFlows.flow_func — Method

Calculates the From - To complex power flow using external data of voltages of branch of type Transformer2W

source
PowerFlows.flow_val — Method

Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line

source
PowerFlows.flow_val — Method

Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line

source
PowerFlows.flow_val — Method

Calculates the From - To complex power flow (Flow injected at the bus) of branch of type TapTransformer

source
PowerFlows.flow_val — Method

Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Transformer2W

source
PowerFlows.make_power_flow_container — Function

Create an appropriate PowerFlowContainer for the given PowerFlowEvaluationModel and initialize it from the given PSY.System.

Arguments:

  • pfem::PowerFlowEvaluationModel: power flow model to construct a container for (e.g., DCPowerFlow())
  • sys::PSY.System: the system from which to initialize the power flow container
  • time_steps::Int: number of time periods to consider (default is 1)
  • timestep_names::Vector{String}: names of the time periods defines by the argument "time_steps". Default value is String[].
  • check_connectivity::Bool: Perform connectivity check on the network matrix. Default value is true.
source
PowerFlows.solve_powerflow! — Method

Evaluates the power flows on each system's branch and updates the PowerFlowData structure.

Arguments:

  • data::PTDFPowerFlowData: PTDFPowerFlowData structure containing all the information related to the system's power flow.
source
PowerFlows.solve_powerflow! — Method

Evaluates the power flows on each system's branch and updates the PowerFlowData structure.

Arguments:

  • data::vPTDFPowerFlowData: vPTDFPowerFlowData structure containing all the information related to the system's power flow.
source
PowerFlows.update_system! — Method

Modify the values in the given System to correspond to the given PowerFlowData such that if a new PowerFlowData is constructed from the resulting system it is the same as data. See also write_powerflow_solution!. NOTE that this assumes that data was initialized from sys and then solved with no further modifications.

source
PowerFlows.with_units — Method

A context manager similar to Logging.with_logger that sets the system's units to the given value, executes the function, then sets them back. Suppresses logging below Warn from internal calls to set_units_base_system!. Not thread safe.

source
PowerFlows.write_to_buffers! — Method

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data. Sienna voltage limits treated as PSS/E normal voltage limits; PSSE emergency voltage limits left as default.

source
PowerFlows.write_to_buffers! — Method

If the exportsettings flag `sourcesas_generatorsis set, exportPSY.Sourceinstances as PSS/E generators in addition toPSY.Generator`s

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Generator Data

source
+Internal API Reference · PowerFlows.jl
Edit on GitHub

Internal

PowerFlows._first_choice_gen_id — Method

Try to make an informative one or two character name for the load/generator/etc.

  • "generator-1234-AB" -> "AB"
  • "123CT7" -> "7"
  • "load1234" -> "34"
source
PowerFlows._psse_bus_names — Method

Given a vector of Sienna bus names, create a dictionary from Sienna bus name to PSS/E-compatible bus name. Guarantees determinism and minimal changes.

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data

source
PowerFlows._psse_bus_numbers — Method

Given a vector of Sienna bus numbers, create a dictionary from Sienna bus number to PSS/E-compatible bus number. Assumes that the Sienna bus numbers are positive and unique. Guarantees determinism: if the input contains the same bus numbers in the same order, the output will. Guarantees minimal changes: that if an existing bus number is compliant, it will not be changed.

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data

source
PowerFlows._psse_transformer_names — Method

Given a vector of Sienna transformer names, create a dictionary from Sienna transformer name to PSS/E-compatible transformer name. Guarantees determinism and minimal changes.

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Transformer Data

source
PowerFlows.create_component_ids — Method

Given a vector of component names and a corresponding vector of container IDs (e.g., bus numbers), create unique-per-container PSS/E-compatible IDs, output a dictionary from (container ID, component name) to PSS/E-compatible component ID. The "singlesto1" flag detects components that are the only one on their bus and gives them the name "1".

source
PowerFlows.fix_nans! — Method

Iterate over all the Generators in the system and, if any active_power or reactive_power fields are NaN, make them 0.0

source
PowerFlows.flow_func — Method

Calculates the From - To complex power flow using external data of voltages of branch of type Line

source
PowerFlows.flow_func — Method

Calculates the From - To complex power flow using external data of voltages of branch of type TapTransformer

source
PowerFlows.flow_func — Method

Calculates the From - To complex power flow using external data of voltages of branch of type Transformer2W

source
PowerFlows.flow_val — Method

Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line

source
PowerFlows.flow_val — Method

Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line

source
PowerFlows.flow_val — Method

Calculates the From - To complex power flow (Flow injected at the bus) of branch of type TapTransformer

source
PowerFlows.flow_val — Method

Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Transformer2W

source
PowerFlows.make_power_flow_container — Function

Create an appropriate PowerFlowContainer for the given PowerFlowEvaluationModel and initialize it from the given PSY.System.

Arguments:

  • pfem::PowerFlowEvaluationModel: power flow model to construct a container for (e.g., DCPowerFlow())
  • sys::PSY.System: the system from which to initialize the power flow container
  • time_steps::Int: number of time periods to consider (default is 1)
  • timestep_names::Vector{String}: names of the time periods defines by the argument "time_steps". Default value is String[].
  • check_connectivity::Bool: Perform connectivity check on the network matrix. Default value is true.
source
PowerFlows.solve_powerflow! — Method

Evaluates the power flows on each system's branch and updates the PowerFlowData structure.

Arguments:

  • data::PTDFPowerFlowData: PTDFPowerFlowData structure containing all the information related to the system's power flow.
source
PowerFlows.solve_powerflow! — Method

Evaluates the power flows on each system's branch and updates the PowerFlowData structure.

Arguments:

  • data::vPTDFPowerFlowData: vPTDFPowerFlowData structure containing all the information related to the system's power flow.
source
PowerFlows.update_system! — Method

Modify the values in the given System to correspond to the given PowerFlowData such that if a new PowerFlowData is constructed from the resulting system it is the same as data. See also write_powerflow_solution!. NOTE that this assumes that data was initialized from sys and then solved with no further modifications.

source
PowerFlows.write_to_buffers! — Method

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data. Sienna voltage limits treated as PSS/E normal voltage limits; PSSE emergency voltage limits left as default.

source
PowerFlows.write_to_buffers! — Method

If the exportsettings flag `sourcesas_generatorsis set, exportPSY.Sourceinstances as PSS/E generators in addition toPSY.Generator`s

WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Generator Data

source
diff --git a/previews/PR54/api/public/index.html b/previews/PR54/api/public/index.html index 8321998..6ffd63c 100644 --- a/previews/PR54/api/public/index.html +++ b/previews/PR54/api/public/index.html @@ -1,6 +1,6 @@ -Public API Reference · PowerFlows.jl
Edit on GitHub

PowerFlows

PowerFlows.PSSEExporter — Type

Structure to perform an export from a Sienna System, plus optional updates from PowerFlowData, to the PSS/E format. Construct from a System and a PSS/E version, update using update_exporter with any new data as relevant, and perform the export with write_export.

Arguments:

  • base_system::PSY.System: the system to be exported. Later updates may change power flow-related values but may not fundamentally alter the system
  • psse_version::Symbol: the version of PSS/E to target, must be one of PSSE_EXPORT_SUPPORTED_VERSIONS
  • write_comments::Bool = false: whether to add the customary-but-not-in-spec-annotations after a slash on the first line and at group boundaries
  • name::AbstractString = "export": the base name of the export
  • step::Union{Nothing, Integer, Tuple{Vararg{Integer}}} = nothing: optional step number or tuple of step numbers (e.g., step and timestamp within step) to append to the base export name. User is responsible for updating the step.
  • overwrite::Bool = false: true to silently overwrite existing exports, false to throw an error if existing results are encountered
source
PowerFlows.PowerFlowData — Type

Structure containing all the data required for the evaluation of the power flows and angles, as well as these ones.

Arguments:

  • bus_lookup::Dict{Int, Int}: dictionary linking the system's bus number with the rows of either "powernetworkmatrix" or "auxnetworkmatrix".
  • branch_lookup::Dict{String, Int}: dictionary linking the branch name with the column name of either the "powernetworkmatrix" or "auxnetworkmatrix".
  • bus_activepower_injection::Matrix{Float64}: "(b, t)" matrix containing the bus active power injection. b: number of buses, t: number of time period.
  • bus_reactivepower_injection::Matrix{Float64}: "(b, t)" matrix containing the bus reactive power injection. b: number of buses, t: number of time period.
  • bus_activepower_withdrawals::Matrix{Float64}: "(b, t)" matrix containing the bus reactive power withdrawals. b: number of buses, t: number of time period.
  • bus_reactivepower_withdrawals::Matrix{Float64}: "(b, t)" matrix containing the bus reactive power withdrawals. b: number of buses, t: number of time period.
  • bus_reactivepower_bounds::Vector{Float64}: Upper and Lower bounds for the reactive supply at each bus.
  • bus_type::Vector{PSY.ACBusTypes}: vector containing type of buses present in the system, ordered according to "bus_lookup".
  • bus_magnitude::Matrix{Float64}: "(b, t)" matrix containing the bus magnitudes, ordered according to "bus_lookup". b: number of buses, t: number of time period.
  • bus_angles::Matrix{Float64}: "(b, t)" matrix containing the bus angles, ordered according to "bus_lookup". b: number of buses, t: number of time period.
  • branch_flow_values::Matrix{Float64}: "(br, t)" matrix containing the power flows, ordered according to "branch_lookup". br: number of branches, t: number of time period.
  • timestep_map::Dict{Int, S}: dictonary mapping the number of the time periods (corresponding to the column number of the previosly mentioned matrices) and their names.
  • valid_ix::Vector{Int}: vector containing the indeces of not slack buses
  • power_network_matrix::M: matrix used for the evaluation of either the power flows or bus angles, depending on the method considered.
  • aux_network_matrix::N: matrix used for the evaluation of either the power flows or bus angles, depending on the method considered.
  • neighbors::Vector{Set{Int}}: Vector with the sets of adjacent buses.
source
PowerFlows.PowerFlowData — Method

Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for AC power flow computations.

Arguments:

  • ::ACPowerFlow: use ACPowerFlow() to evaluate the AC PF.
  • sys::PSY.System: container storing the system data to consider in the PowerFlowData structure.
  • time_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.
  • timestep_names::Vector{String}: names of the time periods defines by the argmunet "time_steps". Default value = String[].
  • check_connectivity::Bool: Perform connectivity check on the network matrix. Default value = true.

WARNING: functions for the evaluation of the multi-period AC PF still to be implemented.

source
PowerFlows.PowerFlowData — Method

Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for DC power flow computations.

Arguments:

  • ::DCPowerFlow: use DCPowerFlow() to store the ABA matrix as powernetworkmatrix and the BA matrix as auxnetworkmatrix.
  • sys::PSY.System: container storing the system data to consider in the PowerFlowData structure.
  • time_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.
  • timestep_names::Vector{String}: names of the time periods defines by the argmunet "time_steps". Default value = String[].
  • check_connectivity::Bool: Perform connectivity check on the network matrix. Default value = true.
source
PowerFlows.PowerFlowData — Method

Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for DC power flow computations.

Arguments:

  • ::PTDFDCPowerFlow: use vPTDFDCPowerFlow() to store the Virtual PTDF matrix as powernetworkmatrix and the ABA matrix as auxnetworkmatrix.
  • sys::PSY.System: container storing the system data to consider in the PowerFlowData structure.
  • time_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.
  • timestep_names::Vector{String}: names of the time periods defines by the argmunet "time_steps". Default value = String[].
source
PowerFlows.solve_ac_powerflow! — Method

Solves a the power flow into the system and writes the solution into the relevant structs. Updates generators active and reactive power setpoints and branches active and reactive power flows (calculated in the From - To direction) (see flow_val)

Supports passing NLsolve kwargs in the args. By default shows the solver trace.

Arguments available for nlsolve:

  • get_connectivity::Bool: Checks if the network is connected. Default true
  • method : See NLSolve.jl documentation for available solvers
  • xtol: norm difference in x between two successive iterates under which convergence is declared. Default: 0.0.
  • ftol: infinite norm of residuals under which convergence is declared. Default: 1e-8.
  • iterations: maximum number of iterations. Default: 1_000.
  • store_trace: should a trace of the optimization algorithm's state be stored? Default: false.
  • show_trace: should a trace of the optimization algorithm's state be shown on STDOUT? Default: false.
  • extended_trace: should additifonal algorithm internals be added to the state trace? Default: false.

Examples

solve_ac_powerflow!(sys)
+Public API Reference · PowerFlows.jl
Edit on GitHub
PowerFlows
PowerFlows.PSSEExporter — Type
Structure to perform an export from a Sienna System, plus optional updates from PowerFlowData, to the PSS/E format. Construct from a System and a PSS/E version, update using update_exporter with any new data as relevant, and perform the export with write_export.
Arguments:
  • base_system::PSY.System: the system to be exported. Later updates may change power flow-related values but may not fundamentally alter the system
  • psse_version::Symbol: the version of PSS/E to target, must be one of PSSE_EXPORT_SUPPORTED_VERSIONS
  • write_comments::Bool = false: whether to add the customary-but-not-in-spec-annotations after a slash on the first line and at group boundaries
  • name::AbstractString = "export": the base name of the export
  • step::Union{Nothing, Integer, Tuple{Vararg{Integer}}} = nothing: optional step number or tuple of step numbers (e.g., step and timestamp within step) to append to the base export name. User is responsible for updating the step.
  • overwrite::Bool = false: true to silently overwrite existing exports, false to throw an error if existing results are encountered
source
PowerFlows.PowerFlowData — Type
Structure containing all the data required for the evaluation of the power flows and angles, as well as these ones.
Arguments:
  • bus_lookup::Dict{Int, Int}:       dictionary linking the system's bus number with the rows of either       "powernetworkmatrix" or "auxnetworkmatrix".
  • branch_lookup::Dict{String, Int}:       dictionary linking the branch name with the column name of either the       "powernetworkmatrix" or "auxnetworkmatrix".
  • bus_activepower_injection::Matrix{Float64}:       "(b, t)" matrix containing the bus active power injection. b: number of       buses, t: number of time period.
  • bus_reactivepower_injection::Matrix{Float64}:       "(b, t)" matrix containing the bus reactive power injection. b: number       of buses, t: number of time period.
  • bus_activepower_withdrawals::Matrix{Float64}:       "(b, t)" matrix containing the bus reactive power withdrawals. b:       number of buses, t: number of time period.
  • bus_reactivepower_withdrawals::Matrix{Float64}:       "(b, t)" matrix containing the bus reactive power withdrawals. b:       number of buses, t: number of time period.
  • bus_reactivepower_bounds::Vector{Float64}: Upper and Lower bounds for the reactive supply       at each bus.
  • bus_type::Vector{PSY.ACBusTypes}:       vector containing type of buses present in the system, ordered       according to "bus_lookup".
  • bus_magnitude::Matrix{Float64}:       "(b, t)" matrix containing the bus magnitudes, ordered according to       "bus_lookup". b: number of buses, t: number of time period.
  • bus_angles::Matrix{Float64}:       "(b, t)" matrix containing the bus angles, ordered according to       "bus_lookup". b: number of buses, t: number of time period.
  • branch_flow_values::Matrix{Float64}:       "(br, t)" matrix containing the power flows, ordered according to       "branch_lookup". br: number of branches, t: number of time period.
  • timestep_map::Dict{Int, S}:       dictonary mapping the number of the time periods (corresponding to the       column number of the previosly mentioned matrices) and their names.
  • valid_ix::Vector{Int}:       vector containing the indeces of not slack buses
  • power_network_matrix::M:       matrix used for the evaluation of either the power flows or bus angles,       depending on the method considered.
  • aux_network_matrix::N:       matrix used for the evaluation of either the power flows or bus angles,       depending on the method considered.
  • neighbors::Vector{Set{Int}}: Vector with the sets of adjacent buses.
source
PowerFlows.PowerFlowData — Method
Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for AC power flow computations.
Arguments:
  • ::ACPowerFlow:       use ACPowerFlow() to evaluate the AC PF.
  • sys::PSY.System:       container storing the system data to consider in the PowerFlowData       structure.
  • time_steps::Int:       number of time periods to consider in the PowerFlowData structure. It       defines the number of columns of the matrices used to store data.       Default value = 1.
  • timestep_names::Vector{String}:       names of the time periods defines by the argmunet "time_steps". Default       value = String[].
  • check_connectivity::Bool:       Perform connectivity check on the network matrix. Default value = true.
WARNING: functions for the evaluation of the multi-period AC PF still to be implemented.
source
PowerFlows.PowerFlowData — Method
Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for DC power flow computations.
Arguments:
  • ::DCPowerFlow:       use DCPowerFlow() to store the ABA matrix as powernetworkmatrix and       the BA matrix as auxnetworkmatrix.
  • sys::PSY.System:       container storing the system data to consider in the PowerFlowData       structure.
  • time_steps::Int:       number of time periods to consider in the PowerFlowData structure. It       defines the number of columns of the matrices used to store data.       Default value = 1.
  • timestep_names::Vector{String}:       names of the time periods defines by the argmunet "time_steps". Default       value = String[].
  • check_connectivity::Bool:       Perform connectivity check on the network matrix. Default value = true.
source
PowerFlows.PowerFlowData — Method
Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for DC power flow computations.
Arguments:
  • ::PTDFDCPowerFlow:       use vPTDFDCPowerFlow() to store the Virtual PTDF matrix as       powernetworkmatrix and the ABA matrix as auxnetworkmatrix.
  • sys::PSY.System:       container storing the system data to consider in the PowerFlowData       structure.
  • time_steps::Int:       number of time periods to consider in the PowerFlowData structure. It       defines the number of columns of the matrices used to store data.       Default value = 1.
  • timestep_names::Vector{String}:       names of the time periods defines by the argmunet "time_steps". Default       value = String[].
source
PowerFlows.solve_ac_powerflow! — Method
Solves a the power flow into the system and writes the solution into the relevant structs. Updates generators active and reactive power setpoints and branches active and reactive power flows (calculated in the From - To direction) (see flow_val)
Supports passing NLsolve kwargs in the args. By default shows the solver trace.
Arguments available for nlsolve:
  • get_connectivity::Bool: Checks if the network is connected. Default true
  • method : See NLSolve.jl documentation for available solvers
  • xtol: norm difference in x between two successive iterates under which convergence is declared. Default: 0.0.
  • ftol: infinite norm of residuals under which convergence is declared. Default: 1e-8.
  • iterations: maximum number of iterations. Default: 1_000.
  • store_trace: should a trace of the optimization algorithm's state be stored? Default: false.
  • show_trace: should a trace of the optimization algorithm's state be shown on STDOUT? Default: false.
  • extended_trace: should additifonal algorithm internals be added to the state trace? Default: false.
Examples
solve_ac_powerflow!(sys)
 # Passing NLsolve arguments
-solve_ac_powerflow!(sys, method=:newton)
source
PowerFlows.solve_powerflow — Method
Similar to solve_powerflow!(sys) but does not update the system struct with results. Returns the results in a dictionary of dataframes.
Examples
res = solve_powerflow(sys)
+solve_ac_powerflow!(sys, method=:newton)
source
PowerFlows.solve_powerflow — Method
Similar to solve_powerflow!(sys) but does not update the system struct with results. Returns the results in a dictionary of dataframes.
Examples
res = solve_powerflow(sys)
 # Passing NLsolve arguments
-res = solve_powerflow(sys, method=:newton)
source
PowerFlows.solve_powerflow — Method
Evaluates the power flows on each system's branch by means of the ABA and BA matrices. Updates the PowerFlowData structure and returns a dictionary containing a DataFrame for the single timestep considered. The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.
Arguments:
  • ::DCPowerFlow:       use DCPowerFlow() to evaluate the power flows according to the method       based on the ABA and BA matrices
  • sys::PSY.System:       container gathering the system data used for the evaluation of flows       and angles.
source
PowerFlows.solve_powerflow — Method
Evaluates the power flows on each system's branch by means of the PTDF matrix. Updates the PowerFlowData structure and returns a dictionary containing a DataFrame for the single timestep considered. The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.
Arguments:
  • ::PTDFDCPowerFlow:       use PTDFDCPowerFlow() to evaluate the power flows according to the       method based on the PTDF matrix
  • sys::PSY.System:       container gathering the system data used for the evaluation of flows       and angles.
source
PowerFlows.solve_powerflow — Method
Evaluates the power flows on each system's branch by means of the ABA and BA matrices. Updates the PowerFlowData structure "data" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in "data". Each DataFrame containts the flows and angles.
Arguments:
  • data::ABAPowerFlowData:       PowerFlowData structure containing the system's data per each timestep       considered, as well as the ABA and BA matrices.
  • sys::PSY.System:       container gathering the system data.
source
PowerFlows.solve_powerflow — Method
Evaluates the power flows on each system's branch by means of the PTDF matrix. Updates the PowerFlowData structure "data" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in "data". Each DataFrame containts the flows and angles.
Arguments:
  • data::PTDFPowerFlowData:       PowerFlowData structure containing the system's data per each timestep       considered, as well as the PTDF matrix.
  • sys::PSY.System:       container gathering the system data.
source
PowerFlows.solve_powerflow — Method
Evaluates the power flows on each system's branch by means of Virtual PTDF matrices. Updates the PowerFlowData structure "data" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in "data". Each DataFrame containts the flows and angles.
Arguments:
  • data::PTDFPowerFlowData:       PowerFlowData structure containing the system data per each timestep       considered, as well as the Virtual PTDF matrix.
  • sys::PSY.System:       container gathering the system data.
source
PowerFlows.solve_powerflow — Method
Evaluates the power flows on each system's branch by means of the Virtual PTDF matrix. Updates the PowerFlowData structure "data" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in "data". The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.
Arguments:
  • ::vPTDFDCPowerFlow:       use vPTDFDCPowerFlow() to evaluate the power flows according to the       method based on the Virtual PTDF matrix
  • sys::PSY.System:       container gathering the system data used for the evaluation of flows       and angles.
source
PowerFlows.update_exporter! — Method
Update the PSSEExporter with new data.
Arguments:
  • exporter::PSSEExporter: the exporter to update
  • data::PSY.PowerFlowData: the new data. Must correspond to the System with which the exporter was constructor
source
PowerFlows.update_exporter! — Method
Update the PSSEExporter with new data.
Arguments:
  • exporter::PSSEExporter: the exporter to update
  • data::PSY.System: system containing the new data. Must be fundamentally the same
System as the one with which the exporter was constructed, just with different values
source
PowerFlows.write_results — Method
Returns a dictionary containing the AC power flow results.
Only single-period evaluation is supported at the moment for AC Power flows. Resulting dictionary will therefore feature just one key linked to one DataFrame.
Arguments:
  • ::ACPowerFlow:       use ACPowerFlow() storing AC power flow results.
  • sys::PSY.System:       container storing the systam information.
  • result::Vector{Float64}:       vector containing the reults for one single time-period.
source
PowerFlows.write_results — Method
Returns a dictionary containing the DC power flow results. Each key conresponds to the name of the considered time periods, storing a DataFrame with the PF results.
Arguments:
  • data::Union{PTDFPowerFlowData, vPTDFPowerFlowData, ABAPowerFlowData}:       PowerFlowData strcuture containing power flows and bus angles.
  • sys::PSY.System:       container storing the systam information.
source

+res = solve_powerflow(sys, method=:newton)
source
PowerFlows.solve_powerflow — Method

Evaluates the power flows on each system's branch by means of the ABA and BA matrices. Updates the PowerFlowData structure and returns a dictionary containing a DataFrame for the single timestep considered. The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.

Arguments:

  • ::DCPowerFlow: use DCPowerFlow() to evaluate the power flows according to the method based on the ABA and BA matrices
  • sys::PSY.System: container gathering the system data used for the evaluation of flows and angles.
source
PowerFlows.solve_powerflow — Method

Evaluates the power flows on each system's branch by means of the PTDF matrix. Updates the PowerFlowData structure and returns a dictionary containing a DataFrame for the single timestep considered. The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.

Arguments:

  • ::PTDFDCPowerFlow: use PTDFDCPowerFlow() to evaluate the power flows according to the method based on the PTDF matrix
  • sys::PSY.System: container gathering the system data used for the evaluation of flows and angles.
source
PowerFlows.solve_powerflow — Method

Evaluates the power flows on each system's branch by means of the ABA and BA matrices. Updates the PowerFlowData structure "data" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in "data". Each DataFrame containts the flows and angles.

Arguments:

  • data::ABAPowerFlowData: PowerFlowData structure containing the system's data per each timestep considered, as well as the ABA and BA matrices.
  • sys::PSY.System: container gathering the system data.
source
PowerFlows.solve_powerflow — Method

Evaluates the power flows on each system's branch by means of the PTDF matrix. Updates the PowerFlowData structure "data" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in "data". Each DataFrame containts the flows and angles.

Arguments:

  • data::PTDFPowerFlowData: PowerFlowData structure containing the system's data per each timestep considered, as well as the PTDF matrix.
  • sys::PSY.System: container gathering the system data.
source
PowerFlows.solve_powerflow — Method

Evaluates the power flows on each system's branch by means of Virtual PTDF matrices. Updates the PowerFlowData structure "data" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in "data". Each DataFrame containts the flows and angles.

Arguments:

  • data::PTDFPowerFlowData: PowerFlowData structure containing the system data per each timestep considered, as well as the Virtual PTDF matrix.
  • sys::PSY.System: container gathering the system data.
source
PowerFlows.solve_powerflow — Method

Evaluates the power flows on each system's branch by means of the Virtual PTDF matrix. Updates the PowerFlowData structure "data" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in "data". The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.

Arguments:

  • ::vPTDFDCPowerFlow: use vPTDFDCPowerFlow() to evaluate the power flows according to the method based on the Virtual PTDF matrix
  • sys::PSY.System: container gathering the system data used for the evaluation of flows and angles.
source
PowerFlows.update_exporter! — Method

Update the PSSEExporter with new data.

Arguments:

  • exporter::PSSEExporter: the exporter to update
  • data::PSY.PowerFlowData: the new data. Must correspond to the System with which the exporter was constructor
source
PowerFlows.update_exporter! — Method

Update the PSSEExporter with new data.

Arguments:

  • exporter::PSSEExporter: the exporter to update
  • data::PSY.System: system containing the new data. Must be fundamentally the same

System as the one with which the exporter was constructed, just with different values

source
PowerFlows.write_results — Method

Returns a dictionary containing the AC power flow results.

Only single-period evaluation is supported at the moment for AC Power flows. Resulting dictionary will therefore feature just one key linked to one DataFrame.

Arguments:

  • ::ACPowerFlow: use ACPowerFlow() storing AC power flow results.
  • sys::PSY.System: container storing the systam information.
  • result::Vector{Float64}: vector containing the reults for one single time-period.
source
PowerFlows.write_results — Method

Returns a dictionary containing the DC power flow results. Each key conresponds to the name of the considered time periods, storing a DataFrame with the PF results.

Arguments:

  • data::Union{PTDFPowerFlowData, vPTDFPowerFlowData, ABAPowerFlowData}: PowerFlowData strcuture containing power flows and bus angles.
  • sys::PSY.System: container storing the systam information.
source
diff --git a/previews/PR54/code_base_developer_guide/developer/index.html b/previews/PR54/code_base_developer_guide/developer/index.html index ac0f9e0..78f3e01 100644 --- a/previews/PR54/code_base_developer_guide/developer/index.html +++ b/previews/PR54/code_base_developer_guide/developer/index.html @@ -1,2 +1,2 @@ -Developer Guide · PowerFlows.jl
Edit on GitHub
+Developer Guide · PowerFlows.jl
Edit on GitHub
diff --git a/previews/PR54/index.html b/previews/PR54/index.html index a373fa0..f950b1c 100644 --- a/previews/PR54/index.html +++ b/previews/PR54/index.html @@ -1,2 +1,2 @@ -Welcome Page · PowerFlows.jl
Edit on GitHub

PowerFlows.jl

Overview

PowerFlows.jl is a Julia package for solving Power Flows

Installation

The latest stable release of PowerFlows can be installed using the Julia package manager with

] add PowerFlows

For the current development version, "checkout" this package with

] add PowerFlows#main

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

+Welcome Page · PowerFlows.jl
Edit on GitHub

PowerFlows.jl

Overview

PowerFlows.jl is a Julia package for solving Power Flows

Installation

The latest stable release of PowerFlows can be installed using the Julia package manager with

] add PowerFlows

For the current development version, "checkout" this package with

] add PowerFlows#main

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

diff --git a/previews/PR54/modeler_guide/power_flow/index.html b/previews/PR54/modeler_guide/power_flow/index.html index e08b1ea..a84ab05 100644 --- a/previews/PR54/modeler_guide/power_flow/index.html +++ b/previews/PR54/modeler_guide/power_flow/index.html @@ -144,4 +144,4 @@ Bus 10 - Magnitude 1.051 - Angle (rad) -0.26354471705114374 Bus 3 - Magnitude 1.01 - Angle (rad) -0.22200588085367873 Bus 1 - Magnitude 1.06 - Angle (rad) 0.0 -Bus 5 - Magnitude 1.02 - Angle (rad) -0.15323990832510212 +Bus 5 - Magnitude 1.02 - Angle (rad) -0.15323990832510212 diff --git a/previews/PR54/search/index.html b/previews/PR54/search/index.html index c55854a..17e04b3 100644 --- a/previews/PR54/search/index.html +++ b/previews/PR54/search/index.html @@ -1,2 +1,2 @@ -Search · PowerFlows.jl

Loading search...

    +Search · PowerFlows.jl

    Loading search...

      diff --git a/previews/PR54/search_index.js b/previews/PR54/search_index.js index 6919cf1..e91879a 100644 --- a/previews/PR54/search_index.js +++ b/previews/PR54/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"code_base_developer_guide/developer/#Guidelines-for-Developers","page":"Developer Guide","title":"Guidelines for Developers","text":"","category":"section"},{"location":"code_base_developer_guide/developer/","page":"Developer Guide","title":"Developer Guide","text":"In order to contribute to PowerSimulationsDynamics.jl repository please read the following sections of InfrastructureSystems.jl documentation in detail:","category":"page"},{"location":"code_base_developer_guide/developer/","page":"Developer Guide","title":"Developer Guide","text":"Style Guide\nContributing Guidelines","category":"page"},{"location":"code_base_developer_guide/developer/","page":"Developer Guide","title":"Developer Guide","text":"Pull requests are always welcome to fix bugs or add additional modeling capabilities.","category":"page"},{"location":"code_base_developer_guide/developer/","page":"Developer Guide","title":"Developer Guide","text":"All the code contributions need to include tests with a minimum coverage of 70%","category":"page"},{"location":"api/internal/#Internal","page":"Internal API Reference","title":"Internal","text":"","category":"section"},{"location":"api/internal/","page":"Internal API Reference","title":"Internal API Reference","text":"CurrentModule = PowerFlows\nDocTestSetup = quote\n using PowerFlows\nend","category":"page"},{"location":"api/internal/","page":"Internal API Reference","title":"Internal API Reference","text":"Modules = [PowerFlows]\nPublic = false\nPrivate = true","category":"page"},{"location":"api/internal/#PowerFlows.SystemPowerFlowContainer","page":"Internal API Reference","title":"PowerFlows.SystemPowerFlowContainer","text":"A PowerFlowContainer that represents its data as a PSY.System\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerFlows._first_choice_gen_id-Tuple{String}","page":"Internal API Reference","title":"PowerFlows._first_choice_gen_id","text":"Try to make an informative one or two character name for the load/generator/etc.\n\n\"generator-1234-AB\" -> \"AB\"\n\"123CT7\" -> \"7\"\n\"load1234\" -> \"34\"\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._get_load_data-Tuple{System, Bus}","page":"Internal API Reference","title":"PowerFlows._get_load_data","text":"Obtain total load on bus b\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._map_psse_container_names-Tuple{Vector{String}}","page":"Internal API Reference","title":"PowerFlows._map_psse_container_names","text":"Validate that the Sienna area/zone names parse as PSS/E-compatible area/zone numbers, output a mapping\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._psse_bus_names-Tuple{Vector{String}, Vector{Int64}, AbstractDict{Int64, Int64}}","page":"Internal API Reference","title":"PowerFlows._psse_bus_names","text":"Given a vector of Sienna bus names, create a dictionary from Sienna bus name to PSS/E-compatible bus name. Guarantees determinism and minimal changes.\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._psse_bus_numbers-Tuple{Vector{Int64}}","page":"Internal API Reference","title":"PowerFlows._psse_bus_numbers","text":"Given a vector of Sienna bus numbers, create a dictionary from Sienna bus number to PSS/E-compatible bus number. Assumes that the Sienna bus numbers are positive and unique. Guarantees determinism: if the input contains the same bus numbers in the same order, the output will. Guarantees minimal changes: that if an existing bus number is compliant, it will not be changed.\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._psse_transformer_names-Tuple{Vector{String}, Vector{Tuple{Int64, Int64}}, AbstractDict{Int64, Int64}, Any}","page":"Internal API Reference","title":"PowerFlows._psse_transformer_names","text":"Given a vector of Sienna transformer names, create a dictionary from Sienna transformer name to PSS/E-compatible transformer name. Guarantees determinism and minimal changes.\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Transformer Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._update_branch_flow!-Tuple{System}","page":"Internal API Reference","title":"PowerFlows._update_branch_flow!","text":"Updates the flow on the branches\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.better_float_to_buf-Tuple{Union{Base.GenericIOBuffer{<:Array{UInt8}}, Base.GenericIOBuffer{<:GenericMemory{:not_atomic, UInt8}}}, Float64}","page":"Internal API Reference","title":"PowerFlows.better_float_to_buf","text":"Temporary, very specialized proof of concept patch for https://github.com/JuliaLang/julia/issues/55835\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.check_33-Tuple{PSSEExporter}","page":"Internal API Reference","title":"PowerFlows.check_33","text":"Throw a NotImplementedError if the psse_version is not :v33\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.create_component_ids-Union{Tuple{T}, Tuple{Vector{<:String}, Vector{T}}} where T","page":"Internal API Reference","title":"PowerFlows.create_component_ids","text":"Given a vector of component names and a corresponding vector of container IDs (e.g., bus numbers), create unique-per-container PSS/E-compatible IDs, output a dictionary from (container ID, component name) to PSS/E-compatible component ID. The \"singlesto1\" flag detects components that are the only one on their bus and gives them the name \"1\".\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.deepcopy_system_no_time_series_no_supplementals-Tuple{System}","page":"Internal API Reference","title":"PowerFlows.deepcopy_system_no_time_series_no_supplementals","text":"Make a deepcopy of the System except replace the time series manager and supplemental attribute manager with blank versions so these are not copied.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.deserialize_reverse_component_ids-Union{Tuple{T}, Tuple{Any, Any, T}} where T<:Type{Int64}","page":"Internal API Reference","title":"PowerFlows.deserialize_reverse_component_ids","text":"Convert a sbusnsname => pname dictionary to a (pbusn, pname) => s_name dictionary\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.fix_load_zone_names!-Tuple{System, Dict}","page":"Internal API Reference","title":"PowerFlows.fix_load_zone_names!","text":"Rename all the LoadZones in the system according to the Load_Zone_Name_Mapping in the metadata\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.fix_nans!-Tuple{System}","page":"Internal API Reference","title":"PowerFlows.fix_nans!","text":"Iterate over all the Generators in the system and, if any active_power or reactive_power fields are NaN, make them 0.0\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_func-Tuple{ACBranch, ComplexF64, ComplexF64}","page":"Internal API Reference","title":"PowerFlows.flow_func","text":"Calculates the From - To complex power flow using external data of voltages of branch of type Line\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_func-Tuple{TapTransformer, ComplexF64, ComplexF64}","page":"Internal API Reference","title":"PowerFlows.flow_func","text":"Calculates the From - To complex power flow using external data of voltages of branch of type TapTransformer\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_func-Tuple{Transformer2W, ComplexF64, ComplexF64}","page":"Internal API Reference","title":"PowerFlows.flow_func","text":"Calculates the From - To complex power flow using external data of voltages of branch of type Transformer2W\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_val-Tuple{ACBranch}","page":"Internal API Reference","title":"PowerFlows.flow_val","text":"Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_val-Tuple{DynamicBranch}","page":"Internal API Reference","title":"PowerFlows.flow_val","text":"Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_val-Tuple{TapTransformer}","page":"Internal API Reference","title":"PowerFlows.flow_val","text":"Calculates the From - To complex power flow (Flow injected at the bus) of branch of type TapTransformer\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_val-Tuple{Transformer2W}","page":"Internal API Reference","title":"PowerFlows.flow_val","text":"Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Transformer2W\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.make_power_flow_container","page":"Internal API Reference","title":"PowerFlows.make_power_flow_container","text":"Create an appropriate PowerFlowContainer for the given PowerFlowEvaluationModel and initialize it from the given PSY.System.\n\nArguments:\n\npfem::PowerFlowEvaluationModel: power flow model to construct a container for (e.g., DCPowerFlow())\nsys::PSY.System: the system from which to initialize the power flow container\ntime_steps::Int: number of time periods to consider (default is 1)\ntimestep_names::Vector{String}: names of the time periods defines by the argument \"time_steps\". Default value is String[].\ncheck_connectivity::Bool: Perform connectivity check on the network matrix. Default value is true.\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerFlows.name_formatter_from_component_ids-Tuple{Any, Any, Any}","page":"Internal API Reference","title":"PowerFlows.name_formatter_from_component_ids","text":"Use PSS/E exporter metadata to build a function that maps component names back to their original Sienna values.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.reset_caches-Tuple{PSSEExporter}","page":"Internal API Reference","title":"PowerFlows.reset_caches","text":"Force all cached information (serialized metadata, component lists, etc.) to be regenerated\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.serialize_component_ids-Tuple{Dict{Tuple{Int64, String}, String}}","page":"Internal API Reference","title":"PowerFlows.serialize_component_ids","text":"Take the output of create_component_ids and make it more suitable for JSON serialization\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.solve_powerflow!-Tuple{PowerFlowData{PowerNetworkMatrices.PTDF{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}, Matrix{Float64}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}}","page":"Internal API Reference","title":"PowerFlows.solve_powerflow!","text":"Evaluates the power flows on each system's branch and updates the PowerFlowData structure.\n\nArguments:\n\ndata::PTDFPowerFlowData: PTDFPowerFlowData structure containing all the information related to the system's power flow.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.solve_powerflow!-Tuple{PowerFlowData{PowerNetworkMatrices.VirtualPTDF{Tuple{Vector{String}, Vector{Int64}}, Tuple{Dict{String, Int64}, Dict{Int64, Int64}}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}}","page":"Internal API Reference","title":"PowerFlows.solve_powerflow!","text":"Evaluates the power flows on each system's branch and updates the PowerFlowData structure.\n\nArguments:\n\ndata::vPTDFPowerFlowData: vPTDFPowerFlowData structure containing all the information related to the system's power flow.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.supports_multi_period-Tuple{PowerFlows.PowerFlowContainer}","page":"Internal API Reference","title":"PowerFlows.supports_multi_period","text":"Trait signifying whether the PowerFlowContainer can represent multi-period data. Must be implemented for all concrete subtypes.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.update_system!-Tuple{System, PowerFlowData}","page":"Internal API Reference","title":"PowerFlows.update_system!","text":"Modify the values in the given System to correspond to the given PowerFlowData such that if a new PowerFlowData is constructed from the resulting system it is the same as data. See also write_powerflow_solution!. NOTE that this assumes that data was initialized from sys and then solved with no further modifications.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.with_units-Tuple{Function, System, Union{UnitSystem, String}}","page":"Internal API Reference","title":"PowerFlows.with_units","text":"A context manager similar to Logging.with_logger that sets the system's units to the given value, executes the function, then sets them back. Suppresses logging below Warn from internal calls to set_units_base_system!. Not thread safe.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_powerflow_solution!-Tuple{System, Vector{Float64}, Int64}","page":"Internal API Reference","title":"PowerFlows.write_powerflow_solution!","text":"Updates system voltages and powers with power flow results\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Bus Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data. Sienna voltage limits treated as PSS/E normal voltage limits; PSSE emergency voltage limits left as default.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Case Identification Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Case Identification Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Fixed Shunt Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Fixed Bus Shunt Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Generator Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"If the exportsettings flag `sourcesas_generatorsis set, exportPSY.Sourceinstances as PSS/E generators in addition toPSY.Generator`s\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Generator Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Load Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Load Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Non-Transformer Branch Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Non-Transformer Branch Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Q Record\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Q Record\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Transformer Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"Currently only supports two-winding transformers\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Transformer Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Zone Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"Assumes that the Sienna zone names are already PSS/E compatible\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Zone Data\n\n\n\n\n\n","category":"method"},{"location":"modeler_guide/power_flow/#Power-Flow","page":"Power Flow","title":"Power Flow","text":"","category":"section"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"CurrentModule = PowerFlows","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"PowerFlows.jl provides the capability to run a power flow using NLSolve, in the current stage of development it can't force reactive power constraints. This power flow routine does not check for reactive power limits or other limiting mechanisms in the grid, and can therefore be used to check for solver convergence - making no guarantees of the solution feasibility.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"The power flow solver uses NLsolve.jl under the hood and takes any keyword argument accepted by NLsolve. The solver uses the current operating point in the buses to provide the initial guess.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Limitations: The PowerFlow solver doesn't support systems with HVDC lines or Phase Shifting transformers yet. The power flow solver can't handle systems with islands.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"using PowerFlows\nusing PowerSystems\nusing PowerSystemCaseBuilder\n\nsystem_data = build_system(PSITestSystems, \"c_sys14\")","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"PowerFlows.jl has two modes of using the power flow solver.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Solving the power flow for the current operating point in the system. Takes the data in the buses, the active_power and reactive_power fields in the static injection devices. Returns a dictionary with results in a DataFrame that can be exported or manipulated as needed.\nSolves the power flow and updated the devices in the system to the operating condition. This model will update the values of magnitudes and angles in the system's buses. It also updates the active and reactive power flows in the branches and devices connected to PV buses. It also updates the active and reactive power of the injection devices connected to the Slack bus, and updates only the reactive power of the injection devices connected to PV buses. If multiple devices are connected to the same bus, the power is divided proportional to the base power. This utility is useful to initialize systems before serializing or checking the addition of new devices is still AC feasible.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Solving the power flow with mode 1:","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"results = run_powerflow(system_data)\nresults[\"bus_results\"]","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Solving the power flow with mode 2:","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Before running the power flow command these are the values of the voltages:","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"for b in get_components(Bus, system_data)\n println(\"$(get_name(b)) - Magnitude $(get_magnitude(b)) - Angle (rad) $(get_angle(b))\")\nend","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"run_powerflow! return true or false to signal the successful result of the power flow. This enables the integration of a power flow into functions and use the return as check. For instance, initializing dynamic simulations. Also, because run_powerflow! uses NLsolve.jl all the parameters used for NLsolve are also available for run_powerflow!","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"run_powerflow!(system_data; method = :newton)","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"After running the power flow command this are the values of the voltages:","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"for b in get_components(Bus, system_data)\n println(\"$(get_name(b)) - Magnitude $(get_magnitude(b)) - Angle (rad) $(get_angle(b))\")\nend","category":"page"},{"location":"#PowerFlows.jl","page":"Welcome Page","title":"PowerFlows.jl","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"CurrentModule = PowerFlows","category":"page"},{"location":"#Overview","page":"Welcome Page","title":"Overview","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerFlows.jl is a Julia package for solving Power Flows","category":"page"},{"location":"#Installation","page":"Welcome Page","title":"Installation","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"The latest stable release of PowerFlows can be installed using the Julia package manager with","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"] add PowerFlows","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"For the current development version, \"checkout\" this package with","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"] add PowerFlows#main","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerFlows has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory (NREL)","category":"page"},{"location":"api/public/#PowerFlows","page":"Public API Reference","title":"PowerFlows","text":"","category":"section"},{"location":"api/public/","page":"Public API Reference","title":"Public API Reference","text":"CurrentModule = PowerFlows\nDocTestSetup = quote\n using PowerFlows\nend","category":"page"},{"location":"api/public/","page":"Public API Reference","title":"Public API Reference","text":"Modules = [PowerFlows]\nPublic = true\nPrivate = false","category":"page"},{"location":"api/public/#PowerFlows.PSSEExporter","page":"Public API Reference","title":"PowerFlows.PSSEExporter","text":"Structure to perform an export from a Sienna System, plus optional updates from PowerFlowData, to the PSS/E format. Construct from a System and a PSS/E version, update using update_exporter with any new data as relevant, and perform the export with write_export.\n\nArguments:\n\nbase_system::PSY.System: the system to be exported. Later updates may change power flow-related values but may not fundamentally alter the system\npsse_version::Symbol: the version of PSS/E to target, must be one of PSSE_EXPORT_SUPPORTED_VERSIONS\nwrite_comments::Bool = false: whether to add the customary-but-not-in-spec-annotations after a slash on the first line and at group boundaries\nname::AbstractString = \"export\": the base name of the export\nstep::Union{Nothing, Integer, Tuple{Vararg{Integer}}} = nothing: optional step number or tuple of step numbers (e.g., step and timestamp within step) to append to the base export name. User is responsible for updating the step.\noverwrite::Bool = false: true to silently overwrite existing exports, false to throw an error if existing results are encountered\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerFlows.PowerFlowData","page":"Public API Reference","title":"PowerFlows.PowerFlowData","text":"Structure containing all the data required for the evaluation of the power flows and angles, as well as these ones.\n\nArguments:\n\nbus_lookup::Dict{Int, Int}: dictionary linking the system's bus number with the rows of either \"powernetworkmatrix\" or \"auxnetworkmatrix\".\nbranch_lookup::Dict{String, Int}: dictionary linking the branch name with the column name of either the \"powernetworkmatrix\" or \"auxnetworkmatrix\".\nbus_activepower_injection::Matrix{Float64}: \"(b, t)\" matrix containing the bus active power injection. b: number of buses, t: number of time period.\nbus_reactivepower_injection::Matrix{Float64}: \"(b, t)\" matrix containing the bus reactive power injection. b: number of buses, t: number of time period.\nbus_activepower_withdrawals::Matrix{Float64}: \"(b, t)\" matrix containing the bus reactive power withdrawals. b: number of buses, t: number of time period.\nbus_reactivepower_withdrawals::Matrix{Float64}: \"(b, t)\" matrix containing the bus reactive power withdrawals. b: number of buses, t: number of time period.\nbus_reactivepower_bounds::Vector{Float64}: Upper and Lower bounds for the reactive supply at each bus.\nbus_type::Vector{PSY.ACBusTypes}: vector containing type of buses present in the system, ordered according to \"bus_lookup\".\nbus_magnitude::Matrix{Float64}: \"(b, t)\" matrix containing the bus magnitudes, ordered according to \"bus_lookup\". b: number of buses, t: number of time period.\nbus_angles::Matrix{Float64}: \"(b, t)\" matrix containing the bus angles, ordered according to \"bus_lookup\". b: number of buses, t: number of time period.\nbranch_flow_values::Matrix{Float64}: \"(br, t)\" matrix containing the power flows, ordered according to \"branch_lookup\". br: number of branches, t: number of time period.\ntimestep_map::Dict{Int, S}: dictonary mapping the number of the time periods (corresponding to the column number of the previosly mentioned matrices) and their names.\nvalid_ix::Vector{Int}: vector containing the indeces of not slack buses\npower_network_matrix::M: matrix used for the evaluation of either the power flows or bus angles, depending on the method considered.\naux_network_matrix::N: matrix used for the evaluation of either the power flows or bus angles, depending on the method considered.\nneighbors::Vector{Set{Int}}: Vector with the sets of adjacent buses.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerFlows.PowerFlowData-Tuple{ACPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.PowerFlowData","text":"Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for AC power flow computations.\n\nArguments:\n\n::ACPowerFlow: use ACPowerFlow() to evaluate the AC PF.\nsys::PSY.System: container storing the system data to consider in the PowerFlowData structure.\ntime_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.\ntimestep_names::Vector{String}: names of the time periods defines by the argmunet \"time_steps\". Default value = String[].\ncheck_connectivity::Bool: Perform connectivity check on the network matrix. Default value = true.\n\nWARNING: functions for the evaluation of the multi-period AC PF still to be implemented.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.PowerFlowData-Tuple{DCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.PowerFlowData","text":"Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for DC power flow computations.\n\nArguments:\n\n::DCPowerFlow: use DCPowerFlow() to store the ABA matrix as powernetworkmatrix and the BA matrix as auxnetworkmatrix.\nsys::PSY.System: container storing the system data to consider in the PowerFlowData structure.\ntime_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.\ntimestep_names::Vector{String}: names of the time periods defines by the argmunet \"time_steps\". Default value = String[].\ncheck_connectivity::Bool: Perform connectivity check on the network matrix. Default value = true.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.PowerFlowData-Tuple{vPTDFDCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.PowerFlowData","text":"Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for DC power flow computations.\n\nArguments:\n\n::PTDFDCPowerFlow: use vPTDFDCPowerFlow() to store the Virtual PTDF matrix as powernetworkmatrix and the ABA matrix as auxnetworkmatrix.\nsys::PSY.System: container storing the system data to consider in the PowerFlowData structure.\ntime_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.\ntimestep_names::Vector{String}: names of the time periods defines by the argmunet \"time_steps\". Default value = String[].\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.get_psse_export_paths-Tuple{AbstractString}","page":"Public API Reference","title":"PowerFlows.get_psse_export_paths","text":"Calculate the paths of the (raw, metadata) files that would be written by a certain call to write_export\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_ac_powerflow!-Tuple{ACPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_ac_powerflow!","text":"Solves a the power flow into the system and writes the solution into the relevant structs. Updates generators active and reactive power setpoints and branches active and reactive power flows (calculated in the From - To direction) (see flow_val)\n\nSupports passing NLsolve kwargs in the args. By default shows the solver trace.\n\nArguments available for nlsolve:\n\nget_connectivity::Bool: Checks if the network is connected. Default true\nmethod : See NLSolve.jl documentation for available solvers\nxtol: norm difference in x between two successive iterates under which convergence is declared. Default: 0.0.\nftol: infinite norm of residuals under which convergence is declared. Default: 1e-8.\niterations: maximum number of iterations. Default: 1_000.\nstore_trace: should a trace of the optimization algorithm's state be stored? Default: false.\nshow_trace: should a trace of the optimization algorithm's state be shown on STDOUT? Default: false.\nextended_trace: should additifonal algorithm internals be added to the state trace? Default: false.\n\nExamples\n\nsolve_ac_powerflow!(sys)\n# Passing NLsolve arguments\nsolve_ac_powerflow!(sys, method=:newton)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{ACPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Similar to solve_powerflow!(sys) but does not update the system struct with results. Returns the results in a dictionary of dataframes.\n\nExamples\n\nres = solve_powerflow(sys)\n# Passing NLsolve arguments\nres = solve_powerflow(sys, method=:newton)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{DCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the ABA and BA matrices. Updates the PowerFlowData structure and returns a dictionary containing a DataFrame for the single timestep considered. The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.\n\nArguments:\n\n::DCPowerFlow: use DCPowerFlow() to evaluate the power flows according to the method based on the ABA and BA matrices\nsys::PSY.System: container gathering the system data used for the evaluation of flows and angles.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{PTDFDCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the PTDF matrix. Updates the PowerFlowData structure and returns a dictionary containing a DataFrame for the single timestep considered. The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.\n\nArguments:\n\n::PTDFDCPowerFlow: use PTDFDCPowerFlow() to evaluate the power flows according to the method based on the PTDF matrix\nsys::PSY.System: container gathering the system data used for the evaluation of flows and angles.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{PowerFlowData{PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}, PowerNetworkMatrices.BA_Matrix{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}}}, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the ABA and BA matrices. Updates the PowerFlowData structure \"data\" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in \"data\". Each DataFrame containts the flows and angles.\n\nArguments:\n\ndata::ABAPowerFlowData: PowerFlowData structure containing the system's data per each timestep considered, as well as the ABA and BA matrices.\nsys::PSY.System: container gathering the system data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{PowerFlowData{PowerNetworkMatrices.PTDF{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}, Matrix{Float64}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the PTDF matrix. Updates the PowerFlowData structure \"data\" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in \"data\". Each DataFrame containts the flows and angles.\n\nArguments:\n\ndata::PTDFPowerFlowData: PowerFlowData structure containing the system's data per each timestep considered, as well as the PTDF matrix.\nsys::PSY.System: container gathering the system data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{PowerFlowData{PowerNetworkMatrices.VirtualPTDF{Tuple{Vector{String}, Vector{Int64}}, Tuple{Dict{String, Int64}, Dict{Int64, Int64}}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of Virtual PTDF matrices. Updates the PowerFlowData structure \"data\" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in \"data\". Each DataFrame containts the flows and angles.\n\nArguments:\n\ndata::PTDFPowerFlowData: PowerFlowData structure containing the system data per each timestep considered, as well as the Virtual PTDF matrix.\nsys::PSY.System: container gathering the system data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{vPTDFDCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the Virtual PTDF matrix. Updates the PowerFlowData structure \"data\" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in \"data\". The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.\n\nArguments:\n\n::vPTDFDCPowerFlow: use vPTDFDCPowerFlow() to evaluate the power flows according to the method based on the Virtual PTDF matrix\nsys::PSY.System: container gathering the system data used for the evaluation of flows and angles.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.update_exporter!-Tuple{PSSEExporter, PowerFlowData}","page":"Public API Reference","title":"PowerFlows.update_exporter!","text":"Update the PSSEExporter with new data.\n\nArguments:\n\nexporter::PSSEExporter: the exporter to update\ndata::PSY.PowerFlowData: the new data. Must correspond to the System with which the exporter was constructor\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.update_exporter!-Tuple{PSSEExporter, System}","page":"Public API Reference","title":"PowerFlows.update_exporter!","text":"Update the PSSEExporter with new data.\n\nArguments:\n\nexporter::PSSEExporter: the exporter to update\ndata::PSY.System: system containing the new data. Must be fundamentally the same\n\nSystem as the one with which the exporter was constructed, just with different values\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.write_export-Tuple{PSSEExporter, AbstractString}","page":"Public API Reference","title":"PowerFlows.write_export","text":"Peform an export from the data contained in a PSSEExporter to the PSS/E file format.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.write_results-Tuple{ACPowerFlow, System, PowerFlowData{PowerNetworkMatrices.Ybus{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}}, Nothing}, Vector{Float64}}","page":"Public API Reference","title":"PowerFlows.write_results","text":"Returns a dictionary containing the AC power flow results.\n\nOnly single-period evaluation is supported at the moment for AC Power flows. Resulting dictionary will therefore feature just one key linked to one DataFrame.\n\nArguments:\n\n::ACPowerFlow: use ACPowerFlow() storing AC power flow results.\nsys::PSY.System: container storing the systam information.\nresult::Vector{Float64}: vector containing the reults for one single time-period.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.write_results-Tuple{Union{PowerFlowData{PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}, PowerNetworkMatrices.BA_Matrix{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}}}, PowerFlowData{PowerNetworkMatrices.PTDF{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}, Matrix{Float64}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}, PowerFlowData{PowerNetworkMatrices.VirtualPTDF{Tuple{Vector{String}, Vector{Int64}}, Tuple{Dict{String, Int64}, Dict{Int64, Int64}}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}}, System}","page":"Public API Reference","title":"PowerFlows.write_results","text":"Returns a dictionary containing the DC power flow results. Each key conresponds to the name of the considered time periods, storing a DataFrame with the PF results.\n\nArguments:\n\ndata::Union{PTDFPowerFlowData, vPTDFPowerFlowData, ABAPowerFlowData}: PowerFlowData strcuture containing power flows and bus angles.\nsys::PSY.System: container storing the systam information.\n\n\n\n\n\n","category":"method"}] +[{"location":"code_base_developer_guide/developer/#Guidelines-for-Developers","page":"Developer Guide","title":"Guidelines for Developers","text":"","category":"section"},{"location":"code_base_developer_guide/developer/","page":"Developer Guide","title":"Developer Guide","text":"In order to contribute to PowerSimulationsDynamics.jl repository please read the following sections of InfrastructureSystems.jl documentation in detail:","category":"page"},{"location":"code_base_developer_guide/developer/","page":"Developer Guide","title":"Developer Guide","text":"Style Guide\nContributing Guidelines","category":"page"},{"location":"code_base_developer_guide/developer/","page":"Developer Guide","title":"Developer Guide","text":"Pull requests are always welcome to fix bugs or add additional modeling capabilities.","category":"page"},{"location":"code_base_developer_guide/developer/","page":"Developer Guide","title":"Developer Guide","text":"All the code contributions need to include tests with a minimum coverage of 70%","category":"page"},{"location":"api/internal/#Internal","page":"Internal API Reference","title":"Internal","text":"","category":"section"},{"location":"api/internal/","page":"Internal API Reference","title":"Internal API Reference","text":"CurrentModule = PowerFlows\nDocTestSetup = quote\n using PowerFlows\nend","category":"page"},{"location":"api/internal/","page":"Internal API Reference","title":"Internal API Reference","text":"Modules = [PowerFlows]\nPublic = false\nPrivate = true","category":"page"},{"location":"api/internal/#PowerFlows.SystemPowerFlowContainer","page":"Internal API Reference","title":"PowerFlows.SystemPowerFlowContainer","text":"A PowerFlowContainer that represents its data as a PSY.System\n\n\n\n\n\n","category":"type"},{"location":"api/internal/#PowerFlows._first_choice_gen_id-Tuple{String}","page":"Internal API Reference","title":"PowerFlows._first_choice_gen_id","text":"Try to make an informative one or two character name for the load/generator/etc.\n\n\"generator-1234-AB\" -> \"AB\"\n\"123CT7\" -> \"7\"\n\"load1234\" -> \"34\"\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._get_load_data-Tuple{System, Bus}","page":"Internal API Reference","title":"PowerFlows._get_load_data","text":"Obtain total load on bus b\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._map_psse_container_names-Tuple{Vector{String}}","page":"Internal API Reference","title":"PowerFlows._map_psse_container_names","text":"Validate that the Sienna area/zone names parse as PSS/E-compatible area/zone numbers, output a mapping\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._psse_bus_names-Tuple{Vector{String}, Vector{Int64}, AbstractDict{Int64, Int64}}","page":"Internal API Reference","title":"PowerFlows._psse_bus_names","text":"Given a vector of Sienna bus names, create a dictionary from Sienna bus name to PSS/E-compatible bus name. Guarantees determinism and minimal changes.\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._psse_bus_numbers-Tuple{Vector{Int64}}","page":"Internal API Reference","title":"PowerFlows._psse_bus_numbers","text":"Given a vector of Sienna bus numbers, create a dictionary from Sienna bus number to PSS/E-compatible bus number. Assumes that the Sienna bus numbers are positive and unique. Guarantees determinism: if the input contains the same bus numbers in the same order, the output will. Guarantees minimal changes: that if an existing bus number is compliant, it will not be changed.\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._psse_transformer_names-Tuple{Vector{String}, Vector{Tuple{Int64, Int64}}, AbstractDict{Int64, Int64}, Any}","page":"Internal API Reference","title":"PowerFlows._psse_transformer_names","text":"Given a vector of Sienna transformer names, create a dictionary from Sienna transformer name to PSS/E-compatible transformer name. Guarantees determinism and minimal changes.\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Transformer Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows._update_branch_flow!-Tuple{System}","page":"Internal API Reference","title":"PowerFlows._update_branch_flow!","text":"Updates the flow on the branches\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.better_float_to_buf-Tuple{Union{Base.GenericIOBuffer{<:Array{UInt8}}, Base.GenericIOBuffer{<:GenericMemory{:not_atomic, UInt8}}}, Float64}","page":"Internal API Reference","title":"PowerFlows.better_float_to_buf","text":"Temporary, very specialized proof of concept patch for https://github.com/JuliaLang/julia/issues/55835\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.check_33-Tuple{PSSEExporter}","page":"Internal API Reference","title":"PowerFlows.check_33","text":"Throw a NotImplementedError if the psse_version is not :v33\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.create_component_ids-Union{Tuple{T}, Tuple{Vector{<:String}, Vector{T}}} where T","page":"Internal API Reference","title":"PowerFlows.create_component_ids","text":"Given a vector of component names and a corresponding vector of container IDs (e.g., bus numbers), create unique-per-container PSS/E-compatible IDs, output a dictionary from (container ID, component name) to PSS/E-compatible component ID. The \"singlesto1\" flag detects components that are the only one on their bus and gives them the name \"1\".\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.deserialize_reverse_component_ids-Union{Tuple{T}, Tuple{Any, Any, T}} where T<:Type{Int64}","page":"Internal API Reference","title":"PowerFlows.deserialize_reverse_component_ids","text":"Convert a sbusnsname => pname dictionary to a (pbusn, pname) => s_name dictionary\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.fix_load_zone_names!-Tuple{System, Dict}","page":"Internal API Reference","title":"PowerFlows.fix_load_zone_names!","text":"Rename all the LoadZones in the system according to the Load_Zone_Name_Mapping in the metadata\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.fix_nans!-Tuple{System}","page":"Internal API Reference","title":"PowerFlows.fix_nans!","text":"Iterate over all the Generators in the system and, if any active_power or reactive_power fields are NaN, make them 0.0\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_func-Tuple{ACBranch, ComplexF64, ComplexF64}","page":"Internal API Reference","title":"PowerFlows.flow_func","text":"Calculates the From - To complex power flow using external data of voltages of branch of type Line\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_func-Tuple{TapTransformer, ComplexF64, ComplexF64}","page":"Internal API Reference","title":"PowerFlows.flow_func","text":"Calculates the From - To complex power flow using external data of voltages of branch of type TapTransformer\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_func-Tuple{Transformer2W, ComplexF64, ComplexF64}","page":"Internal API Reference","title":"PowerFlows.flow_func","text":"Calculates the From - To complex power flow using external data of voltages of branch of type Transformer2W\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_val-Tuple{ACBranch}","page":"Internal API Reference","title":"PowerFlows.flow_val","text":"Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_val-Tuple{DynamicBranch}","page":"Internal API Reference","title":"PowerFlows.flow_val","text":"Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_val-Tuple{TapTransformer}","page":"Internal API Reference","title":"PowerFlows.flow_val","text":"Calculates the From - To complex power flow (Flow injected at the bus) of branch of type TapTransformer\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.flow_val-Tuple{Transformer2W}","page":"Internal API Reference","title":"PowerFlows.flow_val","text":"Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Transformer2W\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.make_power_flow_container","page":"Internal API Reference","title":"PowerFlows.make_power_flow_container","text":"Create an appropriate PowerFlowContainer for the given PowerFlowEvaluationModel and initialize it from the given PSY.System.\n\nArguments:\n\npfem::PowerFlowEvaluationModel: power flow model to construct a container for (e.g., DCPowerFlow())\nsys::PSY.System: the system from which to initialize the power flow container\ntime_steps::Int: number of time periods to consider (default is 1)\ntimestep_names::Vector{String}: names of the time periods defines by the argument \"time_steps\". Default value is String[].\ncheck_connectivity::Bool: Perform connectivity check on the network matrix. Default value is true.\n\n\n\n\n\n","category":"function"},{"location":"api/internal/#PowerFlows.name_formatter_from_component_ids-Tuple{Any, Any, Any}","page":"Internal API Reference","title":"PowerFlows.name_formatter_from_component_ids","text":"Use PSS/E exporter metadata to build a function that maps component names back to their original Sienna values.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.reset_caches-Tuple{PSSEExporter}","page":"Internal API Reference","title":"PowerFlows.reset_caches","text":"Force all cached information (serialized metadata, component lists, etc.) to be regenerated\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.serialize_component_ids-Tuple{Dict{Tuple{Int64, String}, String}}","page":"Internal API Reference","title":"PowerFlows.serialize_component_ids","text":"Take the output of create_component_ids and make it more suitable for JSON serialization\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.solve_powerflow!-Tuple{PowerFlowData{PowerNetworkMatrices.PTDF{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}, Matrix{Float64}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}}","page":"Internal API Reference","title":"PowerFlows.solve_powerflow!","text":"Evaluates the power flows on each system's branch and updates the PowerFlowData structure.\n\nArguments:\n\ndata::PTDFPowerFlowData: PTDFPowerFlowData structure containing all the information related to the system's power flow.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.solve_powerflow!-Tuple{PowerFlowData{PowerNetworkMatrices.VirtualPTDF{Tuple{Vector{String}, Vector{Int64}}, Tuple{Dict{String, Int64}, Dict{Int64, Int64}}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}}","page":"Internal API Reference","title":"PowerFlows.solve_powerflow!","text":"Evaluates the power flows on each system's branch and updates the PowerFlowData structure.\n\nArguments:\n\ndata::vPTDFPowerFlowData: vPTDFPowerFlowData structure containing all the information related to the system's power flow.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.supports_multi_period-Tuple{PowerFlows.PowerFlowContainer}","page":"Internal API Reference","title":"PowerFlows.supports_multi_period","text":"Trait signifying whether the PowerFlowContainer can represent multi-period data. Must be implemented for all concrete subtypes.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.update_system!-Tuple{System, PowerFlowData}","page":"Internal API Reference","title":"PowerFlows.update_system!","text":"Modify the values in the given System to correspond to the given PowerFlowData such that if a new PowerFlowData is constructed from the resulting system it is the same as data. See also write_powerflow_solution!. NOTE that this assumes that data was initialized from sys and then solved with no further modifications.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_powerflow_solution!-Tuple{System, Vector{Float64}, Int64}","page":"Internal API Reference","title":"PowerFlows.write_powerflow_solution!","text":"Updates system voltages and powers with power flow results\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Bus Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Bus Data. Sienna voltage limits treated as PSS/E normal voltage limits; PSSE emergency voltage limits left as default.\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Case Identification Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Case Identification Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Fixed Shunt Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Fixed Bus Shunt Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Generator Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"If the exportsettings flag `sourcesas_generatorsis set, exportPSY.Sourceinstances as PSS/E generators in addition toPSY.Generator`s\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Generator Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Load Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Load Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Non-Transformer Branch Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Non-Transformer Branch Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Q Record\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"WRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Q Record\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Transformer Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"Currently only supports two-winding transformers\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Transformer Data\n\n\n\n\n\n","category":"method"},{"location":"api/internal/#PowerFlows.write_to_buffers!-Tuple{PSSEExporter, Val{Symbol(\"Zone Data\")}}","page":"Internal API Reference","title":"PowerFlows.write_to_buffers!","text":"Assumes that the Sienna zone names are already PSS/E compatible\n\nWRITTEN TO SPEC: PSS/E 33.3 POM 5.2.1 Zone Data\n\n\n\n\n\n","category":"method"},{"location":"modeler_guide/power_flow/#Power-Flow","page":"Power Flow","title":"Power Flow","text":"","category":"section"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"CurrentModule = PowerFlows","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"PowerFlows.jl provides the capability to run a power flow using NLSolve, in the current stage of development it can't force reactive power constraints. This power flow routine does not check for reactive power limits or other limiting mechanisms in the grid, and can therefore be used to check for solver convergence - making no guarantees of the solution feasibility.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"The power flow solver uses NLsolve.jl under the hood and takes any keyword argument accepted by NLsolve. The solver uses the current operating point in the buses to provide the initial guess.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Limitations: The PowerFlow solver doesn't support systems with HVDC lines or Phase Shifting transformers yet. The power flow solver can't handle systems with islands.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"using PowerFlows\nusing PowerSystems\nusing PowerSystemCaseBuilder\n\nsystem_data = build_system(PSITestSystems, \"c_sys14\")","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"PowerFlows.jl has two modes of using the power flow solver.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Solving the power flow for the current operating point in the system. Takes the data in the buses, the active_power and reactive_power fields in the static injection devices. Returns a dictionary with results in a DataFrame that can be exported or manipulated as needed.\nSolves the power flow and updated the devices in the system to the operating condition. This model will update the values of magnitudes and angles in the system's buses. It also updates the active and reactive power flows in the branches and devices connected to PV buses. It also updates the active and reactive power of the injection devices connected to the Slack bus, and updates only the reactive power of the injection devices connected to PV buses. If multiple devices are connected to the same bus, the power is divided proportional to the base power. This utility is useful to initialize systems before serializing or checking the addition of new devices is still AC feasible.","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Solving the power flow with mode 1:","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"results = run_powerflow(system_data)\nresults[\"bus_results\"]","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Solving the power flow with mode 2:","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"Before running the power flow command these are the values of the voltages:","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"for b in get_components(Bus, system_data)\n println(\"$(get_name(b)) - Magnitude $(get_magnitude(b)) - Angle (rad) $(get_angle(b))\")\nend","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"run_powerflow! return true or false to signal the successful result of the power flow. This enables the integration of a power flow into functions and use the return as check. For instance, initializing dynamic simulations. Also, because run_powerflow! uses NLsolve.jl all the parameters used for NLsolve are also available for run_powerflow!","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"run_powerflow!(system_data; method = :newton)","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"After running the power flow command this are the values of the voltages:","category":"page"},{"location":"modeler_guide/power_flow/","page":"Power Flow","title":"Power Flow","text":"for b in get_components(Bus, system_data)\n println(\"$(get_name(b)) - Magnitude $(get_magnitude(b)) - Angle (rad) $(get_angle(b))\")\nend","category":"page"},{"location":"#PowerFlows.jl","page":"Welcome Page","title":"PowerFlows.jl","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"CurrentModule = PowerFlows","category":"page"},{"location":"#Overview","page":"Welcome Page","title":"Overview","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerFlows.jl is a Julia package for solving Power Flows","category":"page"},{"location":"#Installation","page":"Welcome Page","title":"Installation","text":"","category":"section"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"The latest stable release of PowerFlows can be installed using the Julia package manager with","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"] add PowerFlows","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"For the current development version, \"checkout\" this package with","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"] add PowerFlows#main","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"","category":"page"},{"location":"","page":"Welcome Page","title":"Welcome Page","text":"PowerFlows has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory (NREL)","category":"page"},{"location":"api/public/#PowerFlows","page":"Public API Reference","title":"PowerFlows","text":"","category":"section"},{"location":"api/public/","page":"Public API Reference","title":"Public API Reference","text":"CurrentModule = PowerFlows\nDocTestSetup = quote\n using PowerFlows\nend","category":"page"},{"location":"api/public/","page":"Public API Reference","title":"Public API Reference","text":"Modules = [PowerFlows]\nPublic = true\nPrivate = false","category":"page"},{"location":"api/public/#PowerFlows.PSSEExporter","page":"Public API Reference","title":"PowerFlows.PSSEExporter","text":"Structure to perform an export from a Sienna System, plus optional updates from PowerFlowData, to the PSS/E format. Construct from a System and a PSS/E version, update using update_exporter with any new data as relevant, and perform the export with write_export.\n\nArguments:\n\nbase_system::PSY.System: the system to be exported. Later updates may change power flow-related values but may not fundamentally alter the system\npsse_version::Symbol: the version of PSS/E to target, must be one of PSSE_EXPORT_SUPPORTED_VERSIONS\nwrite_comments::Bool = false: whether to add the customary-but-not-in-spec-annotations after a slash on the first line and at group boundaries\nname::AbstractString = \"export\": the base name of the export\nstep::Union{Nothing, Integer, Tuple{Vararg{Integer}}} = nothing: optional step number or tuple of step numbers (e.g., step and timestamp within step) to append to the base export name. User is responsible for updating the step.\noverwrite::Bool = false: true to silently overwrite existing exports, false to throw an error if existing results are encountered\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerFlows.PowerFlowData","page":"Public API Reference","title":"PowerFlows.PowerFlowData","text":"Structure containing all the data required for the evaluation of the power flows and angles, as well as these ones.\n\nArguments:\n\nbus_lookup::Dict{Int, Int}: dictionary linking the system's bus number with the rows of either \"powernetworkmatrix\" or \"auxnetworkmatrix\".\nbranch_lookup::Dict{String, Int}: dictionary linking the branch name with the column name of either the \"powernetworkmatrix\" or \"auxnetworkmatrix\".\nbus_activepower_injection::Matrix{Float64}: \"(b, t)\" matrix containing the bus active power injection. b: number of buses, t: number of time period.\nbus_reactivepower_injection::Matrix{Float64}: \"(b, t)\" matrix containing the bus reactive power injection. b: number of buses, t: number of time period.\nbus_activepower_withdrawals::Matrix{Float64}: \"(b, t)\" matrix containing the bus reactive power withdrawals. b: number of buses, t: number of time period.\nbus_reactivepower_withdrawals::Matrix{Float64}: \"(b, t)\" matrix containing the bus reactive power withdrawals. b: number of buses, t: number of time period.\nbus_reactivepower_bounds::Vector{Float64}: Upper and Lower bounds for the reactive supply at each bus.\nbus_type::Vector{PSY.ACBusTypes}: vector containing type of buses present in the system, ordered according to \"bus_lookup\".\nbus_magnitude::Matrix{Float64}: \"(b, t)\" matrix containing the bus magnitudes, ordered according to \"bus_lookup\". b: number of buses, t: number of time period.\nbus_angles::Matrix{Float64}: \"(b, t)\" matrix containing the bus angles, ordered according to \"bus_lookup\". b: number of buses, t: number of time period.\nbranch_flow_values::Matrix{Float64}: \"(br, t)\" matrix containing the power flows, ordered according to \"branch_lookup\". br: number of branches, t: number of time period.\ntimestep_map::Dict{Int, S}: dictonary mapping the number of the time periods (corresponding to the column number of the previosly mentioned matrices) and their names.\nvalid_ix::Vector{Int}: vector containing the indeces of not slack buses\npower_network_matrix::M: matrix used for the evaluation of either the power flows or bus angles, depending on the method considered.\naux_network_matrix::N: matrix used for the evaluation of either the power flows or bus angles, depending on the method considered.\nneighbors::Vector{Set{Int}}: Vector with the sets of adjacent buses.\n\n\n\n\n\n","category":"type"},{"location":"api/public/#PowerFlows.PowerFlowData-Tuple{ACPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.PowerFlowData","text":"Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for AC power flow computations.\n\nArguments:\n\n::ACPowerFlow: use ACPowerFlow() to evaluate the AC PF.\nsys::PSY.System: container storing the system data to consider in the PowerFlowData structure.\ntime_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.\ntimestep_names::Vector{String}: names of the time periods defines by the argmunet \"time_steps\". Default value = String[].\ncheck_connectivity::Bool: Perform connectivity check on the network matrix. Default value = true.\n\nWARNING: functions for the evaluation of the multi-period AC PF still to be implemented.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.PowerFlowData-Tuple{DCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.PowerFlowData","text":"Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for DC power flow computations.\n\nArguments:\n\n::DCPowerFlow: use DCPowerFlow() to store the ABA matrix as powernetworkmatrix and the BA matrix as auxnetworkmatrix.\nsys::PSY.System: container storing the system data to consider in the PowerFlowData structure.\ntime_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.\ntimestep_names::Vector{String}: names of the time periods defines by the argmunet \"time_steps\". Default value = String[].\ncheck_connectivity::Bool: Perform connectivity check on the network matrix. Default value = true.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.PowerFlowData-Tuple{vPTDFDCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.PowerFlowData","text":"Function for the definition of the PowerFlowData strucure given the System data, number of time periods to consider and their names. Calling this function will not evaluate the power flows and angles. NOTE: use it for DC power flow computations.\n\nArguments:\n\n::PTDFDCPowerFlow: use vPTDFDCPowerFlow() to store the Virtual PTDF matrix as powernetworkmatrix and the ABA matrix as auxnetworkmatrix.\nsys::PSY.System: container storing the system data to consider in the PowerFlowData structure.\ntime_steps::Int: number of time periods to consider in the PowerFlowData structure. It defines the number of columns of the matrices used to store data. Default value = 1.\ntimestep_names::Vector{String}: names of the time periods defines by the argmunet \"time_steps\". Default value = String[].\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.get_psse_export_paths-Tuple{AbstractString}","page":"Public API Reference","title":"PowerFlows.get_psse_export_paths","text":"Calculate the paths of the (raw, metadata) files that would be written by a certain call to write_export\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_ac_powerflow!-Tuple{ACPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_ac_powerflow!","text":"Solves a the power flow into the system and writes the solution into the relevant structs. Updates generators active and reactive power setpoints and branches active and reactive power flows (calculated in the From - To direction) (see flow_val)\n\nSupports passing NLsolve kwargs in the args. By default shows the solver trace.\n\nArguments available for nlsolve:\n\nget_connectivity::Bool: Checks if the network is connected. Default true\nmethod : See NLSolve.jl documentation for available solvers\nxtol: norm difference in x between two successive iterates under which convergence is declared. Default: 0.0.\nftol: infinite norm of residuals under which convergence is declared. Default: 1e-8.\niterations: maximum number of iterations. Default: 1_000.\nstore_trace: should a trace of the optimization algorithm's state be stored? Default: false.\nshow_trace: should a trace of the optimization algorithm's state be shown on STDOUT? Default: false.\nextended_trace: should additifonal algorithm internals be added to the state trace? Default: false.\n\nExamples\n\nsolve_ac_powerflow!(sys)\n# Passing NLsolve arguments\nsolve_ac_powerflow!(sys, method=:newton)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{ACPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Similar to solve_powerflow!(sys) but does not update the system struct with results. Returns the results in a dictionary of dataframes.\n\nExamples\n\nres = solve_powerflow(sys)\n# Passing NLsolve arguments\nres = solve_powerflow(sys, method=:newton)\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{DCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the ABA and BA matrices. Updates the PowerFlowData structure and returns a dictionary containing a DataFrame for the single timestep considered. The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.\n\nArguments:\n\n::DCPowerFlow: use DCPowerFlow() to evaluate the power flows according to the method based on the ABA and BA matrices\nsys::PSY.System: container gathering the system data used for the evaluation of flows and angles.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{PTDFDCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the PTDF matrix. Updates the PowerFlowData structure and returns a dictionary containing a DataFrame for the single timestep considered. The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.\n\nArguments:\n\n::PTDFDCPowerFlow: use PTDFDCPowerFlow() to evaluate the power flows according to the method based on the PTDF matrix\nsys::PSY.System: container gathering the system data used for the evaluation of flows and angles.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{PowerFlowData{PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}, PowerNetworkMatrices.BA_Matrix{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}}}, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the ABA and BA matrices. Updates the PowerFlowData structure \"data\" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in \"data\". Each DataFrame containts the flows and angles.\n\nArguments:\n\ndata::ABAPowerFlowData: PowerFlowData structure containing the system's data per each timestep considered, as well as the ABA and BA matrices.\nsys::PSY.System: container gathering the system data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{PowerFlowData{PowerNetworkMatrices.PTDF{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}, Matrix{Float64}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the PTDF matrix. Updates the PowerFlowData structure \"data\" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in \"data\". Each DataFrame containts the flows and angles.\n\nArguments:\n\ndata::PTDFPowerFlowData: PowerFlowData structure containing the system's data per each timestep considered, as well as the PTDF matrix.\nsys::PSY.System: container gathering the system data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{PowerFlowData{PowerNetworkMatrices.VirtualPTDF{Tuple{Vector{String}, Vector{Int64}}, Tuple{Dict{String, Int64}, Dict{Int64, Int64}}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of Virtual PTDF matrices. Updates the PowerFlowData structure \"data\" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in \"data\". Each DataFrame containts the flows and angles.\n\nArguments:\n\ndata::PTDFPowerFlowData: PowerFlowData structure containing the system data per each timestep considered, as well as the Virtual PTDF matrix.\nsys::PSY.System: container gathering the system data.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.solve_powerflow-Tuple{vPTDFDCPowerFlow, System}","page":"Public API Reference","title":"PowerFlows.solve_powerflow","text":"Evaluates the power flows on each system's branch by means of the Virtual PTDF matrix. Updates the PowerFlowData structure \"data\" and returns a dictionary containing a number of DataFrames equal to the numeber of timestep considered in \"data\". The DataFrame containts the flows and angles related to the information stored in the PSY.System considered as input.\n\nArguments:\n\n::vPTDFDCPowerFlow: use vPTDFDCPowerFlow() to evaluate the power flows according to the method based on the Virtual PTDF matrix\nsys::PSY.System: container gathering the system data used for the evaluation of flows and angles.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.update_exporter!-Tuple{PSSEExporter, PowerFlowData}","page":"Public API Reference","title":"PowerFlows.update_exporter!","text":"Update the PSSEExporter with new data.\n\nArguments:\n\nexporter::PSSEExporter: the exporter to update\ndata::PSY.PowerFlowData: the new data. Must correspond to the System with which the exporter was constructor\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.update_exporter!-Tuple{PSSEExporter, System}","page":"Public API Reference","title":"PowerFlows.update_exporter!","text":"Update the PSSEExporter with new data.\n\nArguments:\n\nexporter::PSSEExporter: the exporter to update\ndata::PSY.System: system containing the new data. Must be fundamentally the same\n\nSystem as the one with which the exporter was constructed, just with different values\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.write_export-Tuple{PSSEExporter, AbstractString}","page":"Public API Reference","title":"PowerFlows.write_export","text":"Peform an export from the data contained in a PSSEExporter to the PSS/E file format.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.write_results-Tuple{ACPowerFlow, System, PowerFlowData{PowerNetworkMatrices.Ybus{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}}, Nothing}, Vector{Float64}}","page":"Public API Reference","title":"PowerFlows.write_results","text":"Returns a dictionary containing the AC power flow results.\n\nOnly single-period evaluation is supported at the moment for AC Power flows. Resulting dictionary will therefore feature just one key linked to one DataFrame.\n\nArguments:\n\n::ACPowerFlow: use ACPowerFlow() storing AC power flow results.\nsys::PSY.System: container storing the systam information.\nresult::Vector{Float64}: vector containing the reults for one single time-period.\n\n\n\n\n\n","category":"method"},{"location":"api/public/#PowerFlows.write_results-Tuple{Union{PowerFlowData{PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}, PowerNetworkMatrices.BA_Matrix{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}}}, PowerFlowData{PowerNetworkMatrices.PTDF{Tuple{Vector{Int64}, Vector{String}}, Tuple{Dict{Int64, Int64}, Dict{String, Int64}}, Matrix{Float64}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}, PowerFlowData{PowerNetworkMatrices.VirtualPTDF{Tuple{Vector{String}, Vector{Int64}}, Tuple{Dict{String, Int64}, Dict{Int64, Int64}}}, PowerNetworkMatrices.ABA_Matrix{Tuple{Vector{Int64}, Vector{Int64}}, Tuple{Dict{Int64, Int64}, Dict{Int64, Int64}}, KLU.KLUFactorization{Float64, Int64}}}}, System}","page":"Public API Reference","title":"PowerFlows.write_results","text":"Returns a dictionary containing the DC power flow results. Each key conresponds to the name of the considered time periods, storing a DataFrame with the PF results.\n\nArguments:\n\ndata::Union{PTDFPowerFlowData, vPTDFPowerFlowData, ABAPowerFlowData}: PowerFlowData strcuture containing power flows and bus angles.\nsys::PSY.System: container storing the systam information.\n\n\n\n\n\n","category":"method"}] }