Merge pull request #30 from jbisits/joey-addnoise

Add simple velocity noise

Project.toml

@@ -1,7 +1,7 @@
 name = "StaircaseShenanigans"
 uuid = "c2bb06a8-94f3-4279-b990-30bf3ab8ba6f"
 authors = ["Josef Bisits <jbisits@gmail.com>"]
-version = "0.2.2"
+version = "0.3"
 
 [deps]
 GibbsSeaWater = "9a22fb26-0b63-4589-b28e-8f9d0b5c3d05"

src/StaircaseShenanigans.jl

@@ -22,6 +22,8 @@ export StaircaseDNS, DNSModel, SDNS_simulation_setup
 
 export StepInitialConditions, SmoothStepInitialConditions, set_staircase_initial_conditions!
 
+export AbstractNoise, VelocityNoise
+
 export OuterStairMask, OuterStairTargets
 
 export CustomLinearRoquetSeawaterPolynomial, CustomLinearEquationOfState
@@ -31,6 +33,7 @@ export save_computed_output!
 export animate_tracers, animate_density, visualise_initial_conditions, visualise_initial_density
 
 include("staircase_initial_conditions.jl")
+include("staircase_noise.jl")
 include("staircase_model.jl")
 include("set_staircase_initial_conditions.jl")
 include("staircase_restoring.jl")

src/set_staircase_initial_conditions.jl

@@ -33,9 +33,26 @@ function set_staircase_initial_conditions!(model, ics::SmoothStepInitialConditio
 
     return nothing
 end
+set_noise!(model, noise::Nothing) = nothing
+function set_noise!(model, noise::VelocityNoise)
+
+    u, v, w = model.velocities
+    u_m, v_m, w_m = noise.u_magnitude, noise.v_magnitude, noise.w_magnitude
+    u_noise = u_m * randn(size(u))
+    v_noise = v_m * randn(size(v))
+    w_noise = w_m * randn(size(w))
+
+    set!(model, u = u_noise, v = v_noise, w = w_noise)
+
+end
+"""
+    function set_staircase_initial_conditions!(sdns::StaircaseDNS)
+Set initial staircase and noise for a `StaircaseDNS`.
+"""
 function set_staircase_initial_conditions!(sdns::StaircaseDNS)
 
     set_staircase_initial_conditions!(sdns.model, sdns.initial_conditions)
+    set_noise!(sdns.model, sdns.initial_noise)
 
     return nothing
 end

src/staircase_initial_conditions.jl

@@ -1,7 +1,7 @@
 abstract type AbstractStaircaseInitialConditions <: AbstractInitialConditions end
 
 Base.iterate(sics::AbstractStaircaseInitialConditions, state = 1) =
-    state > length(fieldnames(sics)) ? nothing : (getfield(sdns, state), state + 1)
+    state > length(fieldnames(sics)) ? nothing : (getfield(sics, state), state + 1)
 
 "Container for initial conditions that have well mixed layers seperated by sharp step interfaces."
 struct StepInitialConditions{T} <: AbstractStaircaseInitialConditions

src/staircase_noise.jl

@@ -0,0 +1,25 @@
+"""
+    struct VelocityNoise{T}
+Container for magnitudes for normally distributed noise added to velocity fields.
+"""
+struct VelocityNoise{T} <: AbstractNoise
+    "Magnitude for u velocity field"
+    u_magnitude :: T
+    "Magnitude for v velocity field"
+    v_magnitude :: T
+    "Magnitude for w velocity field"
+    w_magnitude :: T
+end
+Base.iterate(noise::AbstractNoise, state = 1) =
+    state > length(fieldnames(noise)) ? nothing : (getfield(noise, state), state + 1)
+
+function Base.show(io::IO, noise::AbstractNoise)
+    if noise isa VelocityNoise
+        println(io, "VelocityNoise")
+        println(io, "┣━━ u_noise_magnitude: $(noise.u_magnitude)")
+        println(io, "┣━━ v_noise_magnitude: $(noise.v_magnitude)")
+        print(io,   "┗━━ w_noise_magnitude: $(noise.w_magnitude)")
+    end
+end
+"Convenience for all noise at same magnitude `c`, default behaviour is 1e-4"
+VelocityNoise(c::Float64=1e-4) = VelocityNoise(c, c, c)