build based on f5bafc6

EnergyModelsX · Feb 29, 2024 · dcd3378 · dcd3378
1 parent 7927a70
commit dcd3378
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 11 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-30T18:02:55","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-29T10:35:48","documenter_version":"1.2.1"}}
diff --git a/dev/index.html b/dev/index.html
diff --git a/dev/library/internals/index.html b/dev/library/internals/index.html
diff --git a/dev/library/public/index.html b/dev/library/public/index.html
diff --git a/dev/manual/NEWS/index.html b/dev/manual/NEWS/index.html
diff --git a/dev/manual/constraint-functions/index.html b/dev/manual/constraint-functions/index.html
@@ -1,3 +1,3 @@
 <!DOCTYPE html>
 <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Constraint functions · EnergyModelsRenewableProducers.jl</title><meta name="title" content="Constraint functions · EnergyModelsRenewableProducers.jl"/><meta property="og:title" content="Constraint functions · EnergyModelsRenewableProducers.jl"/><meta property="twitter:title" content="Constraint functions · EnergyModelsRenewableProducers.jl"/><meta name="description" content="Documentation for EnergyModelsRenewableProducers.jl."/><meta property="og:description" content="Documentation for EnergyModelsRenewableProducers.jl."/><meta property="twitter:description" content="Documentation for EnergyModelsRenewableProducers.jl."/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../../search_index.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"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">EnergyModelsRenewableProducers.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../quick-start/">Quick Start</a></li><li><a class="tocitem" href="../optimization-variables/">Optimization variables</a></li><li class="is-active"><a class="tocitem" href>Constraint functions</a><ul class="internal"><li><a class="tocitem" href="#Storage-level-constraints"><span>Storage level constraints</span></a></li><li><a class="tocitem" href="#Operational-expenditure-constraints"><span>Operational expenditure constraints</span></a></li></ul></li><li><a class="tocitem" href="../simple-example/">Examples</a></li><li><a class="tocitem" href="../NEWS/">Release notes</a></li></ul></li><li><span class="tocitem">Library</span><ul><li><a class="tocitem" href="../../library/public/">Public</a></li><li><a class="tocitem" href="../../library/internals/">Internals</a></li></ul></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Manual</a></li><li class="is-active"><a href>Constraint functions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Constraint functions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/EnergyModelsX/EnergyModelsRenewableProducers.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/EnergyModelsX/EnergyModelsRenewableProducers.jl/blob/main/docs/src/manual/constraint-functions.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="constraint_functions"><a class="docs-heading-anchor" href="#constraint_functions">Constraint functions</a><a id="constraint_functions-1"></a><a class="docs-heading-anchor-permalink" href="#constraint_functions" title="Permalink"></a></h1><p>The <a href="../../library/public/#EnergyModelsRenewableProducers.HydroStorage"><code>HydroStorage</code></a> types dispatch on individual functions from within <code>EnergyModelsBase.jl</code> ti extend the functionality</p><h2 id="Storage-level-constraints"><a class="docs-heading-anchor" href="#Storage-level-constraints">Storage level constraints</a><a id="Storage-level-constraints-1"></a><a class="docs-heading-anchor-permalink" href="#Storage-level-constraints" title="Permalink"></a></h2><p>All <a href="../../library/public/#EnergyModelsRenewableProducers.HydroStorage"><code>HydroStorage</code></a> subtypes utilize the same function, <code>constraints_level(m, n::Storage, 𝒯, 𝒫, modeltype::EnergyModel)</code>, for calling the two relevant subfunctions.</p><p>The function</p><pre><code class="language-julia hljs">EMB.constraints_level_aux(m, n::HydroStorage, 𝒯, 𝒫, modeltype::EnergyModel)</code></pre><p>is extended to account for both the provision of an initial level at the start of each strategic period as well as modifying the constraint for the variable <span>$\texttt{stor\_level\_}\Delta\texttt{\_op}$</span> to account for the introduction of the new variable <span>$\texttt{hydro\_spill}$</span>. The former is required for <a href="../../library/public/#EnergyModelsRenewableProducers.HydroStorage"><code>HydroStorage</code></a> subtypes asthe initial level is frequently a function of the season (excluding small scale pumped hydro storage) while the latter is required to include spillage.</p><p>The functions</p><pre><code class="language-julia hljs">EMB.constraints_level_sp(m, n::HydroStorage, t_inv, 𝒫, modeltype::EnergyModel)</code></pre><p>are similar to the function used for <code>RefStorage{T} where {T&lt;:ResourceCarrier}</code>. It is however necessary to reintroduce it due to the declaration for <code>RefStorage</code> in <code>EnergyModelsBase.jl</code>. This will most likely be adjusted in later versions, although it will not impact the user directly.</p><h2 id="Operational-expenditure-constraints"><a class="docs-heading-anchor" href="#Operational-expenditure-constraints">Operational expenditure constraints</a><a id="Operational-expenditure-constraints-1"></a><a class="docs-heading-anchor-permalink" href="#Operational-expenditure-constraints" title="Permalink"></a></h2><p>Variable operational expenditure (OPEX) constraints are slightly different defined in the case of <a href="../../library/public/#EnergyModelsRenewableProducers.HydroStor"><code>HydroStor</code></a> and <a href="../../library/public/#EnergyModelsRenewableProducers.PumpedHydroStor"><code>PumpedHydroStor</code></a> nodes. Hence, dispatch is required on the individual constraints:</p><pre><code class="language-julia hljs">EMB.constraints_opex_var(m, n::HydroStor, 𝒯::TimeStructure, modeltype::EnergyModel)
-EMB.constraints_opex_var(m, n::PumpedHydroStor, 𝒯::TimeStructure, modeltype::EnergyModel)</code></pre><p>Within a <a href="../../library/public/#EnergyModelsRenewableProducers.HydroStor"><code>HydroStor</code></a> node, the variable OPEX is defined <em>via</em> the outflow from the hydropower plant, contrary to the definition of a <code>RefStorage</code> node in which the variable OPEX is defined <em>via</em> the inflow. A <a href="../../library/public/#EnergyModelsRenewableProducers.PumpedHydroStor"><code>PumpedHydroStor</code></a> has contributions by both the inflow (through the field <code>opex_var_pump</code>) and the outflow (through the field <code>opex_var</code>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../optimization-variables/">« Optimization variables</a><a class="docs-footer-nextpage" href="../simple-example/">Examples »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 30 January 2024 18:02">Tuesday 30 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+EMB.constraints_opex_var(m, n::PumpedHydroStor, 𝒯::TimeStructure, modeltype::EnergyModel)</code></pre><p>Within a <a href="../../library/public/#EnergyModelsRenewableProducers.HydroStor"><code>HydroStor</code></a> node, the variable OPEX is defined <em>via</em> the outflow from the hydropower plant, contrary to the definition of a <code>RefStorage</code> node in which the variable OPEX is defined <em>via</em> the inflow. A <a href="../../library/public/#EnergyModelsRenewableProducers.PumpedHydroStor"><code>PumpedHydroStor</code></a> has contributions by both the inflow (through the field <code>opex_var_pump</code>) and the outflow (through the field <code>opex_var</code>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../optimization-variables/">« Optimization variables</a><a class="docs-footer-nextpage" href="../simple-example/">Examples »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 29 February 2024 10:35">Thursday 29 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>