Default settings

The AeoLiS model can be configured using a model configuration file. For any configuration parameters not defined in the model configuration file, or in case the model configuration file is absent, the default model configuration is used. The default model configuration is listed below.

#: AeoLiS model default configuration
DEFAULT_CONFIG = {
    'process_wind'        : True,               # Enable the process of wind
    'process_shear'       : False,              # Enable the process of wind shear
    'process_tide'        : True,               # Enable the process of tides
    'process_wave'        : True,               # Enable the process of waves
    'process_runup'       : True,               # Enable the process of wave runup
    'process_moist'       : True,               # Enable the process of moist
    'process_mixtoplayer' : True,               # Enable the process of mixing
    'process_threshold'   : True,               # Enable the process of threshold
    'process_transport'   : True,               # Enable the process of transport
    'process_bedupdate'   : True,               # Enable the process of bed updating
    'process_meteo'       : False,              # Enable the process of meteo
    'process_salt'        : False,              # Enable the process of salt
    'process_humidity'    : False,              # Enable the process of humidity
    'th_grainsize'        : True,               # Enable wind velocity threshold based on grainsize
    'th_bedslope'         : False,              # Enable wind velocity threshold based on bedslope
    'th_moisture'         : True,               # Enable wind velocity threshold based on moisture
    'th_humidity'         : False,              # Enable wind velocity threshold based on humidity
    'th_salt'             : False,              # Enable wind velocity threshold based on salt
    'th_roughness'        : True,               # Enable wind velocity threshold based on roughness
    'xgrid_file'          : None,               # Filename of ASCII file with x-coordinates of grid cells
    'ygrid_file'          : None,               # Filename of ASCII file with y-coordinates of grid cells
    'bed_file'            : None,               # Filename of ASCII file with bed level heights of grid cells
    'wind_file'           : None,               # Filename of ASCII file with time series of wind velocity and direction
    'tide_file'           : None,               # Filename of ASCII file with time series of water levels
    'wave_file'           : None,               # Filename of ASCII file with time series of wave heights
    'meteo_file'          : None,               # Filename of ASCII file with time series of meteorlogical conditions
    'bedcomp_file'        : None,               # Filename of ASCII file with initial bed composition
    'threshold_file'      : None,               # Filename of ASCII file with shear velocity threshold
    'wave_mask'           : None,               # Filename of ASCII file with mask for wave height
    'tide_mask'           : None,               # Filename of ASCII file with mask for tidal elevation
    'threshold_mask'      : None,               # Filename of ASCII file with mask for the shear velocity threshold
    'nx'                  : 0,                  # [-] Number of grid cells in x-dimension
    'ny'                  : 0,                  # [-] Number of grid cells in y-dimension
    'dt'                  : 60.,                # [s] Time step size
    'CFL'                 : 1.,                 # [-] CFL number to determine time step in explicit scheme
    'accfac'              : 1.,                 # [-] Numerical acceleration factor
    'tstart'              : 0.,                 # [s] Start time of simulation
    'tstop'               : 3600.,              # [s] End time of simulation
    'restart'             : None,               # [s] Interval for which to write restart files
    'output_times'        : 60.,                # [s] Output interval in seconds of simulation time
    'output_file'         : None,               # Filename of netCDF4 output file
    'output_vars'         : ['zb', 'zs',
                             'Ct', 'Cu',
                             'uw', 'uth',
                             'mass', 'pickup'], # Names of spatial grids to be included in output
    'output_types'        : [],                 # Names of statistical parameters to be included in output (avg, sum, var, min or max)
    'grain_size'          : [225e-6],           # [m] Average grain size of each sediment fraction
    'grain_dist'          : [1.],               # [-] Initial distribution of sediment fractions
    'nfractions'          : 1,                  # [-] Number of sediment fractions
    'nlayers'             : 3,                  # [-] Number of bed layers
    'layer_thickness'     : .01,                # [m] Thickness of bed layers
    'g'                   : 9.81,               # [m/s^2] Gravitational constant
    'rhoa'                : 1.25,               # [kg/m^3] Air density
    'rhop'                : 2650.,              # [kg/m^3] Grain density
    'rhow'                : 1025.,              # [kg/m^3] Water density
    'porosity'            : .4,                 # [-] Sediment porosity
    'A'                   : .085,               # [-] Constant in formulation for wind velocity threshold based on grain size
    'z'                   : 10.,                # [m] Measurement height of wind velocity
    'h'                   : None,               # [m] Representative height of saltation layer
    'k'                   : 0.01,               # [m] Bed roughness
    'Cb'                  : 1.5,                # [-] Constant in formulation for equilibrium sediment concentration
    'm'                   : .5,                 # [-] Factor to account for difference between average and maximum shear stress
    'sigma'               : 4.2,                # [-] Ratio between basal area and frontal area of roughness elements
    'beta'                : 130.,               # [-] Ratio between drag coefficient of roughness elements and bare surface
    'bi'                  : 1.,                 # [-] Bed interaction factor
    'T'                   : 1.,                 # [s] Adaptation time scale in advection equation
    'Tdry'                : 3600.*1.5,          # [s] Adaptation time scale for soil drying
    'Tsalt'               : 3600.*24.*30.,      # [s] Adaptation time scale for salinitation
    'eps'                 : 1e-3,               # [m] Minimum water depth to consider a cell "flooded"
    'gamma'               : .5,                 # [-] Maximum wave height over depth ratio
    'xi'                  : .3,                 # [-] Surf similarity parameter
    'facDOD'              : .1,                 # [-] Ratio between depth of disturbance and local wave height
    'csalt'               : 35e-3,              # [-] Maximum salt concentration in bed surface layer