Merge pull request #125 from milankl/get_id_mode

?Parameter help included

Author: Milan K

README.md

@@ -17,7 +17,7 @@ Please feel free to raise an [issue](https://github.com/milankl/ShallowWaters.jl
 
 ## How to use
 
-You find the default parameters in `src/DefaultParameters.jl`. They can be changed with keyword arguments. Optionally, the number format `T` is defined as the first argument of `RunModel(T,...)`
+You find the options and default parameters in `src/DefaultParameters.jl` (or by typing `?Parameter`). They can be changed with keyword arguments. Optionally, the number format `T` is defined as the first argument of `RunModel(T,...)`
 ```julia
 julia> Prog = RunModel(Float32,Ndays=10,g=10,H=500,Fx0=0.12);
 Starting ShallowWaters on Sun, 20 Oct 2019 19:58:25 without output.

src/DefaultParameters.jl

@@ -98,7 +98,7 @@
     initpath::String=outpath            # folder where to pick the restart files from
     init_run_id::Int=0                  # run id for restart from run number
     init_starti::Int=-1                 # timestep to start from (-1 meaning last)
-    get_id_mode::String="continue"      # "continue" or "fill"
+    get_id_mode::String="continue"      # How to determine the run id: "continue" or "fill"
 
     # ASSERT - CHECK THAT THE INPUT PARAMETERS MAKE SENSE
     @assert all((nx,Lx,L_ratio) .> 0.)  "nx, Lx, L_ratio have to be >0"
@@ -133,3 +133,108 @@
     @assert init_starti > 0 || init_starti == -1 "Start index, init_starti, has to be >0 || -1, $init_starti given."
     @assert get_id_mode in ["continue","fill"] "get_id_mode $get_id_mode unsupported."
 end
+
+"""
+Creates a Parameter struct with following options and default values
+
+    T::DataType=Float32                 # number format
+
+    Tprog::DataType=T                   # number format for prognostic variables
+    Tcomm::DataType=T                   # number format for ghost-point copies
+
+    # DOMAIN RESOLUTION AND RATIO
+    nx::Int=100                         # number of grid cells in x-direction
+    Lx::Real=2000e3                     # length of the domain in x-direction [m]
+    L_ratio::Real=2                     # Domain aspect ratio of Lx/Ly
+
+    # PHYSICAL CONSTANTS
+    g::Real=10.                         # gravitational acceleration [m/s]
+    H::Real=500.                        # layer thickness at rest [m]
+    ρ::Real=1e3                         # water density [kg/m^3]
+    ϕ::Real=45.                         # central latitue of the domain (for coriolis) [°]
+    ω::Real=2π/(24*3600)                # Earth's angular frequency [s^-1]
+    R::Real=6.371e6                     # Earth's radius [m]
+
+    # WIND FORCING OPTIONS
+    wind_forcing_x::String="channel"    # "channel", "double_gyre", "shear","constant" or "none"
+    wind_forcing_y::String="constant"   # "channel", "double_gyre", "shear","constant" or "none"
+    Fx0::Real=0.12                      # wind stress strength [Pa] in x-direction
+    Fy0::Real=0.0                       # wind stress strength [Pa] in y-direction
+
+    # BOTTOM TOPOGRAPHY OPTIONS
+    topography::String="ridge"          # "ridge", "seamount", "flat", "ridges", "bathtub"
+    topo_height::Real=50.               # height of seamount [m]
+    topo_width::Real=300e3              # horizontal scale [m] of the seamount
+
+    # SURFACE RELAXATION
+    surface_relax::Bool=false           # yes?
+    t_relax::Real=100.                  # time scale of the relaxation [days]
+    η_refh::Real=5.                     # height difference [m] of the interface relaxation profile
+    η_refw::Real=50e3                   # width [m] of the tangent used for the interface relaxation
+
+    # SURFACE FORCING (Currently only Kelvin wave pumping at Eq.)
+    surface_forcing::Bool=false         # yes?
+    ωyr::Real=1.0                       # (annual) frequency [1/year]
+    A::Real=3e-5                        # Amplitude [m/s]
+
+    # TIME STEPPING OPTIONS
+    RKo::Int=4                          # Order of the RK time stepping scheme (3 or 4)
+    cfl::Real=1.0                       # CFL number (1.0 recommended for RK4, 0.6 for RK3)
+    Ndays::Real=10.0                    # number of days to integrate for
+    nstep_diff::Int=1                   # diffusive part every nstep_diff time steps.
+    nstep_advcor::Int=0                 # advection and coriolis update every nstep_advcor time steps.
+                                        # 0 means it is included in every RK4 substep
+
+    # BOUNDARY CONDITION OPTIONS
+    bc::String="periodic"               # "periodic" or anything else for nonperiodic
+    α::Real=2.                          # lateral boundary condition parameter
+                                        # 0 free-slip, 0<α<2 partial-slip, 2 no-slip
+
+    # MOMENTUM ADVECTION OPTIONS
+    adv_scheme::String="ArakawaHsu"     # "Sadourny" or "ArakawaHsu"
+    dynamics::String="nonlinear"        # "linear" or "nonlinear"
+
+    # BOTTOM FRICTION OPTIONS
+    bottom_drag::String="quadratic"     # "linear", "quadratic" or "none"
+    cD::Real=1e-5                       # bottom drag coefficient [dimensionless] for quadratic
+    τD::Real=300.                       # bottom drag coefficient [days] for linear
+
+    # DIFFUSION OPTIONS
+    diffusion::String="constant"        # "Smagorinsky" or "constant", biharmonic in both cases
+    νB::Real=500.0                      # [m^2/s] scaling constant for constant biharmonic diffusion
+    cSmag::Real=0.15                    # Smagorinsky coefficient [dimensionless]
+
+    # TRACER ADVECTION
+    tracer_advection::Bool=true         # yes?
+    tracer_relaxation::Bool=false       # yes?
+    tracer_consumption::Bool=false      # yes?
+    tracer_pumping::Bool=false          # yes?
+    injection_region::String="west"     # "west", "south", "rect" or "flat"
+    sst_initial::String="south"         # "west", "south", "rect", "flat" or "restart"
+    sst_rect_coords::Array{Float64,1}=[0.,0.15,0.,1.0]
+                                        # (x0,x1,y0,y1) are the size of the rectangle in [0,1]
+    Uadv::Real=0.25                     # Velocity scale [m/s] for tracer advection
+    SSTmax::Real=1.                     # tracer (sea surface temperature) max for restoring
+    SSTmin::Real=0.                     # tracer (sea surface temperature) min for restoring
+    τSST::Real=500.                     # tracer restoring time scale [days]
+    jSST::Real=365.                     # tracer consumption [days]
+    SST_λ0::Real=222e3                  # [m] transition position of relaxation timescale
+    SST_λs::Real=111e3                  # [m] transition width of relaxation timescale
+    SST_γ0::Real=8.35                   # [days] injection time scale
+    SSTw::Real=5e3                      # width [m] of the tangent used for the IC and interface relaxation
+    SSTϕ::Real=0.5                      # latitude/longitude fraction ∈ [0,1] of sst edge
+
+    # OUTPUT OPTIONS
+    output::Bool=false                  # netcdf output?
+    output_vars::Array{String,1}=["u","v","η","sst","q","ζ"]  # which variables to output?
+    output_dt::Real=6                   # output time step [hours]
+    outpath::String=pwd()               # path to output folder
+
+    # INITIAL CONDITIONS
+    initial_cond::String="rest"         # "rest" or "ncfile" for restart from file
+    initpath::String=outpath            # folder where to pick the restart files from
+    init_run_id::Int=0                  # run id for restart from run number
+    init_starti::Int=-1                 # timestep to start from (-1 meaning last)
+    get_id_mode::String="continue"      # How to determine the run id: "continue" or "fill"
+"""
+Parameter