input.txt

! INPUT FILE FOR NHWAVE
! NOTE: all input parameter are capital sensitive

! --------------------TITLE-------------------------------------
TITLE = test

! ---------------- RESULT_FOLDER-------------------------------
RESULT_FOLDER = ./results/

! --------------------DIMENSION---------------------------------
! cell numbers
Mglob = 1000
Nglob = 4
Kglob = 1

! --------------------PROCESSOR NUMBER-------------------------
PX = 2
PY = 2

! -----------------------TIME----------------------------------
! time: total computational time/ plot time / screen interval 
! all in seconds
SIM_STEPS = 100000000
TOTAL_TIME = 15.1
PLOT_START = 0.0
PLOT_INTV = 0.1
SCREEN_INTV = 0.1

! ------------------------GRID----------------------------------
! grid sizes
DX = 2.0
DY = 2.0

! ---------------------VERTICAL GRID OPTION--------------------
! IVGRD = 1: uniform; 2: exponential
IVGRD = 1
GRD_R = 1.1

! ----------------------TIME STEP-----------------------------
DT_INI = 0.01000
DT_MIN = 0.00001
DT_MAX = 60.0000

! ----------------------BATHYMETRY---------------------------
! if analytical bathymetry, set ANA_BATHY = T
! DEPTH_TYPE = CELL_CENTER if the water depth is defined at
! cell center, otherwise, DEPTH_TYPE = CELL_GRID 
DEPTH_TYPE = CELL_CENTER
ANA_BATHY  = F
DepConst = 0.3

! -------------------INITIAL CONDITION---------------------------
! if INITIAL_EUVW = T, need file eta0.txt and uvw0.txt
! if INITIAL_SALI = T, need file sali0.txt
INITIAL_EUVW = F
INITIAL_SALI = F

! -----------------HOT START----------------------------------
HOTSTART = F
Eta_HotStart_File = ./results/eta_00001
U_HotStart_File = ./results/u_00001
V_HotStart_File = ./results/v_00001
W_HotStart_File = ./results/w_00001
P_HotStart_File = ./results/p_00001
Sali_HotStart_File = ./results/sali_00001
Temp_HotStart_File = ./results/temp_00001
Rho_HotStart_File = ./results/rho_00001
TKE_HotStart_File = ./results/k_00001
EPS_HotStart_File = ./results/d_00001
Depth_HotStart_File = ./results/depth_00001
Us_HotStart_File = ./results/Us_00001
Vs_HotStart_File = ./results/Vs_00001

! ----------------- COUPLING -------------------------
! if do coupling, have to set -DCOUPLING in Makefile
COUPLING_FILE = coupling.txt

! ----------------------NUMERICS----------------------------
! Scalar convection scheme: "TVD" or "HLPA"
HIGH_ORDER = SECOND
TIME_ORDER = SECOND
CONVECTION = HLPA
HLLC = F

! ----------------------BOTTOM ROUGHNESS-------------------
! Ibot = 1: given the drag coefficient Cd0
! Ibot = 2: given the bottom roughness height Zob
Ibot = 1
Cd0 = 0.0025
Zob = 1.5e-5
Dfric_Min = 0.0

! ---------------------WIND STRESS--------------------------
! Iws = 1: given constant wind speed
! Iws = 2: given spatially varying wind speed (need wind.txt)
! WindU,WindV: constant wind speed
Iws = 1
WindU = 0.0
WindV = 0.0

! ---------------------Coriolis----------------------------
! slat: latitude
slat = 0.0

! ---------------------BAROTROPIC--------------------------
! if barotropic run, set BAROTROPIC = T
BAROTROPIC = F

! ----------------------NON-HYDRO---------------------------
! if non-hydrostatic simulation
NON_HYDRO = F

! --------------------COURANT_NUMBER---------------------------------
CFL = 0.5

! --------------------FOURDE CAP ----------------------------------
FROUDE_CAP = 100.0

! ---------------------RAMP-UP--------------------------------
! time to ramp up simulation
TRAMP = 0.0

! --------------------VISCOSITY------------------------------
VISCOUS_FLOW = F
IVTURB = 10
IHTURB = 10
PRODTYPE = 3
VISCOSITY = 1.e-6
Schmidt = 1.0
Chs = 0.001
Cvs = 0.001
RNG = T

! --------------------VISCOUS NUMBER----------------------------
VISCOUS_NUMBER = 0.1666667

! ----------------------WET-DRY-------------------------------
! minimum depth for wetting-drying
MinDep = 1.e-2

! ---------------------POISSON SOLVER-------------------------
! isolver is an option for different preconditioner.
! itmax is the maximum number of iterations.
! tol is the stopping criterion.
!
! isolver=1: Modified Incomplete Cholesky CG
! isolver=2: Incomplete Cholesky GMRES
! isolver=3: Successive Overrelaxation (SOR) GMRES
ISOLVER = 2
ITMAX = 1000
TOL = 1.e-12

! ------------------PERIODIC BC------------------------------------
! periodic=.true. : periodic boundary condition in y direction
! Notice if periodic=.true., Nglob must be power-of-two.
! No periodic boundaries in serial run.
PERIODIC_X = F
PERIODIC_Y = F

! ------------------EXTERNAL FORCING------------------------------
EXTERNAL_FORCING = F
Pgrad0 = 9.81e-4

! -------------------BOUNDARY_TYPE--------------------------------
! bc_type=1: free-slip
!         2: no-slip
!         3: influx
!         4: outflux (specified eta)
!         5: bottom or wall friction
!         6: radiation bc
BC_X0 = 1
BC_Xn = 1
BC_Y0 = 1
BC_Yn = 1
BC_Z0 = 1
BC_Zn = 1

! ---------------------WAVEMAKER------------------------------
! wavemaker
! AMP - wave height; PER - wave period; DEP - incident water depth
! THETA - incident wave angle
! LEF_SOL - left boundary solitary wave, need AMP,DEP
! LEF_LIN - left boundary linear wave, need AMP,PER,DEP
! LEF_CON - left boundary cnoidal wave, need AMP,PER,DEP
! LEF_STK - left boundary stokes wave, need AMP,PER,DEP
! LEF_TID - left boundary tide wave, has to specify in subroutine
! LEF_JON - left boundary for JONSWAP spectrum
! RIG_LIN - right boundary linear wave, need AMP,PER,DEP,THETA
! INI_ETA - initial surface elevation specified in subroutine initial
! INT_LIN - internal wavemaker for linear wave
! INT_CON - internal wavemaker for cnoidal wave
! INT_SOL - internal wavemaker for solitary wave
! INT_JON - internal wavemaker for JONSWAP spectrum
! INT_SPC - internal wavemaker for 2D spectrum (need spc2d.txt)
! INT_IRR - internal wavemaker for irregular wave (need irr2d.txt)
! FLUX_LR - impose flux at both left and right boundaries
! FOCUSED - left boundary focusing wave packet (isolated whitecap)
! WAV_CUR - left boundary coexisting waves and currents
WAVEMAKER = NONE
AMP = 0.0144
PER = 10.5
DEP = 0.32
THETA = 0.0
CUR = 0.0
sd_return = 0.75

! ----------------------INTERNAL WAVEMAKER--------------------------------
! parameters for internal wavemaker
Xsource_West = 1.26
Xsource_East = 1.4
Ysource_Suth = 0.0
Ysource_Nrth = 3.388

! ----------------------FOCUSING WAVE PACKET--------------------------------
! parameters for FOC wavemaker type
nwave = 32
Component_Amp_Type = 2
k_center = 5.15
f_center = 1.08
x_breaking = 3.3
t_breaking = 9.0
Slope_group = 0.28
normalized_delta_f = 0.7306
depth_comp = 0.3

! ---------------------PARAMETERS FOR JONSWAP SPECTRUM------------------
! Hm0 - significant wave height
! Tp - peak wave period
! Freq_Min - minimum wave frequency
! Freq_Max - maximum wave frequency
! NumFreq - number of frequency discretizations
Hm0 = 0.035
Tp = 0.8
Freq_Min = 0.2
Freq_Max = 4.00
NumFreq = 200

! ---------------- SPONGE LAYER ------------------------
! DHI type sponge layer
! need to specify widths of four boundaries and parameters
! set width=0.0 if no sponge
SPONGE_ON = F
Sponge_West_Width =  0.0
Sponge_East_Width =  0.0
Sponge_South_Width = 0.0
Sponge_North_Width = 0.0

! ------------------WAVE AVERAGE CONTROL--------------------------
WAVE_AVERAGE_ON = F
WAVE_AVERAGE_START = 200.0
WAVE_AVERAGE_END = 1800.0
WaveheightID = 2

! ------------------SEDIMENT PARAMETERS---------------------------
! parameters for sediment module
! Sed_Type = 'COHESIVE' or 'NONCOHESIVE'
Sed_Type = 'COHESIVE'
BED_LOAD = F
COUPLE_FS = F
Af = 0.0
D50 = 1.2e-5
ntyws = 1
Sedi_Ws = 0.00007
Shields_c = 0.05
Tau_ce = 0.15
Tau_cd = 0.07
Erate = 4.0e-8
Mud_Visc = 1.e-6
Tim_Sedi = 0.0
MorDt = 0.0
BED_CHANGE = T

! -------------------VEGETATION PARAMETERS------------------------
! parameters for vegetation module
Veg_Type = RIGID
Veg_X0 = 2.85
Veg_Xn = 5.30
Veg_Y0 = 0.00
Veg_Yn = 0.10
VegH = 0.135
VegDens = 1250.0
VegVol = 0.0
StemD = 0.0064
VegDrag = 0.8
Cfk = 1.0
Cfe = 1.33
VegVM = 0.0
EI = 8.0e-7

!! -------------------LANDSLIDE PARAMETERS------------------------
!! parameters for landslide module
!! SlideType = 'RIGID_2D', 'RIGID_3D' or 'DEFORMABLE'
!! SlideT: thickness; SlideL: length; SlideW: width
!! SlideAngle: slide angle
!! SlopeAngle: bottom slope
!! SlideX0,SlideY0: initial location
!! SlideUt,SlideA0: rigid landslide kinematics
!! SlideDens: deformable landslide density
!SlideType = RIGID_2D
!SlideT = 0.052
!SlideL = 1.6762
!SlideW = 0.200
!SlideAngle = 0.0
!SlopeAngle = 20.0
!SlideX0 = 1.268
!SlideY0 = 0.0
!SlideUt = 1.258
!SlideA0 = 0.750
!SlideDens = 1500.0
!SlideVisc = 0.00001
!SlideLambda = 0.0
!SlideIniU = 0.0
!Cf_ul = 0.0
!PhiInt = 0.0
!PhiBed = 10.0

!! ----------------------VISCOUS SLIDE---------------------------
!! Slide thickness. The dimension are the same as in DEPTH_FILE
!SLIDE_FILE = slide.txt
!! Density, kg/m^3
!SLIDE_DENSITY = 1951.0
!! Kinematic viscousity (Jiang's Ph.D. Thesis, p. 29)
!! River coastal mud = 0.002-0.2 m^2/s
!! Mudslide and debris flows = 0.2-0.6 m^2/s
!SLIDE_VISCOSITY = 0.00001
!! Manning's coefficient for the viscous slide
!SLIDE_ROUGHNESS = 0.005
!! A tiny diffusivity for the mass equation
!SLIDE_DIFF = 0.00005
!! The minimum slide thickness, m
!SLIDE_MINTHICK = 0.00001 

! ---------------------DEFORMABLE SLIDE--------------------------
! parameters for DEFORMABLE SLIDE module
! RHEO_OPT£º='VISCOUS' or 'GRANULAR'
! NON_HYDRO_SLD: non-hyderostatic model or not
! DISP_CORR_SLD: dispersion correction in non-hyderostatic model (recommonded unless unstability happens)
! REDU_GRAV_SLD: reduced gravitation in non-hyderostatic model (recommonded unless unstability happens)
! NON_HYDRO_UP: non-hyderostatic from upper layer (recommonded unless unstability happens)
! SLIDE_GAMMA: momentum distribution coefficient
! SLIDE_MINTHICK(m): minimum slide thickness
! SLIDE_INIU(m/s):initial velocity of slide in x
! SLIDE_INIV(m/s):initial velocity of slide in y
! SLIDE_INIW(m/s):initial velocity of slide in z
SLIDE_FILE = p58_h.txt
RHEO_OPT = GRANULAR
SLIDE_GAMMA = 1.0
NON_HYDRO_SLD = F
DISP_CORR_SLD = F
REDU_GRAV_SLD = F
NON_HYDRO_UP = T
SLIDE_MINTHICK = 1.e-4
SLIDE_INIU = 1.9138
SLIDE_INIV = 0.0
SLIDE_INIW = -0.9793

!Viscous flow
! SLIDE_DENSITY(kg/m^3): viscous slide density
! SLIDE_VISCOSITY(m^2/s): kinematic viscousity of viscous slide
SLIDE_DENSITY = 1760.0
SLIDE_VISCOSITY = 0.5

!Granular flow
! GRAIN_DENSITY(kg/m^3): pure grain density
! SLIDE_CONC: sediment concentration
! PhiInt_A(deg): internal friction angle of subaerial slide
! PhiBed_A(deg): bed friction angle of subaerial slide
! PhiInt_F(deg): internal friction angle of submarine slide
! PhiBed_F(deg): bed friction angle of submarine slide
! SLIDE_LAMBDA: percentage of non-hydrostatic pressure from solid phase
GRAIN_DENSITY = 2600.0
SLIDE_CONC = 0.475
PhiInt_A = 41.0
PhiBed_A = 23.0
PhiInt_F = 32.0
PhiBed_F = 18.0
SLIDE_LAMBDA = 1.0

! --------------------RHEOLOGY-----------------------------------
RHEOLOGY_ON = F
Yield_Stress = 10.
Plastic_Visc = 0.0

! --------------------PROBE OUTPUT---------------------------------
! output variables at stations which are given in file stat.txt
£¡in form of x,y,z, where z=-1.0 outputs velocity of all layers
NSTAT = 0
PLOT_INTV_STAT = 0.5

! -----------------------OUTPUT-------------------------------
! output variables, T=.TRUE, F = .FALSE.
! OUT_H = water depth
! OUT_E = surface elevation
! OUT_U = velocity in x direction
! OUT_V = velocity in y direction
! OUT_W = velocity in z direction
! OUT_P = dynamic pressure
! OUT_K = turbulent kinetic energy
! OUT_D = turbulent dissipation rate
! OUT_S = shear production
! OUT_C = eddy viscosity
! OUT_B = bubble void fraction
! OUT_A = Reynolds stress
! OUT_T = bottom shear stress
! OUT_F = sediment concentration
! OUT_G = bed elevation
! OUT_I = salinity
! OUT_Z = varying bathymetry
! OUT_M = max wave height
OUT_H = T
OUT_E = F
OUT_U = F
OUT_V = F
OUT_W = F
OUT_P = F
OUT_K = F
OUT_D = F
OUT_S = F
OUT_C = F
OUT_B = F
OUT_A = F
OUT_T = F
OUT_F = F
OUT_G = F
OUT_I = F
OUT_Z = T
OUT_M = F