build based on b45a6fd

kaipartmann · Feb 13, 2025 · f375a0e · f375a0e
1 parent b0a9464
commit f375a0e
Show file tree

Hide file tree

Showing 28 changed files with 78 additions and 80 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-03T09:41:55","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-02-13T09:32:02","documenter_version":"1.8.1"}}
diff --git a/dev/expl_bondbased/index.html b/dev/expl_bondbased/index.html
diff --git a/dev/expl_continuumbased/index.html b/dev/expl_continuumbased/index.html
diff --git a/dev/expl_damage/index.html b/dev/expl_damage/index.html
diff --git a/dev/expl_general_pd/index.html b/dev/expl_general_pd/index.html
diff --git a/dev/expl_nosbased/index.html b/dev/expl_nosbased/index.html
diff --git a/dev/expl_osbased/index.html b/dev/expl_osbased/index.html
diff --git a/dev/expl_references/index.html b/dev/expl_references/index.html
diff --git a/dev/generated/tutorial_brazilian_test/index.html b/dev/generated/tutorial_brazilian_test/index.html
diff --git a/dev/generated/tutorial_cylinder/index.html b/dev/generated/tutorial_cylinder/index.html
diff --git a/dev/generated/tutorial_kalthoff-winkler_dynfrac/index.html b/dev/generated/tutorial_kalthoff-winkler_dynfrac/index.html
diff --git a/dev/generated/tutorial_logo/index.html b/dev/generated/tutorial_logo/index.html
diff --git a/dev/generated/tutorial_tension_dynfrac/index.html b/dev/generated/tutorial_tension_dynfrac/index.html
diff --git a/dev/generated/tutorial_tension_precrack/index.html b/dev/generated/tutorial_tension_precrack/index.html
diff --git a/dev/generated/tutorial_tension_static/index.html b/dev/generated/tutorial_tension_static/index.html
diff --git a/dev/generated/tutorial_wave_in_bar/index.html b/dev/generated/tutorial_wave_in_bar/index.html
diff --git a/dev/generated/tutorial_wave_interface/index.html b/dev/generated/tutorial_wave_interface/index.html
diff --git a/dev/howto_mpi/index.html b/dev/howto_mpi/index.html
diff --git a/dev/howto_visualization/index.html b/dev/howto_visualization/index.html
diff --git a/dev/index.html b/dev/index.html
diff --git a/dev/literate/tutorial_kalthoff-winkler_dynfrac.jl b/dev/literate/tutorial_kalthoff-winkler_dynfrac.jl
@@ -68,7 +68,7 @@ velocity_bc!(t -> t < 0.0001 ? -32.0 : NaN, body, :set_top, :y)
 
 # A layer of 3 points at the uncracked boundary is not allowed to obtain failure.
 point_set!(y -> y < -w / 2 + 3Δx, body, :no_fail_zone)
-failure_permit!(body, :no_fail_zone, false)
+no_failure!(body, :no_fail_zone)
 
 # ## Simulation
 #

diff --git a/dev/literate/tutorial_tension_static.jl b/dev/literate/tutorial_tension_static.jl
@@ -37,7 +37,7 @@ forcedensity_bc!(t -> 3e11, body, :top, 1)
 
 #-
 # Do not allow failure in the entire body:
-failure_permit!(body, false)
+no_failure!(body)
 
 #-
 # We set the number of time steps for the dynamic relaxation algorithm to 500 time steps.

diff --git a/dev/literate/tutorial_wave_in_bar.jl b/dev/literate/tutorial_wave_in_bar.jl
@@ -22,8 +22,6 @@ npyz = 4
 # and point spacing is then created:
 pos, vol = uniform_box(lx, lyz, lyz, Δx)
 body = Body(OSBMaterial(), pos, vol)
-# Failure is prohibited throughout the body:
-failure_permit!(body, false)
 # Following material parameters are specified:
 
 # | material parameter | value |
@@ -32,8 +30,8 @@ failure_permit!(body, false)
 # | Density $ρ$ | $ 7850\,\mathrm{kg}\,\mathrm{m}^{-3}$ |
 # | Young's modulus $E$ | $ 210 \, \mathrm{GPa}$ |
 # | Poisson's ratio $ν$ | $0.25$ |
-# | critical strain $ε_c$ | $0.01$ |
-material!(body, horizon=3.015Δx, rho=7850.0, E=210e9, nu=0.25, epsilon_c=0.01)
+material!(body, horizon=3.015Δx, rho=7850.0, E=210e9, nu=0.25)
+# Failure is prohibited throughout the body since no fracture parameters are defined.
 # Point set `:left` including the first row of points in x-direction is created:
 point_set!(x -> x < -lx / 2 + 1.2Δx, body, :left)
 # The velocity boundary condition of the form

diff --git a/dev/literate/tutorial_wave_interface.jl b/dev/literate/tutorial_wave_interface.jl
@@ -20,18 +20,16 @@ npyz = 4
 # correspondence formulation.
 pos, vol = uniform_box(lx, lyz, lyz, Δx)
 body = Body(NOSBMaterial(), pos, vol)
-# Again, failure is not allowed in the whole body.
-failure_permit!(body, false)
 
 # Then the material parameters for one half of the body are assigned to the whole body
 # first.
-material!(body, horizon=3.015Δx, rho=7850.0, E=210e9, nu=0.25, epsilon_c=0.01)
+material!(body, horizon=3.015Δx, rho=7850.0, E=210e9, nu=0.25)
 
 # Now a point set containing the other half of all points is created.
 point_set!(x -> x < 0, body, :set1)
 # ![](https://github.com/user-attachments/assets/c589ab03-e7f5-4b71-b0c2-0f05eb3cdddc)
 # The parameters for this point set are then overwritten with their new parameters.
-material!(body, :set1, horizon=3.015Δx, rho=7850.0, E=105e9, nu=0.25, epsilon_c=0.01)
+material!(body, :set1, horizon=3.015Δx, rho=7850.0, E=105e9, nu=0.25)
 
 # Except for the Young's modulus, these are the same in both sections:
 #
@@ -42,8 +40,8 @@ material!(body, :set1, horizon=3.015Δx, rho=7850.0, E=105e9, nu=0.25, epsilon_c
 # | Young's modulus $E_I$ | $ 105 \, \mathrm{GPa}$ |
 # | Young's modulus $E_{II}$ | $ 210 \, \mathrm{GPa}$ |
 # | Poisson's ratio $ν$ | $0.25$ |
-# | critical strain $ε_c$ | $0.01$ |
 
+# Again, failure is not allowed in the whole body since no fracture parameters are specified.
 
 # To employ the boundary conditions creating a displacement wave, the point set `:left` is
 # created:

diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/private_api_reference/index.html b/dev/private_api_reference/index.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Private API · Peridynamics.jl</title><meta name="title" content="Private API · Peridynamics.jl"/><meta property="og:title" content="Private API · Peridynamics.jl"/><meta property="twitter:title" content="Private API · Peridynamics.jl"/><meta name="description" content="Documentation for Peridynamics.jl."/><meta property="og:description" content="Documentation for Peridynamics.jl."/><meta property="twitter:description" content="Documentation for Peridynamics.jl."/><meta property="og:url" content="https://kaipartmann.github.io/Peridynamics.jl/private_api_reference/"/><meta property="twitter:url" content="https://kaipartmann.github.io/Peridynamics.jl/private_api_reference/"/><link rel="canonical" href="https://kaipartmann.github.io/Peridynamics.jl/private_api_reference/"/><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><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="Peridynamics.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Peridynamics.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">Explanations</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../expl_general_pd/">Basics of peridynamics theory</a></li><li><a class="tocitem" href="../expl_bondbased/">Bond-based peridynamics</a></li><li><a class="tocitem" href="../expl_osbased/">Ordinary state-based peridynamics</a></li><li><a class="tocitem" href="../expl_nosbased/">Non-ordinary state-based peridynamics</a></li><li><a class="tocitem" href="../expl_continuumbased/">Continuum-kinematics-inspired peridynamics</a></li><li><a class="tocitem" href="../expl_damage/">Damage in peridynamics formulations</a></li><li><a class="tocitem" href="../expl_references/">References</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-3" type="checkbox"/><label class="tocitem" for="menuitem-3"><span class="docs-label">How-to guides</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../howto_mpi/">Simulations with MPI</a></li><li><a class="tocitem" href="../howto_visualization/">Visualization with ParaView</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4" type="checkbox"/><label class="tocitem" for="menuitem-4"><span class="docs-label">Tutorials</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../generated/tutorial_tension_static/">Tensile test quasi-static</a></li><li><a class="tocitem" href="../generated/tutorial_tension_dynfrac/">Tensile test dynamic</a></li><li><a class="tocitem" href="../generated/tutorial_tension_precrack/">Tension with predefined crack</a></li><li><a class="tocitem" href="../generated/tutorial_wave_in_bar/">Wave propagation in a thin bar</a></li><li><a class="tocitem" href="../generated/tutorial_wave_interface/">Wave propagation across material interface</a></li><li><a class="tocitem" href="../generated/tutorial_kalthoff-winkler_dynfrac/">Kalthoff-Winkler experiment</a></li><li><a class="tocitem" href="../generated/tutorial_logo/">The old Peridynamics.jl logo</a></li><li><a class="tocitem" href="../generated/tutorial_cylinder/">Fragmenting Cylinder</a></li><li><a class="tocitem" href="../generated/tutorial_brazilian_test/">Brazilian Test</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-5" type="checkbox" checked/><label class="tocitem" for="menuitem-5"><span class="docs-label">API Reference</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../public_api_reference/">Public API</a></li><li class="is-active"><a class="tocitem" href>Private API</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">API Reference</a></li><li class="is-active"><a href>Private API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Private API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/kaipartmann/Peridynamics.jl/blob/main/docs/src/private_api_reference.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="Private-API"><a class="docs-heading-anchor" href="#Private-API">Private API</a><a id="Private-API-1"></a><a class="docs-heading-anchor-permalink" href="#Private-API" title="Permalink"></a></h1><ul><li><a href="#Private-API">Private API</a></li></ul><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="Peridynamics.failure_permit!" href="#Peridynamics.failure_permit!"><code>Peridynamics.failure_permit!</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">failure_permit!(body, set_name, fail_permit)</code></pre><p>Set the failure permission for points of the set <code>set_name</code> of a <code>body</code>.</p><p><strong>Arguments</strong></p><ul><li><code>body::AbstractBody</code>: <a href="../public_api_reference/#Peridynamics.Body"><code>Body</code></a> where the failure permission will be set.</li><li><code>set_name::Symbol</code>: The name of a point set of this body.</li><li><code>fail_permit::Bool</code>: If <code>true</code>, failure is allowed, and if <code>false</code> then no bonds of this   point are allowed to break during the simulation.</li></ul><div class="admonition is-danger"><header class="admonition-header">Overwriting failure permission with `material!` and `failure_permit!`</header><div class="admonition-body"><p>The function <code>material!</code> calls <code>failure_permit!</code>, so if it is used afterwards, previously set failure permissions might be overwritten!</p></div></div><p><strong>Throws</strong></p><ul><li>Error if the body does not contain a set with <code>set_name</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/kaipartmann/Peridynamics.jl/blob/b45a6fd7c0588848f1d3a0d6049baf86afce5052/src/physics/fracture.jl#L3-L24">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../public_api_reference/">« Public 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><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.8.1 on <span class="colophon-date" title="Thursday 13 February 2025 09:32">Thursday 13 February 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-03T09:41:55","documenter_version":"1.8.0"}}
		{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-02-13T09:32:02","documenter_version":"1.8.1"}}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		<!DOCTYPE html>
		<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Private API · Peridynamics.jl</title><meta name="title" content="Private API · Peridynamics.jl"/><meta property="og:title" content="Private API · Peridynamics.jl"/><meta property="twitter:title" content="Private API · Peridynamics.jl"/><meta name="description" content="Documentation for Peridynamics.jl."/><meta property="og:description" content="Documentation for Peridynamics.jl."/><meta property="twitter:description" content="Documentation for Peridynamics.jl."/><meta property="og:url" content="https://kaipartmann.github.io/Peridynamics.jl/private_api_reference/"/><meta property="twitter:url" content="https://kaipartmann.github.io/Peridynamics.jl/private_api_reference/"/><link rel="canonical" href="https://kaipartmann.github.io/Peridynamics.jl/private_api_reference/"/><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><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="Peridynamics.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Peridynamics.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">Explanations</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../expl_general_pd/">Basics of peridynamics theory</a></li><li><a class="tocitem" href="../expl_bondbased/">Bond-based peridynamics</a></li><li><a class="tocitem" href="../expl_osbased/">Ordinary state-based peridynamics</a></li><li><a class="tocitem" href="../expl_nosbased/">Non-ordinary state-based peridynamics</a></li><li><a class="tocitem" href="../expl_continuumbased/">Continuum-kinematics-inspired peridynamics</a></li><li><a class="tocitem" href="../expl_damage/">Damage in peridynamics formulations</a></li><li><a class="tocitem" href="../expl_references/">References</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-3" type="checkbox"/><label class="tocitem" for="menuitem-3"><span class="docs-label">How-to guides</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../howto_mpi/">Simulations with MPI</a></li><li><a class="tocitem" href="../howto_visualization/">Visualization with ParaView</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4" type="checkbox"/><label class="tocitem" for="menuitem-4"><span class="docs-label">Tutorials</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../generated/tutorial_tension_static/">Tensile test quasi-static</a></li><li><a class="tocitem" href="../generated/tutorial_tension_dynfrac/">Tensile test dynamic</a></li><li><a class="tocitem" href="../generated/tutorial_tension_precrack/">Tension with predefined crack</a></li><li><a class="tocitem" href="../generated/tutorial_wave_in_bar/">Wave propagation in a thin bar</a></li><li><a class="tocitem" href="../generated/tutorial_wave_interface/">Wave propagation across material interface</a></li><li><a class="tocitem" href="../generated/tutorial_kalthoff-winkler_dynfrac/">Kalthoff-Winkler experiment</a></li><li><a class="tocitem" href="../generated/tutorial_logo/">The old Peridynamics.jl logo</a></li><li><a class="tocitem" href="../generated/tutorial_cylinder/">Fragmenting Cylinder</a></li><li><a class="tocitem" href="../generated/tutorial_brazilian_test/">Brazilian Test</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-5" type="checkbox" checked/><label class="tocitem" for="menuitem-5"><span class="docs-label">API Reference</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../public_api_reference/">Public API</a></li><li class="is-active"><a class="tocitem" href>Private API</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">API Reference</a></li><li class="is-active"><a href>Private API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Private API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/kaipartmann/Peridynamics.jl/blob/main/docs/src/private_api_reference.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="Private-API"><a class="docs-heading-anchor" href="#Private-API">Private API</a><a id="Private-API-1"></a><a class="docs-heading-anchor-permalink" href="#Private-API" title="Permalink"></a></h1><ul><li><a href="#Private-API">Private API</a></li></ul><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="Peridynamics.failure_permit!" href="#Peridynamics.failure_permit!"><code>Peridynamics.failure_permit!</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">failure_permit!(body, set_name, fail_permit)</code></pre><p>Set the failure permission for points of the set <code>set_name</code> of a <code>body</code>.</p><p><strong>Arguments</strong></p><ul><li><code>body::AbstractBody</code>: <a href="../public_api_reference/#Peridynamics.Body"><code>Body</code></a> where the failure permission will be set.</li><li><code>set_name::Symbol</code>: The name of a point set of this body.</li><li><code>fail_permit::Bool</code>: If <code>true</code>, failure is allowed, and if <code>false</code> then no bonds of this point are allowed to break during the simulation.</li></ul><div class="admonition is-danger"><header class="admonition-header">Overwriting failure permission with `material!` and `failure_permit!`</header><div class="admonition-body"><p>The function <code>material!</code> calls <code>failure_permit!</code>, so if it is used afterwards, previously set failure permissions might be overwritten!</p></div></div><p><strong>Throws</strong></p><ul><li>Error if the body does not contain a set with <code>set_name</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/kaipartmann/Peridynamics.jl/blob/b45a6fd7c0588848f1d3a0d6049baf86afce5052/src/physics/fracture.jl#L3-L24">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../public_api_reference/">« Public 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><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.8.1 on <span class="colophon-date" title="Thursday 13 February 2025 09:32">Thursday 13 February 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>