MEDYAN.boundary_plane

Tuple{}

boundary_plane(
;
    normal,
    point,
    stiffness,
    collision_layers,
    no_collide_mask
) -> MEDYAN.Boundary

Return a plane boundary.

A bead a distance d past the plane has energy 1/2 * stiffness * d^2 and is pushed back along -normal.

normal::SVector{3,Float64}=SA[1.0,0.0,0.0](unit vector): Vector normal to the plane, pointing outside of the boundary.

point::SVector{3,Float64}=SA[0.0,0.0,0.0](nm): Point on the plane.

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

collision_layers::UInt32=UInt32(1): Collision layers bitmask.

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

Example

A floor keeping beads above z = -200 nm:

boundary_plane(; normal=SA[0.0, 0.0, -1.0], point=SA[0.0, 0.0, -200.0], stiffness=100.0)

See also Boundary, set_mech_boundary!