Skip to content

Commit

Permalink
Small info update (#257)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolasmerino41 authored Aug 29, 2024
1 parent 5cd4bd6 commit 219567c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
*.jl.*.cov
*.jl.mem
docs/build
*.json
Manifest.toml
2 changes: 1 addition & 1 deletion src/framework.jl
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Theses are the taken from the `ruleset` argument by default:
KernelAbstractions.jl and a CUDA gpu is available.
- `opt`: a [`PerformanceOpt`](@ref) to specificy optimisations like
[`SparseOpt`](@ref) or [`NoOpt`](@ref). Defaults to `NoOpt()`.
- `boundary`: what to do with boundary of grid edges. Options are [`Remove`](@ref) or [`Wrap`](@ref), defaulting to `Remove()`.
- `boundary`: what to do with boundary of grid edges. Options are [`Remove`](@ref), [`Wrap`](@ref) or [`Reflect`](@ref), defaulting to `Remove()`.
- `cellsize`: the size of cells, which may be accessed by rules.
- `timestep`: fixed timestep where this is required for some rules.
eg. `Month(1)` or `1u"s"`.
Expand Down
3 changes: 3 additions & 0 deletions src/interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ to skip coordinates that boundary outside of the grid.
[`Wrap`](@ref) returns a tuple with the current position or it's
wrapped equivalent, and `true` as it is allways in-bounds.
[`Reflect`](@ref) returns a tuple with the current position or it's
reflected equivalent, and `true` as it is allways in-bounds.
"""
function inbounds end

Expand Down

0 comments on commit 219567c

Please sign in to comment.