K MODEL.DAT: Difference between revisions
From BAWiki
imported>BAWiki 3 mNo edit summary |
imported>BAWiki 3 mNo edit summary |
||
Line 53: | Line 53: | ||
##: every computational point of the wave model within a distance of '''"Import_Max_Radius"''' a minimum number of data points with given water | ##: every computational point of the wave model within a distance of '''"Import_Max_Radius"''' a minimum number of data points with given water | ||
##: level an current velocity must be available; if this key is not prescribed, 3 interpolation points are going to be used. | ##: level an current velocity must be available; if this key is not prescribed, 3 interpolation points are going to be used. | ||
## (optional) key "Export_Max_Radius" to prescribe the max. (search) radius in meters during export of data (interpolation of wave model results onto the | ## (optional) key '''"Export_Max_Radius"''' to prescribe the '''max. (search) radius''' in meters during '''export of data''' (interpolation of wave model results onto the | ||
##: level as well as current velocity); if this key is not present, a radius of 2000.0 m will be used. | ##: grid for water level as well as current velocity); if this key is not present, a radius of 2000.0 m will be used. | ||
## (optional) key "Export_Min_Nearest" to prescribe the minimum number of required interpolation points during export of data; for | ## (optional) key '''"Export_Min_Nearest"''' to prescribe the minimum number of required interpolation points during export of data; for | ||
##: every point of the computational grid for water level and current velocity (e.g. computational grid of a coupled hydrodynamic numerical model) | ##: every point of the computational grid for water level and current velocity (e.g. computational grid of a coupled hydrodynamic numerical model) | ||
##: within a distance of "Export_Max_Radius" a minimum number of data points with wave model results must be available; if this key is not | ##: within a distance of '''"Export_Max_Radius"''' a minimum number of data points with wave model results must be available; if this key is not | ||
##: prescribed, 3 interpolation points are going to be used. | ##: prescribed, 3 interpolation points are going to be used. | ||
# block Wave_Discretisation gives the discretisation of the wave spectrum: | # block '''Wave_Discretisation''' gives the discretisation of the wave spectrum: | ||
## key "Nof_Wave_Numbers" prescribes the number of discrete wave numbers or frequencies used; | ## key '''"Nof_Wave_Numbers"''' prescribes the number of '''discrete wave numbers''' or frequencies used; | ||
## key "Nof_Wave_Directions" prescribes the number of discrete wave directions used; | ## key '''"Nof_Wave_Directions"''' prescribes the number of discrete wave directions used; | ||
## key "Lowest_Wave_Number" determines the smallest wave number of the discrete spectrum. | ## key '''"Lowest_Wave_Number"''' determines the smallest wave number of the discrete spectrum. | ||
# block Output_Times_And_Timesteps contains different informations relatated to output of computed results in different BAW- as well as GKSS-specific formats: | # block '''Output_Times_And_Timesteps''' contains different informations relatated to output of computed results in different BAW- as well as GKSS-specific formats: | ||
## key "Intrinsic_Data_Timestep" gives the time steps for data output in GKSS-specific formats; the results are stored in | ## key '''"Intrinsic_Data_Timestep"''' gives the time steps for data output in GKSS-specific formats; the results are stored in | ||
### MAPYYYYMMDDhhmmss (integral wave data) and | ### MAPYYYYMMDDhhmmss (integral wave data) and | ||
### OUTYYYYMMDDhhmmss (spectral wave data). | ### OUTYYYYMMDDhhmmss (spectral wave data). | ||
## key "Integrated_Data_Output" prescribes initial date and time, final date and time as well as the time step to store integral wave data in BAW-specific data formats. | ## key '''"Integrated_Data_Output"''' prescribes initial date and time, final date and time as well as the time step to store integral wave data in BAW-specific data formats. | ||
## key "Spectral_Data_Output" prescribes initial date and time, final date and time as well as the time step to store wave spectra in BAW-specific data formats. | ## key '''"Spectral_Data_Output"''' prescribes initial date and time, final date and time as well as the time step to store wave spectra in BAW-specific data formats. | ||
# block Output_Files with names and types for the different BAW-specific data files: | # block '''Output_Files''' with '''names''' and '''types''' for the different BAW-specific data files: | ||
## key "Integrated_Data_File" contains the file name as well as the file type (BDF) to store integral wave parameters (filetypes dirz.bin.R, | ## key '''"Integrated_Data_File"''' contains the '''file name''' as well as the '''file type (BDF)''' to store integral wave parameters (filetypes [[DIRZ.BIN.R|dirz.bin.R]], | ||
##: dirz.bin. | ##: [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]]). | ||
## key "Spectral_Data_File" contains the file name as well as the file type (NETCDF) to store spectral wave data (filetype [[NETCDF.CDF|netcdf.cdf]]). | ## key '''"Spectral_Data_File"''' contains the '''file name''' as well as the '''file type (NETCDF)''' to store spectral wave data (filetype [[NETCDF.CDF|netcdf.cdf]]). | ||
# block Output_Data for steering the amount of data output: | # block '''Output_Data''' for '''steering the amount of data output:''' | ||
## key "Wave_Data" to switch on or off output of wave data; | ## key '''"Wave_Data"''' to switch on or off '''output of wave data'''; | ||
## key "Sea_Data" to switch on or off output of sea data; | ## key '''"Sea_Data"''' to switch on or off '''output of sea data'''; | ||
## key "Swell_Data" to switch on or off output of swell data. | ## key '''"Swell_Data"''' to switch on or off '''output of swell data'''. | ||
# block Open_Boundary_Data with auxilary informations to compute the wave spectrum along open model boundaries: | # block '''Open_Boundary_Data''' with '''auxilary informations''' to compute the wave spectrum along open model boundaries: | ||
## key "Fetch_Length" with different wind wave direction dependent fetch lengths (in km) which will be used to determine the boundary spectrum. | ## key '''"Fetch_Length"''' with different '''wind wave direction dependent fetch lengths''' (in km) which will be used to determine the boundary spectrum. | ||
# block | # block '''Area_''''''To_Be_Printed''' with geometric informations concerning the printer output of results within a '''tile''' of the computational domain: | ||
## Key "First_X": coordinate for the left boundary; | ## Key '''"First_X"''': coordinate for the '''left boundary;''' | ||
## Key "Last_X": coordinate for the right boundary; | ## Key '''"Last_X"''': coordinate for the '''right boundary;''' | ||
## Key "First_Y": coordinate for the bottom boundary; | ## Key '''"First_Y"''': coordinate for the '''bottom boundary;''' | ||
## Key Key "Last_Y": coordinate for the top boundary; | ## Key Key '''"Last_Y"''': coordinate for the '''top boundary'''; | ||
## Key "X_Increment": grid size in x-direction; | ## Key '''"X_Increment"''': '''grid size''' in '''x-direction'''; | ||
## Key "Y_Increment": grid size in y-direction | ## Key '''"Y_Increment"''':''' grid size''' in '''y-direction''' | ||
# (optional) block Input_Files with several additional input files: | # (optional) block '''Input_Files''' with several additional input files: | ||
## (optional) key "Specific_Locations" : name and type of file location.dat, with definition of one or several locations for wave spectra output, using the format of file | ## (optional) key '''"Specific_Locations"''' : name and type of file [[LOCATION.DAT|location.dat]], with definition of one or several '''locations for wave spectra | ||
##: output''', using the format of file [[GEOPOS.DAT|geopos.dat]] to describe an individual location; | |||
## (optional) key "Alternative_Grid_File" : name and type (GITTER05, UNTRIM_BAW) of a file with an alternative computational grid (filetype untrim_grid.dat or | ## (optional) key '''"Alternative_Grid_File"''' : name and type ('''GITTER05, UNTRIM_BAW''') of a file with an '''alternative computational grid''' (filetype untrim_grid.dat or | ||
##: gitter.dat/bin), on which the wave spectrum shall be computed. | ##: gitter.dat/bin), on which the wave spectrum shall be computed. | ||
Notice: | '''Notice:''' | ||
* dictionary-file k_model_dico.dat, usually present in directory $PROGHOME/dic/, will be automatically read by the application program in addition to the user-specified | * dictionary-file '''k_model_dico.dat''', usually present in directory '''$PROGHOME/dic/''', will be automatically read by the application program in addition to the user-specified | ||
:input file. | :input file. | ||
|nutzerprogramme= | |nutzerprogramme= |
Revision as of 14:29, 19 May 2010
Basic Information
File-Type
k_model.dat
File-Form
FORMATTED
Version
6.x / December 2009
Description-Date
December 2009
Significance of the File
contains specific input data related to the software package (k-model).
File-Contents (in Catchwords)
- block Test_Output to specify the level of datail for test output:
- key "Level" to steer the level of detail for test output with allowed values None, Low, Moderate, Medium, High and Extreme.
- block Start_Restart_Specifications different informations related to initial state:
- key "Cold_Start" with possible values Yes or No :
- if Yes, initial state will be constructed from data given in block Initial_Spectra; ;
- if No, initial data will be read from previously generated files
- BLFYYYYMMDDhhmmss and
- LAFYYYYMMDDhhmmss.
- These files must be available at start time YYYYMMDDhhmmss in the local working directory.
- key "Restart_Output_Timestep" with time step for output of restart files
- BLFYYYYMMDDhhmmss und
- LAFYYYYMMDDhhmmss.
- Restart files can be used in a later run to read the initial state from file.
- key "Cold_Start" with possible values Yes or No :
- block Initial_Spectra for a more detailed description of the initial state if Cold_Start=Yes was chosen:
- key "Type_Of_Spectra" describes the type of initial spectrum used; the following options exist:
- "Energy_Equal_Zero": no waves present;
- "Wind_Independent": wind-independent spectrum, which will be computed from subsequent spectra parameters;
- "Wind_Dependent": wind-dependent spectrum, which is computed from the subsequently given fetch length as well as the local wind speed valid at start time.
- key "Phillips_Parameter", to be computed using program WESPE;
- key "Peak_Frequency", to be computed using program WESPE;
- key "Overshoot_Factor", to be computed using program WESPE;
- key "Left_Peak_Width", to be computed using program WESPE;
- key "Right_Peak_Width", to be computed using program WESPE;
- key "Wave_Direction", direction, towards which the waves are travelling, e.g. North (0.0 deg) or East (90.0 deg);
- key "Fetch", fetch length in (m).
- key "Type_Of_Spectra" describes the type of initial spectrum used; the following options exist:
- block Timestep_For_Integration contains different time step data:
- key "Propagation_Timestep", time step for propagation of waves, as well as depth- and current refraction; if the user-prescribed time
- step violates the CFL-condition, the time step will be halved as often as necessary to fulfill the CFL-condition and therefore an emergency
- stop of the running program will no longer occur; the time step used internally will never be larger than the one prescribed by the user;
- key "Source_Timestep", time step for sources and sinks (wind, nonlinear dissipation, dissipation due to bottom interaction);
- key "Ratio_Propagation_Refraction", integer number to describe the ratio between sub steps for propagation and refraction.
- key "Propagation_Timestep", time step for propagation of waves, as well as depth- and current refraction; if the user-prescribed time
- block Options with steering data for consideration of time- and space-varying water depth as well as current velocity and computation of radiation
- stress as well as various steering parameters for interpolation of boundary values as well as computational results between different grids:
- key "Depth_Option" to describe the influence of water depth:
- Deep_Water: deep water approximation;
- Time_Variable_Depth: transient water depth
- key "Current_Option" to describe the influence of current velocity:
- No_Current: no influence due to currents;;
- Time_Variable_Current: transient cuurrent velocity
- key "Radiation_Option" to trigger computation of radiation stress terms:
- No_Radiation_Stress: radiation stress terms will not be computed;
- With_Radiation_Stress: radiation stress terms will be computed;
- (optional) key "Import_Max_Radius" to prescribe the max. (search) radius in meters during import of data (interpolation of water level as
- well as current velocity onto the grid of the wave model); if this key is not present, a radius of 2000.0 m will be used.
- (optional) key "Import_Min_Nearest" to prescribe the minimum number of required interpolation points during import of data; for
- every computational point of the wave model within a distance of "Import_Max_Radius" a minimum number of data points with given water
- level an current velocity must be available; if this key is not prescribed, 3 interpolation points are going to be used.
- (optional) key "Export_Max_Radius" to prescribe the max. (search) radius in meters during export of data (interpolation of wave model results onto the
- grid for water level as well as current velocity); if this key is not present, a radius of 2000.0 m will be used.
- (optional) key "Export_Min_Nearest" to prescribe the minimum number of required interpolation points during export of data; for
- every point of the computational grid for water level and current velocity (e.g. computational grid of a coupled hydrodynamic numerical model)
- within a distance of "Export_Max_Radius" a minimum number of data points with wave model results must be available; if this key is not
- prescribed, 3 interpolation points are going to be used.
- block Wave_Discretisation gives the discretisation of the wave spectrum:
- key "Nof_Wave_Numbers" prescribes the number of discrete wave numbers or frequencies used;
- key "Nof_Wave_Directions" prescribes the number of discrete wave directions used;
- key "Lowest_Wave_Number" determines the smallest wave number of the discrete spectrum.
- block Output_Times_And_Timesteps contains different informations relatated to output of computed results in different BAW- as well as GKSS-specific formats:
- key "Intrinsic_Data_Timestep" gives the time steps for data output in GKSS-specific formats; the results are stored in
- MAPYYYYMMDDhhmmss (integral wave data) and
- OUTYYYYMMDDhhmmss (spectral wave data).
- key "Integrated_Data_Output" prescribes initial date and time, final date and time as well as the time step to store integral wave data in BAW-specific data formats.
- key "Spectral_Data_Output" prescribes initial date and time, final date and time as well as the time step to store wave spectra in BAW-specific data formats.
- key "Intrinsic_Data_Timestep" gives the time steps for data output in GKSS-specific formats; the results are stored in
- block Output_Files with names and types for the different BAW-specific data files:
- key "Integrated_Data_File" contains the file name as well as the file type (BDF) to store integral wave parameters (filetypes dirz.bin.R,
- dirz.bin.i and dirz.bin).
- key "Spectral_Data_File" contains the file name as well as the file type (NETCDF) to store spectral wave data (filetype netcdf.cdf).
- key "Integrated_Data_File" contains the file name as well as the file type (BDF) to store integral wave parameters (filetypes dirz.bin.R,
- block Output_Data for steering the amount of data output:
- key "Wave_Data" to switch on or off output of wave data;
- key "Sea_Data" to switch on or off output of sea data;
- key "Swell_Data" to switch on or off output of swell data.
- block Open_Boundary_Data with auxilary informations to compute the wave spectrum along open model boundaries:
- key "Fetch_Length" with different wind wave direction dependent fetch lengths (in km) which will be used to determine the boundary spectrum.
- block Area_'To_Be_Printed' with geometric informations concerning the printer output of results within a tile of the computational domain:
- Key "First_X": coordinate for the left boundary;
- Key "Last_X": coordinate for the right boundary;
- Key "First_Y": coordinate for the bottom boundary;
- Key Key "Last_Y": coordinate for the top boundary;
- Key "X_Increment": grid size in x-direction;
- Key "Y_Increment": grid size in y-direction
- (optional) block Input_Files with several additional input files:
- (optional) key "Specific_Locations" : name and type of file location.dat, with definition of one or several locations for wave spectra
- output, using the format of file geopos.dat to describe an individual location;
- (optional) key "Alternative_Grid_File" : name and type (GITTER05, UNTRIM_BAW) of a file with an alternative computational grid (filetype untrim_grid.dat or
- gitter.dat/bin), on which the wave spectrum shall be computed.
- (optional) key "Specific_Locations" : name and type of file location.dat, with definition of one or several locations for wave spectra
Notice:
- dictionary-file k_model_dico.dat, usually 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
Example-File
please refer to $PROGHOME/examples/unk/k_model.dat
back to: File Descriptions