Skip to content

Commit

Permalink
build based on 34626f4
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 10, 2024
1 parent 73e28d2 commit 3691dee
Show file tree
Hide file tree
Showing 72 changed files with 9,407 additions and 0 deletions.
1 change: 1 addition & 0 deletions previews/PR30/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-10T03:38:29","documenter_version":"1.5.0"}}
37 changes: 37 additions & 0 deletions previews/PR30/Convenience/ExampleElements/index.html
View file

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions previews/PR30/Convenience/LoadHandler/index.html
View file

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions previews/PR30/Convenience/MaterialModelsBase/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Mechanical materials · FerriteAssembly.jl</title><meta name="title" content="Mechanical materials · FerriteAssembly.jl"/><meta property="og:title" content="Mechanical materials · FerriteAssembly.jl"/><meta property="twitter:title" content="Mechanical materials · FerriteAssembly.jl"/><meta name="description" content="Documentation for FerriteAssembly.jl."/><meta property="og:description" content="Documentation for FerriteAssembly.jl."/><meta property="twitter:description" content="Documentation for FerriteAssembly.jl."/><meta property="og:url" content="https://KnutAM.github.io/FerriteAssembly.jl/Convenience/MaterialModelsBase/"/><meta property="twitter:url" content="https://KnutAM.github.io/FerriteAssembly.jl/Convenience/MaterialModelsBase/"/><link rel="canonical" href="https://KnutAM.github.io/FerriteAssembly.jl/Convenience/MaterialModelsBase/"/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">FerriteAssembly.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><input class="collapse-toggle" id="menuitem-2" type="checkbox"/><label class="tocitem" for="menuitem-2"><span class="docs-label">Learning by doing</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><input class="collapse-toggle" id="menuitem-2-1" type="checkbox"/><label class="tocitem" for="menuitem-2-1"><span class="docs-label">Tutorials</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../tutorials/heat_equation/">Heat Equation</a></li><li><a class="tocitem" href="../../tutorials/viscoelasticity/">Viscoelasticity with state variables</a></li><li><a class="tocitem" href="../../tutorials/incompressible_elasticity/">Multiple fields</a></li><li><a class="tocitem" href="../../tutorials/mixed_materials/">Multiple materials</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-2" type="checkbox"/><label class="tocitem" for="menuitem-2-2"><span class="docs-label">How-to</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../howto/threaded_assembly/">Threaded assembly</a></li><li><a class="tocitem" href="../../howto/automatic_differentiation/">Automatic differentiation</a></li><li><a class="tocitem" href="../../howto/local_constraints/">Local constraint application</a></li><li><a class="tocitem" href="../../howto/robin_bc/">Robin boundary conditions</a></li><li><a class="tocitem" href="../../howto/volume_integral/">Volume integration</a></li><li><a class="tocitem" href="../../howto/surface_integral/">Surface integration</a></li></ul></li></ul></li><li><input class="collapse-toggle" id="menuitem-3" type="checkbox" checked/><label class="tocitem" for="menuitem-3"><span class="docs-label">Reference</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../design/">Design</a></li><li><input class="collapse-toggle" id="menuitem-3-2" type="checkbox"/><label class="tocitem" for="menuitem-3-2"><span class="docs-label">DomainBuffers</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../DomainBuffers/Setup/">DomainBuffers</a></li><li><a class="tocitem" href="../../DomainBuffers/StateVariables/">State variables</a></li><li><a class="tocitem" href="../../DomainBuffers/ItemBuffer/">ItemBuffer</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-3-3" type="checkbox"/><label class="tocitem" for="menuitem-3-3"><span class="docs-label">Workers</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../Workers/Workers/">Workers</a></li><li><a class="tocitem" href="../../Workers/Assemblers/">Assemblers</a></li><li><a class="tocitem" href="../../Workers/Integrators/">Integrators</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-3-4" type="checkbox" checked/><label class="tocitem" for="menuitem-3-4"><span class="docs-label">Convenience</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../LoadHandler/">External loads</a></li><li class="is-active"><a class="tocitem" href>Mechanical materials</a></li><li><a class="tocitem" href="../ExampleElements/">Example elements</a></li></ul></li><li><a class="tocitem" href="../../Customization/">Customizations</a></li><li><a class="tocitem" href="../../internals/">Internals</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Reference</a></li><li><a class="is-disabled">Convenience</a></li><li class="is-active"><a href>Mechanical materials</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Mechanical materials</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/KnutAM/FerriteAssembly.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/main/docs/src/Convenience/MaterialModelsBase.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="MaterialModelsBase"><a class="docs-heading-anchor" href="#MaterialModelsBase">MaterialModelsBase</a><a id="MaterialModelsBase-1"></a><a class="docs-heading-anchor-permalink" href="#MaterialModelsBase" title="Permalink"></a></h1><p>For constitutive mechanical behavior following the <a href="https://github.com/KnutAM/MaterialModelsBase.jl"><code>MaterialModelsBase.jl</code></a> interface, <a href="../../Workers/Assemblers/#FerriteAssembly.element_routine!"><code>element_routine!</code></a>, <a href="../../Workers/Assemblers/#FerriteAssembly.element_residual!"><code>element_residual!</code></a>, <a href="../../DomainBuffers/StateVariables/#FerriteAssembly.create_cell_state"><code>create_cell_state</code></a>, and <a href="#FerriteAssembly.allocate_cell_cache-Tuple{MaterialModelsBase.AbstractMaterial, Any}"><code>allocate_cell_cache</code></a> are implemented in <code>FerriteAssembly.jl</code>.</p><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="FerriteAssembly.element_routine!-Tuple{Any, Any, Vector{&lt;:MaterialModelsBase.AbstractMaterialState}, Any, MaterialModelsBase.AbstractMaterial, CellValues, Any}" href="#FerriteAssembly.element_routine!-Tuple{Any, Any, Vector{&lt;:MaterialModelsBase.AbstractMaterialState}, Any, MaterialModelsBase.AbstractMaterial, CellValues, Any}"><code>FerriteAssembly.element_routine!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">FerriteAssembly.element_routine!(
Ke, re, state::Vector{&lt;:MMB.AbstractMaterialState}, ae,
m::MMB.AbstractMaterial, cv::CellValues, buffer)</code></pre><p>Solve the weak form </p><p class="math-container">\[ \int_\Omega [\boldsymbol{\delta u}\otimes\nabla]^\mathrm{sym} : \boldsymbol{\sigma}\ \mathrm{d}\Omega
= \int_\Gamma \boldsymbol{\delta u} \cdot \boldsymbol{t}\ \mathrm{d}\Gamma
+ \int_\Omega \boldsymbol{\delta u} \cdot \boldsymbol{b}\ \mathrm{d}\Omega\]</p><p>where <span>$\sigma$</span> is calculated with the <code>material_response</code> function from <a href="https://github.com/KnutAM/MaterialModelsBase.jl"><code>MaterialModelsBase.jl</code></a>. Note that <code>create_cell_state</code> is already implemented for <code>&lt;:AbstractMaterial</code>. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/34626f4563a522bdfd9f7eada2e4d95a6f270b16/src/Utils/MaterialModelsBase.jl#L3-L17">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="FerriteAssembly.element_residual!-Tuple{Any, Vector{&lt;:MaterialModelsBase.AbstractMaterialState}, Any, MaterialModelsBase.AbstractMaterial, CellValues, Any}" href="#FerriteAssembly.element_residual!-Tuple{Any, Vector{&lt;:MaterialModelsBase.AbstractMaterialState}, Any, MaterialModelsBase.AbstractMaterial, CellValues, Any}"><code>FerriteAssembly.element_residual!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">FerriteAssembly.element_residual!(
re, state::Vector{&lt;:MMB.AbstractMaterialState}, ae,
m::MMB.AbstractMaterial, cv::CellValues, buffer)</code></pre><p>The <code>element_residual!</code> implementation corresponding to the <code>element_routine!</code> implementation for a <code>MaterialModelsBase.AbstractMaterial</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/34626f4563a522bdfd9f7eada2e4d95a6f270b16/src/Utils/MaterialModelsBase.jl#L43-L50">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="FerriteAssembly.create_cell_state-Tuple{MaterialModelsBase.AbstractMaterial, CellValues, Vararg{Any}}" href="#FerriteAssembly.create_cell_state-Tuple{MaterialModelsBase.AbstractMaterial, CellValues, Vararg{Any}}"><code>FerriteAssembly.create_cell_state</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">FerriteAssembly.create_cell_state(m::MMB.AbstractMaterial, cv::CellValues, args...)</code></pre><p>Create a <code>Vector{&lt;:MMM.AbstractMaterialState}</code> where each element is the output from <code>MMB.initial_material_state(m)</code> and the length is the number of quadrature points in <code>cv</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/34626f4563a522bdfd9f7eada2e4d95a6f270b16/src/Utils/MaterialModelsBase.jl#L70-L75">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="FerriteAssembly.allocate_cell_cache-Tuple{MaterialModelsBase.AbstractMaterial, Any}" href="#FerriteAssembly.allocate_cell_cache-Tuple{MaterialModelsBase.AbstractMaterial, Any}"><code>FerriteAssembly.allocate_cell_cache</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">FerriteAssembly.allocate_cell_cache(m::MMB.AbstractMaterial, ::Any)</code></pre><p>Create the material cache defined by the <code>MMB.allocate_material_cache(m)</code> function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/34626f4563a522bdfd9f7eada2e4d95a6f270b16/src/Utils/MaterialModelsBase.jl#L80-L84">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../LoadHandler/">« External loads</a><a class="docs-footer-nextpage" href="../ExampleElements/">Example elements »</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.5.0 on <span class="colophon-date" title="Tuesday 10 September 2024 03:38">Tuesday 10 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 3691dee

Please sign in to comment.