MEDYAN.boundary_cylinder

Tuple{}

boundary_cylinder(
;
    axis,
    radius,
    center,
    stiffness,
    collision_layers,
    no_collide_mask
)

Return a cylinder boundary.

The domain is the inside of the cylinder. The cylinder boundary is a boundary_capsule for the curved wall and a boundary_plane at each end.

axis::SVector{3,Float64}(nm): The direction and length of the cylinder. Must be nonzero. The spine line segment goes from center - axis/2 to center + axis/2, so the full length of the cylinder is norm(axis).

radius::Float64(nm): Radius of cylinder. Must be nonnegative.

center::SVector{3,Float64}=SA[0.0,0.0,0.0](nm): The center of the cylinder.

stiffness::Float64=1.0(pN/nm): How strong the boundary is.

collision_layers::UInt32=UInt32(1): Collision layers bitmask, applied to the capsule and both end planes.

no_collide_mask::UInt32=UInt32(0): No-collide mask bitmask. Bits set = layers this cylinder will not collide with. The default collides with everything. See the “Collision Layers and No-Collide Masks” explanation page.

Example

A tube along z, 1000 nm long and 200 nm across:

boundary_cylinder(; axis=SA[0.0, 0.0, 1000.0], radius=100.0, stiffness=100.0)

See also Boundary, set_mech_boundary!