Skip to content

Commit

Permalink
build based on 794a466
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 30, 2023
1 parent 097c110 commit 4b3fac6
Show file tree
Hide file tree
Showing 15 changed files with 932 additions and 0 deletions.
2 changes: 2 additions & 0 deletions previews/PR26/api/internal/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Internal API Reference · PowerFlows.jl</title><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="PowerFlows.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">PowerFlows.jl</a></span></div><form class="docs-search" action="../../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../../">Welcome Page</a></li><li><span class="tocitem">Modeler Guide</span><ul><li><a class="tocitem" href="../../modeler_guide/power_flow/">Power Flow</a></li></ul></li><li><span class="tocitem">Code Base Developer Guide</span><ul><li><a class="tocitem" href="../../code_base_developer_guide/developer/">Developer Guide</a></li></ul></li><li><a class="tocitem" href="../public/">Public API Reference</a></li><li class="is-active"><a class="tocitem" href>Internal API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Internal API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Internal API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/main/docs/src/api/internal.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Internal"><a class="docs-heading-anchor" href="#Internal">Internal</a><a id="Internal-1"></a><a class="docs-heading-anchor-permalink" href="#Internal" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="PowerFlows._get_load_data-Tuple{System, Bus}" href="#PowerFlows._get_load_data-Tuple{System, Bus}"><code>PowerFlows._get_load_data</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Obtain total load on bus b</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L121-L123">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows._update_branch_flow!-Tuple{System}" href="#PowerFlows._update_branch_flow!-Tuple{System}"><code>PowerFlows._update_branch_flow!</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Updates the flow on the branches</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L110-L112">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.flow_func-Tuple{ACBranch, ComplexF64, ComplexF64}" href="#PowerFlows.flow_func-Tuple{ACBranch, ComplexF64, ComplexF64}"><code>PowerFlows.flow_func</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Calculates the From - To complex power flow using external data of voltages of branch of type Line</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L77-L80">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.flow_func-Tuple{TapTransformer, ComplexF64, ComplexF64}" href="#PowerFlows.flow_func-Tuple{TapTransformer, ComplexF64, ComplexF64}"><code>PowerFlows.flow_func</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Calculates the From - To complex power flow using external data of voltages of branch of type TapTransformer</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L64-L67">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.flow_func-Tuple{Transformer2W, ComplexF64, ComplexF64}" href="#PowerFlows.flow_func-Tuple{Transformer2W, ComplexF64, ComplexF64}"><code>PowerFlows.flow_func</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Calculates the From - To complex power flow using external data of voltages of branch of type Transformer2W</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L89-L92">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.flow_val-Tuple{ACBranch}" href="#PowerFlows.flow_val-Tuple{ACBranch}"><code>PowerFlows.flow_val</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L21-L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.flow_val-Tuple{DynamicBranch}" href="#PowerFlows.flow_val-Tuple{DynamicBranch}"><code>PowerFlows.flow_val</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Line</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L36-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.flow_val-Tuple{TapTransformer}" href="#PowerFlows.flow_val-Tuple{TapTransformer}"><code>PowerFlows.flow_val</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Calculates the From - To complex power flow (Flow injected at the bus) of branch of type TapTransformer</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L5-L8">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.flow_val-Tuple{Transformer2W}" href="#PowerFlows.flow_val-Tuple{Transformer2W}"><code>PowerFlows.flow_val</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Calculates the From - To complex power flow (Flow injected at the bus) of branch of type Transformer2W</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L44-L47">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="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}}}}" href="#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}}}}"><code>PowerFlows.solve_powerflow!</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Evaluates the power flows on each system&#39;s branch and updates the PowerFlowData structure.</p><p><strong>Arguments:</strong></p><ul><li><code>data::PTDFPowerFlowData</code>: PTDFPowerFlowData structure containig all the information related to the system&#39;s power flow.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/solve_dc_powerflow.jl#L28-L34">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.solve_powerflow!-Tuple{PowerFlowData}" href="#PowerFlows.solve_powerflow!-Tuple{PowerFlowData}"><code>PowerFlows.solve_powerflow!</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Evaluates the power flows on each system&#39;s branch and updates the PowerFlowData structure.</p><p><strong>Arguments:</strong></p><ul><li><code>data::vPTDFPowerFlowData</code>: vPTDFPowerFlowData structure containig all the information related to the system&#39;s power flow.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/solve_dc_powerflow.jl#L48-L54">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerFlows.write_powerflow_solution!-Tuple{System, Vector{Float64}}" href="#PowerFlows.write_powerflow_solution!-Tuple{System, Vector{Float64}}"><code>PowerFlows.write_powerflow_solution!</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Updates system voltages and powers with power flow results</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerFlows.jl/blob/794a466e73df92c00e6754310ee94002e33f8ddd/src/post_processing.jl#L431-L433">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../public/">« Public API Reference</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 30 October 2023 18:31">Monday 30 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 4b3fac6

Please sign in to comment.