API

DataLocation

Subtypes are used for dispatching on the data location

1D cell center

1D cell vertex

Coordinates

Cell node (n) and center (c) 1D coordinates.

ghost_dual(::Extremum)

A 2-element vector near the boundary with 1's on ghost cells and 0's on interior cells

binary(::Extremum)

Returns 0 for Min and 1 for Max

n_hat(::Extremum)

The outward normal vector to the boundary

ghost_vec(::Extremum)

A 3-element vector near the boundary with 1's on ghost cells and 0's on interior cells

Type for dispatching on boundary points

Type for dispatching on interior points

Type for dispatching on all points

Node boundary type, containing ghost, boundary, and first interior indices

Cell center boundary type, containing ghost and first interior indices

Type for dispatching on ghost points

Grid

An N-dimensional Cartesian, structured, computational grid.

Max

A type for dispatching on the maximum of the domain along a particular direction

Min

A type for dispatching on the minimum of the domain along a particular direction

Simple linear extrapolation f_g = 2f_b - f_i

Simple linear extrapolation with two staggered fields: f_g = 2g_b - f_i

FFTs (Fast Fourier Transforms)

The Fast Fourier Transform of the scalar field, f, w.r.t direction dir (1,2,3) which corresponds to (x,y,z).

Implementation

fft!(ω,f,dir,pad)

Input

f    = f(x,y,z)
dir  = direction along which to take the FT (1,2,3)
pad  = (1,0) = (exclude,include) boundary calc along FT direction
       |0000000|     |-------|
       |-------|  ,  |-------| Look at fft for implementation details
       |0000000|     |-------|

References

• https://jakevdp.github.io/blog/2013/08/28/understanding-the-fft/