Skip to content

Commit

Permalink
build based on f40c81e
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 15, 2023
1 parent 3898b83 commit 30dc660
Show file tree
Hide file tree
Showing 20 changed files with 46 additions and 46 deletions.
10 changes: 5 additions & 5 deletions previews/PR19/Convenience/ExampleElements/index.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions previews/PR19/Convenience/LoadHandler/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
fill!(fext, 0)
apply!(fext, lh, t) # Add contributions to `fext`
...
end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/502a20bf5e620f9fa9145bbd9efbfd28c7dd1a09/src/LoadHandler/LoadHandler.jl#L6-L25">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FerriteAssembly.Neumann" href="#FerriteAssembly.Neumann"><code>FerriteAssembly.Neumann</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Neumann(field_name::Symbol, fv_info::Union{FaceValues,QuadratureRule,Int}, faceset::Set{FaceIndex}, f)</code></pre><p>Define a Neumann contribution with the weak forms according to </p><p class="math-container">\[\int_{\Gamma} f \ \delta u \ \mathrm{d}\Gamma, \quad \text{Scalar fields} \\
end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/f40c81edbbe01de2abe368fab1b5b5c2d3adac06/src/LoadHandler/LoadHandler.jl#L6-L25">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FerriteAssembly.Neumann" href="#FerriteAssembly.Neumann"><code>FerriteAssembly.Neumann</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Neumann(field_name::Symbol, fv_info::Union{FaceValues,QuadratureRule,Int}, faceset::Set{FaceIndex}, f)</code></pre><p>Define a Neumann contribution with the weak forms according to </p><p class="math-container">\[\int_{\Gamma} f \ \delta u \ \mathrm{d}\Gamma, \quad \text{Scalar fields} \\

\int_{\Gamma} \boldsymbol{f} \cdot \boldsymbol{\delta u} \ \mathrm{d}\Gamma,
\quad \text{Vector fields} \]</p><p>where <span>$\Gamma$</span> is the boundary where the contribution is active. <span>$f$</span>, or <span>$\boldsymbol{f}$</span>, is the prescribed Neumann value, defined by a function with signatures</p><p><code>f(x::Vec, t::Real, n::Vec) -&gt; Number</code> (Scalar field)</p><p><code>f(x::Vec, t::Real, n::Vec) -&gt; Vec{dim}</code> (Vector field)</p><p>where <code>x</code> is the spatial position of the current quadrature point, <code>t</code> is the current time, and <code>n</code> is the face normal vector. The remaining input arguments are</p><ul><li><code>fieldname</code> describes the field on which the boundary condition should abstract</li><li><code>fv_info</code> gives required input to determine the facevalues. The following input types are accepted:<ul><li><code>Int</code> giving the integration order to use. <code>FaceValues</code> are deduced from the interpolation of <code>fieldname</code> and the output of <code>f</code>. </li><li><code>QuadratureRule</code> matching the interpolation for <code>fieldname</code> for faces in <code>faceset</code> <code>FaceValues</code> are deduced from the output of <code>f</code></li><li><code>FaceValues</code> matching the interpolation for <code>fieldname</code> for the faces in <code>faceset</code> and output of <code>f</code></li></ul></li><li><code>faceset</code> describes which faces the BC is applied to</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/502a20bf5e620f9fa9145bbd9efbfd28c7dd1a09/src/LoadHandler/Neumann.jl#L1-L30">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FerriteAssembly.BodyLoad" href="#FerriteAssembly.BodyLoad"><code>FerriteAssembly.BodyLoad</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">BodyLoad(field_name::Symbol, cv_info::Union{CellValues,QuadratureRule,Int}, cellset::Set{Int}, f)
\quad \text{Vector fields} \]</p><p>where <span>$\Gamma$</span> is the boundary where the contribution is active. <span>$f$</span>, or <span>$\boldsymbol{f}$</span>, is the prescribed Neumann value, defined by a function with signatures</p><p><code>f(x::Vec, t::Real, n::Vec) -&gt; Number</code> (Scalar field)</p><p><code>f(x::Vec, t::Real, n::Vec) -&gt; Vec{dim}</code> (Vector field)</p><p>where <code>x</code> is the spatial position of the current quadrature point, <code>t</code> is the current time, and <code>n</code> is the face normal vector. The remaining input arguments are</p><ul><li><code>fieldname</code> describes the field on which the boundary condition should abstract</li><li><code>fv_info</code> gives required input to determine the facevalues. The following input types are accepted:<ul><li><code>Int</code> giving the integration order to use. <code>FaceValues</code> are deduced from the interpolation of <code>fieldname</code> and the output of <code>f</code>. </li><li><code>QuadratureRule</code> matching the interpolation for <code>fieldname</code> for faces in <code>faceset</code> <code>FaceValues</code> are deduced from the output of <code>f</code></li><li><code>FaceValues</code> matching the interpolation for <code>fieldname</code> for the faces in <code>faceset</code> and output of <code>f</code></li></ul></li><li><code>faceset</code> describes which faces the BC is applied to</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/f40c81edbbe01de2abe368fab1b5b5c2d3adac06/src/LoadHandler/Neumann.jl#L1-L30">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FerriteAssembly.BodyLoad" href="#FerriteAssembly.BodyLoad"><code>FerriteAssembly.BodyLoad</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">BodyLoad(field_name::Symbol, cv_info::Union{CellValues,QuadratureRule,Int}, cellset::Set{Int}, f)
BodyLoad(field_name::Symbol, cv_info::Union{CellValues,QuadratureRule,Int}, f)</code></pre><p>Define a body load contribution with the weak forms according to </p><p class="math-container">\[\int_{\Omega} f \ \delta u \ \mathrm{d}\Omega, \quad \text{Scalar fields} \\

\int_{\Omega} \boldsymbol{f} \cdot \boldsymbol{\delta u} \ \mathrm{d}\Omega,
\quad \text{Vector fields} \]</p><p>where <span>$\Omega$</span> is the region where the contribution is active. <span>$f$</span>, or <span>$\boldsymbol{f}$</span>, is the prescribed volumetric contribution (e.g. force/volume), defined by a function with signatures</p><p><code>f(x::Vec, t::Real) -&gt; Number</code> (Scalar field)</p><p><code>f(x::Vec, t::Real) -&gt; Vec{dim}</code> (Vector field)</p><p>where <code>x</code> is the spatial position of the current quadrature point and <code>t</code> is the current time. The remaining input arguments are</p><ul><li><p><code>fieldname</code> describes the field on which the load should act</p></li><li><p><code>cv_info</code> gives required input to determine the cellvalues. The following input types are accepted:</p><ul><li><code>Int</code> giving the integration order to use. <code>CellValues</code> are deduced from the interpolation of <code>fieldname</code> and the output of <code>f</code>. </li><li><code>QuadratureRule</code> matching the interpolation for <code>fieldname</code> for cells in <code>cellset</code>. <code>CellValues</code> are deduced from the output of <code>f</code></li><li><code>CellValues</code> matching the interpolation for <code>fieldname</code> for the cells in <code>cellset</code> and output of <code>f</code></li></ul></li><li><p><code>cellset</code> describes which cells the load is applied to. If not given, the load is applied to all cells </p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/502a20bf5e620f9fa9145bbd9efbfd28c7dd1a09/src/LoadHandler/BodyLoad.jl#L1-L32">source</a></section></article><pre><code class="nohighlight hljs"></code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../Workers/Integrators/">« Integrators</a><a class="docs-footer-nextpage" href="../MaterialModelsBase/">Mechanical materials »</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="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 0.27.24 on <span class="colophon-date" title="Tuesday 15 August 2023 12:29">Tuesday 15 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
\quad \text{Vector fields} \]</p><p>where <span>$\Omega$</span> is the region where the contribution is active. <span>$f$</span>, or <span>$\boldsymbol{f}$</span>, is the prescribed volumetric contribution (e.g. force/volume), defined by a function with signatures</p><p><code>f(x::Vec, t::Real) -&gt; Number</code> (Scalar field)</p><p><code>f(x::Vec, t::Real) -&gt; Vec{dim}</code> (Vector field)</p><p>where <code>x</code> is the spatial position of the current quadrature point and <code>t</code> is the current time. The remaining input arguments are</p><ul><li><p><code>fieldname</code> describes the field on which the load should act</p></li><li><p><code>cv_info</code> gives required input to determine the cellvalues. The following input types are accepted:</p><ul><li><code>Int</code> giving the integration order to use. <code>CellValues</code> are deduced from the interpolation of <code>fieldname</code> and the output of <code>f</code>. </li><li><code>QuadratureRule</code> matching the interpolation for <code>fieldname</code> for cells in <code>cellset</code>. <code>CellValues</code> are deduced from the output of <code>f</code></li><li><code>CellValues</code> matching the interpolation for <code>fieldname</code> for the cells in <code>cellset</code> and output of <code>f</code></li></ul></li><li><p><code>cellset</code> describes which cells the load is applied to. If not given, the load is applied to all cells </p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KnutAM/FerriteAssembly.jl/blob/f40c81edbbe01de2abe368fab1b5b5c2d3adac06/src/LoadHandler/BodyLoad.jl#L1-L32">source</a></section></article><pre><code class="nohighlight hljs"></code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../Workers/Integrators/">« Integrators</a><a class="docs-footer-nextpage" href="../MaterialModelsBase/">Mechanical materials »</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="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 0.27.24 on <span class="colophon-date" title="Tuesday 15 August 2023 12:57">Tuesday 15 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 30dc660

Please sign in to comment.