MEDYAN.boundary_box

Tuple{MEDYAN.CubicGrid}

boundary_box(
    grid::MEDYAN.CubicGrid;
    offset,
    stiffness,
    collision_layers,
    no_collide_mask
) -> MEDYAN.Boundary

Return a box boundary at the edge of a grid.

The box boundary has one plane per face of the grid, with normals pointing out of the grid. Each plane acts like boundary_plane.

grid::CubicGrid: The planes sit on the faces of this grid.

offset::Float64=0.0(nm): How far the bounding planes should be moved in from the edge of the grid. Positive is inside the grid, negative is outside the grid.

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

collision_layers::UInt32=UInt32(1): Collision layers bitmask, applied to all six planes.

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

Example

grid = CubicGrid(SA[4, 4, 4], 250.0)
boundary_box(grid; stiffness=100.0)

See also Boundary, set_mech_boundary!