mastrof / bubblebath.jl Goto Github PK

• Introduce a verbose keyword to bubblebath and bubblebath! to turn on/off the info logs
• Improve the info logs by providing more accurate information

@JuliaRegistrator register()

Cubes should be reasonably easy to implement; also cylinders, disks and parallelepipeds should be feasible.
The interface might need to be review a bit but I don't expect it to be a breaking change.

Need to implement functions to output .stl meshes.
ConstructiveGeometry.jl kind of works for this but seems not fully maintained, not sure if it's something that can be relied upon.

Implement functions to generate walkmaps, i.e. a BitArray{D} taking value 0 in the space occupied by spheres, and 1 in free space.
The function should have a signature of the form
walkmap(bath::AbstractVector{Sphere{D}}, resolution::Real, probe_radius::Real=0; boundaries::Symbol=:cut) where D

The resulting walkmap depends on both the resolution of the mesh and a probe_radius.
The probe_radius can be imagined as the radius of a probe that is moving in the bath; the accessible volume of course depends on the radius.

Finally, the boundaries keyword can be used to determine what happens in case there are objects crossing through the domain boundaries. There will be two options: :cut and :wrap.

E.g. non-positive radii, negative or larger-than-1 packing fractions.

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!

In the vein of expanding to more geometrical shapes later on (#11), it might be useful to exploit the geometric primitives from GeometryBasics.jl, instead of writing my own types.

The non in-place bubblebath

function bubblebath( 
     radii::Vector{<:Real}, 
     extent::NTuple{D,Real}; 
     min_distance::Real = 0.0, 
     through_boundaries = false, 
     max_tries = 10000, 
     max_fails = 100 
 )::Vector{Sphere{D}} where D 
     spheres = Sphere{D}[] 
     bubblebath!(spheres, radii, extent;
          min_distance, through_boundaries, max_tries, max_fails
     )
     return spheres
end