build based on 5a76149

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-23T16:33:58","documenter_version":"1.4.1"}}
+{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-23T16:41:49","documenter_version":"1.4.1"}}

dev/api/association/index.html

@@ -52,7 +52,7 @@
 julia> assoc1.values[1] = 100; (vals,assoc1.values[1])
 ([3.0], 100.0)
 julia> assoc2.values[1] = 100; (vals,assoc2.values[1])
-([100.0], 100.0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/9d1776f45b43eb4211b5e90998373ea8c4d85acb/src/database/params/paramvectors.jl#L1-L84">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_pair_length" href="#Clapeyron.assoc_pair_length"><code>Clapeyron.assoc_pair_length</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_pair_length(model::EoSModel)</code></pre><p>Indicates the number of pair combinations between the different sites in an association model.</p><p><strong>Example:</strong></p><pre><code class="language-julia-repl hljs">julia&gt; model = PCSAFT([&quot;water&quot;])
+([100.0], 100.0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/5a761496e2a81799ce3eea4fe6ebeccba88209b9/src/database/params/paramvectors.jl#L1-L84">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_pair_length" href="#Clapeyron.assoc_pair_length"><code>Clapeyron.assoc_pair_length</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_pair_length(model::EoSModel)</code></pre><p>Indicates the number of pair combinations between the different sites in an association model.</p><p><strong>Example:</strong></p><pre><code class="language-julia-repl hljs">julia&gt; model = PCSAFT([&quot;water&quot;])
 PCSAFT{BasicIdeal} with 1 component:
  &quot;water&quot;
 Contains parameters: Mw, segment, sigma, epsilon, epsilon_assoc, bondvol
@@ -62,9 +62,9 @@
 (&quot;water&quot;, &quot;e&quot;) &gt;=&lt; (&quot;water&quot;, &quot;H&quot;): 0.034868
 
 julia&gt; Clapeyron.assoc_pair_length(model)
-1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/9d1776f45b43eb4211b5e90998373ea8c4d85acb/src/models/SAFT/association.jl#L10-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_similar" href="#Clapeyron.assoc_similar"><code>Clapeyron.assoc_similar</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_similar(mat::Compressed4DMatrix)
-assoc_similar(mat::Compressed4DMatrix,::Type{𝕋}) where 𝕋 &lt;:Number)</code></pre><p>returns a <code>Clapeyron.Compressed4DMatrix</code> of the same shape as the input, with the same element type as <code>𝕋</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/9d1776f45b43eb4211b5e90998373ea8c4d85acb/src/database/params/paramvectors.jl#L293-L297">source</a></section><section><div><pre><code class="language-julia hljs">assoc_similar(param::SiteParam)
-assoc_similar(param::SiteParam,::Type{𝕋}) where 𝕋 &lt;:Number)</code></pre><p>returns a <code>Clapeyron.Compressed4DMatrix</code> with the smae number of components as the input <code>AssocParam</code>, with the same element type as <code>𝕋</code>. All site combinations are filled.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/9d1776f45b43eb4211b5e90998373ea8c4d85acb/src/database/params/SiteParam.jl#L216-L222">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_options" href="#Clapeyron.assoc_options"><code>Clapeyron.assoc_options</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_options(model::EoSModel)</code></pre><p>Returns association options used in the association solver.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/9d1776f45b43eb4211b5e90998373ea8c4d85acb/src/models/SAFT/association.jl#L106-L111">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_strength" href="#Clapeyron.assoc_strength"><code>Clapeyron.assoc_strength</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_strength(model::EoSModel,V,T,z,i,j,a,b,data = Clapeyron.data(Model,V,T,z))
+1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/5a761496e2a81799ce3eea4fe6ebeccba88209b9/src/models/SAFT/association.jl#L10-L30">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_similar" href="#Clapeyron.assoc_similar"><code>Clapeyron.assoc_similar</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_similar(mat::Compressed4DMatrix)
+assoc_similar(mat::Compressed4DMatrix,::Type{𝕋}) where 𝕋 &lt;:Number)</code></pre><p>returns a <code>Clapeyron.Compressed4DMatrix</code> of the same shape as the input, with the same element type as <code>𝕋</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/5a761496e2a81799ce3eea4fe6ebeccba88209b9/src/database/params/paramvectors.jl#L293-L297">source</a></section><section><div><pre><code class="language-julia hljs">assoc_similar(param::SiteParam)
+assoc_similar(param::SiteParam,::Type{𝕋}) where 𝕋 &lt;:Number)</code></pre><p>returns a <code>Clapeyron.Compressed4DMatrix</code> with the smae number of components as the input <code>AssocParam</code>, with the same element type as <code>𝕋</code>. All site combinations are filled.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/5a761496e2a81799ce3eea4fe6ebeccba88209b9/src/database/params/SiteParam.jl#L216-L222">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_options" href="#Clapeyron.assoc_options"><code>Clapeyron.assoc_options</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_options(model::EoSModel)</code></pre><p>Returns association options used in the association solver.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/5a761496e2a81799ce3eea4fe6ebeccba88209b9/src/models/SAFT/association.jl#L106-L111">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_strength" href="#Clapeyron.assoc_strength"><code>Clapeyron.assoc_strength</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_strength(model::EoSModel,V,T,z,i,j,a,b,data = Clapeyron.data(Model,V,T,z))
 Δ(model::EoSModel,V,T,z,i,j,a,b,data = Clapeyron.data(Model,V,T,z))</code></pre><p>Calculates the asssociation strength between component <code>i</code> at site <code>a</code> and component <code>j</code> at site <code>b</code>.</p><p>Any precomputed values can be passed along by calling <code>Clapeyron.data</code>.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia&gt; model = PCSAFT([&quot;water&quot;])
 PCSAFT{BasicIdeal} with 1 component:
  &quot;water&quot;
@@ -82,7 +82,7 @@
 ([2.991688553098391e-10], 1.3440137996322956e28, 4.020870699566213e18, 1.2029192845380957e9, 0.3598759853853927, 1.0656)
 
 julia&gt; Clapeyron.Δ(model,2.5e-5,298.15,[1.0],1,1,1,2,_data)
-1.293144062056963e-26</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/9d1776f45b43eb4211b5e90998373ea8c4d85acb/src/models/SAFT/association.jl#L35-L63">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_fractions" href="#Clapeyron.assoc_fractions"><code>Clapeyron.assoc_fractions</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_fractions(model::EoSModel, V, T, z,data = nothing)</code></pre><p>Returns the solution for the association site fractions. used internally by all models that require association. The result is of type <code>PackedVectorsOfVectors.PackedVectorOfVectors</code>, with <code>length = length(model)</code>, and <code>x[i][a]</code> representing the empty fraction of the site <code>a</code> at component <code>i</code></p><p><strong>Example:</strong></p><pre><code class="nohighlight hljs">julia&gt; model = PCSAFT([&quot;water&quot;,&quot;methanol&quot;,&quot;ethane&quot;],assoc_options = AssocOptions(combining = :esd))
+1.293144062056963e-26</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/5a761496e2a81799ce3eea4fe6ebeccba88209b9/src/models/SAFT/association.jl#L35-L63">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clapeyron.assoc_fractions" href="#Clapeyron.assoc_fractions"><code>Clapeyron.assoc_fractions</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">assoc_fractions(model::EoSModel, V, T, z,data = nothing)</code></pre><p>Returns the solution for the association site fractions. used internally by all models that require association. The result is of type <code>PackedVectorsOfVectors.PackedVectorOfVectors</code>, with <code>length = length(model)</code>, and <code>x[i][a]</code> representing the empty fraction of the site <code>a</code> at component <code>i</code></p><p><strong>Example:</strong></p><pre><code class="nohighlight hljs">julia&gt; model = PCSAFT([&quot;water&quot;,&quot;methanol&quot;,&quot;ethane&quot;],assoc_options = AssocOptions(combining = :esd))
 PCSAFT{BasicIdeal} with 3 components:
  &quot;water&quot;
  &quot;methanol&quot;
@@ -93,4 +93,4 @@
 3-element pack(::Vector{Vector{Float64}}):
  [0.041396427041509046, 0.041396427041509046]
  [0.018874664357682362, 0.018874664357682362]
- 0-element view(::Vector{Float64}, 5:4) with eltype Float64</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/9d1776f45b43eb4211b5e90998373ea8c4d85acb/src/models/SAFT/association.jl#L246-L267">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../macros/">« Macros</a><a class="docs-footer-nextpage" href="../estimation/">Parameter Estimation »</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="auto">Automatic (OS)</option><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 1.4.1 on <span class="colophon-date" title="Thursday 23 May 2024 16:33">Thursday 23 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 0-element view(::Vector{Float64}, 5:4) with eltype Float64</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/5a761496e2a81799ce3eea4fe6ebeccba88209b9/src/models/SAFT/association.jl#L246-L267">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../macros/">« Macros</a><a class="docs-footer-nextpage" href="../estimation/">Parameter Estimation »</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="auto">Automatic (OS)</option><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 1.4.1 on <span class="colophon-date" title="Thursday 23 May 2024 16:41">Thursday 23 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>