Change so interface steepness is required in TanhInterfaceSmoothing

examples/single_interface.jl

@@ -10,9 +10,9 @@ model_setup = (;architecture, diffusivities, domain_extent, domain_topology, res
 
 ## Initial conditions
 depth_of_interface = -0.5
-salinity = [34.58, 34.70]
+salinity = [34.54, 34.70]
 temperature = [-1.5, 0.5]
-interface_ics = SingleInterfaceICs(eos, depth_of_interface, salinity, temperature)
+interface_ics = SingleInterfaceICs(eos, depth_of_interface, salinity, temperature, interface_smoothing = TanhInterfaceSteepness())
 velocity_noise = VelocityNoise()
 
 ## setup model
@@ -21,7 +21,7 @@ sdns = StaircaseDNS(model_setup, interface_ics, velocity_noise)
 ## Build simulation
 Δt = 1e-1
 stop_time = 4 * 60 * 60 # seconds
-save_schedule = 30  # seconds
+save_schedule = 60  # seconds
 output_path = joinpath(@__DIR__, "output_non_periodic")
 simulation = SDNS_simulation_setup(sdns, stop_time, save_computed_output!, save_vertical_velocities!;
                                     Δt, save_schedule,

src/StaircaseShenanigans.jl

@@ -31,7 +31,7 @@ export STStaircaseInitialConditions, StaircaseICs, SmoothSTStaircaseInitialCondi
        STSingleInterfaceInitialConditions, SingleInterfaceICs,
        set_initial_conditions!
 
-export TanhInterfaceSmoothing, Tanh, NoSmoothing
+export TanhInterfaceSmoothing, Tanh, TanhInterfaceSteepness, NoSmoothing
 
 export BackgroundTanh, BackgroundLinear, BackgroundStep, NoBackground,
         tanh_background, linear_background, step_background

src/interface_smoothing.jl

@@ -17,7 +17,22 @@ end
 const Tanh = TanhInterfaceSmoothing{T} where {T}
 @inline (p::TanhInterfaceSmoothing)(x, y, z) = p.Cₗ - 0.5 * p.ΔC * (1  + tanh(p.D * (z - p.z_interface) / p.z_range))
 
+"Container for the steepness of the `tanh` over the interface for both salinity and temperature.
+Allows easy setting of both and avoids having to set other parts of the container before the
+model has been setup."
+struct TanhInterfaceSteepness{T}
+    "Salinity interface steepness"
+    DS :: T
+    "Temperature interface steepness"
+    DT :: T
+end
+"Some defaults that are unstable to diffusive convection."
+TanhInterfaceSteepness() = TanhInterfaceSteepness(500.0, 250.0)
+TanhInterfaceSteepness(S) = TanhInterfaceSteepness(S, S / 3)
+
 Base.summary(p::Type{<:TanhInterfaceSmoothing}) = "tanh smoothing"
+Base.summary(p::TanhInterfaceSmoothing) = "tanh smoothing"
+Base.summary(p::TanhInterfaceSteepness) = "tanh smoothing"
 
 struct NoInterfaceSmoothing <: AbstractInterfaceSmoothing end
 const NoSmoothing = NoInterfaceSmoothing

src/set_initial_conditions.jl

@@ -64,26 +64,34 @@ function set_initial_conditions!(model, ics,
     return nothing
 end
 set_initial_conditions!(model, ics, interface_smoothing::Type{<:NoSmoothing}, background_state) = nothing
-function set_initial_conditions!(model, ics, interface_smoothing::Type{<:Tanh}, background_state)
+function set_initial_conditions!(model, ics, interface_smoothing::Tanh, background_state)
+
+    S₀(x, y, z) = interface_smoothing(x, y, z)
+    T₀(x, y, z) = interface_smoothing(x, y, z)
+
+    set!(model, S = S₀, T = T₀)
+
+    return nothing
+end
+function set_initial_conditions!(model, ics, interface_smoothing::TanhInterfaceSteepness, background_state)
 
     depth_of_interface = ics.depth_of_interface
     Lz = model.grid.Lz
 
     S = Array(ics.salinity_values)
     Sᵤ, Sₗ = S
     ΔS = diff(S)[1]
-    S₀(x, y, z) = Tanh(Sₗ, ΔS, 100.0, depth_of_interface, abs(Lz))(x, y, z)
+    S₀(x, y, z) = Tanh(Sₗ, ΔS, interface_smoothing.DS, depth_of_interface, abs(Lz))(x, y, z)
 
     T = Array(ics.temperature_values)
     Tᵤ, Tₗ = T
     ΔT = diff(T)[1]
-    T₀(x, y, z) = Tanh(Tₗ, ΔT, 100.0, depth_of_interface, abs(Lz))(x, y, z)
+    T₀(x, y, z) = Tanh(Tₗ, ΔT, interface_smoothing.DT, depth_of_interface, abs(Lz))(x, y, z)
 
     set!(model, S = S₀, T = T₀)
 
     return nothing
 end
-
 "Fallback --- don't set any noise."
 set_noise!(model, noise::Nothing) = nothing
 

test/model_ic_instantiation.jl

@@ -3,5 +3,5 @@ depth_of_interface =  -0.6
 salinity = [34.57, 34.69]
 temperature = [-1.5, 0.5]
 
-smoothing = (NoSmoothing, Tanh)
+smoothing = (NoSmoothing, TanhInterfaceSteepness(), TanhInterfaceSteepness(100.0), TanhInterfaceSteepness(1000.0, 200.0))
 background = (NoBackground, BackgroundTanh(), BackgroundLinear(), BackgroundStep())