Skip to content

Commit

Permalink
build based on c945020
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 30, 2024
1 parent 2b526cb commit 61ee6e8
Show file tree
Hide file tree
Showing 28 changed files with 237 additions and 237 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-30T18:10:14","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-30T21:28:52","documenter_version":"1.7.0"}}
12 changes: 6 additions & 6 deletions dev/api/association/index.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/api/estimation/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/api/macros/index.html

Large diffs are not rendered by default.

36 changes: 18 additions & 18 deletions dev/api/parameters/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/dev/index.html

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions dev/eos/activity/index.html

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions dev/eos/correlations/index.html

Large diffs are not rendered by default.

118 changes: 59 additions & 59 deletions dev/eos/cubic/index.html

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions dev/eos/electrolytes/index.html

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions dev/eos/empiric/index.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions dev/eos/ideal/index.html

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions dev/eos/misc/index.html

Large diffs are not rendered by default.

56 changes: 28 additions & 28 deletions dev/eos/saft/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
publisher={American Chemical Society},
doi={doi/10.1021/acs.iecr.2c00326},
url={https://pubs.acs.org/doi/10.1021/acs.iecr.2c00326}
}</code></pre><h2 id="Citing-a-particular-equation-of-state-model"><a class="docs-heading-anchor" href="#Citing-a-particular-equation-of-state-model">Citing a particular equation of state model</a><a id="Citing-a-particular-equation-of-state-model-1"></a><a class="docs-heading-anchor-permalink" href="#Citing-a-particular-equation-of-state-model" title="Permalink"></a></h2><p>In addition to citing this work, it is encouraged to cite the references to the underlying models used. for that, you can use <a href="api/parameters/#Clapeyron.cite"><code>Clapeyron.cite</code></a> to obtain the references used in a particular model</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="theory/background/">Background »</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.7.0 on <span class="colophon-date" title="Monday 30 September 2024 18:10">Monday 30 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
}</code></pre><h2 id="Citing-a-particular-equation-of-state-model"><a class="docs-heading-anchor" href="#Citing-a-particular-equation-of-state-model">Citing a particular equation of state model</a><a id="Citing-a-particular-equation-of-state-model-1"></a><a class="docs-heading-anchor-permalink" href="#Citing-a-particular-equation-of-state-model" title="Permalink"></a></h2><p>In addition to citing this work, it is encouraged to cite the references to the underlying models used. for that, you can use <a href="api/parameters/#Clapeyron.cite"><code>Clapeyron.cite</code></a> to obtain the references used in a particular model</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="theory/background/">Background »</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.7.0 on <span class="colophon-date" title="Monday 30 September 2024 21:28">Monday 30 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/notebook_examples/index.html

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions dev/properties/basic/index.html

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions dev/properties/bulk/index.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/properties/electrolytes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,26 @@
T = 298.15
m = [1.0]

γ± = mean_ionic_activity_coefficient(model,salts,p,T,m)</code></pre><p>If multiple solvents are present, the composition of the solvent can be specified with the <code>zsolvent</code> keyword argument.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/589656ee001097e8274402b92ebca25999a1cefe/src/methods/property_solvers/electrolytes/mT.jl#L41-L60">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.mean_ionic_activity_coefficient_sat" href="#Clapeyron.mean_ionic_activity_coefficient_sat"><code>Clapeyron.mean_ionic_activity_coefficient_sat</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">mean_ionic_activity_coefficient_sat(model::ESElectrolyteModel,salts,T,m,zsolvent=[1.])</code></pre><p>Calculate the mean ionic activity coefficient of selection of salts at the saturation point at a certain temperature and molality. These are defined as:</p><pre><code class="nohighlight hljs">γ± = φ±/φ±₀ * ∑zsolv/∑z</code></pre><p>Example:</p><pre><code class="language-julia hljs">model = ePCSAFT([&quot;water&quot;],[&quot;sodium&quot;,&quot;chloride&quot;])
γ± = mean_ionic_activity_coefficient(model,salts,p,T,m)</code></pre><p>If multiple solvents are present, the composition of the solvent can be specified with the <code>zsolvent</code> keyword argument.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/c945020ba1fb45b9b25786b84f823fdd8e18840f/src/methods/property_solvers/electrolytes/mT.jl#L41-L60">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.mean_ionic_activity_coefficient_sat" href="#Clapeyron.mean_ionic_activity_coefficient_sat"><code>Clapeyron.mean_ionic_activity_coefficient_sat</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">mean_ionic_activity_coefficient_sat(model::ESElectrolyteModel,salts,T,m,zsolvent=[1.])</code></pre><p>Calculate the mean ionic activity coefficient of selection of salts at the saturation point at a certain temperature and molality. These are defined as:</p><pre><code class="nohighlight hljs">γ± = φ±/φ±₀ * ∑zsolv/∑z</code></pre><p>Example:</p><pre><code class="language-julia hljs">model = ePCSAFT([&quot;water&quot;],[&quot;sodium&quot;,&quot;chloride&quot;])

salts = [(&quot;sodium chloride&quot;,(&quot;sodium&quot;=&gt;1,&quot;chloride&quot;=&gt;1))]

T = 298.15
m = [1.0]

γ± = mean_ionic_activity_coefficient_sat(model,salts,T,m)</code></pre><p>If multiple solvents are present, the composition of the solvent can be specified with the <code>zsolvent</code> keyword argument.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/589656ee001097e8274402b92ebca25999a1cefe/src/methods/property_solvers/electrolytes/mT.jl#L1-L19">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.osmotic_coefficient" href="#Clapeyron.osmotic_coefficient"><code>Clapeyron.osmotic_coefficient</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">osmotic_coefficient(model::ESElectrolyteModel,salts,p,T,m,zsolvent=[1.])</code></pre><p>Calculate the osmotic coefficient of selection of solvents at a given pressure, temperature and molality. These are defined as:</p><pre><code class="nohighlight hljs">ϕ = -1/(∑νi*mi*Mw)*log(asolv)</code></pre><p>Example:</p><pre><code class="language-julia hljs">model = ePCSAFT([&quot;water&quot;],[&quot;sodium&quot;,&quot;chloride&quot;])
γ± = mean_ionic_activity_coefficient_sat(model,salts,T,m)</code></pre><p>If multiple solvents are present, the composition of the solvent can be specified with the <code>zsolvent</code> keyword argument.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/c945020ba1fb45b9b25786b84f823fdd8e18840f/src/methods/property_solvers/electrolytes/mT.jl#L1-L19">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.osmotic_coefficient" href="#Clapeyron.osmotic_coefficient"><code>Clapeyron.osmotic_coefficient</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">osmotic_coefficient(model::ESElectrolyteModel,salts,p,T,m,zsolvent=[1.])</code></pre><p>Calculate the osmotic coefficient of selection of solvents at a given pressure, temperature and molality. These are defined as:</p><pre><code class="nohighlight hljs">ϕ = -1/(∑νi*mi*Mw)*log(asolv)</code></pre><p>Example:</p><pre><code class="language-julia hljs">model = ePCSAFT([&quot;water&quot;],[&quot;sodium&quot;,&quot;chloride&quot;])

salts = [(&quot;sodium chloride&quot;,(&quot;sodium&quot;=&gt;1,&quot;chloride&quot;=&gt;1))]

p = 1e5
T = 298.15
m = [1.0]

ϕ = osmotic_coefficient(model,salts,p,T,m)</code></pre><p>If multiple solvents are present, the composition of the solvent can be specified with the <code>zsolvent</code> keyword argument.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/589656ee001097e8274402b92ebca25999a1cefe/src/methods/property_solvers/electrolytes/mT.jl#L122-L141">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.osmotic_coefficient_sat" href="#Clapeyron.osmotic_coefficient_sat"><code>Clapeyron.osmotic_coefficient_sat</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">osmotic_coefficient_sat(model::ESElectrolyteModel,salts,T,m,zsolvent=[1.])</code></pre><p>Calculate the osmotic coefficient of selection of solvents at the saturation point at a certain temperature and molality. These are defined as:</p><pre><code class="nohighlight hljs">ϕ = -1/(∑νi*mi*Mw)*log(asolv)</code></pre><p>Example:</p><pre><code class="language-julia hljs">model = ePCSAFT([&quot;water&quot;],[&quot;sodium&quot;,&quot;chloride&quot;])
ϕ = osmotic_coefficient(model,salts,p,T,m)</code></pre><p>If multiple solvents are present, the composition of the solvent can be specified with the <code>zsolvent</code> keyword argument.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/c945020ba1fb45b9b25786b84f823fdd8e18840f/src/methods/property_solvers/electrolytes/mT.jl#L122-L141">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.osmotic_coefficient_sat" href="#Clapeyron.osmotic_coefficient_sat"><code>Clapeyron.osmotic_coefficient_sat</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">osmotic_coefficient_sat(model::ESElectrolyteModel,salts,T,m,zsolvent=[1.])</code></pre><p>Calculate the osmotic coefficient of selection of solvents at the saturation point at a certain temperature and molality. These are defined as:</p><pre><code class="nohighlight hljs">ϕ = -1/(∑νi*mi*Mw)*log(asolv)</code></pre><p>Example:</p><pre><code class="language-julia hljs">model = ePCSAFT([&quot;water&quot;],[&quot;sodium&quot;,&quot;chloride&quot;])

salts = [(&quot;sodium chloride&quot;,(&quot;sodium&quot;=&gt;1,&quot;chloride&quot;=&gt;1))]

T = 298.15
m = [1.0]

ϕ = osmotic_coefficient(model,salts,T,m)</code></pre><p>If multiple solvents are present, the composition of the solvent can be specified with the <code>zsolvent</code> keyword argument.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/589656ee001097e8274402b92ebca25999a1cefe/src/methods/property_solvers/electrolytes/mT.jl#L81-L99">source</a></section></article><h2 id="Helper-functions"><a class="docs-heading-anchor" href="#Helper-functions">Helper functions</a><a id="Helper-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Helper-functions" title="Permalink"></a></h2><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.molality_to_composition" href="#Clapeyron.molality_to_composition"><code>Clapeyron.molality_to_composition</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">molality_to_composition(model::ElectrolyteModel,salts,m,zsolv=[1.])</code></pre><p>Convert molality (mol/kg) to composition for a given model, salts, molality, and solvent composition.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/589656ee001097e8274402b92ebca25999a1cefe/src/models/Electrolytes/equations.jl#L24-L28">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../multi/">« Multiphase Properties</a><a class="docs-footer-nextpage" href="../../api/parameters/">Parameters »</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.7.0 on <span class="colophon-date" title="Monday 30 September 2024 18:10">Monday 30 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
ϕ = osmotic_coefficient(model,salts,T,m)</code></pre><p>If multiple solvents are present, the composition of the solvent can be specified with the <code>zsolvent</code> keyword argument.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/c945020ba1fb45b9b25786b84f823fdd8e18840f/src/methods/property_solvers/electrolytes/mT.jl#L81-L99">source</a></section></article><h2 id="Helper-functions"><a class="docs-heading-anchor" href="#Helper-functions">Helper functions</a><a id="Helper-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Helper-functions" title="Permalink"></a></h2><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.molality_to_composition" href="#Clapeyron.molality_to_composition"><code>Clapeyron.molality_to_composition</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">molality_to_composition(model::ElectrolyteModel,salts,m,zsolv=[1.])</code></pre><p>Convert molality (mol/kg) to composition for a given model, salts, molality, and solvent composition.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ClapeyronThermo/Clapeyron.jl/blob/c945020ba1fb45b9b25786b84f823fdd8e18840f/src/models/Electrolytes/equations.jl#L24-L28">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../multi/">« Multiphase Properties</a><a class="docs-footer-nextpage" href="../../api/parameters/">Parameters »</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.7.0 on <span class="colophon-date" title="Monday 30 September 2024 21:28">Monday 30 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
8 changes: 4 additions & 4 deletions dev/properties/multi/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 61ee6e8

Please sign in to comment.