Tracer advection
A tracer is a property
If the tracer
Eulerian advection
Numerically we solve
with
Add/delete tracers
For every tracer in SpeedyWeather the tracer advection equation as outlined above is solved. One can add a new tracer to the model before it is initialized to a simulation
using SpeedyWeather
spectral_grid = SpectralGrid(trunc=63, nlayers=1)
model = ShallowWaterModel(spectral_grid)
# add a tracer called :abc
add!(model, Tracer(:abc))Dict{Symbol, Tracer} with 1 entry:
:abc => Tracer <: SpeedyWeather.AbstractTracer…This returns model.tracers, a dictionary, which will always give you an overview of which tracers are defined. Tracers are defined through a key::Symbol for which we use Symbol (not strings, because Symbols are immutable). We just wrap the key here in Tracer to define a tracer. You can add more tracers
add!(model, Tracer(:co2), Tracer(:ch4))Dict{Symbol, Tracer} with 3 entries:
:abc => Tracer <: SpeedyWeather.AbstractTracer…
:ch4 => Tracer <: SpeedyWeather.AbstractTracer…
:co2 => Tracer <: SpeedyWeather.AbstractTracer…or delete them again
delete!(model, Tracer(:co2))
delete!(model, Tracer(:ch4))Dict{Symbol, Tracer} with 1 entry:
:abc => Tracer <: SpeedyWeather.AbstractTracer…Tracers are just defined through their key, e.g. :co2, so while you can do tracer1 = Tracer(:co2) and tracer2 = Tracer(:co2), they will be considered the same tracer – and no two tracers with the same key can exist inside model (and simulation).
What you should not do is add a tracer to the model after it has been initialized. You can check that the tracers exists in the variables with
simulation = initialize!(model)
simulation.prognostic_variablesPrognosticVariables{Float32, Array}
├ vor: T63, 1-layer, 2-steps LowerTriangularArray{ComplexF32}
├ div: T63, 1-layer, 2-steps LowerTriangularArray{ComplexF32}
├ temp: T63, 1-layer, 2-steps LowerTriangularArray{ComplexF32}
├ humid: T63, 1-layer, 2-steps LowerTriangularArray{ComplexF32}
├ pres: T63, 1-layer, 2-steps LowerTriangularArray{ComplexF32}
├ random_pattern: T63, 1-layer LowerTriangularArray{ComplexF32}
├┐ocean:
│├ sea_surface_temperature: Field{Float32} on 96-ring OctahedralGaussianGrid
│├ sea_ice_concentration: Field{Float32} on 96-ring OctahedralGaussianGrid
│├ sensible_heat_flux: Field{Float32} on 96-ring OctahedralGaussianGrid
│└ surface_humidity_flux: Field{Float32} on 96-ring OctahedralGaussianGrid
├┐land:
│├ soil_temperature: Field{Float32} on 0-layer, 96-ring OctahedralGaussianGrid
│├ soil_moisture: Field{Float32} on 0-layer, 96-ring OctahedralGaussianGrid
│├ snow_depth: Field{Float32} on 96-ring OctahedralGaussianGrid
│├ sensible_heat_flux: Field{Float32} on 96-ring OctahedralGaussianGrid
│└ surface_humidity_flux: Field{Float32} on 96-ring OctahedralGaussianGrid
├ tracers: 1, (:abc,)
├ particles: 0-element Vector{Particle{Float32}}
├ scale: 1.0
└ clock: 2000-01-01T00:00:00where both :abc and :xyz are listed. Tracers in SpeedyWeather are based on dictionaries so the order of the tracers is arbitrary, they are always defined by their key instead.
All tracers have to be added to the model before it is initialized to return the simulation. This is because that initialization determines all required variables and allocates them, after that simulation.variables is an immutable collection of (mutable) arrays. If you do want to start or pause a tracer advection at any time you have to activate or deactivate them, see below.
(De)activate tracers
While a tracer is defined through its key, e.g.
Tracer(:dust)Tracer <: SpeedyWeather.AbstractTracer
├ name::Symbol = dust
└ active::Bool = trueit also has a field active which can be changed any time. Do not confuse this with the discussion of active vs passive, categorising whether a tracer impacts the flow or not. Active versus deactivated here is solely used to describe whether its time evolution is temporarily "deactivated. An activated tracer (the default) is advected, a deactivated tracer does not change in time (=frozen) but continues to exist and all its variables remain in place. You can (de)activate a tracer with
activate!(model, Tracer(:abc))
deactivate!(model, Tracer(:abc))which is equivalent to model.tracers[:abc].active = true (default, or false) and also equivalent to (de)activating them in the simulation instead, i.e. activate!(simulation, Tracer(:abc)).
Set tracers
Tracers can be set to values by using the set! function, which can take scalars, fields (spectral or grid) or functions as arguments, e.g.
set!(simulation, abc=1)
(; GridVariable3D, nlat_half, nlayers) = spectral_grid
set!(simulation, abc=randn(GridVariable3D, nlat_half, nlayers))
set!(simulation, abc=(λ, φ, σ) -> exp(-(λ-180)^2/10^2))The first one sets abc to a global constant (not super exciting), the second to some random values on a grid (transforms automatically!), and the third sets the tracer to a Gaussian ridge that runs through the Pacific (see Tracer visualisation below).
For more examples how to use set! see Changing orography manually, Manual land-sea mask, and Rossby-Haurwitz wave in a BarotropicModel. But note that because we are setting a (in general) 3D variable here the vertical dimension must align: Hence nlayers for the grid, and the anonymous function must take three arguments, including the vertical coordinate σ even if it's independent of it.
Tracer visualisation
Let us illustrate some tracer advection in practice
using SpeedyWeather
spectral_grid = SpectralGrid(trunc=85, nlayers=1)
model = ShallowWaterModel(spectral_grid)
add!(model, Tracer(:abc))
simulation = initialize!(model)
# add and set tracer and run a 0-day simulation
set!(simulation, abc = (λ, φ, σ) -> exp(-(λ-180)^2/10^2))
run!(simulation, period=Day(0))
# visualise the initial conditions for this tracer
using CairoMakie
abc0 = simulation.diagnostic_variables.grid.tracers_grid[:abc][:, 1]
heatmap(abc0, title="Tracer abc, initial conditions")
So we started with a north-south stripe of some tracer. [:, 1] is used to pull out all values : on the one and only layer 1. The ShallowWaterModel has by default a jet in the northern hemisphere which will advect that tracer, after some days:
run!(simulation, period=Day(3))
abc1 = simulation.diagnostic_variables.grid.tracers_grid[:abc][:, 1]
heatmap(abc1, title="Tracer abc, after 3 days")
Output tracers
more to come...