Skip to content

Commit

Permalink
Remove failing doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
efaulhaber committed May 4, 2024
1 parent 5a5ebf8 commit 5583a9c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 44 deletions.
24 changes: 2 additions & 22 deletions src/grid_nhs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -45,38 +45,18 @@ since not sorting makes our implementation a lot faster (although less paralleli
To run a simulation with this neighborhood search, just pass the type to the constructor
of [`Semidiscretization`](@ref):
```jldoctest semi_example; output=false, setup = :(trixi_include(@__MODULE__, joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"), sol=nothing); system1 = fluid_system; system2 = boundary_system)
```julia
semi = Semidiscretization(system1, system2,
neighborhood_search=GridNeighborhoodSearch)
# output
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Semidiscretization │
│ ══════════════════ │
│ #spatial dimensions: ………………………… 2 │
│ #systems: ……………………………………………………… 2 │
│ neighborhood search: ………………………… GridNeighborhoodSearch │
│ total #particles: ………………………………… 636 │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
```
The keyword arguments `periodic_box_min_corner` and `periodic_box_max_corner` explained
above can also be passed to the [`Semidiscretization`](@ref) and will internally be
forwarded to the neighborhood search:
```jldoctest semi_example; output = false
```julia
semi = Semidiscretization(system1, system2,
neighborhood_search=GridNeighborhoodSearch,
periodic_box_min_corner=[0.0, -0.25],
periodic_box_max_corner=[1.0, 0.75])
# output
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Semidiscretization │
│ ══════════════════ │
│ #spatial dimensions: ………………………… 2 │
│ #systems: ……………………………………………………… 2 │
│ neighborhood search: ………………………… GridNeighborhoodSearch │
│ total #particles: ………………………………… 636 │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
```
## References
Expand Down
24 changes: 2 additions & 22 deletions src/trivial_nhs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -26,38 +26,18 @@ internal function `eachneighbor`.
To run a simulation with this neighborhood search, just pass the type to the constructor
of [`Semidiscretization`](@ref):
```jldoctest semi_example; output=false, setup = :(trixi_include(@__MODULE__, joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"), sol=nothing); system1 = fluid_system; system2 = boundary_system)
```julia
semi = Semidiscretization(system1, system2,
neighborhood_search=TrivialNeighborhoodSearch)
# output
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Semidiscretization │
│ ══════════════════ │
│ #spatial dimensions: ………………………… 2 │
│ #systems: ……………………………………………………… 2 │
│ neighborhood search: ………………………… TrivialNeighborhoodSearch │
│ total #particles: ………………………………… 636 │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
```
The keyword arguments `periodic_box_min_corner` and `periodic_box_max_corner` explained
above can also be passed to the [`Semidiscretization`](@ref) and will internally be
forwarded to the neighborhood search:
```jldoctest semi_example; output = false
```julia
semi = Semidiscretization(system1, system2,
neighborhood_search=TrivialNeighborhoodSearch,
periodic_box_min_corner=[0.0, -0.25],
periodic_box_max_corner=[1.0, 0.75])
# output
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Semidiscretization │
│ ══════════════════ │
│ #spatial dimensions: ………………………… 2 │
│ #systems: ……………………………………………………… 2 │
│ neighborhood search: ………………………… TrivialNeighborhoodSearch │
│ total #particles: ………………………………… 636 │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
```
"""
struct TrivialNeighborhoodSearch{NDIMS, ELTYPE, EP, PB}
Expand Down

0 comments on commit 5583a9c

Please sign in to comment.