Skip to content

Commit dd166e7

Browse files
author
Documenter.jl
committed
build based on a8ec9f4
1 parent 6913c67 commit dd166e7

23 files changed

Lines changed: 5314 additions & 1824 deletions

julia-docs/dev/docstrings.html

Lines changed: 181 additions & 146 deletions
Large diffs are not rendered by default.

julia-docs/dev/docstrings/medyan.ballidx-5a4aba766d557d6a.html

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

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@ <h2 class="anchored" data-anchor-id="union---b2cfd89fb0d1b9c6"><code data-shortc
222222
<li><p><code>min_compartment_volume_ratio::Float64</code>: Smallest volume a compartment can have before being deactivated as a ratio to a full compartment volume.</p></li>
223223
<li><p><code>chemistryengine::MEDYAN.RDMESampler</code>: The reaction diffusion master equation sampler, contains the diffusing and regular fixed species state</p></li>
224224
<li><p><code>chem_cylinders::Vector{MEDYAN.ChemCylinders}</code>: Data about filament cylinders, indexed by filament type id</p></li>
225+
<li><p><code>balls::StructArrays.StructVector{MEDYAN.Ball, @NamedTuple{position::Vector{StaticArraysCore.SVector{3, Float64}}, radius::Vector{Float32}, stiffness::Vector{Float32}, state::Vector{StaticArraysCore.SVector{3, Int64}}}, Int64}</code></p></li>
225226
<li><p><code>membranes::Vector</code>: All membrane meshes.</p></li>
226227
<li><p><code>link_manager::MEDYAN.LinkManager</code></p></li>
227228
<li><p><code>decimated_2mon_site_managers::Vector{MEDYAN.AbstractDecimated2MonSiteManager}</code>: Site managers, indexed by site id</p></li>
@@ -244,17 +245,15 @@ <h2 class="anchored" data-anchor-id="union---b2cfd89fb0d1b9c6"><code data-shortc
244245
<li><p><code>shake_before_minimization::Float64</code>: Standard deviation of noise added to coordinates before starting minimization.</p></li>
245246
<li><p><code>iter_max_cg_minimization::Int64</code>: Max number of steps in conjugate gradient minimization.</p></li>
246247
<li><p><code>maxstep::Float64</code>: max step to take during line search (nm)</p></li>
247-
<li><p><code>max_cylinder_force::Float64</code>: max cylinder force when two cylinders are at zero distance (pN)</p></li>
248248
<li><p><code>check_neighborlist_error::Bool</code>: If true neighborlists are checked for errors on every force calc. This is extremely slow, but useful for testing neighborlist errors.</p></li>
249249
<li><p><code>nthreads::Int64</code>: Experimental Set to more than 1 to enable multi threading. This is currently may result in non bitwise reproducable simulations. Results should be statistcally identical, but this is currently not well tested.</p></li>
250-
<li><p><code>enable_cylinder_volume_exclusion::Ref{Bool}</code>: Are cylinder volume exclusion forces calculated</p></li>
251-
<li><p><code>enable_triangle_bead_volume_exclusion::Bool</code>: Are triangle-bead volume exclusion forces calculated.</p></li>
252-
<li><p><code>cylinder_skin_radius::Float64</code>: Extra cell list cutoff radius in nm. The cell lists are reset after a bead moves over this amount</p></li>
250+
<li><p><code>enable_collision::Ref{Bool}</code>: Are collision forces calculated</p></li>
251+
<li><p><code>collision_skin::Float64</code>: Extra collision neighbor list cutoff radius in nm. The neighbor lists are reset after something moves over this amount</p></li>
252+
<li><p><code>collision_switchover_scale_unitless::Float32</code>: Smoothing scale to avoid sharp forces when two cylinders are collinear</p></li>
253253
<li><p><code>filamentmechparams::Vector{MEDYAN.FilamentMechParams}</code>: The filament mechanical parameters, indexed by filament type id</p></li>
254254
<li><p><code>membranemechparams::Vector{MEDYAN.MembraneMechParams}</code>: Membrane mechanical parameters, indexed by membrane type id.</p></li>
255255
<li><p><code>func_membranespeciespotentialenergy::Any</code>: Membrane species potential energy function. See docs on default function for more info.</p></li>
256-
<li><p><code>membranefilamentmechparams::MEDYAN.MembraneFilamentMechParams</code>: Membrane-filament mechanical interaction parameters.</p></li>
257-
<li><p><code>external_energy_forces!::Any</code>: External energy/force expressions. This should be a mutating function taking a <code>(fc::MEDYAN.ForceContext)</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>
256+
<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>
258257
<li><p><code>chemboundary::MEDYAN.Boundary</code>: chemical boundary, updates compartment volumes and diffusion rates</p></li>
259258
<li><p><code>meshindex_as_chemboundary::Ref{Int64}</code>: The membrane index used as chemical boundary. If values other than 0 is used, the actual interior region of the chemical boundary is the intersection between</p>
260259
<ul>

0 commit comments

Comments
 (0)