build based on b57d1e3

dev/concept_reference/Parameters/index.html

@@ -5,4 +5,4 @@
 
 # If not a root `stochastic_scenario`
 
-weight(scenario) = sum([weight(parent) * weight_relative_to_parents(scenario)] for parent in parents)</code></pre><p>The above calculation is performed starting from the roots, generation by generation, until the leaves of the <em>stochastic DAG</em>. Thus, the final weight of each <a href="../Object Classes/#stochastic_scenario">stochastic_scenario</a> is dependent on the <a href="#weight_relative_to_parents">weight_relative_to_parents</a> <a href="#Parameters">Parameters</a> of all its ancestors.</p><h2 id="window_duration"><a class="docs-heading-anchor" href="#window_duration"><code>window_duration</code></a><a id="window_duration-1"></a><a class="docs-heading-anchor-permalink" href="#window_duration" title="Permalink"></a></h2><blockquote><p>The duration of the window in case it differs from roll_forward</p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>TODO</p><h2 id="window_weight"><a class="docs-heading-anchor" href="#window_weight"><code>window_weight</code></a><a id="window_weight-1"></a><a class="docs-heading-anchor-permalink" href="#window_weight" title="Permalink"></a></h2><blockquote><p>The weight of the window in the rolling subproblem</p></blockquote><blockquote><p><strong>Default value:</strong> 1</p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>The <code>window_weight</code> parameter, defined for a <a href="../Object Classes/#model">model</a> object, is used in the Benders decomposition algorithm with representative periods. In this setup, the subproblem rolls over a series of possibly disconnected windows,  corresponding to the representative periods. Each of these windows can have a different weight, for example, equal to the fraction of the full model horizon that it represents. Chosing a good weigth can help the solution  be more accurate.</p><p>To use weighted rolling representative periods Benders, do the following.</p><ul><li>Specify <a href="#roll_forward">roll_forward</a> as an array of n duration values, so the subproblem rolls over representative periods.</li><li>Specify <code>window_weight</code> as an array of n + 1 floating point values, representing the weight of each window.</li></ul><p>Note that it the problem rolls n times, then you have n + 1 windows.</p><h2 id="write_lodf_file"><a class="docs-heading-anchor" href="#write_lodf_file"><code>write_lodf_file</code></a><a id="write_lodf_file-1"></a><a class="docs-heading-anchor-permalink" href="#write_lodf_file" title="Permalink"></a></h2><blockquote><p>A boolean flag for whether the LODF values should be written to a results file.</p></blockquote><blockquote><p><strong>Default value:</strong> false</p></blockquote><blockquote><p><strong>Uses <a href="../Parameter Value Lists/#Parameter-Value-Lists">Parameter Value Lists</a>:</strong> <a href="../Parameter Value Lists/#boolean_value_list">boolean_value_list</a></p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>If this parameter value is set to <code>true</code>, a diagnostics file containing all the network line outage distributions factors in CSV format will be written to the current directory.</p><h2 id="write_mps_file"><a class="docs-heading-anchor" href="#write_mps_file"><code>write_mps_file</code></a><a id="write_mps_file-1"></a><a class="docs-heading-anchor-permalink" href="#write_mps_file" title="Permalink"></a></h2><blockquote><p>A selector for writing an .mps file of the model.</p></blockquote><blockquote><p><strong>Uses <a href="../Parameter Value Lists/#Parameter-Value-Lists">Parameter Value Lists</a>:</strong> <a href="../Parameter Value Lists/#write_mps_file_list">write_mps_file_list</a></p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>This parameter is deprecated and will be removed in a future version.</p><p>This parameter controls when to write a diagnostic model file in MPS format. If set to <code>write_mps_always</code>, the model will always be written in MPS format to the current directory. If set to <code>write\_mps\_on\_no\_solve</code>, the MPS file will be written when the model solve terminates with a status of false.  If set to <code>write\_mps\_never</code>, no file will be written</p><h2 id="write_ptdf_file"><a class="docs-heading-anchor" href="#write_ptdf_file"><code>write_ptdf_file</code></a><a id="write_ptdf_file-1"></a><a class="docs-heading-anchor-permalink" href="#write_ptdf_file" title="Permalink"></a></h2><blockquote><p>A boolean flag for whether the LODF values should be written to a results file.</p></blockquote><blockquote><p><strong>Default value:</strong> false</p></blockquote><blockquote><p><strong>Uses <a href="../Parameter Value Lists/#Parameter-Value-Lists">Parameter Value Lists</a>:</strong> <a href="../Parameter Value Lists/#boolean_value_list">boolean_value_list</a></p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>If this parameter value is set to <code>true</code>, a diagnostics file containing all the network power transfer distributions factors in CSV format will be written to the current directory.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../Relationship Classes/">« Relationship Classes</a><a class="docs-footer-nextpage" href="../Parameter Value Lists/">Parameter Value Lists »</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 7 August 2023 06:55">Monday 7 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+weight(scenario) = sum([weight(parent) * weight_relative_to_parents(scenario)] for parent in parents)</code></pre><p>The above calculation is performed starting from the roots, generation by generation, until the leaves of the <em>stochastic DAG</em>. Thus, the final weight of each <a href="../Object Classes/#stochastic_scenario">stochastic_scenario</a> is dependent on the <a href="#weight_relative_to_parents">weight_relative_to_parents</a> <a href="#Parameters">Parameters</a> of all its ancestors.</p><h2 id="window_duration"><a class="docs-heading-anchor" href="#window_duration"><code>window_duration</code></a><a id="window_duration-1"></a><a class="docs-heading-anchor-permalink" href="#window_duration" title="Permalink"></a></h2><blockquote><p>The duration of the window in case it differs from roll_forward</p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>TODO</p><h2 id="window_weight"><a class="docs-heading-anchor" href="#window_weight"><code>window_weight</code></a><a id="window_weight-1"></a><a class="docs-heading-anchor-permalink" href="#window_weight" title="Permalink"></a></h2><blockquote><p>The weight of the window in the rolling subproblem</p></blockquote><blockquote><p><strong>Default value:</strong> 1</p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>The <code>window_weight</code> parameter, defined for a <a href="../Object Classes/#model">model</a> object, is used in the Benders decomposition algorithm with representative periods. In this setup, the subproblem rolls over a series of possibly disconnected windows,  corresponding to the representative periods. Each of these windows can have a different weight, for example, equal to the fraction of the full model horizon that it represents. Chosing a good weigth can help the solution  be more accurate.</p><p>To use weighted rolling representative periods Benders, do the following.</p><ul><li>Specify <a href="#roll_forward">roll_forward</a> as an array of n duration values, so the subproblem rolls over representative periods.</li><li>Specify <code>window_weight</code> as an array of n + 1 floating point values, representing the weight of each window.</li></ul><p>Note that it the problem rolls n times, then you have n + 1 windows.</p><h2 id="write_lodf_file"><a class="docs-heading-anchor" href="#write_lodf_file"><code>write_lodf_file</code></a><a id="write_lodf_file-1"></a><a class="docs-heading-anchor-permalink" href="#write_lodf_file" title="Permalink"></a></h2><blockquote><p>A boolean flag for whether the LODF values should be written to a results file.</p></blockquote><blockquote><p><strong>Default value:</strong> false</p></blockquote><blockquote><p><strong>Uses <a href="../Parameter Value Lists/#Parameter-Value-Lists">Parameter Value Lists</a>:</strong> <a href="../Parameter Value Lists/#boolean_value_list">boolean_value_list</a></p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>If this parameter value is set to <code>true</code>, a diagnostics file containing all the network line outage distributions factors in CSV format will be written to the current directory.</p><h2 id="write_mps_file"><a class="docs-heading-anchor" href="#write_mps_file"><code>write_mps_file</code></a><a id="write_mps_file-1"></a><a class="docs-heading-anchor-permalink" href="#write_mps_file" title="Permalink"></a></h2><blockquote><p>A selector for writing an .mps file of the model.</p></blockquote><blockquote><p><strong>Uses <a href="../Parameter Value Lists/#Parameter-Value-Lists">Parameter Value Lists</a>:</strong> <a href="../Parameter Value Lists/#write_mps_file_list">write_mps_file_list</a></p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>This parameter is deprecated and will be removed in a future version.</p><p>This parameter controls when to write a diagnostic model file in MPS format. If set to <code>write_mps_always</code>, the model will always be written in MPS format to the current directory. If set to <code>write\_mps\_on\_no\_solve</code>, the MPS file will be written when the model solve terminates with a status of false.  If set to <code>write\_mps\_never</code>, no file will be written</p><h2 id="write_ptdf_file"><a class="docs-heading-anchor" href="#write_ptdf_file"><code>write_ptdf_file</code></a><a id="write_ptdf_file-1"></a><a class="docs-heading-anchor-permalink" href="#write_ptdf_file" title="Permalink"></a></h2><blockquote><p>A boolean flag for whether the LODF values should be written to a results file.</p></blockquote><blockquote><p><strong>Default value:</strong> false</p></blockquote><blockquote><p><strong>Uses <a href="../Parameter Value Lists/#Parameter-Value-Lists">Parameter Value Lists</a>:</strong> <a href="../Parameter Value Lists/#boolean_value_list">boolean_value_list</a></p></blockquote><blockquote><p><strong>Related <a href="../Object Classes/#Object-Classes">Object Classes</a>:</strong> <a href="../Object Classes/#model">model</a></p></blockquote><p>If this parameter value is set to <code>true</code>, a diagnostics file containing all the network power transfer distributions factors in CSV format will be written to the current directory.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../Relationship Classes/">« Relationship Classes</a><a class="docs-footer-nextpage" href="../Parameter Value Lists/">Parameter Value Lists »</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 7 August 2023 07:21">Monday 7 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>