Skip to content

Commit 84523f6

Browse files
author
Documenter.jl
committed
build based on 2e164bf 
1 parent feed0ce commit 84523f6

File tree

41 files changed

+342
-342
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+342
-342
lines changed

‎dev/.documenter-siteinfo.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.12.4","generation_timestamp":"2026-02-18T04:12:10","documenter_version":"1.16.1"}}
1+
{"documenter":{"julia_version":"1.12.4","generation_timestamp":"2026-02-18T05:53:14","documenter_version":"1.16.1"}}

‎dev/api/association/index.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
julia> assoc1.values[1] = 100; (vals,assoc1.values[1])
5353
([3.0], 100.0)
5454
julia> assoc2.values[1] = 100; (vals,assoc2.values[1])
55-
([100.0], 100.0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/f4b5ee7acd36a3949285bef16736d43e3527cfc1/src/database/params/paramvectors.jl#L1-L84">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_pair_length"><a class="docstring-binding" href="#Clapeyron.assoc_pair_length"><code>Clapeyron.assoc_pair_length</code></a> — <span class="docstring-category">Function</span></summary><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. By default uses <code>length(assoc_shape(model).values)</code></p><p><strong>Example:</strong></p><pre><code class="language-julia-repl hljs">julia&gt; model = PCSAFT([&quot;water&quot;])
55+
([100.0], 100.0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/2e164bfa2fb368e1aac825a23ee37805b40ac547/src/database/params/paramvectors.jl#L1-L84">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_pair_length"><a class="docstring-binding" href="#Clapeyron.assoc_pair_length"><code>Clapeyron.assoc_pair_length</code></a> — <span class="docstring-category">Function</span></summary><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. By default uses <code>length(assoc_shape(model).values)</code></p><p><strong>Example:</strong></p><pre><code class="language-julia-repl hljs">julia&gt; model = PCSAFT([&quot;water&quot;])
5656
PCSAFT{BasicIdeal} with 1 component:
5757
&quot;water&quot;
5858
Contains parameters: Mw, segment, sigma, epsilon, epsilon_assoc, bondvol
@@ -62,9 +62,9 @@
6262
(&quot;water&quot;, &quot;e&quot;) &gt;=&lt; (&quot;water&quot;, &quot;H&quot;): 0.034868
6363

6464
julia&gt; Clapeyron.assoc_pair_length(model)
65-
1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/f4b5ee7acd36a3949285bef16736d43e3527cfc1/src/models/SAFT/association.jl#L43-L64">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_similar"><a class="docstring-binding" href="#Clapeyron.assoc_similar"><code>Clapeyron.assoc_similar</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">assoc_similar(mat::Compressed4DMatrix)
66-
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/f4b5ee7acd36a3949285bef16736d43e3527cfc1/src/database/params/paramvectors.jl#L330-L334">source</a></section><section><div><pre><code class="language-julia hljs">assoc_similar(param::SiteParam)
67-
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/f4b5ee7acd36a3949285bef16736d43e3527cfc1/src/database/params/SiteParam.jl#L213-L219">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_options"><a class="docstring-binding" href="#Clapeyron.assoc_options"><code>Clapeyron.assoc_options</code></a> — <span class="docstring-category">Function</span></summary><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/f4b5ee7acd36a3949285bef16736d43e3527cfc1/src/models/SAFT/association.jl#L161-L166">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_strength"><a class="docstring-binding" href="#Clapeyron.assoc_strength"><code>Clapeyron.assoc_strength</code></a> — <span class="docstring-category">Function</span></summary><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))
65+
1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/2e164bfa2fb368e1aac825a23ee37805b40ac547/src/models/SAFT/association.jl#L43-L64">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_similar"><a class="docstring-binding" href="#Clapeyron.assoc_similar"><code>Clapeyron.assoc_similar</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">assoc_similar(mat::Compressed4DMatrix)
66+
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/2e164bfa2fb368e1aac825a23ee37805b40ac547/src/database/params/paramvectors.jl#L330-L334">source</a></section><section><div><pre><code class="language-julia hljs">assoc_similar(param::SiteParam)
67+
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/2e164bfa2fb368e1aac825a23ee37805b40ac547/src/database/params/SiteParam.jl#L213-L219">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_options"><a class="docstring-binding" href="#Clapeyron.assoc_options"><code>Clapeyron.assoc_options</code></a> — <span class="docstring-category">Function</span></summary><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/2e164bfa2fb368e1aac825a23ee37805b40ac547/src/models/SAFT/association.jl#L161-L166">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_strength"><a class="docstring-binding" href="#Clapeyron.assoc_strength"><code>Clapeyron.assoc_strength</code></a> — <span class="docstring-category">Function</span></summary><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))
6868
Δ(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;])
6969
PCSAFT{BasicIdeal} with 1 component:
7070
&quot;water&quot;
@@ -82,7 +82,7 @@
8282
([2.991688553098391e-10], 1.3440137996322956e28, 4.020870699566213e18, 1.2029192845380957e9, 0.3598759853853927, 1.0656)
8383

8484
julia&gt; Clapeyron.Δ(model,2.5e-5,298.15,[1.0],1,1,1,2,_data)
85-
1.293144062056963e-26</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/f4b5ee7acd36a3949285bef16736d43e3527cfc1/src/models/SAFT/association.jl#L70-L98">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_fractions"><a class="docstring-binding" href="#Clapeyron.assoc_fractions"><code>Clapeyron.assoc_fractions</code></a> — <span class="docstring-category">Function</span></summary><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="language-julia hljs">julia&gt; model = PCSAFT([&quot;water&quot;,&quot;methanol&quot;,&quot;ethane&quot;],assoc_options = AssocOptions(combining = :esd))
85+
1.293144062056963e-26</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/2e164bfa2fb368e1aac825a23ee37805b40ac547/src/models/SAFT/association.jl#L70-L98">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Clapeyron.assoc_fractions"><a class="docstring-binding" href="#Clapeyron.assoc_fractions"><code>Clapeyron.assoc_fractions</code></a> — <span class="docstring-category">Function</span></summary><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="language-julia hljs">julia&gt; model = PCSAFT([&quot;water&quot;,&quot;methanol&quot;,&quot;ethane&quot;],assoc_options = AssocOptions(combining = :esd))
8686
PCSAFT{BasicIdeal} with 3 components:
8787
&quot;water&quot;
8888
&quot;methanol&quot;
@@ -93,4 +93,4 @@
9393
3-element pack(::Vector{Vector{Float64}}):
9494
[0.041396427041509046, 0.041396427041509046]
9595
[0.018874664357682362, 0.018874664357682362]
96-
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/f4b5ee7acd36a3949285bef16736d43e3527cfc1/src/models/SAFT/association.jl#L279-L300">source</a></section></details></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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.16.1 on <span class="colophon-date" title="Wednesday 18 February 2026 04:12">Wednesday 18 February 2026</span>. Using Julia version 1.12.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
96+
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/2e164bfa2fb368e1aac825a23ee37805b40ac547/src/models/SAFT/association.jl#L279-L300">source</a></section></details></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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.16.1 on <span class="colophon-date" title="Wednesday 18 February 2026 05:53">Wednesday 18 February 2026</span>. Using Julia version 1.12.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)