Skip to content

Commit dda7c68

Browse files
author
Documenter.jl
committed
build based on 30665a8
1 parent b3e9185 commit dda7c68

19 files changed

Lines changed: 7170 additions & 1045 deletions

julia-docs/dev/docstrings.html

Lines changed: 217 additions & 154 deletions
Large diffs are not rendered by default.

julia-docs/dev/docstrings/medyan.apply_chem_boundary--86fcf1aed37adaf6.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,10 +208,10 @@ <h2 class="anchored" data-anchor-id="tuple-medyan.context--4896731d1a77eb1c"><co
208208
<i class="callout-icon no-icon"></i>
209209
</div>
210210
<div class="callout-body-container">
211-
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">apply_chem_boundary!</span>(c<span class="op">::</span><span class="dt">Context</span>; oversampling_factor<span class="op">::</span><span class="dt">Int</span>=<span class="fl">16</span>)<span class="op">::</span><span class="dt">Nothing</span></span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
211+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">apply_chem_boundary!</span>(c<span class="op">::</span><span class="dt">Context</span>)<span class="op">::</span><span class="dt">Nothing</span></span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
212212
<p>Update chem voxel volumes and diffusion rates.</p>
213213
<p>The chem boundary is the intersection of any boundary set by <a href="../docstrings/medyan.set_chem_boundary--8446b49a230e3146.html"><code>set_chem_boundary!</code></a> and membranes with <code>chem_boundary=true</code>.</p>
214-
<p><code>oversampling_factor</code> can be increased to improve the accuracy at the expense of increased memory use.</p>
214+
<p><a href="../docstrings/medyan.set_chem_boundary_oversampling_factor--dd246eef62c89b5f.html"><code>set_chem_boundary_oversampling_factor!</code></a> can be used to increase the boundary sampling resolution at the expense of increased memory use.</p>
215215
<p>Calling this will invalidate the chem cache.</p>
216216
</div>
217217
</div>

julia-docs/dev/docstrings/medyan.context-736368ed32b08894.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,9 @@ <h2 class="anchored" data-anchor-id="union---b2cfd89fb0d1b9c6"><code data-shortc
259259
<li><p><code>func_membranespeciespotentialenergy::Any</code>: Membrane species potential energy function. See docs on default function for more info.</p></li>
260260
<li><p><code>external_energy_forces!::Any</code>: External energy/force expressions. This should be a mutating function taking a <code>(fc::MEDYAN.ForceContext, vectorized_x)</code>, which adds to <code>fc.forces, fc.energies, and fc.energy</code>. The energy and force must be consistent, and this is not checked. This can be used as ad-hoc solutions to experiment with uncommon forces, such as specifically designed attachments, etc. If this variable is used often, consider moving it into MEDYAN.</p></li>
261261
<li><p><code>chemboundary::MEDYAN.Boundary</code>: chemical boundary, updates compartment volumes and diffusion rates</p></li>
262+
<li><p><code>chem_boundary_oversampling_factor::Int64</code>: Oversampling factor for chem boundary TSDF computation. Default is 4.</p></li>
263+
<li><p><code>chem_boundary_tsdf_max_distance::Float64</code>: Maximum distance for TSDF truncation (nm). Actual max is max(this, 2.5*grid_spacing). Default is 312.5 nm.</p></li>
264+
<li><p><code>chem_boundary_tsdf_cache::Union{Nothing, Array{Float64, 3}}</code>: Cached truncated signed distance field for chem boundary. <code>nothing</code> means cache is invalid.</p></li>
262265
<li><p><code>mechboundary::MEDYAN.Boundary</code>: mechanical boundary</p></li>
263266
<li><p><code>sharedtypedconfigs::MEDYAN.SharedTypedConfigs</code>: Shared configurations stored in type parameters.</p></li>
264267
<li><p><code>validflags::MEDYAN.ValidFlags</code>: Interval system consistency validation flags.</p></li>

julia-docs/dev/docstrings/medyan.get_chem_boundary_grid_spacing-3726877b3aae3a2e.html

Lines changed: 627 additions & 0 deletions
Large diffs are not rendered by default.

julia-docs/dev/docstrings/medyan.get_chem_boundary_oversampling_factor-ceb9b2d946f4fb17.html

Lines changed: 629 additions & 0 deletions
Large diffs are not rendered by default.

julia-docs/dev/docstrings/medyan.get_chem_boundary_tsdf--7c0691ac2b510a3d.html

Lines changed: 629 additions & 0 deletions
Large diffs are not rendered by default.

julia-docs/dev/docstrings/medyan.get_chem_boundary_tsdf_actual_max_distance-387d81e42009c2e5.html

Lines changed: 629 additions & 0 deletions
Large diffs are not rendered by default.

julia-docs/dev/docstrings/medyan.get_chem_boundary_tsdf_max_distance-f1ce8ced1faa2c40.html

Lines changed: 629 additions & 0 deletions
Large diffs are not rendered by default.

julia-docs/dev/docstrings/medyan.is_chem_boundary_tsdf_cache_valid-3823b443227db869.html

Lines changed: 627 additions & 0 deletions
Large diffs are not rendered by default.

julia-docs/dev/docstrings/medyan.is_inside_chem_boundary--1f7c8bf2ac4afb38.html

Lines changed: 635 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)