Skip to content

Commit 5583a9c

Browse files
committed
Remove failing doctests
1 parent 5a5ebf8 commit 5583a9c

File tree

2 files changed

+4
-44
lines changed

2 files changed

+4
-44
lines changed

src/grid_nhs.jl

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -45,38 +45,18 @@ since not sorting makes our implementation a lot faster (although less paralleli
4545
4646
To run a simulation with this neighborhood search, just pass the type to the constructor
4747
of [`Semidiscretization`](@ref):
48-
```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)
48+
```julia
4949
semi = Semidiscretization(system1, system2,
5050
neighborhood_search=GridNeighborhoodSearch)
51-
52-
# output
53-
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
54-
│ Semidiscretization │
55-
│ ══════════════════ │
56-
│ #spatial dimensions: ………………………… 2 │
57-
│ #systems: ……………………………………………………… 2 │
58-
│ neighborhood search: ………………………… GridNeighborhoodSearch │
59-
│ total #particles: ………………………………… 636 │
60-
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
6151
```
6252
The keyword arguments `periodic_box_min_corner` and `periodic_box_max_corner` explained
6353
above can also be passed to the [`Semidiscretization`](@ref) and will internally be
6454
forwarded to the neighborhood search:
65-
```jldoctest semi_example; output = false
55+
```julia
6656
semi = Semidiscretization(system1, system2,
6757
neighborhood_search=GridNeighborhoodSearch,
6858
periodic_box_min_corner=[0.0, -0.25],
6959
periodic_box_max_corner=[1.0, 0.75])
70-
71-
# output
72-
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
73-
│ Semidiscretization │
74-
│ ══════════════════ │
75-
│ #spatial dimensions: ………………………… 2 │
76-
│ #systems: ……………………………………………………… 2 │
77-
│ neighborhood search: ………………………… GridNeighborhoodSearch │
78-
│ total #particles: ………………………………… 636 │
79-
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
8060
```
8161
8262
## References

src/trivial_nhs.jl

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,38 +26,18 @@ internal function `eachneighbor`.
2626
2727
To run a simulation with this neighborhood search, just pass the type to the constructor
2828
of [`Semidiscretization`](@ref):
29-
```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)
29+
```julia
3030
semi = Semidiscretization(system1, system2,
3131
neighborhood_search=TrivialNeighborhoodSearch)
32-
33-
# output
34-
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
35-
│ Semidiscretization │
36-
│ ══════════════════ │
37-
│ #spatial dimensions: ………………………… 2 │
38-
│ #systems: ……………………………………………………… 2 │
39-
│ neighborhood search: ………………………… TrivialNeighborhoodSearch │
40-
│ total #particles: ………………………………… 636 │
41-
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
4232
```
4333
The keyword arguments `periodic_box_min_corner` and `periodic_box_max_corner` explained
4434
above can also be passed to the [`Semidiscretization`](@ref) and will internally be
4535
forwarded to the neighborhood search:
46-
```jldoctest semi_example; output = false
36+
```julia
4737
semi = Semidiscretization(system1, system2,
4838
neighborhood_search=TrivialNeighborhoodSearch,
4939
periodic_box_min_corner=[0.0, -0.25],
5040
periodic_box_max_corner=[1.0, 0.75])
51-
52-
# output
53-
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
54-
│ Semidiscretization │
55-
│ ══════════════════ │
56-
│ #spatial dimensions: ………………………… 2 │
57-
│ #systems: ……………………………………………………… 2 │
58-
│ neighborhood search: ………………………… TrivialNeighborhoodSearch │
59-
│ total #particles: ………………………………… 636 │
60-
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
6141
```
6242
"""
6343
struct TrivialNeighborhoodSearch{NDIMS, ELTYPE, EP, PB}

0 commit comments

Comments
 (0)