build based on c9aa756

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-16T13:59:56","documenter_version":"1.3.0"}}
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-16T14:01:16","documenter_version":"1.3.0"}}

dev/API/index.html

@@ -173,4 +173,4 @@
 </code></pre><p>Returns a tuple of the parameter bounds provided the experimental data and model</p><p><strong>Arguments:</strong></p><ul><li><code>ψ::AbstractHyperelasticModel</code>: Hyperelastic model</li><li><code>test</code> or <code>tests</code>: The test or vector of tests to use in finding the parameter bounds.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TRACER-LULab/Hyperelastics.jl/blob/c9aa756d0a7be74ed9a726fe1b5d9a88e9aab5b6/src/model_functions.jl#L15">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="Hyperelastics.parameters-Tuple{Hyperelastics.AbstractHyperelasticModel}" href="#Hyperelastics.parameters-Tuple{Hyperelastics.AbstractHyperelasticModel}"><code>Hyperelastics.parameters</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">parameters(
     ψ::Hyperelastics.AbstractHyperelasticModel
 ) -&gt; NTuple{4, Symbol}
-</code></pre><p>Returns a tuple of the parameters required for the model</p><p><strong>Arguments:</strong></p><ul><li><code>ψ::AbstractHyperelasticModel</code>: Hyperelastics model</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TRACER-LULab/Hyperelastics.jl/blob/c9aa756d0a7be74ed9a726fe1b5d9a88e9aab5b6/src/model_functions.jl#L1">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../example/">Example »</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.3.0 on <span class="colophon-date" title="Saturday 16 March 2024 13:59">Saturday 16 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p>Returns a tuple of the parameters required for the model</p><p><strong>Arguments:</strong></p><ul><li><code>ψ::AbstractHyperelasticModel</code>: Hyperelastics model</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TRACER-LULab/Hyperelastics.jl/blob/c9aa756d0a7be74ed9a726fe1b5d9a88e9aab5b6/src/model_functions.jl#L1">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../example/">Example »</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.3.0 on <span class="colophon-date" title="Saturday 16 March 2024 14:01">Saturday 16 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/example/index.html

@@ -20,7 +20,7 @@
 p = (μ = 10.0, )
 W = StrainEnergyDensity(ψ, λ⃗, p)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">10.0</code></pre><p>or</p><pre><code class="language-julia hljs">F = rand(3,3)
 p = (μ = 20.0, )
-W = StrainEnergyDensity(ψ, F, p)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">9.627857055342774</code></pre><p>A method for creating an <code>OptimizationProblem</code> compatible with <code>Optimization.jl</code> is provided. To fit the NeoHookean model to the Treloar data previously loaded, an additional field-indexed array is used as the initial guess to <code>HyperelasticProblem</code>. It is recommendedto use ComponentArrays.jl for optimization of model parameters.</p><pre><code class="language-julia hljs">prob = HyperelasticProblem(ψ, treloar_data, ComponentVector(μ = 0.2), ad_type = AutoForwardDiff())
+W = StrainEnergyDensity(ψ, F, p)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">-1.4336442383612358</code></pre><p>A method for creating an <code>OptimizationProblem</code> compatible with <code>Optimization.jl</code> is provided. To fit the NeoHookean model to the Treloar data previously loaded, an additional field-indexed array is used as the initial guess to <code>HyperelasticProblem</code>. It is recommendedto use ComponentArrays.jl for optimization of model parameters.</p><pre><code class="language-julia hljs">prob = HyperelasticProblem(ψ, treloar_data, ComponentVector(μ = 0.2), ad_type = AutoForwardDiff())
 sol = solve(prob, LBFGS())</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">retcode: Success
 u: ComponentVector{Float64}(μ = 0.5665481963398753)</code></pre><p>For fiting multiple models to the same dataset, </p><pre><code class="language-julia hljs">models = Dict(
     Gent =&gt; ComponentVector(μ=240e-3, J_m=80.0),
@@ -72,4 +72,4 @@
         color = :black
     )
 axislegend(position = :lt)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">CairoMakie.Screen{IMAGE}
-</code></pre><p><img src="../sussman_bathe.png" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../API/">« API</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.3.0 on <span class="colophon-date" title="Saturday 16 March 2024 13:59">Saturday 16 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p><img src="../sussman_bathe.png" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../API/">« API</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.3.0 on <span class="colophon-date" title="Saturday 16 March 2024 14:01">Saturday 16 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>