Skip to content

Commit

Permalink
better phrasing in makefilter docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
navidcy committed Jul 10, 2023
1 parent f5ccaa0 commit b8983b0
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/domains.jl
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ one-dimensional grid, the non-dimensional wavenumber `K` is
K = k * dx / π
```
and thus it takes values `K` ``[-1, 1]``.
and thus take values in ``[-1, 1]``.
For `K ≤ innerK` the filter is inactive, i.e., equal to 1. For `K > innerK`,
the filter decays exponentially to remove high-wavenumber content from
Expand All @@ -495,8 +495,9 @@ the solution, i.e.,
filter(K) = exp(- decay * (K - innerK)^order)
```
For a given `order` and , the `decay` rate is determined so that the filter value at the
outer wavenumber `outerK` is `tol`, where `tol` is a small number, close to machine precision.
For a given `order`, the `decay` rate is determined so that the filter value at the
outer wavenumber `outerK` is `tol`, where `tol` is a small number, close to machine
precision.
```julia
decay = - log(tol) / (outerK - innerK)^order
Expand Down

0 comments on commit b8983b0

Please sign in to comment.