@@ -38,27 +38,6 @@ since not sorting makes our implementation a lot faster (although less paralleli
3838 This can be one of the largest sources of variations between simulations
3939 with different thread numbers due to particle ordering changes.
4040
41- !!! warning "Internal use only"
42- Please note that this constructor is intended for internal use only. It is *not* part of
43- the public API of TrixiParticles.jl, and it thus can altered (or be removed) at any time
44- without it being considered a breaking change.
45-
46- To run a simulation with this neighborhood search, just pass the type to the constructor
47- of `Semidiscretization`:
48- ```julia
49- semi = Semidiscretization(system1, system2,
50- neighborhood_search=GridNeighborhoodSearch)
51- ```
52- The keyword arguments `periodic_box_min_corner` and `periodic_box_max_corner` explained
53- above can also be passed to the `Semidiscretization` and will internally be
54- forwarded to the neighborhood search:
55- ```julia
56- semi = Semidiscretization(system1, system2,
57- neighborhood_search=GridNeighborhoodSearch,
58- periodic_box_min_corner=[0.0, -0.25],
59- periodic_box_max_corner=[1.0, 0.75])
60- ```
61-
6241## References
6342- M. Chalela, E. Sillero, L. Pereyra, M.A. Garcia, J.B. Cabral, M. Lares, M. Merchán.
6443 "GriSPy: A Python package for fixed-radius nearest neighbors search".
0 commit comments