Skip to content

Commit aa7b9e3

Browse files
committed
Update docstring
1 parent 4a934cf commit aa7b9e3

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/nhs_precomputed.jl

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
@doc raw"""
22
PrecomputedNeighborhoodSearch{NDIMS}(; search_radius = 0.0, n_points = 0,
3-
periodic_box = nothing, update_strategy = nothing)
3+
periodic_box = nothing, update_strategy = nothing,
4+
update_neighborhood_search = GridNeighborhoodSearch{NDIMS}(),
5+
backend = DynamicVectorOfVectors{Int32},
6+
max_neighbors = max_neighbors(NDIMS))
47
58
Neighborhood search with precomputed neighbor lists. A list of all neighbors is computed
69
for each point during initialization and update.
@@ -30,6 +33,9 @@ to strip the internal neighborhood search, which is not needed anymore.
3033
- `update_neighborhood_search = GridNeighborhoodSearch{NDIMS}(; periodic_box, update_strategy)`:
3134
The neighborhood search used to compute the neighbor lists.
3235
By default, a [`GridNeighborhoodSearch`](@ref) is used.
36+
If the precomputed NHS is to be used on the GPU, make sure to
37+
either freeze it after initialization and never update it again,
38+
or pass a GPU-compatible neighborhood search here.
3339
- `backend = DynamicVectorOfVectors{Int32}`: Type of the data structure to store
3440
the neighbor lists. Can be
3541
- `Vector{Vector{Int32}}`: Scattered memory, but very memory-efficient.

0 commit comments

Comments
 (0)