SEDIMORPH.DAT: Difference between revisions

Revision as of 10:45, 26 April 2016

Basic Information

File-Type

sedimorph.dat

File-Form

FORMATTED

Version

1.x

Description-Date

March 2016

Significance of the File

general input data for the computational morphodynamic module SediMorph, which can be used together with different simulation methods (e.g. Telemac or UNTRIM).

File-Contents (in Catchwords)

Block "Input_Files" with the names of the different input data files:

Key "Sediment_Classification_File": filetype soil.dat with description of the sediment classification used (e.g. Udden-Wentworth-Scale);
Key "Input_Morphological_Dataset_ASC": filetype ipds.dat with data for the initial state (e.g. spatial distribution of sediments, dune height and dune length, etc.), in situations when the initial state has to be prescribed manually (e.g. from measured data);
Key "Input_Restart_File": filetype netcdf.cdf with data for the initial state, in situations when data from an earlier SediMorph simulation shall be used;
Key "Restart_Time": time for the initial state if "Input_Restart_File" was specified before;
Key "Readjust_Initial_Bathymetry": switch (true/false) to readjust the initial bathymetry in situations when data from an earlier SediMorph simulation shall be used;
Key "Vertical_Structure_File": filetype vertical.dat with description of the vertical structure for simulation of a two- or three-dimensional sediment distribution.
(optional) Key "Morphological_Speedup_Factor": Factor for the acceleration of the bed evolution (This key is outdated and can only be used for versions up to untrim2007_2015_07_15.xe).

Notice: "Input_Morphological_Dataset_ASC" and "Input_Restart_File"+"Restart_Time"+"Readjust_Initial_Bathymetry" must not be prescribed at the same time.

(optional) Block "Simplified_3D_Structure" for the Inititalisisation of a 3D sediment distribution:

Key "Global_Sediment_Fraction": fraction name and share.
Key "Minimal_Thickness_for_Regional_Sediment_Probes": minimal vertical validity range for the sediment distribution specified in the IPDS-file.

(optional) Block "Morphological_Data_Output" with steering data concerning the output of morphologically relevant data sets:

Key "Output_Morphological_DataSet_2D": filetype dirz.bin.r, dirz.bin.i and dirz.bin for output of two-dimensional data :

water level
current velocity
time dependent bathymetry
vertical erosion
effective bed roughness
rigid layer depth
rigid layer roughness
porosity in the exchange layer
sediment fraction in the exchange layer (percentaged or as mass)
particle diameter d_m in the exchange layer
[opt.] ripple height
[opt.] ripple wave number
[opt.] dune height
[opt.] dune wave number

Key "Output_Morphological_DataSet_3D": (optional) filetype dirz.bin.R, dirz.bin.I and dirz.bin for output of three-dimensional data:

porosity
sediment fraction (percentaged or as mass)
particle diameter d_m
Key "First_Time_of_MDS_Output": start time for the output of data;
Key "Last_Time_of_MDS_Output": end time for the output of data;
Key "Time_Increment_of_MDS_Output": time interval between two successive times of data output.
Key "Output_As_Sediment_Mass": switch (true/false) to trigger if the output of the sediment distribution is carried out as a percentaged value (false) or as available sediment mass in [math]\displaystyle{ kg/m^2 }[/math] (true).

Notice: results will be eventually interpolated to the nodes of the computational grid.

(optional) Block "Sediment_Transport_Output" with steering data for the output of sediment transport data at the bottom:

Key "Sediment_Transport_Results_File": filetype dirz.bin.r, dirz.bin.i and dirz.bin for the output of all sediment transport data;
Key "First_Time_of_STR_Output": start time for the output of data;
Key "Last_Time_of_STR_Output": end time for the output of data;
Key "Time_Increment_of_STR_Output": time interval between two successive times of data output.
Key "Output_of_Transport_Rate": switch (true/false) to trigger the output of the sediment transport rate;
Key "Output_of_Transport_Capacity": switch (true/false) to trigger the output of the sediment transport capacity;
Key "Output_of_Erosion_Rate": switch (true/false) to trigger the output of the erosion rate of suspended sediments at the bottom;
Key "Output_of_Deposition_Rate": switch (true/false) to trigger the output of the deposition rate of suspended sediments at the bottom;
Key "Output_of_Effective_Bed_Shear_Stress": switch (true/false) to trigger output of effective bed shear stress at the bottom, which is relevant for sediment transport;
Key "Output_of_Critical_Bed_Shear_Stress": switch (true/false) to trigger output of critical bed shear stress at the bottom.

Notice: results will be eventually interpolated to the nodes of the computational grid. (optional) Block "Restart_Data_Output" with steering data to generate a restart file:

Key "Output_Restart_File": filetype netcdf.cdf for output of restart data belonging to the actual computational grid;
Key "First_Time_of_Restart_Output": start time for the output of restart data;
Key "Last_Time_of_Restart_Output": end time for the output of restart data;
Key "Time_Increment_of_Restart_Output": time interval between two successive times of restart data output.

Notice: a "Output_Restart_File" can be re-used in any later simulation as a "Input_Restart_File", as far as the computational grid is identical.

(optional) Block "NetCDF_Data_Output" with steering data for the output of morphological and sediment transport data in a UGRID CF NetCDF file, necessary for post processing with NCANALYSE and NCAGGREGATE:

Key "Output_NetCDF_DataSet": filetype CF-NETCDF.NC for the output of all data;
Key "First_Time_of_NetCDF_Output": start time for the output of data;
Key "Last_Time_of_NetCDF_Output"": end time for the output of data;
Key "Time_Increment_of_NetCDF_Output": time interval between two successive times of data output.
Key "Output_of_Ripples" to trigger the output of the variables

ripple height,
ripple wave number,
time dependent ripple height and
time dependent ripple wave number (if available);

Key "Output_of_Dunes" to trigger the output of the variables

dune height,
dune wave number,
time dependent dune height and
time dependent dune wave number (if available);

Key "Output_of_Bedload" to trigger the output of

bedload transport capacity and
bedload transport rate;

Key "Output_of_Evolution_Erosion" to trigger the output of

bottom evolution rate and
vertical erosion;

Key "Output_of_Erosion_Deposition_Rate" to trigger the output of

erosion rate and
deposition rate;

Key "Output_of_Bed_Shear_Stress" to trigger the output of

effective bed shear stress and
critical bed shear stress;

Key "Output_of_Integral_Mass_Fluxes" to trigger the output of the subsequent balance variables:

horizontal bedload transport at edges integrated along the edge;
sediment mass at faces 2d integrated above a face and along the z axis;
sediment exchange at the bottom at faces integrated above a face; unequal to zero for fractions of suspended matter;
divergence of sediment transport at faces integrated above a face; unequal to zero for bedload fractions;

Block "Bed_Roughness" with steering data to compute the effective bottom roughness:

Key "Ripple_Roughness_Included": switch, whether ripples (if present) are (not) taken into account in the computation of the bottom roughness;
Key "Dune_Roughness_Included": switch, whether dunes (if present) are (not) taken into account in the computation of the bottom roughness.

(optional) Key "Dune_Prediction": switch (true/false) for the prediction of dunes;

(optional) Block "Exchange_Layer" with steering data for the exchange layer definition:

Key "Exchange_Layer_Depth_Formula": choice of a exchange layer depth model (e.g. "5dmax_poly", "Borah", "new_Approach"). If this block is neglected "5dmax_global" is taken into account.
(optional) Key "Hiding_Law": choice of model for the modification of the transport rates of different sediment fractions according to their grain diameter ("NONE" (default), "Egiazaroff", "Ashida_Michiue", "Karim_Holly_Yang").
(optional) Key "With_Dynamic_Layers": Activation of the dynamic bookkeeping layers.
(optional) Key "Max_Number_Of_Dynamic_Layers": Maximal number of dynamic bookkeeping layers. Required if "With_Dynamic_Layers" is activated.
(optional) Key "Max_Depth_Of_Dynamic_Layer": Maximal thickness of a bookkeeping layer. Required if "With_Dynamic_Layers" is activated.

Block "Bed_Load_Transport" with steering data for the parametrization of bed load transport near the bottom:

Key "Transport_Formula": choice of a transport formula (e.g. "Bagnold", "van_Rijn", "Meyer_Peter_Mueller" or "Hunziker").
(optional) Key "Upwind_Scheme": choice of a Upwind formula (1 = edge_velocity_based (default), 2 = bed celerity based).
(optional) Key "Morphological_Speedup_Factor_BL": Factor for the internal scaling of the bed load fluxes.

Block "Suspended_Load_Transport" with steering data for the parametrization of the erodibility:

Key "Erosion_Flux_Model": Choose of "linear" or "quadratic" dependence from the bottom shear stress.
Key "Erosion_Flux_Constant": Constant value according to the "Erosion_Flux_Model".
(optional) Key "Morphological_Speedup_Factor_SL": Factor for the internal scaling of the erosion and deposition fluxes.

(optional) Block "Porosity" with steering data for the porosity: If "Erosion_Flux_Model" = "linear" and "Porosity_Prediction" = "true" the "Erosion_Flux_Constant" will be ignored and internaly calculated as a function of the porosity.

Key "Porosity_Prediction": switch (true/false) for the prediction of porosity;

Block "Sediment_Class" with relevant informations concerning the sediment classes used during computation:

Key "Sediment_Class_Name": name of a sediment class to be used;
Key "Transport_Mode": type of sediment transport (e.g. "No_Transport", "Bed_Load" or "Suspension").
Key "Critical_Shear_Stress_for_Erosion": critical shear stress for erosion (e.g. "User_Defined" plus value, or "Shields" - according to Shields diagram).

Notice: all classes to be used must be defined inside the "Sediment_Classification_File" before (see above). Notice: dictionary-file sedimorph_dico.dat, normally present in directory $PROGHOME/dic/, will be automatically read by the application program in addition to the user-specified input file.

Programs using this Type of File

TELEMAC-2D, UNS, UNTRIM, UNTRIM2, UNTRIM2007

Example-File

please refer to $PROGHOME/examples/sedimorph/

for UnTRIM see also in directory $PROGHOME/examples/untrim/BSP_SediMorph_kurve/

back to: File Descriptions

Overview

@@ Line 13: / Line 13: @@
 * Key "'''Readjust_Initial_Bathymetry'''": '''switch''' (true/false) to readjust the initial bathymetry in situations when data from an earlier SediMorph simulation shall be used;
 * Key "'''Vertical_Structure_File'''": filetype [[VERTICAL.DAT|vertical.dat]] with description of the vertical structure for simulation of a two- or three-dimensional sediment distribution.
-*(optional) Key "'''Morphological_Speedup_Factor'''": Factor for the acceleration of the bed evolution.
+*(optional) Key "'''Morphological_Speedup_Factor'''": Factor for the acceleration of the bed evolution (This key is outdated and can only be used for versions up to untrim2007_2015_07_15.xe).
 Notice: "'''Input_Morphological_Dataset_ASC'''" and "'''Input_Restart_File"+"Restart_Time"+"Readjust_Initial_Bathymetry'''" must not be prescribed at the same time.<br />
+(optional) Block "'''Simplified_3D_Structure'''" for the '''Inititalisisation of a 3D sediment distribution:'''
+:* Key "'''Global_Sediment_Fraction'''": fraction name and share.
+:* Key "'''Minimal_Thickness_for_Regional_Sediment_Probes'''": minimal vertical validity range for the sediment distribution specified in the IPDS-file.
 (optional) Block "'''Morphological_Data_Output'''" with steering data concerning the output of '''morphologically relevant data sets''':
 * Key "'''Output_Morphological_DataSet_2D'''": filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]] for output of '''two-dimensional data''' :
@@ Line 40: / Line 47: @@
 ::* Key "'''Output_As_Sediment_Mass'''": '''switch''' (true/false) to trigger if the output of the sediment distribution is carried out as a percentaged value (false) or as available sediment mass in <math>kg/m^2</math> (true).
 Notice: results will be eventually interpolated to the nodes of the computational grid.
 (optional) Block "'''Sediment_Transport_Output'''" with steering data for the '''output of sediment transport data at the bottom:'''
 :* Key "'''Sediment_Transport_Results_File'''": filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]] for the output of all '''sediment transport data''';
@@ Line 58: / Line 67: @@
 :* Key '''"Time_Increment_of_Restart_Output": time interval''' between two successive times of restart data output.
 Notice: a '''"Output_Restart_File"''' can be re-used in any later simulation as a '''"Input_Restart_File"''', as far as the computational grid is identical.<br />
 (optional) Block "'''NetCDF_Data_Output'''" with steering data for the '''output of morphological and sediment transport data''' in a UGRID CF NetCDF file, necessary for post processing with [[NCANALYSE]] and [[NCAGGREGATE]]:
 :* Key "'''Output_NetCDF_DataSet'''": filetype [[CF-NETCDF.NC|CF-NETCDF.NC]] for the output of all data;
@@ Line 96: / Line 107: @@
 :* Key '''"Dune_Roughness_Included"''': switch, whether '''dunes''' (if present) are (not) taken into account in the computation of the bottom roughness.
 (optional) Key '''"Dune_Prediction"''': switch (true/false) for the '''prediction of dunes''';
 (optional) Block '''"Exchange_Layer"''' with steering data for the exchange layer definition:
-:* Key '''"Exchange_Layer_Depth_Formula"''': choice of a '''exchange layer depth''' model (e.g. '''"5dmax_poly"''',''' "Borah"''', '''"new_Approach"'''). If this block is neglected '''"5dmax_global"''' is taken into account. This approach is fixed in older versions.
+:* Key '''"Exchange_Layer_Depth_Formula"''': choice of a '''exchange layer depth''' model (e.g. '''"5dmax_poly"''',''' "Borah"''', '''"new_Approach"'''). If this block is neglected '''"5dmax_global"''' is taken into account.
+:*(optional) Key '''"Hiding_Law"''': choice of model for the modification of the transport rates of different sediment fractions according to their grain diameter ('''"NONE"''' (default), '''"Egiazaroff"''', '''"Ashida_Michiue"''', '''"Karim_Holly_Yang"''').
+:*(optional) Key '''"With_Dynamic_Layers"''': Activation of the dynamic bookkeeping layers.
+:*(optional) Key '''"Max_Number_Of_Dynamic_Layers"''': Maximal number of dynamic bookkeeping layers. Required if '''"With_Dynamic_Layers"''' is activated.
+:*(optional) Key '''"Max_Depth_Of_Dynamic_Layer"''': Maximal thickness of a bookkeeping layer. Required if '''"With_Dynamic_Layers"''' is activated.
 Block '''"Bed_Load_Transport"''' with steering data for the '''parametrization of bed load transport near the bottom:'''
 :* Key '''"Transport_Formula"''': choice of a '''transport formula''' (e.g. '''"Bagnold"''', '''"van_Rijn"''', '''"Meyer_Peter_Mueller"''' or '''"Hunziker"''').
+:*(optional) Key '''"Upwind_Scheme"''': choice of a Upwind formula (1 = edge_velocity_based (default), 2 = bed celerity based).
+:*(optional) Key '''"Morphological_Speedup_Factor_BL'''": Factor for the internal scaling of the bed load fluxes.
 Block '''"Suspended_Load_Transport"''' with steering data for the '''parametrization of the erodibility:'''
 :* Key '''"Erosion_Flux_Model"''': Choose of "linear" or "quadratic" dependence from the bottom shear stress.
 :* Key '''"Erosion_Flux_Constant"''': '''Constant value''' according to the "Erosion_Flux_Model".
+:*(optional) Key '''"Morphological_Speedup_Factor_SL'''":  Factor for the internal scaling of the erosion and deposition fluxes.
 (optional) Block "'''Porosity'''" with steering data for the '''porosity''': If "Erosion_Flux_Model" = "linear" and "Porosity_Prediction" = "true" the "Erosion_Flux_Constant" will be ignored and internaly calculated as a function of the porosity.
 :* Key "'''Porosity_Prediction'''": switch (true/false) for the '''prediction of porosity''';
 Block "'''Sediment_Class'''" with relevant informations concerning the '''sediment classes''' used during computation:
 :* Key "'''Sediment_Class_Name'''": '''name of a sediment class to be used''';
 :* Key "'''Transport_Mode'''": '''type of sediment transport''' (e.g. '''"No_Transport"''', '''"Bed_Load"''' or '''"Suspension"''').
 :* Key '''"Critical_Shear_Stress_for_Erosion"''': '''critical shear stress for erosion''' (e.g. '''"User_Defined"''' plus value, or '''"Shields"''' - according to Shields diagram).
-:* (optional) Key '''"Settling_Velocity"''': choice of a '''settling velocity formula ("Stokes", "Dietrich", "Malcherek"''' or '''"Manning"''').
 Notice: all classes to be used must be defined inside the '''"Sediment_Classification_File"''' before (see above).
 '''Notice:''' dictionary-file '''sedimorph_dico.dat''', normally present in directory '''$PROGHOME/dic/''', will be automatically read by the application program in addition to the user-specified input file.