Merge pull request #73 from jbisits/jib-morekwargssimsetuo

Move some arguments in simulation to `kwargs`

Author: jbisits

Project.toml

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

examples/four_stair_staircase.jl

@@ -27,7 +27,8 @@ set_staircase_initial_conditions!(sdns)
 stop_time = 10 * 60 # seconds
 save_schedule = 10  # seconds
 output_path = joinpath(@__DIR__, "output")
-simulation = SDNS_simulation_setup(sdns, Δt, stop_time, save_schedule, save_computed_output!; output_path)
+simulation = SDNS_simulation_setup(sdns, stop_time, save_computed_output!;
+                                    output_path, Δt, save_schedule,)
 
 ## Run
 run!(simulation)

examples/single_interface.jl

@@ -22,8 +22,9 @@ sdns = StaircaseDNS(model_setup, interface_ics, velocity_noise)
 stop_time = 210 * 60 # seconds
 save_schedule = 10  # seconds
 output_path = joinpath(@__DIR__, "output")
-simulation = SDNS_simulation_setup(sdns, Δt, stop_time, save_schedule, save_computed_output!,
+simulation = SDNS_simulation_setup(sdns, stop_time, save_computed_output!,
                                     save_vertical_velocities!;
+                                    Δt, save_schedule,
                                     output_path, max_Δt = 5)
 ## Run
 run!(simulation)

examples/single_interface_periodic.jl

@@ -22,8 +22,9 @@ sdns = StaircaseDNS(model_setup, interface_ics, tracer_noise)
 stop_time = 200 * 60 # seconds
 save_schedule = 10  # seconds
 output_path = joinpath(@__DIR__, "output")
-simulation = SDNS_simulation_setup(sdns, Δt, stop_time, save_schedule, save_computed_output!,
-                                    StaircaseShenanigans.save_vertical_velocities!;
+simulation = SDNS_simulation_setup(sdns, stop_time, save_computed_output!,
+                                    save_vertical_velocities!;
+                                    Δt, save_schedule,
                                     output_path, max_Δt = 5)
 ## Run
 run!(simulation)

src/staircase_model.jl

@@ -164,19 +164,21 @@ function grid_stretching(Lz::Number, Nz::Number, refinement::Number, stretching:
 end
 """
     function SDNS_simulation_setup
-Build a `simulation` from `sdns`.
+Build a `simulation` from `sdns`. Only required arguments are the `sdns` and `stop_time`.
+All other `kwargs` have defaults (that can be changed).
 """
-function SDNS_simulation_setup(sdns::StaircaseDNS, Δt::Number,
-                                stop_time::Number, save_schedule::Number,
+function SDNS_simulation_setup(sdns::StaircaseDNS, stop_time::Number,
                                 save_custom_output!::Function=no_custom_output!,
                                 save_velocities!::Function=no_velocities!;
+                                Δt = 1e-3,
+                                max_Δt = 1e-1,
+                                max_change = 1.2,
+                                save_schedule = 60, # seconds
                                 save_file = :netcdf,
                                 output_path = SIMULATION_PATH,
                                 checkpointer_time_interval = nothing,
                                 cfl = 0.75,
                                 diffusive_cfl = 0.75,
-                                max_change = 1.2,
-                                max_Δt = 1e-1,
                                 overwrite_saved_output = true)
 
     simulation = Simulation(sdns.model; Δt, stop_time)