| D50 | 0.00038 | -D50 sediment size in [m]. | +D50 sediment size in [m]. | |||||
| D90 | 0.00053 | -D90 sediment size in [m] | +D90 sediment size in [m]. | |||||
| rhosed | 2650.0 | -Sand density in kg/m3 | +Sand density in kg/m^3. | |||||
| wws | 0.0509 | -sand fall velocity (should be calculated) m/s | +Sand fall velocity (should be calculated) m/s. | |||||
| drydzmax=1.0, wetdzmax=2.0 | -1.0, 2.0 | -Wet/dry max slope in avalanching model | +drydzmax | +1.0 | +Dry maximum slope in avalanching model. | +wetdzmax | +2.0 | +Wet maximum slope in avalanching model. |
| maxslpchg | 0.01 | -max change within a step to avoid avalanching tsunami | +Maximum change within a step to avoid avalanching tsunami. | |||||
| por | 0.4 | -sand porosity (%) | +Sand porosity (%). | |||||
| morfac | 1.0 | -morphological factor 0 no changes in morphology 1 normal changes in morpho >1 accelerated morphological changes (beware this doesn't accelerate the bnd you have to do this manually) | +Morphological factor 0 no changes in morphology 1 normal changes in morpho >1 accelerated morphological changes (beware this doesn't accelerate the bnd you have to do this manually). | |||||
| sus | 1.0 | -calibration coeff for suspended load | +Calibration coefficient for suspended load. | |||||
| bed | 1.0 | -calibration coeff for bed load | +Calibration coefficient for bed load. | |||||
| facsk | 0.2 | -calibration factor for wave skewness | +Calibration factor for wave skewness. | |||||
| facas | 0.2 | -calibration factor for wave asymetry | +Calibration factor for wave asymmetry. | |||||
| bathy, depfile | -[] | -Bathymetry file, positive down [m]. See details below | +bathy | +"" | +Bathymetry file, positive down [m]. See details below. | +|||
| depfile | +"" | +Bathymetry file, positive down [m]. See details below. | ||||||
| wavebndfile | -[] | -Filename of the wave boundary file. See below for details | +"" | +Filename of the wave boundary file. See below for details. | ||||
| SedThkfile | -[] | -Sediment thickness file. Same format as the bathymetry file but with sediment layer thickness values in m | +"" | +Sediment thickness file. Same format as the bathymetry file but with sediment layer thickness values in m. | ||||
| slbndfile | -[] | -Sea level boundary file (see below for details) | +"" | +Sea level boundary file (see below for details). | ||||
| windbndfile | -[] | -Wind boundary file (see below for details) | +"" | +Wind boundary file (see below for details). | ||||
| outfile | -[] | -Netcdf output file name for area serie output | +XBGPU_output.nc | +Netcdf output file name for area series output. | ||||
| TSOfile | -[] | -Output txt file name for Time serie output of a single location. There can be as many TSOfile as specific location to output. With this option you will output zs and H at every step in the model | +"" | +Output txt file name for Time series output of a single location. There can be as many TSOfile as specific location to output. With this option you will output zs and H at every step in the model. | ||||
| TSnode | x,y | -Location in nodes for extracting a time series. You need as many TSnode=x,y (x and y should be integers smaller than nx and ny respectively) as you have TSOfile=myfile.txt | +Location in nodes for extracting a time series. You need as many TSnode=x,y (x and y should be integers smaller than nx and ny respectively) as you have TSOfile=myfile.txt | |||||
| outvars | -"zb", "zs", "uu", "vv", "H", "thetamean", "D", "urms", "ueu", "vev", "C", "dzb", "Fx", "Fy", "hh", "Hmean", "uumean", "vvmean", "hhmean", "zsmean", "Cmean" | -Name of output variables. See below for the full list. Any number of variable can be selected. You can specify the same varibale twice but you would be a fool. specifying an empty lits will revert back to default. outvars may be specifyed multiple time in the param file to add more variable and keep the file clean | +"zb", "zs", "uu", "vv", "H", "thetamean", "D", "urms", "ueu", "vev", "C", "dzb", "Fx", "Fy", "hh", "Hmean", "uumean", "vvmean", "hhmean", "zsmean", "Cmean", "ueumean", "vevmean" | +Name of output variables. See below for the full list. Any number of variable can be selected. You can specify the same variable twice but you would be a fool. Specifying an empty lits will revert back to default. outvars may be specified multiple time in the param file to add more variable and keep the file clean. |
There are 4 different type of wave boundary input. For type 4 (and 5) teh wave groups are internally generated. The wave goup and Low frequency bpound wave generation can be controlled with some of the parameters below.
+There are 4 different type of wave boundary input. For type 4 (and 5) the wave groups are internally generated. The wave goup and Low frequency bpound wave generation can be controlled with some of the parameters below.
| wavebndtype | 2 | -Wave boundary type [1, 2, 3, 4, or 5]. See below for details | +Wave boundary type [1, 2, 3, 4, or 5]. See below for details. | |
| dtbc | 1.0 | -time step for wave group forcing (generation and reading). Only used for wavebndtype 2, 4 and 5. Automatic for wavebndtype=3 | +Time step for wave group forcing (generation and reading). Only used for wavebndtype 2, 4 and 5. Automatic for wavebndtype=3. | |
| sprdthr | 0.8 | -Threshold cut off for spectral sample in boundary generation (in % of peak energy). | +Threshold cut off for spectral sample in boundary generation (in % of peak energy). | |
| rtlength | 3600.0 | -duration of wave group chunks (seconds) . | +Duration of wave group chunks (seconds). | |
| random | -0.0 | -switch for resetting random sampling. ) means the random sample will be the same evry run . 1 mean the sample is different at evry run . | +0 | +Switch for resetting random sampling. 0 means the random sample will be the same every run. 1 mean the sample is different at evry run. |
| nmax | 0.8 | -Factor to reduce long wave variance in shallow water. | +Factor to reduce long wave variance in shallow water. | |
| fcutoff | 0.0 | -Low-freq cutoff frequency. | +Low-freq cutoff frequency. |
wavebndtype = 2;Header speciying: thetamin, thetamax, dtheta, dtbc, rtlength
a time serie with each line containing : time, Trep, qfile, Efile
+a time series with each line containing : time, Trep, qfile, Efile
@@ -625,7 +647,7 @@ Offshore water level
If no sea level files are specified teh water level will be set to 0.0 throughout the duration of the model.
Wind is applied uniformly accross the grid. By default no wind is applied but the user can specify a file wich contains a time series fo time (s) speed (m/s) and direction(degree true North). The wind direction is automatically corrected to the angle of the grid. The time series can be tab delimited, space delimited or comma delimited. Simply make sure it is consistent. The time vector needs to be monotonically increasing but the time step can be variable (but >0.0). See the example below.
+Wind is applied uniformly accross the grid. By default no wind is applied but the user can specify a file which contains a time series fo time (s) speed (m/s) and direction (degree true North). The wind direction is automatically corrected to the angle of the grid. The time series can be tab delimited, space delimited or comma delimited. Simply make sure it is consistent. The time vector needs to be monotonically increasing but the time step can be variable (but >0.0). See the example below.
# Wind boundary example
0.0,5.0,250.0
@@ -646,33 +668,33 @@ Side boundaries
Output
XBGPU is capable of producing 4 types of outputs:
- - Log file is systematically created as soon as you start the software. The log file contains information generated when the model is setup and as teh model runs. It is teh first place to look if the model terminate unexpectidely
- - Gridded variable extrated at selected setps and stored in a netcdf variable (see below)
- - Variable timeseries from selected point(s) output extracted at every model step and stored in a txt file (see below)
+ - Log file is systematically created as soon as you start the software. The log file contains information generated when the model is setup and as the model runs. It is the first place to look if the model terminate unexpectedly.
+ - Gridded variable extrated at selected setps and stored in a netcdf variable (see below).
+ - Variable timeseries from selected point(s) output extracted at every model step and stored in a txt file (see below).
- Reusable boundary in Netcdf format When generating a wave goups and long bound waves from a JONSWAP spectra or an given spectra. XBGPU porduces a Netcdf output containin all the information necessary to rerun the model using the same wave group. This is usefull when the wave group take a long time to generate.
Gridded variables
gridded variables can be extracted from the model at regular time interval.
- outputtimestep = 3600.000000; controls the interval between output of the gridded variables. outfile = XBGPU_output.nc; controls the name of the Netcdf file that will contain the gridded variables. The file cannot be overwritten by XBGPU so data is appended to the file if it already exits. outvars = H,uu,vv,zs,zb controls which gridded variable will be saved (See below). outputtimestep = 3600.000000; controls the interval between output of the gridded variables.outfile = XBGPU_output.nc; controls the name of the Netcdf file that will contain the gridded variables. The file cannot be overwritten by XBGPU so data is appended to the file if it already exits.outvars = H,uu,vv,zs,zb controls which gridded variable will be saved (See below).
Output Variables list
zb: Bathymetry, [m] positive down
uu: U velocity [m/s] at u-point of the cell.
uu: U velocity [m/s] at u-point of the cell
vv: V velocity [m/s] at v-point of the cell.
vv: V velocity [m/s] at v-point of the cell
zs: Water level above datum [m].
zs: Water level above datum [m]
hh: Water depth [m]
H: RMS wave height [m]
thetamean: Mean wave direction [Deg to, math convention, 0 is perpendicular to the offshore boundary traveling to the shore ]
thetamean: Mean wave direction [Deg to, math convention, 0 is perpendicular to the offshore boundary traveling to the shore]
ee: Wave energy []