GitHub

API Index

API Documentation

EnvironmentalTransport.AdvectionOperator — Type

Create an EarthSciMLBase.Operator that performs advection. Advection is performed using the given stencil operator (e.g. l94_stencil or ppm_stencil). p is an optional parameter set to be used by the stencil operator. bc_type is the boundary condition type, e.g. ZeroGradBC().

Wind field data will be added in automatically if available. Currently the only valid source of wind data is EarthSciData.GEOSFP.

source
EnvironmentalTransport.Puff — Method
Puff(
    di::EarthSciMLBase.DomainInfo;
    name
) -> ModelingToolkit.ODESystem

Create a Lagrangian transport model which advects a "puff" or particle of matter within a fluid velocity field.

Model boundaries are set by the DomainInfo argument. The model sets boundaries at the ground and model bottom and top, preventing the puff from crossing those boundaries. If the puff reaches one of the horizontal boundaries, the simulation is stopped.

source
EnvironmentalTransport.get_vf — Method
get_vf(domain, varname, data_f)

Return a function that gets the wind velocity at a given place and time for the given varname. data_f should be a function that takes a time and three spatial coordinates and returns the value of the wind speed in the direction indicated by varname.

source
EnvironmentalTransport.l94_stencil — Method
l94_stencil(ϕ, U, Δt, Δz; kwargs...)

L94 advection in 1-D (Lin et al., 1994)

  • ϕ is the scalar field at the current time step, it should be a vector of length 5.
  • U is the velocity at both edges of the central grid cell, it should be a vector of length 2.
  • Δt is the length of the time step.
  • Δz is the grid spacing.

The output will be time derivative of the central index (i.e. index 3) of the ϕ vector (i.e. dϕ/dt).

(The output is dependent on the Courant number, which depends on Δt, so Δt needs to be an input to the function.)

source
EnvironmentalTransport.ppm_stencil — Method
ppm_stencil(ϕ, U, Δt, Δz; kwargs...)

PPM advection in 1-D (Collela and Woodward, 1984)

  • ϕ is the scalar field at the current time step, it should be a vector of length 8 (3 cells on the left, the central cell, and 4 cells on the right).
  • U is the velocity at both edges of the central grid cell, it should be a vector of length 2.
  • Δt is the length of the time step.
  • Δz is the grid spacing.

The output will be time derivative of the central index (i.e. index 4) of the ϕ vector (i.e. dϕ/dt).

(The output is dependent on the Courant number, which depends on Δt, so Δt needs to be an input to the function.)

source
EnvironmentalTransport.upwind1_stencil — Method
upwind1_stencil(ϕ, U, Δt, Δz; p)

First-order upwind advection in 1-D: https://en.wikipedia.org/wiki/Upwind_scheme.

  • ϕ is the scalar field at the current time step, it should be a vector of length 3 (1 cell on the left, the central cell, and 1 cell on the right).
  • U is the velocity at both edges of the central grid cell, it should be a vector of length 2.
  • Δt is the length of the time step.
  • Δz is the grid spacing.

The output will be time derivative of the central index (i.e. index 2) of the ϕ vector (i.e. dϕ/dt).

Δt and p are not used, but are function arguments for consistency with other operators.

source
EnvironmentalTransport.upwind2_stencil — Method
upwind2_stencil(ϕ, U, Δt, Δz; kwargs...)

Second-order upwind advection in 1-D, otherwise known as linear-upwind differencing (LUD): https://en.wikipedia.org/wiki/Upwind_scheme.

  • ϕ is the scalar field at the current time step, it should be a vector of length 5 (2 cells on the left, the central cell, and 2 cells on the right).
  • U is the velocity at both edges of the central grid cell, it should be a vector of length 2.
  • Δt is the length of the time step.
  • Δz is the grid spacing.

The output will be time derivative of the central index (i.e. index 3) of the ϕ vector (i.e. dϕ/dt).

(Δt is not used, but is a function argument for consistency with other operators.)

source