Skip to content

Commit 0351767

Browse files
authored
Remove internal use warning for NHS constructors (#4)
1 parent 540505f commit 0351767

File tree

2 files changed

+0
-42
lines changed

2 files changed

+0
-42
lines changed

src/grid_nhs.jl

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -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".

src/trivial_nhs.jl

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,6 @@ internal function `eachneighbor`.
1818
- `periodic_box_max_corner`: In order to use a (rectangular) periodic domain, pass the
1919
coordinates of the domain corner in positive coordinate
2020
directions.
21-
22-
!!! warning "Internal use only"
23-
Please note that this constructor is intended for internal use only. It is *not* part of
24-
the public API of TrixiParticles.jl, and it thus can altered (or be removed) at any time
25-
without it being considered a breaking change.
26-
27-
To run a simulation with this neighborhood search, just pass the type to the constructor
28-
of `Semidiscretization`:
29-
```julia
30-
semi = Semidiscretization(system1, system2,
31-
neighborhood_search=TrivialNeighborhoodSearch)
32-
```
33-
The keyword arguments `periodic_box_min_corner` and `periodic_box_max_corner` explained
34-
above can also be passed to the `Semidiscretization` and will internally be
35-
forwarded to the neighborhood search:
36-
```julia
37-
semi = Semidiscretization(system1, system2,
38-
neighborhood_search=TrivialNeighborhoodSearch,
39-
periodic_box_min_corner=[0.0, -0.25],
40-
periodic_box_max_corner=[1.0, 0.75])
41-
```
4221
"""
4322
struct TrivialNeighborhoodSearch{NDIMS, ELTYPE, EP, PB}
4423
search_radius :: ELTYPE

0 commit comments

Comments
 (0)