remarks on trixi-framework#18

benchmarks/count_neighbors.jl

@@ -11,6 +11,15 @@ Due to the minimal computational cost, differences between neighborhood search
 implementations are highlighted. On the other hand, this is the least realistic benchmark.
 
 For a computationally heavier benchmark, see [`benchmark_n_body`](@ref).
+
+# Example
+```julia
+    nhs_trivial = TrivialNeighborhoodSearch .......
+
+    ...
+
+    nhs_grid = GridNeighborhoodSearch ....
+```
 """
 function benchmark_count_neighbors(neighborhood_search, coordinates; parallel = true)
     n_neighbors = zeros(Int, size(coordinates, 2))

benchmarks/n_body.jl

@@ -11,6 +11,15 @@ This is a more realistic benchmark for particle-based simulations than
 [`benchmark_count_neighbors`](@ref).
 However, due to the higher computational cost, differences between neighborhood search
 implementations are less pronounced.
+
+# Example
+```julia
+    nhs_trivial = TrivialNeighborhoodSearch .......
+
+    ...
+
+    nhs_grid = GridNeighborhoodSearch ....
+```
 """
 function benchmark_n_body(neighborhood_search, coordinates; parallel = true)
     mass = 1e10 * (rand(size(coordinates, 2)) .+ 1)

benchmarks/plot.jl

@@ -9,7 +9,7 @@ include("../test/point_cloud.jl")
                     seed = 1, perturbation_factor_position = 1.0,
                     parallel = true, title = "")
 
-Run a benchmark for with several neighborhood searches multiple times for increasing numbers
+Run a benchmark with several neighborhood searches multiple times for increasing numbers
 of points and plot the results.
 
 # Arguments
@@ -28,10 +28,16 @@ of points and plot the results.
 - `perturbation_factor_position = 1.0`: Perturb point positions by this factor. A factor of
                                         `1.0` corresponds to points being moved by
                                         a maximum distance of `0.5` along each axis.
+
+# Example
+
+also an example?
 """
 function plot_benchmarks(benchmark, n_points_per_dimension, iterations;
                          parallel = true, title = "",
                          seed = 1, perturbation_factor_position = 1.0)
+    # Is there a reason why this is hard coded? Why not passing custom nhs like `custom_nhs...`?
+    # And then `nameof(typeof(nhs))`
     neighborhood_searches_names = ["TrivialNeighborhoodSearch";;
                                    "GridNeighborhoodSearch";;
                                    "PrecomputedNeighborhoodSearch"]