Merge pull request #288 from FourierFlows/ncc/docs-typo

Fixes in Docs

Author: navidcy

Project.toml

@@ -6,7 +6,7 @@ authors = ["Gregory L. Wagner <wagner.greg@gmail.com>", "Navid C. Constantinou <
 description = "Tools for building fast, hackable, pseudospectral partial differential equation solvers on periodic domains."
 documentation = "https://fourierflows.github.io/FourierFlowsDocumentation/stable/"
 repository = "https://github.com/FourierFlows/FourierFlows.jl"
-version = "0.7.0"
+version = "0.7.1"
 
 [deps]
 CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"

README.md

@@ -102,7 +102,7 @@ and [Navid C. Constantinou][] (@navidcy).
 
 The code is citable via [zenodo](https://zenodo.org). Please cite as:
 
-> Navid C. Constantinou & Gregory L. Wagner. (2021). FourierFlows/FourierFlows.jl: FourierFlows v0.6.19 (Version v0.6.19). Zenodo.  [http://doi.org/10.5281/zenodo.1161724](http://doi.org/10.5281/zenodo.1161724)
+> Navid C. Constantinou & Gregory L. Wagner. (2021). FourierFlows/FourierFlows.jl: FourierFlows v0.7.1 (Version v0.7.1). Zenodo.  [http://doi.org/10.5281/zenodo.1161724](http://doi.org/10.5281/zenodo.1161724)
 
 
 

docs/src/aliasing.md

@@ -58,26 +58,26 @@ beyond what our grid can resolve anyway. In FourierFlows.jl, the former dealiasi
 implemented.
 
 !!! info "De-aliasing scheme"
-    FourierFlows.jl curently implement dealiasing by zeroing out the top-`aliased_fraction` 
+    FourierFlows.jl curently implements dealiasing by zeroing out the highest-`aliased_fraction` 
     wavenumber components on a `grid`.
 
 The number of wavenumber components that we need to zero-out to be sure the no aliasing errors 
 infiltrate our solution depends on the order of the nonlinearities. For example, for quadratic 
-nonlinearities, one expects that we need to discard the top-1/2 of the wavenumber components. 
+nonlinearities, one expects that we need to discard the highest-1/2 of the wavenumber components. 
 This way, when computing the product of two fields we won't have anything that projects onto
 harmonics with wavenumbers beyond those that our grid is able to resolve and, therefore, no 
 aliasing errors.
 
 The above-mentioned 1/2-rule for dealiasing for quadratic nonlinearities is, however, not the 
 most efficient. Orszag (1972) pointed out that for quadratic nonlirearities, simply only discarding 
-the top-1/3 of wavenumber components is enough to save us from aliasing errors. To be fair, 
+the highest-1/3 of wavenumber components is enough to save us from aliasing errors. To be fair, 
 with Orszag's so-called 2/3-rule for dealiasing, still some aliasing errors occur, but those 
 errors only occur to the higher-1/3 wavenumber components that will be zero-ed out next time 
 we dealias our solution anyway.
 
 When constructing a `grid` we can specify the `aliased_fraction` parameter. By default, this is 
 set to ``1/3``, appropriate for quadratic nonlinearities. Then `dealias!(fh, grid)` will zero-out 
-the top-`aliased_fraction` wavenumber components of `fh`. 
+the highest-`aliased_fraction` wavenumber components of `fh`. 
 
 If we construct a grid with `aliased_fraction=0`, e.g.,
 

docs/src/grids.md

@@ -28,14 +28,13 @@ OneDimensionalGrid
   ├── grid spacing dx: 0.09817477042468103
   ├─────────── domain: x ∈ [-3.141592653589793, 3.0434178831651124]
   └─ aliased fraction: 0.3333333333333333
- ```
-
-The grid domain is, by default, constructed symmetrically around ``x = 0``, but this 
-can be altered using the `x0` keyword argument of `OneDGrid` constructor. The grid 
-spacing is ``L_x / n_x``. Note that the last point of the domain is a grid-spacing 
-before ``L_x / 2``. This is because periodicity implies that the values of any field 
-at the end-points of the domain are equal and, therefore, grid-point values at
-both these end-points are reduntant.
+```
+
+The grid domain is, by default, constructed symmetrically around ``x = 0``, but this can be 
+altered using the `x0` keyword argument of the `OneDGrid` constructor. The grid spacing 
+is ``L_x / n_x``. Note that the last point of the domain is a grid-spacing before ``L_x / 2``. 
+This is because periodicity implies that the values of any field at the end-points of the 
+domain are equal and, therefore, grid-point values at both these end-points are reduntant.
 
 We can define an array `u` that contains the values of a function ``u(x)`` on this 
 grid as