Add 3D advection-diffusion

Project.toml

@@ -4,7 +4,7 @@ license = "MIT"
 authors = ["Navid C. Constantinou <[email protected]>", "Gregory L. Wagner <[email protected]>"]
 documentation = "https://fourierflows.github.io/PassiveTracerFlowsDocumentation/dev/"
 repository = "https://github.com/FourierFlows/PassiveTracerFlows.jl"
-version = "0.7.0"
+version = "0.8.0"
 
 [deps]
 CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"

README.md

@@ -42,13 +42,13 @@ See `examples/` for example scripts.
 
 ## Modules
 
-* `TracerAdvectionDiffusion`: advection-diffusion of a passive tracer in 1D or 2D domains.
+* `TracerAdvectionDiffusion`: advection-diffusion of a passive tracer in 1D, 2D, or 3D domains.
 
 
 ## Cite
 
 The code is citable via [zenodo](https://zenodo.org). Please cite as:
 
-> Navid C. Constantinou, Josef Bisits, and Gregory L. Wagner (2022). FourierFlows/PassiveTracerFlows.jl: PassiveTracerFlows v0.7.0 (Version v0.7.0). Zenodo. [https://doi.org/10.5281/zenodo.2535983](https://doi.org/10.5281/zenodo.2535983)
+> Navid C. Constantinou, Josef Bisits, and Gregory L. Wagner (2022). FourierFlows/PassiveTracerFlows.jl: PassiveTracerFlows v0.8.0 (Version v0.8.0). Zenodo. [https://doi.org/10.5281/zenodo.2535983](https://doi.org/10.5281/zenodo.2535983)
 
 [FourierFlows.jl]: https://github.com/FourierFlows/FourierFlows.jl

docs/src/modules/traceradvectiondiffusion.md

@@ -3,23 +3,32 @@
 ### Basic Equations
 
 This module solves the advection-diffusion equation for a passive tracer concentration in
-1D or 2D domains. 
+1D, 2D, or 3D domains. 
 
 For 1D problems the tracer concentration ``c(x, t)`` evolves under:
 
 ```math
-\partial_t c + u \partial_x c = \underbrace{\kappa \partial_x^2 c}_{\textrm{diffusivity}} + \underbrace{\kappa_h (-1)^{n_{h}} \partial_x^{2n_{h}}c}_{\textrm{hyper-diffusivity}}\ ,
+\partial_t c + u \partial_x c = \underbrace{\kappa \partial_x^2 c}_{\textrm{diffusivity}} + \underbrace{\kappa_h (-1)^{n_{h}} \partial_x^{2n_{h}}c}_{\textrm{hyper-diffusivity}} \ ,
 ```
 
-where ``u(x, t)`` is the advecting flow and ``\kappa`` the diffusivity. The advecting flow could be either compressible or incompressible. 
+where ``u(x, t)`` is the advecting flow and ``\kappa`` the diffusivity. The advecting flow can be either compressible or incompressible. 
 
 For 2D problems the tracer concentration ``c(x, y, t)`` evolves under:
 
 ```math
-\partial_t c + \bm{u} \bm{\cdot} \bm{\nabla} c = \underbrace{\eta \partial_x^2 c + \kappa \partial_y^2 c}_{\textrm{diffusivity}} + \underbrace{\kappa_h (-1)^{n_{h}} \nabla^{2n_{h}}c}_{\textrm{hyper-diffusivity}}\ ,
+\partial_t c + \bm{u} \bm{\cdot} \bm{\nabla} c = \underbrace{\eta \partial_x^2 c + \kappa \partial_y^2 c}_{\textrm{diffusivity}} + \underbrace{\kappa_h (-1)^{n_{h}} \nabla^{2n_{h}}c}_{\textrm{hyper-diffusivity}} \ ,
 ```
 
-where ``\bm{u} = (u, v)`` is the two-dimensional advecting flow, ``\eta`` the ``x``-diffusivity and ``\kappa`` is the ``y``-diffusivity. If ``\eta`` is not defined then the code uses isotropic diffusivity, i.e., ``\eta \partial_x^2 c + \kappa \partial_y^2 c \mapsto \kappa \nabla^2``. The advecting flow could be either compressible or incompressible. 
+where ``\bm{u} = (u, v)`` is the two-dimensional advecting flow, ``\kappa`` the ``x``-diffusivity and ``\eta`` is the ``y``-diffusivity. If ``\eta`` is not defined then the code uses isotropic diffusivity, i.e., ``\eta \partial_x^2 c + \kappa \partial_y^2 c \mapsto \kappa \nabla^2``. The advecting flow can be either compressible or incompressible. 
+
+
+For 3D problems the tracer concentration ``c(x, y, z, t)`` evolves under:
+
+```math
+\partial_t c + \bm{u} \bm{\cdot} \bm{\nabla} c = \underbrace{\kappa \partial_x^2 c + \eta \partial_y^2 c + \ell \partial_z^2}_{\textrm{diffusivity}} + \underbrace{\kappa_h (-1)^{n_{h}} \nabla^{2n_{h}}c}_{\textrm{hyper-diffusivity}} \ ,
+```
+
+where ``\bm{u} = (u, v, w)`` is the three-dimensional advecting flow, ``\kappa`` the ``x``-diffusivity, ``\eta`` is the ``y``-diffusivity, and ``\ell`` the ``z``-diffusivity. If ``\eta`` or ``\ell`` are not defined then the code uses isotropic diffusivity, i.e., ``\eta \partial_x^2 c + \kappa \partial_y^2 + \ell \partial_z^2 c \mapsto \kappa \nabla^2``. The advecting flow can be either compressible or incompressible. 
 
 
 ### Implementation